diff --git a/.github/workflows/cmake_aax_prerelease.yml b/.github/workflows/cmake_aax_prerelease.yml new file mode 100644 index 0000000..4101c6b --- /dev/null +++ b/.github/workflows/cmake_aax_prerelease.yml @@ -0,0 +1,203 @@ +name: AAX Pre Release + +on: + workflow_dispatch: + +# When pushing new commits, cancel any running builds on that branch +concurrency: + group: ${{ github.ref }} + cancel-in-progress: true + +env: + BUILD_TYPE: Release + BUILD_DIR: Builds + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + DISPLAY: :0 # linux pluginval needs this + CMAKE_BUILD_PARALLEL_LEVEL: 3 # Use up to 3 cpus to build juceaide, etc + HOMEBREW_NO_INSTALL_CLEANUP: 1 + IPP_DIR: C:\Program Files (x86)\Intel\oneAPI\ipp\latest\lib\cmake\ipp + +# jobs are run in paralell on different machines +# all steps run in series +jobs: + build_and_test: + name: ${{ matrix.name }} + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false # show all errors for each platform (vs. cancel jobs on error) + matrix: + include: + - name: macOS + os: macos-14 + pluginval-binary: pluginval.app/Contents/MacOS/pluginval + boost_platform_version: "11" + boost_toolset: "clang" + plugin_os_format: "AAX" + - name: Windows + os: windows-latest + pluginval-binary: ./pluginval.exe + boost_platform_version: "2022" + boost_toolset: "msvc" + plugin_os_format: "AAX" + + steps: + - name: Set up MSVC Developer Command Prompt (Windows) + if: runner.os == 'Windows' + uses: ilammy/msvc-dev-cmd@v1 + + - name: Set up Clang (Linux) + if: runner.os == 'Linux' + uses: egor-tensin/setup-clang@v1 + + # This also starts up our "fake" display Xvfb, needed for pluginval + - name: Install JUCE's Linux Deps + if: runner.os == 'Linux' + # Thanks to McMartin & co https://forum.juce.com/t/list-of-juce-dependencies-under-linux/15121/44 + run: | + sudo apt-get update && sudo apt install libasound2-dev libx11-dev libxinerama-dev libxext-dev libfreetype6-dev libwebkit2gtk-4.0-dev libglu1-mesa-dev xvfb ninja-build + sudo /usr/bin/Xvfb $DISPLAY & + + - name: Cache IPP (Windows) + if: runner.os == 'Windows' + id: cache-ipp + uses: actions/cache@v4 + with: + key: ipp-v5 + path: C:\Program Files (x86)\Intel + + - name: Install IPP (Windows) + if: (runner.os == 'Windows') && (steps.cache-ipp.outputs.cache-hit != 'true') + shell: bash + run: | + curl --output oneapi.exe https://registrationcenter-download.intel.com/akdlm/IRC_NAS/b4adec02-353b-4144-aa21-f2087040f316/w_ipp_oneapi_p_2021.11.0.533_offline.exe + ./oneapi.exe -s -x -f oneapi + ./oneapi/bootstrapper.exe -s -c --action install --components=intel.oneapi.win.ipp.devel --eula=accept -p=NEED_VS2022_INTEGRATION=1 --log-dir=. + + - name: Save IPP cache (even on CI fail) + if: runner.os == 'Windows' && (steps.cache-ipp.outputs.cache-hit != 'true') + uses: actions/cache/save@v4 + with: + path: C:\Program Files (x86)\Intel + key: ipp-v5 + + - name: Install Ninja (Windows) + if: runner.os == 'Windows' + shell: bash + run: choco install ninja + + - name: Install macOS Deps + if: ${{ matrix.name == 'macOS' }} + run: brew install ninja osxutils + + # This block can be removed once 15.1 is default (JUCE requires it when building on macOS 14) + - name: Use latest Xcode on system (macOS) + if: ${{ matrix.name == 'macOS' }} + uses: maxim-lobanov/setup-xcode@v1 + with: + xcode-version: latest-stable + + - name: Checkout code + uses: actions/checkout@v4 + with: + submodules: true # Get JUCE populated + +# - name: Install boost +# uses: MarkusJx/install-boost@v2.4.5 +# id: install-boost +# with: +# boost_version: 1.80.0 +# platform_version: ${{ matrix.boost_platform_version }} +# toolset: ${{ matrix.boost_toolset }} +# link: "static" + + - name: Cache the build + uses: mozilla-actions/sccache-action@v0.0.5 + + - name: Import Certificates (macOS) + uses: apple-actions/import-codesign-certs@v3 # only exists as a tag right now + if: ${{ (matrix.name == 'macOS') && (env.p12-file-base64 != '')}} + with: + p12-file-base64: ${{ secrets.DEV_ID_APP_CERT }} + p12-password: ${{ secrets.DEV_ID_APP_PASSWORD }} + env: + p12-file-base64: ${{ secrets.DEV_ID_APP_CERT }} + + - name: Configure + shell: bash + run: cmake -B ${{ env.BUILD_DIR }} -G Ninja -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE}} -DCMAKE_C_COMPILER_LAUNCHER=${{ matrix.ccache }} -DCMAKE_CXX_COMPILER_LAUNCHER=${{ matrix.ccache }} -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" . + env: + PLUGIN_OS_FORMAT: ${{ matrix.plugin_os_format }} + + - name: Build + shell: bash + run: cmake --build ${{ env.BUILD_DIR }} --config ${{ env.BUILD_TYPE }} --parallel 4 + + - name: Test + working-directory: ${{ env.BUILD_DIR }} + run: ctest --output-on-failure -j4 -VV + + - name: Read in .env from CMake # see GitHubENV.cmake + shell: bash + run: | + cat .env # show us the config + cat .env >> $GITHUB_ENV # pull in our PRODUCT_NAME, etc + + - name: Set additional env vars for next steps + shell: bash + run: | + ARTIFACTS_PATH=${{ env.BUILD_DIR }}/${{ env.PROJECT_NAME }}_artefacts/${{ env.BUILD_TYPE }} + echo "ARTIFACTS_PATH=$ARTIFACTS_PATH" >> $GITHUB_ENV + echo "AAX_PATH=$ARTIFACTS_PATH/AAX/${{ env.PRODUCT_NAME }}.axxplugin" >> $GITHUB_ENV + echo "ARTIFACT_NAME=${{ env.PRODUCT_NAME }}-${{ env.VERSION }}-${{ matrix.name }}" >> $GITHUB_ENV + + - name: Check AAX releases + shell: bash + run: | + ls "${{ env.ARTIFACTS_PATH }}/AAX" + + - name: Upload AAX + uses: actions/upload-artifact@v4 + with: + name: ${{ matrix.name }} + path: "${{ env.ARTIFACTS_PATH }}/AAX/*.aaxplugin" + + # pre-release: + # name: Release AAX + # runs-on: ubuntu-latest + # needs: build_and_test + # permissions: + # contents: write + + # steps: + # - name: Get artifacts + # uses: actions/download-artifact@v4 + + # - name: Download AAX pre-release repo + # uses: actions/checkout@v4 + # with: + # repository: "ZL-Audio/ZLEqualizerAAX" + # fetch-depth: 0 + # path: "release_repo" + # ssh-key: ${{ secrets.AAX_RELEASE_DEPLOY_KEY }} + + # - name: Remove old AAX releases + # run: | + # rm -rf "release_repo/macOS" + # rm -rf "release_repo/Windows" + + # - name: Move current AAX pre-releases + # run: | + # mv -v "macOS" "release_repo/macOS" + # mv -v "Windows" "release_repo/Windows" + + # - name: Commit AAX pre-release repo + # run: | + # cd "release_repo" + # git config user.name github-actions + # git config user.email github-actions@github.com + # git checkout --orphan newBranch + # git add -A + # git commit -m "pre-release" + # git branch -D main + # git branch -m main + # git push -f origin main \ No newline at end of file diff --git a/.github/workflows/cmake_full_test.yml b/.github/workflows/cmake_full_test.yml new file mode 100644 index 0000000..66a2aad --- /dev/null +++ b/.github/workflows/cmake_full_test.yml @@ -0,0 +1,266 @@ +name: macOS/Windows/Linux Test + +on: + push: + branches: [main, develop] + pull_request: + branches: [main] + workflow_dispatch: + +# When pushing new commits, cancel any running builds on that branch +concurrency: + group: ${{ github.ref }} + cancel-in-progress: true + +env: + BUILD_TYPE: Release + BUILD_DIR: Builds + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + DISPLAY: :0 # linux pluginval needs this + CMAKE_BUILD_PARALLEL_LEVEL: 3 # Use up to 3 cpus to build juceaide, etc + HOMEBREW_NO_INSTALL_CLEANUP: 1 + IPP_DIR: C:\Program Files (x86)\Intel\oneAPI\ipp\latest\lib\cmake\ipp + +# jobs are run in paralell on different machines +# all steps run in series +jobs: + build_and_test: + name: ${{ matrix.name }} + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false # show all errors for each platform (vs. cancel jobs on error) + matrix: + include: + - name: Linux + os: ubuntu-22.04 + pluginval-binary: ./pluginval + boost_platform_version: "22.04" + boost_toolset: "gcc" + plugin_os_format: "VST3" + - name: macOS + os: macos-14 + pluginval-binary: pluginval.app/Contents/MacOS/pluginval + boost_platform_version: "11" + boost_toolset: "clang" + plugin_os_format: "AU" + - name: Windows + os: windows-latest + pluginval-binary: ./pluginval.exe + boost_platform_version: "2022" + boost_toolset: "msvc" + plugin_os_format: "VST3" + + steps: + - name: Set up MSVC Developer Command Prompt (Windows) + if: runner.os == 'Windows' + uses: ilammy/msvc-dev-cmd@v1 + + - name: Set up Clang (Linux) + if: runner.os == 'Linux' + uses: egor-tensin/setup-clang@v1 + + # This also starts up our "fake" display Xvfb, needed for pluginval + - name: Install JUCE's Linux Deps + if: runner.os == 'Linux' + # Thanks to McMartin & co https://forum.juce.com/t/list-of-juce-dependencies-under-linux/15121/44 + run: | + sudo apt-get update && sudo apt install libasound2-dev libx11-dev libxinerama-dev libxext-dev libfreetype-dev libfontconfig1-dev libwebkit2gtk-4.1-dev libglu1-mesa-dev xvfb ninja-build + sudo /usr/bin/Xvfb $DISPLAY & + + - name: Cache IPP (Windows) + if: runner.os == 'Windows' + id: cache-ipp + uses: actions/cache@v4 + with: + key: ipp-v5 + path: C:\Program Files (x86)\Intel + + - name: Install IPP (Windows) + if: (runner.os == 'Windows') && (steps.cache-ipp.outputs.cache-hit != 'true') + shell: bash + run: | + curl --output oneapi.exe https://registrationcenter-download.intel.com/akdlm/IRC_NAS/b4adec02-353b-4144-aa21-f2087040f316/w_ipp_oneapi_p_2021.11.0.533_offline.exe + ./oneapi.exe -s -x -f oneapi + ./oneapi/bootstrapper.exe -s -c --action install --components=intel.oneapi.win.ipp.devel --eula=accept -p=NEED_VS2022_INTEGRATION=1 --log-dir=. + + - name: Save IPP cache (even on CI fail) + if: runner.os == 'Windows' && (steps.cache-ipp.outputs.cache-hit != 'true') + uses: actions/cache/save@v4 + with: + path: C:\Program Files (x86)\Intel + key: ipp-v5 + + - name: Install Ninja (Windows) + if: runner.os == 'Windows' + shell: bash + run: choco install ninja + + - name: Install macOS Deps + if: ${{ matrix.name == 'macOS' }} + run: brew install ninja osxutils + + # This block can be removed once 15.1 is default (JUCE requires it when building on macOS 14) + - name: Use latest Xcode on system (macOS) + if: ${{ matrix.name == 'macOS' }} + uses: maxim-lobanov/setup-xcode@v1 + with: + xcode-version: latest-stable + + - name: Checkout code + uses: actions/checkout@v4 + with: + submodules: true + + - name: Cache the build + uses: mozilla-actions/sccache-action@v0.0.5 + + - name: Import Certificates (macOS) + uses: apple-actions/import-codesign-certs@v3 # only exists as a tag right now + if: ${{ (matrix.name == 'macOS') && (env.p12-file-base64 != '')}} + with: + p12-file-base64: ${{ secrets.DEV_ID_APP_CERT }} + p12-password: ${{ secrets.DEV_ID_APP_PASSWORD }} + env: + p12-file-base64: ${{ secrets.DEV_ID_APP_CERT }} + + - name: Configure + shell: bash + run: cmake -B ${{ env.BUILD_DIR }} -G Ninja -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE}} -DCMAKE_C_COMPILER_LAUNCHER=${{ matrix.ccache }} -DCMAKE_CXX_COMPILER_LAUNCHER=${{ matrix.ccache }} -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" . + env: + PLUGIN_OS_FORMAT: ${{ matrix.plugin_os_format }} + + - name: Build + shell: bash + run: cmake --build ${{ env.BUILD_DIR }} --config ${{ env.BUILD_TYPE }} --parallel 4 + + - name: Test + working-directory: ${{ env.BUILD_DIR }} + run: ctest --output-on-failure -j4 -VV + + - name: Read in .env from CMake # see GitHubENV.cmake + shell: bash + run: | + cat .env # show us the config + cat .env >> $GITHUB_ENV # pull in our PRODUCT_NAME, etc + + - name: Set additional env vars for next steps + shell: bash + run: | + ARTIFACTS_PATH=${{ env.BUILD_DIR }}/${{ env.PROJECT_NAME }}_artefacts/${{ env.BUILD_TYPE }} + echo "ARTIFACTS_PATH=$ARTIFACTS_PATH" >> $GITHUB_ENV + echo "VST3_PATH=$ARTIFACTS_PATH/VST3/${{ env.PRODUCT_NAME }}.vst3" >> $GITHUB_ENV + echo "AU_PATH=$ARTIFACTS_PATH/AU/${{ env.PRODUCT_NAME }}.component" >> $GITHUB_ENV + echo "LV2_PATH=$ARTIFACTS_PATH/LV2/${{ env.PRODUCT_NAME }}.lv2" >> $GITHUB_ENV + echo "ARTIFACT_NAME=${{ env.PRODUCT_NAME }}-${{ env.VERSION }}-${{ matrix.name }}" >> $GITHUB_ENV + + - name: Pluginval setup + shell: bash + run: | + curl -LO "https://github.com/Tracktion/pluginval/releases/download/v1.0.3/pluginval_${{ matrix.name }}.zip" + 7z x pluginval_${{ matrix.name }}.zip + echo "PLUGINVAL_DISABLED=Plugin state restoration" >> $GITHUB_ENV + + - name: Setup Pluginval random seed + uses: josStorer/get-current-time@v2 + id: current-time + with: + format: YYYYMMDD + + - name: Pluginval VST3 validations + if: ${{ matrix.name != 'macOS' }} + shell: bash + run: | + ${{ matrix.pluginval-binary }} --verbose --validate "${{ env.VST3_PATH }}" --disabled-tests "${{ env.PLUGINVAL_DISABLED }}" + env: + STRICTNESS_LEVEL: 10 + TIMEOUT_MS: 1440000 + REPEAT: 2 + RANDOM_SEED: "${{ steps.current-time.outputs.formattedTime }}" + + - name: Pluginval AU validations (macOS) + if: ${{ matrix.name == 'macOS' }} + shell: bash + run: | + sudo cp -r "${{ env.AU_PATH }}" "/Library/Audio/Plug-ins/components" + sudo killall -9 AudioComponentRegistrar + ${{ matrix.pluginval-binary }} --verbose --validate "/Library/Audio/Plug-ins/components/${{ env.PRODUCT_NAME }}.component" --disabled-tests "${{ env.PLUGINVAL_DISABLED }}" + env: + STRICTNESS_LEVEL: 10 + TIMEOUT_MS: 1440000 + REPEAT: 2 + RANDOM_SEED: "${{ steps.current-time.outputs.formattedTime }}" + + - name: Codesign and Create Individual Packages (macOS) + if: ${{ matrix.name == 'macOS' }} + run: | + python3 -u packaging/packager_macOS.py + env: + DEVELOPER_ID_APPLICATION: ${{ secrets.DEVELOPER_ID_APPLICATION }} + + - name: Sign Final Package (macOS) + if: ${{ (matrix.name == 'macOS') && (env.APPLE_INSTALLER_DEV != '') }} + run: productsign --sign "${{ secrets.APPLE_INSTALLER_DEV }}" "${{ env.ARTIFACT_NAME }}_unsigned.pkg" "${{ env.ARTIFACT_NAME }}.pkg" + env: + APPLE_INSTALLER_DEV: ${{ secrets.APPLE_INSTALLER_DEV }} + + - name: Rename Final Package (macOS) + if: ${{ (matrix.name == 'macOS') && (env.APPLE_INSTALLER_DEV == '') }} + run: mv "${{ env.ARTIFACT_NAME }}_unsigned.pkg" "${{ env.ARTIFACT_NAME }}.pkg" + env: + APPLE_INSTALLER_DEV: ${{ secrets.APPLE_INSTALLER_DEV }} + + - name: Notarize and Staple PKG (macOS) + if: ${{ (matrix.name == 'macOS') && (env.NOTARIZATION_USERNAME != '')}} + run: | + xcrun notarytool submit "${{ env.ARTIFACT_NAME }}.pkg" --apple-id ${{ secrets.NOTARIZATION_USERNAME }} --password ${{ secrets.NOTARIZATION_PASSWORD }} --team-id ${{ secrets.TEAM_ID }} --wait + xcrun stapler staple "${{ env.ARTIFACT_NAME }}.pkg" + env: + NOTARIZATION_USERNAME: ${{ secrets.NOTARIZATION_USERNAME }} + + - name: Create DMG (macOS) + if: ${{ matrix.name == 'macOS' }} + run: | + mkdir "${{ env.ARTIFACTS_PATH }}/dmgtmp" + mv "${{ env.ARTIFACT_NAME }}.pkg" "${{ env.ARTIFACTS_PATH }}/dmgtmp" + hdiutil create "${{ env.ARTIFACTS_PATH }}/tmp.dmg" -ov -volname "${{ env.ARTIFACT_NAME }}" -fs HFS+ -srcfolder "${{ env.ARTIFACTS_PATH }}/dmgtmp" + hdiutil convert "${{ env.ARTIFACTS_PATH }}/tmp.dmg" -format UDZO -o "${{ env.ARTIFACT_NAME }}.dmg" + + - name: Upload DMG (macOS) + if: ${{ matrix.name == 'macOS' }} + uses: actions/upload-artifact@v4 + with: + name: ${{ env.ARTIFACT_NAME }}.dmg + path: "${{ env.ARTIFACT_NAME }}.dmg" + + - name: Generate InnoScript (Windows) + if: ${{ matrix.name == 'Windows' }} + shell: bash + run: | + python3 -u packaging/packager_Windows.py + cat "packaging\installer.iss" + + - name: Generate Installer (Windows) + if: ${{ matrix.name == 'Windows' }} + shell: bash + run: | + iscc "packaging\installer.iss" + mv "packaging/Output/${{ env.ARTIFACT_NAME }}.exe" "${{ env.ARTIFACTS_PATH }}/" + + - name: Upload Exe (Windows) + if: ${{ matrix.name == 'Windows' }} + uses: actions/upload-artifact@v4 + with: + name: ${{ env.ARTIFACT_NAME }}.exe + path: "${{ env.ARTIFACTS_PATH }}/${{ env.ARTIFACT_NAME }}.exe" + + - name: Generate Zip (Linux) + if: ${{ matrix.name == 'Linux' }} + working-directory: ${{ env.ARTIFACTS_PATH }} + run: 7z a -tzip "${{ env.ARTIFACT_NAME }}.zip" "-xr!lib${{ env.PRODUCT_NAME }}_SharedCode.a" . + + - name: Upload Zip (Linux) + if: ${{ matrix.name == 'Linux' }} + uses: actions/upload-artifact@v4 + with: + name: ${{ env.ARTIFACT_NAME }}.zip + path: "${{ env.ARTIFACTS_PATH }}/${{ env.ARTIFACT_NAME }}.zip" \ No newline at end of file diff --git a/.github/workflows/cmake_release.yml b/.github/workflows/cmake_release.yml new file mode 100644 index 0000000..902bf7f --- /dev/null +++ b/.github/workflows/cmake_release.yml @@ -0,0 +1,277 @@ +name: Release + +on: + workflow_dispatch: + +# When pushing new commits, cancel any running builds on that branch +concurrency: + group: ${{ github.ref }} + cancel-in-progress: true + +env: + BUILD_TYPE: Release + BUILD_DIR: Builds + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + DISPLAY: :0 # linux pluginval needs this + CMAKE_BUILD_PARALLEL_LEVEL: 3 # Use up to 3 cpus to build juceaide, etc + HOMEBREW_NO_INSTALL_CLEANUP: 1 + IPP_DIR: C:\Program Files (x86)\Intel\oneAPI\ipp\latest\lib\cmake\ipp + +# jobs are run in paralell on different machines +# all steps run in series +jobs: + build_and_test: + name: ${{ matrix.name }} + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false # show all errors for each platform (vs. cancel jobs on error) + matrix: + include: + - name: Linux + os: ubuntu-22.04 + pluginval-binary: ./pluginval + boost_platform_version: "22.04" + boost_toolset: "gcc" + plugin_os_format: "VST3;LV2" + - name: macOS + os: macos-14 + pluginval-binary: pluginval.app/Contents/MacOS/pluginval + boost_platform_version: "11" + boost_toolset: "clang" + plugin_os_format: "VST3;AU" + - name: Windows + os: windows-latest + pluginval-binary: ./pluginval.exe + boost_platform_version: "2022" + boost_toolset: "msvc" + plugin_os_format: "VST3;LV2" + + steps: + - name: Set up MSVC Developer Command Prompt (Windows) + if: runner.os == 'Windows' + uses: ilammy/msvc-dev-cmd@v1 + + - name: Set up Clang (Linux) + if: runner.os == 'Linux' + uses: egor-tensin/setup-clang@v1 + + # This also starts up our "fake" display Xvfb, needed for pluginval + - name: Install JUCE's Linux Deps + if: runner.os == 'Linux' + # Thanks to McMartin & co https://forum.juce.com/t/list-of-juce-dependencies-under-linux/15121/44 + run: | + sudo apt-get update && sudo apt install libasound2-dev libx11-dev libxinerama-dev libxext-dev libfreetype-dev libfontconfig1-dev libwebkit2gtk-4.1-dev libglu1-mesa-dev xvfb ninja-build + sudo /usr/bin/Xvfb $DISPLAY & + + - name: Cache IPP (Windows) + if: runner.os == 'Windows' + id: cache-ipp + uses: actions/cache@v4 + with: + key: ipp-v5 + path: C:\Program Files (x86)\Intel + + - name: Install IPP (Windows) + if: (runner.os == 'Windows') && (steps.cache-ipp.outputs.cache-hit != 'true') + shell: bash + run: | + curl --output oneapi.exe https://registrationcenter-download.intel.com/akdlm/IRC_NAS/b4adec02-353b-4144-aa21-f2087040f316/w_ipp_oneapi_p_2021.11.0.533_offline.exe + ./oneapi.exe -s -x -f oneapi + ./oneapi/bootstrapper.exe -s -c --action install --components=intel.oneapi.win.ipp.devel --eula=accept -p=NEED_VS2022_INTEGRATION=1 --log-dir=. + + - name: Save IPP cache (even on CI fail) + if: runner.os == 'Windows' && (steps.cache-ipp.outputs.cache-hit != 'true') + uses: actions/cache/save@v4 + with: + path: C:\Program Files (x86)\Intel + key: ipp-v5 + + - name: Install Ninja (Windows) + if: runner.os == 'Windows' + shell: bash + run: choco install ninja + + - name: Install macOS Deps + if: ${{ matrix.name == 'macOS' }} + run: brew install ninja osxutils + + # This block can be removed once 15.1 is default (JUCE requires it when building on macOS 14) + - name: Use latest Xcode on system (macOS) + if: ${{ matrix.name == 'macOS' }} + uses: maxim-lobanov/setup-xcode@v1 + with: + xcode-version: latest-stable + + - name: Checkout code + uses: actions/checkout@v4 + with: + submodules: true + + - name: Cache the build + uses: mozilla-actions/sccache-action@v0.0.5 + + - name: Import Certificates (macOS) + uses: apple-actions/import-codesign-certs@v3 # only exists as a tag right now + if: ${{ (matrix.name == 'macOS') && (env.p12-file-base64 != '')}} + with: + p12-file-base64: ${{ secrets.DEV_ID_APP_CERT }} + p12-password: ${{ secrets.DEV_ID_APP_PASSWORD }} + env: + p12-file-base64: ${{ secrets.DEV_ID_APP_CERT }} + + - name: Configure + shell: bash + run: cmake -B ${{ env.BUILD_DIR }} -G Ninja -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE}} -DCMAKE_C_COMPILER_LAUNCHER=${{ matrix.ccache }} -DCMAKE_CXX_COMPILER_LAUNCHER=${{ matrix.ccache }} -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" . + env: + PLUGIN_OS_FORMAT: ${{ matrix.plugin_os_format }} + + - name: Build + shell: bash + run: cmake --build ${{ env.BUILD_DIR }} --config ${{ env.BUILD_TYPE }} --parallel 4 + + - name: Test + working-directory: ${{ env.BUILD_DIR }} + run: ctest --output-on-failure -j4 -VV + + - name: Read in .env from CMake # see GitHubENV.cmake + shell: bash + run: | + cat .env # show us the config + cat .env >> $GITHUB_ENV # pull in our PRODUCT_NAME, etc + + # - name: Download AAX pre-release repo + # if: (runner.os != 'Linux') + # uses: actions/checkout@v4 + # with: + # repository: "ZL-Audio/ZLEqualizerAAX" + # path: "aax_releases" + # ssh-key: ${{ secrets.AAX_RELEASE_DEPLOY_KEY }} + + - name: Set additional env vars for next steps + shell: bash + run: | + ARTIFACTS_PATH=${{ env.BUILD_DIR }}/${{ env.PROJECT_NAME }}_artefacts/${{ env.BUILD_TYPE }} + echo "ARTIFACTS_PATH=$ARTIFACTS_PATH" >> $GITHUB_ENV + echo "VST3_PATH=$ARTIFACTS_PATH/VST3/${{ env.PRODUCT_NAME }}.vst3" >> $GITHUB_ENV + echo "AU_PATH=$ARTIFACTS_PATH/AU/${{ env.PRODUCT_NAME }}.component" >> $GITHUB_ENV + echo "LV2_PATH=$ARTIFACTS_PATH/LV2/${{ env.PRODUCT_NAME }}.lv2" >> $GITHUB_ENV + echo "AAX_PATH=aax_releases/${{ matrix.name }}/${{ env.PRODUCT_NAME }}.aaxplugin" >> $GITHUB_ENV + echo "ARTIFACT_NAME=${{ env.PRODUCT_NAME }}-${{ env.VERSION }}-${{ matrix.name }}" >> $GITHUB_ENV + + - name: Pluginval setup + shell: bash + run: | + curl -LO "https://github.com/Tracktion/pluginval/releases/download/v1.0.3/pluginval_${{ matrix.name }}.zip" + 7z x pluginval_${{ matrix.name }}.zip + echo "PLUGINVAL_DISABLED=Plugin state restoration" >> $GITHUB_ENV + + - name: Setup Pluginval random seed + uses: josStorer/get-current-time@v2 + id: current-time + with: + format: YYYYMMDD + + - name: Pluginval VST3 validations + shell: bash + run: | + ${{ matrix.pluginval-binary }} --verbose --validate "${{ env.VST3_PATH }}" --disabled-tests "${{ env.PLUGINVAL_DISABLED }}" + env: + STRICTNESS_LEVEL: 10 + TIMEOUT_MS: 1440000 + REPEAT: 1 + RANDOM_SEED: "${{ steps.current-time.outputs.formattedTime }}" + + - name: Codesign and Create Individual Packages (macOS) + if: ${{ matrix.name == 'macOS' }} + run: | + python3 -u packaging/packager_macOS.py + env: + DEVELOPER_ID_APPLICATION: ${{ secrets.DEVELOPER_ID_APPLICATION }} + + - name: Sign Final Package (macOS) + if: ${{ (matrix.name == 'macOS') && (env.APPLE_INSTALLER_DEV != '') }} + run: productsign --sign "${{ secrets.APPLE_INSTALLER_DEV }}" "${{ env.ARTIFACT_NAME }}_unsigned.pkg" "${{ env.ARTIFACT_NAME }}.pkg" + env: + APPLE_INSTALLER_DEV: ${{ secrets.APPLE_INSTALLER_DEV }} + + - name: Rename Final Package (macOS) + if: ${{ (matrix.name == 'macOS') && (env.APPLE_INSTALLER_DEV == '') }} + run: mv "${{ env.ARTIFACT_NAME }}_unsigned.pkg" "${{ env.ARTIFACT_NAME }}.pkg" + env: + APPLE_INSTALLER_DEV: ${{ secrets.APPLE_INSTALLER_DEV }} + + - name: Notarize and Staple PKG (macOS) + if: ${{ (matrix.name == 'macOS') && (env.NOTARIZATION_USERNAME != '')}} + run: | + xcrun notarytool submit "${{ env.ARTIFACT_NAME }}.pkg" --apple-id ${{ secrets.NOTARIZATION_USERNAME }} --password ${{ secrets.NOTARIZATION_PASSWORD }} --team-id ${{ secrets.TEAM_ID }} --wait + xcrun stapler staple "${{ env.ARTIFACT_NAME }}.pkg" + env: + NOTARIZATION_USERNAME: ${{ secrets.NOTARIZATION_USERNAME }} + + - name: Create DMG (macOS) + if: ${{ matrix.name == 'macOS' }} + run: | + mkdir "${{ env.ARTIFACTS_PATH }}/dmgtmp" + mv "${{ env.ARTIFACT_NAME }}.pkg" "${{ env.ARTIFACTS_PATH }}/dmgtmp" + hdiutil create "${{ env.ARTIFACTS_PATH }}/tmp.dmg" -ov -volname "${{ env.ARTIFACT_NAME }}" -fs HFS+ -srcfolder "${{ env.ARTIFACTS_PATH }}/dmgtmp" + hdiutil convert "${{ env.ARTIFACTS_PATH }}/tmp.dmg" -format UDZO -o "${{ env.ARTIFACT_NAME }}.dmg" + + - name: Upload DMG (macOS) + if: ${{ matrix.name == 'macOS' }} + uses: actions/upload-artifact@v4 + with: + name: ${{ env.ARTIFACT_NAME }}.dmg + path: "${{ env.ARTIFACT_NAME }}.dmg" + + - name: Generate InnoScript (Windows) + if: ${{ matrix.name == 'Windows' }} + shell: bash + run: | + python3 -u packaging/packager_Windows.py + cat "packaging\installer.iss" + + - name: Generate Installer (Windows) + if: ${{ matrix.name == 'Windows' }} + shell: bash + run: | + iscc "packaging\installer.iss" + mv "packaging/Output/${{ env.ARTIFACT_NAME }}.exe" "${{ env.ARTIFACTS_PATH }}/" + + - name: Upload Exe (Windows) + if: ${{ matrix.name == 'Windows' }} + uses: actions/upload-artifact@v4 + with: + name: ${{ env.ARTIFACT_NAME }}.exe + path: "${{ env.ARTIFACTS_PATH }}/${{ env.ARTIFACT_NAME }}.exe" + + - name: Generate Zip (Linux) + if: ${{ matrix.name == 'Linux' }} + working-directory: ${{ env.ARTIFACTS_PATH }} + run: 7z a -tzip "${{ env.ARTIFACT_NAME }}.zip" "-xr!lib${{ env.PRODUCT_NAME }}_SharedCode.a" . + + - name: Upload Zip (Linux) + if: ${{ matrix.name == 'Linux' }} + uses: actions/upload-artifact@v4 + with: + name: ${{ env.ARTIFACT_NAME }}.zip + path: "${{ env.ARTIFACTS_PATH }}/${{ env.ARTIFACT_NAME }}.zip" + + release: + if: contains(github.ref, 'tags/') + runs-on: ubuntu-latest + needs: build_and_test + + steps: + - name: Get Artifacts + uses: actions/download-artifact@v4 + + - name: Create Release + uses: softprops/action-gh-release@v2 + with: + prerelease: true + # download-artifact puts these files in their own dirs... + # Using globs sidesteps having to pass the version around + files: | + */*.exe + */*.zip + */*.dmg \ No newline at end of file diff --git a/.github/workflows/cmake_standalone.yml b/.github/workflows/cmake_standalone.yml new file mode 100644 index 0000000..fd01fcb --- /dev/null +++ b/.github/workflows/cmake_standalone.yml @@ -0,0 +1,235 @@ +name: Standalone + +on: + workflow_dispatch: + +concurrency: + group: ${{ github.ref }} + cancel-in-progress: true + +env: + BUILD_TYPE: Release + BUILD_DIR: Builds + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + DISPLAY: :0 # linux pluginval needs this + CMAKE_BUILD_PARALLEL_LEVEL: 3 # Use up to 3 cpus to build juceaide, etc + HOMEBREW_NO_INSTALL_CLEANUP: 1 + IPP_DIR: C:\Program Files (x86)\Intel\oneAPI\ipp\latest\lib\cmake\ipp + +# jobs are run in paralell on different machines +# all steps run in series +jobs: + build_and_test: + name: ${{ matrix.name }} + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false # show all errors for each platform (vs. cancel jobs on error) + matrix: + include: + - name: Linux + os: ubuntu-22.04 + boost_platform_version: "22.04" + boost_toolset: "gcc" + plugin_os_format: "Standalone" + app_suffix: "" + - name: macOS + os: macos-14 + boost_platform_version: "11" + boost_toolset: "clang" + plugin_os_format: "Standalone" + app_suffix: "app" + - name: Windows + os: windows-latest + boost_platform_version: "2022" + boost_toolset: "msvc" + plugin_os_format: "Standalone" + app_suffix: "exe" + + steps: + - name: Set up MSVC Developer Command Prompt (Windows) + if: runner.os == 'Windows' + uses: ilammy/msvc-dev-cmd@v1 + + - name: Set up Clang (Linux) + if: runner.os == 'Linux' + uses: egor-tensin/setup-clang@v1 + + # This also starts up our "fake" display Xvfb, needed for pluginval + - name: Install JUCE's Linux Deps + if: runner.os == 'Linux' + # Thanks to McMartin & co https://forum.juce.com/t/list-of-juce-dependencies-under-linux/15121/44 + run: | + sudo apt-get update && sudo apt install libasound2-dev libx11-dev libxinerama-dev libxext-dev libfreetype-dev libfontconfig1-dev libwebkit2gtk-4.1-dev libglu1-mesa-dev xvfb ninja-build + sudo /usr/bin/Xvfb $DISPLAY & + + - name: Cache IPP (Windows) + if: runner.os == 'Windows' + id: cache-ipp + uses: actions/cache@v4 + with: + key: ipp-v5 + path: C:\Program Files (x86)\Intel + + - name: Install IPP (Windows) + if: (runner.os == 'Windows') && (steps.cache-ipp.outputs.cache-hit != 'true') + shell: bash + run: | + curl --output oneapi.exe https://registrationcenter-download.intel.com/akdlm/IRC_NAS/b4adec02-353b-4144-aa21-f2087040f316/w_ipp_oneapi_p_2021.11.0.533_offline.exe + ./oneapi.exe -s -x -f oneapi + ./oneapi/bootstrapper.exe -s -c --action install --components=intel.oneapi.win.ipp.devel --eula=accept -p=NEED_VS2022_INTEGRATION=1 --log-dir=. + + - name: Save IPP cache (even on CI fail) + if: runner.os == 'Windows' && (steps.cache-ipp.outputs.cache-hit != 'true') + uses: actions/cache/save@v4 + with: + path: C:\Program Files (x86)\Intel + key: ipp-v5 + + - name: Install Ninja (Windows) + if: runner.os == 'Windows' + shell: bash + run: choco install ninja + + - name: Install macOS Deps + if: ${{ matrix.name == 'macOS' }} + run: brew install ninja osxutils + + # This block can be removed once 15.1 is default (JUCE requires it when building on macOS 14) + - name: Use latest Xcode on system (macOS) + if: ${{ matrix.name == 'macOS' }} + uses: maxim-lobanov/setup-xcode@v1 + with: + xcode-version: latest-stable + + - name: Checkout code + uses: actions/checkout@v4 + with: + submodules: true + + - name: Install boost + uses: MarkusJx/install-boost@v2.4.5 + id: install-boost + with: + boost_version: 1.80.0 + platform_version: ${{ matrix.boost_platform_version }} + toolset: ${{ matrix.boost_toolset }} + link: "static" + + - name: Cache the build + uses: mozilla-actions/sccache-action@v0.0.5 + + - name: Import Certificates (macOS) + uses: apple-actions/import-codesign-certs@v3 # only exists as a tag right now + if: ${{ (matrix.name == 'macOS') && (env.p12-file-base64 != '')}} + with: + p12-file-base64: ${{ secrets.DEV_ID_APP_CERT }} + p12-password: ${{ secrets.DEV_ID_APP_PASSWORD }} + env: + p12-file-base64: ${{ secrets.DEV_ID_APP_CERT }} + + - name: Configure + shell: bash + run: cmake -B ${{ env.BUILD_DIR }} -G Ninja -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE}} -DCMAKE_C_COMPILER_LAUNCHER=${{ matrix.ccache }} -DCMAKE_CXX_COMPILER_LAUNCHER=${{ matrix.ccache }} -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" . + env: + BOOST_ROOT: ${{ steps.install-boost.outputs.BOOST_ROOT }} + PLUGIN_OS_FORMAT: ${{ matrix.plugin_os_format }} + + - name: Build + shell: bash + run: cmake --build ${{ env.BUILD_DIR }} --config ${{ env.BUILD_TYPE }} --parallel 4 + + - name: Test + working-directory: ${{ env.BUILD_DIR }} + run: ctest --output-on-failure -j4 -VV + + - name: Read in .env from CMake # see GitHubENV.cmake + shell: bash + run: | + cat .env # show us the config + cat .env >> $GITHUB_ENV # pull in our PRODUCT_NAME, etc + + - name: Set additional env vars for next steps + shell: bash + run: | + ARTIFACTS_PATH=${{ env.BUILD_DIR }}/${{ env.PROJECT_NAME }}_artefacts/${{ env.BUILD_TYPE }} + echo "ARTIFACTS_PATH=$ARTIFACTS_PATH" >> $GITHUB_ENV + echo "VST3_PATH=$ARTIFACTS_PATH/VST3/${{ env.PRODUCT_NAME }}.vst3" >> $GITHUB_ENV + echo "AU_PATH=$ARTIFACTS_PATH/AU/${{ env.PRODUCT_NAME }}.component" >> $GITHUB_ENV + echo "LV2_PATH=$ARTIFACTS_PATH/LV2/${{ env.PRODUCT_NAME }}.lv2" >> $GITHUB_ENV + echo "Standalone_PATH=$ARTIFACTS_PATH/Standalone/${{ env.PRODUCT_NAME }}.${{ matrix.app_suffix }}" >> $GITHUB_ENV + echo "ARTIFACT_NAME=${{ env.PRODUCT_NAME }}-${{ env.VERSION }}-${{ matrix.name }}" >> $GITHUB_ENV + + - name: Codesign and Create Individual Packages (macOS) + if: ${{ matrix.name == 'macOS' }} + run: | + python3 -u packaging/packager_macOS.py + env: + DEVELOPER_ID_APPLICATION: ${{ secrets.DEVELOPER_ID_APPLICATION }} + + - name: Sign Final Package (macOS) + if: ${{ (matrix.name == 'macOS') && (env.APPLE_INSTALLER_DEV != '') }} + run: productsign --sign "${{ secrets.APPLE_INSTALLER_DEV }}" "${{ env.ARTIFACT_NAME }}_unsigned.pkg" "${{ env.ARTIFACT_NAME }}.pkg" + env: + APPLE_INSTALLER_DEV: ${{ secrets.APPLE_INSTALLER_DEV }} + + - name: Rename Final Package (macOS) + if: ${{ (matrix.name == 'macOS') && (env.APPLE_INSTALLER_DEV == '') }} + run: mv "${{ env.ARTIFACT_NAME }}_unsigned.pkg" "${{ env.ARTIFACT_NAME }}.pkg" + env: + APPLE_INSTALLER_DEV: ${{ secrets.APPLE_INSTALLER_DEV }} + + - name: Notarize and Staple PKG (macOS) + if: ${{ (matrix.name == 'macOS') && (env.NOTARIZATION_USERNAME != '')}} + run: | + xcrun notarytool submit "${{ env.ARTIFACT_NAME }}.pkg" --apple-id ${{ secrets.NOTARIZATION_USERNAME }} --password ${{ secrets.NOTARIZATION_PASSWORD }} --team-id ${{ secrets.TEAM_ID }} --wait + xcrun stapler staple "${{ env.ARTIFACT_NAME }}.pkg" + env: + NOTARIZATION_USERNAME: ${{ secrets.NOTARIZATION_USERNAME }} + + - name: Create DMG (macOS) + if: ${{ matrix.name == 'macOS' }} + run: | + mkdir "${{ env.ARTIFACTS_PATH }}/dmgtmp" + mv "${{ env.ARTIFACT_NAME }}.pkg" "${{ env.ARTIFACTS_PATH }}/dmgtmp" + hdiutil create "${{ env.ARTIFACTS_PATH }}/tmp.dmg" -ov -volname "${{ env.ARTIFACT_NAME }}" -fs HFS+ -srcfolder "${{ env.ARTIFACTS_PATH }}/dmgtmp" + hdiutil convert "${{ env.ARTIFACTS_PATH }}/tmp.dmg" -format UDZO -o "${{ env.ARTIFACT_NAME }}.dmg" + + - name: Upload DMG (macOS) + if: ${{ matrix.name == 'macOS' }} + uses: actions/upload-artifact@v4 + with: + name: ${{ env.ARTIFACT_NAME }}-Standalone.dmg + path: "${{ env.ARTIFACT_NAME }}.dmg" + + - name: Generate InnoScript (Windows) + if: ${{ matrix.name == 'Windows' }} + shell: bash + run: | + python3 -u packaging/packager_Windows.py + cat "packaging\installer.iss" + + - name: Generate Installer (Windows) + if: ${{ matrix.name == 'Windows' }} + shell: bash + run: | + iscc "packaging\installer.iss" + mv "packaging/Output/${{ env.ARTIFACT_NAME }}.exe" "${{ env.ARTIFACTS_PATH }}/" + + - name: Upload Exe (Windows) + if: ${{ matrix.name == 'Windows' }} + uses: actions/upload-artifact@v4 + with: + name: ${{ env.ARTIFACT_NAME }}-Standalone.exe + path: "${{ env.ARTIFACTS_PATH }}/${{ env.ARTIFACT_NAME }}.exe" + + - name: Generate Zip (Linux) + if: ${{ matrix.name == 'Linux' }} + working-directory: ${{ env.ARTIFACTS_PATH }} + run: 7z a -tzip "${{ env.ARTIFACT_NAME }}.zip" "-xr!lib${{ env.PRODUCT_NAME }}_SharedCode.a" . + + - name: Upload Zip (Linux) + if: ${{ matrix.name == 'Linux' }} + uses: actions/upload-artifact@v4 + with: + name: ${{ env.ARTIFACT_NAME }}-Standalone.zip + path: "${{ env.ARTIFACTS_PATH }}/${{ env.ARTIFACT_NAME }}.zip" \ No newline at end of file diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml new file mode 100644 index 0000000..238bccf --- /dev/null +++ b/.github/workflows/sync.yml @@ -0,0 +1,16 @@ +name: Git sync +on: + workflow_dispatch: + schedule: + - cron: "0 0 * * 0" + +jobs: + sync: + runs-on: ubuntu-latest + steps: + - name: Sync to Gitee + uses: abersheeran/sync-gitee-mirror@v1-beta + with: + repository: ${{ github.repository }} + username: ${{ github.actor }} + password: ${{ secrets.GITEE_PAT }} \ No newline at end of file diff --git a/.github/workflows/sync_release.yml b/.github/workflows/sync_release.yml new file mode 100644 index 0000000..bf81ec7 --- /dev/null +++ b/.github/workflows/sync_release.yml @@ -0,0 +1,58 @@ +name: Release Sync +on: + workflow_dispatch: + +jobs: + build: + name: Release Sync + if: ${{ github.event.workflow_run.conclusion == 'success' }} || ${{ github.event_name == 'workflow_dispatch' }} + runs-on: ubuntu-22.04 + permissions: + contents: write + steps: + - name: Checkout current repo + uses: actions/checkout@v4 + with: + submodules: false + path: "current_repo" + - name: Download release repo + uses: actions/checkout@v4 + with: + repository: "ZL-Audio/ZLRelease" + fetch-depth: 0 + path: "release_repo" + ssh-key: ${{ secrets.SSH_RELEASE_DEPLOY_KEY }} + - name: Download current release assets (macOS) + uses: robinraju/release-downloader@v1.11 + with: + latest: true + preRelease: true + fileName: "*dmg" + out-file-path: "current_release" + - name: Download current release assets (Windows) + uses: robinraju/release-downloader@v1.11 + with: + latest: true + preRelease: true + fileName: "*exe" + out-file-path: "current_release" + - name: Remove old release assets + run: | + rm -rf "release_repo/${{ github.event.repository.name }}" + mkdir -p "release_repo/${{ github.event.repository.name }}" + ls "current_release/" + - name: Move current release assets + run: | + mv -v "current_release"/* "release_repo/${{ github.event.repository.name }}/" + mv -v "current_repo/CHANGELOG.md" "release_repo/${{ github.event.repository.name }}/README.md" + - name: Commit release repo + run: | + cd "release_repo" + git config user.name github-actions + git config user.email github-actions@github.com + git checkout --orphan newBranch + git add -A + git commit -m "release" + git branch -D main + git branch -m main + git push -f origin main \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b90be7e --- /dev/null +++ b/.gitignore @@ -0,0 +1,31 @@ +CMakeLists.txt.user +CMakeCache.txt +CMakeFiles +CMakeScripts +Makefile +cmake_install.cmake +install_manifest.txt +compile_commands.json +CTestTestfile.cmake +_deps +**/.DS_Store +VERSION + +# It's nice to have the Builds folder exist, to remind us where it is +Builds/* +!Builds/.gitkeep + +# This should never exist +Install/* + +# Running CTest makes a bunch o junk +Testing + +# IDE config +.idea + +# clion cmake builds +cmake-build-debug +cmake-build-release +cmake-build-relwithdebinfo +packaging/Output/* \ No newline at end of file diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..ddef9fe --- /dev/null +++ b/.gitmodules @@ -0,0 +1,4 @@ +[submodule "JUCE"] + path = JUCE + url = https://github.com/juce-framework/JUCE/ + branch = master diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..6943477 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,189 @@ +# 3.24.1 is bundled in Visual Studio 2022 v17.4 +# 3.24.1 is also bundled in CLion as of 2023 +cmake_minimum_required(VERSION 3.24.1) + +# This tells cmake we have goodies in the /cmake folder +list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake-includes") +include(GitVersion) +include(PamplejuceVersion) + +# Change me! +# This is the internal name of the project and the name of JUCE's shared code "target" +# Note: This cannot have spaces (it may be 2023, but you can't have it all!) +# Worry not, JUCE's PRODUCT_NAME can have spaces (and is DAWs display) +set(PROJECT_NAME "ZLTemplate") +set(PLUGIN_CODE "Temp") + +# Change me! +# Worry not, JUCE's PRODUCT_NAME can have spaces (and is what DAWs will display) +# You can also just have it be the same thing as PROJECT_NAME +# You may want to append the major version on the end of this (and PROJECT_NAME) ala: +# # set(PROJECT_NAME "MyPlugin_v${MAJOR_VERSION}") +# Doing so enables major versions to show up in IDEs and DAWs as separate plugins +# allowing you to change parameters and behavior without breaking existing user projects +set(PRODUCT_NAME "ZL Template") + +# Change me! Used for the MacOS bundle name and Installers +set(COMPANY_NAME "ZL") +set(PLUGIN_MANUFACTURER_CODE "Zliu") + +# Change me! Used for the MacOS bundle identifier (and signing) +set(BUNDLE_ID "com.zlaudio.plugins") + +set(LV2URI "https://github.com/ZL-Audio/${PROJECT_NAME}") + +# For simplicity, the name of the CMake project is also the name of the target +project(${PROJECT_NAME} VERSION ${CURRENT_VERSION}) + +# Change me! Set the plugin formats you want built +# Valid choices: AAX Unity VST VST3 AU AUv3 Standalone +if (CMAKE_SYSTEM_NAME STREQUAL "Darwin") + if (DEFINED ENV{PLUGIN_OS_FORMAT}) + set(FORMATS "$ENV{PLUGIN_OS_FORMAT}") + else () + set(FORMATS AU VST3 AAX) + endif() + if (DEFINED ENV{GITHUB_TOKEN}) + set(JUCE_AAX_COPY_DIR "/Users/runner/Library/Audio/Plug-Ins/AAX") + else () + set(JUCE_AAX_COPY_DIR "/Library/Application Support/Avid/Audio/Plug-Ins") + endif () +elseif (CMAKE_SYSTEM_NAME STREQUAL "Windows") + if (DEFINED ENV{PLUGIN_OS_FORMAT}) + set(FORMATS "$ENV{PLUGIN_OS_FORMAT}") + else () + set(FORMATS LV2 VST3 AAX) + endif() + set(JUCE_AAX_COPY_DIR "C:/Program Files/Common Files/Avid/Audio/Plug-Ins") +else () + if (DEFINED ENV{PLUGIN_OS_FORMAT}) + set(FORMATS "$ENV{PLUGIN_OS_FORMAT}") + else() + set(FORMATS LV2 VST3) + endif () +endif () + +# include boost for this project +# find_package(Boost 1.80.0 REQUIRED) + +# Configures universal binaries in CI +include(PamplejuceMacOS) + +# Couple tweaks that IMO should be JUCE defaults +include(JUCEDefaults) + +# JUCE is setup as a submodule in the /JUCE folder +# Locally, you must run `git submodule update --init --recursive` once +# and later `git submodule update --remote --merge` to keep it up to date +# On Github Actions, this is done as a part of actions/checkout +add_subdirectory(JUCE) + +# Add any other modules you want modules here, before the juce_add_plugin call + +# See `docs/CMake API.md` in the JUCE repo for all config options +juce_add_plugin("${PROJECT_NAME}" + # Icons for the standalone app + ICON_BIG "${CMAKE_CURRENT_SOURCE_DIR}/packaging/icon.png" + + # Change me! + COMPANY_NAME "${COMPANY_NAME}" + BUNDLE_ID "${BUNDLE_ID}" + + # On MacOS, plugin is copied to ~/Users/yourname/Library/Audio/Plug-Ins/ + COPY_PLUGIN_AFTER_BUILD TRUE + AAX_COPY_DIR "${JUCE_AAX_COPY_DIR}" + + # Change me! + # A four-character plugin id + # First character MUST be uppercase for AU formats + PLUGIN_MANUFACTURER_CODE "${PLUGIN_MANUFACTURER_CODE}" + + # Change me! + # A unique four-character plugin id + # Note: this must have at least one upper-case character + PLUGIN_CODE "${PLUGIN_CODE}" + FORMATS "${FORMATS}" + LV2URI "${LV2URI}" + + AU_MAIN_TYPE kAudioUnitType_Effect + VST3_CATEGORIES Fx + AAX_CATEGORY AAX_EPlugInCategory_Effect + + # The name of your final executable + # This is how it's listed in the DAW + # This can be different from PROJECT_NAME and can have spaces! + # You might want to use v${MAJOR_VERSION} here once you go to v2... + PRODUCT_NAME "${PRODUCT_NAME}") + +# This lets us use our code in both the JUCE targets and our Test target +# Without running into ODR violations +add_library(SharedCode INTERFACE) + +# C++20, please +# Use cxx_std_23 for C++23 (as of CMake v 3.20) +include(SharedCodeDefaults) + +# Manually list all .h and .cpp files for the plugin +# If you are like me, you'll use globs for your sanity. +# Just ensure you employ CONFIGURE_DEPENDS so the build system picks up changes +# If you want to appease the CMake gods and avoid globs, manually add files like so: +# set(SourceFiles Source/PluginEditor.h Source/PluginProcessor.h Source/PluginEditor.cpp Source/PluginProcessor.cpp) +file(GLOB_RECURSE SourceFiles CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/source/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/source/*.h") +target_sources(SharedCode INTERFACE ${SourceFiles}) + +# Adds a BinaryData target for embedding assets into the binary +include(Assets) + +# MacOS only: Cleans up folder and target organization on Xcode. +include(XcodePrettify) + +# This is where you can set preprocessor definitions for JUCE and your plugin +target_compile_definitions(SharedCode + INTERFACE + + # JUCE_WEB_BROWSER and JUCE_USE_CURL off by default + JUCE_WEB_BROWSER=0 # If you set this to 1, add `NEEDS_WEB_BROWSER TRUE` to the `juce_add_plugin` call + JUCE_USE_CURL=0 # If you set this to 1, add `NEEDS_CURL TRUE` to the `juce_add_plugin` call + JUCE_VST3_CAN_REPLACE_VST2=0 + + # lets the app known if we're Debug or Release + CMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" + VERSION="${CURRENT_VERSION}" + + # JUCE_DISPLAY_SPLASH_SCREEN=0 + + # JucePlugin_Name is for some reason doesn't use the nicer PRODUCT_NAME + PRODUCT_NAME_WITHOUT_VERSION="${PRODUCT_NAME}" + # JUCE_COREGRAPHICS_RENDER_WITH_MULTIPLE_PAINT_CALLS=1 + JUCE_SILENCE_XCODE_15_LINKER_WARNING=1 +) + +# Link to any other modules you added (with juce_add_module) here! +# Usually JUCE modules must have PRIVATE visibility +# See https://github.com/juce-framework/JUCE/blob/master/docs/CMake%20API.md#juce_add_module +# However, with Pamplejuce, you'll link modules to SharedCode with INTERFACE visibility +# This allows the JUCE plugin targets and the Tests target to link against it +target_link_libraries(SharedCode + INTERFACE + Assets + juce_audio_utils + juce_audio_processors + juce_dsp + juce_gui_basics + juce_gui_extra + juce::juce_recommended_config_flags + juce::juce_recommended_lto_flags + juce::juce_recommended_warning_flags) +# Boost::boost) + +# Link the JUCE plugin targets our SharedCode target +target_link_libraries("${PROJECT_NAME}" PRIVATE SharedCode) + +# IPP support, comment out to disable +include(PamplejuceIPP) + +# A separate target keeps the Tests target fast! +# include(Benchmarks) + +# Pass some config to GA (like our PRODUCT_NAME) +include(GitHubENV) \ No newline at end of file diff --git a/JUCE b/JUCE new file mode 160000 index 0000000..46c2a95 --- /dev/null +++ b/JUCE @@ -0,0 +1 @@ +Subproject commit 46c2a95905abffe41a7aa002c70fb30bd3b626ef diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..46ff6af --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +# GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b27240 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +

+ + +

+ +# ZLTemplate +![pluginval]() +[![License](https://img.shields.io/badge/License-GPL3-blue.svg)](https://opensource.org/licenses/GPL-3.0) +[![Downloads](https://img.shields.io/github/downloads/ZL-Audio/ZLTemplate/total)](https://somsubhra.github.io/github-release-stats/?username=ZL-Audio&repository=ZLTemplate&page=1&per_page=30) + +ZLTemplate is a template for building JUCE plugins (derived from [pamplejuce](https://github.com/sudara/pamplejuce)). + + + + +## License + +ZLTemplate is licensed under GPLv3, as found in the [LICENSE.md](LICENSE.md) file. diff --git a/assets/font/MiSansLatin-Medium.ttf b/assets/font/MiSansLatin-Medium.ttf new file mode 100644 index 0000000..975b306 Binary files /dev/null and b/assets/font/MiSansLatin-Medium.ttf differ diff --git a/assets/logo.svg b/assets/logo.svg new file mode 100644 index 0000000..e2e2b2f --- /dev/null +++ b/assets/logo.svg @@ -0,0 +1,4 @@ + + + + diff --git a/assets/zlaudio.svg b/assets/zlaudio.svg new file mode 100644 index 0000000..1e47f42 --- /dev/null +++ b/assets/zlaudio.svg @@ -0,0 +1,70 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/cmake-includes/Assets.cmake b/cmake-includes/Assets.cmake new file mode 100644 index 0000000..5a757b5 --- /dev/null +++ b/cmake-includes/Assets.cmake @@ -0,0 +1,10 @@ +# HEADS UP: Pamplejuce assumes anything you stick in the assets folder you want to included in your binary! +# This makes life easy, but will bloat your binary needlessly if you include unused files +file(GLOB_RECURSE AssetFiles CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/assets/*") + +# Setup our binary data as a target called Assets +juce_add_binary_data(Assets SOURCES ${AssetFiles}) + +# Required for Linux happiness: +# See https://forum.juce.com/t/loading-pytorch-model-using-binarydata/39997/2 +set_target_properties(Assets PROPERTIES POSITION_INDEPENDENT_CODE TRUE) diff --git a/cmake-includes/Benchmarks.cmake b/cmake-includes/Benchmarks.cmake new file mode 100644 index 0000000..18f8714 --- /dev/null +++ b/cmake-includes/Benchmarks.cmake @@ -0,0 +1,26 @@ +file(GLOB_RECURSE BenchmarkFiles CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/benchmarks/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/Benchmarks/*.h") + +# Organize the test source in the Tests/ folder in the IDE +source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/benchmarks PREFIX "" FILES ${BenchmarkFiles}) + +add_executable(Benchmarks ${BenchmarkFiles}) +target_compile_features(Benchmarks PRIVATE cxx_std_20) +catch_discover_tests(Benchmarks) + +# Our benchmark executable also wants to know about our plugin code... +target_include_directories(Benchmarks PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/source) + +# Copy over compile definitions from our plugin target so it has all the JUCEy goodness +target_compile_definitions(Benchmarks PRIVATE $) + +# And give tests access to our shared code +target_link_libraries(Benchmarks PRIVATE SharedCode Catch2::Catch2WithMain) + +# Make an Xcode Scheme for the test executable so we can run tests in the IDE +set_target_properties(Benchmarks PROPERTIES XCODE_GENERATE_SCHEME ON) + +# When running Tests we have specific needs +target_compile_definitions(Benchmarks PUBLIC + JUCE_MODAL_LOOPS_PERMITTED=1 # let us run Message Manager in tests + RUN_PAMPLEJUCE_TESTS=1 # also run tests in module .cpp files guarded by RUN_PAMPLEJUCE_TESTS +) diff --git a/cmake-includes/CHANGELOG.md b/cmake-includes/CHANGELOG.md new file mode 100644 index 0000000..1b5f885 --- /dev/null +++ b/cmake-includes/CHANGELOG.md @@ -0,0 +1,8 @@ +## 2023-09-04 + +* Added `SharedCodeDefaults.cmake` which handles setting C++20 and fast math on the `SharedCode` Target. +* Modified CTest to report on failure + +## 2023-09-04 + +Initial commit. Added this CHANGELOG. diff --git a/cmake-includes/GitHubENV.cmake b/cmake-includes/GitHubENV.cmake new file mode 100644 index 0000000..5efac9f --- /dev/null +++ b/cmake-includes/GitHubENV.cmake @@ -0,0 +1,13 @@ +# Write some temp files to make GitHub Actions / packaging easy + +if ((DEFINED ENV{CI})) + set (env_file "${PROJECT_SOURCE_DIR}/.env") + message ("Writing ENV file for CI: ${env_file}") + + # the first call truncates, the rest append + file(WRITE "${env_file}" "PROJECT_NAME=${PROJECT_NAME}\n") + file(APPEND "${env_file}" "PRODUCT_NAME=${PRODUCT_NAME}\n") + file(APPEND "${env_file}" "VERSION=${CURRENT_VERSION}\n") + file(APPEND "${env_file}" "BUNDLE_ID=${BUNDLE_ID}\n") + file(APPEND "${env_file}" "COMPANY_NAME=${COMPANY_NAME}\n") +endif () diff --git a/cmake-includes/GitVersion.cmake b/cmake-includes/GitVersion.cmake new file mode 100644 index 0000000..2e48a3c --- /dev/null +++ b/cmake-includes/GitVersion.cmake @@ -0,0 +1,42 @@ +# Read version from git tag and write it to VERSION file +find_package(Git) + +if (GIT_EXECUTABLE) + # Generate a git-describe version string from Git repository tags + execute_process( + COMMAND ${GIT_EXECUTABLE} describe --tags --abbrev=0 + OUTPUT_VARIABLE GIT_DESCRIBE_VERSION + RESULT_VARIABLE GIT_DESCRIBE_ERROR_CODE + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + if (NOT GIT_DESCRIBE_ERROR_CODE) + set(FOOBAR_VERSION ${GIT_DESCRIBE_VERSION}) + message(WARNING "Using the version \"${FOOBAR_VERSION}\".") + endif () + execute_process( + COMMAND ${GIT_EXECUTABLE} log -1 --format=%h + OUTPUT_VARIABLE GIT_CURRENT_HASH + RESULT_VARIABLE GIT_HASH_ERROR_CODE + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + if (NOT GIT_HASH_ERROR_CODE) + set(FOOBAR_HASH ${GIT_CURRENT_HASH}) + endif () +endif () + +if (NOT DEFINED FOOBAR_VERSION) + set(FOOBAR_VERSION 0.0.0) + message(WARNING "Failed to determine VERSION from Git tags. Using default version \"${FOOBAR_VERSION}\".") +endif () +if (NOT DEFINED FOOBAR_HASH) + set(FOOBAR_HASH "0000000") + message(WARNING "Failed to determine HASH from Git logs. Using default hash \"${FOOBAR_HASH}\".") +endif () + +string(REPLACE "v" "" FOOBAR_VERSION_WITHOUT_V "${FOOBAR_VERSION}") + +file(WRITE VERSION "${FOOBAR_VERSION_WITHOUT_V}") + +add_definitions(-DZLEQUALIZER_CURRENT_VERSION="${FOOBAR_VERSION_WITHOUT_V}") + +add_definitions(-DZLEQUALIZER_CURRENT_HASH="${FOOBAR_HASH}") \ No newline at end of file diff --git a/cmake-includes/JUCEDefaults.cmake b/cmake-includes/JUCEDefaults.cmake new file mode 100644 index 0000000..77435ee --- /dev/null +++ b/cmake-includes/JUCEDefaults.cmake @@ -0,0 +1,20 @@ +# Adds all the module sources so they appear correctly in the IDE +# Must be set before JUCE is added as a sub-dir (or any targets are made) +# https://github.com/juce-framework/JUCE/commit/6b1b4cf7f6b1008db44411f2c8887d71a3348889 +set_property(GLOBAL PROPERTY USE_FOLDERS YES) + +# Creates a /Modules directory in the IDE with the JUCE Module code +option(JUCE_ENABLE_MODULE_SOURCE_GROUPS "Show all module sources in IDE projects" ON) + +# Static runtime please +# See https://github.com/sudara/pamplejuce/issues/111 +if (WIN32) + set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$:Debug>" CACHE INTERNAL "") +endif () + +# Color our warnings and errors +if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU") + add_compile_options(-fdiagnostics-color=always) +elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") + add_compile_options(-fcolor-diagnostics) +endif () diff --git a/cmake-includes/PamplejuceIPP.cmake b/cmake-includes/PamplejuceIPP.cmake new file mode 100644 index 0000000..40d08a0 --- /dev/null +++ b/cmake-includes/PamplejuceIPP.cmake @@ -0,0 +1,11 @@ +# When present, use Intel IPP for performance on Windows +if (WIN32) # Can't use MSVC here, as it won't catch Clang on Windows + find_package(IPP) + if (IPP_FOUND) + target_link_libraries(SharedCode INTERFACE IPP::ipps IPP::ippcore IPP::ippi IPP::ippcv) + message("IPP LIBRARIES FOUND") + target_compile_definitions(SharedCode INTERFACE PAMPLEJUCE_IPP=1) + else () + message("IPP LIBRARIES *NOT* FOUND") + endif () +endif () diff --git a/cmake-includes/PamplejuceMacOS.cmake b/cmake-includes/PamplejuceMacOS.cmake new file mode 100644 index 0000000..e075922 --- /dev/null +++ b/cmake-includes/PamplejuceMacOS.cmake @@ -0,0 +1,14 @@ + +# This must be set before the project() call +# see: https://cmake.org/cmake/help/latest/variable/CMAKE_OSX_DEPLOYMENT_TARGET.html +set(CMAKE_OSX_DEPLOYMENT_TARGET "10.13" CACHE STRING "Support macOS down to High Sierra") + +# Building universal binaries on macOS increases build time +# This is set on CI but not during local dev +if ((DEFINED ENV{CI}) AND (CMAKE_BUILD_TYPE STREQUAL "Release")) + message("Building for Apple Silicon and x86_64") + set(CMAKE_OSX_ARCHITECTURES arm64 x86_64) +endif () + +# By default we don't want Xcode schemes to be made for modules, etc +set(CMAKE_XCODE_GENERATE_SCHEME OFF) diff --git a/cmake-includes/PamplejuceVersion.cmake b/cmake-includes/PamplejuceVersion.cmake new file mode 100644 index 0000000..cc33759 --- /dev/null +++ b/cmake-includes/PamplejuceVersion.cmake @@ -0,0 +1,9 @@ +# Reads in our VERSION file and sticks in it CURRENT_VERSION variable +# Be sure the file has no newlines! +# This exposes CURRENT_VERSION to the build system +# And it's later fed to JUCE so it shows up as VERSION in your IDE +file(STRINGS VERSION CURRENT_VERSION) + +# Figure out the major version to append to our PROJECT_NAME +string(REGEX MATCH "([0-9]+)" MAJOR_VERSION ${CURRENT_VERSION}) +message(STATUS "Major version: ${MAJOR_VERSION}") diff --git a/cmake-includes/README.md b/cmake-includes/README.md new file mode 100644 index 0000000..dce974c --- /dev/null +++ b/cmake-includes/README.md @@ -0,0 +1,33 @@ +# CMake Includes for Pamplejuce + +Hi there! + +## What is this? + +It's most of the actual CMake functionality used by [Pamplejuce](https://github.com/sudara/pamplejuce), my template repository for plugins in the JUCE framework. + +## Why is this its own git submodule? + +It's to help projects built by the template pull in the lastest changes. + +[Pamplejuce](https://github.com/sudara/pamplejuce) is a template repository. Unlike most "dependencies," when you hit "Create Template" you are literally copying and pasting the code. Which sorta sucks, as people can't get fixes or updates. + +## Why would I want updates? + +For at least the gritty CMake details, there are fixes, improvements and additional functionality being added. + +In the best case, as a submodule, you can pull in the fixes and improvements. + +In the worst case, this seperate repo will help you see what exactly changed in Pamplejuce. + +## Is it risky? + +It could be! + +As of 2023, Pamplejuce is still being changed around a bunch, with the goal of being a better and better ecosystem for developers. + +That means there could be breakage when you pull. + +## What changed recently tho? + +See [CHANGELOG.md](CHANGELOG.md). diff --git a/cmake-includes/SharedCodeDefaults.cmake b/cmake-includes/SharedCodeDefaults.cmake new file mode 100644 index 0000000..4e89322 --- /dev/null +++ b/cmake-includes/SharedCodeDefaults.cmake @@ -0,0 +1,19 @@ +if (MSVC) + # fast math and better simd support in RELEASE + # https://learn.microsoft.com/en-us/cpp/build/reference/fp-specify-floating-point-behavior?view=msvc-170#fast + target_compile_options(SharedCode INTERFACE $<$:/fp:fast>) +else () + # See the implications here: + # https://stackoverflow.com/q/45685487 + target_compile_options(SharedCode INTERFACE $<$:-Ofast>) + target_compile_options(SharedCode INTERFACE $<$:-Ofast>) +endif () + +# Tell MSVC to properly report what c++ version is being used +if (MSVC) + target_compile_options(SharedCode INTERFACE /Zc:__cplusplus) +endif () + +# C++20, please +# Use cxx_std_23 for C++23 (as of CMake v 3.20) +target_compile_features(SharedCode INTERFACE cxx_std_20) \ No newline at end of file diff --git a/cmake-includes/Tests.cmake b/cmake-includes/Tests.cmake new file mode 100644 index 0000000..ce68548 --- /dev/null +++ b/cmake-includes/Tests.cmake @@ -0,0 +1,53 @@ +# Required for ctest (which is just an easier way to run in cross-platform CI) +# include(CTest) could be used too, but adds additional targets we don't care about +# See: https://github.com/catchorg/Catch2/issues/2026 +# You can also forgo ctest entirely and call ./Tests directly from the build dir +enable_testing() + +# Go into detail when there's a CTest failure +set(CTEST_OUTPUT_ON_FAILURE ON) +set_property(GLOBAL PROPERTY CTEST_TARGETS_ADDED 1) + +# "GLOBS ARE BAD" is brittle and silly dev UX, sorry CMake! +file(GLOB_RECURSE TestFiles CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/tests/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/tests/*.h") + +# Organize the test source in the Tests/ folder in Xcode +source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/tests PREFIX "" FILES ${TestFiles}) + +# Use Catch2 v3 on the devel branch +Include(FetchContent) +FetchContent_Declare( + Catch2 + GIT_REPOSITORY https://github.com/catchorg/Catch2.git + GIT_PROGRESS TRUE + GIT_SHALLOW TRUE + GIT_TAG v3.4.0) +FetchContent_MakeAvailable(Catch2) # find_package equivalent + +# Setup the test executable, again C++20 please +add_executable(Tests ${TestFiles}) +target_compile_features(Tests PRIVATE cxx_std_20) + +# Our test executable also wants to know about our plugin code... +target_include_directories(Tests PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/source) + +# Copy over compile definitions from our plugin target so it has all the JUCEy goodness +target_compile_definitions(Tests PRIVATE $) + +# And give tests access to our shared code +target_link_libraries(Tests PRIVATE SharedCode Catch2::Catch2WithMain) + +# Make an Xcode Scheme for the test executable so we can run tests in the IDE +set_target_properties(Tests PROPERTIES XCODE_GENERATE_SCHEME ON) + +# When running Tests we have specific needs +target_compile_definitions(Tests PUBLIC + JUCE_MODAL_LOOPS_PERMITTED=1 # let us run Message Manager in tests + RUN_PAMPLEJUCE_TESTS=1 # also run tests in other module .cpp files guarded by RUN_PAMPLEJUCE_TESTS +) + +# Load and use the .cmake file provided by Catch2 +# https://github.com/catchorg/Catch2/blob/devel/docs/cmake-integration.md +# We have to manually provide the source directory here for now +include(${Catch2_SOURCE_DIR}/extras/Catch.cmake) +catch_discover_tests(Tests) diff --git a/cmake-includes/XcodePrettify.cmake b/cmake-includes/XcodePrettify.cmake new file mode 100644 index 0000000..c6ec34a --- /dev/null +++ b/cmake-includes/XcodePrettify.cmake @@ -0,0 +1,31 @@ +# No, we don't want our source buried in extra nested folders +set_target_properties(SharedCode PROPERTIES FOLDER "") + +# The Xcode source tree should uhhh, still look like the source tree, yo +source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/source PREFIX "" FILES ${SourceFiles}) + +# It tucks the Plugin varieties into a "Targets" folder and generate an Xcode Scheme manually +# Xcode scheme generation is turned off globally to limit noise from other targets +# The non-hacky way of doing this is via the global PREDEFINED_TARGETS_FOLDER property +# However that doesn't seem to be working in Xcode +# Not all plugin types (au, vst) available on each build type (win, macos, linux) +foreach (target ${FORMATS} "All") + if (TARGET ${PROJECT_NAME}_${target}) + set_target_properties(${PROJECT_NAME}_${target} PROPERTIES + # Tuck the actual plugin targets into a folder where they won't bother us + FOLDER "Targets" + # Let us build the target in Xcode + XCODE_GENERATE_SCHEME ON) + + # Set the default executable that Xcode will open on build + # Note: you must manually build the AudioPluginHost.xcodeproj in the JUCE subdir + if ((NOT target STREQUAL "All") AND (NOT target STREQUAL "Standalone")) + set_target_properties(${PROJECT_NAME}_${target} PROPERTIES + XCODE_SCHEME_EXECUTABLE "${CMAKE_CURRENT_SOURCE_DIR}/JUCE/extras/AudioPluginHost/Builds/MacOSX/build/Debug/AudioPluginHost.app") + endif () + endif () +endforeach () + +if (TARGET Assets) + set_target_properties(Assets PROPERTIES FOLDER "Targets") +endif () diff --git a/docs/zlaudio.svg b/docs/zlaudio.svg new file mode 100644 index 0000000..77a89d2 --- /dev/null +++ b/docs/zlaudio.svg @@ -0,0 +1,70 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/licenses/JUCE_LICENSE.md b/licenses/JUCE_LICENSE.md new file mode 100644 index 0000000..2a05a45 --- /dev/null +++ b/licenses/JUCE_LICENSE.md @@ -0,0 +1,62 @@ +# The JUCE Framework + +The JUCE Framework is an open source framework licensed under a combination of +open source and commercial licences. + +The JUCE Framwork modules are dual-licensed under the +[AGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html) and the commercial [JUCE +licence](https://juce.com/legal/juce-8-licence/). + +## The JUCE Licence + +If you are not licensing the JUCE Framework modules under the +[AGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html) then by downloading, +installing, or using the JUCE Framework, or combining the JUCE Framework with +any other source code, object code, content or any other copyrightable work, you +agree to the terms of the the [JUCE 8 End User Licence +Agreement](https://juce.com/legal/juce-8-licence/), and all incorporated terms +including the [JUCE Privacy Policy](https://juce.com/legal/juce-privacy-policy/) +and the [JUCE Website Terms of +Service](https://juce.com/legal/juce-website-terms-of-service/), as applicable, +which will bind you. If you do not agree to the terms of this Agreement, we will +not license the JUCE Framework to you, and you must discontinue the installation +or download process and cease use of the JUCE Framework. + +THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, +WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF MERCHANTABILITY OR FITNESS +FOR A PARTICULAR PURPOSE, ARE DISCLAIMED. + +For more information, visit the [JUCE website](https://juce.com). + +Full licence terms: +- [JUCE 8 End User Licence Agreement](https://juce.com/legal/juce-8-licence/) +- [JUCE Privacy Policy](https://juce.com/legal/juce-privacy-policy/) +- [JUCE Website Terms of Service](https://juce.com/legal/juce-website-terms-of-service/) + +## The JUCE Framework Dependencies + +The JUCE modules contain the following dependencies: +- [Oboe](modules/juce_audio_devices/native/oboe/) ([Apache 2.0](modules/juce_audio_devices/native/oboe/LICENSE)) +- [FLAC](modules/juce_audio_formats/codecs/flac/) ([BSD](modules/juce_audio_formats/codecs/flac/Flac%20Licence.txt)) +- [Ogg Vorbis](modules/juce_audio_formats/codecs/oggvorbis/) ([BSD](modules/juce_audio_formats/codecs/oggvorbis/Ogg%20Vorbis%20Licence.txt)) +- [AudioUnitSDK](modules/juce_audio_plugin_client/AU/AudioUnitSDK/) ([Apache 2.0](modules/juce_audio_plugin_client/AU/AudioUnitSDK/LICENSE.txt)) +- [LV2](modules/juce_audio_processors/format_types/LV2_SDK/) ([ISC](modules/juce_audio_processors/format_types/LV2_SDK/lv2/COPYING)) +- [pslextensions](modules/juce_audio_processors/format_types/pslextensions/ipslcontextinfo.h) ([Public domain](modules/juce_audio_processors/format_types/pslextensions/ipslcontextinfo.h)) +- [VST3](modules/juce_audio_processors/format_types/VST3_SDK/) ([Proprietary Steinberg VST3/GPLv3](modules/juce_audio_processors/format_types/VST3_SDK/LICENSE.txt)) +- [zlib](modules/juce_core/zip/zlib/) ([zlib](modules/juce_core/zip/zlib/README)) +- [Box2D](modules/juce_box2d/box2d/) ([zlib](modules/juce_box2d/box2d/Box2D.h)) +- [jpeglib](modules/juce_graphics/image_formats/jpglib/) ([Independent JPEG Group License](modules/juce_graphics/image_formats/jpglib/README)) +- [pnglib](modules/juce_graphics/image_formats/pnglib/) ([zlib](modules/juce_graphics/image_formats/pnglib/LICENSE)) +- [GLEW](modules/juce_opengl/opengl/juce_gl.h) ([BSD](modules/juce_opengl/opengl/juce_gl.h)), including [Mesa](modules/juce_opengl/opengl/juce_gl.h) ([MIT](modules/juce_opengl/opengl/juce_gl.h)) and [Khronos](modules/juce_opengl/opengl/juce_gl.h) ([MIT](modules/juce_opengl/opengl/juce_gl.h)) + +The JUCE examples are licensed under the terms of the +[ISC license](http://www.isc.org/downloads/software-support-policy/isc-license/). + +Dependencies in the examples: +- [reaper-sdk](examples/Plugins/extern/) ([zlib](examples/Plugins/extern/LICENSE.md)) + +Dependencies in the bundled applications: +- [Projucer icons](extras/Projucer/Source/Utility/UI/jucer_Icons.cpp) ([MIT](extras/Projucer/Source/Utility/UI/jucer_Icons.cpp)) + +Dependencies in the build system: +- [Android Gradle](examples/DemoRunner/Builds/Android/gradle/wrapper/LICENSE-for-gradlewrapper.txt) ([Apache 2.0](examples/DemoRunner/Builds/Android/gradle/wrapper/LICENSE-for-gradlewrapper.txt)) diff --git a/licenses/pamplejuce_LICENSE.txt b/licenses/pamplejuce_LICENSE.txt new file mode 100644 index 0000000..1536cc6 --- /dev/null +++ b/licenses/pamplejuce_LICENSE.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Sudara Williams + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/modules/.gitkeep b/modules/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/packaging/Readme.rtf b/packaging/Readme.rtf new file mode 100644 index 0000000..6e31a0b --- /dev/null +++ b/packaging/Readme.rtf @@ -0,0 +1,152 @@ +{\rtf1\ansi\deff0{\fonttbl{\f0 \fswiss Helvetica;}{\f1 Courier;}} +{\colortbl;\red255\green0\blue0;\red0\green0\blue255;} +\widowctrl\hyphauto + +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs28 GNU GENERAL PUBLIC LICENSE\par} +{\pard \ql \f0 \sa180 \li0 \fi0 Version 3, 29 June 2007\par} +{\pard \ql \f0 \sa180 \li0 \fi0 Copyright \u169? 2007 Free Software Foundation, Inc. <{\field{\*\fldinst{HYPERLINK "https://fsf.org/"}}{\fldrslt{\ul +https://fsf.org/ +}}} +>\par} +{\pard \ql \f0 \sa180 \li0 \fi0 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs28 Preamble\par} +{\pard \ql \f0 \sa180 \li0 \fi0 The GNU General Public License is a free, copyleft license for software and other kinds of works.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 The precise terms and conditions for copying, distribution and modification follow.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs28 TERMS AND CONDITIONS\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 0. Definitions.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \u8220"This License\u8221" refers to version 3 of the GNU General Public License.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \u8220"Copyright\u8221" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \u8220"The Program\u8221" refers to any copyrightable work licensed under this License. Each licensee is addressed as \u8220"you\u8221". \u8220"Licensees\u8221" and \u8220"recipients\u8221" may be individuals or organizations.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 To \u8220"modify\u8221" 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 \u8220"modified version\u8221" of the earlier work or a work \u8220"based on\u8221" the earlier work.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 A \u8220"covered work\u8221" means either the unmodified Program or a work based on the Program.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 To \u8220"propagate\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 To \u8220"convey\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 An interactive user interface displays \u8220"Appropriate Legal Notices\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 1. Source Code.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 The \u8220"source code\u8221" for a work means the preferred form of the work for making modifications to it. \u8220"Object code\u8221" means any non-source form of a work.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 A \u8220"Standard Interface\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 The \u8220"System Libraries\u8221" 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 \u8220"Major Component\u8221", 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 The \u8220"Corresponding Source\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 The Corresponding Source for a work in source code form is that same work.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 2. Basic Permissions.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 4. Conveying Verbatim Copies.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 5. Conveying Modified Source Versions.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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:\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab a) The work must carry prominent notices stating that you modified it, and giving a relevant date.\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab 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 \u8220"keep intact all notices\u8221".\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab 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.\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab 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.\sa180\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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 \u8220"aggregate\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 6. Conveying Non-Source Forms.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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:\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab 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.\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab 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.\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab 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.\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab 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.\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab 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.\sa180\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 A \u8220"User Product\u8221" is either (1) a \u8220"consumer product\u8221", 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, \u8220"normally used\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \u8220"Installation Information\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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).\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 7. Additional Terms.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \u8220"Additional permissions\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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:\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab 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\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab 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\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab d) Limiting the use for publicity purposes of names of licensors or authors of the material; or\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or\par} +{\pard \ql \f0 \sa0 \li360 \fi-360 \bullet \tx360\tab 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.\sa180\par} +{\pard \ql \f0 \sa180 \li0 \fi0 All other non-permissive additional terms are considered \u8220"further restrictions\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 8. Termination.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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).\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 9. Acceptance Not Required for Having Copies.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 10. Automatic Licensing of Downstream Recipients.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 An \u8220"entity transaction\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 11. Patents.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 A \u8220"contributor\u8221" 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 \u8220"contributor version\u8221".\par} +{\pard \ql \f0 \sa180 \li0 \fi0 A contributor's \u8220"essential patent claims\u8221" 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, \u8220"control\u8221" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 In the following three paragraphs, a \u8220"patent license\u8221" 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 \u8220"grant\u8221" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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. \u8220"Knowingly relying\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 A patent license is \u8220"discriminatory\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 12. No Surrender of Others' Freedom.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 13. Use with the GNU Affero General Public License.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 14. Revised Versions of this License.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License \u8220"or any later version\u8221" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 15. Disclaimer of Warranty.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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 \u8220"AS IS\u8221" 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 16. Limitation of Liability.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs24 17. Interpretation of Sections 15 and 16.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 END OF TERMS AND CONDITIONS\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs28 How to Apply These Terms to Your New Programs\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 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 \u8220"copyright\u8221" line and a pointer to where the full notice is found.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \f1 \line + Copyright (C) \line +\line + This program is free software: you can redistribute it and/or modify\line + it under the terms of the GNU General Public License as published by\line + the Free Software Foundation, either version 3 of the License, or\line + (at your option) any later version.\line +\line + This program is distributed in the hope that it will be useful,\line + but WITHOUT ANY WARRANTY; without even the implied warranty of\line + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\line + GNU General Public License for more details.\line +\line + You should have received a copy of the GNU General Public License\line + along with this program. If not, see .\par} +{\pard \ql \f0 \sa180 \li0 \fi0 Also add information on how to contact you by electronic and paper mail.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:\par} +{\pard \ql \f0 \sa180 \li0 \fi0 \f1 Copyright (C) \line + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.\line + This is free software, and you are welcome to redistribute it\line + under certain conditions; type `show c' for details.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an \u8220"about box\u8221".\par} +{\pard \ql \f0 \sa180 \li0 \fi0 You should also get your employer (if you work as a programmer) or school, if any, to sign a \u8220"copyright disclaimer\u8221" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <{\field{\*\fldinst{HYPERLINK "https://www.gnu.org/licenses/"}}{\fldrslt{\ul +https://www.gnu.org/licenses/ +}}} +>.\par} +{\pard \ql \f0 \sa180 \li0 \fi0 The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <{\field{\*\fldinst{HYPERLINK "https://www.gnu.org/licenses/why-not-lgpl.html"}}{\fldrslt{\ul +https://www.gnu.org/licenses/why-not-lgpl.html +}}} +>.\par} +} \ No newline at end of file diff --git a/packaging/icon.icns b/packaging/icon.icns new file mode 100644 index 0000000..624a0ab Binary files /dev/null and b/packaging/icon.icns differ diff --git a/packaging/icon.ico b/packaging/icon.ico new file mode 100644 index 0000000..ebb4ed6 Binary files /dev/null and b/packaging/icon.ico differ diff --git a/packaging/icon.png b/packaging/icon.png new file mode 100644 index 0000000..ed24846 Binary files /dev/null and b/packaging/icon.png differ diff --git a/packaging/packager_Windows.py b/packaging/packager_Windows.py new file mode 100644 index 0000000..2f2b5d9 --- /dev/null +++ b/packaging/packager_Windows.py @@ -0,0 +1,120 @@ +import os +import sys +import subprocess +from pathlib import PureWindowsPath + + +def main(): + temp_dir = "./windowstmp" + subprocess.run(["mkdir", temp_dir]) + + project_name = os.getenv("PROJECT_NAME", "Pamplejuce") + product_name = os.getenv("PRODUCT_NAME", "Pamplejuce Demo") + version = os.getenv("VERSION", "0.0.0") + bundle_id = os.getenv("BUNDLE_ID", "") + build_dir = os.getenv("BUILD_DIR", "") + artifact_name = os.getenv("ARTIFACT_NAME", "") + + outfile = open("packaging/installer.iss", "w") + + outfile.write(r''' +#define Version Trim(FileRead(FileOpen("..\VERSION"))) +#define ProjectName GetEnv('PROJECT_NAME') +#define ProductName GetEnv('PRODUCT_NAME') +#define Publisher GetEnv('COMPANY_NAME') +#define Year GetDateTimeString("yyyy","","") + +[Setup] +ArchitecturesInstallIn64BitMode=x64 +ArchitecturesAllowed=x64 +AppName={#ProductName} +OutputBaseFilename={#ProductName}-{#Version}-Windows +AppCopyright=Copyright (C) {#Year} {#Publisher} +AppPublisher={#Publisher} +AppVersion={#Version} +DefaultDirName="{commoncf64}\VST3\{#ProductName}.vst3" +DisableDirPage=yes +CreateAppDir=no +''') + + if os.path.isfile("/packaging/icon.ico"): + outfile.write(r'SetupIconFile=..\packaging\icon.ico') + outfile.write("UninstallDisplayIcon={uninstallexe}") + if os.path.isfile("/packaging/EULA"): + outfile.write(r'LicenseFile="EULA"') + if os.path.isfile("/packaging/Readme.rtf"): + outfile.write(r'InfoBeforeFile="Readme.rtf"') + + outfile.write(''' +[Types] +Name: "full"; Description: "Full installation" +Name: "custom"; Description: "Custom installation"; Flags: iscustom +''') + + all_install_paths = [ + r'{commoncf64}\VST3', + r'{commoncf64}\LV2', + r'{commoncf64}\Avid\Audio\Plug-Ins', + r'{commonpf64}\ZLAudio'] + + plugin_formats, extensions, install_paths = [], [], [] + for plugin_format, extension, install_path in zip( + ["VST3", "LV2", "AAX", "Standalone"], + ["vst3", "lv2", "aaxplugin", "standalone"], + all_install_paths): + if plugin_format + "_PATH" in os.environ: + plugin_path = os.environ[plugin_format + "_PATH"] + if os.path.exists(plugin_path): + plugin_formats.append(plugin_format) + extensions.append(extension) + install_paths.append(install_path) + + outfile.write("[Components]\n") + for plugin_format, extension, install_path in zip(plugin_formats, extensions, install_paths): + outfile.write( + 'Name: "{}"; Description: {} {}; Types: full custom; Flags: checkablealone'.format( + extension, product_name, plugin_format + )) + outfile.write("\n") + + outfile.write("[UninstallDelete]\n") + for plugin_format, extension, install_path in zip(plugin_formats, extensions, install_paths): + outfile.write( + 'Type: filesandordirs; Name: "{}"'.format( + install_path + '\\' + product_name + 'Data' + )) + outfile.write("\n") + + outfile.write("[Files]\n") + for plugin_format, extension, install_path in zip(plugin_formats, extensions, install_paths): + if plugin_format == "Standalone": + outfile.write( + 'Source: "..\\{}"; DestDir: "{}"; Excludes: *.ilk; Flags: ignoreversion; Components: {}'.format( + str(PureWindowsPath(os.environ[plugin_format + "_PATH"])), + install_path + '\\' + product_name, + extension) + ) + else: + outfile.write( + 'Source: "..\\{}\\*"; DestDir: "{}"; Excludes: *.ilk; Flags: ignoreversion recursesubdirs; Components: {}'.format( + str(PureWindowsPath(os.environ[plugin_format + "_PATH"])), + install_path + '\\' + product_name + "." + extension + "\\", + extension) + ) + outfile.write("\n") + + outfile.write("[Run]\n") + for plugin_format, extension, install_path in zip(plugin_formats, extensions, install_paths): + outfile.write('Filename: "{cmd}"; ') + outfile.write('WorkingDir:"{}"; '.format(install_path)) + outfile.write('Parameters: "/C mklink /D ""{}"" ""{}"""; ' + .format(install_path + '\\' + product_name + 'Data', + '{commonappdata}\\{#ProductName}')) + outfile.write("Flags: runascurrentuser; ") + outfile.write("Components: " + extension) + outfile.write("\n") + + outfile.close() + +if __name__ == '__main__': + sys.exit(main()) diff --git a/packaging/packager_macOS.py b/packaging/packager_macOS.py new file mode 100644 index 0000000..394b159 --- /dev/null +++ b/packaging/packager_macOS.py @@ -0,0 +1,113 @@ +import os +import sys +import xml +import xml.etree.cElementTree as ET +import subprocess + + +def main(): + temp_dir = "./appletmp" + subprocess.run(["mkdir", temp_dir]) + + project_name = os.getenv("PROJECT_NAME", "Pamplejuce") + product_name = os.getenv("PRODUCT_NAME", "Pamplejuce Demo") + version = os.getenv("VERSION", "0.0.0") + bundle_id = os.getenv("BUNDLE_ID", "") + build_dir = os.getenv("BUILD_DIR", "") + artifact_name = os.getenv("ARTIFACT_NAME", "") + developer_id_app = os.getenv("DEVELOPER_ID_APPLICATION", "") + + # root + root = ET.Element("installer-gui-script", minSpecVersion="1") + # title + title = ET.SubElement(root, "title") + title.text = "{} {}".format(product_name, version) + # EULA + if os.path.isfile("packaging/EULA"): + eula = ET.SubElement(root, "license", file="EULA") + eula.set("mime-type", "text/plain") + # readme + if os.path.isfile("packaging/Readme.rtf"): + readme = ET.SubElement(root, "readme", file="Readme.rtf") + # options + options = ET.SubElement(root, "options", + customize="always", + rootVolumeOnly="true", + hostArchitectures="x86_64,arm64") + # domain + domain = ET.SubElement(root, "domain", + enable_anywhere="false", + enable_currentUserHome="false", + enable_localSystem="true") + # choices outline + outline = ET.SubElement(root, "choices-outline") + + install_paths = [ + "/Library/Audio/Plug-Ins/VST3", + "/Library/Audio/Plug-Ins/Components", + "/Library/Audio/Plug-Ins/LV2", + "/Library/Audio/Plug-Ins/CLAP", + "/Library/Application Support/Avid/Audio/Plug-Ins", + "/Applications" + ] + + print("Create packages") + for plugin_format, extension, install_path in zip( + ["VST3", "AU", "LV2", "CLAP", "AAX", "Standalone"], + ["vst3", "au", "lv2", "clap", "aax", "standalone"], + install_paths): + if plugin_format + "_PATH" in os.environ: + plugin_path = os.environ[plugin_format + "_PATH"] + if os.path.exists(plugin_path): + if developer_id_app != "" and extension != "aax": + subprocess.run( + 'codesign --force -s "{}" -v "{}" --deep --strict --options=runtime --timestamp'.format( + developer_id_app, plugin_path), shell=True) + + identifier = "{}.{}.{}.pkg".format(bundle_id, project_name, extension) + pkg_path = "{}/{}.{}.pkg".format(build_dir, product_name, extension) + + subprocess.run( + 'pkgbuild --identifier "{}" --version {} --component "{}" --install-location "{}" "{}"'.format( + identifier, version, plugin_path, install_path, pkg_path), shell=True) + ref = ET.SubElement(root, "pkg-ref", + id=identifier, version=version, onConclusion="none") + ref.text = pkg_path + choice = ET.SubElement(root, "choice", id=identifier, + visible="true", start_selected="true", + title="{} {}".format(product_name, plugin_format)) + ET.SubElement(choice, "pkg-ref", id=identifier) + ET.SubElement(outline, "line", choice=identifier) + + # write xml + print("") + print("Create distribution xml") + ET.indent(root, space="\t", level=0) + tree = ET.ElementTree(root) + tree.write("packaging/distribution.xml", encoding="utf-8", xml_declaration=True) + + print(ET.tostring(root, encoding='utf8').decode()) + + print("") + print("Create final package") + command_list = ["--distribution", "packaging/distribution.xml", + "--package-path", build_dir, + "--resources", "packaging", + artifact_name + "_unsigned.pkg"] + + subprocess.run(["productbuild"] + command_list) + + if os.path.exists("packaging/icon.icns"): + print("") + print("Attach icns") + subprocess.run(["mv", "packaging/icon.icns", "."]) + with open("tmpIcon.rsrc", "w") as outfile: + subprocess.run(["echo", "read 'icns' (-16455) \"icon.icns\";"], stdout=outfile) + print(subprocess.run(["Rez -append tmpIcon.rsrc -o \"{}_unsigned.pkg\"".format(artifact_name)], shell=True)) + print(subprocess.run(["SetFile -a C \"{}_unsigned.pkg\"".format(artifact_name)], shell=True)) + print("") + return 0 + + +if __name__ == '__main__': + sys.exit(main()) diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..44fc659 --- /dev/null +++ b/renovate.json @@ -0,0 +1,10 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:base" + ], + "git-submodules": { + "enabled": true + }, + "schedule": "after 5am on Friday" +} \ No newline at end of file diff --git a/source/PluginEditor.cpp b/source/PluginEditor.cpp new file mode 100644 index 0000000..4a09138 --- /dev/null +++ b/source/PluginEditor.cpp @@ -0,0 +1,34 @@ +#include "PluginEditor.h" + +PluginEditor::PluginEditor(PluginProcessor &p) + : AudioProcessorEditor(&p), processorRef(p) { + juce::ignoreUnused(processorRef); + + addAndMakeVisible(inspectButton); + + // Make sure that before the constructor has finished, you've set the + // editor's size to whatever you need it to be. + setSize(400, 300); +} + +PluginEditor::~PluginEditor() { +} + +void PluginEditor::paint(juce::Graphics &g) { + // (Our component is opaque, so we must completely fill the background with a solid colour) + g.fillAll(getLookAndFeel().findColour(juce::ResizableWindow::backgroundColourId)); + + auto area = getLocalBounds(); + g.setColour(juce::Colours::white); + g.setFont(16.0f); + auto helloWorld = juce::String("Hello from ") + PRODUCT_NAME_WITHOUT_VERSION + " v" + VERSION + " running in " + CMAKE_BUILD_TYPE; + g.drawText(helloWorld, area.removeFromTop(150), juce::Justification::centred, false); +} + +void PluginEditor::resized() { + // layout the positions of your child components here + auto area = getLocalBounds(); + area.removeFromBottom(50); + inspectButton.setBounds(getLocalBounds().withSizeKeepingCentre(100, 50)); +} diff --git a/source/PluginEditor.h b/source/PluginEditor.h new file mode 100644 index 0000000..ef9689f --- /dev/null +++ b/source/PluginEditor.h @@ -0,0 +1,24 @@ +#pragma once + +#include "PluginProcessor.h" +#include "BinaryData.h" + +//============================================================================== +class PluginEditor : public juce::AudioProcessorEditor { +public: + explicit PluginEditor(PluginProcessor &); + + ~PluginEditor() override; + + //============================================================================== + void paint(juce::Graphics &) override; + + void resized() override; + +private: + // This reference is provided as a quick way for your editor to + // access the processor object that created it. + PluginProcessor &processorRef; + juce::TextButton inspectButton{"Inspect the UI"}; + JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (PluginEditor) +}; diff --git a/source/PluginProcessor.cpp b/source/PluginProcessor.cpp new file mode 100644 index 0000000..0d2e27b --- /dev/null +++ b/source/PluginProcessor.cpp @@ -0,0 +1,166 @@ +#include "PluginProcessor.h" +#include "PluginEditor.h" + +//============================================================================== +PluginProcessor::PluginProcessor() + : AudioProcessor(BusesProperties() +#if !JucePlugin_IsMidiEffect +#if !JucePlugin_IsSynth + .withInput("Input", juce::AudioChannelSet::stereo(), true) +#endif + .withOutput("Output", juce::AudioChannelSet::stereo(), true) +#endif +) { +} + +PluginProcessor::~PluginProcessor() { +} + +//============================================================================== +const juce::String PluginProcessor::getName() const { + return JucePlugin_Name; +} + +bool PluginProcessor::acceptsMidi() const { +#if JucePlugin_WantsMidiInput + return true; +#else + return false; +#endif +} + +bool PluginProcessor::producesMidi() const { +#if JucePlugin_ProducesMidiOutput + return true; +#else + return false; +#endif +} + +bool PluginProcessor::isMidiEffect() const { +#if JucePlugin_IsMidiEffect + return true; +#else + return false; +#endif +} + +double PluginProcessor::getTailLengthSeconds() const { + return 0.0; +} + +int PluginProcessor::getNumPrograms() { + return 1; // NB: some hosts don't cope very well if you tell them there are 0 programs, + // so this should be at least 1, even if you're not really implementing programs. +} + +int PluginProcessor::getCurrentProgram() { + return 0; +} + +void PluginProcessor::setCurrentProgram(int index) { + juce::ignoreUnused(index); +} + +const juce::String PluginProcessor::getProgramName(int index) { + juce::ignoreUnused(index); + return {}; +} + +void PluginProcessor::changeProgramName(int index, const juce::String &newName) { + juce::ignoreUnused(index, newName); +} + +//============================================================================== +void PluginProcessor::prepareToPlay(double sampleRate, int samplesPerBlock) { + // Use this method as the place to do any pre-playback + // initialisation that you need.. + juce::ignoreUnused(sampleRate, samplesPerBlock); +} + +void PluginProcessor::releaseResources() { + // When playback stops, you can use this as an opportunity to free up any + // spare memory, etc. +} + +bool PluginProcessor::isBusesLayoutSupported(const BusesLayout &layouts) const { +#if JucePlugin_IsMidiEffect + juce::ignoreUnused (layouts); + return true; +#else + // This is the place where you check if the layout is supported. + // In this template code we only support mono or stereo. + if (layouts.getMainOutputChannelSet() != juce::AudioChannelSet::mono() + && layouts.getMainOutputChannelSet() != juce::AudioChannelSet::stereo()) + return false; + + // This checks if the input layout matches the output layout +#if !JucePlugin_IsSynth + if (layouts.getMainOutputChannelSet() != layouts.getMainInputChannelSet()) + return false; +#endif + + return true; +#endif +} + +void PluginProcessor::processBlock(juce::AudioBuffer &buffer, + juce::MidiBuffer &midiMessages) { + juce::ignoreUnused(midiMessages); + + juce::ScopedNoDenormals noDenormals; + auto totalNumInputChannels = getTotalNumInputChannels(); + auto totalNumOutputChannels = getTotalNumOutputChannels(); + + // In case we have more outputs than inputs, this code clears any output + // channels that didn't contain input data, (because these aren't + // guaranteed to be empty - they may contain garbage). + // This is here to avoid people getting screaming feedback + // when they first compile a plugin, but obviously you don't need to keep + // this code if your algorithm always overwrites all the output channels. + for (auto i = totalNumInputChannels; i < totalNumOutputChannels; ++i) + buffer.clear(i, 0, buffer.getNumSamples()); + + // This is the place where you'd normally do the guts of your plugin's + // audio processing... + // Make sure to reset the state if your inner loop is processing + // the samples and the outer loop is handling the channels. + // Alternatively, you can process the samples with the channels + // interleaved by keeping the same state. + for (int channel = 0; channel < totalNumInputChannels; ++channel) { + auto *channelData = buffer.getWritePointer(channel); + juce::ignoreUnused(channelData); + // ..do something to the data... + } +} + +//============================================================================== +bool PluginProcessor::hasEditor() const { + return true; // (change this to false if you choose to not supply an editor) +} + +juce::AudioProcessorEditor *PluginProcessor::createEditor() { + return new PluginEditor(*this); +} + +//============================================================================== +void PluginProcessor::getStateInformation(juce::MemoryBlock &destData) { + // You should use this method to store your parameters in the memory block. + // You could do that either as raw data, or use the XML or ValueTree classes + // as intermediaries to make it easy to save and load complex data. + juce::ignoreUnused(destData); +} + +void PluginProcessor::setStateInformation(const void *data, int sizeInBytes) { + // You should use this method to restore your parameters from this memory block, + // whose contents will have been created by the getStateInformation() call. + juce::ignoreUnused(data, sizeInBytes); +} + +//============================================================================== +// This creates new instances of the plugin.. +juce::AudioProcessor *JUCE_CALLTYPE + +createPluginFilter() { + return new PluginProcessor(); +} diff --git a/source/PluginProcessor.h b/source/PluginProcessor.h new file mode 100644 index 0000000..02c22f5 --- /dev/null +++ b/source/PluginProcessor.h @@ -0,0 +1,53 @@ +#pragma once + +#include + +#if (MSVC) +#include "ipps.h" +#endif + +class PluginProcessor : public juce::AudioProcessor { +public: + PluginProcessor(); + + ~PluginProcessor() override; + + void prepareToPlay(double sampleRate, int samplesPerBlock) override; + + void releaseResources() override; + + bool isBusesLayoutSupported(const BusesLayout &layouts) const override; + + void processBlock(juce::AudioBuffer &, juce::MidiBuffer &) override; + + juce::AudioProcessorEditor *createEditor() override; + + bool hasEditor() const override; + + const juce::String getName() const override; + + bool acceptsMidi() const override; + + bool producesMidi() const override; + + bool isMidiEffect() const override; + + double getTailLengthSeconds() const override; + + int getNumPrograms() override; + + int getCurrentProgram() override; + + void setCurrentProgram(int index) override; + + const juce::String getProgramName(int index) override; + + void changeProgramName(int index, const juce::String &newName) override; + + void getStateInformation(juce::MemoryBlock &destData) override; + + void setStateInformation(const void *data, int sizeInBytes) override; + +private: + JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (PluginProcessor) +};