packages feed

jammittools (empty) → 0.2.0.1

raw patch · 11 files changed

+2460/−0 lines, 11 filesdep +basedep +boxesdep +containerssetup-changed

Dependencies added: base, boxes, containers, directory, filepath, process, property-list, temporary, transformers

Files

+ LICENSE view
@@ -0,0 +1,674 @@+                    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>.
+ README.md view
@@ -0,0 +1,116 @@+# `jammittools`++A command-line tool for exporting sheet music and audio from the Windows/Mac app [Jammit].+It should go without saying, but please do not distribute content from songs you have purchased --+it is for your use only!++[Jammit]: https://www.jammit.com/++## Requirements++This is basically a fancy shell script but written in Haskell.+[ImageMagick](http://www.imagemagick.org) and [Sox](http://sox.sourceforge.net/)+are used to do the actual conversion work, so install those and put them in your path.+If you're on Windows, ImageMagick `convert` infamously conflicts with a system tool of the same name,+but `jammittools` tries looking in your Program Files so you shouldn't have to do anything.++## Usage++    jammittools -?+    # Print usage info.++    jammittools -d+    # Displays the entire library.++    jammittools -t "My Song" -r "Some Artist" -x dir+    # Easiest export option: exports all sheet music and audio for a song.++    jammittools -t "My Song" -r "Some Artist" -s file.pdf -y <parts>+    # Exports a single sheet music file with a list of parts, interleaved.+    # See below for the syntax of instrument parts.++    jammittools -t "My Song" -r "Some Artist" -a file.wav -y <parts>+    # Exports a single audio file with a list of parts, mixed together.+    # See below for the syntax of instrument parts.++    jammittools -t "My Song" -r "Some Artist" -c -y <parts>+    # Do a "dry run" of audio extraction, which checks if the parts exist+    # but does not do any conversion. Exits with a non-zero code if any+    # part does not exist.++Other lesser-used flags:++    -j /path/to/jammit/lib+    # On Windows and OS X, the official app's library location is used+    # if you do not specify this flag.+    # You can also specify the environment variable JAMMIT.++    -T "My Song"+    # Exact search on title, instead of -t which is case-insensitive substring.++    -R "Some Artist"+    # Exact search on artist, instead of -r which is case-insensitive substring.++    -n <parts>+    # Allows you to invert certain audio parts when exporting a WAV file.+    # This can be used to access "hidden" parts that aren't a part of any+    # transcribed instrument part, see below.++    -l <number>+    # Select the number of sheet music systems per page.+    # One system contains a line from each individual part.+    # If this flag is not given, an appropriate number of systems will be chosen+    # to get close to an 8.5" by 11" page ratio.++Instrument parts are given by this somewhat terse syntax:++    g - Guitar (1)+    r - Guitar 2+    b - Bass+    d - Drums+    k - Keyboard (1)+    y - Keyboard 2+    p - Piano+    s - Synth+    v - Vocals (Lead)+    x - Vocals (Backing)+    GRB - in sheet music, tab instead of notation+    GBDKV - in audio, the backing track for an instrument++So, for example, to make a backing track consisting of just drums and bass:++    jammittools <search parameters> -a out.wav -y db++To make a sheet music file with Guitar 1's notation and tab interleaved:++    jammittools <search parameters> -s out.pdf -y gG++## Accessing hidden parts++Not all the audio in a song has been transcribed and sold by Jammit. Things such+as sound-effects, other instruments like violin, and occasionally third guitar+or keyboard parts are "hidden" inside the backing tracks for every instrument+package that you can purchase. You can listen to these parts by performing+audio subtraction, where you take two audio files, invert one of them, and then+mix them together.++Let's say you own all 5 instruments for a song. You can access the "hidden"+track with the following command:++    jammittools <search parameters> -a out.wav -y D -n grbkyvx++This uses the `-n` flag to mix many audio files in after inverting them.+The `D` part is the backing track for the drums package. What this does is+subtract the non-drums instrument parts from this backing track, leaving you+with just the portion of the song that isn't present in any of the transcribed+parts. If you use the `-x` option to export all parts of a song, this process+will be done for you and placed in a file called `backing.wav`.++The resulting file has a thin layer of noise, because all the audio used in+Jammit is lossily encoded, which means the backing tracks are not quite perfect+mixes of their constituent parts. But the results are generally pretty good,+and you can easily use something like [Audacity]'s noise filter to clean it up+further. Using the drums backing track as a base is preferred, because drums+leaves the most audible noise when you remove it from a different backing track.++[Audacity]: http://audacity.sourceforge.net/
+ Setup.lhs view
@@ -0,0 +1,4 @@+#! /usr/bin/env runhaskell++> import Distribution.Simple+> main = defaultMain
+ cbits/aifc2wav-5.1.c view
@@ -0,0 +1,785 @@+/* public domain+ * ima4, sowt and sdx2 handled+ * sdx2 not hardly tested, may fail, contact me if problems+ * endian-independant code+ * sed@free.fr for comments/suggestions/anything+ * http://sed.free.fr/aifc2wav.html+ * Wed, 22 Jan 2003+ * Last update: Fri, 30 Mar 2007+ *+ * algo, tables ripped from http://www.pcisys.net/~melanson/codecs/adpcm.txt+ * the above link looks dead (2007-03-30), try the following link+ *   http://wiki.multimedia.cx/index.php?title=Category:ADPCM_Audio_Codecs+ *+ * file format in : ftp://ftp.sgi.com/sgi/aiff-c.9.26.91.ps.Z+ *+ * http://www.mactech.com/articles/mactech/Vol.06/06.01/SANENormalized/+ * helped for handling extended numbers+ *+ * http://ewhac.best.vwh.net/3DO-old/music/+ * for sdx2 code (see aif2raw.c there)+ */++/* handled chunks types */+#define FORM        1+#define COMM        2+#define FVER        3+#define SSND        4++#include <stdio.h>+#include <stdlib.h>+#include <string.h>++static int index_table[16] = {+    -1, -1, -1, -1, 2, 4, 6, 8,+    -1, -1, -1, -1, 2, 4, 6, 8,+};++static int step_table[89] = {+    7, 8, 9, 10, 11, 12, 13, 14, 16, 17,+    19, 21, 23, 25, 28, 31, 34, 37, 41, 45,+    50, 55, 60, 66, 73, 80, 88, 97, 107, 118,+    130, 143, 157, 173, 190, 209, 230, 253, 279, 307,+    337, 371, 408, 449, 494, 544, 598, 658, 724, 796,+    876, 963, 1060, 1166, 1282, 1411, 1552, 1707, 1878, 2066,+    2272, 2499, 2749, 3024, 3327, 3660, 4026, 4428, 4871, 5358,+    5894, 6484, 7132, 7845, 8630, 9493, 10442, 11487, 12635, 13899,+    15289, 16818, 18500, 20350, 22385, 24623, 27086, 29794, 32767+};++/* parse a chunk - waits a 34 bytes buffer, returns a little endian buffer */+void decode_chunk(unsigned char *input, unsigned char *output, short *static_predictor)+{+  char d;+  int i;+  short predictor;+  short step_index;+  int hnb, lnb;+  int diff;+  int sign, delta;+  short step;++  d = *input++;+  predictor=d << 8;+  d = *input++;+  step_index = d & 127;+  predictor |= d&128;++  // onyxite: use this channel's last packet's last sample as predictor+  predictor = *static_predictor;++  /* is this necessary ? */+  if (step_index < 0) step_index = 0;+  if (step_index > 88) step_index = 88;++  step = step_table[step_index];++  for (i=0; i<32; i++, input++) {+    d = *input;+    hnb = (d>>4) & 15;+    lnb = d & 15;++    /* decode lnb */+    step_index += index_table[lnb];+    /* necessary ? */+    if (step_index<0) step_index = 0;+    if (step_index>88) step_index = 88;++    sign = lnb & 8;+    delta = lnb & 7;+    diff = step >> 3;+    if (delta & 4) diff += step;+    if (delta & 2) diff += step >> 1;+    if (delta & 1) diff += step >> 2;+    /* take care of clamping (Adam Sampson <ats@offog.org>) */+    if (sign) {+      int p = ((int) predictor) - diff;+      if (p < -32768)+        predictor = -32768;+      else+        predictor = p;+    } else {+      int p = ((int) predictor) + diff;+      if (p > 32767)+        predictor = 32767;+      else+        predictor = p;+    }++    *output = predictor&255;+    output++;+    *output = (predictor>>8)&255;+    output++;++    step = step_table[step_index];++    /* decode hnb */+    step_index += index_table[hnb];+    if (step_index<0) step_index = 0;+    if (step_index>88) step_index = 88;++    sign = hnb & 8;+    delta = hnb & 7;+    diff = step >> 3;+    if (delta & 4) diff += step;+    if (delta & 2) diff += step >> 1;+    if (delta & 1) diff += step >> 2;+    /* take care of clamping (Adam Sampson <ats@offog.org>) */+    if (sign) {+      int p = ((int) predictor) - diff;+      if (p < -32768)+        predictor = -32768;+      else+        predictor = p;+    } else {+      int p = ((int) predictor) + diff;+      if (p > 32767)+        predictor = 32767;+      else+        predictor = p;+    }++    *output = predictor&255;+    output++;+    *output = (predictor>>8)&255;+    output++;++    // onyxite: save this sample so (if it's the last sample in this packet)+    // it becomes the predictor for the next packet in this channel+    *static_predictor = predictor;++    step = step_table[step_index];+  }+}++/* reads the FILE, return the type of the chunk, size too */+/* return -1 on error, -2 if unhandled chunk, -3 if EOF */+int get_type(FILE *f, long *size)+{+  int ret;++  unsigned char buf[8];++  ret=fread(buf, 1, 8, f);++  if (ret == 0 && feof(f))+    return -3;++  if (ferror(f) || ret != 8)+    return -1;++  *size = (unsigned)(buf[4]<<24) + (buf[5]<<16) + (buf[6]<<8) + buf[7];++  if (!strncmp((char*)buf, "FORM", 4)) {+    /* let's check if it's AIFC or not */+    if (fread(buf, 1, 4, f) != 4)+      return -1;++    if (strncmp((char*)buf, "AIFC", 4)) {+      buf[4] = 0;+      fprintf(stderr, "unsupported type %s\nonly AIFC handled\n", buf);+      return -1;+    }++    *size -= 4;+    return FORM;+  }++  if (!strncmp((char*)buf, "COMM", 4))+    return COMM;++  if (!strncmp((char*)buf, "FVER", 4))+    return FVER;++  if (!strncmp((char*)buf, "SSND", 4))+    return SSND;++  if (!strncmp((char*)buf, "FLLR", 4))+    return -2;++  buf[4] = 0;+  fprintf(stderr, "warning: unhandled chunk %s (size=%ld)\n", buf, *size);++  return -2;+}++/* transform an int into a little endian buffer */+unsigned char *itole(unsigned long l, unsigned char *t)+{+  *t = l & 255;+  *(t+1) = (l >>  8) & 255;+  *(t+2) = (l >> 16) & 255;+  *(t+3) = (l >> 24) & 255;+  return t;+}++/* transform a short into a little endian buffer */+unsigned char *stole(unsigned short l, unsigned char *t)+{+  *t = l & 255;+  *(t+1) = (l >>  8) & 255;+  return t;+}++/* different flags to know what chunk here, what chunk has been proceeded */+#define FORM_DONE        1+#define COMM_DONE        2+#define FVER_DONE        4+#define SSND_DONE        8++/* we don't want stack space for those */+static unsigned char buf[24];+static unsigned char in[34];+static unsigned char out[256];  /* only 128 if mono, 256 if stereo */+static unsigned char out2[128]; /* for stereo, another buffer (we must+                                 * interleave the two buffers in the WAV file)+                                 */++/* != file types supported */+#define IMA4        1+#define SOWT        2+#define SDX2        3++int aifc2wav_main(int n, char **v)+{+  long size;+  int flags = 0;+  char *input_file;+  char *output_file;+  FILE *fin, *fout;+  int nb_chans;                /* number of channels, must be 1 or 2 */+  int nb_frames;        /* number of sound chunks */+  int nb_bits;                /* nb bits / sample, must be 16 */+  long double freq;        /* sample rate */+  long ssnd_pos;        /* pos of beginning of the stream in the input file */+  long total_size=1;        /* some files are bigger than what says FORM size+                         * so we must only parse the nb of bytes given by+                         * FORM size (init to 1 for the while to run)+                         */+  int sound_type=0;        /* the type of the data in the sound file */+  long riff_size;        /* the riff size - depends of the type of data sound */+  short *last;                /* for SDX2 files */++  short predictor_left = 0;+  short predictor_right = 0;++  if (n != 3) {+    fprintf(stderr, "usage: %s <input AIFC file> <output WAV file>\n", v[0]);+    return 1;+  }++  input_file = v[1];+  output_file = v[2];++  fin = fopen(input_file, "rb");+  if (!fin) {+    perror(input_file);+    return 1;+  }++  fout = fopen(output_file, "wb");+  if (!fout) {+    perror(output_file);+    fclose(fin);+    return 1;+  }++  /* we don't care about the order (only FORM must be first) */+  /* we require only one SSND, one COMM, at most one FVER, that's all */+  /* total_size must be != 0 before to come here */+  while(total_size)+  switch (get_type(fin, &size)) {+    case FORM :+      if (flags) goto bad_file;++      flags = FORM_DONE;+      total_size = size;++      break;++    case COMM :+      if (!(flags & FORM_DONE)) goto bad_file;++      if (flags & COMM_DONE) goto bad_file;++      total_size -= 8;+      if (total_size < 0) goto in_error_size;++      flags |= COMM_DONE;++      if (fread(buf, 1, 22, fin) != 22)+        goto bad_file;+      total_size -= 22;+      if (total_size < 0) goto in_error_size;++      nb_chans = (buf[0]<<8) + buf[1];+      nb_frames = (unsigned)(buf[2]<<24) + (buf[3]<<16) + (buf[4]<<8) + buf[5];+      nb_bits = (buf[6]<<8) + buf[7];++      /* converting this silly extended format into freq+       * IAFC people are weird, why extended ?+       * this code is far from efficient+       * based on :+       * http://www.mactech.com/articles/mactech/Vol.06/06.01/SANENormalized/+       * this may fail on your machine, it works on ia32 and sparc+       */+      {+        int sign = (buf[8] >> 7) & 1;+        int exp = ((buf[8] & 127) << 8) + buf[9] - 16383;+        int j = (buf[10]>>7)&1;+        unsigned long frac = ((buf[10]&127) << 24) ++                              (buf[11] << 16) ++                              (buf[12] << 8) ++                              (buf[13]);+        unsigned long frac2 = (unsigned)(buf[14] << 24) ++                              (buf[15] << 16) ++                              (buf[16] << 8) ++                              (buf[17]);+        int i;++        freq = frac2;+        for (i=0; i<32; i++) freq /= 2;+        freq += frac;+        for (i=0; i<31; i++) freq /= 2;+        if (j) freq += 1.;+        while (exp) {+          freq *= 2;+          exp--;+        }++        if (sign) freq = -freq;+      }++      if (nb_chans != 1 && nb_chans != 2) {+        fprintf(stderr, "nb of channels = %d\nonly 1 or 2 channels handled\n",+                nb_chans);+        goto bad_file;+      }++      // onyxite: assume 16 bit samples+      if (nb_bits == 0) {+        nb_bits = 16;+      }+      +      if (nb_bits != 16) {+        fprintf(stderr, "bits per sample = %d\nonly 16 bits handled\n",+                nb_bits);+        goto bad_file;+      }++      /* 1e7 is enough ? */+      if (freq <= 0 || freq >=1e7) {+        fprintf(stderr, "freq = %Lf\nonly 0 < freq < 1e7 handled\n", freq);+        goto bad_file;+      }++      /* let's test if it's a ima4, sowt or SDX2 or something else */+      memcpy(buf, &buf[18], 4);+      buf[4] = 0;+      if (strcmp((char*)buf, "ima4") &&+          strcmp((char*)buf, "sowt") &&+          strcmp((char*)buf, "SDX2")) {+        fprintf(stderr,+          "compression scheme = %s\nonly ima4, sowt and SDX2 handled\n", buf);+        goto bad_file;+      }+      sound_type = IMA4;+      if (!strcmp((char*)buf, "sowt"))+        sound_type = SOWT;+      else if (!strcmp((char*)buf, "SDX2"))+        sound_type = SDX2;++      /* should we optimize here ? no */+      /* the doc says there may be a non-counted byte */+      if (size & 1) size++;+      size -= 22;+      total_size -= size;+      if (total_size < 0) goto in_error_size;++      while(size > 0) {+        int c = fgetc(fin);+        if (c == EOF) {+          fprintf(stderr, "error with COMM chunk, bad size\n");+          goto bad_file;+        }+        size--;+      }++      break;++    case FVER : {+      unsigned long version;++      if (!(flags & FORM_DONE)) goto bad_file;++      if (flags & FVER_DONE) goto bad_file;++      flags |= FVER_DONE;++      total_size -= 8;+      if (total_size < 0) goto in_error_size;++      if (fread(buf, 1, 4, fin) != 4)+        goto bad_file;+      total_size -= 4;+      if (total_size < 0) goto in_error_size;++      version = (unsigned)(buf[0]<<24) + (buf[1]<<16) + (buf[2]<<8) + buf[3];++      if (version != 2726318400U) {+        fprintf(stderr, "version = %lu\nonly 2726318400 handled\n", version);+        goto bad_file;+      }++      /* size should be 4, what to do ? if we don't read, there might+       * be a problem, but someone might not set it to 4 and still+       * telling us there is nothing more... well, let's read it+       */+      /* the doc says there may be a non-counted byte */+      if (size & 1) size++;+      size -= 4;+      total_size -= size;+      if (total_size < 0) goto in_error_size;++      while(size > 0) {+        int c = fgetc(fin);+        if (c == EOF) {+          fprintf(stderr, "error with FVER chunk, bad size\n");+          goto bad_file;+        }+        size--;+      }++      break;+    }++    case SSND : {+      unsigned long offset, blocksize;+      unsigned long nbbytes=0;++      if (!(flags & FORM_DONE)) goto bad_file;++      if (flags & SSND_DONE) {+        fprintf(stderr, "more than one SSND\n");+        goto bad_file;+      }++      total_size -= 8;+      if (total_size < 0) goto in_error_size;++      flags |= SSND_DONE;++      if (fread(buf, 1, 8, fin) != 8)+        goto bad_file;+      total_size -= 8;+      if (total_size < 0) goto in_error_size;++      offset = (unsigned)(buf[0]<<24) + (buf[1]<<16) + (buf[2]<<8) + buf[3];+      blocksize = (unsigned)(buf[4]<<24) + (buf[5]<<16) + (buf[6]<<8) + buf[7];++#if 0+      if (offset || blocksize) {+        fprintf(stderr, "offset = %lu, blocksize = %lu\nthey both must be 0\n",+                offset, blocksize);+        goto bad_file;+      }+#endif++      ssnd_pos = ftell(fin) + offset;+      if (ssnd_pos == -1) {+        perror("ftell");+        goto bad_file;+      }++      /* the doc says there may be a non-counted byte */+      if (size & 1) size++;++      /* we should optimize here, no ? */+      size -= 8;+      total_size -= size;+      if (total_size < 0) goto in_error_size;++      while(size > 0) {+        int c = fgetc(fin);+#if 0+        if (c == EOF) {+          fprintf(stderr, "error with SSND chunk, bad size\n");+          goto bad_file;+        }+#endif+        if (c == EOF) {+          if (!(flags & COMM_DONE)) goto bad_file;++          /* a little hack to update nb_frames for sowt only */+          fprintf(stderr, "warning - bad size in SSND, the output file will"+                          " probably be wrong\n");++          nbbytes -= offset;+          if (sound_type == SDX2) {+            fprintf(stderr, "error - for SDX2 files, I don't know what to"+                            " do\nContact sed@free.fr to see what"+                            " we can do.\n");+            goto both_error;+          } else if (sound_type == SOWT)+            nbbytes /= 2;+          else+            nbbytes /= 34;+          if (nb_chans == 2) nbbytes /= 2;+          nb_frames = nbbytes;++          /* we go to all_parsed, because it's EOF */+          goto all_parsed;+        }++        nbbytes++;+        size--;+      }++      break;+    }++    /* -1 is error */+    case -1:+        goto bad_file;++    /* -2 is unhandled chunk type, so pass it */+    case -2: {+      if (!(flags & FORM_DONE)) goto bad_file;++      total_size -= 8;+      if (total_size < 0) goto in_error_size;++      /* the doc says there may be a non-counted byte */+      if (size & 1) size++;+      total_size -= size;+      if (total_size < 0) goto in_error_size;++      while (size) {+        int c = fgetc(fin);+        if (c == EOF)+          goto bad_file;+        size --;+      }+      break;+    }++    /* -3 is EOF */+    case -3 :+      /* this may be an error, let's just produce a warning */+      fprintf(stderr, "warning: your file is shorter than expected\n");+      goto all_parsed;++    default : +      fprintf(stderr, "you should not read this...\n");+      goto bad_file;+  }++all_parsed:+  /* we must have parsed COMM and SSND */+  if ((flags & (COMM_DONE | SSND_DONE)) != (COMM_DONE | SSND_DONE)) {++    if (!(flags & COMM_DONE))+      fprintf(stderr, "no COMM chunk found\n");++    if (!(flags & SSND_DONE))+      fprintf(stderr, "no SSND chunk found\n");++    goto bad_file;+  }++  /* is freq an integer ? */+  if (freq != (long double)((int)freq))+    fprintf(stderr, "warning, freq = %Lf will be truncated to %d\n",+        freq, (int)freq);++  /* all is alright */++  /* write header of wav */+  /* start with RIFF */+  if (fwrite("RIFF", 1, 4, fout) != 4) goto out_error;++  if (sound_type == IMA4)+    riff_size = nb_frames * 128;+  else+    riff_size = nb_frames * 2;+  if (nb_chans == 2)+    riff_size *= 2;++  /* then size of the stuff */+  if (fwrite(itole(riff_size+36, buf), 1, 4, fout) != 4) goto out_error;++  /* then WAVEfmt */+  if (fwrite("WAVEfmt ", 1, 8, fout) != 8) goto out_error;++  /* length of fmt chunk (16) */+  if (fwrite(itole(16, buf), 4, 1, fout) != 1) goto out_error;++  /* 1 => PCM */+  if (fwrite(stole(1, buf), 2, 1, fout) != 1) goto out_error;++  /* nb of channels */+  if (fwrite(stole(nb_chans, buf), 2, 1, fout) != 1) goto out_error;++  /* freq */+  if (fwrite(itole((int)freq, buf), 4, 1, fout) != 1) goto out_error;++  /* don't know what */+  if (fwrite(itole((int)freq * nb_chans * (nb_bits/8), buf), 4, 1, fout) != 1)+    goto out_error;++  /* don't know what */+  if (fwrite(stole(nb_chans * (nb_bits/8), buf), 2, 1, fout) != 1)+    goto out_error;++  /* nb bits */+  if (fwrite(stole(nb_bits, buf), 2, 1, fout) != 1) goto out_error;++  /* data chunk */+  if (fwrite("data", 4, 1, fout) != 1) goto out_error;++  /* data size */+  if (fwrite(itole(riff_size, buf), 1, 4, fout) != 4) goto out_error;++  /* let's kick all the frames out */+  if (fseek(fin, ssnd_pos, SEEK_SET) == -1) goto out_error;++  if (sound_type != SOWT) goto not_sowt;++  /* sowt */+  while (nb_frames) {+    nb_frames--;++    if (fread(in, 1, 2, fin) != 2) {+      perror(input_file);+      goto bad_file;+    }+    if (fwrite(in, 1, 2, fout) != 2)+      goto out_error;++    if (nb_chans == 1)+      continue;++    if (fread(in, 1, 2, fin) != 2) {+      perror(input_file);+      goto bad_file;+    }+    if (fwrite(in, 1, 2, fout) != 2)+      goto out_error;+  }++  goto file_done;++not_sowt:+  /* SDX2? */+  if (sound_type != SDX2) goto not_sdx2;++  last = malloc(nb_chans * sizeof(short));+  if (!last) {+    perror("memory");+    goto both_error;+  }+  memset(last, 0, sizeof(short) * nb_chans);++  while (nb_frames > 0) {+    signed char src;+    unsigned short dst;+    int i;++    nb_frames--;++    for (i=0; i<nb_chans; i++) {+      if (fread(&src, 1, 1, fin) != 1) {+        perror(input_file);+        free(last);+        goto bad_file;+      }++      if (src & 1)+        dst = last[i] + ((src * abs(src)) << 1);+      else+        dst = (src * abs(src)) << 1;++      last[i] = dst;++      /* out is 256 bytes, so we're fine */+      out[0] = dst&255;+      out[1] = (dst>>8)&255;++      if (fwrite(out, 1, 2, fout) != 2) {+        free(last);+        goto out_error;+      }+    }+  }++  free(last);++  goto file_done;++not_sdx2:+  /* ima4 */+  while (nb_frames) {+    if (fread(in, 1, 34, fin) != 34) {+      perror(input_file);+      goto bad_file;+    }++    decode_chunk(in, out, &predictor_left);++    /* if stereo mode the next chunk is right channel */+    if (nb_chans == 2) {+      int i;++      if (fread(in, 1, 34, fin) != 34) {+        perror(input_file);+        goto bad_file;+      }++      decode_chunk(in, out2, &predictor_right);++      /* we must now interleave the two channels */++      /* first part, move the first channel to its correct position */+      /* we should optimize this code */+      for (i=63; i>0; i--) {+        out[i*4] = out[i*2];+        out[i*4+1] = out[i*2+1];+      }++      /* second, add right channel to output buffer */+      /* we should optimize this code */+      for (i=0; i<64; i++) {+        out[i*4+2] = out2[i*2];+        out[i*4+3] = out2[i*2+1];+      }+    }++    if (fwrite(out, 1, nb_chans == 2 ? 256 : 128, fout) !=+                (nb_chans == 2 ? 256 : 128))+      goto out_error;++    nb_frames--;+  }++file_done:+  fclose(fin);+  fclose(fout);+  return 0;++in_error_size:+  fprintf(stderr, "the size information of your file is bad\n");++bad_file:+  fprintf(stderr, "%s: bad sound file, can't load\n", input_file);+  fprintf(stderr, "contact sed@free.fr to add support for your file\n");++both_error:+  fclose(fin);+  fclose(fout);+  remove(output_file);+  return 1;++out_error:+  perror(output_file);+  goto both_error;+}
+ jammittools.cabal view
@@ -0,0 +1,55 @@+Name:               jammittools+Version:            0.2.0.1+Synopsis:           Export sheet music and audio from Windows/Mac app Jammit+Description:        <http://www.jammit.com/ Jammit> is a service and associated+                    app for Windows\/Mac\/iOS that sells isolated instrument+                    audio tracks from popular music, along with full+                    transcriptions. This is a tool that allows you to export the+                    sheet music (in PDF format) and audio (in WAV format) to+                    tracks that you have purchased.+                    .+                    Any sheet music or audio you export is solely for your own+                    use, e.g. for use on Linux and Android devices that do not+                    have the official app available. Please do not use this tool+                    to share content with others who have not purchased it!+                    .+                    You must install ImageMagick and Sox for sheet music and+                    audio export respectively, because they are used to do the+                    actual conversion.+                    Please see the+                    <https://github.com/mtolly/jammittools/blob/master/README.md README>+                    for usage information.+License:            GPL+License-File:       LICENSE+Author:             Michael Tolly+Maintainer:         miketolly@gmail.com+Build-Type:         Simple+Cabal-Version:      >= 1.8+Category:           Sound+Homepage:           https://github.com/mtolly/jammittools+Bug-Reports:        https://github.com/mtolly/jammittools/issues+Extra-Source-Files: README.md++Executable jammittools+  Main-Is:          Main.hs+  Other-Modules:    AIFC2WAV+                    ImageMagick+                    Jammit+                    Sox+                    TempFile+  Hs-Source-Dirs:   src+  Build-Depends:    base            >= 4.6.0.1 && < 5+                    , property-list >= 0.1.0.4 && < 0.2+                    , directory     >= 1.2.0.1 && < 1.3+                    , filepath      >= 1.3.0.1 && < 1.4+                    , containers    >= 0.5.0.0 && < 0.6+                    , process       >= 1.1.0.2 && < 1.3+                    , temporary     >= 1.1.2.5 && < 1.3+                    , boxes         >= 0.1.3   && < 1.2+                    , transformers  >= 0.3.0.0 && < 0.5+  Ghc-Options:      -Wall+  C-Sources:        cbits/aifc2wav-5.1.c++Source-Repository head+  Type:             git+  location:         https://github.com/mtolly/jammittools
+ src/AIFC2WAV.hs view
@@ -0,0 +1,27 @@+{-# LANGUAGE ForeignFunctionInterface #-}+module AIFC2WAV+( aifcToWav+) where++import Foreign.C (withCString, CInt(..), CChar(..))+import Foreign.Marshal.Array (withArrayLen)+import Foreign.Ptr (Ptr)++import TempFile++foreign import ccall unsafe "aifc2wav_main" aifc2wav_main+  :: CInt -> Ptr (Ptr CChar) -> IO CInt++-- | Given a (new-style) IMA4-compressed AIFC file, converts it to a WAV file.+aifcToWav :: FilePath -> TempIO FilePath+aifcToWav aifc = do+  wav <- newTempFile "aifcToWav.wav"+  code <- liftIO $+    withCString "aifc2wav" $ \progC ->+    withCString aifc       $ \aifcC ->+    withCString wav        $ \wavC  ->+    withArrayLen [progC, aifcC, wavC] $ \n v ->+      aifc2wav_main (fromIntegral n) v+  if code == 0+    then return wav+    else error $ "aifcToWav: returned " ++ show code
+ src/ImageMagick.hs view
@@ -0,0 +1,89 @@+module ImageMagick+( connectVertical+, splitVertical+, joinPages+) where++import Control.Applicative ((<$>))+import Control.Monad (void)+import Data.Char (isDigit)+import Data.List (isPrefixOf, sortBy)+import Data.Maybe (listToMaybe)+import Data.Ord (comparing)+import System.Environment (lookupEnv)+import System.Exit (ExitCode(..))+import qualified System.Info as Info++import System.Directory (getDirectoryContents)+import System.FilePath ((</>))+import System.IO.Temp (createTempDirectory)+import System.Process (readProcess, readProcessWithExitCode)++import TempFile++-- | Find an ImageMagick binary, because the names are way too generic, and+-- "convert" is both an ImageMagick program and a Windows built-in utility.+imageMagick :: String -> IO (Maybe String)+imageMagick cmd = do+  (code, _, _) <- readProcessWithExitCode cmd ["-version"] ""+  case code of+    ExitSuccess -> return $ Just cmd+    _ -> case Info.os of+      "mingw32" -> firstJustM $+        -- env variables for different configs of (ghc arch)/(imagemagick arch)+        -- ProgramFiles: 32/32 or 64/64+        -- ProgramFiles(x86): 64/32+        -- ProgramW6432: 32/64+        flip map ["ProgramFiles", "ProgramFiles(x86)", "ProgramW6432"] $ \env ->+          lookupEnv env >>= \var -> case var of+            Nothing -> return Nothing+            Just pf+              ->  fmap (\im -> pf </> im </> cmd)+              .   listToMaybe+              .   filter ("ImageMagick" `isPrefixOf`)+              <$> getDirectoryContents pf+      _ -> return Nothing++imageMagick' :: String -> IO String+imageMagick' cmd = imageMagick cmd >>= \ms -> case ms of+  Nothing -> error $ "imageMagick': couldn't find program " ++ cmd+  Just s  -> return s++-- | Only runs actions until the first that gives 'Just'.+firstJustM :: (Monad m) => [m (Maybe a)] -> m (Maybe a)+firstJustM [] = return Nothing+firstJustM (mx : xs) = mx >>= \x -> case x of+  Nothing -> firstJustM xs+  Just y  -> return $ Just y++-- | Stick images together vertically into one long image.+connectVertical :: [FilePath] -> TempIO FilePath+connectVertical [fin] = return fin+connectVertical fins = do+  cmd  <- liftIO $ imageMagick' "montage"+  fout <- newTempFile "connectVertical.png"+  void $ liftIO $ readProcess cmd+    (["-geometry", "100%", "-tile", "1x"] ++ fins ++ [fout]) ""+  return fout++-- | Splits an image vertically into chunks of a given height.+splitVertical :: Integer -> FilePath -> TempIO [FilePath]+splitVertical i fin = do+  cmd      <- liftIO $ imageMagick' "convert"+  tempdir  <- ask+  splitdir <- liftIO $ createTempDirectory tempdir "splitVertical"+  void $ liftIO $+    readProcess cmd ["-crop", "x" ++ show i, fin, splitdir </> "x.png"] ""+  map (splitdir </>) . sortBy (comparing getNumber) . filter isFile+    <$> liftIO (getDirectoryContents splitdir)+  where getNumber :: String -> Integer+        getNumber = read . takeWhile isDigit . dropWhile (not . isDigit)+        isFile = (`notElem` [".", ".."])++-- | Joins several images into a PDF, where each image is a page.+joinPages :: [FilePath] -> TempIO FilePath+joinPages fins = do+  cmd  <- liftIO $ imageMagick' "convert"+  fout <- newTempFile "joinPages.pdf"+  void $ liftIO $ readProcess cmd (fins ++ [fout]) ""+  return fout
+ src/Jammit.hs view
@@ -0,0 +1,253 @@+module Jammit+( Instrument(..)+, Part(..)+, AudioPart(..)+, SheetPart(..)+, titleToPart+, titleToAudioPart+, partToInstrument+, audioPartToInstrument+, Info(..)+, Track(..)+, loadInfo+, loadTracks+, findJammitDir+, songSubdirs+) where++import Control.Applicative ((<$>), (<*>), liftA2)+import Control.Arrow ((***))+import Control.Exception (evaluate)+import Control.Monad (filterM, guard)+import Data.Char (toLower, toUpper)+import Data.Maybe (catMaybes)+import System.Environment (lookupEnv)+import Text.Read (readMaybe)++import qualified Data.Map as Map+import qualified Data.PropertyList as PL+import qualified System.Directory as Dir+import System.FilePath ((</>))+import qualified System.Info as Info++-- | The Enum instance corresponds to the number used in the "instrument"+-- property, and the names (used by Show/Read) are capitalized versions of those+-- used in the "skillLevel" property.+data Instrument = Guitar | Bass | Drums | Keyboard | Vocal+  deriving (Eq, Ord, Show, Read, Enum, Bounded)++data Part+  = PartGuitar1+  | PartGuitar2+  | PartBass+  | PartDrums+  | PartKeys1+  | PartKeys2+  | PartPiano+  | PartSynth+  | PartVocal+  | PartBVocals+  deriving (Eq, Ord, Show, Read, Enum, Bounded)++data AudioPart+  = Only Part+  | Without Instrument+  deriving (Eq, Ord, Show, Read)++data SheetPart+  = Notation Part+  | Tab Part+  deriving (Eq, Ord, Show, Read)++titleToPart :: String -> Maybe Part+titleToPart s = case s of+  "Guitar"   -> Just PartGuitar1+  "Guitar 1" -> Just PartGuitar1+  "Guitar 2" -> Just PartGuitar2+  "Bass"     -> Just PartBass+  "Drums"    -> Just PartDrums+  "Keys"     -> Just PartKeys1+  "Keys 1"   -> Just PartKeys1+  "Keys 2"   -> Just PartKeys2+  "Piano"    -> Just PartPiano+  "Synth"    -> Just PartSynth+  "Vocal"    -> Just PartVocal+  "B Vocals" -> Just PartBVocals+  _          -> Nothing++titleToAudioPart :: String -> Instrument -> Maybe AudioPart+titleToAudioPart "Band" i = Just $ Without i+titleToAudioPart s      _ = Only <$> titleToPart s++partToInstrument :: Part -> Instrument+partToInstrument p = case p of+  PartGuitar1 -> Guitar+  PartGuitar2 -> Guitar+  PartBass    -> Bass+  PartDrums   -> Drums+  PartKeys1   -> Keyboard+  PartKeys2   -> Keyboard+  PartPiano   -> Keyboard+  PartSynth   -> Keyboard+  PartVocal   -> Vocal+  PartBVocals -> Vocal++audioPartToInstrument :: AudioPart -> Instrument+audioPartToInstrument (Only    p) = partToInstrument p+audioPartToInstrument (Without i) = i++data Info = Info+  { album        :: String+  , artist       :: String+  , bpm          :: String+  , copyright    :: String+  , countInBeats :: Integer+  , courtesyOf   :: String+  , demo         :: Bool+  , explicit     :: Bool+  , genre        :: String+  , instrument   :: Instrument+  , publishedBy  :: String+  , skillLevel   :: Either Integer [(Instrument, Integer)]+  , sku          :: String+  , slow         :: Double+  , title        :: String+  , version      :: Integer+  , writtenBy    :: String+  } deriving (Eq, Ord, Show, Read)++instance PL.PropertyListItem Info where++  fromPropertyList pl = PL.fromPlDict pl >>= \dict -> Info+    <$> (Map.lookup "album"        dict >>= PL.fromPlString)+    <*> (Map.lookup "artist"       dict >>= PL.fromPlString)+    <*> (Map.lookup "bpm"          dict >>= PL.fromPlString)+    <*> (Map.lookup "copyright"    dict >>= PL.fromPlString)+    <*> (Map.lookup "countInBeats" dict >>= PL.fromPlInt   )+    <*> (Map.lookup "courtesyOf"   dict >>= PL.fromPlString)+    <*> (Map.lookup "demo"         dict >>=    fromPlEnum  )+    <*> (Map.lookup "explicit"     dict >>=    fromPlEnum  )+    <*> (Map.lookup "genre"        dict >>= PL.fromPlString)+    <*> (Map.lookup "instrument"   dict >>=    fromPlEnum  )+    <*> (Map.lookup "publishedBy"  dict >>= PL.fromPlString)+    <*> (Map.lookup "skillLevel"   dict >>=    fromPlSkills)+    <*> (Map.lookup "sku"          dict >>= PL.fromPlString)+    <*> (Map.lookup "slow"         dict >>= PL.fromPlReal  )+    <*> (Map.lookup "title"        dict >>= PL.fromPlString)+    <*> (Map.lookup "version"      dict >>= PL.fromPlInt   )+    <*> (Map.lookup "writtenBy"    dict >>= PL.fromPlString)++  toPropertyList info = PL.plDict $ Map.fromList+    [ ("album"       , PL.plString $ album        info)+    , ("artist"      , PL.plString $ artist       info)+    , ("bpm"         , PL.plString $ bpm          info)+    , ("copyright"   , PL.plString $ copyright    info)+    , ("countInBeats", PL.plInt    $ countInBeats info)+    , ("courtesyOf"  , PL.plString $ courtesyOf   info)+    , ("demo"        ,    plEnum   $ demo         info)+    , ("explicit"    ,    plEnum   $ explicit     info)+    , ("genre"       , PL.plString $ genre        info)+    , ("instrument"  ,    plEnum   $ instrument   info)+    , ("publishedBy" , PL.plString $ publishedBy  info)+    , ("skillLevel"  ,    plSkills $ skillLevel   info)+    , ("sku"         , PL.plString $ sku          info)+    , ("slow"        , PL.plReal   $ slow         info)+    , ("title"       , PL.plString $ title        info)+    , ("version"     , PL.plInt    $ version      info)+    , ("writtenBy"   , PL.plString $ writtenBy    info)+    ]++fromPlEnum :: (Enum a) => PL.PropertyList -> Maybe a+fromPlEnum pl = toEnum . fromIntegral <$> PL.fromPlInt pl++plEnum :: (Enum a) => a -> PL.PropertyList+plEnum = PL.plInt . fromIntegral . fromEnum++fromPlSkills+  :: PL.PropertyList -> Maybe (Either Integer [(Instrument, Integer)])+fromPlSkills pl = case (PL.fromPlInt pl, PL.fromPlDict pl) of+  (Nothing, Nothing) -> Nothing+  (Just i , _      ) -> Just $ Left i+  (_      , Just d ) -> let+    getSkill (x, y) = liftA2 (,) (readMaybe $ capitalize x) (PL.fromPlInt y)+    capitalize ""     = ""+    capitalize (c:cs) = toUpper c : map toLower cs+    in fmap Right $ mapM getSkill $ Map.toList d++plSkills :: Either Integer [(Instrument, Integer)] -> PL.PropertyList+plSkills (Left  i ) = PL.plInt i+plSkills (Right sl) = PL.plDict $+  Map.fromList $ map (map toLower . show *** PL.plInt) sl++loadInfo :: FilePath -> IO (Maybe Info)+loadInfo dir =+  PL.fromPropertyList <$> readXmlPropertyListFromFile' (dir </> "info.plist")++data Track = Track+  { trackClass          :: String+  , identifier          :: String+  , scoreSystemHeight   :: Maybe Integer+  , scoreSystemInterval :: Maybe Integer+  , trackTitle          :: Maybe String+  } deriving (Eq, Ord, Show, Read)++instance PL.PropertyListItem Track where++  toPropertyList t = PL.plDict $ Map.fromList $ catMaybes+    [ Just ("class"              , PL.plString $ trackClass          t)+    , Just ("identifier"         , PL.plString $ identifier          t)+    , (\i -> ("scoreSystemHeight"  , PL.plInt    i)) <$> scoreSystemHeight   t+    , (\i -> ("scoreSystemInterval", PL.plInt    i)) <$> scoreSystemInterval t+    , (\s -> ("title"              , PL.plString s)) <$> trackTitle          t+    ]++  fromPropertyList pl = PL.fromPlDict pl >>= \d -> Track+    <$>      (Map.lookup "class"               d >>= PL.fromPlString)+    <*>      (Map.lookup "identifier"          d >>= PL.fromPlString)+    <*> Just (Map.lookup "scoreSystemHeight"   d >>= PL.fromPlInt   )+    <*> Just (Map.lookup "scoreSystemInterval" d >>= PL.fromPlInt   )+    <*> Just (Map.lookup "title"               d >>= PL.fromPlString)++loadTracks :: FilePath -> IO (Maybe [Track])+loadTracks dir = PL.listFromPropertyList <$>+  readXmlPropertyListFromFile' (dir </> "tracks.plist")++-- | Reads strictly so as not to exhaust our allowed open files.+readXmlPropertyListFromFile' :: FilePath -> IO PL.PropertyList+readXmlPropertyListFromFile' f = do+  str <- readFile f+  _ <- evaluate $ length str+  either fail return $ PL.readXmlPropertyList str++-- | Tries to find the top-level Jammit library directory on Windows or+-- Mac OS X.+findJammitDir :: IO (Maybe FilePath)+findJammitDir = case Info.os of+  "mingw32" -> do+    var <- lookupEnv "LocalAppData"+    case var of+      Just local -> jammitIn local+      Nothing    -> return Nothing+  "darwin" -> do+    home <- Dir.getHomeDirectory+    jammitIn $ home </> "Library" </> "Application Support"+  _ -> return Nothing+  where jammitIn dir = do+          let jmt = dir </> "Jammit"+          b <- Dir.doesDirectoryExist jmt+          return $ guard b >> Just jmt++-- | Gets the contents of a directory without the @.@ and @..@ special paths,+-- and adds the directory to the front of all the names to make absolute paths.+lsAbsolute :: FilePath -> IO [FilePath]+lsAbsolute d =+  map (d </>) . filter (`notElem` [".", ".."]) <$> Dir.getDirectoryContents d++-- | Searches a directory and all subdirectories for folders containing a Jammit+-- info file.+songSubdirs :: FilePath -> IO [FilePath]+songSubdirs dir = do+  isSong <- Dir.doesFileExist $ dir </> "info.plist"+  let here = [dir | isSong]+  subdirs <- lsAbsolute dir >>= filterM Dir.doesDirectoryExist+  (here ++) . concat <$> mapM songSubdirs subdirs
+ src/Main.hs view
@@ -0,0 +1,320 @@+module Main (main) where++import Control.Applicative ((<$>), liftA2, (<|>))+import Control.Monad (forM, (>=>), forM_)+import Data.Char (toLower)+import Data.List (isInfixOf, transpose, sort, nub, partition, isPrefixOf)+import Data.Maybe (mapMaybe, catMaybes, fromMaybe, listToMaybe)+import Data.Version (showVersion)+import qualified System.Console.GetOpt as Opt+import qualified System.Environment as Env++import System.Directory (getDirectoryContents)+import System.FilePath ((</>), splitFileName, takeFileName)+import Text.PrettyPrint.Boxes+  (text, vcat, left, render, hsep, top, (/+/))++import AIFC2WAV+import ImageMagick+import Jammit+import qualified Paths_jammittools as Paths+import Sox+import TempFile++data Args = Args+  { filterLibrary :: Library -> Library+  , selectParts   :: String+  , rejectParts   :: String+  , pageLines     :: Maybe Int+  , jammitDir     :: Maybe FilePath+  , function      :: Function+  }++data Function+  = PrintUsage+  | ShowDatabase+  | ExportSheet FilePath+  | ExportAudio FilePath+  | ExportAll   FilePath+  | CheckPresence+  deriving (Eq, Ord, Show, Read)++defaultArgs :: Args+defaultArgs = Args+  { filterLibrary = id+  , selectParts   = ""+  , rejectParts   = ""+  , pageLines     = Nothing+  , jammitDir     = Nothing+  , function      = PrintUsage+  }++partToChar :: Part -> Char+partToChar p = case p of+  PartGuitar1 -> 'g'+  PartGuitar2 -> 'r'+  PartBass    -> 'b'+  PartDrums   -> 'd'+  PartKeys1   -> 'k'+  PartKeys2   -> 'y'+  PartPiano   -> 'p'+  PartSynth   -> 's'+  PartVocal   -> 'v'+  PartBVocals -> 'x'++charPartMap :: [(Char, Part)]+charPartMap = [ (partToChar p, p) | p <- [minBound .. maxBound] ]++charToSheetPart :: Char -> Maybe SheetPart+charToSheetPart c = let+  notation = Notation <$> lookup c           charPartMap+  tab      = Tab      <$> lookup (toLower c) charPartMap+  in notation <|> tab++charToAudioPart :: Char -> Maybe AudioPart+charToAudioPart c = let+  only    = Only                       <$> lookup c           charPartMap+  without = Without . partToInstrument <$> lookup (toLower c) charPartMap+  in only <|> without++type Library = [(FilePath, Info, [Track])]++fuzzySearchBy :: (Info -> String) -> String -> Library -> Library+fuzzySearchBy f str = let str' = map toLower str in+  filter $ \(_, info, _) -> str' `isInfixOf` map toLower (f info)++exactSearchBy :: (Info -> String) -> String -> Library -> Library+exactSearchBy f str = filter $ \(_, info, _) -> f info == str++argOpts :: [Opt.OptDescr (Args -> Args)]+argOpts =+  [ Opt.Option ['t'] ["title"]+    (Opt.ReqArg+      (\s a -> a { filterLibrary = fuzzySearchBy title s . filterLibrary a })+      "str")+    "search by song title"+  , Opt.Option ['r'] ["artist"]+    (Opt.ReqArg+      (\s a -> a { filterLibrary = fuzzySearchBy artist s . filterLibrary a })+      "str")+    "search by song artist"+  , Opt.Option ['T'] ["title-exact"]+    (Opt.ReqArg+      (\s a -> a { filterLibrary = exactSearchBy title s . filterLibrary a })+      "str")+    "search by song title (exact)"+  , Opt.Option ['R'] ["artist-exact"]+    (Opt.ReqArg+      (\s a -> a { filterLibrary = exactSearchBy artist s . filterLibrary a })+      "str")+    "search by song artist (exact)"+  , Opt.Option ['y'] ["yes-parts"]+    (Opt.ReqArg (\s a -> a { selectParts = s }) "parts")+    "parts to appear in sheet music or audio"+  , Opt.Option ['n'] ["no-parts"]+    (Opt.ReqArg (\s a -> a { rejectParts = s }) "parts")+    "parts to subtract (add inverted) from audio"+  , Opt.Option ['l'] ["lines"]+    (Opt.ReqArg (\s a -> a { pageLines = Just $ read s }) "int")+    "number of systems per page"+  , Opt.Option ['j'] ["jammit"]+    (Opt.ReqArg (\s a -> a { jammitDir = Just s }) "directory")+    "location of Jammit library"+  , Opt.Option ['?'] ["help"]+    (Opt.NoArg $ \a -> a { function = PrintUsage })+    "function: print usage info"+  , Opt.Option ['d'] ["database"]+    (Opt.NoArg $ \a -> a { function = ShowDatabase })+    "function: display all songs in db"+  , Opt.Option ['s'] ["sheet"]+    (Opt.ReqArg (\s a -> a { function = ExportSheet s }) "file")+    "function: export sheet music"+  , Opt.Option ['a'] ["audio"]+    (Opt.ReqArg (\s a -> a { function = ExportAudio s }) "file")+    "function: export audio"+  , Opt.Option ['x'] ["export"]+    (Opt.ReqArg (\s a -> a { function = ExportAll s }) "dir")+    "function: export all to dir"+  , Opt.Option ['c'] ["check"]+    (Opt.NoArg $ \a -> a { function = CheckPresence })+    "function: check presence of audio parts"+  ]++loadLibrary :: FilePath -> IO Library+loadLibrary jmt = do+  dirs <- songSubdirs jmt+  fmap catMaybes $ forM dirs $ \d -> do+    maybeInfo <- loadInfo   d+    maybeTrks <- loadTracks d+    return $ liftA2 (\i t -> (d, i, t)) maybeInfo maybeTrks++-- | Displays a table of the library, possibly filtered by search terms.+showLibrary :: Library -> String+showLibrary lib = let+  titleArtists = sort $ nub [ (title info, artist info) | (_, info, _) <- lib ]+  partsFor ttl art = map partToChar $ sort $ concat+    [ mapMaybe (trackTitle >=> titleToPart) trks+    | (_, info, trks) <- lib+    , (ttl, art) == (title info, artist info) ]+  makeColumn h col = text h /+/ vcat left (map text col)+  titleColumn  = makeColumn "Title"  $ map fst                titleArtists+  artistColumn = makeColumn "Artist" $ map snd                titleArtists+  partsColumn  = makeColumn "Parts"  $ map (uncurry partsFor) titleArtists+  in render $ hsep 1 top [titleColumn, artistColumn, partsColumn]++-- | Loads the Jammit library, and applies the search terms from the arguments+-- to filter it.+searchResults :: Args -> IO Library+searchResults args = do+  jmt <- case jammitDir args of+    Just j  -> return j+    Nothing -> Env.lookupEnv "JAMMIT" >>= \mv -> case mv of+      Just j -> return j+      Nothing ->+        fromMaybe (error "Couldn't find Jammit directory.") <$> findJammitDir+  db <- loadLibrary jmt+  return $ filterLibrary args db++-- | A mapping from audio part to absolute filename of an audio file.+getAudioParts :: Library -> [(AudioPart, FilePath)]+getAudioParts lib = do+  (dir, info, trks) <- lib+  trk <- trks+  case trackTitle trk >>= \t -> titleToAudioPart t (instrument info) of+    Nothing -> []+    Just ap -> [(ap, dir </> (identifier trk ++ "_jcfx"))]++-- | A mapping from sheet part to+-- @(prefix of image files, line height in pixels)@.+getSheetParts :: Library -> [(SheetPart, (FilePath, Integer))]+getSheetParts lib = do+  (dir, _info, trks) <- lib+  trk <- trks+  case (trackTitle trk >>= \t -> titleToPart t, scoreSystemInterval trk) of+    (Just p, Just ht) -> let+      sheet = (Notation p, (dir </> (identifier trk ++ "_jcfn"), ht))+      tab   = (Tab      p, (dir </> (identifier trk ++ "_jcft"), ht))+      in if elem (partToInstrument p) [Guitar, Bass]+        then [sheet, tab]+        else [sheet]+    _ -> []++-- | If there is exactly one pair with the given first element, returns its+-- second element. Otherwise (for 0 or >1 elements) returns an error.+getOneResult :: (Eq a, Show a) => a -> [(a, b)] -> Either String b+getOneResult x xys = case [ b | (a, b) <- xys, a == x ] of+  [y] -> Right y+  ys  -> Left $ "Got " ++ show (length ys) ++ " results for " ++ show x++main :: IO ()+main = do+  (fs, _, _) <- Opt.getOpt Opt.Permute argOpts <$> Env.getArgs+  let args = foldr ($) defaultArgs fs+  case function args of+    PrintUsage -> do+      prog <- Env.getProgName+      putStrLn $ "jammittools v" ++ showVersion Paths.version+      let header = "Usage: " ++ prog ++ " [options]"+      putStr $ Opt.usageInfo header argOpts+    ShowDatabase -> do+      matches <- searchResults args+      putStr $ showLibrary matches+    ExportAudio fout -> do+      matches <- getAudioParts <$> searchResults args+      let f = mapM (`getOneResult` matches) . mapMaybe charToAudioPart+      case (f $ selectParts args, f $ rejectParts args) of+        (Left  err   , _           ) -> error err+        (_           , Left  err   ) -> error err+        (Right yaifcs, Right naifcs) -> runAudio yaifcs naifcs fout+    CheckPresence -> do+      matches <- getAudioParts <$> searchResults args+      let f = mapM (`getOneResult` matches) . mapMaybe charToAudioPart+      case (f $ selectParts args, f $ rejectParts args) of+        (Left  err   , _           ) -> error err+        (_           , Left  err   ) -> error err+        (Right _     , Right _     ) -> return ()+    ExportSheet fout -> do+      matches <- getSheetParts <$> searchResults args+      let f = mapM (`getOneResult` matches) . mapMaybe charToSheetPart+      case f $ selectParts args of+        Left  err   -> error err+        Right parts -> let+          systemHeight = sum $ map snd parts+          in runSheet parts (getPageLines systemHeight args) fout+    ExportAll dout -> do+      matches <- searchResults args+      let sheets = getSheetParts matches+          audios = getAudioParts matches+          backingOrder = [Drums, Guitar, Keyboard, Bass, Vocal]+          isGuitar p = elem (partToInstrument p) [Guitar, Bass]+          (gtrs, nongtrs) = partition isGuitar [minBound .. maxBound]+          chosenBacking = listToMaybe $ flip mapMaybe backingOrder $ \i ->+            case getOneResult (Without i) audios of+              Left  _  -> Nothing+              Right fp -> Just (i, fp)+      forM_ gtrs $ \p ->+        case (getOneResult (Notation p) sheets, getOneResult (Tab p) sheets) of+          (Right note, Right tab) -> let+            parts = [note, tab]+            systemHeight = sum $ map snd parts+            fout = dout </> drop 4 (map toLower (show p) ++ ".pdf")+            in runSheet [note, tab] (getPageLines systemHeight args) fout+          _ -> return ()+      forM_ nongtrs $ \p ->+        case getOneResult (Notation p) sheets of+          Left  _    -> return ()+          Right note -> let+            fout = dout </> drop 4 (map toLower (show p) ++ ".pdf")+            in runSheet [note] (getPageLines (snd note) args) fout+      forM_ [minBound .. maxBound] $ \p ->+        case getOneResult (Only p) audios of+          Left  _  -> return ()+          Right fp -> let+            fout = dout </> drop 4 (map toLower (show p) ++ ".wav")+            in runAudio [fp] [] fout+      case chosenBacking of+        Nothing            -> return ()+        Just (inst, fback) -> let+          others = [ fp | (Only p, fp) <- audios, partToInstrument p /= inst ]+          fout = dout </> "backing.wav"+          in runAudio [fback] others fout++getPageLines :: Integer -> Args -> Int+getPageLines systemHeight args = let+  pageHeight   = 724 / 8.5 * 11 :: Double+  defaultLines = round $ pageHeight / fromIntegral systemHeight+  in max 1 $ fromMaybe defaultLines $ pageLines args++-- | Takes a list of positive AIFCs, a list of negative AIFCs, and a WAV file+-- to produce.+runAudio :: [FilePath] -> [FilePath] -> FilePath -> IO ()+runAudio pos neg fout = runTempIO fout $ do+  -- I've only found one audio file where the instruments are not aligned:+  -- the drums and drums backing track for Take the Time are 38 samples ahead+  -- of the other instruments. So as a hack, we pad the front of them by 38+  -- samples to line things up.+  let tttDrums     = "793EAAE0-6761-44D7-9A9A-1FB451A2A438_jcfx"+      tttDrumsBack = "37EE5AA5-4049-4CED-844A-D34F6B165F67_jcfx"+      aifcToWav' a = if takeFileName a `elem` [tttDrums, tttDrumsBack]+        then Pad (Samples 38) . File <$> aifcToWav a+        else File <$> aifcToWav a+  posWavs <- map (\w -> ( 1, w)) <$> mapM aifcToWav' pos+  negWavs <- map (\w -> (-1, w)) <$> mapM aifcToWav' neg+  renderAudio $ optimize $ Mix (posWavs ++ negWavs)++runSheet :: [(FilePath, Integer)] -> Int -> FilePath -> IO ()+runSheet trks lns fout = runTempIO fout $ do+  trkLns <- forM trks $ \(fp, ht) -> do+    let (dir, file) = splitFileName fp+    ls <- liftIO $ getDirectoryContents dir+    cnct <- connectVertical $+      map (dir </>) $ sort $ filter (file `isPrefixOf`) ls+    splitVertical ht cnct+  pages <- forM (map concat $ chunksOf lns $ transpose trkLns) $ \pg ->+    connectVertical pg+  joinPages pages++chunksOf :: Int -> [a] -> [[a]]+chunksOf _ [] = []+chunksOf n xs = case splitAt n xs of+  (ys, zs) -> ys : chunksOf n zs
+ src/Sox.hs view
@@ -0,0 +1,96 @@+module Sox+( Audio(..)+, Time(..)+, renderAudio+, optimize+) where++import Control.Arrow (first)+import Control.Monad (void, forM, guard)++import System.Process (readProcess)++import TempFile++data Audio+  = Empty                 -- ^ An empty stereo file+  | File FilePath         -- ^ An existing (stereo) file+  | Pad Time Audio        -- ^ Pad audio start with silence+  | Mix [(Double, Audio)] -- ^ Add audio sample-wise, also multiplying volumes+  | Concat [Audio]        -- ^ Sequentially connect audio+  deriving (Eq, Ord, Show, Read)++data Time+  = Seconds Double+  | Samples Integer+  deriving (Eq, Ord, Show, Read)++showTime :: Time -> String+showTime (Seconds d) = show d+showTime (Samples i) = show i ++ "s"++renderAudio :: Audio -> TempIO FilePath+renderAudio aud = case aud of+  Empty -> do+    fout <- newTempFile "render.wav"+    void $ liftIO $+      readProcess "sox" (["-n", fout] ++ words "trim 0 0 channels 2") ""+    return fout+  File f -> return f+  Pad t x -> do+    fin <- renderAudio x+    fout <- newTempFile "render.wav"+    void $ liftIO $ readProcess "sox" [fin, fout, "pad", showTime t] ""+    return fout+  Mix xs -> case xs of+    [] -> renderAudio Empty+    [(d, x)] -> do+      fin <- renderAudio x+      fout <- newTempFile "render.wav"+      void $ liftIO $+        readProcess "sox" ["-v", show d, fin, fout] ""+      return fout+    _ -> do+      dfins <- forM xs $ \(d, x) -> do+        fin <- renderAudio x+        return (d, fin)+      let argsin = concatMap+            (\(d, fin) -> ["-v", show d, fin]) dfins+      fout <- newTempFile "render.wav"+      void $ liftIO $+        readProcess "sox" (["--combine", "mix"] ++ argsin ++ [fout]) ""+      return fout+  Concat xs -> case xs of+    [] -> renderAudio Empty+    _ -> do+      fins <- mapM renderAudio xs+      fout <- newTempFile "render.wav"+      void $ liftIO $ readProcess "sox" (fins ++ [fout]) ""+      return fout++optimize :: Audio -> Audio+optimize aud = case aud of+  Pad (Samples 0) x -> x+  Pad (Seconds 0) x -> x+  Mix xs -> let+    xs' = do+      (d, x) <- xs+      guard $ d /= 0+      case optimize x of+        Mix ys -> map (first (* d)) ys+        x'     -> [(d, x')]+    in case xs' of+      []       -> Empty+      [(1, x)] -> x+      _        -> Mix xs'+  Concat xs -> let+    xs' = do+      x <- xs+      case optimize x of+        Concat ys -> ys+        x'        -> [x']+    in case xs' of+      []  -> Empty+      [x] -> x+      _   -> Concat xs'+  _ -> aud
+ src/TempFile.hs view
@@ -0,0 +1,41 @@+-- | A wrapper around IO that allows you to treat temporary files like+-- garbage-collected values.+module TempFile+( TempIO+, runTempIO+, newTempFile+, ask+, liftIO+) where++import Data.List (stripPrefix)+import System.IO (hClose)+import System.IO.Error (catchIOError)++import Control.Monad.IO.Class (liftIO)+import Control.Monad.Trans.Reader (ask, ReaderT(..))+import System.Directory (copyFile, renameFile)+import System.FilePath (splitPath)+import System.IO.Temp (openTempFile, withSystemTempDirectory)++-- | A wrapper around IO with a designated directory for temporary files.+type TempIO = ReaderT FilePath IO++-- | Creates a new temporary directory to run a computation in. When finished,+-- the final file will be moved/copied to the given path, and the temporary+-- directory will be deleted.+runTempIO :: FilePath -> TempIO FilePath -> IO ()+runTempIO fout act = withSystemTempDirectory "tempfile" $ \tmp -> do+  res <- runReaderT act tmp+  case stripPrefix (splitPath tmp) (splitPath res) of+    Just f | ".." `notElem` f -> -- try rename if we know the file is in tmp+      catchIOError (renameFile res fout) $ \_ -> copyFile res fout+    _ -> copyFile res fout++-- | Creates a new file in the temporary directory, given a template.+newTempFile :: String -> TempIO FilePath+newTempFile pat = do+  tmp <- ask+  (f, h) <- liftIO $ openTempFile tmp pat+  liftIO $ hClose h+  return f