diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index df74d55..1f4bc3d 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -48,8 +48,6 @@ jobs: apt install -y sudo cmake curl tree - uses: actions/checkout@v4 - with: - submodules: true - name: Setup Environment Variables shell: bash @@ -63,7 +61,7 @@ jobs: # This needs to be absolute to make action/cache happy WORKING_DIR=$(pwd) - echo "PLUGIN_CACHE_PATH=$WORKING_DIR/modules/juce/Builds/examples/Plugins" >> $GITHUB_ENV + echo "PLUGIN_CACHE_PATH=$WORKING_DIR/_deps/juce-build/examples/Plugins" >> $GITHUB_ENV - name: Install dependencies (Linux) if: ${{ matrix.name == 'Linux' }} @@ -90,7 +88,7 @@ jobs: - name: ccache uses: hendrikmuhs/ccache-action@v1.2 with: - key: v2-${{ matrix.name }}-${{ env.BUILD_TYPE }} + key: v3-${{ matrix.name }}-${{ env.BUILD_TYPE }} - name: Configure shell: bash @@ -114,11 +112,10 @@ jobs: with: path: ${{ env.PLUGIN_CACHE_PATH }} # Increment the version in the key below to manually break plugin cache - key: v7-${{ runner.os }}-${{ env.JUCE_SHA1 }} + key: v8-${{ runner.os }}-${{ env.JUCE_SHA1 }} - name: Build JUCE example plugins if: steps.cache-plugins.outputs.cache-hit != 'true' - working-directory: modules/juce shell: bash run: | cmake -B Builds -DJUCE_BUILD_EXAMPLES=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache . diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index b03a59d..0000000 --- a/.gitmodules +++ /dev/null @@ -1,4 +0,0 @@ -[submodule "modules/juce"] - path = modules/juce - url = https://github.com/juce-framework/JUCE - branch = develop diff --git a/CMakeLists.txt b/CMakeLists.txt index 6f3f76a..2cc7ad5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -3,12 +3,24 @@ cmake_minimum_required(VERSION 3.15) file(STRINGS VERSION CURRENT_VERSION LIMIT_COUNT 1) project(pluginval VERSION ${CURRENT_VERSION}) -if (APPLE) - # Target OS versions down to 10.11 - set (CMAKE_OSX_DEPLOYMENT_TARGET "10.11" CACHE INTERNAL "") +# Just compliing pluginval +if (pluginval_IS_TOP_LEVEL) + include(cmake/CPM.cmake) + CPMAddPackage("gh:juce-framework/juce#8.0.3") - # Uncomment to produce a universal binary - # set(CMAKE_OSX_ARCHITECTURES arm64 x86_64) + if (APPLE) + # Target OS versions down to 10.11 + set (CMAKE_OSX_DEPLOYMENT_TARGET "10.11" CACHE INTERNAL "") + + # Uncomment to produce a universal binary + # set(CMAKE_OSX_ARCHITECTURES arm64 x86_64) + endif() + +else() + # compiling as a "dependency" of another JUCE CMake project + if (NOT COMMAND juce_add_module) + message(FATAL_ERROR "JUCE must be added to your project before pluginval!") + endif () endif() # sanitizer options, from https://github.com/sudara/cmake-includes/blob/main/Sanitizers.cmake @@ -41,12 +53,6 @@ endif () set_property(GLOBAL PROPERTY USE_FOLDERS YES) option(JUCE_ENABLE_MODULE_SOURCE_GROUPS "Enable Module Source Groups" ON) -option(PLUGINVAL_FETCH_JUCE "Fetch JUCE along with PluginVal" ON) - -if(PLUGINVAL_FETCH_JUCE) - add_subdirectory(modules/juce) -endif() - if (DEFINED ENV{VST2_SDK_DIR}) MESSAGE(STATUS "Building with VST2 SDK: $ENV{VST2_SDK_DIR}") juce_set_vst2_sdk_path($ENV{VST2_SDK_DIR}) @@ -122,11 +128,12 @@ if (${CMAKE_SYSTEM_NAME} MATCHES "Linux") -static-libstdc++) endif() -set (cmdline_docs_out "${CMAKE_CURRENT_LIST_DIR}/docs/Command line options.md") +if (pluginval_IS_TOP_LEVEL) + set (cmdline_docs_out "${CMAKE_CURRENT_LIST_DIR}/docs/Command line options.md") -add_custom_command (OUTPUT "${cmdline_docs_out}" - COMMAND pluginval --help > "${cmdline_docs_out}" - COMMENT "Regenerating Command line options.md..." - USES_TERMINAL) - -add_custom_target (PluginvalDocs DEPENDS "${cmdline_docs_out}") + add_custom_command (OUTPUT "${cmdline_docs_out}" + COMMAND pluginval --help > "${cmdline_docs_out}" + COMMENT "Regenerating Command line options.md..." + USES_TERMINAL) + add_custom_target (PluginvalDocs DEPENDS "${cmdline_docs_out}") +endif() diff --git a/README.md b/README.md index 963df15..a8dd6ca 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,24 @@ cmake -B Builds/Debug -DCMAKE_BUILD_TYPE=Debug . # configure cmake --build Builds/Debug --config Debug # build ``` +### Including within an existing JUCE project + +Instead of running as a separate app, you can add pluginval as a CMake target to your existing plugin project. This not only makes for a convenient debugging workflow, it gives you better stack traces. + +For example, if you add pluginval as a git submodule like so: +``` +git submodule add -b develop git@github.com:Tracktion/pluginval.git modules/pluginval +``` + +or added with CPM like so: + +``` +CPMAddPackage("gh:tracktion/pluginval#develop") +``` + +Then all you need to do is call `add_subdirectory ("modules/pluginval")` in your `CMakeLists.txt`. This should be done **after** your call to `juce_add_plugin`. + + ### Third-party Installation ###### _Chocolatey (Windows):_ ```shell diff --git a/Source/CommandLine.cpp b/Source/CommandLine.cpp index 8790922..2d0dfd1 100644 --- a/Source/CommandLine.cpp +++ b/Source/CommandLine.cpp @@ -239,7 +239,11 @@ namespace bool isPluginArgument (juce::String arg) { juce::AudioPluginFormatManager formatManager; + #if JUCE_VERSION >= 0x08000B + addDefaultFormatsToManager (formatManager); + #else formatManager.addDefaultFormats(); + #endif for (auto format : formatManager.getFormats()) if (format->fileMightContainThisPluginType (arg)) diff --git a/Source/MainComponent.cpp b/Source/MainComponent.cpp index 8a52d2c..96e5f12 100644 --- a/Source/MainComponent.cpp +++ b/Source/MainComponent.cpp @@ -246,7 +246,11 @@ namespace MainComponent::MainComponent (Validator& v) : validator (v) { + #if JUCE_VERSION >= 0x08000B + addDefaultFormatsToManager (formatManager); + #else formatManager.addDefaultFormats(); + #endif const auto tabCol = getLookAndFeel().findColour (juce::ResizableWindow::backgroundColourId); addAndMakeVisible (tabbedComponent); diff --git a/Source/PluginTests.cpp b/Source/PluginTests.cpp index abee411..ebecd54 100644 --- a/Source/PluginTests.cpp +++ b/Source/PluginTests.cpp @@ -52,7 +52,11 @@ PluginTests::PluginTests (const juce::String& fileOrIdentifier, Options opts) { jassert (fileOrIdentifier.isNotEmpty()); jassert (juce::isPositiveAndNotGreaterThan (options.strictnessLevel, 10)); + #if JUCE_VERSION >= 0x08000B + addDefaultFormatsToManager (formatManager); + #else formatManager.addDefaultFormats(); + #endif } PluginTests::PluginTests (const juce::PluginDescription& desc, Options opts) diff --git a/Source/tests/BasicTests.cpp b/Source/tests/BasicTests.cpp index c9844c4..600250d 100644 --- a/Source/tests/BasicTests.cpp +++ b/Source/tests/BasicTests.cpp @@ -486,7 +486,8 @@ namespace ParameterHelpers const int numSteps = parameter.getNumSteps(); const bool isDiscrete = parameter.isDiscrete(); const bool isBoolean = parameter.isBoolean(); - const juce::StringArray allValueStrings = parameter.getAllValueStrings(); + const juce::StringArray allValueStrings = parameter.isDiscrete() ? parameter.getAllValueStrings() : juce::StringArray(); + const bool isOrientationInverted = parameter.isOrientationInverted(); const bool isAutomatable = parameter.isAutomatable(); diff --git a/cmake/CPM.cmake b/cmake/CPM.cmake new file mode 100644 index 0000000..baf2d8c --- /dev/null +++ b/cmake/CPM.cmake @@ -0,0 +1,24 @@ +# SPDX-License-Identifier: MIT +# +# SPDX-FileCopyrightText: Copyright (c) 2019-2023 Lars Melchior and contributors + +set(CPM_DOWNLOAD_VERSION 0.40.2) +set(CPM_HASH_SUM "c8cdc32c03816538ce22781ed72964dc864b2a34a310d3b7104812a5ca2d835d") + +if(CPM_SOURCE_CACHE) + set(CPM_DOWNLOAD_LOCATION "${CPM_SOURCE_CACHE}/cpm/CPM_${CPM_DOWNLOAD_VERSION}.cmake") +elseif(DEFINED ENV{CPM_SOURCE_CACHE}) + set(CPM_DOWNLOAD_LOCATION "$ENV{CPM_SOURCE_CACHE}/cpm/CPM_${CPM_DOWNLOAD_VERSION}.cmake") +else() + set(CPM_DOWNLOAD_LOCATION "${CMAKE_BINARY_DIR}/cmake/CPM_${CPM_DOWNLOAD_VERSION}.cmake") +endif() + +# Expand relative path. This is important if the provided path contains a tilde (~) +get_filename_component(CPM_DOWNLOAD_LOCATION ${CPM_DOWNLOAD_LOCATION} ABSOLUTE) + +file(DOWNLOAD + https://github.com/cpm-cmake/CPM.cmake/releases/download/v${CPM_DOWNLOAD_VERSION}/CPM.cmake + ${CPM_DOWNLOAD_LOCATION} EXPECTED_HASH SHA256=${CPM_HASH_SUM} +) + +include(${CPM_DOWNLOAD_LOCATION}) diff --git a/modules/juce b/modules/juce deleted file mode 160000 index 5179f4e..0000000 --- a/modules/juce +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 5179f4e720d8406ebd1b5401c86aea8da6cc83c9