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 index 140d4f6..d9b9f57 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,14 @@ gamepad, and MIDI** (USB or Bluetooth). platform language ui + license

## Features at a glance - **Tracker tab** — 4-track pattern grid (note / velocity-hex / MIDI-channel per track), beat & bar coloring, tap-to-focus + drag-to-edit with haptics and - scale-aware note entry; plus an 8-lane arrangement piano-roll (up to 256 beats) + scale-aware note entry; plus an 8-lane arrangement piano-roll (up to 256 bars) with A/B loop regions. - **Mix tab** — 4 channels, each with an instrument + 4 FX slots, MIDI channel, volume, mute/solo. @@ -23,16 +24,21 @@ gamepad, and MIDI** (USB or Bluetooth). bitcrusher). Every device has an auto-generated editor and text presets. - **Setup tab** — `.sng` project save/load, color themes (with import/export), gamepad bindings, and searchable/collapsible MIDI bindings. +- **Master recording** — render the master bus (with FX tail) to a WAV file. - **Background playback** with a media notification (Play/Pause/Stop). - **Two-thread design** — Compose UI on the main thread, a sample-accurate sound engine on its own high-priority thread. +There is also a standalone `tools/samplepack-builder.html` — an offline page for +assembling Sampler preset bundles (drop audio onto 16 note-labelled pads, then +download an importable `.zip`). + ## Build & run -Open the project in **Android Studio** (2024.1+), let it create the Gradle -wrapper if prompted, and Run on an **API 26+** device or emulator. +Open the project in **Android Studio** (2024.1+) and Run on an **API 26+** +device or emulator. -CLI (after the wrapper exists — `gradle wrapper --gradle-version 8.9`): +From the CLI (the Gradle wrapper is committed, so a fresh clone needs no setup): ``` ./gradlew assembleDebug ``` @@ -57,4 +63,9 @@ compatibility shim is a listed TODO in the handover doc. ## License -TBD by the project owner. +Sizzletracker is free software: you can redistribute it and/or modify it under +the terms of the **GNU General Public License v3.0 or later** +(`GPL-3.0-or-later`). See the [`LICENSE`](LICENSE) file for the full text; every +source file carries an SPDX `GPL-3.0-or-later` header. + +Copyright © 2026 Reactorcoremeltdown diff --git a/app/src/main/cpp/native_audio.cpp b/app/src/main/cpp/native_audio.cpp index 8f7590e..b1cbf5d 100644 --- a/app/src/main/cpp/native_audio.cpp +++ b/app/src/main/cpp/native_audio.cpp @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + // Native Oboe (AAudio) output backend for Sizzletracker. // // Opens a low-latency mono float Oboe output stream. On each real-time data diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/MainActivity.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/MainActivity.kt index 604d485..92c20d3 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/MainActivity.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/MainActivity.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker import android.Manifest diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/SizzleApp.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/SizzleApp.kt index 79d2730..955ca76 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/SizzleApp.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/SizzleApp.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker import android.app.Application diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/AmbienceReverb.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/AmbienceReverb.kt index a8f6101..0cab1b9 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/AmbienceReverb.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/AmbienceReverb.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.audio import com.reactorcoremeltdown.sizzletracker.model.AmbiencePresets diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/AudioEngine.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/AudioEngine.kt index ffd599e..2ff7e13 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/AudioEngine.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/AudioEngine.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.audio import android.media.AudioAttributes diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/Effects.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/Effects.kt index 605710b..47fcd2b 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/Effects.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/Effects.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.audio import com.reactorcoremeltdown.sizzletracker.model.DelayDivisions diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/MasterRecorder.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/MasterRecorder.kt index a490c69..0e4ca3c 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/MasterRecorder.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/MasterRecorder.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.audio import java.io.File diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/NativeAudioBridge.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/NativeAudioBridge.kt index f38f918..6408a72 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/NativeAudioBridge.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/NativeAudioBridge.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.audio /** diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SampleRecorder.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SampleRecorder.kt index b5ff748..d029296 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SampleRecorder.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SampleRecorder.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.audio import android.annotation.SuppressLint diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SampleStore.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SampleStore.kt index b3a6c7c..3785f9c 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SampleStore.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SampleStore.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.audio import java.nio.ByteBuffer diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SampleVoice.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SampleVoice.kt index e4a1f0c..9056323 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SampleVoice.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SampleVoice.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.audio import kotlin.math.exp diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SoundFontLoader.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SoundFontLoader.kt index 46c900f..5233d75 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SoundFontLoader.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SoundFontLoader.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.audio import java.nio.ByteBuffer diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SynthVoice.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SynthVoice.kt index e1c328d..fe81908 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SynthVoice.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/SynthVoice.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.audio /** diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/Transport.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/Transport.kt index f4d5bf1..4b3d5d7 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/Transport.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/audio/Transport.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.audio /** diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/BindingStore.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/BindingStore.kt index d95eeaf..63e3aa9 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/BindingStore.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/BindingStore.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.input import android.content.Context diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/GamepadInput.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/GamepadInput.kt index bd30010..4de424c 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/GamepadInput.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/GamepadInput.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.input import android.view.InputDevice diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/InputAction.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/InputAction.kt index 6e05618..62b55ca 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/InputAction.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/InputAction.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.input /** diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/InputActions.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/InputActions.kt index befa5d7..792a443 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/InputActions.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/InputActions.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.input /** diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/InputRouter.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/InputRouter.kt index 7bf89db..e042b2a 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/InputRouter.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/InputRouter.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.input import kotlinx.coroutines.flow.MutableSharedFlow diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/KeyboardInput.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/KeyboardInput.kt index 342424a..ba6afb1 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/KeyboardInput.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/KeyboardInput.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.input import android.view.KeyEvent diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/MidiInput.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/MidiInput.kt index 7ac2adb..2a1048e 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/MidiInput.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/input/MidiInput.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.input import android.content.Context diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/PresetIo.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/PresetIo.kt index f369c5f..5b9d80c 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/PresetIo.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/PresetIo.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.io import com.reactorcoremeltdown.sizzletracker.model.ToolboxSlot diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/PresetLibrary.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/PresetLibrary.kt index 4b47b40..9b92175 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/PresetLibrary.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/PresetLibrary.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.io import com.reactorcoremeltdown.sizzletracker.audio.SampleStore diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ProjectIo.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ProjectIo.kt index a0cca96..6e4b3d9 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ProjectIo.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ProjectIo.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.io import com.reactorcoremeltdown.sizzletracker.model.Cell diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ProjectStore.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ProjectStore.kt index ae2871d..05b15bf 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ProjectStore.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ProjectStore.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.io import com.reactorcoremeltdown.sizzletracker.model.Project diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/SettingsStore.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/SettingsStore.kt index 1fb2126..2506c2d 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/SettingsStore.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/SettingsStore.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.io import android.content.Context diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/SngFormat.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/SngFormat.kt index 9b1e9de..ae25fdb 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/SngFormat.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/SngFormat.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.io import com.reactorcoremeltdown.sizzletracker.model.Arrangement diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/SongLibrary.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/SongLibrary.kt index 2f36f89..5e420fd 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/SongLibrary.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/SongLibrary.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.io import java.io.File diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ThemeIo.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ThemeIo.kt index 2a17062..67159a9 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ThemeIo.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ThemeIo.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.io import androidx.compose.ui.graphics.Color diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ThemeLibrary.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ThemeLibrary.kt index 3a7dd0e..bb5dc62 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ThemeLibrary.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/io/ThemeLibrary.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.io import com.reactorcoremeltdown.sizzletracker.ui.theme.RetroPalette diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/AmbiencePresets.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/AmbiencePresets.kt index 5d7ba45..5d0efac 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/AmbiencePresets.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/AmbiencePresets.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.model /** diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Arrangement.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Arrangement.kt index 195d582..0af2b4b 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Arrangement.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Arrangement.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.model /** diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Mixer.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Mixer.kt index a00aa6c..24944cb 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Mixer.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Mixer.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.model /** diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Music.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Music.kt index 03e4c50..c3455c6 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Music.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Music.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.model /** diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Pattern.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Pattern.kt index d10f1e9..bea1afe 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Pattern.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Pattern.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.model /** diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Project.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Project.kt index 1d4dc8a..3a5672c 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Project.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Project.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.model /** diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Toolbox.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Toolbox.kt index 00befb7..14af7ed 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Toolbox.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/model/Toolbox.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.model /** diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/playback/EnginePlayer.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/playback/EnginePlayer.kt index 05d257b..908c2d4 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/playback/EnginePlayer.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/playback/EnginePlayer.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.playback import android.os.Looper diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/playback/PlaybackService.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/playback/PlaybackService.kt index e8c1b89..eeefbf4 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/playback/PlaybackService.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/playback/PlaybackService.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.playback import android.content.Context diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/App.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/App.kt index 926b7b9..dfdaed8 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/App.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/App.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui import androidx.activity.compose.BackHandler diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/AppViewModel.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/AppViewModel.kt index cf89b85..db09550 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/AppViewModel.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/AppViewModel.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui import androidx.compose.runtime.getValue diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/Responsive.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/Responsive.kt index 190cd7c..d1b5f28 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/Responsive.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/Responsive.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui import android.content.res.Configuration diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/StackedKeyboard.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/StackedKeyboard.kt index 72afe8a..667b43c 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/StackedKeyboard.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/StackedKeyboard.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui import androidx.compose.foundation.background diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/components/GlyphCache.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/components/GlyphCache.kt index bb35e9f..ae8503f 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/components/GlyphCache.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/components/GlyphCache.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.components import androidx.compose.ui.text.TextLayoutResult diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/components/Piano.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/components/Piano.kt index 33cb8ff..7adca1e 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/components/Piano.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/components/Piano.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.components import androidx.compose.foundation.background diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/components/Widgets.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/components/Widgets.kt index 9d374c0..ce76e65 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/components/Widgets.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/components/Widgets.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.components import androidx.compose.foundation.background diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/mixer/MixerScreen.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/mixer/MixerScreen.kt index c3fa80a..e14b685 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/mixer/MixerScreen.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/mixer/MixerScreen.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.mixer import androidx.activity.compose.rememberLauncherForActivityResult diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/settings/SettingsScreen.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/settings/SettingsScreen.kt index 6149de1..70315e3 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/settings/SettingsScreen.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/settings/SettingsScreen.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.settings import android.content.Context diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/theme/Theme.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/theme/Theme.kt index 9a9c973..326bb2f 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/theme/Theme.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/theme/Theme.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.theme import android.app.Activity diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/DelayEditor.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/DelayEditor.kt index b5c4cf2..a250548 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/DelayEditor.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/DelayEditor.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.toolbox import androidx.compose.foundation.Canvas diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/LfoEditor.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/LfoEditor.kt index 55d8bf9..c831a00 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/LfoEditor.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/LfoEditor.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.toolbox import androidx.compose.foundation.layout.Arrangement diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/ParamControl.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/ParamControl.kt index 43f239e..a9f2810 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/ParamControl.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/ParamControl.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.toolbox import androidx.compose.foundation.layout.Column diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/SamplerEditor.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/SamplerEditor.kt index 8f9a4fc..54eb5d8 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/SamplerEditor.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/SamplerEditor.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.toolbox import androidx.activity.compose.rememberLauncherForActivityResult diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/SoundFontEditor.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/SoundFontEditor.kt index 1c22fdd..dadf5a9 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/SoundFontEditor.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/SoundFontEditor.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.toolbox import androidx.activity.compose.rememberLauncherForActivityResult diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/ToolboxScreen.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/ToolboxScreen.kt index b28b51d..3bef659 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/ToolboxScreen.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/toolbox/ToolboxScreen.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.toolbox import android.content.Intent diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/tracker/ArrangementRoll.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/tracker/ArrangementRoll.kt index eec89e4..029a639 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/tracker/ArrangementRoll.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/tracker/ArrangementRoll.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.tracker import androidx.compose.foundation.Canvas diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/tracker/PatternGrid.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/tracker/PatternGrid.kt index 0f68cc5..1916bd8 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/tracker/PatternGrid.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/tracker/PatternGrid.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.tracker import androidx.compose.foundation.Canvas diff --git a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/tracker/TrackerScreen.kt b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/tracker/TrackerScreen.kt index 28324e8..d1b52c8 100644 --- a/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/tracker/TrackerScreen.kt +++ b/app/src/main/java/com/reactorcoremeltdown/sizzletracker/ui/tracker/TrackerScreen.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.ui.tracker import androidx.compose.foundation.background diff --git a/app/src/test/java/com/reactorcoremeltdown/sizzletracker/io/SngFormatTest.kt b/app/src/test/java/com/reactorcoremeltdown/sizzletracker/io/SngFormatTest.kt index 273fa6b..4811516 100644 --- a/app/src/test/java/com/reactorcoremeltdown/sizzletracker/io/SngFormatTest.kt +++ b/app/src/test/java/com/reactorcoremeltdown/sizzletracker/io/SngFormatTest.kt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Reactorcoremeltdown +// SPDX-License-Identifier: GPL-3.0-or-later + package com.reactorcoremeltdown.sizzletracker.io import com.reactorcoremeltdown.sizzletracker.model.Arrangement @@ -28,7 +31,7 @@ class SngFormatTest { @Test fun parsesReferenceExample() { - val p = SngFormat.import(reference) + val p = SngFormat.importInto(Project(), reference) assertEquals(120f, p.tempoBpm, 0.001f) assertEquals(TimeSignature.FOUR_FOUR, p.timeSignature) @@ -64,7 +67,7 @@ class SngFormatTest { p.arrangement.set(0, 0, 0) p.arrangement.set(0, 1, 0) - val restored = SngFormat.import(SngFormat.export(p)) + val restored = SngFormat.importInto(Project(), SngFormat.export(p)) assertEquals(140f, restored.tempoBpm, 0.001f) assertEquals(TimeSignature.FIVE_FOUR, restored.timeSignature) diff --git a/docs/DEVELOPER_HANDOVER.md b/docs/DEVELOPER_HANDOVER.md index d7a739a..cb8f32d 100644 --- a/docs/DEVELOPER_HANDOVER.md +++ b/docs/DEVELOPER_HANDOVER.md @@ -30,15 +30,14 @@ Requirements: **Android Studio** (Koala / 2024.1 or newer) which bundles a JDK 17 and the Android SDK. 1. Open the project root in Android Studio. It will detect the Gradle build. -2. If prompted, let it **create the Gradle wrapper** (or run - `gradle wrapper --gradle-version 8.9` from a shell that has Gradle). -3. Let it download the SDK for `compileSdk 34`. -4. Pick a device/emulator running **Android 8.0 (API 26)** or newer and press +2. Let it download the SDK for `compileSdk 34`. +3. Pick a device/emulator running **Android 8.0 (API 26)** or newer and press **Run**. -> The command line here (`./gradlew assembleDebug`) needs the wrapper JAR, which -> is generated by step 2. The wrapper JAR is intentionally not committed as a -> binary; generating it is a one-time step. +> The Gradle wrapper (`gradle/wrapper/gradle-wrapper.jar`) **is committed** +> (Gradle's recommended practice), so `./gradlew assembleDebug` works on a fresh +> clone with no extra setup. A `staging` build type (`./gradlew assembleStaging`) +> gives release-like performance while still using the debug signing key. Key versions live in **one file**: `gradle/libs.versions.toml` (the "version catalog"). Change a number there and the whole project follows. @@ -58,7 +57,7 @@ catalog"). Change a number there and the whole project follows. Project (the song) ▲ reads on audio thread │ - AudioEngine ─────────┘ ──▶ AudioTrack ──▶ speakers + AudioEngine ─────────┘ ──▶ Oboe / AudioTrack ──▶ speakers (own thread) ``` @@ -92,14 +91,17 @@ com.reactorcoremeltdown.sizzletracker ├── model/ Pure data, no Android imports (unit-test friendly) │ ├── Music.kt Pitch, TimeSignature, Scale (incl. scale-step logic) │ ├── Pattern.kt Cell, CellColumn, Pattern (4 tracks x N lines) -│ ├── Arrangement.kt Arrangement (8 lanes x 256 beats), LoopRegion A/B -│ ├── Mixer.kt Mixer, MixerChannel (4 channels) -│ ├── Toolbox.kt ToolboxType (all instruments+effects), ParamSpec, ToolboxSlot +│ ├── Arrangement.kt Arrangement (8 lanes; canvas denominated in bars, up to 256), LoopRegion A/B +│ ├── Mixer.kt Mixer, MixerChannel (4 channels; volume/mute/solo/limiter) +│ ├── Toolbox.kt ToolboxType (all instruments+effects), ParamSpec, ToolboxSlot, SamplerPads +│ ├── AmbiencePresets.kt Factory reverb spaces seeded into the preset library │ └── Project.kt The whole song │ ├── input/ The unified input layer │ ├── InputAction.kt The neutral action vocabulary -│ ├── InputRouter.kt Flow-based message bus +│ ├── InputActions.kt Bindable-action catalogue (for the rebind/learn UI) +│ ├── InputRouter.kt Flow-based message bus (+ learn mode) +│ ├── BindingStore.kt Persists gamepad/MIDI bindings │ ├── KeyboardInput.kt KeyEvent -> InputAction (+ a 2-octave typing piano) │ ├── GamepadInput.kt KeyEvent/MotionEvent -> InputAction (rebindable) │ └── MidiInput.kt MIDI bytes -> InputAction (USB & Bluetooth via MidiManager) @@ -107,23 +109,43 @@ com.reactorcoremeltdown.sizzletracker ├── audio/ The real-time sound engine (own thread) │ ├── Transport.kt TransportState snapshot published to the UI │ ├── SynthVoice.kt One NES-style voice: pulse/triangle/noise + ADSR -│ └── AudioEngine.kt AudioTrack + sample-accurate sequencer + voice mixing +│ ├── SampleVoice.kt Pitched + sliced playback of a decoded sample +│ ├── SampleStore.kt Process-wide decoded-PCM cache + WAV encode/decode +│ ├── SampleRecorder.kt Ad-hoc mic/USB capture into a sample +│ ├── SoundFontLoader.kt Extract PCM from an .sf2 / .xi into the SampleStore +│ ├── Effects.kt Insert DSP: TapeDelay, Filter, Bitcrusher, GraphicEq (+ AudioEffect API) +│ ├── AmbienceReverb.kt FDN reverb processor +│ ├── MasterRecorder.kt Renders the master bus (with FX tail) to a WAV +│ ├── NativeAudioBridge.kt JNI bridge to the Oboe callback (calls fillBlock) +│ └── AudioEngine.kt Oboe/AudioTrack + sample-accurate sequencer + voice/FX mixing +│ +├── cpp/native_audio.cpp Low-latency Oboe stream; RT callback pulls audio via JNI │ ├── io/ Human-readable text persistence │ ├── PresetIo.kt Instrument/effect preset <-> KEY=VALUE text -│ └── ProjectIo.kt Whole song <-> .sng text +│ ├── PresetLibrary.kt On-disk preset library (+ .zip sample bundles) +│ ├── ProjectIo.kt Whole song <-> internal .sng text (full fidelity) +│ ├── ProjectStore.kt Autosave / load of the current project +│ ├── SongLibrary.kt Named project save/load browser backing +│ ├── SngFormat.kt Desktop-compatible .sng interchange read/write +│ ├── SettingsStore.kt App settings (theme, recording dir, keyboard) via DataStore +│ ├── ThemeIo.kt RetroPalette <-> .szt text +│ └── ThemeLibrary.kt On-disk theme library (import/export/delete) │ ├── playback/ -│ └── PlaybackService.kt Foreground service: background playback + media notification +│ ├── EnginePlayer.kt SimpleBasePlayer wrapping the engine for MediaSession +│ └── PlaybackService.kt MediaSessionService: background playback + media notification │ └── ui/ ├── AppViewModel.kt Screen state + THE single InputAction handler ├── App.kt Tab shell + ├── Responsive.kt Portrait/landscape layout helpers (nav rail, two-column) + ├── StackedKeyboard.kt On-screen audition / punch-in piano ├── theme/Theme.kt RetroPalette + monospace typography + SizzleTheme - ├── components/Widgets.kt RetroButton, RetroDropdown, SectionLabel, PixelGlyph + ├── components/ Widgets (RetroButton/Dropdown…), GlyphCache, Piano ├── tracker/ TrackerScreen, PatternGrid, ArrangementRoll ├── mixer/MixerScreen.kt - ├── toolbox/ ToolboxScreen, ParamControl + ├── toolbox/ ToolboxScreen, ParamControl, Sampler/SoundFont/Delay/Lfo editors └── settings/SettingsScreen.kt ``` @@ -185,10 +207,18 @@ are both **generated** from that list. See §6 to add a new device. ### Add a new instrument or effect 1. Add an entry to `ToolboxType` (`model/Toolbox.kt`) with its `ParamSpec` list. -2. Teach `AudioEngine` how to render/process it (today only `NES_SYNTH` is - rendered; see `synthParamsForTrack`). Add a branch there. -That's it — the Toolbox picker, parameter editor, and preset save/load all work -automatically. +2. Teach the engine how to sound it: + - **Instrument**: handle its type where the engine picks a voice per channel + (see how `NES_SYNTH`, `SAMPLER`, and `SOUNDFONT` are dispatched in + `AudioEngine`). + - **Signal effect**: add a processor in `audio/Effects.kt` implementing + `AudioEffect` and register it in `AudioEffect.create(...)`; the per-channel + insert chain picks it up automatically. + - **MIDI effect** (arp/transpose/LFO-style): hook into the sequencer instead + of the signal path (see `advanceArps` / `applyLfos` in `AudioEngine`). +The Toolbox picker, parameter editor, and preset save/load all work automatically +from the `ParamSpec` list. A device with many parameters can ship a bespoke +editor (see `ui/toolbox/DelayEditor.kt`, `SamplerEditor.kt`). ### Add a new input gesture/control 1. Add a case to `InputAction`. @@ -249,8 +279,9 @@ Line-oriented, sectioned (`[PATTERN ...]`, `[ARRANGEMENT ...]`, `[MIXER]`, ## 9. Current status — implemented vs. TODO This is an honest map so you know where the edges are. The **architecture and -all four tabs are in place and interactive**; several deep features are scaffolded -with a clear seam to finish them. +all four tabs are in place and interactive**, and the feature set below is +implemented and working; the short "Remaining / optional" list at the end is +polish and interchange niceties, not functional gaps. ### Implemented and working - Full 4-tab UI, retro monospace theme (+ theme switching), tab navigation. @@ -307,12 +338,13 @@ with a clear seam to finish them. (`version`/`bpm`/`sig`, `block`…`endblock` with `roll`/`track`/steps) — covered by passing JVM unit tests in `app/src/test`. - Background playback foreground service with Play/Pause/Stop notification. -- **Oboe / AAudio native output** ✓ (opt-in): `src/main/cpp/native_audio.cpp` +- **Oboe / AAudio native output** ✓ (default): `src/main/cpp/native_audio.cpp` opens a low-latency Oboe stream whose real-time callback pulls audio via JNI (`audio/NativeAudioBridge.kt`) from the SAME `AudioEngine.fillBlock` the AudioTrack loop uses — so both backends produce identical sound, only the - delivery path differs. Toggle it in Settings → Audio Devices ("Low-latency - engine (Oboe)"); it falls back to AudioTrack if the native lib is absent. + delivery path differs. Oboe is the default engine; it falls back to the + AudioTrack loop only if it fails to initialise (or the native lib is absent), + surfacing a popup with the reason (there is no user toggle). Built via **NDK r27** (`ndkVersion` in `app/build.gradle.kts`) + CMake + the `com.google.oboe:oboe:1.10.0` prefab AAR. All packaged `.so` files are **16 KB page-aligned** (Android 15 / Google Play requirement): NDK r27 aligns ELF load @@ -320,17 +352,34 @@ with a clear seam to finish them. lib is aligned, our `CMakeLists.txt` also passes `-Wl,-z,max-page-size=16384`, and AGP stores each `.so` at a 16 KB-aligned offset in the APK. (Verify with `llvm-readelf -l .so` → LOAD `Align 0x4000`.) +- **SF2 / XI loader instrument** ✓: `audio/SoundFontLoader.kt` extracts PCM from + an `.sf2` / `.xi` into the `SampleStore`, played back through the same + `SampleVoice` path as the Sampler; edited via `ui/toolbox/SoundFontEditor.kt` + (root note, volume, ADSR). +- **Master recording** ✓: `audio/MasterRecorder.kt` renders the stereo master bus + (plus a configurable FX tail) to a WAV in a user-chosen folder (SAF). +- **Stereo output & recording** ✓: `fillBlock` renders interleaved stereo and the + recorder captures two channels (voices/inserts are mono, so both channels carry + the same sum). +- **Responsive landscape layout** ✓ (`ui/Responsive.kt`): nav rail, side-by-side + screens, two-column mixer/editors, wider on-screen keyboards for tablets/handhelds. +- **Arrangement niceties** ✓: 256-bar canvas with viewport-culled drawing, + per-lane mutes, and centre-follow scrolling. +- **Per-bus soft-clip limiter** ✓, sampler QoL (fire-on-tap, clear, normalize), + theme import/export, and preset `.zip` bundle import/export. +- **Sample-pack builder** ✓: `tools/samplepack-builder.html`, a standalone offline + page that assembles importable Sampler `.zip` bundles. -### Scaffolded — remaining -1. **SF2 / XI loader instrument.** The Sampler (WAV) is done; the SoundFont/XI - loader still falls back to the synth. Parse `.sf2`/`.xi`, feed the extracted - PCM through the existing `SampleStore`/`SampleVoice` path. (This was not in the - original milestone list; noted for completeness.) +### Remaining / optional -All spec milestones are implemented. Next steps are polish/hardening: routing the -Oboe backend through the chosen output device (Oboe `setDeviceId`), a full C++ -port of the synth/mixer to remove JVM/GC from the native audio callback, and the -SF2/XI loader above. +- **Byte-exact desktop `.sng` compatibility.** `io/SngFormat.kt` reads/writes the + reference line format and round-trips musically; a field-for-field byte match + with the CLI project layout is the remaining interchange nicety. +- **Full C++ audio port.** The DSP currently runs in Kotlin behind the Oboe + callback (via JNI). Porting the hot path to C++ would remove JVM/GC from the + real-time thread — a performance hardening step, not a functional gap. +- **Route the Oboe backend through the chosen output device** (Oboe + `setDeviceId`), matching the AudioTrack path's device selection. --- diff --git a/tools/samplepack-builder.html b/tools/samplepack-builder.html index ad8e316..6f34d3f 100644 --- a/tools/samplepack-builder.html +++ b/tools/samplepack-builder.html @@ -1,4 +1,6 @@ + +