summaryrefslogtreecommitdiff
path: root/support
diff options
context:
space:
mode:
Diffstat (limited to 'support')
-rwxr-xr-xsupport/xml2pmx/MacOS/xml2pmxbin0 -> 114704 bytes
-rw-r--r--support/xml2pmx/README97
-rw-r--r--support/xml2pmx/doc/LICENSE675
-rw-r--r--support/xml2pmx/doc/Readme.XML2PMX135
-rw-r--r--support/xml2pmx/doc/musixtex.1204
-rw-r--r--support/xml2pmx/doc/musixtex.pdfbin0 -> 23518 bytes
-rw-r--r--support/xml2pmx/doc/xml2pmx.147
-rw-r--r--support/xml2pmx/doc/xml2pmx.pdfbin0 -> 16563 bytes
-rwxr-xr-xsupport/xml2pmx/scripts/musixtex.lua631
9 files changed, 1789 insertions, 0 deletions
diff --git a/support/xml2pmx/MacOS/xml2pmx b/support/xml2pmx/MacOS/xml2pmx
new file mode 100755
index 0000000000..d5d862ecc1
--- /dev/null
+++ b/support/xml2pmx/MacOS/xml2pmx
Binary files differ
diff --git a/support/xml2pmx/README b/support/xml2pmx/README
new file mode 100644
index 0000000000..9320fa1a74
--- /dev/null
+++ b/support/xml2pmx/README
@@ -0,0 +1,97 @@
+xml2pmx, version 2020-06-29.
+
+Summary: xml2pmx translates MusicXML into PMX notation.
+
+MusicXML (http://www.musicxml.com) originally
+developed by Recordare and now owned by Finale
+(https://www.finalemusic.com/), is the leading music-data
+exchange format.
+
+PMX, developed by Don Simons dsimons(at)roadrunner(dot)com,
+is an easy to use, yet powerful preprocessor
+for the music typesetting system MusiXTeX.
+http://icking-music-archive.org/software/htdocs/
+
+xml2pmx has been developed by Dieter
+Gloetzel with the "Oberon Plugin for Windows
+Version 2.5" of ETHZ Zurich on Windows 10.
+https://github.com/Spirit-of-Oberon/ETH-Oberon-PlugIn-Win32
+
+Coverage of MusicXML by xml2pmx
+*******************************
+
+The following MusicXML features are detected and translated
+to PMX:
+
+- maximum of 24 staves/voices and 400 measures
+- two voices per staff
+- maximum of two staves per instrument
+- notes and rests up to 64th, including tuplets and grace notes,
+- maximum of 2 dots
+- chords, accidentals
+- some annotations like Fermata, Staccato, Tremolo etc.
+- ties, slurs and beams
+- definition of meter, fifths, clefs and their changes on the fly
+- dynamic marks: hairpins, "ff" etc., piano damping pedal
+- title and composer, and texts above or below the staff
+- barlines, repeats, volta
+- instrument names,
+- origin of XML file copied to the resulting PMX file
+- accepts Windows files (records ended by 0DX OAX)
+
+This package is based on a runtime system developed by Mike
+Spivey (mike(at)cs.ox.ac.uk) as part of the Oxford Oberon
+Compiler project.
+
+Usage
+*****
+
+On Windows or Macs, use the executables provided in the
+relevant folders.
+
+To build and install an executable xml2pmx on a Linux system
+with conventional development tools:
+
+ tar xvf xml2pmx-2020-06-29.tar.gz
+ cd xml2pmx-2020-06-29
+ ./configure
+ make
+ sudo make install
+
+Full details on usage are in the man page. The most
+convenient way to use xml2pmx is with the musixtex.lua
+script, version 0.23 or later, which supports xml2pmx as a
+pre-preprocessor. Version 0.23 of musixtex.lua is provided
+in the scripts folder. On Windows you may have to use it as
+follows:
+
+ texlua musixtex.lua something[.xml]
+
+If it is necessary to edit the resulting pmx file, use the
+-m option.
+
+Licencing
+*********
+
+The source files for xml2pmx are Copyright 2015-2020 by
+Dieter Gloetzel (d.gloetzel(a)web.de) and the source files
+for the runtime system are Copyright 2020 by Mike Spivey
+(mike(a)cs.ox.ac.uk). They may be modified and distributed
+according to the terms of the GNU General Public Licence
+version 3 or at your option any later version.
+
+musixtex.lua is Copyright 2011-2020 by Bob
+Tennent (rdt(a)cs.queensu.ca) and Dirk Laurie
+(dirk.laurie(at)gmail.com). It may be modified and distributed
+according to the terms of the GNU General Public Licence
+version 2 or at your option any later version.
+
+This README and the man pages xml2pmx.1 and musixtex.1 were
+written by Bob Tennent and may be modified and distributed
+according to the terms of the LaTeX Project Public License.
+
+Please report problems with the executables or the Linux
+build system to Bob Tennent (rdt(a)cs.queensu.ca). Problems
+with the XML to PMX translation should be reported to Dieter
+Gloetzel (d.gloetzel(at)web.de).
+
diff --git a/support/xml2pmx/doc/LICENSE b/support/xml2pmx/doc/LICENSE
new file mode 100644
index 0000000000..10926e87f1
--- /dev/null
+++ b/support/xml2pmx/doc/LICENSE
@@ -0,0 +1,675 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+
diff --git a/support/xml2pmx/doc/Readme.XML2PMX b/support/xml2pmx/doc/Readme.XML2PMX
new file mode 100644
index 0000000000..04165c2269
--- /dev/null
+++ b/support/xml2pmx/doc/Readme.XML2PMX
@@ -0,0 +1,135 @@
+(***************************************************************************)
+(****************Copyright 2015,2016,2017 Dieter Gloetzel ******************)
+(***************************************************************************)
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+1. Introduction
+ "MusicXML", ( http://www.musicxml.com/ ) originally developed by Recordare INC
+ and now owned by Finale ( https://www.finalemusic.com/ ), is the leading
+ musical data exchange format. XML2PMX provides an import facility for
+ sheet music stored in MusicXML format to PMX and MusiXTeX, the leading free
+ software for musical typesetting. Thus we are now able to import published MusicXML sources
+ as well as MusicXML sources created by OCR scanning,
+ e.g. with Sharpeye of VISIV ( http://www.visiv.co.uk ).
+
+2. PMX
+ developed by Don Simons (dsimons(at)roadrunner(dot)com) is an easy to use,
+ yet powerful preprocessor for the musical typesetting system MusiXTeX.
+ http://icking-music-archive.org/software/htdocs/index.html
+ An excellent introduction to using PMX is
+ http://icking-music-archive.org/software/pmx/pmxccn.pdf
+
+3. XML2PMX
+ has been developed by the author with "Oberon Plugin for Windows
+ Version 2.5" of ETHZ Zürich on Windows 10.
+ https://github.com/Spirit-of-Oberon/ETH-Oberon-PlugIn-Win32
+
+ XML2PMX is available as Windows-EXE (32 Bit) and as Linux binary (32 Bit).
+ XML2PMX requires a TeX, MusiXTeX and PMX installation.
+ For Unix please see: https://tug.org/texlive/
+ For Windows please see: https://miktex.org/2.9/setup
+
+4. Coverage of MusicXML
+ The following MusicXML features are detected and translated to PMX:
+ - maximum of 24 staves/voices and 400 measures
+ - two voices per staff
+ - maximum of two staves per instrument
+ - notes and rests up to 64th, including tuplets and grace notes,
+ - maximum of 2 dots
+ - chords, accidentals
+ - some annotations like Fermata, Staccato, Tremolo etc.
+ - ties, slurs and beams
+ - definition of meter, fifths, clefs and their changes on the fly
+ - dynamic marks: hairpins, "ff" etc., piano damping pedal
+ - title and composer, and texts above or below the staff
+ - barlines, repeats, volta
+ - instrument names,
+ - origin of XML file copied to the resulting PMX file
+ - accepts Windows files (records ended by 0DX OAX)
+ as well as Unix files (records ended by 0AX)
+ - resulting PMX-file on Unix has records ended by 0AX.
+ - resulting PMX-file on Windows has records ended by 0DX 0AX.
+
+5. New features:
+ - There is a new command line field "options",
+ which may contain one or several of the five letters "PDVSL"
+ in arbitrary sequence in upper or lower case.
+ - Lyrics are extracted and stored in a separate file (option L=Lyrics)
+ - several options for console output (P=parsed data, D=directions, V=voices, S=statistics,)
+ - automatic detection of pickup
+ - incomplete measures or voices are automatically filled with blind rests
+
+6. Limitations
+ Some more elaborate situations like beams crossing staves or chords crossing staves
+ have not yet been covered.
+
+7. Usage on MS Windows command line:
+ ===================================================================
+ XML2PMX "xml-file with path" "pmx-file with path" "options"
+ ===================================================================
+ The doublequotes are required.
+ "options" contains a sequence (without blanks) of one or several of
+ the letters "p", "d", "v", "s" and "l" .
+ Their meaning is the following:
+ _______________________________________________________________
+ | p | XML parser output; not recommended unless the terminal |
+ | | window process has enough storage |
+ |-------------------------------------------------------------|
+ | d | information on "directions" (dynamical marks etc) |
+ |-------------------------------------------------------------|
+ | v | distribution of voices over instruments and measures |
+ |-------------------------------------------------------------|
+ | s | statistics of MusicXML tags like <note>, <measure> etc|
+ |-------------------------------------------------------------|
+ | l | for extracting lyrics in a separate file |
+ |_____________________________________________________________|
+
+ The generated PMX file will in general be complete and can be processed by "musixtex".
+
+ If not, you can often solve the problem with minor changes in the PMX code.
+
+ After the XML2PMX run you will find intermediate results in the
+ terminal window which may be helpful for debugging.
+
+ Once you have a generated PMX file with all of the notes extracted, the bulk work has been done.
+ It is then easy to improve the results on the PMX side.
+
+8.1 MusicXML test data
+ You will find MusicXML-sources for testing under:
+
+ http://www.musicxml.com/music-in-musicxml/example-set/
+
+ The following pieces from this source (and a few more) have been tested:
+
+ - Schubert: "Ave Maria" (Ellen’s Gesang III), D. 839 "SchbAvMaSample.xml"
+
+ - Beethoven: "An die ferne Geliebte", Op. 98 "BeetAnGeSample.xml"
+
+ - Lee Actor "Prelude to a tragedy": "ActorPreludeSample.xml"
+ sample with 22 instruments and 41 measures
+
+ - Mahler: "Lieder eines fahrenden Gesellen", "MahlFaGe4Sample.xml"
+
+8.2 OCR scanned sheet music
+ The MusicXML results from the tool Sharpeye from VISIV
+ (http://www.visiv.co.uk/) have been tested successfully.
+
+Contact:
+
+ Feel free to contact me at <d.gloetzel(at)web(dot)de>
+ in order to report errors, propose improvements or
+ other comments.
+
+
diff --git a/support/xml2pmx/doc/musixtex.1 b/support/xml2pmx/doc/musixtex.1
new file mode 100644
index 0000000000..59b6c8874e
--- /dev/null
+++ b/support/xml2pmx/doc/musixtex.1
@@ -0,0 +1,204 @@
+.\" This manpage is licensed under the GNU Public License
+.TH MUSIXTEX 1 2020-05-21 "musixtex version 0.23" ""
+
+.SH NAME
+musixtex \- processes MusiXTeX files, using pre-processors prepmx, xml2pmx, pmxab and autosp
+as necessary, and then deletes intermediate and log files (unless
+.B -i
+is used)
+.SH SYNOPSIS
+[ texlua ]
+.B musixtex[.lua]
+{
+.I option
+|
+.I jobname
+[ .xml | .mtx | .pmx | .aspc | .tex | .ltx ] } ...
+.SH DESCRIPTION
+.TP
+If a jobname argument has a .tex extension, the default effect is to process the file using
+.TP 12
+.BR etex (1)
+(first pass)
+.TP
+.BR musixflx (1)
+(second pass)
+.TP
+.BR etex (1)
+(third pass)
+.TP
+.BR dvips (1)
+(dvi to Postscript)
+.TP
+.BR ps2pdf (1)
+(Postscript to Portable Document Format)
+.TP
+normally followed by removal of intermediate and log files. A log musixtex.log is generated, even if other log files are removed.
+.P
+If a jobname argument has a .pmx extension, the file is first preprocessed using
+.BR pmxab (1)
+and the resulting .tex file is processed as above.
+.P
+If a jobname argument has a .xml extension, the file is first preprocessed using
+.BR xml2pmx (1)
+and the resulting .pmx file is processed as above.
+.P
+If a jobname argument has a .mtx extension, the file is first preprocessed using
+.BR prepmx (1)
+and the resulting .pmx file is processed as above.
+.P
+If a jobname argument has a .ltx extension, the file is processed using
+.BR latex (1)
+(or
+.BR pdflatex (1))
+in place of
+.BR etex .
+.P
+If a jobname argument has a .aspc extension, the file is first preprocessed using
+.BR autosp (1)
+and the resulting .tex or .ltx file is processed as above.
+.P
+If a jobname argument has none of these extensions, the script will look for a file
+.IR jobname .xml
+or
+.IR jobname .mtx
+or
+.IR jobname .pmx
+or
+.IR jobname .aspc
+or
+.IR jobname .tex
+or
+.IR jobname .ltx ,
+in that order, and process it as above.
+.SH OPTIONS
+.TP 10
+.B -v, -version, --version
+output program name and version number, and quit
+.TP
+.B -h, -help, --help
+output usage summary and quit
+.TP
+.B -l
+assume LaTeX source;
+implied if the file has .ltx extension
+.TP
+.B -p
+change the TeX processor to
+.BR pdfetex (1)
+or
+.BR pdflatex (1)
+(and doesn't run a dvi processor)
+.TP
+.B -c
+preprocess pmx file using
+.BR pmxchords (1)
+.TP
+.B -d
+don't generate a .ps file and change the dvi processor to
+.BR dvipdfm (1)
+.TP
+.B -D dvix
+use
+.B dvix
+as the dvi processor; e.g., -D "dvipdfm -m 0.9".
+Use -d
+.I before
+-D to suppress .ps generation.
+.TP
+.B -P ps2pdf
+use
+.B ps2pdf
+as the Postscript processor; e.g., -P "ps2pdf -sPAPERSIZE=a4"
+.TP
+.B -F fmt
+use
+.B fmt
+as the TeX processor; e.g., -F "luatex --output-format=dvi"
+.TP
+.B -m
+stop processing at the pmx file
+.TP
+.B -M mtxx
+use
+.B mtxx
+as the mtx preprocessor; e.g., -M "prepmx -i".
+.TP
+.B -X pmxx
+use
+.B pmxx
+as the pmx preprocessor; e.g., -X "./pmxab",
+.TP
+.B -A aspcx
+use
+.B aspcx
+as the aspc preprocessor; e.g., -A "autosp -l".
+.TP
+.B -L xmlx
+use
+.B xmlx
+as the xml preprocessor; e.g., -L "./XML2PMX".
+.TP
+.B -t
+stop processing at the tex/mid files
+.TP
+.B -s
+stop processing at the dvi file
+.TP
+.B -g
+stop processing at the ps file
+.TP
+.B -i
+retain intermediate and log files
+.TP
+.B -1
+one-pass [pdf][la]tex processing; i.e., without calling
+.B musixflx
+.TP
+.B -x
+call
+.BR makeindex (1)
+to update index database
+.TP
+.B -f
+restore default processing
+.TP
+.B -q
+quiet mode (only musixtex's own messages); other messages are diverted to a temporary file.
+If an error occurs at the TeX stage, processing halts immediately and the tail of the log file is sent to stderr.
+Version information is copied from the temporary file to the log file.
+
+.TP 0
+Options affect processing of all succeeding MusiXTeX files unless changed by another option. Option flags cannot be combined; e.g., use \fB -l -x \fP rather than \fB -lx\fP.
+
+Note that four TeX engines are available via the -l and -p options:
+.TP
+ etex default
+ latex -l
+ pdfetex -p
+ pdflatex -l -p
+.TP 0
+If the -F option is used, options -l and -p need to be set if the engine name does not contain "latex" and "pdf" respectively. For example, the above four engines can be replaced by:
+ -F "luatex --output-format=dvi"
+ -F "lualatex --output-format=dvi"
+ -F "luatex" -p
+ -F "lualatex" -p
+
+.SH SEE ALSO
+.BR autosp (1),
+.BR etex (1),
+.BR latex (1),
+.BR pdfetex (1),
+.BR pdflatex (1),
+.BR makeindex (1),
+.BR musixflx (1),
+.BR dvipdfm (1),
+.BR dvips (1),
+.BR pmxab (1),
+.BR pmxchords (1),
+.BR prepmx (1),
+.BR ps2pdf (1),
+.BR xml2pmx (1)
+and musixdoc.pdf.
+.SH AUTHOR
+This manual page was written by Bob Tennent <rdt@cs.queensu.ca>.
diff --git a/support/xml2pmx/doc/musixtex.pdf b/support/xml2pmx/doc/musixtex.pdf
new file mode 100644
index 0000000000..30246ff59f
--- /dev/null
+++ b/support/xml2pmx/doc/musixtex.pdf
Binary files differ
diff --git a/support/xml2pmx/doc/xml2pmx.1 b/support/xml2pmx/doc/xml2pmx.1
new file mode 100644
index 0000000000..3fc9c14219
--- /dev/null
+++ b/support/xml2pmx/doc/xml2pmx.1
@@ -0,0 +1,47 @@
+.TH XML2PMX 1 2020-05-21 "" ""
+
+.SH DESCRIPTION
+
+xml2pmx translates MusicXML files to input suitable for PMX processing
+
+.SH SYNOPSIS
+
+.B xml2pmx
+.RB [ \-v\ |\ \-\-version\ |\ \-h\ |\ \-\-help ]
+
+.B xml2pmx
+.IR input .xml
+.IR output .pmx
+[ p | d | v | s | l ] ..
+
+The
+.BR musixtex.lua
+script
+from version 0.23 supports
+.BR xml2pmx
+as a pre-preprocessor for MusicXML files.
+
+.SH OPTIONS
+
+The meanings of the letter options are as follows:
+
+ p XML parser output; not recommended unless the terminal window process has enough storage
+
+ d information on "directions" (dynamical marks etc)
+
+ v distribution of voices over instruments and measures
+
+ s statistics of MusicXML tags like <note>, <measure> etc
+
+ l for extracting lyrics in a separate file
+
+.SH SEE ALSO
+
+.BR pmx (1)
+.BR obc (1)
+.BR musixtex (1)
+
+.SH AUTHORS
+This man page was written by Bob Tennent <rdt@cs.queensu.ca>.
+XML2PMX was written by Dieter Gloetzel <d.gloetzel@web.de> and
+adapted for compilation by obc (the Oxford Oberon Compiler) by Mike Spivey <mike@cs.ox.ac.uk>.
diff --git a/support/xml2pmx/doc/xml2pmx.pdf b/support/xml2pmx/doc/xml2pmx.pdf
new file mode 100644
index 0000000000..987e7496b3
--- /dev/null
+++ b/support/xml2pmx/doc/xml2pmx.pdf
Binary files differ
diff --git a/support/xml2pmx/scripts/musixtex.lua b/support/xml2pmx/scripts/musixtex.lua
new file mode 100755
index 0000000000..a4175ad17b
--- /dev/null
+++ b/support/xml2pmx/scripts/musixtex.lua
@@ -0,0 +1,631 @@
+#!/usr/bin/env texlua
+
+VERSION = "0.23"
+
+--[[
+ musixtex.lua: processes MusiXTeX files using xml2pmx and/or prepmx and/or pmxab
+ and/or autosp as pre-processors (and deletes intermediate files)
+
+ (c) Copyright 2011-2020 Bob Tennent rdt@cs.queensu.ca
+ and Dirk Laurie dirk.laurie@gmail.com
+
+ This program is free software; you can redistribute it and/or modify it
+ under the terms of the GNU General Public License as published by the
+ Free Software Foundation; either version 2 of the License, or (at your
+ option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
+ Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+--]]
+
+--[[
+
+ ChangeLog:
+
+ version 0.23 2020-05-21 RDT
+ added support for xml2pmx pre-preprocessing
+
+ version 0.22 2020-03-20 RDT
+ add -X option
+ add -version, --version, -help, --help options
+
+ version 0.21 2018-07-27 RDT
+ add -P option.
+
+ version 0.20 2018-06-11 RDT
+ remove .mx1 file before tex processing
+
+ version 0.19 2017-12-10 RDT
+ Allow non-standard extensions.
+ Add -M and -A options.
+
+ version 0.18 2017-06-13 RDT
+ Allow autosp to generate .ltx files
+
+ version 0.17a 2017-01-08 RDT
+ Added -D option.
+ Avoid writing or concatenating a nil value.
+
+ version 0.16e 2016-03-02 DL
+ missing version information (caused by batchmode in 0.16c) fixed
+
+ version 0.16d 2016-03-02 RDT
+ filename argument in autosp failure message fixed
+
+ version 0.16c 2016-02-24 RDT
+ -interaction batchmode for -q
+ report_error reports only the first error
+
+ version 0.16b 2016-02-20 DL
+ Improved help message as suggested by Bob Tennent.
+
+ version 0.16a 2015-12-30 DL
+ Corrects bug in -g option reported by Christian Mondrup.
+
+ version 0.16 2015-12-24 DL
+ Versions read from tempfile and written to musixtex.log.
+
+ version 0.15 2015-12-03 DL
+ Option -q added, which redirects most screen output into
+ a temporary file. If an error occurs at the TeX stage, processing
+ halts immediately and the tail of the log file is sent to stderr.
+
+ version 0.14 2015-12-01 DL
+ Writes `musixtex.log` and deletes other logfiles (except with -i)
+ Hierarchy of extensions emphasized in usage() and consistently
+ used elsewhere.
+ Unknown option-like arguments reported and ignored, not treated
+ as filenames
+ Warnings and error messages generated by musixtex.lua start with
+ respctively `!` and `!!`.
+
+ version 0.13 2015-11-30 RDT
+ Process .mtx and .pmx files (suggested by Dirk Laurie)
+ exit_code is now an error count
+ Use pmxab exit code to distinguish between errors and warnings
+
+ version 0.12 2015-11-28 RDT
+ Process .ltx files, with -l implied
+
+ version 0.11 2015-07-16 RDT
+ Automatic autosp preprocessing.
+
+ version 0.10 2015-04-23 RDT
+ Add -a option to preprocess using autosp
+
+ version 0.9 2015-02-13 RDT
+ Add an additional latex pass to resolve cross-references.
+ Add -e0 option to dvips as given in musixdoc.tex
+ Add -x option to call makeindex
+
+ version 0.8 2014-05-18 RDT
+ Add -g option
+
+ version 0.7 2013-12-11 RDT
+ Add -F fmt option
+
+ version 0.6 2012-09-14 RDT
+ Add -1 (one-pass [pdf][la]tex processing) option.
+
+ version 0.5 2011-11-28 RDT
+ Add -i (retain intermediate files) option.
+
+ version 0.4 2011-04-30 RDT
+ Allow multiple filenames (and options).
+ Add -f (default) and -l (latex) options.
+
+ version 0.3 2011-04-25 RDT
+ Add -d (dvipdfm) and -s (stop at dvi) options.
+
+ version 0.2 2011-04-21 RDT
+ Allow basename.tex as filename.
+ Add -p option for pdfetex processing.
+ Add standard -v -h options.
+--]]
+local orig_print = print
+
+function usage()
+ orig_print
+[[
+Usage: [texlua] musixtex.lua { option | basename[ .xml | .mtx | .pmx | .aspc | .tex | .ltx] } ...
+ When no extension is given, extensions are tried in the above order
+ until a source file is found. Preprocessing goes xml-pmx-tex or mtx-pmx-tex or
+ aspc-tex, with the entry point determined by the extension.
+ The normal route after preprocessing goes tex-dvi-ps-pdf, but shorter
+ routes are also available, see the options. The default 3-pass processing route
+ for .tex files is etex-musixflx-etex.
+Options: -v, --version version
+ -h, --help help
+ -l latex source
+ -p direct tex-pdf (pdftex etc)
+ -F fmt use fmt as the TeX processor
+ -d tex-dvi-pdf (using dvipdfm if -D not used)
+ -D dvixx use dvixx as the dvi processor
+ -P ps2pdfxx use ps2pdfxx as the Postscript processor
+ -c preprocess pmx file using pmxchords
+ -m stop at pmx
+ -M prepmxx use prepmxx as the mtx preprocessor
+ -A autospx use autospx as the aspc preprocessor
+ -X pmxabx use pmxabx as the pmx preprocessor
+ -L xmlx use xmlx as the xml preprocessor
+ -t stop at tex/mid
+ -s stop at dvi
+ -g stop at ps
+ -i retain intermediate and log files
+ -q quiet mode (redirect screen logs, write summary on musixtex.log)
+ -1 one-pass [pdf][la]tex processing
+ -x run makeindex
+ -f restore default processing
+Four TeX engines are available via the -l and -p options.
+ etex default
+ latex -l
+ pdfetex -p
+ pdflatex -l -p
+If the -F option is used, options -l and -p need to be set if the engine
+name does not contain "latex" and "pdf" respectively. For example, the
+above four engines can be replaced by:
+ -F "luatex --output-format=dvi"
+ -F "lualatex --output-format=dvi"
+ -F "luatex" -p
+ -F "lualatex" -p
+]]
+end
+
+function whoami ()
+ print("This is musixtex.lua version ".. VERSION .. ".")
+end
+
+function exists (filename, nolog)
+ local f = io.open(filename, "r")
+ if f then
+ f:close()
+ if not nolog then musixlog:write("Processing " .. filename,'\n' ) end
+ return true
+ else
+ return false
+ end
+end
+
+-- System commands for the various programs are mostly
+-- set to nil if the step is to be omitted, which can be
+-- tested by a simple "if" statement.
+-- Exceptions:
+-- 'tex' is the command for processing a TeX file, but it is important
+-- to know whether the user has explicitly specified an option that
+-- affects this choice, in which case the automatic selection of the
+-- command is restricted or disabled.
+-- force_engine "use the command provided"
+-- override records when 'l' and/or 'p' options are in effect
+-- 'dvi' is the command for processing a DVI file, but there are two
+-- reasons for not needing it and it is important for the automatic
+-- selection of a TeX engine to know which is in effect. This is
+-- possible by exploiting the the fact that Lua has two false values.
+-- dvi == nil "do not produce a DVI file" (but maybe PDF)
+-- dvi == false "do not process the DVI file" (but stop after TeX)
+local dvips = "dvips -e0"
+function defaults()
+ xml2pmx = "xml2pmx"
+ prepmx = "prepmx"
+ pmx = "pmxab"
+ autosp = "autosp"
+ tex = "etex"
+ musixflx = "musixflx"
+ dvi = dvips
+ ps2pdf = "ps2pdf"
+ cleanup = true -- clean up intermediate and log files
+ index = false
+ latex = false
+ force_engine = false -- indicates whether -F is specified
+ override = ""
+ passes = 2
+ quiet = "" -- set by "-q"
+end
+
+------------------------------------------------------------------------
+
+if #arg == 0 then
+ whoami()
+ usage()
+ os.exit(0)
+end
+
+-- Logging on `musixtex.log` everything that is printed, all os calls,
+-- and warnings from other log files.
+
+musixlog = io.open("musixtex.log","w")
+if not musixlog then
+ print"!! Can't open files for writing in current directory, aborting"
+ os.exit(1)
+end
+
+------------------------------------------------------------------------
+
+print = function(...)
+ orig_print(...)
+ musixlog:write(...,"\n") -- only the first argument gets written!
+end
+
+local orig_remove = os.remove
+remove = function(filename)
+ if exists(filename,"nolog") then
+ musixlog:write(" removing ",filename,"\n")
+ return orig_remove(filename)
+ end
+end
+
+local orig_execute = os.execute
+execute = function(command)
+ musixlog:write(" ",command,"\n")
+ return orig_execute(command .. quiet)
+end
+
+function report_warnings(filename,pattern)
+ local log = io.open(filename)
+ if not log then
+ print("! No file "..filename)
+ return
+ end
+ for line in log:lines() do
+ if line:match(pattern) then
+ musixlog:write("! "..line,"\n")
+ end
+ end
+end
+
+function report_error(filename)
+ local log = io.open(filename)
+ if not log then
+ print("! No file "..filename)
+ return
+ end
+ local trigger = false
+ for line in log:lines() do
+ if trigger and line:match"^!" then
+ -- report just the first error
+ break
+ end
+ trigger = trigger or line:match"^!"
+ if trigger then
+ io.stderr:write("! "..line,"\n")
+ end
+ end
+end
+
+function process_option(this_arg)
+ if this_arg == "-v" or this_arg == "-version" or this_arg == "--version" then
+ os.exit(0)
+ elseif this_arg == "-h" or this_arg == "-help" or this_arg == "--help" then
+ usage()
+ os.exit(0)
+ elseif this_arg == "-l" then
+ latex = true
+ override = override .. 'l'
+ elseif this_arg == "-p" then
+ dvi = nil
+ override = override .. 'p'
+ elseif this_arg == "-d" then
+ dvi = "dvipdfm"; ps2pdf = nil
+ elseif this_arg == "-D" then
+ narg = narg+1
+ dvi = arg[narg]
+ elseif this_arg == "-c" then
+ pmx = "pmxchords"
+ elseif this_arg == "-F" then
+ narg = narg+1
+ tex = arg[narg]
+ force_engine = true
+ elseif this_arg == "-s" then
+ dvi = false; ps2pdf = nil; protect.dvi = true
+ elseif this_arg == "-g" then
+ dvi = dvips; ps2pdf = nil; protect.ps = true
+ elseif this_arg == "-i" then
+ cleanup = false
+ elseif this_arg == "-x" then
+ index = true
+ elseif this_arg == "-1" then
+ passes = 1
+ elseif this_arg == "-f" then
+ defaults()
+ elseif this_arg == "-t" then
+ tex, dvi, ps2pdf = nil,nil,nil
+ protect.tex = true
+ elseif this_arg == "-m" then
+ pmx, tex, dvi, ps2pdf = nil,nil,nil,nil
+ protect.pmx = true
+ elseif this_arg == "-M" then
+ narg = narg+1
+ prepmx = arg[narg]
+ elseif this_arg == "-A" then
+ narg = narg+1
+ autosp = arg[narg]
+ elseif this_arg == "-L" then
+ narg = narg+1
+ xml2pmx = arg[narg]
+ elseif this_arg == "-q" then
+ if not tempname then
+ tempname = tempname or os.tmpname()
+ print("Redirecting screen output to "..tempname)
+ end
+ if dvi == dvips then dvi = dvi .. " -q" end
+ quiet = " >> " .. tempname
+ elseif this_arg == "-P" then
+ narg = narg+1
+ ps2pdf = arg[narg]
+ elseif this_arg == "-X" then
+ narg = narg+1
+ pmx = arg[narg]
+ else
+ print("! Unknown option "..this_arg.." ignored")
+ end
+end
+
+function find_file(this_arg)
+ basename, extension = this_arg:match"(.*)%.(.*)"
+ extensions = {["xml"] = true, ["mtx"] = true, ["pmx"] = true, ["aspc"] = true, ["tex"] = true, ["ltx"] = true}
+ if extensions[extension] then
+ return basename, extension
+ end
+ basename, extension = this_arg, null
+ for ext in ("xml,mtx,pmx,aspc,tex,ltx"):gmatch"[^,]+" do
+ if exists (basename .. "." .. ext) then
+ extension = ext
+ break
+ end
+ end
+ if extension == null then
+ print("!! No file " .. basename .. ".[xml|mtx|pmx|aspc|tex|ltx]")
+ exit_code = exit_code+1
+ return
+ end
+ return basename, extension
+end
+
+function preprocess(basename,extension)
+ if not (basename and extension) then return end
+ if extension == "xml" then
+ if execute(xml2pmx .. " " .. basename .. ".xml" .. " " .. basename .. ".pmx" ) == 0 then
+ extension = "pmx"
+ else
+ print ("!! xml2pmx preprocessing of " .. basename .. ".xml fails.")
+ return
+ end
+ elseif extension == "mtx" then
+ if execute(prepmx .. " " .. basename ) == 0 then
+ extension = "pmx"
+ else
+ print ("!! prepmx preprocessing of " .. basename .. ".mtx fails.")
+ return
+ end
+ end
+ if extension == "pmx" then
+ local OK = true
+ if pmx then
+ local code = execute(pmx .. " " .. basename)
+ local pmxaerr = io.open("pmxaerr.dat", "r")
+ if (not pmxaerr) then
+ OK = false
+ print("!! No pmx log file.")
+ else
+ extension = "tex"
+ local linebuf = pmxaerr:read()
+ local err = tonumber(linebuf)
+ if (code == 0) then
+ if err ~=0 then
+ print ("! pmx produced a warning on line "..err..
+ " of "..basename..".pmx")
+ end
+ else
+ OK = false
+ print ("!! pmx processing of " .. basename .. ".pmx fails.")
+ end
+ pmxaerr:close()
+ end
+ end
+ if not OK then
+ exit_code = exit_code+1
+ return
+ end
+ end
+ if extension == "aspc" then
+ if execute (autosp .. " " .. basename .. ".aspc" ) == 0 then
+ if exists ( basename .. ".ltx")
+ then extension = "ltx"
+ else extension = "tex"
+ end
+ else
+ print ("!! autosp preprocessing of " .. basename .. ".aspc fails.")
+ exit_code = exit_code+1
+ return
+ end
+ end
+ return extension
+end
+
+function tex_process(tex,basename,extension)
+ if not (extension == "tex" or extension == "ltx") or not tex then return end
+ remove(basename .. ".mx1")
+ remove(basename .. ".mx2")
+ local filename = basename .. "." ..extension
+-- .ltx extension re-selects engine only for the current file, and only
+-- if default processing is plain TeX
+ local latex = latex
+ if extension == "ltx" then
+ if not force_engine and not latex then
+ if dvi then tex = "latex" else tex = "pdflatex" end
+ end
+ latex = true
+ end
+ if quiet ~= "" then
+ tex = tex .. " -interaction batchmode"
+ end
+ local OK = (execute(tex .. " " .. filename) == 0)
+ if passes ~= 1 then
+ OK = OK and (execute(musixflx .. " " .. basename) == 0)
+ and (execute(tex .. " " .. filename) == 0)
+ if latex and index then
+ OK = OK and (execute("makeindex -q " .. basename) == 0)
+ and (execute(tex .. " " .. filename) == 0)
+ if exists (basename .. ".toc","nolog") then
+ -- an extra line for the index will have been added
+ OK = OK and (execute(tex .. " " .. filename) == 0)
+ -- there is a tiny possibility that the extra line for the index
+ -- has changed the pagination. If you feel this should not be
+ -- ignored, here are the possibilities:
+ -- a. Do an extra TeX pass regardless.
+ -- b. Provide a user option -4 to force the extra pass.
+ -- c. Compare aux files to find out.
+ end
+ end
+ end
+ if (quiet ~= "") and not OK then
+ report_error(basename..".log")
+ end
+ if OK and latex then
+ report_warnings(basename..".log","LaTeX.*Warning")
+ end
+ if dvi then OK = OK and (execute(dvi .. " " .. basename) == 0) end
+ if dvi and ps2pdf then
+ OK = OK and (execute(ps2pdf .. " " .. basename .. ".ps") == 0)
+ if OK then
+ print(basename .. ".pdf generated by " .. ps2pdf .. ".")
+ end
+ end
+ if not OK then
+ print("!! Processing of " .. filename .. " fails.\n")
+ exit_code = exit_code+1
+ end
+end
+
+---- Report version information on musixtex.log
+
+-- File names and message signatures to be looked for in a TeX log file.
+logtargets = {
+mtxtex = {"mtx%.tex","mtxTeX"},
+mtxlatex = {"mtxlatex%.sty","mtxLaTeX"},
+pmxtex = {"pmx%.tex","PMX"},
+musixtex = {"musixtex%.tex","MusiXTeX"},
+musixltx = {"musixltx%.tex","MusiXLaTeX"},
+musixlyr = {"musixlyr%.tex","MusiXLYR"}
+}
+
+-- Signatures of messages displayed on standard output by programs
+capturetargets = {
+MTx = "This is (M%-Tx.->)",
+PMX = "This is (PMX[^\n]+)",
+pdftex = "This is (pdfTeX[^\n]+)",
+musixflx = "Musixflx%S+",
+autosp = "This is autosp.*$",
+index = "autosp,MTx,PMX,musixflx,pdftex"
+}
+
+function report_texfiles(logname)
+ local log = logname and io.open(logname)
+ if not log then return end
+ local lines =
+ {"--- TeX files actually included according to "..logname.." ---"}
+ log = log:read"*a"
+-- The following pattern matches filenames input by TeX, even if
+-- interrupted by a line break. It may include the first word of
+-- an \immediate\write10 message emitted by the file.
+ for pos,filename in log:gmatch"%(()(%.?[/]%a[%-/%.%w\n]+)" do
+ local hit
+ repeat
+ local oldfilename = filename
+ filename = oldfilename:match"[^\n]+" -- up to next line break
+ hit = io.open(filename) -- success if the file exists
+ if hit then break end
+ filename = oldfilename:gsub("\n","",1) -- remove line break
+ until filename==oldfilename
+ if hit then
+ for target,sig in pairs(logtargets) do
+ if filename:match(sig[1]) then
+ local i,j = log:find(sig[2].."[^\n]+",pos)
+ if j then lines[#lines+1] = filename.."\n "..log:sub(i,j) end
+ end
+ end
+ end
+ end
+ return table.concat(lines,'\n').."\n"
+end
+
+function report_versions(tempname)
+ if not tempname then return end -- only available with -q
+ local logs = io.open(tempname)
+ if not logs then
+ musixlog:write ("No version information: could not open "..tempname)
+ return
+ end
+ local versions = {}
+ musixlog:write("--- Programs actually executed according to "..tempname.." ---\n")
+ for line in logs:lines() do
+ for target in capturetargets.index:gmatch"[^,]+" do
+ if not versions[target] then
+ local found = line:match(capturetargets[target])
+ if found then
+ versions[target] = found
+ musixlog:write(found,"\n")
+ end
+ end
+ end
+ end
+ logs:close()
+ return
+end
+
+------------------------------------------------------------------------
+
+whoami()
+
+defaults()
+
+exit_code = 0
+narg = 1
+protect = {} -- extensions not to be deleted, even if cleanup requested
+
+repeat
+ this_arg = arg[narg]
+ if this_arg:match"^%-" then process_option(this_arg)
+ else
+ basename, extension = find_file(this_arg) -- nil,nil if not found
+ if tex then -- tex output enabled, now select engine
+ if tex:match"pdf" then dvi = nil end
+ if not dvi then ps2pdf = nil end
+ -- .ltx extension will be taken into account later, in `process`
+ -- deduce tex/latex from current engine name if -l is not specified
+ if not override:match"l" then latex = tex:match"latex" end
+ if not force_engine then -- select appropriate default engine
+ if latex then
+ if dvi==nil then tex = "pdflatex" else tex = "latex" end
+ else
+ if dvi==nil then tex = "pdfetex" else tex = "etex" end
+ end
+ end
+ end
+ extension = preprocess(basename, extension)
+ tex_process(tex,basename,extension)
+ if basename and io.open(basename..".log") then -- to be printed later
+ versions = report_texfiles(basename..".log")
+ end
+ if basename and cleanup then
+ remove("pmxaerr.dat")
+ for ext in ("mx1,mx2,dvi,ps,idx,log,ilg,pml,pmxprep"):gmatch"[^,]+" do
+ if not protect[ext] then remove(basename.."."..ext)
+ end
+ end
+ end
+ protect = {}
+ end
+ narg = narg+1
+until narg > #arg
+
+if versions then musixlog:write(versions) end
+report_versions(tempname)
+musixlog:close()
+os.exit( exit_code )