diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +# History of changes + +## ALGA 0.1.0 + +Initial release. Support for Ardour is still not done. Maybe because I don't +use it. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,82 @@ +# ALGA + +[![License GPL 3](https://img.shields.io/badge/license-GPL_3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.txt) +[![Hackage](https://img.shields.io/hackage/v/alga.svg?style=flat)](https://hackage.haskell.org/package/alga) +[![Build Status](https://travis-ci.org/mrkkrp/alga.svg?branch=master)](https://travis-ci.org/mrkkrp/alga) + +How to algorithmically control every aspect of music using familiar, robust +tools: plugins, DAWs, etc. that have not built with this in mind? I've +partially solved the problem in [MIDA](https://github.com/mrkkrp/mida) — +program that generates MIDI files using simple, symmetric, declarative +language. However, even though MIDA is a fine tool to create scores, it's +not sufficient if you want to control everything. Initially I thought I +could find some plugins that can algorithmically control other plugins, but +there are no decent tools of this sort. How automation is handled in a +traditional DAW? Well, you draw it in a separate track. Wouldn't it be a +good idea to algorithmically perform exactly that — drawing of the +automation track? This is simpler than it may seem: many DAWs allow to +export tracks in XML format, and this is all we need to start our hacking. + +## How does it work? + +You export your tracks in XML format, write some scripts in +[MIDA](https://github.com/mrkkrp/mida)-like language and patch the XML +file. Then you can import the files back, they will (hopefully) have fancy +automation tracks in place. + +## Installation + +1. Install [Haskell Platform](https://www.haskell.org/platform/); +2. Install [Cabal](https://www.haskell.org/cabal/); +3. Download and untar git repository of MIDA, or clone it: + + ``` + $ git clone https://github.com/mrkkrp/alga.git + ``` + +4. Go to the root directory of the repository and execute: + + ``` + $ cabal update + $ cabal configure + $ cabal install --only-dependencies + $ cabal build + # sh install.sh + ``` + + or (if you use Stack): + + ``` + $ stack build + ``` + +5. Done (you can use `uninstall.sh` to uninstall the program). + +## Example + +ALGA is a simple declarative language. Just to get feeling of it: + +``` +# +# Example of ALGA program +# + +my_track.pan = {0..16} / 16 $ [{2}] +my_track.pand = 1/8, 0 +``` + +This thing changes position of stereo-panorama for track named +`my_track`. There are 16 possible values from left to right. Panorama is +changed instantly, every eighth note. + +You can control volume, panorama, mute, input gain, all parameters of send +slots, insertion slots, and software synths. Changes can be applied to audio +tracks, group tracks, instrument tracks, and effect tracks. + +See [ALGA Manual](https://mrkkrp.github.io/alga/) for more information. + +## License + +Copyright © 2015 Mark Karpov + +Distributed under GNU GPL, version 3. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,6 @@ +module Main (main) where + +import Distribution.Simple + +main :: IO () +main = defaultMain diff --git a/alga.cabal b/alga.cabal new file mode 100644 --- /dev/null +++ b/alga.cabal @@ -0,0 +1,155 @@ +-- -*- Mode: Haskell-Cabal; -*- +-- +-- Cabal config for ALGA. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +name: alga +version: 0.1.0 +synopsis: Algorithmic automation for various DAWs +description: + + How to algorithmically control every aspect of music using familiar, + robust tools: plugins, DAWs, etc. that have not built with this in mind? + I've partially solved the problem in MIDA -- program that generates MIDI + files using very simple and symmetric language. However, even though MIDA + is a fine tool to create scores, it's not sufficient if you want to + control everything. Initially I thought I could find some plugins that can + algorithmically control other plugins, but there are no decent tools of + this sort. How automation is handled in a traditional DAW? Well, you draw + it in a separate track. Wouldn't it be a good idea to algorithmically + perform exactly that: drawing of the automation track. This is simpler + than it may seem: many DAWs allow to export tracks in XML format, and this + is all we need to start our hacking. + +homepage: https://github.com/mrkkrp/alga +license: GPL-3 +license-file: LICENSE.md +author: Mark Karpov +maintainer: Mark Karpov +copyright: Copyright © 2015 Mark Karpov +category: Language +build-type: Simple +extra-source-files: README.md, CHANGELOG.md +cabal-version: >= 1.10 + +library + hs-source-dirs: src + ghc-options: -O2 -Wall + ghc-prof-options: -O2 -Wall -prof -fprof-cafs -rtsopts + build-depends: base >= 4.8 && < 5 + , containers >= 0.5.5.1 + , exceptions >= 0.8 + , haskeline >= 0.7.1.3 + , hxt >= 9.3.1.15 + , megaparsec >= 4.2 + , mtl >= 2.1.3.1 + , path >= 0.5.3 + , random + , text >= 1.2.0.4 + , tf-random >= 0.5 + , transformers >= 0.2.0.0 && < 0.5 + default-extensions: FlexibleContexts + , FlexibleInstances + , OverloadedStrings + , TupleSections + exposed-modules: Alga.Configuration + , Alga.Language + , Alga.Language.Element + , Alga.Language.Environment + , Alga.Language.Eval + , Alga.Language.SyntaxTree + , Alga.Representation + , Alga.Representation.Parser + , Alga.Representation.Show + , Alga.Translation + other-modules: Alga.Representation.Base + , Alga.Translation.Base + , Alga.Translation.Ardour + , Alga.Translation.Cubase + default-language: Haskell2010 + +executable alga + main-is: Main.hs + hs-source-dirs: src + other-modules: Alga.Interaction + ghc-options: -O2 -Wall + ghc-prof-options: -O2 -Wall -prof -fprof-cafs -rtsopts + build-depends: alga >= 0.1.0 + , base >= 4.8 && < 5 + , containers >= 0.5.5.1 + , directory >= 1.2.1.0 + , exceptions >= 0.8 + , filepath >= 1.3.0.2 + , formatting >= 6.2 + , haskeline >= 0.7.1.3 + , hxt >= 9.3.1.15 + , megaparsec >= 4.2 + , mtl >= 2.1.3.1 + , optparse-applicative >= 0.11.0.2 + , path >= 0.5.3 + , random + , temporary >= 1.2 + , text >= 1.2.0.4 + , tf-random >= 0.5 + , transformers >= 0.2.0.0 && < 0.5 + default-extensions: FlexibleContexts + , FlexibleInstances + , OverloadedStrings + , TupleSections + other-modules: Alga.Configuration + , Alga.Interaction + , Alga.Interaction.Base + , Alga.Interaction.Commands + , Alga.Language + , Alga.Language.Element + , Alga.Language.Environment + , Alga.Language.Eval + , Alga.Language.SyntaxTree + , Alga.Representation + , Alga.Representation.Base + , Alga.Representation.Parser + , Alga.Representation.Show + , Alga.Translation + , Alga.Translation.Ardour + , Alga.Translation.Base + , Alga.Translation.Cubase + , Paths_alga + default-language: Haskell2010 + +test-suite tests + main-is: Main.hs + hs-source-dirs: tests + type: exitcode-stdio-1.0 + ghc-options: -O2 -Wall -rtsopts + default-language: Haskell2010 + build-depends: QuickCheck >= 2.4 && < 3 + , alga >= 0.1.0 + , base >= 4.8 && < 5 + , containers >= 0.5.5.1 + , hxt >= 9.3.1.15 + , megaparsec == 4.* + , mtl >= 2.1.3.1 + , random + , test-framework >= 0.4 && < 1 + , test-framework-quickcheck2 >= 0.3 && < 0.4 + , text >= 1.2.0.4 + , tf-random >= 0.5 + , transformers >= 0.2.0.0 && < 0.5 + +source-repository head + type: git + location: git://github.com/mrkkrp/alga.git diff --git a/src/Alga/Configuration.hs b/src/Alga/Configuration.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Configuration.hs @@ -0,0 +1,105 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes how to parse Unix-style configuration files. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE TypeSynonymInstances #-} + +module Alga.Configuration + ( Params + , parseConfig + , lookupCfg ) +where + +import Control.Applicative +import Control.Monad +import Data.Char (isSpace) +import Data.Map (Map) +import Data.Maybe (fromMaybe, listToMaybe) +import Data.Text.Lazy (Text) +import Numeric.Natural +import Text.Megaparsec +import Text.Megaparsec.Text.Lazy +import qualified Data.Map as M +import qualified Text.Megaparsec.Lexer as L + +-- | Collection of configuration parameters. They are kept as 'String's and +-- then converted on request. + +type Params = Map String String + +class Read a => Parsable a where + parseValue :: String -> Maybe a + +instance Parsable String where + parseValue = Just + +instance Parsable Natural where + parseValue = parseNum + +instance Parsable Double where + parseValue = parseNum + +instance Parsable Bool where + parseValue "true" = Just True + parseValue "false" = Just False + parseValue _ = Nothing + +-- | Lookup a value from configuration parameters. Type of result determines +-- how value will be interpreted. + +lookupCfg :: Parsable a + => Params -- ^ Collection of configuration parameters + -> String -- ^ Name of parameter to lookup + -> a -- ^ Fallback value + -> a -- ^ Result +lookupCfg cfg v d = fromMaybe d $ M.lookup v cfg >>= parseValue + +-- | Parse configuration file. + +parseConfig :: String -> Text -> Either String Params +parseConfig file = either (Left . show) Right . parse pConfig file + +pConfig :: Parser Params +pConfig = M.fromList <$> (sc *> many pItem <* eof) + +pItem :: Parser (String, String) +pItem = (,) <$> pIdentifier <* pOperator "=" <*> (pString <|> pThing) + +pIdentifier :: Parser String +pIdentifier = lexeme $ (:) <$> first <*> many other + where first = letterChar <|> char '_' + other = alphaNumChar <|> char '_' + +pOperator :: String -> Parser String +pOperator = lexeme . string + +pString :: Parser String +pString = lexeme $ char '"' >> manyTill L.charLiteral (char '"') + +pThing :: Parser String +pThing = lexeme $ many (satisfy $ not . isSpace) + +lexeme :: Parser a -> Parser a +lexeme = L.lexeme sc + +sc :: Parser () +sc = L.space (void spaceChar) (L.skipLineComment "#") empty + +parseNum :: (Num a, Read a) => String -> Maybe a +parseNum = fmap fst . listToMaybe . reads diff --git a/src/Alga/Interaction.hs b/src/Alga/Interaction.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Interaction.hs @@ -0,0 +1,109 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes how ALGA processes commands in interactive +-- mode. These commands are also used in batch mode. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +module Alga.Interaction + ( AlgaSt (..) + , AlgaCfg (..) + , Alga + , runAlga + , cmdBackend + , cmdLoad + , cmdMake + , interaction + , defaultSeed + , defaultBeats ) +where + +import Alga.Interaction.Base +import Alga.Interaction.Commands +import Alga.Language +import Alga.Representation +import Control.Monad.Reader +import Control.Monad.State.Strict +import Data.Text.Lazy (Text) +import Data.Version (showVersion) +import Formatting +import Path +import Paths_alga (version) +import System.IO +import qualified Data.Text.Lazy as T +import qualified Data.Text.Lazy.IO as T +import qualified System.Console.Haskeline as L + +-- | Entry point for REPL interaction. + +interaction :: Alga () +interaction = do + liftIO $ hSetBuffering stdin LineBuffering + liftIO $ fprint + ("ALGA Interactive Environment " % string % "\n") (showVersion version) + L.runInputT (L.setComplete completionFunc L.defaultSettings) algaRepl + +-- | Infinite REPL loop inside Haskeline's 'InputT' monad transformer. + +algaRepl :: L.InputT Alga () +algaRepl = do + input <- getMultiline "" + case input of + Just x -> do + if T.pack cmdPrefix `T.isPrefixOf` T.strip x + then lift $ processCmd x + else lift $ processExpr x + algaRepl + Nothing -> return () + +-- | Read multi-line. + +getMultiline :: Text -> L.InputT Alga (Maybe Text) +getMultiline prv = do + prompt <- lift (asks cfgPrompt) + input <- L.getInputLine $ + if T.null prv then prompt else replicate (length prompt) ' ' + case input of + Just x -> let r = prv `T.append` T.pack x `T.append` "\n" + in if probeAlga r + then return (Just r) + else getMultiline r + Nothing -> return Nothing + +-- | Process expression. + +processExpr :: Text -> Alga () +processExpr expr = do + file <- gets stSrcFile + case parseAlga (fromAbsFile file) expr of + Right x -> mapM_ f x + Left x -> liftIO $ fprint (string % "\n") x + where f (Definition n t) = processDef n t + f (Exposition t) = do + len <- gets stPrevLen + verbose <- asks cfgVerbose + result <- eval t + prin <- toPrin t + liftIO . when verbose $ + fprint ("≡ " % text) (showPrinciple prin) + spitList $ take (fromIntegral len) result + +-- | Pretty-print stream of non-negative ratios. + +spitList :: [NRatio] -> Alga () +spitList [] = liftIO $ T.putStrLn "⇒ ⊥" +spitList xs = liftIO $ fprint ("⇒ " % string % "…\n") l + where l = unwords $ showRatio <$> xs diff --git a/src/Alga/Interaction/Base.hs b/src/Alga/Interaction/Base.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Interaction/Base.hs @@ -0,0 +1,104 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes monad for interactive REPL and some basic +-- functions. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +module Alga.Interaction.Base + ( AlgaSt (..) + , AlgaCfg (..) + , Alga + , runAlga + , defaultSeed + , defaultBeats + , processDef + , showRatio ) +where + +import Alga.Language +import Alga.Representation +import Alga.Translation +import Control.Monad.Reader +import Control.Monad.State.Strict +import Data.Ratio (numerator, denominator, Ratio) +import Formatting +import Numeric.Natural +import Path + +-- | ALGA REPL state. + +data AlgaSt = AlgaSt + { stBackend :: AlgaBackend -- ^ Selected backend (DAW dependent) + , stPrevLen :: Natural -- ^ Length of preview principles + , stSrcFile :: Path Abs File -- ^ Name of current source file + } + +-- | ALGA REPL configuration. + +data AlgaCfg = AlgaCfg + { cfgPrecision :: Double -- ^ Precision for some REPL utilities + , cfgPrompt :: String -- ^ REPL prompt + , cfgVerbose :: Bool -- ^ Verbose mode? + } + +-- | A synonym for MIDA monad stack. + +type Alga = StateT AlgaSt (ReaderT AlgaCfg (AlgaEnv IO)) + +-- | Run ALGA monad stack. + +runAlga + :: Alga a -- ^ ALGA monad stack + -> AlgaSt -- ^ Initial state + -> AlgaCfg -- ^ Configuration + -> IO a +runAlga m st cfg = runAlgaEnv (runReaderT (evalStateT m st) cfg) + +-- | Default seed for random number generator. + +defaultSeed :: Natural +defaultSeed = 0 + +-- | Default duration of automation to calculate in whole notes, note that +-- this is actually floating point value. + +defaultBeats :: Double +defaultBeats = 4 + +-- | Process a principle definition. + +processDef :: (HasEnv m, MonadIO m) + => String -- ^ Definition name + -> SyntaxTree -- ^ AST for that definition + -> m () +processDef n t = do + recursive <- checkRecur n t + if recursive + then liftIO $ + fprint ("Rejected recursive definition for «" % string % "».\n") n + else do addDef n t + liftIO $ fprint ("• «" % string % "»\n") n + +-- | Render a ratio. + +showRatio :: (Integral a, Show a) => Ratio a -> String +showRatio x = + let n = numerator x + d = denominator x + in if d == 1 + then show n + else show n ++ divisionOp ++ show d diff --git a/src/Alga/Interaction/Commands.hs b/src/Alga/Interaction/Commands.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Interaction/Commands.hs @@ -0,0 +1,398 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes all supported ALGA commands. It also provides all +-- the functionality to load source files and patch XML files. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +{-# LANGUAGE RecordWildCards #-} + +module Alga.Interaction.Commands + ( processCmd + , completionFunc + , cmdBackend + , cmdLoad + , cmdMake + , cmdPrefix ) +where + +import Alga.Interaction.Base +import Alga.Language +import Alga.Representation +import Alga.Translation +import Control.Exception (SomeException) +import Control.Monad.Catch (try, MonadThrow, fromException, throwM) +import Control.Monad.IO.Class +import Control.Monad.Reader +import Control.Monad.State.Class +import Data.Char (isSpace) +import Data.Foldable (find) +import Data.List (elemIndex, isPrefixOf) +import Data.Maybe (fromMaybe, listToMaybe) +import Data.Ratio (approxRational) +import Data.Text.Lazy (Text) +import Formatting +import Numeric.Natural +import Path +import System.Directory + ( doesDirectoryExist + , doesFileExist + , getCurrentDirectory + , getHomeDirectory + , makeAbsolute + , setCurrentDirectory ) +import System.Exit (exitSuccess, ExitCode) +import qualified Data.Text.Lazy as T +import qualified Data.Text.Lazy.IO as T +import qualified System.Console.Haskeline as L +import qualified System.FilePath as FP + +-- | Description of REPL command. + +data Cmd = Cmd + { cmdName :: String -- ^ Name of command + , cmdFunc :: String -> Alga () -- ^ Action it performs + , cmdDesc :: Text -- ^ Description of command + , cmdComp :: CompletionScheme -- ^ How to complete arguments of the command + } + +-- | Scale (linear or logarithmic) to use with some utilities. + +data Scale = Lin | Log deriving (Eq, Show) + +-- | How to complete arguments of command. + +data CompletionScheme + = None -- ^ Don't complete at all + | Files -- ^ Complete as file names + | Names -- ^ Complete as definition names + deriving (Eq, Show) + +-- | All defined commands. + +commands :: [Cmd] +commands = + -- name action description completion + [ Cmd "backend" cmdBackend "Set backend (name of DAW)" None + , Cmd "cd" cmdCd "Change working directory" Files + , Cmd "clear" cmdClear "Restore default state of environment" None + , Cmd "def" cmdDef "Print definition of given symbol" Names + , Cmd "help" cmdHelp "Show this help text" None + , Cmd "lin" cmdLin "Linear scale conversion to ratio" None + , Cmd "load" cmdLoad' "Load definitions from given file" Files + , Cmd "log" cmdLog "Logarithmic scale conversion to ratio" None + , Cmd "make" cmdMake' "Patch an XML file" Files + , Cmd "prvlen" cmdLength "Set length of displayed results" None + , Cmd "purge" cmdPurge "Remove redundant definitions" None + , Cmd "pwd" cmdPwd "Print working directory" None + , Cmd "quit" cmdQuit "Quit the interactive environment" None + , Cmd "ratio" cmdRatio "Real number to ratio converter" None + , Cmd "save" cmdSave "Save current environment in file" Files + , Cmd "udef" cmdUdef "Remove definition of given symbol" Names + , Cmd "vol" cmdVol "Convert decibels to ratio" None ] + +-- | Process command (with its arguments). + +processCmd :: Text -> Alga () +processCmd txt = + case find g commands of + Just Cmd { cmdFunc = f } -> do + result <- try . f . T.unpack . T.strip $ args + :: Alga (Either SomeException ()) + case result of + Left e -> + case fromException e :: Maybe ExitCode of + Just _ -> throwM e + Nothing -> spitExc e + Right _ -> return () + Nothing -> liftIO $ + fprint ("Unknown command, try " % string % "help.\n") cmdPrefix + where g Cmd { cmdName = c } = c == dropCmdPrefix (T.unpack cmd) + (cmd, args) = T.break isSpace (T.strip txt) + +-- | Completion function to work with Haskeline. + +completionFunc + :: (HasEnv m, MonadIO m, MonadReader AlgaCfg m, MonadState AlgaSt m) + => L.CompletionFunc m +completionFunc = L.completeWordWithPrev Nothing " " getCompletions + +-- | Generate completions. + +getCompletions + :: (HasEnv m, MonadIO m, MonadReader AlgaCfg m, MonadState AlgaSt m) + => String -- ^ Contents of line before cursor, reversed + -> String -- ^ Contents of line after cursor + -> m [L.Completion] -- ^ List of completions +getCompletions prev word = do + names <- getRefs + files <- L.listFiles word + let cmds = (cmdPrefix ++) . cmdName <$> commands + f = fmap L.simpleCompletion . filter (word `isPrefixOf`) + g None = [] + g Files = files + g Names = f names + return $ + case words . reverse $ prev of + [] -> f $ cmds ++ names + (c:_) -> + case c `elemIndex` cmds of + Just i -> g . cmdComp $ commands !! i + Nothing -> f names + +-- | Change set backend (name of DAW). + +cmdBackend :: MonadState AlgaSt m => String -> m () +cmdBackend arg = modify $ \st -> st { stBackend = toBackend arg } + +-- | Change working directory. + +cmdCd :: MonadIO m => String -> m () +cmdCd next' = liftIO $ do + next <- fixPath next' >>= parseAbsDir + let npath = fromAbsDir next + present <- doesDirectoryExist npath + if present + then do setCurrentDirectory npath + fprint ("Changed to \"" % string % "\".\n") npath + else fprint ("Cannot cd to \"" % string % "\".\n") npath + +-- | Restore default state of environment. + +cmdClear :: (HasEnv m, MonadIO m) => String -> m () +cmdClear _ = do + clearDefs + liftIO (T.putStrLn "Environment cleared.") + +-- | Print definition of given symbol. + +cmdDef :: (HasEnv m, MonadIO m) => String -> m () +cmdDef arg = mapM_ f (words arg) + where f name = getSrc name >>= liftIO . T.putStr + +-- | Show help with list of all available commands. + +cmdHelp :: MonadIO m => String -> m () +cmdHelp _ = liftIO $ do + T.putStrLn "Available commands:" + mapM_ f commands + where f Cmd {..} = fprint fmt cmdPrefix cmdName cmdDesc + fmt = " " % string % (right 24 ' ' %. string) % text % "\n" + +-- | Linear scale conversion to ratio. + +cmdLin :: (MonadIO m, MonadReader AlgaCfg m) => String -> m () +cmdLin str = pRatio Lin (parseNum a 0) (parseNum b 1) (parseNum s 0) + where (a:b:s:_) = parseArgs str + +-- | Load definitions from given file. Note that this version of the command +-- is used in REPL, not 'cmdLoad'. + +cmdLoad' :: (HasEnv m, MonadIO m, MonadState AlgaSt m, MonadThrow m) + => String -> m () +cmdLoad' = cmdLoad . words + +-- | Alternative interface to loading functionality. This one is used in +-- main module. + +cmdLoad :: (HasEnv m, MonadIO m, MonadState AlgaSt m, MonadThrow m) + => [FilePath] -> m () +cmdLoad = mapM_ loadOne + +-- | Load single source file. + +loadOne :: (HasEnv m, MonadIO m, MonadState AlgaSt m, MonadThrow m) + => FilePath -> m () +loadOne given = do + file <- output given "" + let fpath = fromAbsFile file + b <- liftIO $ doesFileExist fpath + if b + then do contents <- liftIO $ T.readFile fpath + case parseAlga fpath contents of + Right x -> do + mapM_ f x + setFileName file + liftIO $ fprint + ("\"" % string % "\" loaded successfully.\n") + fpath + Left x -> liftIO $ fprint (string % "\n") x + else liftIO $ fprint ("Could not find \"" % string % "\".\n") fpath + where f (Definition n t) = processDef n t + f (Exposition _) = return () + +-- | Logarithmic scale conversion to ratio. + +cmdLog :: (MonadIO m, MonadReader AlgaCfg m) => String -> m () +cmdLog str = pRatio Log (parseNum a 0) (parseNum b e) (parseNum s 0) + where (a:b:s:_) = parseArgs str + e = exp 1 + +-- | Version of 'cmdMake' used by REPL. + +cmdMake' :: (HasEnv m, MonadIO m, MonadState AlgaSt m, MonadThrow m) + => String -> m () +cmdMake' str = + let (s:b:f:_) = parseArgs str + in cmdMake (parseNum s defaultSeed) + (parseNum b defaultBeats) + f + +-- | Patch an XML file. + +cmdMake :: (HasEnv m, MonadIO m, MonadState AlgaSt m, MonadThrow m) + => Natural -- ^ Seed for random number generator + -> Double -- ^ Desired duration in number of whole notes + -> FilePath -- ^ Where to find file to patch + -> m () +cmdMake s b f = do + file <- output f "xml" + backend <- gets stBackend + status <- patchAuto s b file backend + let msg = if status == 0 + then "File patched successfully \"" % string % "\".\n" + else "Failed to patch file \"" % string % "\".\n" + liftIO $ fprint msg (fromAbsFile file) + +-- | Set length of displayed results. + +cmdLength :: MonadState AlgaSt m => String -> m () +cmdLength arg = do + len <- gets stPrevLen + modify $ \st -> st { stPrevLen = parseNum (trim arg) len } + +-- | Remove redundant definitions. + +cmdPurge :: (HasEnv m, MonadIO m) => String -> m () +cmdPurge _ = do + topDefs >>= purgeEnv + liftIO $ T.putStrLn "Environment purged." + +-- | Print working directory. + +cmdPwd :: MonadIO m => String -> m () +cmdPwd _ = liftIO (getCurrentDirectory >>= putStrLn) + +-- | Quit the interactive environment. + +cmdQuit :: MonadIO m => String -> m () +cmdQuit _ = liftIO exitSuccess + +-- | Real number to ratio converter. + +cmdRatio :: (MonadIO m, MonadReader AlgaCfg m) => String -> m () +cmdRatio = pRatio Lin 0 1 . (`parseNum` 0) + +-- | Save current environment in file. + +cmdSave :: (HasEnv m, MonadIO m, MonadState AlgaSt m, MonadThrow m) + => String -> m () +cmdSave given = do + file <- output given "" + let fpath = fromAbsFile file + src <- fullSrc + liftIO $ T.writeFile fpath src + setFileName file + liftIO $ fprint ("Environment saved as \"" % string % "\".\n") fpath + +-- | Undefine definitions. + +cmdUdef :: (HasEnv m, MonadIO m) => String -> m () +cmdUdef arg = mapM_ f (words arg) + where f name = do + remDef name + liftIO $ fprint ("Definition for «" % string % "» removed.\n") name + +-- | Convert decibels to ratio. + +cmdVol :: (MonadIO m, MonadReader AlgaCfg m) => String -> m () +cmdVol = pRatio Lin 0 1 . dBToRatio . (`parseNum` 0) + where dBToRatio dB = 10 ** (dB / 10) + +-- | Universal conversion to ratios. + +pRatio :: (MonadIO m, MonadReader AlgaCfg m) + => Scale -- ^ Scale to use (linear or logarithmic) + -> Double -- ^ Minimum + -> Double -- ^ Maximum + -> Double -- ^ Value between minimum and maximum + -> m () +pRatio scale a b s = do + ε <- asks cfgPrecision + let σ = case scale of + Lin -> (s - a) / (b - a) + Log -> (log s - log a) / (log b - log a) + x = approxRational σ ε + liftIO $ fprint ("≈ " % string % "\n") (showRatio x) + +parseArgs :: String -> [String] +parseArgs str = words str ++ repeat "" + +-- | Parse a number defaulting to given value. + +parseNum :: (Num a, Read a) + => String -- ^ String to parse + -> a -- ^ Default value + -> a -- ^ Result +parseNum s x = fromMaybe x $ fst <$> listToMaybe (reads s) + +-- | Generate file name from given base name and extension. + +output :: (MonadIO m, MonadThrow m, MonadState AlgaSt m) + => FilePath -- ^ Given file name + -> String -- ^ Extension + -> m (Path Abs File) -- ^ Absolute path to output file +output given' ext = do + given <- liftIO (fixPath given') + actual <- fromAbsFile <$> gets stSrcFile + let a = if null ext then actual else FP.replaceExtension actual ext + parseAbsFile (if null given' then a else given) + +-- | Make path absolute resolving tilde (that's actually shell-functionality, +-- but we do it for convenience). + +fixPath :: FilePath -> IO FilePath +fixPath path = do + home <- getHomeDirectory + let f x = if x == "~" then home else x + makeAbsolute . FP.joinPath . fmap f . FP.splitDirectories $ path + +-- | Change current file name. + +setFileName :: MonadState AlgaSt m => Path Abs File -> m () +setFileName fpath = modify $ \st -> st { stSrcFile = fpath } + +-- | Drop command prefix if it's present. + +dropCmdPrefix :: String -> String +dropCmdPrefix arg + | cmdPrefix `isPrefixOf` arg = drop (length cmdPrefix) arg + | otherwise = arg + +-- | All REPL commands are prefixed with this. + +cmdPrefix :: String +cmdPrefix = ":" + +-- | Print out an exception. + +spitExc :: MonadIO m => SomeException -> m () +spitExc = liftIO . fprint ("× " % string % ".\n") . show + +-- | Stupid trimming for strings. + +trim :: String -> String +trim = let f = reverse . dropWhile isSpace in f . f diff --git a/src/Alga/Language.hs b/src/Alga/Language.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Language.hs @@ -0,0 +1,46 @@ +-- -*- Mode: Haskell; -*- +-- +-- This is entry point of Alga.Lang library. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +module Alga.Language + ( SyntaxTree + , Sel (..) + , Principle + , NRatio + , Element (..) + , AlgaEnv + , HasEnv (..) + , runAlgaEnv + , addDef + , remDef + , clearDefs + , getPrin + , getSrc + , fullSrc + , getRefs + , purgeEnv + , checkRecur + , evalDef + , eval + , toPrin ) +where + +import Alga.Language.SyntaxTree (SyntaxTree, Sel (..)) +import Alga.Language.Element (Principle, NRatio, Element (..)) +import Alga.Language.Environment +import Alga.Language.Eval (evalDef, eval, toPrin) diff --git a/src/Alga/Language/Element.hs b/src/Alga/Language/Element.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Language/Element.hs @@ -0,0 +1,58 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes internal representation of principle as list of +-- elements. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +{-# LANGUAGE DeriveFoldable #-} +{-# LANGUAGE DeriveFunctor #-} + +module Alga.Language.Element + ( Principle + , NRatio + , Element (..) ) +where + +import Control.Arrow ((***)) +import Data.Ratio (Ratio) +import Numeric.Natural + +-- | Collection of elements for evaluation, representation of some aspect of +-- voice. + +type Principle = [Element NRatio] + +-- | Non-negative rational number is the best choice for our purposes, hence +-- the synonym. + +type NRatio = Ratio Natural + +-- | Fundamental type representing an atom for evaluation. + +data Element a + = Val a -- ^ Single value, evaluates to itself + | Sec [Element a] -- ^ Universal container for other values + | Mul [Element a] -- ^ Multivalue, the way to introduce varying elements + | CMul [([Element a], [Element a])] -- ^ Conditional multivalue + deriving (Eq, Show, Functor, Foldable) + +instance Applicative Element where + pure = Val + (Val f) <*> x = f <$> x + (Sec f) <*> x = Sec $ (<*> x) <$> f + (Mul f) <*> x = Mul $ (<*> x) <$> f + (CMul f) <*> x = CMul $ (((<*> x) <$>) *** ((<*> x) <$>)) <$> f diff --git a/src/Alga/Language/Environment.hs b/src/Alga/Language/Environment.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Language/Environment.hs @@ -0,0 +1,226 @@ +-- -*- Mode: Haskell; -*- +-- +-- Environment is formed via evaluation of definitions. This module +-- describes minimal ALGA environment in form of monad transformer. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +{-# LANGUAGE GeneralizedNewtypeDeriving #-} + +module Alga.Language.Environment + ( AlgaEnv + , HasEnv (..) + , runAlgaEnv + , addDef + , remDef + , clearDefs + , getPrin + , getSrc + , fullSrc + , getRefs + , purgeEnv + , checkRecur ) +where + +import Alga.Language.SyntaxTree +import Alga.Representation.Base (extremumAlias, panAlias) +import Alga.Representation.Show (showDefinition) +import Control.Arrow ((***), (>>>)) +import Control.Monad.Catch (MonadThrow, MonadCatch, MonadMask) +import Control.Monad.Reader +import Control.Monad.State.Strict +import Data.Map (Map) +import Data.Maybe (fromMaybe) +import Data.Monoid ((<>)) +import Data.Ratio ((%)) +import Data.Text.Lazy (Text) +import Numeric.Natural +import System.Console.Haskeline.MonadException -- FIXME +import System.Random (split) +import System.Random.TF (TFGen, mkTFGen) +import qualified Data.Map.Strict as M + +-- | ALGA environment state. Basically this amounts to collection of +-- definitions and random number generator. + +data AlgaEnvSt = AlgaEnvSt + { aeDefs :: Defs -- ^ Collection of definitions + , aeRandGen :: TFGen -- ^ Random generator + } deriving Show + +-- | Type synonym for collection of definitions, where a definition is a +-- pair of variable name and corresponding AST. + +type Defs = Map String SyntaxTree + +-- | Monad that implements ALGA environment. + +newtype AlgaEnv m a = AlgaEnv + { unAlgaEnv :: StateT AlgaEnvSt m a } + deriving ( Functor + , Applicative + , Monad + , MonadIO + , MonadState AlgaEnvSt + , MonadException + , MonadThrow + , MonadCatch + , MonadMask ) + +-- | Type class for things that can be considered MIDA environment. + +class Monad m => HasEnv m where + -- | Get collection of all definitions. + getDefs :: m Defs + -- | Update definitions with given ones. + setDefs :: Defs -> m () + -- | Set random generator seed. + setRandGen :: Natural -> m () + -- | Split current random generator, update it, and return new one. + newRandGen :: m TFGen + +instance Monad m => HasEnv (AlgaEnv m) where + getDefs = gets aeDefs + setDefs defs = modify $ \env -> env { aeDefs = defs } + setRandGen gen = modify $ \e -> e { aeRandGen = mkTFGen (fromIntegral gen) } + newRandGen = do + (g, g') <- split <$> gets aeRandGen + modify $ \e -> e { aeRandGen = g' } + return g + +instance HasEnv m => HasEnv (StateT e m) where + getDefs = lift getDefs + setDefs = lift . setDefs + setRandGen = lift . setRandGen + newRandGen = lift newRandGen + +instance HasEnv m => HasEnv (ReaderT e m) where + getDefs = lift getDefs + setDefs = lift . setDefs + setRandGen = lift . setRandGen + newRandGen = lift newRandGen + +-- | Run state monad with ALGA environment. + +runAlgaEnv :: Monad m => AlgaEnv m a -> m a +runAlgaEnv e = evalStateT (unAlgaEnv e) AlgaEnvSt + { aeDefs = defaultDefs + , aeRandGen = mkTFGen 0 } + +-- | Default definitions in ALGA environment. + +defaultDefs :: Defs +defaultDefs = M.fromList + [ (a, [Value 0]) + , (b, [Value 1]) + , (l, [Value 0]) + , (c, [Value (1 % 2)]) + , (r, [Value 1]) ] + where (a, b) = extremumAlias + (l, c, r) = panAlias + +-- | Add a new definition to the environment. + +addDef :: HasEnv m + => String -- ^ Reference name + -> SyntaxTree -- ^ AST of its principle + -> m () +addDef name tree = getDefs >>= setDefs . M.insert name tree + +-- | Remove definition given its name. + +remDef :: HasEnv m + => String -- ^ Reference name + -> m () +remDef name = getDefs >>= setDefs . M.delete name + +-- | Remove all definitions, restoring default state of environment. + +clearDefs :: HasEnv m => m () +clearDefs = setDefs defaultDefs + +-- | Get principle corresponding to given variable name. + +getPrin :: HasEnv m + => String -- ^ Reference name + -> m SyntaxTree -- ^ Syntax tree +getPrin name = (fromMaybe [] . M.lookup name) <$> getDefs + +-- | Get source code of definition given its name. + +getSrc :: HasEnv m + => String -- ^ Reference name + -> m Text -- ^ Textual representation of source code +getSrc name = showDefinition name <$> getPrin name + +-- | Reconstruct source code for all existing definitions. + +fullSrc :: HasEnv m => m Text +fullSrc = (M.foldMapWithKey showDefinition . (M.\\ defaultDefs)) <$> getDefs + +-- | Get all reference names defined at the moment. + +getRefs :: HasEnv m => m [String] +getRefs = M.keys <$> getDefs + +-- | This performs “definition traversal” and returns collection of +-- definition names that given reference name depends on. + +tDefs + :: String -- ^ Reference name + -> Defs -- ^ Definitions + -> [String] -- ^ Collection of definition names +tDefs name defs = maybe mzero cm $ name `M.lookup` defs + where cm = (>>= f) + f (Value _) = mempty + f (Section x) = cm x + f (Multi x) = cm x + f (CMulti x) = x >>= (cm *** cm >>> uncurry (<>)) + f (Reference x) = return x <> tDefs x defs + f (Range _ _) = mempty + f (Product x y) = f x <> f y + f (Division x y) = f x <> f y + f (Sum x y) = f x <> f y + f (Diff x y) = f x <> f y + f (Loop x y) = f x <> f y + f (Rotation x y) = f x <> f y + f (Reverse x) = f x + +-- | Purge environment removing definitions that are not used in +-- construction of “top-level” definitions. + +purgeEnv :: HasEnv m + => [String] -- ^ Top-level definitions + -> m () +purgeEnv tops = f <$> getDefs >>= setDefs + where f defs = M.intersection defs $ M.unions [ts, ms defs, defaultDefs] + ms = M.unions . fmap toDefs . zipWith tDefs tops . repeat + ts = toDefs tops + +-- | Check if definition with given name is depends on itself. + +checkRecur :: HasEnv m + => String -- ^ Reference name + -> SyntaxTree -- ^ Its syntax tree + -> m Bool +checkRecur name tree = check <$> getDefs + where check = elem name . tDefs name . M.insert name tree + +-- | Turn collection of definition names into collection of empty +-- definitions. + +toDefs :: [String] -> Defs +toDefs = M.fromList . fmap (, []) diff --git a/src/Alga/Language/Eval.hs b/src/Alga/Language/Eval.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Language/Eval.hs @@ -0,0 +1,224 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes process of evaluation of definitions and arbitrary +-- principles. Result of evaluation is infinite list of integers or empty +-- list. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +module Alga.Language.Eval + ( evalDef + , eval + , toPrin ) +where + +import Alga.Language.Element +import Alga.Language.Environment +import Alga.Language.SyntaxTree +import Control.Arrow ((***)) +import Control.Monad.State.Lazy +import Data.List (tails) +import Data.Maybe (listToMaybe) +import Data.Monoid ((<>)) +import System.Random (next) +import System.Random.TF (TFGen) + +-- | State record used for calculation\/evaluation of principles. + +data CalcSt = CalcSt + { clHistory :: [NRatio] -- ^ Recently evaluated values + , clRandGen :: TFGen -- ^ Local random generator + } deriving Show + +-- | Evaluate definition given its name. + +evalDef :: HasEnv m + => String -- ^ Reference name + -> m [NRatio] -- ^ Infinite stream of naturals or empty list +evalDef name = getPrin name >>= eval + +-- | Evaluate given syntax tree. + +eval :: HasEnv m + => SyntaxTree -- ^ Syntax tree + -> m [NRatio] -- ^ Infinite stream of ratios or empty list +eval tree = liftM2 runCalc (resolve . cycle' <$> toPrin tree) newRandGen + where cycle' p = if null $ foldMap (:[]) (Sec p) then [] else cycle p + +-- | Resolve principle into stream of naturals. + +resolve :: MonadState CalcSt m + => Principle -- ^ Principle in question + -> m [NRatio] -- ^ Stream of naturals +resolve [] = return [] +resolve xs = concat <$> mapM f xs + where f (Val x) = addHistory x >> return [x] + f (Sec x) = resolve x + f (Mul x) = choice x >>= maybe (return []) f + f (CMul x) = listToMaybe <$> filterM (matchHistory . fst) x >>= + maybe (f . toMul $ x) (f . Mul . snd) + +-- | Run lazy state monad with 'CalcSt' state. + +runCalc + :: State CalcSt a -- ^ Monad to run + -> TFGen -- ^ Initial random generator + -> a -- ^ Result +runCalc m gen = evalState m CalcSt + { clHistory = mempty + , clRandGen = gen } + +-- | Random choice between given options. + +choice :: MonadState CalcSt m + => [a] -- ^ Options to choose from + -> m (Maybe a) -- ^ Result +choice [] = return Nothing +choice xs = do + (n, g) <- next <$> gets clRandGen + modify $ \c -> c { clRandGen = g } + return . Just $ xs !! (abs n `rem` length xs) + +-- | Check if given elements “matches” history of generated values. This +-- is for conditional multivalues, see manual for more information. +-- +-- Note: head of history is the most recently evaluated element. + +condMatch :: [NRatio] -> Element NRatio -> Bool +condMatch [] _ = False +condMatch (h:_) (Val x) = h == x +condMatch hs (Sec x) = and $ zipWith condMatch (tails hs) (reverse x) +condMatch hs (Mul x) = or $ condMatch hs <$> x +condMatch hs (CMul x) = condMatch hs (toMul x) + +-- | Convert internals of conditional multivalue into plain multivalue. + +toMul + :: [([Element NRatio], [Element NRatio])] -- ^ Pattern\/result pairs + -> Element NRatio -- ^ Internals of plain multivalue +toMul xs = Mul (xs >>= snd) + +-- | A monadic wrapper around 'condMatch'. + +matchHistory :: MonadState CalcSt m + => [Element NRatio] -- ^ Stream of elements to test + -> m Bool -- ^ Do they match history? +matchHistory x = do + hs <- gets clHistory + return . or $ condMatch hs <$> x + +-- | Add evaluated value to history. + +addHistory :: MonadState CalcSt m => NRatio -> m () +addHistory x = modify $ \c -> c { clHistory = return x <> clHistory c } + +-- | Transform 'SyntaxTree' into 'Principle' applying all necessary +-- transformations and resolving references. + +toPrin :: HasEnv m + => SyntaxTree -- ^ Syntax tree to transform + -> m Principle -- ^ Resulting principle +toPrin = fmap simplifySec . toPrin' + +-- | Simplify section. There are several simple transformations that are +-- proven to preserve the same resulting stream of naturals. + +simplifySec :: Principle -> Principle +simplifySec = (>>= f) + where f (Sec xs) = simplifySec xs + f x = simplifyElt x + +-- | Basic simplification of principles. + +simplify :: Principle -> Principle +simplify = (>>= simplifyElt) + +-- | Simplification of single element. Note that single element can produce +-- several elements after simplification. + +simplifyElt :: Element NRatio -> Principle +simplifyElt x@(Val _) = [x] +simplifyElt (Sec [x]) = simplify [x] +simplifyElt (Mul [x]) = simplify [x] +simplifyElt (CMul [(_, xs)]) = simplifyElt (Mul xs) +simplifyElt (Sec xs) = [Sec (simplifySec xs)] +simplifyElt (Mul xs) = [Mul (simplify xs)] +simplifyElt (CMul xs) = [CMul ((simplify *** simplify) <$> xs)] + +-- | The meat of the algorithm that transforms 'SyntaxTree' into 'Principle'. + +toPrin' :: HasEnv m + => SyntaxTree -- ^ Syntax tree to transform + -> m Principle -- ^ Resulting principle +toPrin' = liftM concat . mapM f + where + fPair (c, x) = (,) <$> toPrin' c <*> toPrin' x + f (Value x) = return . Val <$> return x + f (Section xs) = return . Sec <$> toPrin' xs + f (Multi xs) = return . Mul <$> toPrin' xs + f (CMulti xs) = return . CMul <$> mapM fPair xs + f (Reference x) = getPrin x >>= toPrin' + f (Range x y) = return $ Val <$> if x > y then [x,x-1..y] else [x..y] + f (Product x y) = adb (\a b -> [(*) <$> a <*> b]) <$> f x <*> f y + f (Division x y) = adb (\a b -> [sdiv <$> a <*> b]) <$> f x <*> f y + f (Sum x y) = adb (\a b -> [(+) <$> a <*> b]) <$> f x <*> f y + f (Diff x y) = adb (\a b -> [sdif <$> a <*> b]) <$> f x <*> f y + f (Loop x y) = adb loop <$> f x <*> f y + f (Rotation x y) = adb (\a b -> [rotate a b]) <$> f x <*> f y + f (Reverse x) = adu reverse' <$> f x + adb _ [] _ = [] + adb _ xs [] = xs + adb g xs (y:ys) = init xs ++ g (last xs) y ++ ys + adu _ [] = [] + adu g (x:xs) = g x : xs + +-- | Saturated division. + +sdiv :: NRatio -> NRatio -> NRatio +sdiv x 0 = x +sdiv x y = x / y + +-- | Saturated subtraction. + +sdif :: NRatio -> NRatio -> NRatio +sdif x y + | x < y = 0 + | otherwise = x - y + +-- | Concept of looping. + +loop :: Element NRatio -> Element NRatio -> Principle +loop x (Val y) = replicate (floor y) x +loop x (Mul y) = [Mul $ Sec . loop x <$> y] +loop (Sec x) (Sec y) = [Sec . concat $ zipWith loop x (cycle y)] +loop (Mul x) (Sec y) = [Mul . concat $ zipWith loop x (cycle y)] +loop x _ = [x] + +-- | Concept of rotation. + +rotate :: Element NRatio -> Element NRatio -> Element NRatio +rotate (Sec x) (Val y) = Sec $ zipWith const (drop (floor y) (cycle x)) x +rotate x@(Sec _) (Mul y) = Mul $ rotate x <$> y +rotate (Sec x) (Sec y) = Sec $ zipWith rotate x (cycle y) +rotate x _ = x + +-- | Concept of reversion for elements. + +reverse' :: Element NRatio -> Element NRatio +reverse' x@(Val _) = x +reverse' (Mul x) = Mul $ reverse' <$> x +reverse' (Sec x) = Sec $ reverse $ reverse' <$> x +reverse' (CMul x) = CMul $ ((reverse' <$>) *** (reverse' <$>)) <$> x diff --git a/src/Alga/Language/SyntaxTree.hs b/src/Alga/Language/SyntaxTree.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Language/SyntaxTree.hs @@ -0,0 +1,49 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module defines abstract syntax tree of ALGA language. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +module Alga.Language.SyntaxTree + ( SyntaxTree + , Sel (..) ) +where + +import Alga.Language.Element (NRatio) + +-- | Syntax tree in our case is just a collection of syntactic elements. + +type SyntaxTree = [Sel] + +-- | Syntactic element corresponds to language features. Some of them have +-- direct corresponding constructor in 'Alga.Language.Element.Element', +-- others have to be simplified first. + +data Sel + = Value NRatio -- ^ Literal value + | Section [Sel] -- ^ Section + | Multi [Sel] -- ^ Multivalue + | CMulti [([Sel], [Sel])] -- ^ Conditional multivalue + | Reference String -- ^ Reference (name of variable) + | Range NRatio NRatio -- ^ Range of values + | Product Sel Sel -- ^ Product of principles + | Division Sel Sel -- ^ Division of principles + | Sum Sel Sel -- ^ Sum of principles + | Diff Sel Sel -- ^ Subtraction of principles + | Loop Sel Sel -- ^ Loop + | Rotation Sel Sel -- ^ Rotation + | Reverse Sel -- ^ Reversed principle + deriving (Eq, Show) diff --git a/src/Alga/Representation.hs b/src/Alga/Representation.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Representation.hs @@ -0,0 +1,34 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module binds together syntax tree and textual representation of ALGA +-- language. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +module Alga.Representation + ( Statement (..) + , probeAlga + , parseAlga + , showStatement + , showSyntaxTree + , showPrinciple + , divisionOp + , autoDel ) +where + +import Alga.Representation.Base (divisionOp, autoDel) +import Alga.Representation.Parser +import Alga.Representation.Show diff --git a/src/Alga/Representation/Base.hs b/src/Alga/Representation/Base.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Representation/Base.hs @@ -0,0 +1,73 @@ +-- -*- Mode: Haskell; -*- +-- +-- Textual representation of basic elements in ALGA language. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +module Alga.Representation.Base + ( extremumAlias + , panAlias + , commentLine + , productOp + , divisionOp + , sumOp + , diffOp + , loopOp + , rotationOp + , reverseOp + , rangeOp + , defOp + , autoDel ) +where + +extremumAlias :: (String, String) +extremumAlias = ("off", "on") + +panAlias :: (String, String, String) +panAlias = ("L", "C", "R") + +commentLine :: String +commentLine = "#" + +productOp :: String +productOp = "*" + +divisionOp :: String +divisionOp = "/" + +sumOp :: String +sumOp = "+" + +diffOp :: String +diffOp = "-" + +loopOp :: String +loopOp = "$" + +rotationOp :: String +rotationOp = "^" + +reverseOp :: String +reverseOp = "@" + +rangeOp :: String +rangeOp = ".." + +defOp :: String +defOp = "=" + +autoDel :: Char +autoDel = '.' diff --git a/src/Alga/Representation/Parser.hs b/src/Alga/Representation/Parser.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Representation/Parser.hs @@ -0,0 +1,166 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes how to build syntax tree from textual +-- representation of ALGA statements. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +module Alga.Representation.Parser + ( Statement (..) + , probeAlga + , parseAlga ) +where + +import Alga.Language.Element (NRatio) +import Alga.Language.SyntaxTree (SyntaxTree, Sel (..)) +import Control.Applicative +import Control.Monad (void) +import Data.Ratio ((%)) +import Data.Text.Lazy (Text) +import Text.Megaparsec +import Text.Megaparsec.Expr +import Text.Megaparsec.Text.Lazy +import qualified Alga.Representation.Base as B +import qualified Data.Text.Lazy as T +import qualified Text.Megaparsec.Lexer as L + +-- | Statement can be either definition or exposition. Expositions are only +-- used in REPL. + +data Statement + = Definition String SyntaxTree + | Exposition SyntaxTree + deriving (Eq, Show) + +-- | Test if given fragment of ALGA code is finished and self-contained. + +probeAlga :: Text -> Bool +probeAlga txt = not $ or + ["," `T.isSuffixOf` stripped + , f ("[", "]") + , f ("{", "}") + , f ("<", ">") + , f ("(", ")") ] + where stripped = T.strip txt + f (x, y) = (&&) <$> (> 0) <*> (/= g y) $ g x + g x = T.count x stripped + +-- | Entry point for ALGA parsing. + +parseAlga + :: String -- ^ Name of file + -> Text -- ^ Text to parse + -> Either String [Statement] -- ^ Error message or parsed statements +parseAlga file txt = + case parse parser file txt of + Right x -> if null x + then Left $ '\"' : file ++ "\":\ninvalid definition syntax" + else Right x + Left x -> Left . show $ x + where parser = if T.pack B.defOp `T.isInfixOf` txt + then pSource + else return <$> pExposition + +pSource :: Parser [Statement] +pSource = sc *> many pDefinition <* eof + +pDefinition :: Parser Statement +pDefinition = Definition <$> pIdentifier <* pOperator B.defOp <*> pPrinciple + +pExposition :: Parser Statement +pExposition = Exposition <$> (sc *> pPrinciple <* eof) + +pIdentifier :: Parser String +pIdentifier = lexeme $ (:) <$> first <*> many other + where first = letterChar <|> char '_' + other = alphaNumChar <|> char '_' <|> char B.autoDel + +pOperator :: String -> Parser String +pOperator = lexeme . string + +pPrinciple :: Parser SyntaxTree +pPrinciple = sepBy (pExpression <|> pElement) (optional comma) + +pElement :: Parser Sel +pElement + = try pRange + <|> pValue + <|> try pReference + <|> pSection + <|> try pMulti + <|> pCMulti + "element" + +pRange :: Parser Sel +pRange = Range <$> pLiteral <* pOperator B.rangeOp <*> pLiteral + +pValue :: Parser Sel +pValue = Value <$> pLiteral + +pLiteral :: Parser NRatio +pLiteral = rational "literal value" + +pReference :: Parser Sel +pReference = Reference <$> pIdentifier <* notFollowedBy (pOperator B.defOp) + +pSection :: Parser Sel +pSection = Section <$> brackets pPrinciple + +pMulti :: Parser Sel +pMulti = Multi <$> braces pPrinciple + +pCMulti :: Parser Sel +pCMulti = CMulti <$> braces (many $ (,) <$> angles pPrinciple <*> pPrinciple) + +pExpression :: Parser Sel +pExpression = makeExprParser (parens pExpression <|> pElement) optTable + +optTable :: [[Operator Parser Sel]] +optTable = + [[ Prefix (pOperator B.reverseOp *> pure Reverse ) ] + , [ InfixL (pOperator B.productOp *> pure Product ) + , InfixL (pOperator B.divisionOp *> pure Division) + , InfixL (pOperator B.sumOp *> pure Sum ) + , InfixL (pOperator B.diffOp *> pure Diff ) + , InfixL (pOperator B.loopOp *> pure Loop ) + , InfixL (pOperator B.rotationOp *> pure Rotation) ]] + +angles :: Parser a -> Parser a +angles = between (symbol "<") (symbol ">") + +braces :: Parser a -> Parser a +braces = between (symbol "{") (symbol "}") + +brackets :: Parser a -> Parser a +brackets = between (symbol "[") (symbol "]") + +comma :: Parser () +comma = void . hidden . symbol $ "," + +rational :: Parser NRatio +rational = (% 1) . fromIntegral <$> lexeme L.integer + +parens :: Parser a -> Parser a +parens = between (symbol "(") (symbol ")") + +symbol :: String -> Parser String +symbol = L.symbol sc + +lexeme :: Parser a -> Parser a +lexeme = L.lexeme sc + +sc :: Parser () +sc = L.space (void spaceChar) (L.skipLineComment "#") empty diff --git a/src/Alga/Representation/Show.hs b/src/Alga/Representation/Show.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Representation/Show.hs @@ -0,0 +1,127 @@ +-- -*- Mode: Haskell; -*- +-- +-- Here we describe how to build textual representation of syntax trees and +-- principles. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +module Alga.Representation.Show + ( showStatement + , showDefinition + , showSyntaxTree + , showPrinciple ) +where + +import Alga.Language.Element +import Alga.Language.SyntaxTree +import Alga.Representation.Parser (Statement (..)) +import Control.Arrow ((***), (>>>)) +import Data.List (intersperse) +import Data.Monoid ((<>)) +import Data.Ratio (numerator, denominator) +import Data.Text.Lazy (Text) +import qualified Alga.Representation.Base as B +import qualified Data.Text.Lazy.Builder as T (Builder, fromString, toLazyText) +import qualified Data.Text.Lazy.Builder.Int as T (decimal) + +-- | Render a statement. This handles definitions and expositions. + +showStatement :: Statement -> Text +showStatement (Definition n t) = showDefinition n t +showStatement (Exposition t) = showSyntaxTree t + +-- | Render definition. + +showDefinition + :: String -- ^ Reference name + -> SyntaxTree -- ^ Syntax tree + -> Text -- ^ Textual representation of definition +showDefinition n = T.toLazyText . showDefinition' n + +-- | Render syntax tree. + +showSyntaxTree :: SyntaxTree -> Text +showSyntaxTree = T.toLazyText . showSyntaxTree' + +-- | Show principle. This is useful for printing of simplified principles +-- back to user. We can use the same pretty-printing algorithm as for syntax +-- trees, but this requires us to perform transformation from 'Principle' to +-- 'SyntaxTree', which is trivial. + +showPrinciple :: Principle -> Text +showPrinciple = showSyntaxTree . toSyntaxTree + +-- | This is used by 'showDefinition'. It just creates lazy text builder. + +showDefinition' + :: String -- ^ Reference name + -> SyntaxTree -- ^ Syntax tree + -> T.Builder -- ^ Lazy text builder for this definition +showDefinition' n t = T.fromString n <> pad B.defOp <> showSyntaxTree' t + +-- | Convert syntax tree into lazy text builder. + +showSyntaxTree' :: SyntaxTree -> T.Builder +showSyntaxTree' t = cm f t <> "\n" + where + cm g xs = mconcat . intersperse " " $ g <$> xs + p x@(Value _) = f x + p x@(Section _) = f x + p x@(Multi _) = f x + p x@(CMulti _) = f x + p x@(Reference _) = f x + p x@(Range _ _) = f x + p x = "(" <> f x <> ")" + f (Value x) = pRational x + f (Section x) = "[" <> cm f x <> "]" + f (Multi x) = "{" <> cm f x <> "}" + f (CMulti x) = "{" <> cm (c *** cm f >>> uncurry (<>)) x <> "}" + f (Reference x) = T.fromString x + f (Range x y) = pRational x <> T.fromString B.rangeOp <> pRational y + f (Product x y) = f x <> pad B.productOp <> p y + f (Division x@(Value _) y@(Value _)) = + f x <> T.fromString B.divisionOp <> p y + f (Division x y) = f x <> pad B.divisionOp <> p y + f (Sum x y) = f x <> pad B.sumOp <> p y + f (Diff x y) = f x <> pad B.diffOp <> p y + f (Loop x y) = f x <> pad B.loopOp <> p y + f (Rotation x y) = f x <> pad B.rotationOp <> p y + f (Reverse x) = T.fromString B.reverseOp <> p x + c xs = "<" <> cm f xs <> "> " + +-- | Convert principle to syntax tree to show it. + +toSyntaxTree :: Principle -> SyntaxTree +toSyntaxTree = fmap f + where f (Val x) = Value x + f (Sec x) = Section $ f <$> x + f (Mul x) = Multi $ f <$> x + f (CMul x) = CMulti $ (toSyntaxTree *** toSyntaxTree) <$> x + +-- | Pad given string with single space on both sides. + +pad :: String -> T.Builder +pad op = " " <> T.fromString op <> " " + +-- | Render non-negative ratio. + +pRational :: NRatio -> T.Builder +pRational x = + let n = numerator x + d = denominator x + in if d == 1 + then T.decimal n + else T.decimal n <> T.fromString B.divisionOp <> T.decimal d diff --git a/src/Alga/Translation.hs b/src/Alga/Translation.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Translation.hs @@ -0,0 +1,34 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module performs patching of data structure that represent tracks +-- according of state of ALGA environment. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +module Alga.Translation + ( AlgaBackend + , topDefs + , patchAuto + , toBackend ) +where + +import Alga.Translation.Base +import Alga.Translation.Ardour +import Alga.Translation.Cubase + +toBackend :: String -> AlgaBackend +toBackend "ardour" = ardourBackend +toBackend _ = cubaseBackend diff --git a/src/Alga/Translation/Ardour.hs b/src/Alga/Translation/Ardour.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Translation/Ardour.hs @@ -0,0 +1,28 @@ +-- -*- Mode: Haskell; -*- +-- +-- Patching of XML files, Ardour backend. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +module Alga.Translation.Ardour (ardourBackend) where + +import Alga.Translation.Base + +-- | Adour backend for XML configuration patching. This function says: +-- “Please, finish me if you're OK with arrows and you're Ardour user.” + +ardourBackend :: AlgaBackend +ardourBackend = undefined diff --git a/src/Alga/Translation/Base.hs b/src/Alga/Translation/Base.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Translation/Base.hs @@ -0,0 +1,223 @@ +-- -*- Mode: Haskell; -*- +-- +-- In this module we describe how to prepare information about automation +-- tracks and then use specific (to DAW) arrow to patch XML file. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +{-# LANGUAGE BangPatterns #-} +{-# LANGUAGE RecordWildCards #-} + +module Alga.Translation.Base + ( AlgaBackend + , AutoMap + , AutoBatch + , AutoType (..) + , AutoTrack (..) + , nullTrack + , totalDur + , topDefs + , patchAuto ) +where + +import Alga.Language +import Alga.Representation (autoDel) +import Control.Monad.IO.Class +import Data.Map (Map) +import Data.Maybe (isJust, maybeToList) +import Data.Ratio (numerator, denominator) +import Numeric.Natural +import Path +import Text.Megaparsec +import Text.Megaparsec.String +import Text.XML.HXT.Core +import qualified Data.Map.Lazy as M +import qualified Text.Megaparsec.Lexer as L + +-- | ALGA backend is a function that takes 'AutoMap' and returns arrow that +-- patches XML configuration accordingly for given DAW. + +type AlgaBackend = AutoMap -> IOSArrow XmlTree XmlTree + +-- | Collection of automation parameters per track. Tracks are identified by +-- names. + +type AutoMap = Map String AutoBatch + +-- | Collection of various aspects of automation track. + +type AutoBatch = Map AutoType AutoTrack + +-- | Aspect of automation, it includes simple volume or stereo panorama +-- controls as well as any arbitrary parameters supported by given +-- instrument or effect. + +data AutoType + = Volume -- ^ Volume control + | Mute -- ^ “Mute” control + | IGain -- ^ Input gain control + | Pan -- ^ Stereo panorama control + | InsertSlot Natural Natural -- ^ Index of insert slot\/index of parameter + | SendSlot Natural Natural -- ^ Index of send slot\/index of parameter + | SynthParam Natural -- ^ Synth parameter index + deriving (Show, Eq, Ord) + +-- | Automation track is combination of control values and delta times +-- between them. + +data AutoTrack = AutoTrack + { atVal :: [Double] -- ^ Value of parameter + , atDur :: [Double] -- ^ Delta time (duration of that “point”) + } deriving (Eq, Show) + +-- | Check if given track is empty. + +nullTrack :: AutoTrack -> Bool +nullTrack AutoTrack {..} = null atVal || null atDur + +-- | Calculate total duration of automation track. + +totalDur :: AutoTrack -> Double +totalDur AutoTrack {..} = sum atDur + +-- | Generate collection of “top-level” definitions (i.e. definitions that +-- are directly represent aspects of automation track, not auxiliary parts +-- in other definitions). + +topDefs :: HasEnv m => m [String] +topDefs = filter isTopRef <$> getRefs + +-- | Patch XML document containing automation settings for given DAW. + +patchAuto :: (MonadIO m, HasEnv m) + => Natural -- ^ Seed for random number generator + -> Double -- ^ Duration as number of whole notes + -> Path Abs File -- ^ Path to file to path + -> AlgaBackend -- ^ Backed (arrow that will patch XML) + -> m Int -- ^ Exit code +patchAuto s b fpath exec = do + setRandGen s + refs <- getRefs + amap <- M.fromListWith M.union . concat <$> + mapM (fmap maybeToList . toMap b) refs + let file = fromAbsFile fpath + head <$> (liftIO . runX $ + readDocument [withValidate no] file >>> + exec amap >>> + writeDocument [withIndent yes] file >>> + errorMsgStderr >>> + getErrStatus) + +-- | Calculate an automation aspect given name of definition. + +toMap :: HasEnv m + => Double -- ^ Duration as number of whole notes + -> String -- ^ Name of definition of automation aspect + -> m (Maybe (String, AutoBatch)) -- ^ Automation (maybe) +toMap b n = + case parseTopRef n of + Nothing -> return Nothing + Just (r, at) -> fmap f <$> evalTrack b n + where f x = (r, M.singleton at x) + +-- | Evaluate automation aspect if it's defined. + +evalTrack :: HasEnv m + => Double -- ^ Duration as number of whole notes + -> String -- ^ Name of definition + -> m (Maybe AutoTrack) -- ^ Automation track (maybe) +evalTrack b valRef = do + let durRef = valRef ++ durSuffix + val <- fmap toFloat <$> evalDef valRef + dur <- fmap toFloat <$> evalDef durRef + return $ if null val || null dur + then Nothing + else Just $ slice b AutoTrack { atVal = val, atDur = dur } + +-- | Get sufficient part of infinite stream of numbers in automation track +-- making it finite. + +slice + :: Double -- ^ Duration as number of whole notes + -> AutoTrack -- ^ Infinite automation track + -> AutoTrack -- ^ Finite automation track +slice b AutoTrack {..} = + let n = f 0 0 atDur + f !i _ [] = i + f !i !a (x:xs) = if x + a >= b then succ i else f (succ i) (x + a) xs + in AutoTrack { atVal = take n atVal, atDur = take n atDur } + +-- | Convert non-negative rational number into floating point value. + +toFloat :: NRatio -> Double +toFloat x = fromIntegral (numerator x) / fromIntegral (denominator x) + +---------------------------------------------------------------------------- +-- Parsing + +-- | Check if given definition name belongs to “top-level”. + +isTopRef :: String -> Bool +isTopRef = isJust . parseMaybe pTopRef' + +-- | Parser of top-level definitions. Returns base name of corresponding +-- automation aspect. + +parseTopRef :: String -> Maybe (String, AutoType) +parseTopRef = parseMaybe pTopRef + +pTopRef' :: Parser (String, AutoType) +pTopRef' = pTopRef <* optional (string durSuffix) + +pTopRef :: Parser (String, AutoType) +pTopRef = (,) <$> some (satisfy (/= autoDel)) <* char autoDel <*> pSuffix + +pSuffix :: Parser AutoType +pSuffix + = try pVolume + <|> try pMute + <|> try pIGain + <|> try pPan + <|> try pInsert + <|> try pSend + <|> pSynth + +pVolume :: Parser AutoType +pVolume = Volume <$ string "volume" + +pMute :: Parser AutoType +pMute = Mute <$ string "mute" + +pIGain :: Parser AutoType +pIGain = IGain <$ string "igain" + +pPan :: Parser AutoType +pPan = Pan <$ string "pan" + +pInsert :: Parser AutoType +pInsert = string "i" *> (InsertSlot <$> pNum <* string "_" <*> pNum) + +pSend :: Parser AutoType +pSend = string "s" *> (SendSlot <$> pNum <* string "_" <*> pNum) + +pSynth :: Parser AutoType +pSynth = string "p" *> (SynthParam <$> pNum) + +pNum :: Parser Natural +pNum = fromIntegral <$> L.integer + +durSuffix :: String +durSuffix = "d" diff --git a/src/Alga/Translation/Cubase.hs b/src/Alga/Translation/Cubase.hs new file mode 100644 --- /dev/null +++ b/src/Alga/Translation/Cubase.hs @@ -0,0 +1,432 @@ +-- -*- Mode: Haskell; -*- +-- +-- Patching of XML files, Cubase backend. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +{-# LANGUAGE RecordWildCards #-} + +module Alga.Translation.Cubase (cubaseBackend) where + +import Alga.Translation.Base +import Control.Arrow +import Control.Arrow.ArrowTree +import Data.Bool (bool) +import Data.Char (ord) +import Data.Foldable (foldl') +import Data.Map.Lazy (Map) +import Data.Maybe (fromMaybe, listToMaybe) +import Numeric.Natural +import Text.XML.HXT.Core +import qualified Data.Map.Lazy as M + +-- | Cubase backend for XML configuration patching. This module is result of +-- my reverse engineering sessions with Cubase 5 XML-exported tracks. Due to +-- heavy use of arrows, this is a very dense piece of code that may be +-- difficult to read and understand. HXT documentation and general arrow +-- tutorials should help here. + +cubaseBackend :: AlgaBackend +cubaseBackend m = + configSysVars [withNoEmptyElemFor nonEmptyElts] >>> + "tracklist" />/ inList "track" ("obj" />/ procTrack m) + +-- | Process a track. This first identifies tracks for which we have +-- definitions in given 'AutoMap'. Every found definition gets its +-- 'ritualVolumeEvent', because Cubase likes to have empty volume automation +-- track in all cases (when we already have volume automation nothing is +-- added, of course). +-- +-- Then for tracks that are found in XML document and have at the save time +-- automation to add, we need to find GUIDs. 'insertGuids' gets list of +-- GUIDs for insert slots, while 'synthGuids' does the same for synth +-- slots. Then this together with 'AutoBatch' is passed to 'procAuto'. + +procTrack :: ArrowXml a + => AutoMap -- ^ Collection of automation parameters + -> a XmlTree XmlTree -- ^ Arrow transforming a track +procTrack amap = mthis editTrack $< (trackName >>> arr prepBatch) + where editTrack ab = g ab $<< insertGuids &&& synthGuids + g ab is ps = inClass "MAutomationNode" (procAuto ab is ps) + prepBatch x = (`M.union` ritualVolumeEvent) <$> (x `M.lookup` amap) + +-- | Process automation track. First we add integer parameter “Expanded” +-- with value 1, so automation tracks are visible and obvious then patches +-- docuement is loaded. Then we delete existing automation tracks (they go +-- through 'none' arrow), and add various automation events one by one. + +procAuto :: ArrowXml a + => AutoBatch -- ^ Aspects of an automation track + -> [String] -- ^ Insert slots GUIDs + -> [String] -- ^ Synth slots GUIDs + -> a XmlTree XmlTree -- ^ Arrow transforming automation track +procAuto batch is ps = setInt "Expanded" 1 >>> deleteOld += mkTracks + where deleteOld = processChildren (none `when` deletable) + deletable = isList "Tracks" <+> isClass "MAutomationTrack" + mkTracks = M.foldlWithKey' f (mkList "Tracks" "obj" []) batch + f a k t = a ++= g k t + g k = + case k of + Volume -> volumeEvent + Mute -> muteEvent + IGain -> igainEvent + Pan -> panEvent + InsertSlot n s -> mnone' (`iEvent` s) (genInsertDN is n) + SendSlot n s -> sendEvent (genSendDN n) s + SynthParam s -> mnone' (`iEvent` s) (genSynthDN ps) + mnone' = maybe (const none) + +-- | Calculate volume automation event. + +volumeEvent :: ArrowXml a => AutoTrack -> a XmlTree XmlTree +volumeEvent = addEvent 1025 4 Nothing . fixRange + +-- | Calculate mute automation event. + +muteEvent :: ArrowXml a => AutoTrack -> a XmlTree XmlTree +muteEvent = addEvent 1027 5 Nothing + +-- | Calculate input gain automation event. + +igainEvent :: ArrowXml a => AutoTrack -> a XmlTree XmlTree +igainEvent = addEvent 4099 4 Nothing . fixRange + +-- | Calculate stereo panoram automation event. + +panEvent :: ArrowXml a => AutoTrack -> a XmlTree XmlTree +panEvent = addEvent 4201 6 (Just "Panner") + +-- | Calculate event + +iEvent :: ArrowXml a => String -> Natural -> AutoTrack -> a XmlTree XmlTree +iEvent dn i = addEvent (4201 + i) 4 (Just dn) + +-- | Generate automation event for “send” track. + +sendEvent :: ArrowXml a => String -> Natural -> AutoTrack -> a XmlTree XmlTree +sendEvent dn i = addEvent (4096 + i) 5 (Just dn) . bool id fixRange (i == 1) + +-- | Most general way to create automation event. By event we (after Cubase) +-- mean the element representing whole automation track. This may be +-- confusing, so I explicitly mention it here. + +addEvent :: ArrowXml a + => Natural -- ^ Tags (magic number identifying what this thing will control) + -> Natural -- ^ Flags (another magic number, some settings) + -> Maybe String -- ^ + -> AutoTrack -- ^ Automation track (values + delta times) + -> a XmlTree XmlTree +addEvent tag flags dn t = + mkObj (Just "MAutomationTrackEvent") Nothing Nothing + [ mkInt "Flags" 32 + , mkFloat "Start" 0 + , mkFloat "Length" (durFactor * totalDur t) + , mkObj (Just "MAutoListNode") (Just "Node") Nothing + [ mkMember "Domain" + [ mkInt "Type" 0 ] + , mkList "Events" "obj" (genEvents t) ] + , mkAutoTrack dn + , unlessNull (mkInt "Height" 42) + , mkInt "Tag" tag + , unlessNull (mkInt "TrackFlags" flags) ] + where unlessNull a = if nullTrack t then none else a + +-- | Generate automation track element with specified device name. + +mkAutoTrack :: ArrowXml a => Maybe String -> a XmlTree XmlTree +mkAutoTrack dn = ifA (deep $ isAT dn) mkLink mkCmpl + where mkCmpl = mkObj (Just "MAutomationTrack") name (Just $ genID dn) + [ mkInt "Connection Type" (maybe 2 (const 7) dn) + , mnone (mkString "Device Name") dn + , mkInt "Read" 1 + , mkInt "Write" 0 ] + mkLink = mkObj Nothing name (Just (genID dn)) [] + name = Just "Track Device" + +-- | Produce array of elements corresponding to points in our automation +-- track. + +genEvents :: ArrowXml a => AutoTrack -> [a XmlTree XmlTree] +genEvents AutoTrack {..} = zipWith f atVal (fixDur atDur) + where f v d = mkObj (Just "MParamEvent") Nothing Nothing + [mkFloat "Start" d, mkFloat "Value" v] + +-- | Fix range of volume\/gain values, so 1 corresponds to 100% volume. + +fixRange :: AutoTrack -> AutoTrack +fixRange AutoTrack {..} = AutoTrack ((* 0.78908658027648926) <$> atVal) atDur + +-- | Fix duration of every point in automation track. Apart from trivial +-- scaling of values we also transform delta times into start times. + +fixDur :: [Double] -> [Double] +fixDur = fmap (* durFactor) . reverse . tail . foldl' f [] + where f [] a = [a, 0] + f xs@(x:_) a = x + a : xs + +-- | Generate device name for insertion slot given collection of insertion +-- slot GUIDs and index of this insertion slot. + +genInsertDN + :: [String] -- ^ Insert slot GUIDs + -> Natural -- ^ Index of this insert slot + -> Maybe String -- ^ Device name +genInsertDN is n = wrap <$> is !!! n + where wrap x = concat ["Inserts\\Slot", idx, "\\", x, "-0"] + idx = if n > 0 then " " ++ show (succ n) else "" + +-- | Generate device name for send slot given its index. + +genSendDN :: Natural -> String +genSendDN n = "Sends\\Slot" ++ if n > 0 then " " ++ show (succ n) else "" + +-- | Generate device name for synth track given collection of synth GUIDs. + +genSynthDN :: [String] -> Maybe String +genSynthDN ps = wrap <$> ps !!! 0 + where wrap x = "Slot\\" ++ x ++ "-0" + +-- | Generate identifier from device name. Algorithm is not very original, +-- but it works. + +genID :: Maybe String -> String +genID = show . (+ 13) . maybe 0 (sum . zipWith (+) [255,510..] . fmap ord) + +---------------------------------------------------------------------------- +-- Element Creation + +-- | Generate object. + +mkObj :: ArrowXml a + => Maybe String -- ^ Class name + -> Maybe String -- ^ Name attribute + -> Maybe String -- ^ Identifier + -> [a XmlTree XmlTree] -- ^ Attributes + -> a XmlTree XmlTree +mkObj c n i = mkelem "obj" + [ mnone (sattr "class") c + , mnone (sattr "name") n + , sattr "ID" (fromMaybe "7" i) ] + +-- | Generate “member”. + +mkMember :: ArrowXml a + => String -- ^ Name attribute + -> [a XmlTree XmlTree] -- ^ Attributes + -> a XmlTree XmlTree +mkMember name = mkelem "member" [sattr "name" name] + +-- | Generate list. + +mkList :: ArrowXml a + => String -- ^ Name attribute + -> String -- ^ Type attribute + -> [a XmlTree XmlTree] -- ^ Attributes + -> a XmlTree XmlTree +mkList name t = mkelem "list" [sattr "name" name, sattr "type" t] + +-- | Generate string. + +mkString :: ArrowXml a + => String -- ^ Name attribute + -> String -- ^ Value attribute + -> a XmlTree XmlTree +mkString n v = mkNamedVal "string" n v += sattr "wide" "true" + +-- | Generate integer (for our purposes it's always non-negative). + +mkInt :: ArrowXml a + => String -- ^ Name attribute + -> Natural -- ^ Value attribute + -> a XmlTree XmlTree +mkInt n v = mkNamedVal "int" n (show v) + +-- | Generate floating point value. + +mkFloat :: ArrowXml a + => String -- ^ Name attribute + -> Double -- ^ Value attribute + -> a XmlTree XmlTree +mkFloat n v = mkNamedVal "float" n (show v) + +-- | General way to generate named values (i.e. with “name” and “value” +-- attributes). + +mkNamedVal :: ArrowXml a + => String -- ^ Type (tag name) + -> String -- ^ Name attribute + -> String -- ^ Value attribute + -> a XmlTree XmlTree +mkNamedVal t n v = mkelem t [sattr "name" n, sattr "value" v] [] + +---------------------------------------------------------------------------- +-- Get/Set/Access Information + +-- | Get name of track(s). + +trackName :: ArrowXml a => a XmlTree String +trackName = isAnyClass trackEvents /> isClass "MListNode" /> getStr "Name" + +-- | Get collection of GUIDs for insertion slots. + +insertGuids :: ArrowXml a => a XmlTree [String] +insertGuids = guidsIn $ isMember "InsertFolder" /> isList "Slot" /> isItem + +-- | Get collection of GUIDS for synth slots. + +synthGuids :: ArrowXml a => a XmlTree [String] +synthGuids = guidsIn $ isMember "Synth Slot" + +-- | General utility for GUID extraction. + +guidsIn :: ArrowXml a + => a XmlTree XmlTree -- ^ Varying intermediate produce + -> a XmlTree [String] -- ^ Collection of GUIDs +guidsIn a = + listA $ getChildren >>> + isAnyClass tracks /> + isMember "DeviceAttributes" /> + a /> + isMember "Plugin" /> + isMember "Plugin UID" /> + getStr "GUID" + +-- | Get string + +getStr :: ArrowXml a => String -> a XmlTree String +getStr name = + isElem >>> hasName "string" >>> hasAttrValue "name" (== name) >>> + getAttrValue "value" + +setInt :: ArrowXml a => String -> Int -> a XmlTree XmlTree +setInt name val = processChildren $ setVal `when` rightInt + where setVal = addAttr "value" (show val) + rightInt = isElem >>> hasName "int" >>> hasAttrValue "name" (== name) + +---------------------------------------------------------------------------- +-- Special Primitives + +-- | Filter automation tracks corresponding + +isAT :: ArrowXml a => Maybe String -> a XmlTree XmlTree +isAT i = isClass "MAutomationTrack" >>> hasAttrValue "ID" (== genID i) + +-- | Perform some actions on elements with specified class name. + +inList :: ArrowXml a => String -> a XmlTree XmlTree -> a XmlTree XmlTree +inList name action = processChildren $ action `when` isList name + +-- | Filter lists with given name. + +isList :: ArrowXml a => String -> a XmlTree XmlTree +isList name = isElem >>> hasName "list" >>> hasAttrValue "name" (== name) + +-- | Filter elements which are of one of given classes. + +isAnyClass :: ArrowXml a + => [String] -- ^ Collection of class names + -> a XmlTree XmlTree -- ^ Arrow that selects elements of those classes +isAnyClass cs = catA (isClass <$> cs) + +-- | Perform some actions on elements with specified class name. + +inClass :: ArrowXml a => String -> a XmlTree XmlTree -> a XmlTree XmlTree +inClass cls action = processChildren $ action `when` isClass cls + +-- | Filter elements with specified class name. + +isClass :: ArrowXml a => String -> a XmlTree XmlTree +isClass cls = isElem >>> hasName "obj" >>> hasAttrValue "class" (== cls) + +-- | Filter members with given names. + +isMember :: ArrowXml a => String -> a XmlTree XmlTree +isMember name = isElem >>> hasName "member" >>> hasAttrValue "name" (== name) + +-- | Filter items. + +isItem :: ArrowXml a => a XmlTree XmlTree +isItem = isElem >>> hasName "item" + +-- | This takes arrow to use when input is 'Just' value, otherwise it acts +-- as identity arrow. + +mthis :: ArrowXml a => (b -> a XmlTree XmlTree) -> Maybe b -> a XmlTree XmlTree +mthis = maybe this + +-- | If input is 'Nothing', XML stream is purged, otherwise given function +-- is applied. + +mnone :: ArrowXml a => (b -> a XmlTree XmlTree) -> Maybe b -> a XmlTree XmlTree +mnone = maybe none + +-- | Add elements\/attributes. Input of the second argument is current XML +-- (sub)tree and its result is added to it. + +infixl 7 ++= + +(++=) :: ArrowXml a + => a XmlTree XmlTree -- ^ The first arrow + -> a XmlTree XmlTree -- ^ Arrow generating new elements from the first arrow + -> a XmlTree XmlTree -- ^ Arrow combining new elements and existing ones +a ++= b = a += (a >>> b) + +-- | Perform given action on children that have specified name. + +infixr 5 />/ + +(/>/) :: ArrowXml a + => String -- ^ Name of element + -> a XmlTree XmlTree -- ^ Action to perform + -> a XmlTree XmlTree -- ^ Resulting arrow +name />/ action = processChildren $ action `when` (isElem >>> hasName name) + +-- | Safe list indexation. + +infixl 9 !!! + +(!!!) :: [a] -> Natural -> Maybe a +xs !!! n = listToMaybe $ drop (fromIntegral n) xs + +---------------------------------------------------------------------------- +-- Constants + +-- | XML elements that cannot be self-closing. + +nonEmptyElts :: [String] +nonEmptyElts = ["bin","member","obj","list"] + +-- | Names of track events. + +trackEvents :: [String] +trackEvents = ["MAudioTrackEvent","MInstrumentTrackEvent","MDeviceTrackEvent"] + +-- | Names of tracks. + +tracks :: [String] +tracks = ["MAudioTrack","MInstrumentTrack","MTrack"] + +-- | For some reason Cubase likes to have empty automation track for volume +-- in all cases. + +ritualVolumeEvent :: Map AutoType AutoTrack +ritualVolumeEvent = M.singleton Volume (AutoTrack [] []) + +-- | Multiplier to convert number of whole notes into units understood by +-- Cubase. One quarter note is 480 units, so the whole note is 1920. + +durFactor :: Double +durFactor = 1920 diff --git a/src/Main.hs b/src/Main.hs new file mode 100644 --- /dev/null +++ b/src/Main.hs @@ -0,0 +1,177 @@ +-- -*- Mode: Haskell; -*- +-- +-- Main module of ALGA describes logic of the program on top level. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +module Main (main) where + +import Alga.Configuration +import Alga.Interaction +import Alga.Translation (toBackend) +import Control.Monad +import Data.Text.Lazy (Text) +import Data.Version (showVersion) +import Formatting +import Numeric.Natural +import Options.Applicative +import Path +import Paths_alga (version) +import System.Directory (getHomeDirectory, doesFileExist, getCurrentDirectory) +import qualified Data.Map as M +import qualified Data.Text.Lazy.IO as T + +-- | ALGA application command line options. + +data Opts = Opts + { opInterac :: Bool -- ^ Do we run in interactive mode? + , opBackend :: String -- ^ Which backend to use? + , opSeed :: Natural -- ^ Seed for random number generator + , opBeats :: Double -- ^ Duration as number of whole notes + , opTarget :: String -- ^ XML file for patching + , opLicense :: Bool -- ^ Whether to show license + , opVersion :: Bool -- ^ Whether to show program's version + , opFiles :: [FilePath] -- ^ Source files to load + } + +-- | Entry point for the whole thing. + +main :: IO () +main = execParser opts >>= f + where f Opts { opLicense = True } = T.putStr license + f Opts { opVersion = True } = fprint ("ALGA " % string % "\n") ver + f Opts { opFiles = [] + , opBackend = β } = g β interaction + f Opts { opInterac = True + , opBackend = β + , opFiles = ns } = g β $ cmdLoad ns >> interaction + f Opts { opBackend = β + , opSeed = s + , opBeats = b + , opTarget = trg + , opFiles = ns } = g β $ cmdLoad ns >> cmdMake s b trg + g β x = T.putStrLn notice >> runAlga' (ξ β >> x) + ξ β = unless (null β) (cmdBackend β) + ver = showVersion version + +-- | Shortish copyright notice. + +notice :: Text +notice = + "ALGA Copyright © 2015 Mark Karpov\n\n\ + \This program comes with ABSOLUTELY NO WARRANTY. This is free software,\n\ + \and you are welcome to redistribute it under certain conditions; see\n\ + \GNU General Public License for details.\n" + +-- | Longer copyright notice. + +license :: Text +license = + "ALGA — algorithmic automation for various DAWs.\n\ + \Copyright © 2015 Mark Karpov\n\ + \\n\ + \ALGA is free software: you can redistribute it and/or modify it under the\n\ + \terms of the GNU General Public License as published by the Free Software\n\ + \Foundation, either version 3 of the License, or (at your option) any\n\ + \later version.\n\ + \\n\ + \ALGA is distributed in the hope that it will be useful, but WITHOUT ANY\n\ + \WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\n\ + \FOR A PARTICULAR PURPOSE. See the GNU General Public License for more\n\ + \details.\n\ + \\n\ + \You should have received a copy of the GNU General Public License along\n\ + \with this program. If not, see .\n" + +-- | Read configuration file if present and run ALGA monad. + +runAlga' :: Alga () -> IO () +runAlga' e = do + params <- loadConfig + wdir <- getCurrentDirectory >>= parseAbsDir + dfname <- parseRelFile "foo.da" + let dfltSrcFile = fromAbsFile (wdir dfname) + srcFile <- parseAbsFile (lookupCfg params "src" dfltSrcFile) + void $ runAlga e + AlgaSt { stBackend = toBackend $ lookupCfg params "backend" "default" + , stPrevLen = lookupCfg params "prvlen" 18 + , stSrcFile = srcFile } + AlgaCfg { cfgPrecision = lookupCfg params "precision" 0.01 + , cfgPrompt = lookupCfg params "prompt" "> " + , cfgVerbose = lookupCfg params "verbose" True } + +-- | Read configuration file. + +loadConfig :: IO Params +loadConfig = do + home <- getHomeDirectory >>= parseAbsDir + cfn <- parseRelFile ".alga" + let file = fromAbsFile (home cfn) + exist <- doesFileExist file + if exist + then do params <- parseConfig file <$> T.readFile file + case params of + Right x -> return x + Left _ -> return M.empty + else return M.empty + +-- | Some information about the program. + +opts :: ParserInfo Opts +opts = info (helper <*> options) + ( fullDesc + <> progDesc "starts ALGA interpreter or patches given XML file" + <> header "alga — algorithmic automation for various DAWs" ) + +-- | Description of command line options. + +options :: Parser Opts +options = Opts + <$> switch + ( long "interactive" + <> short 'i' + <> help "Start ALGA in interactive mode" ) + <*> strOption + ( long "backend" + <> short 'B' + <> metavar "DAW" + <> value "" + <> help "Specify which backend to use" ) + <*> option auto + ( long "seed" + <> short 's' + <> metavar "SEED" + <> value defaultSeed + <> help ("Set seed for random numbers, default is " ++ show defaultSeed) ) + <*> option auto + ( long "beats" + <> short 'b' + <> metavar "BEATS" + <> value defaultBeats + <> help ("Set total time in whole notes, default is " ++ show defaultBeats) ) + <*> strOption + ( long "target" + <> short 't' + <> metavar "TARGET" + <> value "" + <> help "Specify target XML file for patching" ) + <*> switch + ( long "license" + <> help "Show license of the program" ) + <*> switch + ( long "version" + <> help "Show version of the program" ) + <*> many (strArgument $ metavar "FILES") diff --git a/tests/Main.hs b/tests/Main.hs new file mode 100644 --- /dev/null +++ b/tests/Main.hs @@ -0,0 +1,103 @@ +-- -*- Mode: Haskell; -*- +-- +-- QuickCheck tests for ALGA. +-- +-- Copyright © 2015 Mark Karpov +-- +-- ALGA 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. +-- +-- ALGA 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 . + +{- + TODO: + - parser for configuration files; + - translation from syntax tree to internal language; + - process of translation Principle -> [Double]; + - patching of XML files. +-} + +{-# OPTIONS -fno-warn-orphans #-} + +module Main (main) where + +import Control.Arrow ((&&&), (>>>)) +import Data.Char (isLetter, isAlphaNum) +import Data.Ratio ((%)) + +import Test.Framework (defaultMain, testGroup, Test) +import Test.Framework.Providers.QuickCheck2 (testProperty) +import Test.QuickCheck + +import Alga.Language (Sel (..)) +import Alga.Representation + ( Statement (..) + , probeAlga + , parseAlga + , showStatement + , autoDel ) + +main :: IO () +main = defaultMain tests + +tests :: [Test] +tests = + [ testGroup "Printer and Parser" + [ testProperty "Valid ALGA Probe" prop_valid_probe + , testProperty "Printer and Parser Consistency" prop_pp_consistency ] ] + +prop_valid_probe :: Statement -> Bool +prop_valid_probe = probeAlga . showStatement + +prop_pp_consistency :: Statement -> Bool +prop_pp_consistency = id &&& (parseAlga "" . showStatement) >>> check + where check (x, Right [y]) = x == y + check _ = False + +instance Arbitrary Statement where + arbitrary = + oneof [ Definition <$> identifier <*> arbitrary + , Exposition <$> arbitrary ] + +instance Arbitrary Sel where + arbitrary = sized arbitrarySel + +arbitrarySel :: Int -> Gen Sel +arbitrarySel 0 = + oneof [ Value <$> nonNegative + , Reference <$> identifier + , Range <$> nonNegative <*> nonNegative ] + where nonNegative = (% 1) . getNonNegative <$> arbitrary +arbitrarySel n = + oneof [ Section <$> listSel + , Multi <$> listSel + , CMulti <$> listCnd + , Product <$> leafSel <*> leafSel + , Division <$> leafSel <*> leafSel + , Sum <$> leafSel <*> leafSel + , Diff <$> leafSel <*> leafSel + , Loop <$> leafSel <*> leafSel + , Rotation <$> leafSel <*> leafSel + , Reverse <$> leafSel ] + where cnSel d = arbitrarySel (n `div` d) + vcSel d = (getNonNegative <$> arbitrary) + >>= \s -> vectorOf s (cnSel $ d * s) + leafSel = cnSel 2 + listSel = vcSel 1 + listCnd = (getPositive <$> arbitrary) + >>= \s -> vectorOf s $ (,) <$> vcSel s <*> vcSel s + +identifier :: Gen String +identifier = (:) <$> ch0 <*> chN + where ch0 = u isLetter + chN = listOf $ u (\x -> isAlphaNum x || x == autoDel) + u f = frequency [ (1, return '_') + , (74, arbitrary `suchThat` f) ]