From 098a5f3303c0da1279d872b4327ef89a496546ca Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Thu, 30 Apr 2026 09:25:23 -0700 Subject: [PATCH 01/21] release: harden upload pipeline (TAG/VER split, --fail-with-body, GITHUB_TOKEN, contents:write) Aligns with the chip-plugin repos: - Use TAG (with v prefix) for gh release create, VER (stripped) for Changelist lookup and upload.php's version field. - curl --fail-with-body so server-side errors fail the workflow instead of passing silently. - Switch GH_TOKEN to the auto-provided GITHUB_TOKEN with explicit contents:write permission, dropping the dependency on a per-repo ACCESS_TOKEN PAT. --- .github/workflows/release.yaml | 4 +++- release.sh | 9 ++++++--- tag.sh | 4 ++-- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 491a0ef..42df63a 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -67,6 +67,8 @@ jobs: needs: build runs-on: ubuntu-latest timeout-minutes: 30 + permissions: + contents: write steps: - uses: actions/checkout@v4 - name: Download Artifacts @@ -75,5 +77,5 @@ jobs: run: ./release.sh shell: bash env: - GH_TOKEN: ${{ secrets.ACCESS_TOKEN }} + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} APIKEY: ${{ secrets.APIKEY }} diff --git a/release.sh b/release.sh index 50fefed..f39f24a 100755 --- a/release.sh +++ b/release.sh @@ -4,7 +4,10 @@ set -x cd "$(dirname "$0")" ROOT=$(pwd) -VER="$GITHUB_REF_NAME" +TAG="$GITHUB_REF_NAME" +# Tags are pushed with a leading "v" (see tag.sh); strip for the changelog +# lookup and the upload.php version field, but use TAG for gh release create. +VER="${TAG#v}" # Extract the changelog section for the current version # Matches version with optional colon, captures until the next version line or EOF @@ -32,13 +35,13 @@ if [ -f "./Binaries macOS/Symbols_Mac.zip" ]; then ASSETS+=("./Binaries macOS/Symbols_Mac.zip") fi -gh release create "$VER" --title "$VER" -F /tmp/release_notes.txt "${ASSETS[@]}" +gh release create "$TAG" --title "$TAG" -F /tmp/release_notes.txt "${ASSETS[@]}" PLUGIN=wavetable for f in "./Binaries Linux"/*.deb \ "./Binaries Windows"/*.exe \ "./Binaries macOS"/*.pkg; do - curl -sS -F "files=@${f}" \ + curl -sS --fail-with-body -F "files=@${f}" \ -F "plugin=${PLUGIN}" \ -F "version=${VER}" \ -F "changelog=${NOTES}" \ diff --git a/tag.sh b/tag.sh index eb1bdb5..b903424 100755 --- a/tag.sh +++ b/tag.sh @@ -13,5 +13,5 @@ if ! grep -q "^${VER}:*$" Changelist.txt; then exit 1 fi -echo "Tagging [$VER]" -git tag "$VER" && git push origin "$VER" +echo "Tagging [v$VER]" +git tag "v$VER" && git push origin "v$VER" From d8df411f1ef787fce0d440b4e36175a828b58f4e Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Thu, 30 Apr 2026 13:50:12 -0700 Subject: [PATCH 02/21] =?UTF-8?q?Replace=20reFX=20EULA=20with=20AGPL-3.0?= =?UTF-8?q?=20=E2=80=94=20these=20plugins=20are=20open=20source?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Installer/EULA.rtf | 795 +++++++++++++++++++++++++++++++++++++-------- Installer/eula.md | 707 ++++++++++++++++++++++++++++++++++++---- 2 files changed, 1317 insertions(+), 185 deletions(-) diff --git a/Installer/EULA.rtf b/Installer/EULA.rtf index 7eb667d..bfb3f36 100644 --- a/Installer/EULA.rtf +++ b/Installer/EULA.rtf @@ -1,127 +1,668 @@ -{\rtf1\ansi\ansicpg1252\deff0\nouicompat\deflang4105\deflangfe4105{\fonttbl{\f0\fswiss\fprq2\fcharset0 Calibri Light;}} -{\colortbl ;\red82\green82\blue82;\red0\green0\blue0;} -{\*\listtable -{\list\listhybrid -{\listlevel\levelnfc0\leveljc0\levelstartat1{\leveltext\'02\'00.;}{\levelnumbers\'01;}\jclisttab\tx720} -{\listlevel\levelnfc4\leveljc0\levelstartat1{\leveltext\'02\'01.;}{\levelnumbers\'01;}\jclisttab\tx720}\listid1 }} -{\*\listoverridetable{\listoverride\listid1\listoverridecount0\ls1}} -{\*\generator Riched20 10.0.18362}{\*\mmathPr\mnaryLim0\mdispDef1\mwrapIndent1440 }\viewkind4\uc1 -\pard\widctlpar\expndtw-10\kerning28\f0\fs56 End-User Licence Agreement\par - -\pard\widctlpar\sa720\qj\cf1\expndtw0\kerning0\fs21\line READ THE FOLLOWING LICENCE AGREEMENT CAREFULLY! IT CONTAINS VERY IMPORTANT INFORMATION ABOUT YOUR RIGHTS AND OBLIGATIONS, AS WELL AS LIMITATIONS AND EXCLUSIONS THAT MAY APPLY TO YOU. THIS DOCUMENT CONTAINS A DISPUTE RESOLUTION CLAUSE. BY CLICKING ON THE "ACCEPT" BUTTON, YOU ARE CONSENTING TO BE BOUND BY AND ARE BECOMING A PARTY TO THIS AGREEMENT. IF YOU DO NOT AGREE TO ALL OF THE TERMS OF THIS AGREEMENT, CLICK THE "DO NOT ACCEPT" BUTTON OR LEAVE THE WEBSITE.\par - -\pard\widctlpar\sa120\qj\cf2\b\fs33 1. Definitions\par - -\pard -{\pntext\f0 1.\tab}{\*\pn\pnlvlbody\pnf0\pnindent720\pnstart1\pndec{\pntxta.}} -\widctlpar\fi-360\li360\qj\cf1\b0\fs21 "We", "Our" and "Us" means SocaLabs.\par -{\pntext\f0 2.\tab}"You" and "Your" means the person or entity who is being licenced to use the Licenced Software.\par -{\pntext\f0 3.\tab}"Agreement" means this Software Licence Agreement between Us and You;\par -{\pntext\f0 4.\tab}"Licenced Materials" means the Licenced Software and the Licenced Library;\par -{\pntext\f0 5.\tab}"Licenced Software" means certain commercial software products being provided to You under this Agreement, including executable program modules thereof, as well as related documentation, and computer readable media;\par -{\pntext\f0 6.\tab}"Sub-Licenced Software" means certain third party owned software components being provided under this Agreement that are required to properly enable or operate the Licenced Software; and\par -{\pntext\f0 7.\tab}"Licenced Library" means any audio waveforms, such as melodies, music, instrument recordings, or other audible information, provided by Us for use with the Licenced Software.\par - -\pard\widctlpar\li360\qj\par -\par - -\pard\widctlpar\sa120\qj\cf2\b\fs33 2. Software Licence, Rights and Restrictions\par - -\pard -{\listtext\f0 1.\tab}\jclisttab\tx720\ls1\widctlpar\fi-360\li360\qj\cf1\b0\fs21 Subject to the provisions contained in this Agreement, We hereby grant to You a personal, revocable, non-exclusive licence (the "Licence") to access, read, use and download one copy of the Licenced Materials solely for the purposes provided under paragraph 3. This is not a transfer of title.\par -{\listtext\f0 2.\tab}Under the Licence you may not and shall not, without Our express written authorization:\par - -\pard -{\listtext\f0 a.\tab}\jclisttab\tx720\ls1\ilvl1\widctlpar\fi-360\li1080\qj own title, or transfer title to the Licenced Materials to another party;\par -{\listtext\f0 b.\tab}transfer the Licence;\par -{\listtext\f0 c.\tab}remove any copyright or other proprietary notations from the Licenced Materials;\par -{\listtext\f0 d.\tab}distribute, or sublicense or otherwise provide copies of or access to the Licenced Materials to any third party;\par -{\listtext\f0 e.\tab}pledge, hypothecate, alienate or otherwise encumber the Licenced Materials to any third party;\par -{\listtext\f0 f.\tab}create derivative works of, reverse engineer, decompile, disassemble, adapt, translate, transmit, arrange, modify, copy, bundle, sell, sublicense, export, merge, transfer, adapt, loan, rent, lease, assign, share, outsource, host, publish, make available to any person or otherwise use, either directly or indirectly, the Licenced Materials;\par -{\listtext\f0 g.\tab}permit, allow or do anything that would infringe or otherwise prejudice the proprietary rights of Us or Our licensors;\par -{\listtext\f0 h.\tab}circumvent, remove, alter or otherwise impair any technological protection measures, digital rights management information, or other copy-protection mechanisms used in or by the Licenced Materials; or\par -{\listtext\f0 i.\tab}include, use, re-sample, mix, process, isolate or embed any content from the Licenced Library in any virtual instrument, audio sampling system, audio playback system or library of any kind, other than those provided or authorized by Us.\par - -\pard -{\listtext\f0 3.\tab}\jclisttab\tx720\ls1\widctlpar\fi-360\li360\qj We are not obligated to provide any authorization referred to in paragraph 2(2), We reserve the right to charge a fee for the grant of such authorization, and We may cancel such authorization at Our sole and unfettered discretion by providing notice to You of such cancellation.\par -{\listtext\f0 4.\tab}The restrictions set out in this Agreement, including the restrictions listed at paragraph 2(2), shall not apply to the limited extent the restrictions are prohibited by applicable law.\par -{\listtext\f0 5.\tab}We will have the right to inspect and enforce the restrictions and covenants contained in this Agreement at Your sole expense, and You hereby agree to promptly notify Us of any known violations of such restrictions.\par -{\listtext\f0 6.\tab}You agree to protect the Licenced Materials from unauthorized use, reproduction, distribution or publication in electronic or physical form.\par -{\listtext\f0 7.\tab}Upon execution of this Agreement, We will:\par - -\pard -{\listtext\f0 a.\tab}\jclisttab\tx720\ls1\ilvl1\widctlpar\fi-360\li1080\qj permit You to download a copy of the Licenced Materials for Your use under this Agreement; and\par -{\listtext\f0 b.\tab}permit You to download updates to the Licenced Software as We consider needed. We are not obligated to provide updates for the Licenced Software.\par - -\pard\widctlpar\li1080\qj\par -\par - -\pard\widctlpar\sa120\qj\cf2\b\fs33 3. Usage Conditions\par - -\pard -{\pntext\f0 1.\tab}{\*\pn\pnlvlbody\pnf0\pnindent720\pnstart1\pndec{\pntxta.}} -\widctlpar\fi-360\li360\qj\cf1\b0\fs21 You are authorized to use the Licenced Materials only for personal use. Your personal use may be commercial.\par -{\pntext\f0 2.\tab}You may not rent out to others equipment on which the Licenced Software is installed or by which the Licenced Library is accessible without obtaining a written rental licence from Us that expressly authorizes such use. We reserve the right to charge a fee for a rental licence.\par -{\pntext\f0 3.\tab}You may install the Licenced Software on as many devices as required for Your personal use provided such devices are used only by You.\par - -\pard\widctlpar\qj\par - -\pard\widctlpar\li360\qj\par - -\pard\widctlpar\sa120\qj\cf2\b\fs33 4. Ownership and Intellectual Property Rights\par - -\pard -{\pntext\f0 1.\tab}{\*\pn\pnlvlbody\pnf0\pnindent720\pnstart1\pndec{\pntxta.}} -\widctlpar\fi-360\li360\qj\cf1\b0\fs21 All copyright in the Licenced Software, including any documentation, media, packaging and illustrations, but excluding the Sublicensed Software, is owned by Us. You do not acquire title to any copyright in the Licenced Materials or Sublicensed Software under this Agreement.\par -{\pntext\f0 2.\tab}Certain logos, product names and trade-marks owned by Us or by third parties may be contained within the Licenced Materials or in documentation, media, packaging and illustrations relating to the Licensed Software. You do not acquire title to any such logos, product names or trade-marks under this Agreement.\par - -\pard\widctlpar\li360\qj\par -\par - -\pard\widctlpar\sa120\qj\cf2\b\fs33 5. Termination\par - -\pard -{\pntext\f0 1.\tab}{\*\pn\pnlvlbody\pnf0\pnindent720\pnstart1\pndec{\pntxta.}} -\widctlpar\fi-360\li360\qj\cf1\b0\fs21 This Agreement is effective until terminated by Us, with or without cause, in Our sole and unfettered discretion. We may terminate this Agreement without notice to You if You fail to comply with any of its terms. Any such termination by Us shall be in addition to and without prejudice to such rights and remedies as may be available to Us, including injunction and other equitable remedies.\par -{\pntext\f0 2.\tab}The disclaimers, limitations on liability, ownership, termination, interpretation, Your warranty and the indemnity provisions of this Agreement shall survive the termination or expiry of this Agreement.\par -{\pntext\f0 3.\tab}This Agreement will automatically terminate if You violate or assist in the violation of any of the restrictions of paragraph 2(2).\par -{\pntext\f0 4.\tab}On the termination of this Agreement, you must destroy any copies of the Licenced Materials in your possession whether in electronic or printed format.\par - -\pard\widctlpar\li360\qj\par -\par - -\pard\widctlpar\sa120\qj\cf2\b\fs33 6. Indemnification\par - -\pard\widctlpar\sa720\qj\cf1\b0\fs21 You agree to indemnify, defend and hold Us and Our partners, lawyers, staff, affiliates, successors and assigns (collectively, \ldblquote Affiliated Parties\rdblquote ) harmless from any liability, loss, claim and expense, including reasonable legal fees, related to Your violation of this Agreement or use of the Licenced Materials.\par - -\pard\widctlpar\sa120\qj\cf2\b\fs33 7. Disclaimer and Limitation of Liability\par - -\pard -{\pntext\f0 1.\tab}{\*\pn\pnlvlbody\pnf0\pnindent720\pnstart1\pndec{\pntxta.}} -\widctlpar\fi-360\li360\qj\cf1\b0\fs21 THE LICENCED MATERIALS ARE PROVIDED "AS IS", "AS AVAILABLE" AND ALL WARRANTIES, EXPRESS OR IMPLIED, ARE DISCLAIMED (INCLUDING BUT NOT LIMITED TO THE DISCLAIMER OF ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE). THE LICENCED MATERIALS MAY CONTAIN BUGS, ERRORS, PROBLEMS OR OTHER LIMITATIONS. WE AND OUR AFFILIATED PARTIES HAVE NO LIABILITY WHATSOEVER FOR YOUR USE OF ANY OF THE MATERIALS. IN PARTICULAR, BUT NOT AS A LIMITATION THEREOF, WE AND THE AFFILIATED PARTIES ARE NOT LIABLE FOR ANY INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING DAMAGES FOR LOSS OF BUSINESS, LOSS OF PROFITS, LITIGATION OR THE LIKE), WHETHER BASED ON BREACH OF CONTRACT, BREACH OF WARRANTY, TORT (INCLUDING NEGLIGENCE), PRODUCT LIABILITY OR OTHERWISE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. THE NEGATION OF DAMAGES SET FORTH ABOVE ARE FUNDAMENTAL ELEMENTS OF THE BASIS OF THE BARGAIN BETWEEN YOU AND US. THE LICENCED MATERIALS WOULD NOT BE PROVIDED WITHOUT SUCH LIMITATIONS.\par -{\pntext\f0 2.\tab}All responsibility or liability for any damages caused by the Licenced Materials, including, without limitation, damages caused by computer viruses or other malicious code contained within the Licenced Software is disclaimed.\par - -\pard\widctlpar\li360\qj\par -\par - -\pard\widctlpar\sa120\qj\cf2\b\fs33 8. Use of Information\par - -\pard\widctlpar\sa720\qj\cf1\b0\fs21 We reserve the right, and You authorize Us, to the use and assignment of all information regarding Your use of the Licenced Materials and all information provided by You in any manner consistent with Our Privacy Policy.\par - -\pard\widctlpar\sa120\qj\cf2\b\fs33 9. Miscellaneous\par - -\pard -{\pntext\f0 1.\tab}{\*\pn\pnlvlbody\pnf0\pnindent720\pnstart1\pndec{\pntxta.}} -\widctlpar\fi-360\li360\qj\cf1\b0\fs21 This Agreement shall be treated as though it were executed and performed in the province of British Columbia, Canada, and shall be governed by and construed in accordance with the laws of the province of British Columbia (without regard to conflict of law principles).\par -{\pntext\f0 2.\tab}Any of Your causes of action with respect to the Licenced Materials must be instituted within six (6) months after the cause of action arose or be forever waived and barred. All actions shall be subject to the limitations set forth in paragraph 7 of this Agreement.\par -{\pntext\f0 3.\tab}The language in this Agreement shall be interpreted as to its fair meaning and not construed strictly for or against either party. The division of this Agreement into sections and the insertion of headings are for convenience of reference only and shall not affect the construction or interpretation of this Agreement.\par -{\pntext\f0 4.\tab}All legal proceedings arising out of or in connection with this Agreement shall be brought solely in Vancouver, British Columbia. You expressly submit to the exclusive jurisdiction of said courts and consent to extra-territorial service of process.\par -{\pntext\f0 5.\tab}Should any part of this Agreement be held invalid or unenforceable, that portion shall be construed consistent with applicable law and the remaining portions shall remain in full force and effect.\par -{\pntext\f0 6.\tab}Failure of Us to enforce any provision of this Agreement shall not be deemed a waiver of such provision nor of the right to enforce such provision.\par -{\pntext\f0 7.\tab}You agree to review this Agreement prior to downloading, copying, installing or using the Licenced Materials. This Agreement may be amended by Us from time to time without specific advance notice to You. The latest Agreement will be provided with updates to the Licenced Software, and You should review the Agreement prior to using the Licenced Materials.\par -{\pntext\f0 8.\tab}This Agreement, as modified from time to time as described above, and including the policies incorporated by reference, constitutes the entire and only agreement between You and Us and supersedes all prior or contemporaneous agreements, representations, warranties and understandings with respect to the Licenced Materials.\par -{\pntext\f0 9.\tab}To the extent that anything in or associated with the Licenced Materials is in conflict or inconsistent with this Agreement, this Agreement shall take precedence.\par - -\pard\widctlpar\sa160\sl252\slmult1\cf0\fs22\par -} - \ No newline at end of file +{\rtf1\ansi\ansicpg1252\cocoartf2868 +\cocoatextscaling0\cocoaplatform0{\fonttbl\f0\fswiss\fcharset0 Helvetica-Light;} +{\colortbl;\red255\green255\blue255;} +{\*\expandedcolortbl;;} +\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\partightenfactor0 + +\f0\fs24 \cf0 GNU AFFERO GENERAL PUBLIC LICENSE\ + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for\ +software and other kinds of works, specifically designed to ensure\ +cooperation with the community in the case of network server software.\ +\ + The licenses for most software and other practical works are designed\ +to take away your freedom to share and change the works. By contrast,\ +our General Public Licenses are 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.\ +\ + 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.\ +\ + Developers that use our General Public Licenses protect your rights\ +with two steps: (1) assert copyright on the software, and (2) offer\ +you this License which gives you legal permission to copy, distribute\ +and/or modify the software.\ +\ + A secondary benefit of defending all users' freedom is that\ +improvements made in alternate versions of the program, if they\ +receive widespread use, become available for other developers to\ +incorporate. Many developers of free software are heartened and\ +encouraged by the resulting cooperation. However, in the case of\ +software used on network servers, this result may fail to come about.\ +The GNU General Public License permits making a modified version and\ +letting the public access it on a server without ever releasing its\ +source code to the public.\ +\ + The GNU Affero General Public License is designed specifically to\ +ensure that, in such cases, the modified source code becomes available\ +to the community. It requires the operator of a network server to\ +provide the source code of the modified version running there to the\ +users of that server. Therefore, public use of a modified version, on\ +a publicly accessible server, gives the public access to the source\ +code of the modified version.\ +\ + An older license, called the Affero General Public License and\ +published by Affero, was designed to accomplish similar goals. This is\ +a different license, not a version of the Affero GPL, but Affero has\ +released a new version of the Affero GPL which permits relicensing under\ +this license.\ +\ + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.\ +\ + Notwithstanding any other provision of this License, if you modify the\ +Program, your modified version must prominently offer all users\ +interacting with it remotely through a computer network (if your version\ +supports such interaction) an opportunity to receive the Corresponding\ +Source of your version by providing access to the Corresponding Source\ +from a network server at no charge, through some standard or customary\ +means of facilitating copying of software. This Corresponding Source\ +shall include the Corresponding Source for any work covered by version 3\ +of the GNU General Public License that is incorporated pursuant to the\ +following paragraph.\ +\ + 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 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 work with which it is combined will remain governed by version\ +3 of the GNU General Public License.\ +\ + 14. Revised Versions of this License.\ +\ + The Free Software Foundation may publish revised and/or new versions of\ +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.\ +\ + You should have received a copy of the GNU Affero General Public License\ + along with this program. If not, see .\ +\ +Also add information on how to contact you by electronic and paper mail.\ +\ + If your software can interact with users remotely through a computer\ +network, you should also make sure that it provides a way for users to\ +get its source. For example, if your program is a web application, its\ +interface could display a "Source" link that leads users to an archive\ +of the code. There are many ways you could offer source, and different\ +solutions will be better for different programs; see section 13 for the\ +specific requirements.\ +\ + 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 AGPL, see\ +.\ +} \ No newline at end of file diff --git a/Installer/eula.md b/Installer/eula.md index 887387e..be3f7b2 100644 --- a/Installer/eula.md +++ b/Installer/eula.md @@ -1,70 +1,661 @@ -# End-User Licence Agreement # + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 -READ THE FOLLOWING LICENCE AGREEMENT CAREFULLY! IT CONTAINS VERY IMPORTANT INFORMATION ABOUT YOUR RIGHTS AND OBLIGATIONS, AS WELL AS LIMITATIONS AND EXCLUSIONS THAT MAY APPLY TO YOU. THIS DOCUMENT CONTAINS A DISPUTE RESOLUTION CLAUSE. BY CLICKING ON THE "ACCEPT" BUTTON, YOU ARE CONSENTING TO BE BOUND BY AND ARE BECOMING A PARTY TO THIS AGREEMENT. IF YOU DO NOT AGREE TO ALL OF THE TERMS OF THIS AGREEMENT, CLICK THE "DO NOT ACCEPT" BUTTON OR LEAVE THE WEBSITE. + 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. -## 1. Definitions ## + Preamble -1. "We", "Our" and "Us" means SocaLabs. -2. "You" and "Your" means the person or entity who is being licenced to use the Licenced Software. -3. "Agreement" means this Software Licence Agreement between Us and You; -4. "Licenced Materials" means the Licenced Software and the Licenced Library; -5. "Licenced Software" means certain commercial software products being provided to You under this Agreement, including executable program modules thereof, as well as related documentation, and computer readable media; -6. "Sub-Licenced Software" means certain third party owned software components being provided under this Agreement that are required to properly enable or operate the Licenced Software; and -7. "Licenced Library" means any audio waveforms, such as melodies, music, instrument recordings, or other audible information, provided by Us for use with the Licenced Software. + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. -## 2. Software Licence, SamplePack Licence, Rights and Restrictions ## + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. -1. Subject to the provisions contained in this Agreement, We hereby grant to You a personal, revocable, non-exclusive licence (the "Licence") to access, read, use and download one copy of the Licenced Materials solely for the purposes provided under paragraph 3. This is not a transfer of title. -2. Under the Licence you may not and shall not, without Our express written authorization: - 1. own title, or transfer title to the Licenced Materials to another party; - 2. transfer the Licence; - 3. remove any copyright or other proprietary notations from the Licenced Materials; - 4. distribute, or sublicense or otherwise provide copies of or access to the Licenced Materials to any third party; - 5. pledge, hypothecate, alienate or otherwise encumber the Licenced Materials to any third party; - 6. create derivative works of, reverse engineer, decompile, disassemble, adapt, translate, transmit, arrange, modify, copy, bundle, sell, sublicense, export, merge, transfer, adapt, loan, rent, lease, assign, share, outsource, host, publish, make available to any person or otherwise use, either directly or indirectly, the Licenced Materials; - 7. permit, allow or do anything that would infringe or otherwise prejudice the proprietary rights of Us or Our licensors; - 8. circumvent, remove, alter or otherwise impair any technological protection measures, digital rights management information, or other copy-protection mechanisms used in or by the Licenced Materials; or - 9. include, use, re-sample, mix, process, isolate or embed any content from the Licenced Library in any virtual instrument, audio sampling system, audio playback system or library of any kind, other than those provided or authorized by Us. -3. We are not obligated to provide any authorization referred to in paragraph 2(2), We reserve the right to charge a fee for the grant of such authorization, and We may cancel such authorization at Our sole and unfettered discretion by providing notice to You of such cancellation. -4. The restrictions set out in this Agreement, including the restrictions listed at paragraph 2(2), shall not apply to the limited extent the restrictions are prohibited by applicable law. -5. We will have the right to inspect and enforce the restrictions and covenants contained in this Agreement at Your sole expense, and You hereby agree to promptly notify Us of any known violations of such restrictions. -6. You agree to protect the Licenced Materials from unauthorized use, reproduction, distribution or publication in electronic or physical form. -7. Upon execution of this Agreement, We will: - 1. permit You to download a copy of the Licenced Materials for Your use under this Agreement; and - 2. permit You to download updates to the Licenced Software as We consider needed. We are not obligated to provide updates for the Licenced Software. + 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. -## 3. Usage Conditions ## -1. You are authorized to use the Licenced Materials only for personal use. -2. You may not rent out to others equipment on which the Licenced Software is installed or by which the Licenced Library is accessible without obtaining a written rental licence from Us that expressly authorizes such use. We reserve the right to charge a fee for a rental licence. -3. You may install the Licenced Software on as many devices as required for Your personal use provided such devices are used only by You. + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. -## 4. Ownership and Intellectual Property Rights ## -1. All copyright in the Licenced Software, including any documentation, media, packaging and illustrations, but excluding the Sublicenced Software, is owned by Us. You do not acquire title to any copyright in the Licenced Materials or Sublicenced Software under this Agreement. -2. Certain logos, product names and trade-marks owned by Us or by third parties may be contained within the Licenced Materials or in documentation, media, packaging and illustrations relating to the Licensed Software. You do not acquire title to any such logos, product names or trade-marks under this Agreement. + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. -## 5. Termination ## -1. This Agreement is effective until terminated by Us, with or without cause, in Our sole and unfettered discretion. We may terminate this Agreement without notice to You if You fail to comply with any of its terms. Any such termination by Us shall be in addition to and without prejudice to such rights and remedies as may be available to Us, including injunction and other equitable remedies. -2. The disclaimers, limitations on liability, ownership, termination, interpretation, Your warranty and the indemnity provisions of this Agreement shall survive the termination or expiry of this Agreement. -3. This Agreement will automatically terminate if You violate or assist in the violation of any of the restrictions of paragraph 2(2). -4. On the termination of this Agreement, you must destroy any copies of the Licenced Materials in your possession whether in electronic or printed format. + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. -## 6. Indemnification ## -You agree to indemnify, defend and hold Us and Our partners, lawyers, staff, affiliates, successors and assigns (collectively, "Affiliated Parties") harmless from any liability, loss, claim and expense, including reasonable legal fees, related to Your violation of this Agreement or use of the Licenced Materials. + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. -## 7. Disclaimer and Limitation of Liability ## -1. THE LICENCED MATERIALS ARE PROVIDED "AS IS", "AS AVAILABLE" AND ALL WARRANTIES, EXPRESS OR IMPLIED, ARE DISCLAIMED (INCLUDING BUT NOT LIMITED TO THE DISCLAIMER OF ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE). THE LICENCED MATERIALS MAY CONTAIN BUGS, ERRORS, PROBLEMS OR OTHER LIMITATIONS. WE AND OUR AFFILIATED PARTIES HAVE NO LIABILITY WHATSOEVER FOR YOUR USE OF ANY OF THE MATERIALS. IN PARTICULAR, BUT NOT AS A LIMITATION THEREOF, WE AND THE AFFILIATED PARTIES ARE NOT LIABLE FOR ANY INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING DAMAGES FOR LOSS OF BUSINESS, LOSS OF PROFITS, LITIGATION OR THE LIKE), WHETHER BASED ON BREACH OF CONTRACT, BREACH OF WARRANTY, TORT (INCLUDING NEGLIGENCE), PRODUCT LIABILITY OR OTHERWISE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. THE NEGATION OF DAMAGES SET FORTH ABOVE ARE FUNDAMENTAL ELEMENTS OF THE BASIS OF THE BARGAIN BETWEEN YOU AND US. THE LICENCED MATERIALS WOULD NOT BE PROVIDED WITHOUT SUCH LIMITATIONS. -2. All responsibility or liability for any damages caused by the Licenced Materials, including, without limitation, damages caused by computer viruses or other malicious code contained within the Licenced Software is disclaimed. + The precise terms and conditions for copying, distribution and +modification follow. -## 8. Use of Information ## -We reserve the right, and You authorize Us, to the use and assignment of all information regarding Your use of the Licenced Materials and all information provided by You in any manner consistent with Our Privacy Policy. + TERMS AND CONDITIONS -## 9. Miscellaneous ## -1. This Agreement shall be treated as though it were executed and performed in the province of British Columbia, Canada, and shall be governed by and construed in accordance with the laws of the province of British Columbia (without regard to conflict of law principles). -2. Any of Your causes of action with respect to the Licenced Materials must be instituted within six (6) months after the cause of action arose or be forever waived and barred. All actions shall be subject to the limitations set forth in paragraph 7 of this Agreement. -3. The language in this Agreement shall be interpreted as to its fair meaning and not construed strictly for or against either party. The division of this Agreement into sections and the insertion of headings are for convenience of reference only and shall not affect the construction or interpretation of this Agreement. -4. All legal proceedings arising out of or in connection with this Agreement shall be brought solely in Vancouver, British Columbia. You expressly submit to the exclusive jurisdiction of said courts and consent to extra-territorial service of process. -5. Should any part of this Agreement be held invalid or unenforceable, that portion shall be construed consistent with applicable law and the remaining portions shall remain in full force and effect. -6. Failure of Us to enforce any provision of this Agreement shall not be deemed a waiver of such provision nor of the right to enforce such provision. -7. You agree to review this Agreement prior to downloading, copying, installing or using the Licenced Materials. This Agreement may be amended by Us from time to time without specific advance notice to You. The latest Agreement will be provided with updates to the Licenced Software, and You should review the Agreement prior to using the Licenced Materials. -8. This Agreement, as modified from time to time as described above, and including the policies incorporated by reference, constitutes the entire and only agreement between You and Us and supersedes all prior or contemporaneous agreements, representations, warranties and understandings with respect to the Licenced Materials. -9. To the extent that anything in or associated with the Licenced Materials is in conflict or inconsistent with this Agreement, this Agreement shall take precedence. + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. From c991e57693de041724fb9354c1b579e30001c8ea Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Thu, 30 Apr 2026 13:57:46 -0700 Subject: [PATCH 03/21] Release 1.0.29 --- Changelist.txt | 3 +++ VERSION | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/Changelist.txt b/Changelist.txt index cbd80d0..e0c06f2 100644 --- a/Changelist.txt +++ b/Changelist.txt @@ -1,3 +1,6 @@ +1.0.29: +- AGPL license + 1.0.28: - Created installers diff --git a/VERSION b/VERSION index f8536a4..fa7e3ca 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.0.28 \ No newline at end of file +1.0.29 \ No newline at end of file From e2f3f5fc0f7d22da445d7822c1db9ce8c2c90405 Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Thu, 30 Apr 2026 15:42:51 -0700 Subject: [PATCH 04/21] VST2 install path; disable build workflow --- .github/workflows/{build.yaml => build.yaml.disabled} | 0 Changelist.txt | 3 +++ Installer/win/Wavetable.iss | 4 ++-- VERSION | 2 +- 4 files changed, 6 insertions(+), 3 deletions(-) rename .github/workflows/{build.yaml => build.yaml.disabled} (100%) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml.disabled similarity index 100% rename from .github/workflows/build.yaml rename to .github/workflows/build.yaml.disabled diff --git a/Changelist.txt b/Changelist.txt index e0c06f2..dbbe90d 100644 --- a/Changelist.txt +++ b/Changelist.txt @@ -1,3 +1,6 @@ +1.0.30: +- VST2 install path + 1.0.29: - AGPL license diff --git a/Installer/win/Wavetable.iss b/Installer/win/Wavetable.iss index eaf49e4..97d2621 100644 --- a/Installer/win/Wavetable.iss +++ b/Installer/win/Wavetable.iss @@ -58,7 +58,7 @@ Name: "clap"; Description: "CLAP plug-in"; Types: full cu Name: "resources"; Description: "Factory wavetables and presets"; Types: full custom; Flags: fixed [InstallDelete] -Type: files; Name: "{commoncf64}\VST\Wavetable.dll"; Components: vst +Type: files; Name: "{commoncf64}\VST2\Wavetable.dll"; Components: vst Type: filesandordirs; Name: "{commoncf64}\VST3\Wavetable.vst3"; Components: vst3 Type: files; Name: "{commoncf64}\CLAP\Wavetable.clap"; Components: clap Type: filesandordirs; Name: "{commonappdata}\SocaLabs\Wavetable\Presets"; Components: resources @@ -66,7 +66,7 @@ Type: filesandordirs; Name: "{commonappdata}\SocaLabs\Wavetable\Wavetables"; [Files] ; Plug-in formats -Source: "bin\VST\Wavetable.dll"; DestDir: "{commoncf64}\VST"; Flags: ignoreversion overwritereadonly; Components: vst +Source: "bin\VST\Wavetable.dll"; DestDir: "{commoncf64}\VST2"; Flags: ignoreversion overwritereadonly; Components: vst Source: "bin\VST3\Wavetable.vst3\*"; DestDir: "{commoncf64}\VST3\Wavetable.vst3\"; Flags: ignoreversion overwritereadonly recursesubdirs; Components: vst3 Source: "bin\CLAP\Wavetable.clap"; DestDir: "{commoncf64}\CLAP"; Flags: ignoreversion overwritereadonly; Components: clap diff --git a/VERSION b/VERSION index fa7e3ca..a7a8343 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.0.29 \ No newline at end of file +1.0.30 \ No newline at end of file From be05233662b49db9bf6ec89db675888a703a38c0 Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Thu, 30 Apr 2026 16:56:41 -0700 Subject: [PATCH 05/21] Re-enable build workflow [skip ci] --- .github/workflows/{build.yaml.disabled => build.yaml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{build.yaml.disabled => build.yaml} (100%) diff --git a/.github/workflows/build.yaml.disabled b/.github/workflows/build.yaml similarity index 100% rename from .github/workflows/build.yaml.disabled rename to .github/workflows/build.yaml From f822ff7659cd427a2eb3332cfdbb99aa848b1bac Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Sat, 2 May 2026 09:49:53 -0700 Subject: [PATCH 06/21] v1.0.31 --- Changelist.txt | 3 +++ VERSION | 2 +- modules/gin | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/Changelist.txt b/Changelist.txt index dbbe90d..374f337 100644 --- a/Changelist.txt +++ b/Changelist.txt @@ -1,3 +1,6 @@ +1.0.31: +- Fixed ADSR attack when time is 0 + 1.0.30: - VST2 install path diff --git a/VERSION b/VERSION index a7a8343..a8c6b78 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.0.30 \ No newline at end of file +1.0.31 \ No newline at end of file diff --git a/modules/gin b/modules/gin index 7781d8d..ec6ac53 160000 --- a/modules/gin +++ b/modules/gin @@ -1 +1 @@ -Subproject commit 7781d8dafb59e6e4b7837ff8acb113fcae7291ea +Subproject commit ec6ac53d4c86559ff40cfe335c96a249890a12ab From 8c45136be6b259a9b52c8a00a95ad6b1b4893d2f Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Sat, 2 May 2026 09:54:17 -0700 Subject: [PATCH 07/21] bring back config_cmake --- ci/config_cmake.sh | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100755 ci/config_cmake.sh diff --git a/ci/config_cmake.sh b/ci/config_cmake.sh new file mode 100755 index 0000000..233babd --- /dev/null +++ b/ci/config_cmake.sh @@ -0,0 +1,16 @@ +#!/bin/bash -e + +ROOT=$(cd "$(dirname "$0")/.."; pwd) +cd "$ROOT" + +export PATH=$PATH:"/c/Program Files/CMake/bin" + +if [ "$(uname)" == "Darwin" ]; then + TOOLCHAIN="xcode" +elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then + TOOLCHAIN="ninja-gcc" +elif [ "$(expr substr $(uname -s) 1 10)" == "MINGW64_NT" ]; then + TOOLCHAIN="vs" +fi + +cmake --preset $TOOLCHAIN -D BUILD_EXTRAS=OFF -D JUCE_COPY_PLUGIN_AFTER_BUILD=ON From e4f7246f45d062b1827e97a360ce2130a98df5ed Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Sat, 2 May 2026 15:47:21 -0700 Subject: [PATCH 08/21] Fix wavetable menu --- plugin/Source/Panels.h | 12 ++++----- plugin/Source/PluginProcessor.cpp | 44 ++++++++++++++++++++++++------- plugin/Source/PluginProcessor.h | 1 + 3 files changed, 42 insertions(+), 15 deletions(-) diff --git a/plugin/Source/Panels.h b/plugin/Source/Panels.h index 65bd3c0..161699e 100644 --- a/plugin/Source/Panels.h +++ b/plugin/Source/Panels.h @@ -143,16 +143,16 @@ public: } else if (e.originalComponent == &h && e.mouseWasClicked() && e.x >= prevButton.getRight() && e.x <= nextButton.getX()) { - auto tables = proc.getWavetableNames(); + auto files = proc.getWavetableFiles(); std::map menus; - for (auto t : tables) + for (auto& f : files) { - auto prefix = t.upToFirstOccurrenceOf (" ", false, false); - auto suffix = t.fromFirstOccurrenceOf (" ", false, false); + auto t = f.getFileNameWithoutExtension(); + auto category = f.getParentDirectory().getFileName(); - menus[prefix].addItem (t, [this, t] + menus[category].addItem (t, [this, t] { if (idx == 0) { @@ -171,7 +171,7 @@ public: juce::PopupMenu m; m.setLookAndFeel (&getLookAndFeel()); - + for (auto itr : menus) m.addSubMenu (itr.first, itr.second); diff --git a/plugin/Source/PluginProcessor.cpp b/plugin/Source/PluginProcessor.cpp index 27bead0..956f6f7 100644 --- a/plugin/Source/PluginProcessor.cpp +++ b/plugin/Source/PluginProcessor.cpp @@ -643,12 +643,15 @@ void WavetableAudioProcessor::reloadWavetables() { auto loadMemory = [&] (const juce::String& name) -> juce::MemoryBlock { - auto file = systemResourceRoot().getChildFile ("Wavetables").getChildFile (name + ".wt2048"); - if (file.existsAsFile()) + auto wtDir = systemResourceRoot().getChildFile ("Wavetables"); + if (wtDir.isDirectory()) { - juce::MemoryBlock mb; - if (file.loadFileAsData (mb)) - return mb; + for (auto& file : wtDir.findChildFiles (juce::File::findFiles, true, name + ".wt2048")) + { + juce::MemoryBlock mb; + if (file.loadFileAsData (mb)) + return mb; + } } return {}; }; @@ -788,15 +791,38 @@ juce::Array WavetableAudioProcessor::getFactoryProgramDirectories() juce::StringArray WavetableAudioProcessor::getWavetableNames() const { juce::StringArray tables; - auto wtDir = systemResourceRoot().getChildFile ("Wavetables"); - if (wtDir.isDirectory()) - for (auto f : wtDir.findChildFiles (juce::File::findFiles, false, "*.wt2048")) - tables.add (f.getFileNameWithoutExtension()); + for (auto& f : getWavetableFiles()) + tables.add (f.getFileNameWithoutExtension()); tables.sortNatural(); return tables; } +juce::Array WavetableAudioProcessor::getWavetableFiles() const +{ + juce::Array files; + auto wtDir = systemResourceRoot().getChildFile ("Wavetables"); + if (wtDir.isDirectory()) + files = wtDir.findChildFiles (juce::File::findFiles, true, "*.wt2048"); + + struct Sorter + { + static int compareElements (const juce::File& a, const juce::File& b) + { + auto categoryCmp = a.getParentDirectory().getFileName() + .compareNatural (b.getParentDirectory().getFileName()); + if (categoryCmp != 0) + return categoryCmp; + return a.getFileNameWithoutExtension() + .compareNatural (b.getFileNameWithoutExtension()); + } + }; + Sorter sorter; + files.sort (sorter); + + return files; +} + //============================================================================== void WavetableAudioProcessor::setupModMatrix() { diff --git a/plugin/Source/PluginProcessor.h b/plugin/Source/PluginProcessor.h index b96eb51..5ef0f1b 100644 --- a/plugin/Source/PluginProcessor.h +++ b/plugin/Source/PluginProcessor.h @@ -56,6 +56,7 @@ public: void incWavetable (int osc, int delta); bool loadUserWavetable (int osc, const juce::File& f, int sz); juce::StringArray getWavetableNames() const; + juce::Array getWavetableFiles() const; void applyEffects (juce::AudioSampleBuffer& buffer); void applyEffect (juce::AudioSampleBuffer& buffer, int fxId); From 155c9337110a2c9eee5ff524ef70b755385744b0 Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Sat, 2 May 2026 15:54:57 -0700 Subject: [PATCH 09/21] Fix deadlock --- plugin/Source/PluginProcessor.cpp | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/plugin/Source/PluginProcessor.cpp b/plugin/Source/PluginProcessor.cpp index 956f6f7..1d6d488 100644 --- a/plugin/Source/PluginProcessor.cpp +++ b/plugin/Source/PluginProcessor.cpp @@ -942,14 +942,15 @@ bool WavetableAudioProcessor::isBusesLayoutSupported (const BusesLayout& layout) void WavetableAudioProcessor::processBlock (juce::AudioBuffer& buffer, juce::MidiBuffer& midi) { juce::ScopedNoDenormals noDenormals; + + if (buffer.getNumChannels() != 2) + return; + if (! dspLock.tryEnter()) { blockMissed = true; return; } - - if (buffer.getNumChannels() != 2) - return; if (midiLearn) midiLearn->processBlock (midi, buffer.getNumSamples()); From 98d290770b1436bc43017defb9a775b7ea80fe47 Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Sat, 2 May 2026 15:58:03 -0700 Subject: [PATCH 10/21] Spacing --- Installer/win/Wavetable.iss | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Installer/win/Wavetable.iss b/Installer/win/Wavetable.iss index 97d2621..6f3e732 100644 --- a/Installer/win/Wavetable.iss +++ b/Installer/win/Wavetable.iss @@ -58,7 +58,7 @@ Name: "clap"; Description: "CLAP plug-in"; Types: full cu Name: "resources"; Description: "Factory wavetables and presets"; Types: full custom; Flags: fixed [InstallDelete] -Type: files; Name: "{commoncf64}\VST2\Wavetable.dll"; Components: vst +Type: files; Name: "{commoncf64}\VST2\Wavetable.dll"; Components: vst Type: filesandordirs; Name: "{commoncf64}\VST3\Wavetable.vst3"; Components: vst3 Type: files; Name: "{commoncf64}\CLAP\Wavetable.clap"; Components: clap Type: filesandordirs; Name: "{commonappdata}\SocaLabs\Wavetable\Presets"; Components: resources @@ -66,7 +66,7 @@ Type: filesandordirs; Name: "{commonappdata}\SocaLabs\Wavetable\Wavetables"; [Files] ; Plug-in formats -Source: "bin\VST\Wavetable.dll"; DestDir: "{commoncf64}\VST2"; Flags: ignoreversion overwritereadonly; Components: vst +Source: "bin\VST\Wavetable.dll"; DestDir: "{commoncf64}\VST2"; Flags: ignoreversion overwritereadonly; Components: vst Source: "bin\VST3\Wavetable.vst3\*"; DestDir: "{commoncf64}\VST3\Wavetable.vst3\"; Flags: ignoreversion overwritereadonly recursesubdirs; Components: vst3 Source: "bin\CLAP\Wavetable.clap"; DestDir: "{commoncf64}\CLAP"; Flags: ignoreversion overwritereadonly; Components: clap From 05992e760fb24240af16a033a51afcc7670177ad Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Sat, 2 May 2026 15:59:02 -0700 Subject: [PATCH 11/21] v1.0.32 --- Changelist.txt | 4 ++++ VERSION | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/Changelist.txt b/Changelist.txt index 374f337..e2e08b4 100644 --- a/Changelist.txt +++ b/Changelist.txt @@ -1,3 +1,7 @@ +1.0.32: +- Fixed fix wavetable menus +- Fixed deadlock + 1.0.31: - Fixed ADSR attack when time is 0 diff --git a/VERSION b/VERSION index a8c6b78..08a69b5 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.0.31 \ No newline at end of file +1.0.32 \ No newline at end of file From 539fd803709d2cdba57e3a6031ef24d5301ab412 Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Sun, 3 May 2026 12:23:58 -0700 Subject: [PATCH 12/21] new instances remember ui size --- modules/gin | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/gin b/modules/gin index ec6ac53..94fee5b 160000 --- a/modules/gin +++ b/modules/gin @@ -1 +1 @@ -Subproject commit ec6ac53d4c86559ff40cfe335c96a249890a12ab +Subproject commit 94fee5b72348976107f6d7c751b1c4f632cf6bf0 From a681b2e3321e6833ccbd8c6ab6b3f7d326f68339 Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Thu, 16 Jul 2026 18:18:43 -0700 Subject: [PATCH 13/21] Add crash reporting (bundle CrashReporter, strip, symbols, upload) - register plugin + ship Installer/crashreporter.json - installer bundles the shared CrashReporter (mac pkg + component-plist + reporter-scripts promote-if-newer; win .iss shared component) and the JSON - strip shipped mac binaries; emit dSYM (Xcode) and PDB (/Zi /DEBUG) in Release - launchCrashReporterOnce() from the processor on first instance - upload dSYM/PDB symbols to the crash site from release.yaml - bump to 1.0.33 --- .github/workflows/release.yaml | 1 + CMakeLists.txt | 17 +++ Changelist.txt | 3 + Installer/build.sh | 110 ++++++++++++++++++- Installer/crashreporter.json | 6 + Installer/macOS/distribution.xml | 11 ++ Installer/macOS/reporter-scripts/postinstall | 38 +++++++ Installer/win/Wavetable.iss | 8 ++ VERSION | 2 +- plugin/Source/PluginProcessor.cpp | 25 +++++ 10 files changed, 219 insertions(+), 2 deletions(-) create mode 100644 Installer/crashreporter.json create mode 100755 Installer/macOS/reporter-scripts/postinstall diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 42df63a..c48a2a8 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -53,6 +53,7 @@ jobs: AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }} AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }} AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }} + SYMBOL_API_KEY: ${{ secrets.SYMBOL_API_KEY }} - name: Upload Artifact uses: actions/upload-artifact@v4 diff --git a/CMakeLists.txt b/CMakeLists.txt index 4a8d37b..7504482 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -213,6 +213,7 @@ if (APPLE) XCODE_ATTRIBUTE_CLANG_LINK_OBJC_RUNTIME NO #XCODE_ATTRIBUTE_DEPLOYMENT_POSTPROCESSING[variant=Release] YES XCODE_ATTRIBUTE_ONLY_ACTIVE_ARCH[variant=Debug] "YES" + XCODE_ATTRIBUTE_DEBUG_INFORMATION_FORMAT[variant=Release] "dwarf-with-dsym" ) if (NOT t STREQUAL "All") target_compile_options(${tgt} PRIVATE @@ -237,6 +238,22 @@ if (WIN32) set_target_properties(${tgt} PROPERTIES LINK_FLAGS "/ignore:4099") endif() endforeach() + + # Generate debug symbols (PDBs) for Release builds so crashes can be symbolicated. + # /Zi emits full debug info; /DEBUG produces the .pdb; /OPT:REF and /OPT:ICF + # restore the size optimisations that /DEBUG otherwise disables. + foreach(t ${FORMATS} "CLAP" "") + set(tgt ${CMAKE_PROJECT_NAME}) + if (NOT t STREQUAL "") + set(tgt ${tgt}_${t}) + endif() + if (TARGET ${tgt}) + target_compile_options(${tgt} PRIVATE "$<$:/Zi>") + target_link_options(${tgt} PRIVATE "$<$:/DEBUG>") + target_link_options(${tgt} PRIVATE "$<$:/OPT:REF>") + target_link_options(${tgt} PRIVATE "$<$:/OPT:ICF>") + endif() + endforeach() endif() if(UNIX AND NOT APPLE) diff --git a/Changelist.txt b/Changelist.txt index e2e08b4..b3babb2 100644 --- a/Changelist.txt +++ b/Changelist.txt @@ -1,3 +1,6 @@ +1.0.33: +- Added crash reporting + 1.0.32: - Fixed fix wavetable menus - Fixed deadlock diff --git a/Installer/build.sh b/Installer/build.sh index 6e2da81..e559fe2 100755 --- a/Installer/build.sh +++ b/Installer/build.sh @@ -21,6 +21,42 @@ fi VERSION=$(cat "$PROJECT_ROOT/VERSION") +# +# Crash reporting: bundle the latest CrashReporter app + this plugin's +# registration JSON, and upload debug symbols so crashes can be symbolicated. +# SYMBOL_API_KEY - CI secret, authorises symbol upload for this plugin. +# The CrashReporter download is a public distribution channel (no key needed). +# +CRASH_BASE="https://crashreports.rabiensoftware.com" + +# Native (non-MSYS) curl on Windows can't read Git-Bash paths like /d/a/..., +# so translate to a Windows path there. No-op on macOS/Linux. +curl_path () { + if command -v cygpath >/dev/null 2>&1; then cygpath -m "$1"; else printf '%s' "$1"; fi +} + +# Download the latest CrashReporter build for a platform. Non-fatal: if none is +# published yet we still ship the registration JSON so crashes register. +fetch_reporter () { # $1 platform, $2 output file + if curl -fsSL "$CRASH_BASE/reporter/latest/?platform=$1" -o "$(curl_path "$2")"; then + return 0 + fi + echo "WARNING: could not fetch CrashReporter for $1 (none published yet?)" + return 1 +} + +# Upload a symbols archive for this plugin/version. Skipped if the key is unset. +upload_symbols () { # $1 platform, $2 zip file + if [ -z "${SYMBOL_API_KEY:-}" ]; then echo "SYMBOL_API_KEY not set — skipping symbol upload"; return 0; fi + if [ ! -f "$2" ]; then echo "No symbol archive $2 — skipping"; return 0; fi + echo "Uploading $1 symbols for $VERSION" + # Non-fatal: a symbol-upload failure must never break a release build. + curl -fsS -H "X-API-Key: $SYMBOL_API_KEY" \ + -F "platform=$1" -F "version=$VERSION" -F "files[]=@$(curl_path "$2")" \ + "$CRASH_BASE/symbols/" || echo "WARNING: symbol upload failed" + echo +} + # # Reset staging # @@ -95,6 +131,15 @@ if [ "$PLATFORM" = "macOS" ]; then cp -R "$PROJECT_ROOT/plugin/Resources/WavetablesFLAC" "$STAGE/resources/Library/Audio/Presets/$VENDOR/$PLUGIN/Wavetables" find "$STAGE/resources" -name ".DS_Store" -delete + # Strip symbols from the shipped binaries so end-user crash logs are NOT + # symbolicated locally by macOS — the server symbolicates them from the dSYMs + # (built below from the unstripped products in $ART_DIR). strip preserves the + # Mach-O UUID, so the dSYM still matches. Before codesign. + strip -x "$STAGE/vst/$PLUGIN.vst/Contents/MacOS/$PLUGIN" + strip -x "$STAGE/vst3/$PLUGIN.vst3/Contents/MacOS/$PLUGIN" + strip -x "$STAGE/au/$PLUGIN.component/Contents/MacOS/$PLUGIN" + strip -x "$STAGE/clap/$PLUGIN.clap/Contents/MacOS/$PLUGIN" + if [ -n "${APPLICATION:-}" ]; then codesign -s "$DEV_APP_ID" --options=runtime --timestamp --force -v "$STAGE/vst/$PLUGIN.vst" codesign -s "$DEV_APP_ID" --options=runtime --timestamp --force -v "$STAGE/vst3/$PLUGIN.vst3" @@ -136,6 +181,38 @@ if [ "$PLATFORM" = "macOS" ]; then --scripts "$PROJECT_ROOT/Installer/macOS/scripts" \ "$PKG_DIR/resources.pkg" + # CrashReporter component: latest signed CrashReporter.app + this plugin's + # registration JSON. Staged under .incoming and promoted by the postinstall + # only if strictly newer (shared component, never downgraded). + REP_STAGE="$PROJECT_ROOT/Installer/macOS/bin/reporter" + REP_ROOT="$REP_STAGE/Library/Application Support/Rabien Software/Crash Reporter" + rm -Rf "$REP_STAGE" + mkdir -p "$REP_ROOT/Plugins" "$REP_ROOT/.incoming" + if fetch_reporter mac "$REP_STAGE/CrashReporter_Mac.zip"; then + ( cd "$REP_STAGE" && unzip -qo CrashReporter_Mac.zip && rm CrashReporter_Mac.zip ) + mv "$REP_STAGE/CrashReporter.app" "$REP_ROOT/.incoming/" + fi + cp "$PROJECT_ROOT/Installer/crashreporter.json" "$REP_ROOT/Plugins/wavetable.json" + find "$REP_STAGE" -name ".DS_Store" -delete + + if [ -n "${APPLICATION:-}" ] && [ -d "$REP_ROOT/.incoming/CrashReporter.app" ]; then + codesign -s "$DEV_APP_ID" --options=runtime --timestamp --force -v "$REP_ROOT/.incoming/CrashReporter.app" + fi + + chmod +x "$PROJECT_ROOT/Installer/macOS/reporter-scripts/postinstall" + + # Disable bundle relocation so the installer installs to our staged path + # instead of redirecting to a CrashReporter.app found elsewhere via Spotlight. + COMP_PLIST="$PROJECT_ROOT/Installer/macOS/bin/reporter-component.plist" + pkgbuild --analyze --root "$REP_STAGE" "$COMP_PLIST" + /usr/libexec/PlistBuddy -c "Set :0:BundleIsRelocatable false" "$COMP_PLIST" 2>/dev/null || true + + pkgbuild --root "$REP_STAGE" --install-location "/" \ + --identifier "${BUNDLE_BASE}.crashreporter.pkg" --version "$VERSION" \ + --component-plist "$COMP_PLIST" \ + --scripts "$PROJECT_ROOT/Installer/macOS/reporter-scripts" \ + "$PKG_DIR/reporter.pkg" + # productbuild — combine into one signed installer cp "$PROJECT_ROOT/Installer/EULA.rtf" "$PKG_DIR/EULA.rtf" cp "$PROJECT_ROOT/Installer/macOS/welcome.txt" "$PKG_DIR/welcome.txt" @@ -172,7 +249,18 @@ if [ "$PLATFORM" = "macOS" ]; then cp "$PKG_OUT" "$PROJECT_ROOT/bin/" - # Symbols zip + # Symbols zip. Some Xcode/CMake combos don't emit .dSYMs next to the product, + # so generate any that are missing straight from the built binaries. + for pair in "VST:$PLUGIN.vst" "VST3:$PLUGIN.vst3" "AU:$PLUGIN.component" "CLAP:$PLUGIN.clap"; do + d="${pair%%:*}"; b="${pair#*:}" + dsym="$ART_DIR/$d/$b.dSYM" + bin="$ART_DIR/$d/$b/Contents/MacOS/$PLUGIN" + if [ ! -d "$dsym" ] && [ -f "$bin" ]; then + echo "Generating dSYM for $d/$b" + dsymutil "$bin" -o "$dsym" || true + fi + done + cd "$ART_DIR" zip -r "$PROJECT_ROOT/bin/Symbols_Mac.zip" \ AU/$PLUGIN.component.dSYM \ @@ -180,6 +268,8 @@ if [ "$PLATFORM" = "macOS" ]; then VST3/$PLUGIN.vst3.dSYM \ CLAP/$PLUGIN.clap.dSYM 2>/dev/null || true + upload_symbols mac "$PROJECT_ROOT/bin/Symbols_Mac.zip" + ############################################################ # Linux — cpack DEB (VST + VST3 + LV2 + CLAP + Resources) ############################################################ @@ -210,6 +300,14 @@ else cp -R "$ART_DIR/VST3/$PLUGIN.vst3" "$STAGE/VST3/" cp -R "$ART_DIR/CLAP/$PLUGIN.clap" "$STAGE/CLAP/" + # CrashReporter: latest signed build + this plugin's registration JSON. + REP_DIR="$STAGE/CrashReporter" + rm -Rf "$REP_DIR"; mkdir -p "$REP_DIR" + if fetch_reporter win "$REP_DIR/CrashReporter_Win.zip"; then + ( cd "$REP_DIR" && 7z x -y CrashReporter_Win.zip >/dev/null && rm CrashReporter_Win.zip ) + fi + cp "$PROJECT_ROOT/Installer/crashreporter.json" "$REP_DIR/wavetable.json" + # # Sign binaries via Microsoft Trusted Signing. # Required env: AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET. @@ -272,4 +370,14 @@ else fi cp "$EXE_OUT" "$PROJECT_ROOT/bin/" + + # Symbols zip — PDBs for crash symbolication. + SYM_DIR="$STAGE/symbols" + rm -Rf "$SYM_DIR"; mkdir -p "$SYM_DIR/VST" "$SYM_DIR/VST3" "$SYM_DIR/CLAP" + cp "$ART_DIR/VST/$PLUGIN.pdb" "$SYM_DIR/VST/" 2>/dev/null || true + cp "$ART_DIR/VST3/$PLUGIN.pdb" "$SYM_DIR/VST3/" 2>/dev/null || true + cp "$ART_DIR/CLAP/$PLUGIN.pdb" "$SYM_DIR/CLAP/" 2>/dev/null || true + ( cd "$SYM_DIR" && 7z a "$PROJECT_ROOT/bin/Symbols_Win.zip" VST VST3 CLAP ) + + upload_symbols win "$PROJECT_ROOT/bin/Symbols_Win.zip" fi diff --git a/Installer/crashreporter.json b/Installer/crashreporter.json new file mode 100644 index 0000000..cc52a9c --- /dev/null +++ b/Installer/crashreporter.json @@ -0,0 +1,6 @@ +{ + "name": "Wavetable", + "pluginID": "com.socalabs.wavetable", + "crashUrl": "https://crashreports.rabiensoftware.com/post/", + "apiKey": "da8b3bc4e5fcb9b5ba8b5960d0ef805b62d4097b956082c87fcf82cab40cc2c8" +} diff --git a/Installer/macOS/distribution.xml b/Installer/macOS/distribution.xml index 63aa3fd..6846ef7 100644 --- a/Installer/macOS/distribution.xml +++ b/Installer/macOS/distribution.xml @@ -13,6 +13,7 @@ + + + + + vst.pkg vst3.pkg au.pkg clap.pkg resources.pkg + reporter.pkg diff --git a/Installer/macOS/reporter-scripts/postinstall b/Installer/macOS/reporter-scripts/postinstall new file mode 100755 index 0000000..9ae4a00 --- /dev/null +++ b/Installer/macOS/reporter-scripts/postinstall @@ -0,0 +1,38 @@ +#!/bin/bash +# +# CrashReporter is a SHARED component across all SocaLabs/Rabien plugins, so we +# never downgrade it and never remove it. The pkg payload stages the incoming +# app under .incoming; here we promote it to the live location only if it is +# strictly newer than what's already installed (or nothing is installed yet). +# +set -e + +BASE="/Library/Application Support/Rabien Software/Crash Reporter" +NEW="$BASE/.incoming/CrashReporter.app" +LIVE="$BASE/CrashReporter.app" +PB="/usr/libexec/PlistBuddy" + +version_of () { # $1 = .app path -> prints CFBundleShortVersionString or 0 + if [ -d "$1" ]; then + "$PB" -c "Print :CFBundleShortVersionString" "$1/Contents/Info.plist" 2>/dev/null || echo 0 + else + echo 0 + fi +} + +if [ -d "$NEW" ]; then + newver="$(version_of "$NEW")" + livever="$(version_of "$LIVE")" + + # Promote if nothing installed, or the incoming build is strictly newer. + highest="$(printf '%s\n%s\n' "$livever" "$newver" | sort -V | tail -1)" + if [ ! -d "$LIVE" ] || { [ "$highest" = "$newver" ] && [ "$newver" != "$livever" ]; }; then + rm -rf "$LIVE" + mv "$NEW" "$LIVE" + fi +fi + +# Always clear the staging area. +rm -rf "$BASE/.incoming" + +exit 0 diff --git a/Installer/win/Wavetable.iss b/Installer/win/Wavetable.iss index 6f3e732..133a24a 100644 --- a/Installer/win/Wavetable.iss +++ b/Installer/win/Wavetable.iss @@ -56,6 +56,7 @@ Name: "vst"; Description: "VST plug-in"; Types: full cu Name: "vst3"; Description: "VST3 plug-in"; Types: full custom; Flags: checkablealone Name: "clap"; Description: "CLAP plug-in"; Types: full custom; Flags: checkablealone Name: "resources"; Description: "Factory wavetables and presets"; Types: full custom; Flags: fixed +Name: "crashreporter"; Description: "Crash reporter (shared component, only updated if newer)"; Types: full custom; Flags: checkablealone [InstallDelete] Type: files; Name: "{commoncf64}\VST2\Wavetable.dll"; Components: vst @@ -74,3 +75,10 @@ Source: "bin\CLAP\Wavetable.clap"; DestDir: "{commoncf64}\CLAP"; ; Presets are flattened by Installer/build.sh into Installer/_flat_presets/. Source: "..\_flat_presets\*.xml"; DestDir: "{commonappdata}\SocaLabs\Wavetable\Presets\"; Flags: ignoreversion; Components: resources Source: "..\..\plugin\Resources\WavetablesFLAC\*.wt2048"; DestDir: "{commonappdata}\SocaLabs\Wavetable\Wavetables\"; Flags: ignoreversion recursesubdirs createallsubdirs; Components: resources + +; CrashReporter app → C:\Program Files\Rabien Software\Crash Reporter, plus this +; plugin's registration JSON → C:\ProgramData\Rabien Software\Crash Reporter\Plugins. +; Shared across plugins: the app is only updated if newer and never removed on +; uninstall; the registration JSON is always installed and never removed. +Source: "bin\CrashReporter\CrashReporter.exe"; DestDir: "{commonpf}\Rabien Software\Crash Reporter"; Flags: skipifsourcedoesntexist uninsneveruninstall; Components: crashreporter +Source: "bin\CrashReporter\wavetable.json"; DestDir: "{commonappdata}\Rabien Software\Crash Reporter\Plugins"; Flags: ignoreversion uninsneveruninstall diff --git a/VERSION b/VERSION index 08a69b5..c1cf2f9 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.0.32 \ No newline at end of file +1.0.33 \ No newline at end of file diff --git a/plugin/Source/PluginProcessor.cpp b/plugin/Source/PluginProcessor.cpp index 1d6d488..00f6604 100644 --- a/plugin/Source/PluginProcessor.cpp +++ b/plugin/Source/PluginProcessor.cpp @@ -2,6 +2,29 @@ #include "PluginEditor.h" #include "WavetableVoice.h" +#include + +// If the shared CrashReporter is installed, launch it once per process (on the +// first plugin instance) so it can scan and upload any crash from last session. +static void launchCrashReporterOnce() +{ + static std::once_flag flag; + std::call_once (flag, [] + { + #if JUCE_MAC + juce::File app ("/Library/Application Support/Rabien Software/Crash Reporter/CrashReporter.app"); + #elif JUCE_WINDOWS + auto app = juce::File::getSpecialLocation (juce::File::globalApplicationsDirectory) + .getChildFile ("Rabien Software").getChildFile ("Crash Reporter").getChildFile ("CrashReporter.exe"); + #else + juce::File app; + #endif + + if (app.exists()) + juce::Process::openDocument (app.getFullPathName(), {}); + }); +} + static juce::String subTextFunction (const gin::Parameter&, float v) { switch (int (v)) @@ -563,6 +586,8 @@ WavetableAudioProcessor::WavetableAudioProcessor() fireAmp (FXBaseCallback ([this] { return gin::Processor::getSampleRate(); })), grindAmp (FXBaseCallback ([this] { return gin::Processor::getSampleRate(); })) { + launchCrashReporterOnce(); + // One-time migration of any user presets from the pre-installer location. // Factory presets now live in systemResourceRoot()/Presets and are surfaced // via getFactoryProgramDirectories(). User saves go to userResourceRoot()/Presets. From afa366e9e166b88516c0ad280ddd4e1fd85dc3f8 Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Thu, 16 Jul 2026 18:36:32 -0700 Subject: [PATCH 14/21] Update Gin and JUCE --- modules/gin | 2 +- modules/juce | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/gin b/modules/gin index 94fee5b..32f47f6 160000 --- a/modules/gin +++ b/modules/gin @@ -1 +1 @@ -Subproject commit 94fee5b72348976107f6d7c751b1c4f632cf6bf0 +Subproject commit 32f47f63ad3fb3d53b1d7928fc8465ad8bd48b29 diff --git a/modules/juce b/modules/juce index bc7339f..2cdfca8 160000 --- a/modules/juce +++ b/modules/juce @@ -1 +1 @@ -Subproject commit bc7339fe07ca1ef7d4708cb6a124932de4af3719 +Subproject commit 2cdfca8feb300fb424002ba2c2751569e5bacb64 From 8292f10db2e8bff14952b6a40c6cc88d99153bec Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Sun, 19 Jul 2026 07:51:19 -0700 Subject: [PATCH 15/21] Upload symbols from release step; bump to 1.0.34 --- .github/workflows/release.yaml | 2 +- Changelist.txt | 3 +++ Installer/build.sh | 20 ++------------------ VERSION | 2 +- release.sh | 17 +++++++++++++++++ 5 files changed, 24 insertions(+), 20 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index c48a2a8..b651fb4 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -53,7 +53,6 @@ jobs: AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }} AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }} AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }} - SYMBOL_API_KEY: ${{ secrets.SYMBOL_API_KEY }} - name: Upload Artifact uses: actions/upload-artifact@v4 @@ -80,3 +79,4 @@ jobs: env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} APIKEY: ${{ secrets.APIKEY }} + SYMBOL_API_KEY: ${{ secrets.SYMBOL_API_KEY }} diff --git a/Changelist.txt b/Changelist.txt index b3babb2..d3f543d 100644 --- a/Changelist.txt +++ b/Changelist.txt @@ -1,3 +1,6 @@ +1.0.34: +- Crash reporting improvements + 1.0.33: - Added crash reporting diff --git a/Installer/build.sh b/Installer/build.sh index e559fe2..3aa595b 100755 --- a/Installer/build.sh +++ b/Installer/build.sh @@ -23,8 +23,8 @@ VERSION=$(cat "$PROJECT_ROOT/VERSION") # # Crash reporting: bundle the latest CrashReporter app + this plugin's -# registration JSON, and upload debug symbols so crashes can be symbolicated. -# SYMBOL_API_KEY - CI secret, authorises symbol upload for this plugin. +# registration JSON. Debug symbols are zipped into bin/ and uploaded later by +# the release job (release.sh), never from this build. # The CrashReporter download is a public distribution channel (no key needed). # CRASH_BASE="https://crashreports.rabiensoftware.com" @@ -45,18 +45,6 @@ fetch_reporter () { # $1 platform, $2 output file return 1 } -# Upload a symbols archive for this plugin/version. Skipped if the key is unset. -upload_symbols () { # $1 platform, $2 zip file - if [ -z "${SYMBOL_API_KEY:-}" ]; then echo "SYMBOL_API_KEY not set — skipping symbol upload"; return 0; fi - if [ ! -f "$2" ]; then echo "No symbol archive $2 — skipping"; return 0; fi - echo "Uploading $1 symbols for $VERSION" - # Non-fatal: a symbol-upload failure must never break a release build. - curl -fsS -H "X-API-Key: $SYMBOL_API_KEY" \ - -F "platform=$1" -F "version=$VERSION" -F "files[]=@$(curl_path "$2")" \ - "$CRASH_BASE/symbols/" || echo "WARNING: symbol upload failed" - echo -} - # # Reset staging # @@ -268,8 +256,6 @@ if [ "$PLATFORM" = "macOS" ]; then VST3/$PLUGIN.vst3.dSYM \ CLAP/$PLUGIN.clap.dSYM 2>/dev/null || true - upload_symbols mac "$PROJECT_ROOT/bin/Symbols_Mac.zip" - ############################################################ # Linux — cpack DEB (VST + VST3 + LV2 + CLAP + Resources) ############################################################ @@ -378,6 +364,4 @@ else cp "$ART_DIR/VST3/$PLUGIN.pdb" "$SYM_DIR/VST3/" 2>/dev/null || true cp "$ART_DIR/CLAP/$PLUGIN.pdb" "$SYM_DIR/CLAP/" 2>/dev/null || true ( cd "$SYM_DIR" && 7z a "$PROJECT_ROOT/bin/Symbols_Win.zip" VST VST3 CLAP ) - - upload_symbols win "$PROJECT_ROOT/bin/Symbols_Win.zip" fi diff --git a/VERSION b/VERSION index c1cf2f9..ffcbe71 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.0.33 \ No newline at end of file +1.0.34 diff --git a/release.sh b/release.sh index f39f24a..d86c90c 100755 --- a/release.sh +++ b/release.sh @@ -26,6 +26,23 @@ fi echo "$NOTES" > /tmp/release_notes.txt +# --- Debug symbols -> crash server ------------------------------------------- +# Uploaded here (not the build job) so a failed upload fails the release. The +# server stores symbols write-once per (plugin, platform, version): a re-tagged +# or rebuilt version whose symbols already exist returns 409 and fails the +# release loudly — delete the stale symbols in the crash site, then re-run. +CRASH_BASE="https://crashreports.rabiensoftware.com" +upload_symbols () { # $1 platform, $2 zip + if [ ! -f "$2" ]; then echo "Error: expected symbols $2 not found"; exit 1; fi + echo "Uploading $1 symbols for $VER" + curl -sS --fail-with-body -H "X-API-Key: $SYMBOL_API_KEY" \ + -F "platform=$1" -F "version=$VER" -F "files[]=@$2" \ + "$CRASH_BASE/symbols/" + echo +} +upload_symbols mac "./Binaries macOS/Symbols_Mac.zip" +upload_symbols win "./Binaries Windows/Symbols_Win.zip" + ASSETS=( "./Binaries Linux"/*.deb "./Binaries Windows"/*.exe From 62f2788c8a937b5d8e81695bdd4c7f95154034e8 Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Tue, 21 Jul 2026 08:44:25 -0700 Subject: [PATCH 16/21] Update JUCE --- modules/juce | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/juce b/modules/juce index 2cdfca8..f8f8864 160000 --- a/modules/juce +++ b/modules/juce @@ -1 +1 @@ -Subproject commit 2cdfca8feb300fb424002ba2c2751569e5bacb64 +Subproject commit f8f8864172464b9adf9eba6101e1f784838d1597 From e34c58fc8fa9c873ce425e48b1be3c6095d00f14 Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Tue, 21 Jul 2026 08:45:24 -0700 Subject: [PATCH 17/21] Update Gin --- modules/gin | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/gin b/modules/gin index 32f47f6..414fecf 160000 --- a/modules/gin +++ b/modules/gin @@ -1 +1 @@ -Subproject commit 32f47f63ad3fb3d53b1d7928fc8465ad8bd48b29 +Subproject commit 414fecf9c28e72a9a5a4ac188f0fc6ef2e83eb2a From ba6e7b59cac29453916a9b8f634c09267a5a0dc0 Mon Sep 17 00:00:00 2001 From: Roland Rabien Date: Tue, 21 Jul 2026 13:43:12 -0700 Subject: [PATCH 18/21] Update clap-juce-extensions --- modules/clap-juce-extensions | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/clap-juce-extensions b/modules/clap-juce-extensions index e44a9e5..26bab6b 160000 --- a/modules/clap-juce-extensions +++ b/modules/clap-juce-extensions @@ -1 +1 @@ -Subproject commit e44a9e53ea8d22e2fbe2f366921d494534bb2b52 +Subproject commit 26bab6be8c428ba9537fdd2fd80d2dbb07dd9164 From 5797f8b8b7fcaa95d754cc5651b4cb54ffa631ca Mon Sep 17 00:00:00 2001 From: Armin Date: Tue, 28 Jul 2026 16:27:38 +0200 Subject: [PATCH 19/21] add modules to gitignore, remove tracked modules --- .gitignore | 6 +- AGENTS.md | 174 ++++++++++++++++++++ Installer/build.sh | 44 ++--- Installer/win/Wavetable.iss | 2 +- README.md | 292 ++++++++++++++++++++++++++++++++- modules/MTS-ESP | 1 - modules/clap-juce-extensions | 1 - modules/gin | 1 - modules/juce | 1 - modules/melatonin_inspector | 1 - modules/plugin_sdk | 1 - plugin/Source/PluginEditor.cpp | 2 +- 12 files changed, 488 insertions(+), 38 deletions(-) create mode 100644 AGENTS.md delete mode 160000 modules/MTS-ESP delete mode 160000 modules/clap-juce-extensions delete mode 160000 modules/gin delete mode 160000 modules/juce delete mode 160000 modules/melatonin_inspector delete mode 160000 modules/plugin_sdk diff --git a/.gitignore b/.gitignore index 9d078de..792c923 100644 --- a/.gitignore +++ b/.gitignore @@ -38,4 +38,8 @@ Installer/macOS/bin Installer/win/bin Installer/_flat_presets .DS_Store -.claude \ No newline at end of file +.claude + +# modules +modules + diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..6814a83 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,174 @@ +# AGENTS.md — Wavetable Synth Project Context + +## Project Overview + +Wavetable is a polyphonic wavetable synthesizer audio plugin (VST3, AU, CLAP, LV2, Standalone) built with **JUCE** and the **Gin** framework. It's developed by SocaLabs (Roland Rabien). + +- **Version**: 1.0.34 (tracked in `VERSION` file) +- **Language**: C++20 +- **Build system**: CMake (minimum 3.24) +- **Bundle ID**: `com.socalabs.wavetable` + +## Repository Structure + +``` +Wavetable/ +├── CMakeLists.txt # Main build config +├── CMakePresets.json # Presets: xcode (macOS), vs (Windows), ninja-gcc (Linux) +├── VERSION # Current version string +├── Changelist.txt # Version history (used by release.sh) +├── release.sh # GitHub release script +├── tag.sh # Tags current VERSION and pushes +├── plugin/ +│ ├── Source/ +│ │ ├── PluginProcessor.h/cpp # Main processor (WavetableAudioProcessor) +│ │ ├── PluginEditor.h/cpp # Editor (WavetableAudioProcessorEditor) +│ │ ├── Editor.h/cpp # Main UI layout component +│ │ ├── Panels.h # All section UI boxes (OscillatorBox, FilterBox, etc.) +│ │ ├── WavetableVoice.h/cpp # Synth voice +│ │ ├── Cfg.h # Compile-time constants +│ │ └── FX/ # Custom FX (DeRez2, FireAmp, GrindAmp) +│ └── Resources/ +│ ├── layout.json # UI layout +│ ├── Presets/ # Factory presets (XML, per-category subdirs) +│ ├── Wavetables/ # Factory wavetables +│ └── WavetablesFLAC/ # FLAC-compressed wavetables +├── modules/ # Git submodules +│ ├── gin/ # Gin framework (core dependency) +│ ├── juce/ # JUCE framework +│ ├── clap-juce-extensions/ # CLAP format support +│ ├── MTS-ESP/ # Microtuning support +│ ├── plugin_sdk/ # VST2 SDK (optional) +│ └── melatonin_inspector/ # Debug UI inspector +├── installer/ +│ ├── build.sh # Full installer build script (macOS/Linux/Windows) +│ ├── macOS/ # macOS pkg installer resources +│ └── win/ # Windows Inno Setup installer +└── .github/workflows/ + ├── build.yaml # CI build on push + └── release.yaml # Release build on tag push +``` + +## Key Architecture + +### Plugin Core +- **`WavetableAudioProcessor`** (`plugin/Source/PluginProcessor.h`) — inherits `gin::Processor` + `gin::Synthesiser` +- **`WavetableAudioProcessorEditor`** (`plugin/Source/PluginEditor.h`) — inherits `gin::ProcessorEditor` +- **`Editor`** (`plugin/Source/Editor.h`) — the main content component with all section boxes + +### UI Panels (Panels.h) +All section UIs are `gin::ParamBox` subclasses: +- `OscillatorBox` — wavetable osc with navigation buttons in header +- `SubBox`, `NoiseBox` — simple boxes +- `FilterBox` — complex with ADSR, routing buttons +- `ADSRBox` — envelope display + knobs +- `LFOBox`, `ENVBox` — tabbed (addHeader with HeaderButton) +- `StepBox` — step sequencer +- `ModBox`, `MatrixBox` — modulation source/matrix tabs +- `GlobalBox` — global controls +- FX boxes: `GateBox`, `ChorusBox`, `DistortBox`, `DelayBox`, `ReverbBox` + +### Gin Framework (submodule) +- **`gin::ParamBox`** (`modules/gin/.../gin_parambox.h`) — base for all section boxes +- **`gin::ParamHeader`** — header bar with gradient background + label text +- **`gin::CopperLookAndFeel`** (`modules/gin/.../gin_copperlookandfeel.cpp`) — default LookAndFeel +- **Colors**: title1/title2 (header gradient), matte1/matte2 (body gradient), accent (copper) +- **`gradientRect()`** helper — vertical linear gradient fill + +### Custom LookAndFeel +The project uses `gin::CopperLookAndFeel` by default (set in `gin_processor.cpp`). Colors can be overridden per-component via `findColour()`. + +**Important**: `ParamHeader::paint()` is **private** and has hardcoded font size and gradient colors. To customize header appearance, you must edit `gin_parambox.h` directly in the submodule. This is a local modification that will be overwritten on `git submodule update`. + +## Build Instructions + +### Quick Build (macOS) +```bash +git clone --recursive https://github.com/FigBug/Wavetable.git +cd Wavetable +cmake --preset xcode +cmake --build --preset xcode --config Release +# Output: Builds/xcode/Wavetable_artefacts/Release/ +``` + +### CMake Presets +- **macOS**: `xcode` — generates Xcode project, builds universal (arm64 + x86_64) +- **Windows**: `vs` — generates Visual Studio solution +- **Linux**: `ninja-gcc` — generates Ninja build files with GCC + +### Build Outputs (macOS) +``` +Builds/xcode/Wavetable_artefacts/Release/ +├── Standalone/Wavetable.app +├── VST/Wavetable.vst +├── VST3/Wavetable.vst3 +├── AU/Wavetable.component +└── CLAP/Wavetable.clap +``` + +### Installer (macOS) +```bash +./installer/build.sh +# Output: installer/macOS/bin/Wavetable.pkg +# Requires Xcode CLI tools; signing/notarization optional (needs secrets) +``` + +The installer pkg installs: +- VST → `/Library/Audio/Plug-Ins/VST/` +- VST3 → `/Library/Audio/Plug-Ins/VST3/` +- AU → `/Library/Audio/Plug-Ins/Components/` +- CLAP → `/Library/Audio/Plug-Ins/CLAP/` +- Factory wavetables + presets → `/Library/Audio/Presets/SocaLabs/Wavetable/` + +### Manual Plugin Install (macOS, no installer) +Copy built bundles manually: +```bash +cp -R Builds/xcode/Wavetable_artefacts/Release/AU/Wavetable.component ~/Library/Audio/Plug-Ins/Components/ +cp -R Builds/xcode/Wavetable_artefacts/Release/VST3/Wavetable.vst3 ~/Library/Audio/Plug-Ins/VST3/ +cp -R Builds/xcode/Wavetable_artefacts/Release/CLAP/Wavetable.clap ~/Library/Audio/Plug-Ins/CLAP/ +``` +Factory resources: +```bash +mkdir -p ~/Library/Audio/Presets/SocaLabs/Wavetable +cp -R plugin/Resources/WavetablesFLAC ~/Library/Audio/Presets/SocaLabs/Wavetable/Wavetables +# Presets (flatten subdirs): +find plugin/Resources/Presets -name "*.xml" -exec cp {} ~/Library/Audio/Presets/SocaLabs/Wavetable/ \; +``` + +## Release Process + +1. Update `VERSION` file +2. Add changelog entry in `Changelist.txt` under the version +3. Commit and push +4. Run `./tag.sh` — tags `v{VERSION}` and pushes the tag +5. GitHub Actions (`release.yaml`) builds installers for all platforms +6. `release.sh` creates a GitHub release and uploads to socalabs.com + +## Submodule Notes + +The Gin submodule is pinned at commit `414fecf`. Local modifications to Gin files (e.g., `gin_parambox.h`, `gin_copperlookandfeel.cpp`) are intentional and should not be committed to the submodule. Be aware that `git submodule update` will overwrite these changes. + +## Coding Conventions + +- Standard JUCE/Gin code style (camelCase methods, PascalCase classes) +- `gin::Parameter::Ptr` for all synth parameters +- `gin::ParamBox` subclassed for each UI section +- Parameters defined as nested structs in `WavetableAudioProcessor` (e.g., `OSCParams`, `FilterParams`) +- No comments unless explicitly requested +- Build with `-ffast-math -fno-finite-math-only` on macOS/Release + +## Common Tasks + +### Changing header label appearance +Edit `modules/gin/modules/gin_plugin/components/gin_parambox.h` → `ParamHeader::paint()`. The font and gradient are hardcoded there. + +### Changing header gradient colors +Edit `modules/gin/modules/gin_plugin/lookandfeel/gin_copperlookandfeel.cpp` → `title1ColourId` / `title2ColourId` in constructor. + +### Adding new parameters +1. Add to the relevant Params struct in `PluginProcessor.h` +2. Initialize in `PluginProcessor.cpp` (`setup()` method) +3. Add UI control in the appropriate Box class in `Panels.h` + +### Changing UI layout +Edit `plugin/Resources/layout.json` — positions are grid-based (56px columns, 70px rows, 23px header height). diff --git a/Installer/build.sh b/Installer/build.sh index 3aa595b..43dca8b 100755 --- a/Installer/build.sh +++ b/Installer/build.sh @@ -48,8 +48,8 @@ fetch_reporter () { # $1 platform, $2 output file # # Reset staging # -rm -Rf "$PROJECT_ROOT/Installer/$PLATFORM/bin" -mkdir -p "$PROJECT_ROOT/Installer/$PLATFORM/bin" +rm -Rf "$PROJECT_ROOT/installer/$PLATFORM/bin" +mkdir -p "$PROJECT_ROOT/installer/$PLATFORM/bin" rm -Rf "$PROJECT_ROOT/bin" mkdir -p "$PROJECT_ROOT/bin" @@ -58,7 +58,7 @@ mkdir -p "$PROJECT_ROOT/bin" # gin's loadDirectory() doesn't recurse, and the legacy BinaryData flow stored # presets flat in the user directory — keeping flat matches what users see. # -FLAT_PRESETS="$PROJECT_ROOT/Installer/_flat_presets" +FLAT_PRESETS="$PROJECT_ROOT/installer/_flat_presets" rm -Rf "$FLAT_PRESETS" mkdir -p "$FLAT_PRESETS" find "$PROJECT_ROOT/plugin/Resources/Presets" -name "*.xml" -type f -exec cp {} "$FLAT_PRESETS/" \; @@ -101,8 +101,8 @@ if [ "$PLATFORM" = "macOS" ]; then cmake --preset xcode cmake --build --preset xcode --config Release - STAGE="$PROJECT_ROOT/Installer/macOS/bin/stage" - PKG_DIR="$PROJECT_ROOT/Installer/macOS/bin/pkgs" + STAGE="$PROJECT_ROOT/installer/macOS/bin/stage" + PKG_DIR="$PROJECT_ROOT/installer/macOS/bin/pkgs" rm -Rf "$STAGE" "$PKG_DIR" mkdir -p "$STAGE/vst" "$STAGE/vst3" "$STAGE/au" "$STAGE/clap" mkdir -p "$STAGE/resources/Library/Audio/Presets/$VENDOR/$PLUGIN" @@ -166,13 +166,13 @@ if [ "$PLATFORM" = "macOS" ]; then --install-location "/" \ --identifier "${BUNDLE_BASE}.resources.pkg" \ --version "$VERSION" \ - --scripts "$PROJECT_ROOT/Installer/macOS/scripts" \ + --scripts "$PROJECT_ROOT/installer/macOS/scripts" \ "$PKG_DIR/resources.pkg" # CrashReporter component: latest signed CrashReporter.app + this plugin's # registration JSON. Staged under .incoming and promoted by the postinstall # only if strictly newer (shared component, never downgraded). - REP_STAGE="$PROJECT_ROOT/Installer/macOS/bin/reporter" + REP_STAGE="$PROJECT_ROOT/installer/macOS/bin/reporter" REP_ROOT="$REP_STAGE/Library/Application Support/Rabien Software/Crash Reporter" rm -Rf "$REP_STAGE" mkdir -p "$REP_ROOT/Plugins" "$REP_ROOT/.incoming" @@ -180,34 +180,34 @@ if [ "$PLATFORM" = "macOS" ]; then ( cd "$REP_STAGE" && unzip -qo CrashReporter_Mac.zip && rm CrashReporter_Mac.zip ) mv "$REP_STAGE/CrashReporter.app" "$REP_ROOT/.incoming/" fi - cp "$PROJECT_ROOT/Installer/crashreporter.json" "$REP_ROOT/Plugins/wavetable.json" + cp "$PROJECT_ROOT/installer/crashreporter.json" "$REP_ROOT/Plugins/wavetable.json" find "$REP_STAGE" -name ".DS_Store" -delete if [ -n "${APPLICATION:-}" ] && [ -d "$REP_ROOT/.incoming/CrashReporter.app" ]; then codesign -s "$DEV_APP_ID" --options=runtime --timestamp --force -v "$REP_ROOT/.incoming/CrashReporter.app" fi - chmod +x "$PROJECT_ROOT/Installer/macOS/reporter-scripts/postinstall" + chmod +x "$PROJECT_ROOT/installer/macOS/reporter-scripts/postinstall" # Disable bundle relocation so the installer installs to our staged path # instead of redirecting to a CrashReporter.app found elsewhere via Spotlight. - COMP_PLIST="$PROJECT_ROOT/Installer/macOS/bin/reporter-component.plist" + COMP_PLIST="$PROJECT_ROOT/installer/macOS/bin/reporter-component.plist" pkgbuild --analyze --root "$REP_STAGE" "$COMP_PLIST" /usr/libexec/PlistBuddy -c "Set :0:BundleIsRelocatable false" "$COMP_PLIST" 2>/dev/null || true pkgbuild --root "$REP_STAGE" --install-location "/" \ --identifier "${BUNDLE_BASE}.crashreporter.pkg" --version "$VERSION" \ --component-plist "$COMP_PLIST" \ - --scripts "$PROJECT_ROOT/Installer/macOS/reporter-scripts" \ + --scripts "$PROJECT_ROOT/installer/macOS/reporter-scripts" \ "$PKG_DIR/reporter.pkg" # productbuild — combine into one signed installer - cp "$PROJECT_ROOT/Installer/EULA.rtf" "$PKG_DIR/EULA.rtf" - cp "$PROJECT_ROOT/Installer/macOS/welcome.txt" "$PKG_DIR/welcome.txt" + cp "$PROJECT_ROOT/installer/EULA.rtf" "$PKG_DIR/EULA.rtf" + cp "$PROJECT_ROOT/installer/macOS/welcome.txt" "$PKG_DIR/welcome.txt" - PKG_OUT="$PROJECT_ROOT/Installer/macOS/bin/${PLUGIN}.pkg" + PKG_OUT="$PROJECT_ROOT/installer/macOS/bin/${PLUGIN}.pkg" - productbuild --distribution "$PROJECT_ROOT/Installer/macOS/distribution.xml" \ + productbuild --distribution "$PROJECT_ROOT/installer/macOS/distribution.xml" \ --package-path "$PKG_DIR" \ --resources "$PKG_DIR" \ --version "$VERSION" \ @@ -278,7 +278,7 @@ else cmake --build --preset vs --config Release ART_DIR="$PROJECT_ROOT/Builds/vs/${PLUGIN}_artefacts/Release" - STAGE="$PROJECT_ROOT/Installer/win/bin" + STAGE="$PROJECT_ROOT/installer/win/bin" rm -Rf "$STAGE" mkdir -p "$STAGE/VST" "$STAGE/VST3" "$STAGE/CLAP" @@ -292,12 +292,12 @@ else if fetch_reporter win "$REP_DIR/CrashReporter_Win.zip"; then ( cd "$REP_DIR" && 7z x -y CrashReporter_Win.zip >/dev/null && rm CrashReporter_Win.zip ) fi - cp "$PROJECT_ROOT/Installer/crashreporter.json" "$REP_DIR/wavetable.json" + cp "$PROJECT_ROOT/installer/crashreporter.json" "$REP_DIR/wavetable.json" # # Sign binaries via Microsoft Trusted Signing. # Required env: AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET. - # Cert is referenced via Installer/win/metadata.json. + # Cert is referenced via installer/win/metadata.json. # uuid_re='^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' WIN_SIGN=0 @@ -325,7 +325,7 @@ else nuget install Microsoft.Trusted.Signing.Client -Version 1.0.86 \ -OutputDirectory "$TOOLS_DIR" -ExcludeVersion -NonInteractive DLIB="$TOOLS_DIR/Microsoft.Trusted.Signing.Client/bin/x64/Azure.CodeSigning.Dlib.dll" - METADATA="$PROJECT_ROOT/Installer/win/metadata.json" + METADATA="$PROJECT_ROOT/installer/win/metadata.json" sign_file () { "$SIGNTOOL" sign -v -fd SHA256 \ @@ -341,14 +341,14 @@ else fi # Build installer .exe - cd "$PROJECT_ROOT/Installer/win" + cd "$PROJECT_ROOT/installer/win" ISCC="/c/Program Files (x86)/Inno Setup 6/ISCC.exe" if [ ! -f "$ISCC" ]; then ISCC="/c/Program Files/Inno Setup 6/ISCC.exe" fi - "$ISCC" "$PROJECT_ROOT/Installer/win/${PLUGIN}.iss" + "$ISCC" "$PROJECT_ROOT/installer/win/${PLUGIN}.iss" - EXE_OUT="$PROJECT_ROOT/Installer/win/bin/${PLUGIN}.exe" + EXE_OUT="$PROJECT_ROOT/installer/win/bin/${PLUGIN}.exe" # Sign installer if [ "$WIN_SIGN" = "1" ]; then diff --git a/Installer/win/Wavetable.iss b/Installer/win/Wavetable.iss index 133a24a..1aa5ae1 100644 --- a/Installer/win/Wavetable.iss +++ b/Installer/win/Wavetable.iss @@ -72,7 +72,7 @@ Source: "bin\VST3\Wavetable.vst3\*"; DestDir: "{commoncf64}\VST3\Wavetable.vst3\ Source: "bin\CLAP\Wavetable.clap"; DestDir: "{commoncf64}\CLAP"; Flags: ignoreversion overwritereadonly; Components: clap ; Factory content (Wavetables, Presets) → C:\ProgramData\SocaLabs\Wavetable\ -; Presets are flattened by Installer/build.sh into Installer/_flat_presets/. +; Presets are flattened by installer/build.sh into installer/_flat_presets/. Source: "..\_flat_presets\*.xml"; DestDir: "{commonappdata}\SocaLabs\Wavetable\Presets\"; Flags: ignoreversion; Components: resources Source: "..\..\plugin\Resources\WavetablesFLAC\*.wt2048"; DestDir: "{commonappdata}\SocaLabs\Wavetable\Wavetables\"; Flags: ignoreversion recursesubdirs createallsubdirs; Components: resources diff --git a/README.md b/README.md index 1a3feb1..7c380c5 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A 2 oscillator wavetable synthesizer with flexible modulation options. -![Screenshot](Screenshots/Screenshot1.png) +![Screenshot](screenshots/Screenshot1.png) [Download](https://github.com/FigBug/Wavetable/releases) | [Product Page](https://socalabs.com/synths/Wavetable/) @@ -48,22 +48,300 @@ A 2 oscillator wavetable synthesizer with flexible modulation options. - VST3 - VST2 (requires VST2 SDK) - AU (macOS) +- CLAP - LV2 - Standalone -## Building +## System Requirements -Requirements: -- CMake 3.16+ -- C++20 compatible compiler +- macOS 10.13 or later +- Windows 10 or later +- Linux (Ubuntu 20.04 or compatible) + +--- + +## Building on macOS (ARM64 / Apple Silicon) + +### Prerequisites + +- Xcode (with Command Line Tools) +- CMake 3.24+ (`brew install cmake`) +- Git + +### Clone & Build ```bash git clone --recursive https://github.com/FigBug/Wavetable.git cd Wavetable -cmake -B build -cmake --build build --config Release + +# Configure (generates Xcode project, universal arm64 + x86_64) +cmake --preset xcode + +# Build Release +cmake --build --preset xcode --config Release ``` +Build products are in `Builds/xcode/Wavetable_artefacts/Release/`: + +| Format | Path | +|--------|------| +| Standalone | `Standalone/Wavetable.app` | +| VST | `VST/Wavetable.vst` | +| VST3 | `VST3/Wavetable.vst3` | +| AU | `AU/Wavetable.component` | +| CLAP | `CLAP/Wavetable.clap` | + +### Install via Installer (.pkg) + +Build the signed/notarized installer (or unsigned for local use): + +```bash +./installer/build.sh +# Output: installer/macOS/bin/Wavetable.pkg +``` + +Open `Wavetable.pkg` and follow the installer. It installs: + +| Component | Install Location | +|-----------|-----------------| +| VST | `/Library/Audio/Plug-Ins/VST/` | +| VST3 | `/Library/Audio/Plug-Ins/VST3/` | +| AU | `/Library/Audio/Plug-Ins/Components/` | +| CLAP | `/Library/Audio/Plug-Ins/CLAP/` | +| Factory wavetables & presets | `/Library/Audio/Presets/SocaLabs/Wavetable/` | + +### Install Manually (no installer) + +Copy the built bundles to the system plugin directories: + +```bash +# AU (Logic Pro, GarageBand) +cp -R Builds/xcode/Wavetable_artefacts/Release/AU/Wavetable.component \ + ~/Library/Audio/Plug-Ins/Components/ + +# VST3 (Ableton Live, Reaper, Bitwig, etc.) +cp -R Builds/xcode/Wavetable_artefacts/Release/VST3/Wavetable.vst3 \ + ~/Library/Audio/Plug-Ins/VST3/ + +# CLAP (Ableton Live 12+, Bitwig, Reaper) +cp -R Builds/xcode/Wavetable_artefacts/Release/CLAP/Wavetable.clap \ + ~/Library/Audio/Plug-Ins/CLAP/ + +# VST (legacy) +cp -R Builds/xcode/Wavetable_artefacts/Release/VST/Wavetable.vst \ + ~/Library/Audio/Plug-Ins/VST/ +``` + +Install factory wavetables and presets: + +```bash +mkdir -p ~/Library/Audio/Presets/SocaLabs/Wavetable +cp -R plugin/Resources/WavetablesFLAC \ + ~/Library/Audio/Presets/SocaLabs/Wavetable/Wavetables + +# Presets must be flattened (subdirectories are not scanned by the plugin) +find plugin/Resources/Presets -name "*.xml" -exec \ + cp {} ~/Library/Audio/Presets/SocaLabs/Wavetable/ \; +``` + +After copying, rescan plugins in your DAW. For AU, you may need to log out and back in, or run: + +```bash +killall -9 AudioComponentRegistrar +``` + +--- + +## Parameter Reference + +### Oscillators + +Two identical wavetable oscillators provide the main sound source. + +| Parameter | Range | Description | +|-----------|-------|-------------| +| Enable | On/Off | Enable or disable the oscillator | +| Wavetable | - | Select from built-in wavetables or load custom WAV files | +| Tune | -36 to +36 semitones | Coarse pitch adjustment | +| Fine | -100 to +100 cents | Fine pitch adjustment | +| Level | -100 to 0 dB | Oscillator volume | +| Pos | 0-100% | Wavetable position - morphs through the wavetable frames | +| Pan | -100% to +100% | Stereo panning | +| Formant | -1.0 to +1.0 | Formant shifting for tonal variation | +| Bend | -1.0 to +1.0 | Pitch bend modulation amount | +| Voices | 1-8 | Number of unison voices | +| Detune | 0-0.5 | Pitch spread between unison voices (enabled when Voices > 1) | +| Spread | -100% to +100% | Stereo spread of unison voices (enabled when Voices > 1) | +| Retrig | On/Off | Retrigger oscillator phase on each new note | + +**Tip:** Drag on the wavetable display to adjust the position in real-time. + +### Sub-Oscillator + +| Parameter | Range | Description | +|-----------|-------|-------------| +| Enable | On/Off | Enable or disable the sub-oscillator | +| Wave | Sine, Triangle, Saw Up, Pulse 50%, Pulse 25%, Pulse 12% | Waveform selection | +| Tune | -36 to +36 semitones | Pitch adjustment | +| Level | -100 to 0 dB | Volume | +| Pan | -100% to +100% | Stereo panning | +| Retrig | On/Off | Retrigger phase on new notes | + +### Noise Generator + +| Parameter | Range | Description | +|-----------|-------|-------------| +| Enable | On/Off | Enable or disable noise | +| Type | White, Pink | Noise color | +| Level | -100 to 0 dB | Volume | +| Pan | -100% to +100% | Stereo panning | + +### Filter + +Multi-mode filter with envelope control and key/velocity tracking. + +**Filter Types:** LP 12, LP 24, HP 12, HP 24, BP 12, BP 24, NT 12, NT 24 + +| Parameter | Range | Description | +|-----------|-------|-------------| +| Enable | On/Off | Enable or disable the filter | +| Type | See above | Filter type selection | +| Frequency | 20 Hz - 20 kHz | Cutoff frequency | +| Resonance | 0-100% | Filter resonance/Q | +| Key | 0-100% | Keyboard tracking amount | +| Velocity | 0-100% | Velocity to filter frequency modulation | +| Amount | -1.0 to +1.0 | Filter envelope modulation depth | + +**Filter Envelope:** + +| Parameter | Range | Description | +|-----------|-------|-------------| +| Attack | 0-60 seconds | Attack time | +| Decay | 0-60 seconds | Decay time | +| Sustain | 0-100% | Sustain level | +| Release | 0-60 seconds | Release time | +| Retrig | On/Off | Retrigger envelope on new notes | + +**Filter Routing:** Use the routing buttons (WT1, WT2, Sub, Noise) to select which sound sources are processed by the filter. + +### Amplitude Envelope + +| Parameter | Range | Description | +|-----------|-------|-------------| +| Attack | 0-60 seconds | Attack time | +| Decay | 0-60 seconds | Decay time | +| Sustain | 0-100% | Sustain level | +| Release | 0-60 seconds | Release time | +| Velocity | 0-100% | Velocity sensitivity | +| Retrig | On/Off | Retrigger on new notes (mono mode with glide only) | + +### LFOs + +Three independent LFOs with multiple waveforms. + +**Waveforms:** None, Sine, Triangle, Saw Up, Saw Down, Square, Square+, Sample & Hold, Noise, Step Up (3/4/8 steps), Step Down (3/4/8 steps), Pyramid (3/5/9 steps) + +| Parameter | Range | Description | +|-----------|-------|-------------| +| Enable | On/Off | Enable or disable the LFO | +| Wave | See above | Waveform selection | +| Sync | On/Off | Sync to host tempo | +| Rate | 0-50 Hz | LFO speed (when Sync is off) | +| Beat | Note values | LFO speed (when Sync is on) | +| Depth | -1.0 to +1.0 | Modulation amount | +| Phase | -1.0 to +1.0 | Starting phase offset | +| Offset | -1.0 to +1.0 | DC offset/center bias | +| Fade | -60 to +60 seconds | Fade in (positive) or fade out (negative) time | +| Delay | 0-60 seconds | Delay before LFO starts | +| Retrig | On/Off | Retrigger phase on new notes | + +### Modulation Envelopes + +Three independent ADSR envelopes for modulation. + +| Parameter | Range | Description | +|-----------|-------|-------------| +| Enable | On/Off | Enable or disable the envelope | +| Attack | 0-60 seconds | Attack time | +| Decay | 0-60 seconds | Decay time | +| Sustain | 0-100% | Sustain level | +| Release | 0-60 seconds | Release time | +| Retrig | On/Off | Retrigger on new notes | + +### Step LFO + +A 32-step sequencer for rhythmic modulation. + +| Parameter | Range | Description | +|-----------|-------|-------------| +| Enable | On/Off | Enable or disable | +| Beat | Note values | Step clock speed (tempo-synced) | +| Length | 2-32 steps | Number of active steps | +| Retrig | On/Off | Retrigger sequence on new notes | +| Steps 1-32 | -1.0 to +1.0 | Individual step values | + +### Modulation Matrix + +The mod matrix routes any modulation source to any parameter with flexible depth, curve shaping, and polarity controls. + +**Source types:** Single ring = mono (global), double ring = poly (per-voice). + +**MIDI sources:** Pitch Bend (mono), Note Number (poly), Velocity (poly), CC 1-120 (mono) + +**MPE sources (when enabled):** Pressure (poly), Timbre (poly), Pitch Bend (poly) + +**Internal sources:** LFO 1-3 poly/mono, Step LFO poly/mono, Filter Envelope, Mod Envelopes 1-3 + +**Assigning modulation:** +1. **Drag and Drop** - Drag a source icon from the mod source list onto any knob +2. **Learn Mode** - Click a source icon, then click a knob to assign + +**Matrix panel controls:** Enable toggle, depth slider, bipolar button, curve button, delete button. + +**Polarity:** Unipolar (0 to 1) or Bipolar (-1 to +1). + +**Curves:** Linear, Quadratic (In/Out/In-Out), Sine (In/Out/In-Out), Exponential (In/Out/In-Out), plus inverted versions of all. + +### Effects + +Effects can be reordered by dragging. + +**Gate:** Beat, Length (2-16 steps), Attack, Release, L/R step pattern + +**Chorus:** Delay (0.1-30 ms), Rate (0.1-10 Hz), Depth (0.1-20 ms), Width, Mix + +**Distortion:** Simple (Amount), Bitcrusher (Rate/Rez/Hard/Mix), Fire Amp (Gain/Tone/Output/Mix), Grind Amp (Gain/Tone/Output/Mix) + +**Delay:** Sync, Time/Beat, Feedback, Crossfeed, Mix + +**Reverb:** Size, Decay, Lowpass, Damping, Predelay, Mix + +### Global Settings + +| Parameter | Range | Description | +|-----------|-------|-------------| +| Level | -100 to 0 dB | Master output volume | +| Voices | 2-40 | Maximum polyphony | +| Mono | On/Off | Monophonic mode | +| Glide | Off, Glissando, Portamento | Pitch glide mode | +| Glide Time | 0.001-20 seconds | Glide duration | +| Legato | On/Off | Legato mode (mono only) | +| Pitch Bend | 0-48 semitones | MIDI pitch bend range | +| MPE | On/Off | Enable MPE support | + +--- + +## Tips & Tricks + +1. **Rich Pads:** Use both oscillators with different wavetables, slight detune, and long filter envelope +2. **Punchy Basses:** Enable the sub-oscillator, use LP24 filter with short decay envelope +3. **Movement:** Modulate wavetable position with an LFO for evolving textures +4. **Rhythmic Effects:** Use the Step LFO or Gate effect for pulsing sounds +5. **Expression:** Enable MPE and map pressure/timbre to filter cutoff and wavetable position +6. **Layering:** Route oscillators differently through the filter for complex timbres + +--- + ## License The synth is BSD licensed. However, it depends on JUCE. To use in a commercial application, you must have a JUCE license. Wavetables have their own license. diff --git a/modules/MTS-ESP b/modules/MTS-ESP deleted file mode 160000 index 2d7c013..0000000 --- a/modules/MTS-ESP +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 2d7c013ebf4a076c35811e62293e8f819d053a91 diff --git a/modules/clap-juce-extensions b/modules/clap-juce-extensions deleted file mode 160000 index 26bab6b..0000000 --- a/modules/clap-juce-extensions +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 26bab6be8c428ba9537fdd2fd80d2dbb07dd9164 diff --git a/modules/gin b/modules/gin deleted file mode 160000 index 414fecf..0000000 --- a/modules/gin +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 414fecf9c28e72a9a5a4ac188f0fc6ef2e83eb2a diff --git a/modules/juce b/modules/juce deleted file mode 160000 index f8f8864..0000000 --- a/modules/juce +++ /dev/null @@ -1 +0,0 @@ -Subproject commit f8f8864172464b9adf9eba6101e1f784838d1597 diff --git a/modules/melatonin_inspector b/modules/melatonin_inspector deleted file mode 160000 index d0e42b8..0000000 --- a/modules/melatonin_inspector +++ /dev/null @@ -1 +0,0 @@ -Subproject commit d0e42b81bb7b747b0b7b51a993366a1f46ea3a55 diff --git a/modules/plugin_sdk b/modules/plugin_sdk deleted file mode 160000 index bcbef19..0000000 --- a/modules/plugin_sdk +++ /dev/null @@ -1 +0,0 @@ -Subproject commit bcbef199f4dd78b883aebd6477cc104dad850e1b diff --git a/plugin/Source/PluginEditor.cpp b/plugin/Source/PluginEditor.cpp index 565ac4c..aa3f50e 100644 --- a/plugin/Source/PluginEditor.cpp +++ b/plugin/Source/PluginEditor.cpp @@ -102,5 +102,5 @@ void WavetableAudioProcessorEditor::addMenuItems (juce::PopupMenu& m) m.addSeparator(); - m.addItem ("Manual", [] { juce::URL ("https://github.com/FigBug/Wavetable/blob/master/Manual.md").launchInDefaultBrowser(); }); + m.addItem ("Manual", [] { juce::URL ("https://github.com/FigBug/Wavetable/blob/master/README.md").launchInDefaultBrowser(); }); } From 3001ed82719f7094fdad2dc7e627eac734e7fe27 Mon Sep 17 00:00:00 2001 From: Armin Date: Sun, 2 Aug 2026 22:02:11 +0200 Subject: [PATCH 20/21] rename: Screenshots -> screenshots --- {Screenshots => screenshots}/Screenshot1.png | Bin 1 file changed, 0 insertions(+), 0 deletions(-) rename {Screenshots => screenshots}/Screenshot1.png (100%) diff --git a/Screenshots/Screenshot1.png b/screenshots/Screenshot1.png similarity index 100% rename from Screenshots/Screenshot1.png rename to screenshots/Screenshot1.png From 0399fa39dc50a5ec83d181c9b1aeeb7b7124bf67 Mon Sep 17 00:00:00 2001 From: Armin Date: Sun, 2 Aug 2026 22:06:13 +0200 Subject: [PATCH 21/21] update README --- LICENSE | 1 + README.md | 13 +++---------- 2 files changed, 4 insertions(+), 10 deletions(-) diff --git a/LICENSE b/LICENSE index f386d22..5c36cb9 100644 --- a/LICENSE +++ b/LICENSE @@ -27,3 +27,4 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + diff --git a/README.md b/README.md index 7c380c5..a23f073 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,9 @@ -# Wavetable +# Wavetable - personal fork with some modifications -![Build](https://github.com/FigBug/Wavetable/workflows/Build/badge.svg) - -A 2 oscillator wavetable synthesizer with flexible modulation options. +A 2 oscillator wavetable synthesizer with flexible modulation options. See https://github.com/FigBug/Wavetable for the upstream code project and https://socalabs.com/synths/Wavetable/ for the product page. ![Screenshot](screenshots/Screenshot1.png) -[Download](https://github.com/FigBug/Wavetable/releases) | [Product Page](https://socalabs.com/synths/Wavetable/) - ## Features ### Oscillators @@ -344,8 +340,5 @@ Effects can be reordered by dragging. ## License -The synth is BSD licensed. However, it depends on JUCE. To use in a commercial application, you must have a JUCE license. Wavetables have their own license. +See the LICENSE file for license information. -## Contact - -Need additional features or help integrating? Contact me for consulting services: https://rabiensoftware.com/