diff --git a/Extra/xenosInterface.png b/Extra/xenosInterface.png new file mode 100644 index 0000000..3f0813c Binary files /dev/null and b/Extra/xenosInterface.png differ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -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 index 0000000..c59e939 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Xenos + +Xenos is a virtual instrument plug-in that implements and extends the Dynamic Stochastic Synthesis (DSS) algorithm invented by Iannis Xenakis. It is open-source, cross-platform, and can be built in a number of plugin formats. + +![](Extra/xenosInterface.png "The Xenos interface") + +Features include: +- Authentic DSS engine +- Xenharmonic pitch quantizer +- Custom scale import in the [Scala](https://www.huygens-fokker.org/scala/) format +- Ten stochastic distributions with up to two parameters each +- First- and second-order random walks +- Variable number of segments per wave cycle +- Variable amplitude envelope +- Polyphonic (64 voices by default) +- MIDI implementation (notes, sustain, pitch bend) +- External MIDI controller assignment +- Parameter automation +- Simple and streamlined interface +- Free and open source + +## Build + +1. [Download](https://juce.com/get-juce/download) JUCE +2. Clone or [download](https://github.com/raphaelradna/xenos/archive/refs/heads/main.zip) Xenos +3. Open Xenos.jucer in the Projucer +4. Export the project for your IDE and platform (e.g. Xcode (maxOS) or Visual Studio 2019); see [here](https://docs.juce.com/master/tutorial_new_projucer_project.html) for help +5. Compile Xenos using your IDE (or make on Linux) +6. Copy the plug-in binary (e.g., Xenos.component, Xenos.vst3, etc.) to the proper location for your platform and host software +7. Open a suitable plug-in host application, add Xenos on a virtual instrument track, and enjoy! + +## Pre-built releases and user manual coming soon! \ No newline at end of file diff --git a/Resources/background.png b/Resources/background.png new file mode 100644 index 0000000..b907e52 Binary files /dev/null and b/Resources/background.png differ diff --git a/Source/ParamListener.h b/Source/ParamListener.h new file mode 100644 index 0000000..b6d19a9 --- /dev/null +++ b/Source/ParamListener.h @@ -0,0 +1,25 @@ +/* + ============================================================================== + + ParamListener.h + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#pragma once + +class ParamListener : public juce::AudioProcessorValueTreeState::Listener { +public: + ParamListener(XenosAudioProcessor& aP_) : aP(aP_) {} + + void parameterChanged(const juce::String& parameterID, float newValue) + { + aP.xenosAudioSource.setParam(parameterID, newValue); + } +private: + XenosAudioProcessor& aP; +}; diff --git a/Source/ParamMenu.h b/Source/ParamMenu.h new file mode 100644 index 0000000..4ebd790 --- /dev/null +++ b/Source/ParamMenu.h @@ -0,0 +1,25 @@ +/* + ============================================================================== + + ParamMenu.h + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#pragma once + +#include "ParamListener.h" + +struct ParamMenu : juce::ComboBox { + juce::Label label; + std::unique_ptr + attachment; + ParamListener* listener; + std::string param, disp; + + ParamMenu() {} +}; diff --git a/Source/ParamSlider.h b/Source/ParamSlider.h new file mode 100644 index 0000000..635843b --- /dev/null +++ b/Source/ParamSlider.h @@ -0,0 +1,25 @@ +/* + ============================================================================== + + ParamSlider.h + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#pragma once + +#include "ParamListener.h" + +struct ParamSlider : juce::Slider { + juce::Label label; + std::unique_ptr + attachment; + ParamListener* listener; + std::string param, disp; + + ParamSlider() {} +}; diff --git a/Source/PluginEditor.cpp b/Source/PluginEditor.cpp new file mode 100644 index 0000000..757c547 --- /dev/null +++ b/Source/PluginEditor.cpp @@ -0,0 +1,309 @@ +/* + ============================================================================== + + PluginEditor.cpp + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#include "PluginProcessor.h" +#include "PluginEditor.h" + +//============================================================================== +XenosAudioProcessorEditor::XenosAudioProcessorEditor( + XenosAudioProcessor& p, juce::AudioProcessorValueTreeState& vts) + : AudioProcessorEditor(&p) + , audioProcessor(p) + , valueTreeState(vts) + , customButton("load...") + , keyboardComponent(p.keyboardState, + juce::MidiKeyboardComponent::horizontalKeyboard) +{ + setSize(700, 560); + + red = juce::Colours::red; + green = juce::Colours::lawngreen; + blue = juce::Colours::cornflowerblue; + + formatHeaderLabel(pitchLabel, "PITCH"); + + initParamSlider(pitchWidth, "pitchWidth", "WIDTH", vertical, red); + initParamSlider(pitchBarrier, "pitchBarrier", "BARRIER", vertical, red); + initParamSlider(pitchStep, "pitchStep", "STEP", vertical, red); + + initParamMenu(pitchDistribution, "pitchDistribution", "DISTRIBUTION"); + initParamMenu(pitchWalk, "pitchWalk", "WALK"); + initParamSlider(pitchAlpha, "pitchAlpha", "α", horizontal, red); + initParamSlider(pitchBeta, "pitchBeta", "β", horizontal, red); + + formatHeaderLabel(amplitudeLabel, "AMPLITUDE"); + + initParamSlider(ampGain, "ampGain", "GAIN", vertical, green); + initParamSlider(ampBarrier, "ampBarrier", "BARRIER", vertical, green); + initParamSlider(ampStep, "ampStep", "STEP", vertical, green); + + initParamMenu(ampDistribution, "ampDistribution", "DISTRIBUTION"); + initParamMenu(ampWalk, "ampWalk", "WALK"); + initParamSlider(ampAlpha, "ampAlpha", "α", horizontal, green); + initParamSlider(ampBeta, "ampBeta", "β", horizontal, green); + + formatHeaderLabel(envelopeLabel, "GLOBAL"); + + initParamSlider(attack, "attack", "A", vertical, blue); + initParamSlider(decay, "decay", "D", vertical, blue); + initParamSlider(sustain, "sustain", "S", vertical, blue); + initParamSlider(release, "release", "R", vertical, blue); + + initParamSlider(segments, "segments", "SEGMENTS", horizontal, blue); + initParamMenu(scale, "scale", "SCALE", + 29.16675f); // ideally refactor to use relative pixel value + scale.setItemEnabled(customScaleMenuIndex, false); + initParamSlider(root, "root", "ROOT", horizontal, blue); + + if (!audioProcessor.customScaleData.isEmpty()) { + scale.changeItemText(customScaleMenuIndex, + audioProcessor.customScaleName); + scale.setItemEnabled(customScaleMenuIndex, true); + if (dynamic_cast( + valueTreeState.getParameter("scale")) + ->getIndex() + == customScaleParamIndex) { + scale.setSelectedId(customScaleMenuIndex); + } + } + + customButton.setLookAndFeel(&xenosLookAndFeel); + addAndMakeVisible(customButton); + customButton.addListener(this); + + addAndMakeVisible(keyboardComponent); +} + +XenosAudioProcessorEditor::~XenosAudioProcessorEditor() {} + +//============================================================================== +void XenosAudioProcessorEditor::paint(juce::Graphics& g) +{ + g.fillAll( + getLookAndFeel().findColour(juce::ResizableWindow::backgroundColourId)); + juce::Image background = juce::ImageCache::getFromMemory( + BinaryData::background_png, BinaryData::background_pngSize); + g.drawImageAt(background, 0, 0); + + double w = getWidth(); + double h = getHeight(); + auto header = h / 16; + auto margin = w / 64; + auto panel1W = w / 3 - margin * 2; + + g.setColour(juce::Colours::white); + auto line1X = 2 * margin + panel1W; + auto line2X = line1X * 2; + auto lineY = header / 2; + g.drawLine(line1X, lineY, line1X, 25 * h / 32, 2.0f); + g.drawLine(line2X, lineY, line2X, 25 * h / 32, 2.0f); + + g.setFont(9.0f); + juce::String copyr = juce::String::fromUTF8(u8"\u00A9"); + g.drawText( + "Copyright " + copyr + " 2022 Raphael Radna. All rights reserved.", + margin, h - margin, w - margin * 2, margin, juce::Justification::right); +} + +void XenosAudioProcessorEditor::resized() +{ + double w = getWidth(); + double h = getHeight(); + + auto header = h / 16; + auto margin = w / 64; + auto panel1W = w / 3 - margin * 2; + auto panel1H = 8 * h / 16; + pitchLabel.setBounds(margin, 0, panel1W, header); + + auto sliderStep = panel1W / 3 + ((panel1W / 3) - (panel1W / 4)) / 2; + auto vSliderY = header + margin; + auto vSliderH = panel1H - margin * 2; + pitchWidth.setBounds(margin, vSliderY, panel1W / 4, vSliderH); + pitchBarrier.setBounds(margin + sliderStep, vSliderY, panel1W / 4, + vSliderH); + pitchStep.setBounds(margin + 2 * sliderStep, vSliderY, panel1W / 4, + vSliderH); + + auto panel1X2 = w / 3 + margin; + amplitudeLabel.setBounds(panel1X2, 0, panel1W, header); + + ampGain.setBounds(panel1X2, vSliderY, panel1W / 4, vSliderH); + ampBarrier.setBounds(panel1X2 + sliderStep, vSliderY, panel1W / 4, + vSliderH); + ampStep.setBounds(panel1X2 + 2 * sliderStep, vSliderY, panel1W / 4, + vSliderH); + + auto panel1X3 = 2 * w / 3 + margin; + envelopeLabel.setBounds(panel1X3, 0, panel1W, header); + + attack.setBounds(panel1X3, vSliderY, panel1W / 4, vSliderH); + decay.setBounds(panel1X3 + panel1W / 4, vSliderY, panel1W / 4, vSliderH); + sustain.setBounds(panel1X3 + 2 * panel1W / 4, vSliderY, panel1W / 4, + vSliderH); + release.setBounds(panel1X3 + 3 * panel1W / 4, vSliderY, panel1W / 4, + vSliderH); + + auto panel2Y = 9 * h / 16 + margin * 1.5; + auto panel2H = 4 * h / 16 - margin; + auto menuH = panel2H / 8; + auto menuW = panel1W / 2 - margin / 2; + auto hSliderYOffset = panel2H / 3; + auto hSliderW = panel1W + margin / 2; + pitchDistribution.setBounds(margin, panel2Y, menuW, menuH); + pitchWalk.setBounds(margin + panel1W / 2 + margin / 2, panel2Y, menuW, + menuH); + pitchAlpha.setBounds(margin, panel2Y + hSliderYOffset, hSliderW, menuH); + pitchBeta.setBounds(margin, panel2Y + hSliderYOffset * 2, hSliderW, menuH); + + ampDistribution.setBounds(panel1X2, panel2Y, menuW, menuH); + ampWalk.setBounds(panel1X2 + panel1W / 2 + margin / 2, panel2Y, menuW, + menuH); + ampAlpha.setBounds(panel1X2, panel2Y + hSliderYOffset, hSliderW, menuH); + ampBeta.setBounds(panel1X2, panel2Y + hSliderYOffset * 2, hSliderW, menuH); + + scale.setBounds(panel1X3, panel2Y, panel1W * 0.75, menuH); + customButton.setBounds(panel1X3 + panel1W * 0.75, panel2Y, panel1W * 0.25, + menuH); + root.setBounds(panel1X3, panel2Y + hSliderYOffset, hSliderW, menuH); + segments.setBounds(panel1X3, panel2Y + hSliderYOffset * 2, hSliderW, menuH); + + auto keyboardY = 13 * h / 16; + keyboardComponent.setBounds(margin, keyboardY, w - margin * 2, + h - keyboardY - margin); +} + +//============================================================================== + +void XenosAudioProcessorEditor::formatHeaderLabel(juce::Label& label, + std::string t) +{ + label.setText(t, juce::dontSendNotification); + label.setFont(20.0f); + label.setJustificationType(juce::Justification::centred); + addAndMakeVisible(label); +} + +void XenosAudioProcessorEditor::initParamSlider(ParamSlider& slider, + std::string p, std::string d, + sliderStyle s, juce::Colour c) +{ + slider.param = p; + slider.disp = d; + + slider.attachment.reset( + new SliderAttachment(valueTreeState, slider.param, slider)); + slider.listener = new ParamListener(audioProcessor); + valueTreeState.addParameterListener(slider.param, slider.listener); + slider.setTextValueSuffix( + " " + valueTreeState.getParameter(slider.param)->getLabel()); + + slider.label.setText(slider.disp, juce::dontSendNotification); + switch (s) { + case vertical: + slider.setSliderStyle(juce::Slider::SliderStyle::LinearVertical); + slider.setTextBoxStyle(juce::Slider::TextBoxBelow, false, 52.0f, 16.0f); + + slider.label.attachToComponent(dynamic_cast(&slider), + false); + slider.label.setJustificationType(juce::Justification::centred); + slider.label.setMinimumHorizontalScale(1.0f); + slider.label.setSize(slider.getWidth() * 1.5, slider.label.getHeight()); + slider.label.setCentrePosition(slider.getX() + slider.getWidth() / 2, + slider.label.getY() + + slider.label.getHeight() * 0.75f); + break; + case horizontal: + slider.setSliderStyle(juce::Slider::SliderStyle::LinearHorizontal); + slider.setTextBoxStyle(juce::Slider::TextBoxLeft, false, 52.0f, 16.0f); + + slider.label.attachToComponent(dynamic_cast(&slider), + false); + slider.label.setJustificationType(juce::Justification::centred); + break; + case rotary: + slider.setSliderStyle(juce::Slider::SliderStyle::Rotary); + slider.setTextBoxStyle(juce::Slider::TextBoxBelow, false, 52.0f, 16.0f); + + slider.label.attachToComponent(dynamic_cast(&slider), + false); + slider.label.setJustificationType(juce::Justification::centred); + break; + } + + slider.setLookAndFeel(&xenosLookAndFeel); + slider.setColour(juce::Slider::thumbColourId, c); + slider.setColour(juce::Slider::trackColourId, c.darker(2.0f)); + slider.setColour(juce::CaretComponent::caretColourId, c); + + addAndMakeVisible(slider); + addAndMakeVisible(slider.label); +} + +void XenosAudioProcessorEditor::initParamMenu(ParamMenu& menu, std::string p, + std::string d, float labelOffsetX) +{ + menu.param = p; + menu.disp = d; + + auto paramObject = dynamic_cast( + valueTreeState.getParameter(menu.param)); + menu.addItemList(paramObject->choices, 1); + addAndMakeVisible(menu); + menu.attachment.reset( + new ComboBoxAttachment(valueTreeState, menu.param, menu)); + menu.listener = new ParamListener(audioProcessor); + valueTreeState.addParameterListener(menu.param, menu.listener); + + // menu.label.setText(valueTreeState.getParameter(menu.param)->getName(99), + // juce::dontSendNotification); + menu.label.setText(menu.disp, juce::dontSendNotification); + menu.label.setJustificationType(juce::Justification::centred); + menu.label.attachToComponent(dynamic_cast(&menu), false); + auto labelPos = menu.label.getPosition(); + labelPos.addXY(labelOffsetX, 0.0f); + menu.label.setTopLeftPosition(labelPos); + + menu.setLookAndFeel(&xenosLookAndFeel); + menu.setColour(juce::ComboBox::backgroundColourId, + getLookAndFeel().findColour(juce::Slider::trackColourId)); + + addAndMakeVisible(menu.label); +} + +void XenosAudioProcessorEditor::buttonClicked(juce::Button* button) +{ + if (button == &customButton) loadCustomScale(); +} + +void XenosAudioProcessorEditor::loadCustomScale() +{ + juce::FileChooser chooser("Select a Scala tuning file (.scl) to load.", + juce::File{}, "*.scl"); + if (chooser.browseForFileToOpen()) { + juce::File f = chooser.getResult(); + juce::StringArray scaleData; + f.readLines(scaleData); + juce::String scaleName = f.getFileNameWithoutExtension(); + + if (audioProcessor.xenosAudioSource.loadScl(scaleData, true)) { + scale.changeItemText(customScaleMenuIndex, scaleName); + scale.setItemEnabled(customScaleMenuIndex, true); + scale.setSelectedId(customScaleMenuIndex); + + audioProcessor.customScaleName = scaleName; + audioProcessor.customScaleData = scaleData; + + audioProcessor.updateHostDisplay(); + } + } +} diff --git a/Source/PluginEditor.h b/Source/PluginEditor.h new file mode 100644 index 0000000..a2f7ea6 --- /dev/null +++ b/Source/PluginEditor.h @@ -0,0 +1,170 @@ +/* + ============================================================================== + + PluginEditor.h + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#pragma once + +#include +#include "ParamMenu.h" +#include "ParamSlider.h" +#include "PluginProcessor.h" + +//============================================================================== + +enum sliderStyle { vertical, horizontal, rotary }; + +class XenosLookAndFeel : public juce::LookAndFeel_V4 { +public: + XenosLookAndFeel() + { + backgroundColor = findColour(juce::Slider::trackColourId); + outlineColor = findColour(juce::Slider::textBoxOutlineColourId); + sliderColor = findColour(juce::Slider::backgroundColourId); + + setColour(juce::Slider::backgroundColourId, backgroundColor); + setColour(juce::Slider::thumbColourId, juce::Colours::red); + setColour(juce::Slider::textBoxBackgroundColourId, backgroundColor); + setColour(juce::Slider::textBoxHighlightColourId, + outlineColor.darker(1.0f)); + } + + void drawButtonBackground(juce::Graphics& g, juce::Button& b, + const juce::Colour& backgroundColour, + bool shouldDrawButtonAsHighlighted, + bool shouldDrawButtonAsDown) override + { + juce::Colour buttonColor = (!shouldDrawButtonAsHighlighted) + ? backgroundColor + : outlineColor.darker(1.0f); + g.setColour(buttonColor); + auto w = b.getWidth(); + auto h = b.getHeight(); + g.fillRect(0, 0, w, h); + g.setColour(outlineColor); + g.drawRect(0, 0, w, h, 1); + } + + void drawComboBox(juce::Graphics& g, int width, int height, + bool isButtonDown, int buttonX, int buttonY, int buttonW, + int buttonH, juce::ComboBox& c) override + { + g.setColour(backgroundColor); + g.fillRect(0, 0, width, height); + g.setColour(outlineColor); + g.drawRect(0, 0, width, height, 1); + + int p1X = buttonX + buttonW / 3; + int p1Y = buttonY + buttonH / 3; + int p3X = buttonX + 2 * buttonW / 3; + int p2X = (p1X + p3X) / 2.f; + int p2Y = buttonY + buttonH - buttonH / 3; + int shift = 5; + + juce::Path p; + p.addTriangle(p1X + shift, p1Y, p2X + shift, p2Y, p3X + shift, p1Y); + g.fillPath(p); + } + + void positionComboBoxText(juce::ComboBox& c, + juce::Label& labelToPosition) override + { + labelToPosition.setSize(c.getWidth() - 25, c.getHeight()); + } + + juce::Font getLabelFont(juce::Label&) override { return juce::Font(12.0f); } + + juce::Font getComboBoxFont(juce::ComboBox&) override + { + return juce::Font(12.0f); + } + + void drawPopupMenuBackground(juce::Graphics& g, int width, + int height) override + { + g.setColour(backgroundColor); + g.fillRect(0, 0, width, height); + g.setColour(outlineColor); + g.drawRect(0, 0, width, height); + } + + juce::Font getPopupMenuFont() override { return juce::Font(24.0f); } +private: + juce::Colour backgroundColor, outlineColor, sliderColor; +}; + +class XenosAudioProcessorEditor + : public juce::AudioProcessorEditor + , private juce::Button::Listener { +public: + typedef juce::AudioProcessorValueTreeState::SliderAttachment + SliderAttachment; + typedef juce::AudioProcessorValueTreeState::ComboBoxAttachment + ComboBoxAttachment; + + XenosAudioProcessorEditor(XenosAudioProcessor&, + juce::AudioProcessorValueTreeState&); + ~XenosAudioProcessorEditor() override; + + //============================================================================== + void paint(juce::Graphics&) override; + void resized() override; + + //============================================================================== + void formatHeaderLabel(juce::Label& label, std::string t); + void initParamSlider(ParamSlider& slider, std::string p, std::string d, + sliderStyle s = vertical, + juce::Colour c = juce::Colours::red); + void initParamMenu(ParamMenu& menu, std::string p, std::string d, + float labelOffsetX = 0.0f); + void buttonClicked(juce::Button* button) override; + void loadCustomScale(); +private: + XenosAudioProcessor& audioProcessor; + juce::AudioProcessorValueTreeState& valueTreeState; + XenosLookAndFeel xenosLookAndFeel; + + ParamSlider pitchWidth; + ParamSlider pitchBarrier; + ParamSlider pitchStep; + ParamMenu pitchDistribution; + ParamMenu pitchWalk; + ParamSlider pitchAlpha; + ParamSlider pitchBeta; + + ParamSlider ampGain; + ParamSlider ampBarrier; + ParamSlider ampStep; + ParamMenu ampDistribution; + ParamMenu ampWalk; + ParamSlider ampAlpha; + ParamSlider ampBeta; + + ParamSlider attack; + ParamSlider decay; + ParamSlider sustain; + ParamSlider release; + ParamSlider segments; + + ParamMenu scale; + juce::TextButton customButton; + ParamSlider root; + + juce::MidiKeyboardComponent keyboardComponent; + + juce::Label pitchLabel, amplitudeLabel, envelopeLabel; + + juce::Colour red, green, blue; + + const int customScaleParamIndex = SCALE_PRESETS + 1; + const int customScaleMenuIndex = SCALE_PRESETS + 2; + + JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(XenosAudioProcessorEditor) +}; diff --git a/Source/PluginProcessor.cpp b/Source/PluginProcessor.cpp new file mode 100644 index 0000000..ec084f4 --- /dev/null +++ b/Source/PluginProcessor.cpp @@ -0,0 +1,389 @@ +/* + ============================================================================== + + PluginProcessor.cpp + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#include "PluginProcessor.h" +#include "PluginEditor.h" + +//============================================================================== +XenosAudioProcessor::XenosAudioProcessor() +#ifndef JucePlugin_PreferredChannelConfigurations + : AudioProcessor( + BusesProperties() +#if !JucePlugin_IsMidiEffect +#if !JucePlugin_IsSynth +// .withInput ("Input", juce::AudioChannelSet::stereo(), +// true) +#endif + .withOutput("Output", juce::AudioChannelSet::stereo(), true) +#endif + ) + , xenosAudioSource(keyboardState) + , params( + *this, nullptr, juce::Identifier("Xenos"), + {std::make_unique( + juce::ParameterID{"segments", 1}, // parameterID, version hint + "segments", // parameter display name + 2, // minimum value + 128, // maximum value + 12), // default value + std::make_unique( + juce::ParameterID{"pitchWidth", 1}, "pitchWidth", + juce::NormalisableRange(0.0f, 96.0f, 0.0f, 1.0f), 1.0f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); }) + .withLabel("st")), + std::make_unique( + juce::ParameterID{"pitchBarrier", 1}, "pitchBarrier", + juce::NormalisableRange(0.0f, 1.0f, 0.0f, 0.5f), 0.1f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); })), + std::make_unique( + juce::ParameterID{"pitchStep", 1}, "pitchStep", + juce::NormalisableRange(0.0f, 1.0f, 0.0f, 0.5f), 0.01f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); })), + std::make_unique( + juce::ParameterID{"ampGain", 1}, "ampGain", + juce::NormalisableRange(-96.0f, 0.0f, 0.0f, 4.0f), 0.0f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction([](auto x, auto) { + return (x > -96.0f) ? juce::String(x, 3) : "-inf"; + }) + .withLabel("dB")), + std::make_unique( + juce::ParameterID{"ampBarrier", 1}, "ampBarrier", + juce::NormalisableRange(0.0f, 1.0f, 0.0f, 0.5f), 0.1f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); })), + std::make_unique( + juce::ParameterID{"ampStep", 1}, "ampStep", + juce::NormalisableRange(0.0f, 1.0f, 0.0f, 0.5f), 0.01f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); })), + std::make_unique( + juce::ParameterID{"pitchDistribution", + 1}, // parameterID, version hint + "pitchDistribution", // parameter display name + juce::StringArray{// choices + "uniform", "gaussian", "poisson", "cauchy", + "logistic", "hyperbolic cosine", "arcsine", + "exponential", "triangular", "sinus"}, + 0), // index of default value + std::make_unique( + juce::ParameterID{"pitchWalk", 1}, "pitchWalk", + juce::StringArray{"primary", "secondary"}, 1), + std::make_unique( + juce::ParameterID{"pitchAlpha", 1}, "pitchAlpha", + juce::NormalisableRange(-100.0f, 100.0f, 0.0f, 0.3f, + true), + 1.0f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); })), + std::make_unique( + juce::ParameterID{"pitchBeta", 1}, "pitchBeta", + juce::NormalisableRange(-100.0f, 100.0f, 0.0f, 0.3f, + true), + 1.0f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); })), + std::make_unique( + juce::ParameterID{"ampDistribution", 1}, "ampDistribution", + juce::StringArray{// choices + "uniform", "gaussian", "poisson", "cauchy", + "logistic", "hyperbolic cosine", "arcsine", + "exponential", "triangular", "sinus"}, + 0), + std::make_unique( + juce::ParameterID{"ampWalk", 1}, "ampWalk", + juce::StringArray{"primary", "secondary"}, 1), + std::make_unique( + juce::ParameterID{"ampAlpha", 1}, "ampAlpha", + juce::NormalisableRange(-100.0f, 100.0f, 0.0f, 0.3f, + true), + 1.0f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); })), + std::make_unique( + juce::ParameterID{"ampBeta", 1}, "ampBeta", + juce::NormalisableRange(-100.0f, 100.0f, 0.0f, 0.3f, + true), + 1.0f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); })), + std::make_unique( + juce::ParameterID{"attack", 1}, // parameterID, version hint + "attack", // parameter display name + juce::NormalisableRange(0.001f, 100.0f, 0.0f, + 0.3f), // range + 0.1f, // default value + juce::AudioParameterFloatAttributes() // attributes + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); }) + .withLabel("s")), + std::make_unique( + juce::ParameterID{"decay", 1}, "decay", + juce::NormalisableRange(0.001f, 100.0f, 0.0f, 0.3f), 0.1f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); }) + .withLabel("s")), + std::make_unique( + juce::ParameterID{"sustain", 1}, "sustain", + juce::NormalisableRange(-96.0f, 0.0f, 0.0f, 4.0f), 0.0f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction([](auto x, auto) { + return (x > -96.0f) ? juce::String(x, 3) : "-inf"; + }) + .withLabel("dB")), + std::make_unique( + juce::ParameterID{"release", 1}, "release", + juce::NormalisableRange(0.001f, 100.0f, 0.0f, 0.3f), 0.1f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); }) + .withLabel("s")), + std::make_unique( + juce::ParameterID{"scale", 1}, "scale", + juce::StringArray{ + "none", "pentatonic", "pentatonic (pythagorean)", "blues", + "blues (7-limit)", "whole-tone", "major", "major (5-limit)", + "minor", "minor (5-limit)", "octatonic", "overtone", + "chromatic", "bohlen-pierce", "quarter-tone", "custom"}, + 0), + std::make_unique( + juce::ParameterID{"root", 1}, "root", + juce::NormalisableRange(0.0f, 12.0f, 0.0f, 1.0f), 0.0f, + juce::AudioParameterFloatAttributes() + .withStringFromValueFunction( + [](auto x, auto) { return juce::String(x, 3); }) + .withLabel("st"))}) +#endif +{ + segmentsParam = params.getRawParameterValue("segments"); + pitchWidthParam = params.getRawParameterValue("pitchWidth"); + pitchBarrierParam = params.getRawParameterValue("pitchBarrier"); + pitchStepParam = params.getRawParameterValue("pitchStep"); + ampGainParam = params.getRawParameterValue("ampGain"); + ampBarrierParam = params.getRawParameterValue("ampBarrier"); + ampStepParam = params.getRawParameterValue("ampStep"); + + pitchDistributionParam = params.getRawParameterValue("pitchDistribution"); + pitchWalkParam = params.getRawParameterValue("pitchWalk"); + pitchAlphaParam = params.getRawParameterValue("pitchAlpha"); + pitchBetaParam = params.getRawParameterValue("pitchBeta"); + + ampDistributionParam = params.getRawParameterValue("ampDistribution"); + ampWalkParam = params.getRawParameterValue("ampWalk"); + ampAlphaParam = params.getRawParameterValue("ampAlpha"); + ampBetaParam = params.getRawParameterValue("ampBeta"); + + attackParam = params.getRawParameterValue("attack"); + decayParam = params.getRawParameterValue("decay"); + sustainParam = params.getRawParameterValue("sustain"); + releaseParam = params.getRawParameterValue("release"); + + scaleParam = params.getRawParameterValue("scale"); + rootParam = params.getRawParameterValue("root"); +} + +XenosAudioProcessor::~XenosAudioProcessor() {} + +//============================================================================== +const juce::String XenosAudioProcessor::getName() const +{ + return JucePlugin_Name; +} + +bool XenosAudioProcessor::acceptsMidi() const +{ +#if JucePlugin_WantsMidiInput + return true; +#else + return false; +#endif +} + +bool XenosAudioProcessor::producesMidi() const +{ +#if JucePlugin_ProducesMidiOutput + return true; +#else + return false; +#endif +} + +bool XenosAudioProcessor::isMidiEffect() const +{ +#if JucePlugin_IsMidiEffect + return true; +#else + return false; +#endif +} + +double XenosAudioProcessor::getTailLengthSeconds() const { return 0.0; } + +int XenosAudioProcessor::getNumPrograms() +{ + return 1; // NB: some hosts don't cope very well if you tell them there are + // 0 programs, so this should be at least 1, even if you're not + // really implementing programs. +} + +int XenosAudioProcessor::getCurrentProgram() { return 0; } + +void XenosAudioProcessor::setCurrentProgram(int index) {} + +const juce::String XenosAudioProcessor::getProgramName(int index) { return {}; } + +void XenosAudioProcessor::changeProgramName(int index, + const juce::String& newName) +{} + +//============================================================================== +void XenosAudioProcessor::prepareToPlay(double sampleRate, int samplesPerBlock) +{ + // Use this method as the place to do any pre-playback + // initialisation that you need.. + + xenosAudioSource.prepareToPlay(samplesPerBlock, sampleRate); +} + +void XenosAudioProcessor::releaseResources() +{ + // When playback stops, you can use this as an opportunity to free up any + // spare memory, etc. + + xenosAudioSource.releaseResources(); +} + +#ifndef JucePlugin_PreferredChannelConfigurations +bool XenosAudioProcessor::isBusesLayoutSupported( + const BusesLayout& layouts) const +{ +#if JucePlugin_IsMidiEffect + juce::ignoreUnused(layouts); + return true; +#else + // This is the place where you check if the layout is supported. + // In this template code we only support mono or stereo. + // Some plugin hosts, such as certain GarageBand versions, will only + // load plugins that support stereo bus layouts. + if (layouts.getMainOutputChannelSet() != juce::AudioChannelSet::mono() + && layouts.getMainOutputChannelSet() != juce::AudioChannelSet::stereo()) + return false; + + // This checks if the input layout matches the output layout +#if !JucePlugin_IsSynth + if (layouts.getMainOutputChannelSet() != layouts.getMainInputChannelSet()) + return false; +#endif + + return true; +#endif +} +#endif + +void XenosAudioProcessor::processBlock(juce::AudioBuffer& buffer, + juce::MidiBuffer& midiMessages) +{ + xenosAudioSource.setMidiBuffer(midiMessages); + juce::AudioSourceChannelInfo channelInfo(buffer); + xenosAudioSource.getNextAudioBlock(channelInfo); +} + +//============================================================================== +bool XenosAudioProcessor::hasEditor() const +{ + return true; // (change this to false if you choose to not supply an editor) +} + +juce::AudioProcessorEditor* XenosAudioProcessor::createEditor() +{ + return new XenosAudioProcessorEditor(*this, params); +} + +//============================================================================== +void XenosAudioProcessor::getStateInformation(juce::MemoryBlock& destData) +{ + // You should use this method to store your parameters in the memory block. + // You could do that either as raw data, or use the XML or ValueTree classes + // as intermediaries to make it easy to save and load complex data. + + auto state = params.copyState(); + + juce::XmlElement xmlParent("parent"); + + std::unique_ptr xmlParams(state.createXml()); + xmlParent.addChildElement(xmlParams.release()); + + juce::XmlElement* xmlScale = xmlParent.createNewChildElement( + "scaleParams"); // add custom scale data to xml tree + xmlScale->setAttribute(juce::Identifier(juce::String("CUSTOM_SCALE_DATA")), + customScaleData.joinIntoString("\n")); + xmlScale->setAttribute(juce::Identifier(juce::String("CUSTOM_SCALE_NAME")), + customScaleName); + + copyXmlToBinary(xmlParent, destData); +} + +void XenosAudioProcessor::setStateInformation(const void* data, int sizeInBytes) +{ + // You should use this method to restore your parameters from this memory + // block, whose contents will have been created by the getStateInformation() + // call. + + std::unique_ptr xmlState( + getXmlFromBinary(data, sizeInBytes)); + juce::XmlElement* xmlParams + = xmlState->getChildByName(params.state.getType()); + juce::XmlElement* xmlScale = xmlState->getChildByName("scaleParams"); + + if (xmlState.get() != nullptr) { + if (xmlParams->hasTagName(params.state.getType())) { + params.replaceState(juce::ValueTree::fromXml(*xmlParams)); + auto n = params.state.getNumChildren(); + for (int i = 0; i < n; ++i) { // recall stored parameters + auto child = params.state.getChild(i); + auto id = child["id"]; + auto value = child["value"]; + xenosAudioSource.setParam(id, value); + } + } + if (xmlScale->hasTagName(juce::StringRef("scaleParams"))) { + customScaleName = xmlScale->getStringAttribute( + juce::String("CUSTOM_SCALE_NAME"), "custom"); + juce::String scaleData = xmlScale->getStringAttribute( + juce::String("CUSTOM_SCALE_DATA"), ""); + customScaleData.clear(); + if (scaleData != "") customScaleData.addLines(scaleData); + xenosAudioSource.loadScl(customScaleData, + *scaleParam == customScaleParamIndex); + } + } +} + +//============================================================================== +// This creates new instances of the plugin.. +juce::AudioProcessor* JUCE_CALLTYPE createPluginFilter() +{ + return new XenosAudioProcessor(); +} diff --git a/Source/PluginProcessor.h b/Source/PluginProcessor.h new file mode 100644 index 0000000..93da3f9 --- /dev/null +++ b/Source/PluginProcessor.h @@ -0,0 +1,103 @@ +/* + ============================================================================== + + PluginProcessor.h + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#pragma once + +#include +#include "Xenos.h" + +#define SCALE_PRESETS (14) + +//============================================================================== +/** + */ +class XenosAudioProcessor : public juce::AudioProcessor { +public: + //============================================================================== + XenosAudioProcessor(); + ~XenosAudioProcessor() override; + + //============================================================================== + void prepareToPlay(double sampleRate, int samplesPerBlock) override; + void releaseResources() override; + +#ifndef JucePlugin_PreferredChannelConfigurations + bool isBusesLayoutSupported(const BusesLayout& layouts) const override; +#endif + + void processBlock(juce::AudioBuffer&, juce::MidiBuffer&) override; + + //============================================================================== + juce::AudioProcessorEditor* createEditor() override; + bool hasEditor() const override; + + //============================================================================== + const juce::String getName() const override; + + bool acceptsMidi() const override; + bool producesMidi() const override; + bool isMidiEffect() const override; + double getTailLengthSeconds() const override; + + //============================================================================== + int getNumPrograms() override; + int getCurrentProgram() override; + void setCurrentProgram(int index) override; + const juce::String getProgramName(int index) override; + void changeProgramName(int index, const juce::String& newName) override; + + //============================================================================== + void getStateInformation(juce::MemoryBlock& destData) override; + void setStateInformation(const void* data, int sizeInBytes) override; + + //============================================================================== + juce::MidiKeyboardState keyboardState; + + juce::String customScaleName; + juce::StringArray customScaleData; + + XenosSynthAudioSource xenosAudioSource; +private: + //============================================================================== + juce::AudioProcessorValueTreeState params; + + std::atomic* segmentsParam = nullptr; + + std::atomic* pitchWidthParam = nullptr; + std::atomic* pitchBarrierParam = nullptr; + std::atomic* pitchStepParam = nullptr; + std::atomic* ampGainParam = nullptr; + std::atomic* ampBarrierParam = nullptr; + std::atomic* ampStepParam = nullptr; + + std::atomic* pitchDistributionParam = nullptr; + std::atomic* pitchWalkParam = nullptr; + std::atomic* pitchAlphaParam = nullptr; + std::atomic* pitchBetaParam = nullptr; + + std::atomic* ampDistributionParam = nullptr; + std::atomic* ampWalkParam = nullptr; + std::atomic* ampAlphaParam = nullptr; + std::atomic* ampBetaParam = nullptr; + + std::atomic* attackParam = nullptr; + std::atomic* decayParam = nullptr; + std::atomic* sustainParam = nullptr; + std::atomic* releaseParam = nullptr; + + std::atomic* scaleParam = nullptr; + std::atomic* rootParam = nullptr; + + const int customScaleParamIndex = SCALE_PRESETS + 1; + + JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(XenosAudioProcessor) +}; diff --git a/Source/Quantizer.cpp b/Source/Quantizer.cpp new file mode 100644 index 0000000..97f27e0 --- /dev/null +++ b/Source/Quantizer.cpp @@ -0,0 +1,88 @@ +/* + ============================================================================== + + Quantizer.cpp + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#include "Quantizer.h" +#include "Utility.h" + +void Quantizer::loadScl(juce::StringArray s, bool load) +{ + const auto nPresets = scale.size() - 1; + scale[nPresets] = Scale(s); + if (load) setScale(nPresets); +} + +void Quantizer::calcSteps() +{ + steps.clear(); + double start = calcStart(); + while (start <= pitchRange[0]) { + for (int i = 0; i < scalePtr->size(); i++) { + double q = mtos(start) / scalePtr->getInterval(i); + steps.push_back(q); + } + start += rtoc(scalePtr->getRepeatRatio()) / 100.0; + } +} + +double Quantizer::calcStart() +{ // get the highest root transposition <= pitchRange[0] + double s = root; + double repeatPointMidi = rtoc(scalePtr->getRepeatRatio()) / 100.0; + while (s < pitchRange[1] - repeatPointMidi) s += repeatPointMidi; + return s; +} + +double Quantizer::operator()(double per) +{ + if (active) { + double min = 999999; + int step = 0; + for (int i = 0; i < steps.size(); i++) { + double mag = abs(steps[i] - per); + if (mag < min) { + min = mag; + step = i; + } + } + return steps[step]; + } else { + return per; + } +} + +double Quantizer::getFactor() { return factor; } + +void Quantizer::setActive(bool a) +{ + if (active != a) active = a; +} + +void Quantizer::setFactor(double sP) { factor = (*this)(sP) / sP; } + +void Quantizer::setRange(double hi, double lo) +{ + if (hi == lo) hi += 0.000001; // quantizer misbehaves with a range of 0 + pitchRange[0] = hi; + pitchRange[1] = lo; +} + +void Quantizer::setRoot(const double r) +{ + root = (r > 11.9999999) ? 0.0 : r; + calcSteps(); +} + +void Quantizer::setScale(const unsigned char n) +{ + scalePtr = &scale[n]; + calcSteps(); +} diff --git a/Source/Quantizer.h b/Source/Quantizer.h new file mode 100644 index 0000000..fafdb22 --- /dev/null +++ b/Source/Quantizer.h @@ -0,0 +1,72 @@ +/* + ============================================================================== + + Quantizer.h + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#pragma once + +#include "Scale.h" + +class Quantizer { +public: + void loadScl(juce::StringArray s, bool load); + void calcSteps(); + double calcStart(); + double operator()(double per); + + double getFactor(); + void setActive(bool a); + void setFactor(double sP); + void setRange(double hi, double lo); + void setRoot(const double r); + void setScale(const unsigned char n); +private: + double root = 0.0; + double pitchRange[2] = {48.5, 47.5}; + double factor = 1.0; + std::vector steps; + bool active = false; + std::array scale = { + Scale({1., 1.122462, 1.259921, 1.498307, 1.681793}, 2), // pentatonic + Scale({1., 1.125, 1.265625, 1.5, 1.6875}, + 2), // pentatonic (pythagorean) + Scale({1., 1.189207, 1.33484, 1.414214, 1.498307, 1.781797}, + 2), // blues + Scale({1., 1.166667, 1.333333, 1.4, 1.5, 1.75}, 2), // blues (7-limit) + Scale({1., 1.122462, 1.259921, 1.414214, 1.587401, 1.781797}, + 2), // whole-tone + Scale({1., 1.122462, 1.259921, 1.33484, 1.498307, 1.681793, 1.887749}, + 2), // major + Scale({1., 1.125, 1.25, 1.333333, 1.5, 1.666667, 1.875}, + 2), // major (5-limit) + Scale({1., 1.122462, 1.189207, 1.33484, 1.498307, 1.587401, 1.781797}, + 2), // minor + Scale({1., 1.125, 1.2, 1.333333, 1.5, 1.6, 1.777778}, + 2), // minor (5-limit) + Scale({1., 1.122462, 1.189207, 1.33484, 1.414214, 1.587401, 1.681793, + 1.887749}, + 2), // octatonic + Scale({1., 1.125, 1.25, 1.375, 1.5, 1.625, 1.75, 1.875}, 2), // overtone + Scale({1., 1.059463, 1.122462, 1.189207, 1.259921, 1.33484, 1.414214, + 1.498307, 1.587401, 1.681793, 1.781797, 1.887749}, + 2), // chromatic + Scale({1., 1.088182, 1.18414, 1.288561, 1.402189, 1.525837, 1.660388, + 1.806806, 1.966134, 2.139512, 2.328178, 2.533484, 2.756892}, + 3), // bohlen–pierce + Scale({1., 1.029302, 1.059463, 1.090508, 1.122462, 1.155353, + 1.189207, 1.224054, 1.259921, 1.29684, 1.33484, 1.373954, + 1.414214, 1.455653, 1.498307, 1.542211, 1.587401, 1.633915, + 1.681793, 1.731073, 1.781797, 1.834008, 1.887749, 1.943064}, + 2), // quarter-tone + Scale() // custom scale placeholder + }; + Scale* scalePtr = &scale[0]; + const unsigned long nPresets = scale.size(); +}; diff --git a/Source/RandomSource.cpp b/Source/RandomSource.cpp new file mode 100644 index 0000000..8b71408 --- /dev/null +++ b/Source/RandomSource.cpp @@ -0,0 +1,121 @@ +/* + ============================================================================== + + RandomSource.cpp + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#define _USE_MATH_DEFINES +#include +#include "RandomSource.h" + +double RandomSource::uniform(double a) { return uniformDist(generator) * a; } + +double RandomSource::normal(double a, double b) +{ + normalDist.param(std::normal_distribution::param_type(a, b)); + return normalDist(generator); +} + +double RandomSource::poisson(double a) +{ + if (a < 0.0) a *= -1; + poissonDist.param(std::poisson_distribution::param_type(a)); + return poissonDist(generator); +} + +double RandomSource::cauchy(double z, double a) +{ + return (a * tan((z - 0.5) * M_PI)); +} + +double RandomSource::logist(double z, double a, double b) +{ + if (a > -0.001 && a < 0.001) + a = 0.001 * ((a > 0.0) * 2 - 1); // prevent divide by 0 + return (-(log((1 - z) / z) + b) / a); +} + +double RandomSource::hyperbcos(double z, double a) +{ + return (a * log(tan(z * M_PI / 2.0))); +} + +double RandomSource::arcsine(double z, double a) +{ + return (a * (0.5 - 0.5 * sin((0.5 - z) * M_PI))); +} + +double RandomSource::exponential(double z, double a) +{ + if (a > -0.001 && a < 0.001) + a = 0.001 * ((a > 0.0) * 2 - 1); // prevent divide by 0 + return (-(log(1 - z)) / a); +} + +double RandomSource::triangle(double z, double a) +{ + return (a * (1 - sqrt(1 - z))); +} + +double RandomSource::sinus(double z, double a, double b) +{ + return (a * sin(z * (2 * M_PI) * b)); +} + +double RandomSource::operator()() +{ + double rand = uniformDist(generator); + int sign = (rand < 0.5) * 2 - 1; + double v; + switch (mode) { + case 0: + v = uniform(alpha); + v *= sign; + break; + case 1: + v = normal(alpha, beta); + v *= sign; + break; + case 2: + v = poisson(alpha); + v *= sign; + break; + case 3: + v = cauchy(rand, alpha); + break; + case 4: + v = logist(rand, alpha, beta); + v *= sign; + break; + case 5: + v = hyperbcos(rand, alpha); + break; + case 6: + v = arcsine(rand, alpha); + v *= sign; + break; + case 7: + v = exponential(rand, alpha); + v *= sign; + break; + case 8: + v = triangle(rand, alpha); + v *= sign; + break; + case 9: + v = sinus(rand, alpha, beta); + } + return v; +} + +void RandomSource::setMode(int m) { mode = m; } + +void RandomSource::setAlpha(double a) { alpha = a; } + +void RandomSource::setBeta(double b) { beta = b; } diff --git a/Source/RandomSource.h b/Source/RandomSource.h new file mode 100644 index 0000000..a526faa --- /dev/null +++ b/Source/RandomSource.h @@ -0,0 +1,42 @@ +/* + ============================================================================== + + RandomSource.h + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#pragma once + +#include + +class RandomSource { +public: + double uniform(double a = 1); + double normal(double a = 1, double b = 1); + double poisson(double a = 1); + double cauchy(double z, double a = 1); + double logist(double z, double a = 1, double b = 1); + double hyperbcos(double z, double a = 1); + double arcsine(double z, double a = 1); + double exponential(double z, double a = 1); + double triangle(double z, double a = 1); + double sinus(double z, double a = 1, double b = 1); + double operator()(); + + void setMode(int m); + void setAlpha(double a); + void setBeta(double b); +private: + std::random_device s; + std::default_random_engine generator{s()}; + std::uniform_real_distribution uniformDist{0.0, 1.0}; + std::normal_distribution normalDist{5, 2}; + std::poisson_distribution poissonDist{4.1}; + int mode = 0; + double alpha = 1, beta = 1; +}; diff --git a/Source/RandomWalk.cpp b/Source/RandomWalk.cpp new file mode 100644 index 0000000..4fdb7a3 --- /dev/null +++ b/Source/RandomWalk.cpp @@ -0,0 +1,154 @@ +/* + ============================================================================== + + RandomWalk.cpp + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#include +#include "RandomWalk.h" +#include "Utility.h" + +void RandomWalk::initialize(int n) +{ + pri.resize(n); + sec.resize(n); +} + +void RandomWalk::reset(int i, double v) +{ + pri[i] = 0.0; + sec[i] = v; +} + +void RandomWalk::setParams(double* pR, int nP) +{ + calcSecBarriers(pR, nP); + calcPriBarriers(); + calcPriStepSize(); +} + +void RandomWalk::setParams(double v) +{ + setSecBarriers(v); + calcPriBarriers(); + calcPriStepSize(); +} + +void RandomWalk::calcSecBarriers(double* pR, int nP) +{ + secBarrier[0] = pR[1] / nP; // lo samps/hi freq + secBarrier[1] = pR[0] / nP; // hi samps/lo freq +} + +void RandomWalk::setSecBarriers(double v) +{ + secBarrier[0] = v * -1; + secBarrier[1] = v; +} + +void RandomWalk::calcPriBarriers() +{ + double secWalkSize = secBarrier[1] - secBarrier[0]; + secStepSize = secWalkSize * stepRatio; + priBarrier = secWalkSize / 2 * barrierRatio; +} + +void RandomWalk::calcPriStepSize() +{ + double priWalkSize = priBarrier * 2; + priStepSize = priWalkSize * stepRatio; +} + +void RandomWalk::step(int n, double r) +{ + if (walk) { + // scale primary walk step + double rnd = r * priStepSize; + + // do primary walk + pri[n] += rnd; + pri[n] = reflect(pri[n], priBarrier * -1, priBarrier); + + // do secondary walk + sec[n] += pri[n]; + sec[n] = reflect(sec[n], secBarrier[0], secBarrier[1]); + } else { + double rnd = r * secStepSize; + + // do secondary walk, primary style + sec[n] += rnd; + sec[n] = reflect(sec[n], secBarrier[0], secBarrier[1]); + } + sumPeriod += sec[n]; +} + +double RandomWalk::reflect(double val, double min, double max) +{ + if (min == max) { + val = min; + } else { + double space = max - min; + double diff, ref; + bool dir; + if (val > max) { + diff = val - max; + dir = static_cast(diff / space) % 2; + ref = fmod(diff, space); + + val = (dir) ? min + ref : max - ref; + } + if (val < min) { + diff = min - val; + dir = static_cast(diff / space) % 2; + ref = fmod(diff, space); + + val = (dir) ? max - ref : min + ref; + } + } + return val; +} + +double RandomWalk::realLookup(std::vector& a, double x, int nP) +{ + int x1 = std::floor(x); + int x2 = x1 + 1; + if (x2 >= nP) x2 = 0; + double w = x - x1; + return (1 - w) * a[x1] + w * a[x2]; +} + +double RandomWalk::operator()(unsigned i, double f) { return sec[i] * f; } + +double RandomWalk::operator()(double idx, int nP) +{ + return realLookup(sec, idx, nP); +} + +double RandomWalk::getSumPeriod() +{ + double temp = sumPeriod; + sumPeriod = 0; + return temp; +} + +void RandomWalk::setBarrierRatio(double bR) +{ + barrierRatio = bR; + calcPriBarriers(); + calcPriStepSize(); +} + +void RandomWalk::setStepRatio(double sR) +{ + stepRatio = sR; + calcPriBarriers(); + calcPriStepSize(); +} + +void RandomWalk::setWalk(bool w) { walk = w; } diff --git a/Source/RandomWalk.h b/Source/RandomWalk.h new file mode 100644 index 0000000..0f4e16a --- /dev/null +++ b/Source/RandomWalk.h @@ -0,0 +1,44 @@ +/* + ============================================================================== + + RandomWalk.h + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#pragma once + +#include + +class RandomWalk { +public: + void initialize(int n); + void reset(int i, double v); + void setParams(double* pR, int nP); + void setParams(double v); + void calcSecBarriers(double* pR, int nP); + void setSecBarriers(double v); + void calcPriBarriers(); + void calcPriStepSize(); + void step(int n, double r); + double reflect(double val, double min, double max); + double realLookup(std::vector& a, double x, int nP); + double operator()(unsigned i, double f); + double operator()(double idx, int nP); + + double getSumPeriod(); + void setBarrierRatio(double bR); + void setStepRatio(double sR); + void setWalk(bool w); +private: + double secBarrier[2]; + double secStepSize, priBarrier, priStepSize, + sumPeriod = 0.0, barrierRatio = 0.1, stepRatio = 0.01; + int distribution; + bool walk = true; + std::vector pri, sec; +}; diff --git a/Source/Scale.cpp b/Source/Scale.cpp new file mode 100644 index 0000000..591d782 --- /dev/null +++ b/Source/Scale.cpp @@ -0,0 +1,76 @@ +/* + ============================================================================== + + Scale.cpp + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#include +#include "Scale.h" +#include "Utility.h" + +Scale::Scale() +{ + intervals.push_back(1); + repeatRatio = 2; +} + +Scale::Scale(std::vector _intervals, double _repeatPoint) +{ + for (int i = 0; i < _intervals.size(); i++) + intervals.push_back(_intervals[i]); + repeatRatio = _repeatPoint; +} + +Scale::Scale(juce::StringArray scalaLines) +{ + for (int i = 0; i < scalaLines.size(); i++) { + std::smatch match; + std::string str = scalaLines[i].toStdString(); + if (std::regex_search( + str, match, + std::regex("^\\s*\\d+((\\.\\d*)|(\\/\\d+))?(\\s*cents)?"))) + intervals.push_back(parseSclLine(str)); + } + intervals.erase(intervals.begin()); // remove cardinality + + if (intervals[0] == 1) { + repeatRatio = 2; + } else { + repeatRatio = intervals.back(); + intervals.pop_back(); + intervals.insert(intervals.begin(), 1); + } +} + +double Scale::parseSclLine(std::string str) +{ + std::smatch match; + double interval = 1; + if (std::regex_search(str, match, + std::regex("^\\s*(\\d+)\\/(\\d+)"))) { // ratio + interval = stod(match[1]) / stod(match[2]); + } else if (std::regex_search( + str, match, + std::regex("^\\s*(\\d+\\.\\d*)\\s*cents"))) { // cents + interval = ctor(stod(match[1])); + } else if (std::regex_search(str, match, + std::regex("^\\s*\\d+\\.\\d*"))) { // decimal + interval = ctor(stod(match[0])); + } else if (std::regex_search(str, match, + std::regex("^\\s*(\\d+)"))) { // integer + interval = stoi(match[1]); + } + return interval; +} + +unsigned long Scale::size() { return intervals.size(); } + +double Scale::getInterval(int i) { return intervals[i]; } + +double Scale::getRepeatRatio() { return repeatRatio; } diff --git a/Source/Scale.h b/Source/Scale.h new file mode 100644 index 0000000..353a8cf --- /dev/null +++ b/Source/Scale.h @@ -0,0 +1,30 @@ +/* + ============================================================================== + + Scale.h + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#pragma once + +#include + +class Scale { +public: + Scale(); + Scale(std::vector _intervals, double _repeatPoint); + Scale(juce::StringArray scalaLines); + + double parseSclLine(std::string str); + unsigned long size(); + double getInterval(int i); + double getRepeatRatio(); +private: + std::vector intervals; + double repeatRatio; +}; diff --git a/Source/Utility.cpp b/Source/Utility.cpp new file mode 100644 index 0000000..91ae4c2 --- /dev/null +++ b/Source/Utility.cpp @@ -0,0 +1,46 @@ +/* + ============================================================================== + + Utility.cpp + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#include +#include "Utility.h" + +double mtof(double n, double b) { return b * std::pow(2, (n - 69) / 12); } + +double ftom(double f, double b) { return 12 * std::log(f / b) / log(2) + 69; } + +double mtos(double m, double sr) +{ + double freq = mtof(m); + return sr / freq; +} + +double stom(double s, double sr) +{ + double freq = sr / s; + return ftom(freq); +} + +double rtoc(double t1, double t2) { return 1200 * std::log(t1 / t2) / log(2); } + +double ctor(double c) { return exp((c / 1200) * std::log(2)); } + +double scale(double v, double inL, double inH, double outL, double outH, + double c) +{ + if ((inL == inH) || (outL == outH)) { + return outL + (outH - outL) / 2; + } else { + double vNorm = (v - inL) / (inH - inL); + if (c != 1) vNorm = std::pow(vNorm, c); + return vNorm * (outH - outL) + outL; + } +} diff --git a/Source/Utility.h b/Source/Utility.h new file mode 100644 index 0000000..ae0886f --- /dev/null +++ b/Source/Utility.h @@ -0,0 +1,22 @@ +/* + ============================================================================== + + Utility.h + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#pragma once + +double mtof(double n, double b = 440); // midi to frequency +double ftom(double f, double b = 440); // frequency to midi +double mtos(double m, double sr = 44100); // midi to samples +double stom(double s, double sr = 44100); // samples to midi +double rtoc(double t1, double t2 = 1); // ratio to cents +double ctor(double c); // cents to ratio +double scale(double v, double inL, double inH, double outL, double outH, + double c = 1); diff --git a/Source/Xenos.h b/Source/Xenos.h new file mode 100644 index 0000000..8816654 --- /dev/null +++ b/Source/Xenos.h @@ -0,0 +1,343 @@ +/* + ============================================================================== + + Xenos.h + + Xenos: Xenharmonic Stochastic Synthesizer + Raphael Radna + This code is licensed under the GPLv3 + + ============================================================================== +*/ + +#pragma once + +#include +#include +#include "Quantizer.h" +#include "RandomWalk.h" +#include "RandomSource.h" +#include "Utility.h" + +#define MAX_POINTS (128) +#define NUM_VOICES (64) + +struct XenosCore { + void initialize(double sr) + { + sampleRate = sr; + pitchWalk.initialize(MAX_POINTS); + ampWalk.initialize(MAX_POINTS); + ampWalk.setParams(1.0); + reset(); + } + + void reset() + { + for (unsigned i = 0; i < MAX_POINTS; ++i) { + pitchWalk.reset(i, mtos(pitchCenter) / nPoints); + ampWalk.reset(i, uniform(generator)); + } + calcMetaParams(); + } + + void calcMetaParams() + { + calcPeriodRange(pitchCenter, pitchWidth); + pitchWalk.setParams(periodRange, nPoints); + quantizer.calcSteps(); + } + + void calcPeriodRange(double pC, double pW) + { + double min = pC - pW / 2; + double max = pC + pW / 2; + periodRange[0] = mtos(min); + periodRange[1] = mtos(max); + quantizer.setRange(max, min); + } + + double operator()() + { + if (index < 0.0) index = 0.0; + int intdex = floor(index); + double segmentSamps = pitchWalk(intdex, quantizer.getFactor()) * bend; + double increment = 1 / segmentSamps; + + if (intdex != _index) { + step(_index); + _index = intdex; + } + + index += increment; + + if (index >= nPoints) { + quantizer.setFactor(pitchWalk.getSumPeriod()); + index -= nPoints; + if (nPoints_ > 0) setNPoints(); + } + return ampWalk(index, nPoints); + } + + void step(int n) + { + pitchWalk.step(n, pitchSource()); + ampWalk.step(n, ampSource()); + } + + void setNPoints() + { + nPoints = nPoints_; + calcMetaParams(); + nPoints_ = 0; + } + + void setPitchCenter(float pC) + { + pitchCenter = pC; + calcMetaParams(); + } + + void setPitchWidth(float pW) + { + pitchWidth = pW; + calcMetaParams(); + } + + void setBend(double b, double r = 2.0) + { + if (b > 8191) { + bend = scale(b, 8192, 16383, 1.0, 1.0 / r); + } else { + bend = scale(b, 0, 8191, r, 1.0); + } + } + + double sampleRate = 44100.0; + float pitchCenter = 48.0f; // midi pitch + float pitchWidth = 1.0f; // semitones + double periodRange[2]; + double bend = 1.0; + int nPoints = 12; + int nPoints_ = 0; + double index = 0.0; + int _index = 0; + RandomWalk pitchWalk, ampWalk; + RandomSource pitchSource, ampSource; + Quantizer quantizer; + std::default_random_engine generator; + std::uniform_real_distribution uniform{-1.0, 1.0}; +}; + +//============================================================================== +struct XenosSound : public juce::SynthesiserSound { + XenosSound() {} + + bool appliesToNote(int) override { return true; } + bool appliesToChannel(int) override { return true; } +}; + +//============================================================================== +struct XenosVoice : public juce::SynthesiserVoice { + XenosVoice() {} + + bool canPlaySound(juce::SynthesiserSound* sound) override + { + return dynamic_cast(sound) != nullptr; + } + + void setCurrentPlaybackSampleRate(double newRate) override + { + if (newRate > 0.0) { + xenos.initialize(newRate); + adsr.setSampleRate(newRate); + updateADSR(); + } + } + + void updateADSR() + { + adsr.setParameters(juce::ADSR::Parameters(a, d, s, r)); + } + + void startNote(int note, float velocity, juce::SynthesiserSound*, + int /*currentPitchWheelPosition*/) override + { + xenos.pitchCenter = note; + adsr.noteOn(); + xenos.reset(); + } + + void stopNote(float /*velocity*/, bool allowTailOff) override + { + if (adsr.isActive()) adsr.noteOff(); + } + + void pitchWheelMoved(int newPitchWheelValue) override + { + xenos.setBend(newPitchWheelValue); + } + + void controllerMoved(int, int) override {} + + void renderNextBlock(juce::AudioSampleBuffer& outputBuffer, int startSample, + int numSamples) override + { + if (isVoiceActive()) { + while (--numSamples >= 0) { + auto currentSample + = xenos() * adsr.getNextSample() * polyGainFactor; + for (auto i = outputBuffer.getNumChannels(); --i >= 0;) + outputBuffer.addSample(i, startSample, currentSample); + ++startSample; + } + } else { + adsr.reset(); + clearCurrentNote(); + } + } + + XenosCore xenos; + juce::ADSR adsr; + float a = 0.1f, d = 0.1f, s = 1.0f, r = 0.1f; + const double polyGainFactor = 1 / sqrt(NUM_VOICES / 4); +}; + +//============================================================================== +class XenosSynthAudioSource : public juce::AudioSource { +public: + XenosSynthAudioSource(juce::MidiKeyboardState& keyState) + : keyboardState(keyState) + { + for (auto i = 0; i < NUM_VOICES; ++i) + xenosSynth.addVoice(new XenosVoice()); + + xenosSynth.addSound(new XenosSound()); + } + + void setUsingSineWaveSound() { xenosSynth.clearSounds(); } + + void prepareToPlay(int /*samplesPerBlockExpected*/, + double sampleRate) override + { + xenosSynth.setCurrentPlaybackSampleRate(sampleRate); + } + + void releaseResources() override {} + + void + getNextAudioBlock(const juce::AudioSourceChannelInfo& bufferToFill) override + { + bufferToFill.clearActiveBufferRegion(); + + keyboardState.processNextMidiBuffer(midiBuffer, + bufferToFill.startSample, + bufferToFill.numSamples, true); + + xenosSynth.renderNextBlock(*bufferToFill.buffer, midiBuffer, + bufferToFill.startSample, + bufferToFill.numSamples); + } + + void setParam(const juce::String& parameterID, float newValue) + { + for (int i = 0; i < xenosSynth.getNumVoices(); ++i) { + auto voice = dynamic_cast(xenosSynth.getVoice(i)); + XenosCore& xenos = voice->xenos; + + if (parameterID == "segments") { xenos.nPoints_ = newValue; } + if (parameterID == "pitchWidth") { + xenos.pitchWidth = newValue; + if (voice->isVoiceActive()) xenos.calcMetaParams(); + } + if (parameterID == "pitchBarrier") { + xenos.pitchWalk.setBarrierRatio(newValue); + } + if (parameterID == "pitchStep") { + xenos.pitchWalk.setStepRatio(newValue); + } + if (parameterID == "ampGain") { + auto linear = juce::Decibels::decibelsToGain(newValue, -96.0f); + xenos.ampWalk.setSecBarriers(linear); + xenos.ampWalk.calcPriBarriers(); + xenos.ampWalk.calcPriStepSize(); + } + if (parameterID == "ampBarrier") { + xenos.ampWalk.setBarrierRatio(newValue); + } + if (parameterID == "ampStep") { + xenos.ampWalk.setStepRatio(newValue); + } + + if (parameterID == "pitchDistribution") { + xenos.pitchSource.setMode(newValue); + } + if (parameterID == "pitchWalk") { + xenos.pitchWalk.setWalk(newValue); + } + if (parameterID == "pitchAlpha") { + xenos.pitchSource.setAlpha(newValue); + } + if (parameterID == "pitchBeta") { + xenos.pitchSource.setBeta(newValue); + } + + if (parameterID == "ampDistribution") { + xenos.ampSource.setMode(newValue); + } + if (parameterID == "ampWalk") { xenos.ampWalk.setWalk(newValue); } + if (parameterID == "ampAlpha") { + xenos.ampSource.setAlpha(newValue); + } + if (parameterID == "ampBeta") { xenos.ampSource.setBeta(newValue); } + + if (parameterID == "attack") { + voice->a = newValue; + voice->updateADSR(); + } + if (parameterID == "decay") { + voice->d = newValue; + voice->updateADSR(); + } + if (parameterID == "sustain") { + auto linear = juce::Decibels::decibelsToGain(newValue, -96.0f); + voice->s = linear; + voice->updateADSR(); + } + if (parameterID == "release") { + voice->r = newValue; + voice->updateADSR(); + } + + if (parameterID == "scale") { + if (newValue == 0) { + xenos.quantizer.setActive(0); + } else { + xenos.quantizer.setScale(newValue - 1); + xenos.quantizer.setActive(1); + } + } + if (parameterID == "root") { xenos.quantizer.setRoot(newValue); } + } + } + + void setMidiBuffer(juce::MidiBuffer& mB) { midiBuffer = mB; } + + bool loadScl(juce::StringArray& s, bool load) + { + bool result = false; + if (!s.isEmpty()) { + for (int i = 0; i < xenosSynth.getNumVoices(); ++i) { + auto voice = dynamic_cast(xenosSynth.getVoice(i)); + XenosCore& xenos = voice->xenos; + xenos.quantizer.loadScl(s, load); + } + result = true; + } + return result; + } +private: + juce::MidiKeyboardState& keyboardState; + juce::MidiBuffer midiBuffer; + juce::Synthesiser xenosSynth; +}; diff --git a/Xenos.jucer b/Xenos.jucer new file mode 100644 index 0000000..e7b7001 --- /dev/null +++ b/Xenos.jucer @@ -0,0 +1,99 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +