Add faster and more accurate WindowedSinc interpolators. (#375) #1294
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Compile, Test, and Deploy | |
| on: | |
| pull_request: {} | |
| push: | |
| branches: | |
| - master | |
| release: | |
| types: [published] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| lint-python: | |
| runs-on: ${{ matrix.os }} | |
| continue-on-error: true | |
| strategy: | |
| matrix: | |
| python-version: ['3.12'] | |
| os: ['ubuntu-20.04'] | |
| name: Lint Python | |
| steps: | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - uses: actions/checkout@v4 | |
| - name: Install Ruff | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install ruff | |
| - name: Lint Python code | |
| run: ruff check ${{ runner.workspace }}/pedalboard --ignore=E203,F541 --exclude .git,dist,doc,build,vendors,'*.pyi' --line-length 100 | |
| - name: Check Python formatting | |
| run: ruff format --check ${{ runner.workspace }}/pedalboard --exclude .git,dist,doc,build,JUCE,examples,vendors,'*.pyi' --diff --line-length 100 | |
| lint-cpp: | |
| runs-on: 'ubuntu-20.04' | |
| continue-on-error: true | |
| name: Lint C++ | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # Don't check out submodules, as the action below will look at ALL C++ code! | |
| - name: Check C++ Formatting | |
| uses: jidicula/[email protected] | |
| with: | |
| clang-format-version: 14 | |
| exclude-regex: 'vendors/' | |
| fallback-style: LLVM | |
| # Build the native module with ccache enabled so we can share object files between builds: | |
| prime-ubuntu-build-caches: | |
| runs-on: ${{ matrix.os }} | |
| continue-on-error: false | |
| strategy: | |
| matrix: | |
| include: | |
| - { os: ubuntu-20.04, python-version: "3.12", compiler: "gcc", cc: "ccache gcc", cxx: "ccache g++" } | |
| name: Pre-build on ${{ matrix.os }} with ${{ matrix.compiler }} | |
| steps: | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install Linux dependencies | |
| if: runner.os == 'Linux' | |
| run: | | |
| sudo apt-get update \ | |
| && sudo apt-get install -y pkg-config libsndfile1 \ | |
| libx11-dev libxrandr-dev libxinerama-dev \ | |
| libxrender-dev libxcomposite-dev libxcb-xinerama0-dev \ | |
| libxcursor-dev libfreetype6 libfreetype6-dev \ | |
| libasound2-dev | |
| # We depend on ccache features that are only present in 4.8.0 and later, but installing from apt-get gives us v3. | |
| - name: Install ccache on Linux | |
| if: runner.os == 'Linux' | |
| run: | | |
| mkdir ccache | |
| curl -L https://github.com/ccache/ccache/releases/download/v4.9.1/ccache-4.9.1-linux-x86_64.tar.xz | tar xvJf - -C ccache | |
| mv ccache/ccache*/ccache /usr/local/bin/ccache | |
| chmod +x /usr/local/bin/ccache | |
| - name: Install ccache on macOS | |
| if: runner.os == 'macOS' | |
| run: brew install ccache | |
| - name: Install test dependencies | |
| env: | |
| # on macOS and with Python 3.10: building NumPy from source fails without these options: | |
| NPY_BLAS_ORDER: "" | |
| NPY_LAPACK_ORDER: "" | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install wheel | |
| pip install -r test-requirements.txt | |
| # TensorFlow is an optional dependency; if present, we'll run tests with it: | |
| # There are no environment specifiers to select when TensorFlow binaries are available. | |
| pip install tensorflow==2.13 || true | |
| - name: Restore Cached ${{ runner.os }} Objects | |
| id: cache-objects-restore | |
| uses: actions/cache/restore@v4 | |
| with: | |
| enableCrossOsArchive: true | |
| path: | | |
| ${{ runner.workspace }}/.ccache | |
| ${{ runner.workspace }}/pedalboard/build/lib* | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/pedalboard/juce_overrides | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/vendors | |
| key: ${{ runner.os }}-${{ matrix.compiler }}-ccache | |
| - name: Build pedalboard locally | |
| env: | |
| CCACHE_DIR: ${{ runner.workspace }}/.ccache | |
| CCACHE_BASEDIR: ${{ runner.workspace }} | |
| CCACHE_DEBUGDIR: ${{ runner.workspace }}/.ccache_debug | |
| CCACHE_SLOPPINESS: "pch_defines,include_file_mtime,include_file_ctime,time_macros,locale,random_seed,system_headers" | |
| CCACHE_COMPILERCHECK: none | |
| CCACHE_NOINODECACHE: 1 | |
| CCACHE_IGNOREOPTIONS: "-fno-strict-overflow -fwrapv -W* -arch x86_64 arm64 -dynamic -fno-common -g -I/usr/local/opt/*" | |
| CCACHE_LOGFILE: ${{ runner.workspace }}/.ccache_log | |
| CCACHE_DEBUG: "1" | |
| DISABLE_LTO: "1" # Speeds up un-cacheable link step which doesn't really increase performance in tests anyways | |
| CC: ${{ matrix.cc }} | |
| CXX: ${{ matrix.cxx }} | |
| run: python setup.py develop | |
| - name: Ensure ccache worked | |
| env: | |
| CCACHE_DIR: ${{ runner.workspace }}/.ccache | |
| run: | | |
| ccache --show-stats --verbose | |
| ccache --zero-stats | |
| # cat ${{ runner.workspace }}/.ccache_log || true | |
| # - name: Delete Existing Cache for ${{ runner.os }} Objects | |
| # run: gh cache delete --repo ${{ github.repository }} ${{ steps.cache-objects-restore.outputs.cache-primary-key }} | |
| # env: | |
| # # This token requires the "repo" scope. | |
| # GITHUB_TOKEN: ${{ secrets.ACTION_CLEAR_CACHES_TOKEN }} | |
| - name: Save Cached ${{ runner.os }} Objects | |
| id: cache-objects-save | |
| uses: actions/cache/save@v4 | |
| with: | |
| enableCrossOsArchive: true | |
| path: | | |
| ${{ runner.workspace }}/.ccache | |
| ${{ runner.workspace }}/pedalboard/build/lib* | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/pedalboard/juce_overrides | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/vendors | |
| key: ${{ steps.cache-objects-restore.outputs.cache-primary-key }} | |
| prime-macos-build-caches: | |
| runs-on: ${{ matrix.os }} | |
| continue-on-error: false | |
| strategy: | |
| matrix: | |
| include: | |
| - { os: macos-13, python-version: "3.12", compiler: "clang", cc: "ccache clang", cxx: "ccache clang++" } | |
| name: Pre-build on ${{ matrix.os }} with ${{ matrix.compiler }} | |
| steps: | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install ccache on macOS | |
| if: runner.os == 'macOS' | |
| run: brew install ccache | |
| - name: Install test dependencies | |
| env: | |
| # on macOS and with Python 3.10: building NumPy from source fails without these options: | |
| NPY_BLAS_ORDER: "" | |
| NPY_LAPACK_ORDER: "" | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install wheel | |
| pip install -r test-requirements.txt | |
| - name: Restore Cached ${{ runner.os }} Objects | |
| id: cache-objects-restore | |
| uses: actions/cache/restore@v4 | |
| with: | |
| enableCrossOsArchive: true | |
| path: | | |
| ${{ runner.workspace }}/.ccache | |
| ${{ runner.workspace }}/pedalboard/build/lib* | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/pedalboard/juce_overrides | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/vendors | |
| key: ${{ runner.os }}-${{ matrix.compiler }}-ccache | |
| - name: Build pedalboard locally | |
| env: | |
| CCACHE_DIR: ${{ runner.workspace }}/.ccache | |
| CCACHE_BASEDIR: ${{ runner.workspace }} | |
| CCACHE_DEBUGDIR: ${{ runner.workspace }}/.ccache_debug | |
| CCACHE_SLOPPINESS: "pch_defines,include_file_mtime,include_file_ctime,time_macros,locale,random_seed,system_headers" | |
| CCACHE_COMPILERCHECK: none | |
| CCACHE_NOINODECACHE: 1 | |
| CCACHE_IGNOREOPTIONS: "-fno-strict-overflow -fwrapv -W* -arch x86_64 arm64 -dynamic -fno-common -g -I/usr/local/opt/*" | |
| CCACHE_DEBUG: "1" | |
| # Use the minimum macOS deployment target supported by our version of PyBind: | |
| MACOSX_DEPLOYMENT_TARGET: "10.14" | |
| CCACHE_LOGFILE: ${{ runner.workspace }}/.ccache_log | |
| # This build caching is only to speed up tests on CI, so we only care about x86_64 for now. | |
| # Without limiting to a single architecture, ccache can't properly cache mixed Objective-C and C++ builds. | |
| # Fun fact: this is supported in Python itself! https://github.com/python/cpython/blob/893c9cc/Lib/_osx_support.py#L314-L328 | |
| ARCHFLAGS: -arch x86_64 | |
| DISABLE_LTO: "1" # Speeds up un-cacheable link step which doesn't really increase performance in tests anyways | |
| CC: ${{ matrix.cc }} | |
| CXX: ${{ matrix.cxx }} | |
| run: python setup.py develop | |
| - name: Ensure ccache worked | |
| env: | |
| CCACHE_DIR: ${{ runner.workspace }}/.ccache | |
| run: | | |
| ccache --show-stats --verbose | |
| ccache --zero-stats | |
| # cat ${{ runner.workspace }}/.ccache_log || true | |
| # ls -lashR ${{ runner.workspace }}/pedalboard | |
| # - name: Delete Existing Cache for ${{ runner.os }} Objects | |
| # run: gh cache delete --repo ${{ github.repository }} ${{ steps.cache-objects-restore.outputs.cache-primary-key }} | |
| # env: | |
| # # This token requires the "repo" scope. | |
| # GITHUB_TOKEN: ${{ secrets.ACTION_CLEAR_CACHES_TOKEN }} | |
| - name: Save Cached ${{ runner.os }} Objects | |
| id: cache-objects-save | |
| uses: actions/cache/save@v4 | |
| with: | |
| enableCrossOsArchive: true | |
| path: | | |
| ${{ runner.workspace }}/.ccache | |
| ${{ runner.workspace }}/pedalboard/build/lib* | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/pedalboard/juce_overrides | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/vendors | |
| key: ${{ steps.cache-objects-restore.outputs.cache-primary-key }} | |
| # Build the native module with ccache enabled so we can share object files between builds: | |
| prime-asan-build-caches: | |
| runs-on: ${{ matrix.os }} | |
| continue-on-error: false | |
| strategy: | |
| matrix: | |
| include: | |
| - { os: ubuntu-20.04, python-version: "3.12", compiler: "clang", cc: "ccache clang", cxx: "ccache clang++" } | |
| name: Pre-build on ${{ matrix.os }} with ${{ matrix.compiler }} | |
| steps: | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install Linux dependencies | |
| if: runner.os == 'Linux' | |
| run: | | |
| sudo apt-get update \ | |
| && sudo apt-get install -y pkg-config libsndfile1 \ | |
| libx11-dev libxrandr-dev libxinerama-dev \ | |
| libxrender-dev libxcomposite-dev libxcb-xinerama0-dev \ | |
| libxcursor-dev libfreetype6 libfreetype6-dev \ | |
| libasound2-dev | |
| # We depend on ccache features that are only present in 4.8.0 and later, but installing from apt-get gives us v3. | |
| - name: Install ccache on Linux | |
| if: runner.os == 'Linux' | |
| run: | | |
| mkdir ccache | |
| curl -L https://github.com/ccache/ccache/releases/download/v4.9.1/ccache-4.9.1-linux-x86_64.tar.xz | tar xvJf - -C ccache | |
| mv ccache/ccache*/ccache /usr/local/bin/ccache | |
| chmod +x /usr/local/bin/ccache | |
| - name: Install ccache on macOS | |
| if: runner.os == 'macOS' | |
| run: brew install ccache | |
| - name: Install test dependencies | |
| env: | |
| # on macOS and with Python 3.10: building NumPy from source fails without these options: | |
| NPY_BLAS_ORDER: "" | |
| NPY_LAPACK_ORDER: "" | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install wheel | |
| pip install -r test-requirements.txt | |
| # TensorFlow is an optional dependency; if present, we'll run tests with it: | |
| # There are no environment specifiers to select when TensorFlow binaries are available. | |
| pip install tensorflow==2.13 || true | |
| - name: Restore Cached ${{ runner.os }} Objects | |
| id: cache-objects-restore | |
| uses: actions/cache/restore@v4 | |
| with: | |
| enableCrossOsArchive: true | |
| path: | | |
| ${{ runner.workspace }}/.ccache | |
| ${{ runner.workspace }}/pedalboard/build/lib* | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/pedalboard/juce_overrides | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/vendors | |
| key: ${{ runner.os }}-${{ matrix.compiler }}-ccache | |
| - name: Build pedalboard locally | |
| env: | |
| CCACHE_DIR: ${{ runner.workspace }}/.ccache | |
| CCACHE_BASEDIR: ${{ runner.workspace }} | |
| CCACHE_DEBUGDIR: ${{ runner.workspace }}/.ccache_debug | |
| CCACHE_SLOPPINESS: "pch_defines,include_file_mtime,include_file_ctime,time_macros,locale,random_seed,system_headers" | |
| CCACHE_COMPILERCHECK: none | |
| CCACHE_NOINODECACHE: 1 | |
| CCACHE_IGNOREOPTIONS: "-fno-strict-overflow -fwrapv -W* -arch x86_64 arm64 -dynamic -fno-common -g -I/usr/local/opt/*" | |
| CCACHE_LOGFILE: ${{ runner.workspace }}/.ccache_log | |
| USE_ASAN: "1" | |
| DISABLE_LTO: "1" # Speeds up un-cacheable link step which doesn't really increase performance in tests anyways | |
| CC: ${{ matrix.cc }} | |
| CXX: ${{ matrix.cxx }} | |
| run: python setup.py develop | |
| - name: Ensure ccache worked | |
| env: | |
| CCACHE_DIR: ${{ runner.workspace }}/.ccache | |
| run: | | |
| ccache --show-stats --verbose | |
| ccache --zero-stats | |
| # cat ${{ runner.workspace }}/.ccache_log || true | |
| # ls -lashR ${{ runner.workspace }} | |
| # - name: Delete Existing Cache for ${{ runner.os }} Objects | |
| # run: gh cache delete --repo ${{ github.repository }} ${{ steps.cache-objects-restore.outputs.cache-primary-key }} | |
| # env: | |
| # # This token requires the "repo" scope. | |
| # GITHUB_TOKEN: ${{ secrets.ACTION_CLEAR_CACHES_TOKEN }} | |
| - name: Save Cached ${{ runner.os }} Objects | |
| id: cache-objects-save | |
| uses: actions/cache/save@v4 | |
| with: | |
| enableCrossOsArchive: true | |
| path: | | |
| ${{ runner.workspace }}/.ccache | |
| ${{ runner.workspace }}/pedalboard/build/lib* | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/pedalboard/juce_overrides | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/vendors | |
| key: ${{ steps.cache-objects-restore.outputs.cache-primary-key }} | |
| # This initial job catches obvious failures faster by running tests in parallel on just Ubuntu. | |
| run-tests-in-parallel: | |
| runs-on: ${{ matrix.os }} | |
| continue-on-error: false | |
| needs: | |
| - prime-ubuntu-build-caches | |
| strategy: | |
| matrix: | |
| os: ["ubuntu-20.04"] | |
| python-version: ["3.12"] | |
| compiler: ["gcc"] | |
| cc: ["ccache gcc"] | |
| cxx: ["ccache g++"] | |
| runner_index: ["1", "2", "3", "4", "5", "6", "7", "8"] | |
| runner_total: ["8"] | |
| name: Test ${{ matrix.runner_index }} / ${{ matrix.runner_total }} with Python ${{ matrix.python-version }} on ${{ matrix.os }} | |
| steps: | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install Linux dependencies | |
| if: runner.os == 'Linux' | |
| run: | | |
| sudo apt-get update \ | |
| && sudo apt-get install -y pkg-config libsndfile1 \ | |
| libx11-dev libxrandr-dev libxinerama-dev \ | |
| libxrender-dev libxcomposite-dev libxcb-xinerama0-dev \ | |
| libxcursor-dev libfreetype6 libfreetype6-dev \ | |
| libasound2-dev | |
| # We depend on ccache features that are only present in 4.8.0 and later, but installing from apt-get gives us v3. | |
| - name: Install ccache on Linux | |
| if: runner.os == 'Linux' | |
| run: | | |
| mkdir ccache | |
| curl -L https://github.com/ccache/ccache/releases/download/v4.9.1/ccache-4.9.1-linux-x86_64.tar.xz | tar xvJf - -C ccache | |
| mv ccache/ccache*/ccache /usr/local/bin/ccache | |
| chmod +x /usr/local/bin/ccache | |
| - name: Install test dependencies | |
| env: | |
| # on macOS and with Python 3.10: building NumPy from source fails without these options: | |
| NPY_BLAS_ORDER: "" | |
| NPY_LAPACK_ORDER: "" | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install wheel | |
| pip install -r test-requirements.txt | |
| # TensorFlow is an optional dependency; if present, we'll run tests with it: | |
| # There are no environment specifiers to select when TensorFlow binaries are available. | |
| pip install tensorflow==2.13 || true | |
| - name: Restore Cached ${{ runner.os }} Objects | |
| id: cache-objects-restore | |
| uses: actions/cache/restore@v4 | |
| with: | |
| enableCrossOsArchive: true | |
| path: | | |
| ${{ runner.workspace }}/.ccache | |
| ${{ runner.workspace }}/pedalboard/build/lib* | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/pedalboard/juce_overrides | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/vendors | |
| key: ${{ runner.os }}-${{ matrix.compiler }}-ccache | |
| - name: Print Restored ${{ runner.os }} Objects | |
| run: ls -lashR ${{ runner.workspace }} | |
| # Without this, distutils will recompile the extension even though we already have the .so built: | |
| - name: Touch Restored ${{ runner.os }} Objects to Prevent Cache Miss | |
| if: runner.os == 'Linux' || runner.os == 'macOS' | |
| run: | | |
| find ${{ runner.workspace }} -name '*.so' -exec touch {} \; || true | |
| find ${{ runner.workspace }} -name '*.o' -exec touch {} \; || true | |
| ls -lR ${{ runner.workspace }}/pedalboard | |
| - name: Build pedalboard locally | |
| run: python setup.py develop | |
| env: | |
| CCACHE_DIR: ${{ runner.workspace }}/.ccache | |
| CCACHE_BASEDIR: ${{ runner.workspace }} | |
| CCACHE_DEBUGDIR: ${{ runner.workspace }}/.ccache_debug | |
| CCACHE_SLOPPINESS: "pch_defines,include_file_mtime,include_file_ctime,time_macros,locale,random_seed,system_headers" | |
| CCACHE_COMPILERCHECK: none | |
| CCACHE_NOINODECACHE: 1 | |
| CCACHE_IGNOREOPTIONS: "-fno-strict-overflow -fwrapv -W* -arch x86_64 arm64 -dynamic -fno-common -g -I/usr/local/opt/*" | |
| CCACHE_LOGFILE: ${{ runner.workspace }}/.ccache_log | |
| DISABLE_LTO: "1" # Speeds up un-cacheable link step which doesn't really increase performance in tests anyways | |
| CC: ${{ matrix.cc }} | |
| CXX: ${{ matrix.cxx }} | |
| - name: Ensure ccache worked | |
| env: | |
| CCACHE_DIR: ${{ runner.workspace }}/.ccache | |
| run: | | |
| ccache --show-stats --verbose | |
| ccache --zero-stats | |
| # cat ${{ runner.workspace }}/.ccache_log || true | |
| # ls -lashR ${{ runner.workspace }} | |
| - name: Install VSTs for testing | |
| env: | |
| GCS_ASSET_BUCKET_NAME: ${{ secrets.GCS_ASSET_BUCKET_NAME }} | |
| GCS_READER_SERVICE_ACCOUNT_KEY: ${{ secrets.GCS_READER_SERVICE_ACCOUNT_KEY }} | |
| run: python ./tests/download_test_plugins.py | |
| - name: Setup dummy soundcard for testing | |
| if: runner.os == 'Linux' | |
| run: | | |
| sudo apt-get install -y linux-modules-extra-$(uname -r) | |
| sudo modprobe snd-dummy | |
| - name: Run tests | |
| env: | |
| TEST_WORKER_INDEX: ${{ matrix.runner_index }} | |
| NUM_TEST_WORKERS: ${{ matrix.runner_total }} | |
| run: pytest --maxfail=1 --durations=10 | |
| run-tests: | |
| runs-on: ${{ matrix.os }} | |
| continue-on-error: false | |
| needs: | |
| - prime-ubuntu-build-caches | |
| - prime-macos-build-caches | |
| env: | |
| MINIMUM_COVERAGE_PERCENTAGE: 80 | |
| strategy: | |
| matrix: | |
| include: | |
| - { os: macos-13, python-version: "3.8", compiler: "clang", cc: "ccache clang", cxx: "ccache clang++" } | |
| - { os: macos-13, python-version: "3.9", compiler: "clang", cc: "ccache clang", cxx: "ccache clang++" } | |
| - { os: macos-13, python-version: "3.10", compiler: "clang", cc: "ccache clang", cxx: "ccache clang++" } | |
| - { os: macos-13, python-version: "3.11", compiler: "clang", cc: "ccache clang", cxx: "ccache clang++" } | |
| - { os: macos-13, python-version: "3.12", compiler: "clang", cc: "ccache clang", cxx: "ccache clang++" } | |
| - { os: macos-13, python-version: "3.13.0-rc.1", compiler: "clang", cc: "ccache clang", cxx: "ccache clang++" } | |
| - { os: ubuntu-20.04, python-version: "3.8", compiler: "gcc", cc: "ccache gcc", cxx: "ccache g++" } | |
| - { os: ubuntu-20.04, python-version: "3.9", compiler: "gcc", cc: "ccache gcc", cxx: "ccache g++" } | |
| - { os: ubuntu-20.04, python-version: "3.10", compiler: "gcc", cc: "ccache gcc", cxx: "ccache g++" } | |
| - { os: ubuntu-20.04, python-version: "3.11", compiler: "gcc", cc: "ccache gcc", cxx: "ccache g++" } | |
| - { os: ubuntu-20.04, python-version: "3.12", compiler: "gcc", cc: "ccache gcc", cxx: "ccache g++" } | |
| - { os: ubuntu-20.04, python-version: "3.13.0-rc.1", compiler: "gcc", cc: "ccache gcc", cxx: "ccache g++" } | |
| # - { os: windows-latest, python-version: "3.8", compiler: "msvc", cc: "msvc", cxx: "msvc" } | |
| # - { os: windows-latest, python-version: "3.9", compiler: "msvc", cc: "msvc", cxx: "msvc" } | |
| # - { os: windows-latest, python-version: "3.10", compiler: "msvc", cc: "msvc", cxx: "msvc" } | |
| # - { os: windows-latest, python-version: "3.11", compiler: "msvc", cc: "msvc", cxx: "msvc" } | |
| - { os: windows-latest, python-version: "3.12", compiler: "msvc", cc: "msvc", cxx: "msvc" } | |
| - { os: windows-latest, python-version: "3.13.0-rc.1", compiler: "msvc", cc: "msvc", cxx: "msvc" } | |
| name: Test with Python ${{ matrix.python-version }} on ${{ matrix.os }} | |
| steps: | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install Linux dependencies | |
| if: runner.os == 'Linux' | |
| run: | | |
| sudo apt-get update \ | |
| && sudo apt-get install -y pkg-config libsndfile1 \ | |
| libx11-dev libxrandr-dev libxinerama-dev \ | |
| libxrender-dev libxcomposite-dev libxcb-xinerama0-dev \ | |
| libxcursor-dev libfreetype6 libfreetype6-dev \ | |
| libasound2-dev | |
| # We depend on ccache features that are only present in 4.8.0 and later, but installing from apt-get gives us v3. | |
| - name: Install ccache on Linux | |
| if: runner.os == 'Linux' | |
| run: | | |
| mkdir ccache | |
| curl -L https://github.com/ccache/ccache/releases/download/v4.9.1/ccache-4.9.1-linux-x86_64.tar.xz | tar xvJf - -C ccache | |
| mv ccache/ccache*/ccache /usr/local/bin/ccache | |
| chmod +x /usr/local/bin/ccache | |
| - name: Install ccache on macOS | |
| if: runner.os == 'macOS' | |
| run: brew install ccache | |
| - name: Install test dependencies | |
| env: | |
| # on macOS and with Python 3.10: building NumPy from source fails without these options: | |
| NPY_BLAS_ORDER: "" | |
| NPY_LAPACK_ORDER: "" | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install wheel | |
| pip install -r test-requirements.txt | |
| # TensorFlow is an optional dependency; if present, we'll run tests with it: | |
| # There are no environment specifiers to select when TensorFlow binaries are available. | |
| pip install tensorflow==2.13 || true | |
| - name: Install JQ for coverage badge on Linux | |
| run: sudo apt-get install -y jq | |
| if: runner.os == 'Linux' | |
| - name: Install JQ for coverage badge on macOS | |
| run: brew install jq | |
| if: runner.os == 'macOS' | |
| - name: Install JQ for coverage badge on Windows | |
| if: runner.os == 'Windows' | |
| uses: crazy-max/ghaction-chocolatey@v2 | |
| with: | |
| args: install jq | |
| - name: Restore Cached ${{ runner.os }} Objects | |
| id: cache-objects-restore | |
| uses: actions/cache/restore@v4 | |
| with: | |
| enableCrossOsArchive: true | |
| path: | | |
| ${{ runner.workspace }}/.ccache | |
| ${{ runner.workspace }}/pedalboard/build/lib* | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/pedalboard/juce_overrides | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/vendors | |
| key: ${{ runner.os }}-${{ matrix.compiler }}-ccache | |
| # Without this, distutils will recompile the extension even though we already have the shared object built: | |
| - name: Touch Restored ${{ runner.os }} Objects to Prevent Cache Miss | |
| if: runner.os == 'Linux' || runner.os == 'macOS' | |
| run: | | |
| find ${{ runner.workspace }} -name '*.so' -exec touch {} \; || true | |
| find ${{ runner.workspace }} -name '*.o' -exec touch {} \; || true | |
| ls -lR ${{ runner.workspace }}/pedalboard | |
| - name: Build pedalboard locally | |
| run: python setup.py develop | |
| env: | |
| CCACHE_DIR: ${{ runner.workspace }}/.ccache | |
| CCACHE_BASEDIR: ${{ runner.workspace }} | |
| CCACHE_DEBUGDIR: ${{ runner.workspace }}/.ccache_debug | |
| CCACHE_SLOPPINESS: "pch_defines,include_file_mtime,include_file_ctime,time_macros,locale,random_seed,system_headers" | |
| CCACHE_COMPILERCHECK: none | |
| CCACHE_NOINODECACHE: 1 | |
| CCACHE_IGNOREOPTIONS: "-fno-strict-overflow -fwrapv -W* -arch x86_64 arm64 -dynamic -fno-common -g -I/usr/local/opt/*" | |
| CCACHE_LOGFILE: ${{ runner.workspace }}/.ccache_log | |
| CCACHE_DEBUG: "1" | |
| # Use the minimum macOS deployment target supported by our version of PyBind: | |
| MACOSX_DEPLOYMENT_TARGET: "10.14" | |
| # This build caching is only to speed up tests on CI, so we only care about x86_64 for now. | |
| # Without limiting to a single architecture, ccache can't properly cache mixed Objective-C and C++ builds. | |
| # Fun fact: this is supported in Python itself! https://github.com/python/cpython/blob/893c9cc/Lib/_osx_support.py#L314-L328 | |
| ARCHFLAGS: -arch x86_64 | |
| DISABLE_LTO: "1" # Speeds up un-cacheable link step which doesn't really increase performance in tests anyways | |
| CC: ${{ matrix.cc }} | |
| CXX: ${{ matrix.cxx }} | |
| - name: Ensure ccache worked | |
| if: runner.os == 'Linux' || runner.os == 'macOS' | |
| env: | |
| CCACHE_DIR: ${{ runner.workspace }}/.ccache | |
| run: | | |
| ccache --show-stats --verbose | |
| ccache --zero-stats | |
| # cat ${{ runner.workspace }}/.ccache_log || true | |
| - name: Install VSTs for testing | |
| env: | |
| GCS_ASSET_BUCKET_NAME: ${{ secrets.GCS_ASSET_BUCKET_NAME }} | |
| GCS_READER_SERVICE_ACCOUNT_KEY: ${{ secrets.GCS_READER_SERVICE_ACCOUNT_KEY }} | |
| run: python ./tests/download_test_plugins.py | |
| - name: Run tests | |
| if: matrix.os != 'ubuntu-20.04' || matrix.python-version != '3.8' | |
| run: pytest --maxfail=4 --cov-report term --cov-fail-under=${{ env.MINIMUM_COVERAGE_PERCENTAGE }} --cov=pedalboard --durations=100 | |
| - name: Run tests with coverage reporting | |
| if: matrix.os == 'ubuntu-20.04' && matrix.python-version == '3.8' | |
| run: | | |
| pytest --maxfail=4 --cov-report term --cov-fail-under=${{ env.MINIMUM_COVERAGE_PERCENTAGE }} --cov=pedalboard \ | |
| && coverage json --fail-under=${{ env.MINIMUM_COVERAGE_PERCENTAGE }} \ | |
| && jq -r 'def roundit: .*100.0 + 0.5|floor/100.0; .totals.percent_covered | round | "COVERAGE_PERCENTAGE=" + (. | tostring) + "%" ' coverage.json >> $GITHUB_ENV \ | |
| && jq -r 'if .totals.percent_covered > ${{ env.MINIMUM_COVERAGE_PERCENTAGE }} then "COVERAGE_COLOR=green" else "COVERAGE_COLOR=red" end' coverage.json >> $GITHUB_ENV | |
| - name: Create coverage badge | |
| uses: schneegans/[email protected] | |
| if: matrix.os == 'ubuntu-20.04' && matrix.python-version == '3.8' && github.event_name == 'release' && github.event.action == 'published' | |
| with: | |
| auth: ${{ secrets.COVERAGE_GIST_SECRET }} | |
| gistID: 8736467e9952991ef44a67915ee7c762 | |
| filename: coverage.json | |
| label: Test Coverage | |
| message: ${{ env.COVERAGE_PERCENTAGE }} | |
| color: ${{ env.COVERAGE_COLOR }} | |
| run-tests-with-address-sanitizer: | |
| runs-on: ${{ matrix.os }} | |
| needs: [prime-asan-build-caches] | |
| strategy: | |
| matrix: | |
| python-version: ['3.8', '3.9', '3.10', '3.11', '3.12'] | |
| os: ['ubuntu-20.04'] | |
| name: Test with Python ${{ matrix.python-version }} + Address Sanitizer | |
| steps: | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install Linux dependencies | |
| if: runner.os == 'Linux' | |
| run: | | |
| sudo apt-get update \ | |
| && sudo apt-get install -y pkg-config libsndfile1 \ | |
| libx11-dev libxrandr-dev libxinerama-dev \ | |
| libxrender-dev libxcomposite-dev libxcb-xinerama0-dev \ | |
| libxcursor-dev libfreetype6 libfreetype6-dev \ | |
| libasound2-dev | |
| # We depend on ccache features that are only present in 4.8.0 and later, but installing from apt-get gives us v3. | |
| - name: Install ccache on Linux | |
| if: runner.os == 'Linux' | |
| run: | | |
| mkdir ccache | |
| curl -L https://github.com/ccache/ccache/releases/download/v4.9.1/ccache-4.9.1-linux-x86_64.tar.xz | tar xvJf - -C ccache | |
| mv ccache/ccache*/ccache /usr/local/bin/ccache | |
| chmod +x /usr/local/bin/ccache | |
| - name: Install test dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install wheel | |
| pip install -r test-requirements.txt | |
| # TensorFlow is an optional dependency; if present, we'll run tests with it: | |
| # There are no environment specifiers to select when TensorFlow binaries are available. | |
| pip install tensorflow==2.13 || true | |
| - name: Restore Cached ${{ runner.os }} Objects | |
| id: cache-objects-restore | |
| uses: actions/cache/restore@v4 | |
| with: | |
| enableCrossOsArchive: true | |
| path: | | |
| ${{ runner.workspace }}/.ccache | |
| ${{ runner.workspace }}/pedalboard/build/lib* | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/pedalboard/juce_overrides | |
| ${{ runner.workspace }}/pedalboard/build/temp${{ runner.workspace }}/pedalboard/vendors | |
| key: ${{ runner.os }}-clang-ccache | |
| - name: Build pedalboard locally | |
| env: | |
| DEBUG: "0" | |
| USE_ASAN: "1" | |
| CCACHE_DIR: ${{ runner.workspace }}/.ccache | |
| CCACHE_BASEDIR: ${{ runner.workspace }} | |
| CCACHE_DEBUGDIR: ${{ runner.workspace }}/.ccache_debug | |
| CCACHE_SLOPPINESS: "pch_defines,include_file_mtime,include_file_ctime,time_macros,locale,random_seed,system_headers" | |
| CCACHE_COMPILERCHECK: none | |
| CCACHE_NOINODECACHE: 1 | |
| CCACHE_IGNOREOPTIONS: "-fno-strict-overflow -fwrapv -W* -arch x86_64 arm64 -dynamic -fno-common -g -I/usr/local/opt/*" | |
| CCACHE_LOGFILE: ${{ runner.workspace }}/.ccache_log | |
| CCACHE_DEBUG: "1" | |
| DISABLE_LTO: "1" # Speeds up un-cacheable link step which doesn't really increase performance in tests anyways | |
| CC: ccache clang | |
| CXX: ccache clang++ | |
| run: python setup.py develop | |
| - name: Ensure ccache worked | |
| env: | |
| CCACHE_DIR: ${{ runner.workspace }}/.ccache | |
| run: | | |
| ccache --show-stats --verbose | |
| ccache --zero-stats | |
| # cat ${{ runner.workspace }}/.ccache_log || true | |
| - name: Run tests with ASan loaded | |
| # pytest can exit before all Python objects have been destroyed, | |
| # so we tell ASan to ignore leaks. | |
| run: | | |
| ASAN_OPTIONS=detect_leaks=0 \ | |
| LD_PRELOAD=$(clang -print-file-name=libclang_rt.asan-x86_64.so) \ | |
| pytest --maxfail=4 | |
| build-wheels: | |
| needs: [lint-python, lint-cpp] | |
| runs-on: ${{ matrix.os }} | |
| continue-on-error: false | |
| if: (github.event_name == 'release' && github.event.action == 'published') || contains(github.event.pull_request.labels.*.name, 'Also Test Wheels') | |
| strategy: | |
| matrix: | |
| include: | |
| - { os: macos-12, build: cp38-macosx_x86_64 } | |
| - { os: macos-12, build: cp39-macosx_x86_64 } | |
| - { os: macos-12, build: cp310-macosx_x86_64 } | |
| - { os: macos-12, build: cp311-macosx_x86_64 } | |
| - { os: macos-12, build: cp312-macosx_x86_64 } | |
| - { os: macos-12, build: cp313-macosx_x86_64 } | |
| - { os: macos-12, build: cp313t-macosx_x86_64 } | |
| - { os: macos-12, build: cp38-macosx_universal2 } | |
| - { os: macos-12, build: cp39-macosx_universal2 } | |
| - { os: macos-12, build: cp310-macosx_universal2 } | |
| - { os: macos-12, build: cp311-macosx_universal2 } | |
| - { os: macos-12, build: cp312-macosx_universal2 } | |
| - { os: macos-12, build: cp313-macosx_universal2 } | |
| - { os: macos-12, build: cp313t-macosx_universal2 } | |
| - { os: macos-12, build: cp38-macosx_arm64 } | |
| - { os: macos-12, build: cp39-macosx_arm64 } | |
| - { os: macos-12, build: cp310-macosx_arm64 } | |
| - { os: macos-12, build: cp311-macosx_arm64 } | |
| - { os: macos-12, build: cp312-macosx_arm64 } | |
| - { os: macos-12, build: cp313-macosx_arm64 } | |
| - { os: macos-12, build: cp313t-macosx_arm64 } | |
| # - { os: macos-12, build: pp38-macosx_x86_64 } | |
| # - { os: macos-12, build: pp39-macosx_x86_64 } | |
| - { os: windows-latest, build: cp38-win_amd64 } | |
| - { os: windows-latest, build: cp39-win_amd64 } | |
| - { os: windows-latest, build: cp310-win_amd64 } | |
| - { os: windows-latest, build: cp311-win_amd64 } | |
| - { os: windows-latest, build: cp312-win_amd64 } | |
| - { os: windows-latest, build: cp313-win_amd64 } | |
| # - { os: windows-latest, build: cp313t-win_amd64 } | |
| # - { os: windows-latest, build: pp38-win_amd64 } | |
| # - { os: windows-latest, build: pp39-win_amd64 } | |
| - { os: windows-latest, build: cp38-win32 } | |
| - { os: windows-latest, build: cp39-win32 } | |
| - { os: windows-latest, build: cp310-win32 } | |
| - { os: windows-latest, build: cp311-win32 } | |
| - { os: windows-latest, build: cp312-win32 } | |
| # - { os: windows-latest, build: cp313-win32 } | |
| # - { os: windows-latest, build: cp313t-win32 } | |
| - { os: 'ubuntu-20.04', build: cp38-manylinux_x86_64 } | |
| - { os: 'ubuntu-20.04', build: cp38-manylinux_aarch64 } | |
| - { os: 'ubuntu-20.04', build: cp38-musllinux_x86_64 } | |
| - { os: 'ubuntu-20.04', build: cp38-musllinux_aarch64 } | |
| - { os: 'ubuntu-20.04', build: cp39-manylinux_x86_64 } | |
| - { os: 'ubuntu-20.04', build: cp39-manylinux_aarch64 } | |
| - { os: 'ubuntu-20.04', build: cp39-musllinux_x86_64 } | |
| - { os: 'ubuntu-20.04', build: cp39-musllinux_aarch64 } | |
| - { os: 'ubuntu-20.04', build: cp310-manylinux_x86_64 } | |
| - { os: 'ubuntu-20.04', build: cp310-manylinux_aarch64 } | |
| - { os: 'ubuntu-20.04', build: cp310-musllinux_x86_64 } | |
| - { os: 'ubuntu-20.04', build: cp310-musllinux_aarch64 } | |
| - { os: 'ubuntu-20.04', build: cp311-manylinux_x86_64 } | |
| - { os: 'ubuntu-20.04', build: cp311-manylinux_aarch64 } | |
| - { os: 'ubuntu-20.04', build: cp311-musllinux_x86_64 } | |
| - { os: 'ubuntu-20.04', build: cp311-musllinux_aarch64 } | |
| - { os: 'ubuntu-20.04', build: cp312-manylinux_x86_64 } | |
| - { os: 'ubuntu-20.04', build: cp312-manylinux_aarch64 } | |
| - { os: 'ubuntu-20.04', build: cp312-musllinux_x86_64 } | |
| - { os: 'ubuntu-20.04', build: cp312-musllinux_aarch64 } | |
| - { os: 'ubuntu-20.04', build: cp313-manylinux_x86_64 } | |
| - { os: 'ubuntu-20.04', build: cp313-manylinux_aarch64 } | |
| # - { os: 'ubuntu-20.04', build: cp313-musllinux_x86_64 } | |
| # - { os: 'ubuntu-20.04', build: cp313-musllinux_aarch64 } | |
| - { os: 'ubuntu-20.04', build: cp313t-manylinux_x86_64 } | |
| - { os: 'ubuntu-20.04', build: cp313t-manylinux_aarch64 } | |
| # - { os: 'ubuntu-20.04', build: cp313t-musllinux_x86_64 } | |
| # - { os: 'ubuntu-20.04', build: cp313t-musllinux_aarch64 } | |
| # - { os: 'ubuntu-20.04', build: pp37-manylinux_x86_64 } | |
| # - { os: 'ubuntu-20.04', build: pp37-manylinux_aarch64 } | |
| # - { os: 'ubuntu-20.04', build: pp38-manylinux_x86_64 } | |
| # - { os: 'ubuntu-20.04', build: pp38-manylinux_aarch64 } | |
| # - { os: 'ubuntu-20.04', build: pp39-manylinux_x86_64 } | |
| # - { os: 'ubuntu-20.04', build: pp39-manylinux_aarch64 } | |
| name: Build wheel for ${{ matrix.build }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| # Used to host cibuildwheel, so version doesn't really matter | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| - name: Install cibuildwheel | |
| run: python -m pip install 'cibuildwheel>=2.11.0' | |
| - name: Set up QEMU for aarch64 on Linux | |
| if: runner.os == 'Linux' | |
| uses: docker/setup-qemu-action@v1 | |
| with: | |
| platforms: all | |
| - name: Build wheels | |
| run: python -m cibuildwheel --output-dir wheelhouse | |
| env: | |
| CIBW_TEST_REQUIRES: -r test-requirements.txt | |
| CIBW_TEST_COMMAND: "pytest {project}/tests" | |
| CIBW_BUILD: ${{ matrix.build }} | |
| CIBW_ARCHS_WINDOWS: auto # Allow 32-bit Windows builds | |
| CIBW_ARCHS_LINUX: auto64 aarch64 # Useful for building linux images with Apple Silicon | |
| CIBW_ARCHS_MACOS: x86_64 universal2 arm64 # Support Apple Silicon | |
| # on macOS and with Python 3.10: building NumPy from source fails without these options: | |
| CIBW_ENVIRONMENT: NPY_BLAS_ORDER="" NPY_LAPACK_ORDER="" CIBW_BUILD="${{ matrix.build }}" | |
| CIBW_REPAIR_WHEEL_COMMAND_LINUX: pip install auditwheel-symbols && (auditwheel repair -w {dest_dir} {wheel} || auditwheel-symbols --manylinux 2010 {wheel}) | |
| # The manylinux container doesn't have a new enough glibc version, | |
| # so we can't run post-wheel-build tests there. | |
| # The musllinux containers on aarch64 take 6+ hours to test. | |
| # Also testing any pypy versions fails, as TensorFlow isn't pypy compatible. | |
| CIBW_TEST_SKIP: "*manylinux* *musllinux_aarch* *pp* *-macosx_universal2:arm64" | |
| CIBW_PRERELEASE_PYTHONS: "1" | |
| # Use the minimum macOS deployment target supported by our version of PyBind: | |
| MACOSX_DEPLOYMENT_TARGET: "10.14" | |
| CIBW_MUSLLINUX_X86_64_IMAGE: quay.io/pypa/musllinux_1_1_x86_64:2024-04-29-07d05a0 | |
| CIBW_MUSLLINUX_AARCH64_IMAGE: quay.io/pypa/musllinux_1_1_aarch64:2024-04-29-07d05a0 | |
| CIBW_FREE_THREADED_SUPPORT: "1" | |
| - uses: actions/upload-artifact@v2 | |
| with: | |
| path: ./wheelhouse/*.whl | |
| upload-pypi: | |
| needs: [build-wheels, run-tests-with-address-sanitizer, run-tests] | |
| runs-on: 'ubuntu-20.04' | |
| name: "Upload wheels to PyPI" | |
| if: github.event_name == 'release' && github.event.action == 'published' | |
| steps: | |
| - uses: actions/download-artifact@v2 | |
| with: | |
| name: artifact | |
| path: dist | |
| - uses: pypa/[email protected] | |
| with: | |
| user: __token__ | |
| password: ${{ secrets.PYPI_DEPLOY_TOKEN }} |