Integrate VST3 validator directly into pluginval binary (#162)

* Integrate VST3 validator directly into pluginval binary

- Add VST3 SDK as a dependency via CPM (fetched during cmake configure)
- Create VST3ValidatorRunner wrapper to call SDK validation APIs
- Add --vst3-validator-mode CLI option for running embedded validator
- Modify VST3validator test to use embedded validator instead of external binary
- Remove --vst3validator CLI option and related UI code (no longer needed)
- Update CLAUDE.md documentation with new build options and architecture

The embedded validator eliminates the need for users to supply a separate
vstvalidator binary path. When built with PLUGINVAL_VST3_VALIDATOR=ON (default),
the validator runs automatically for VST3 plugins at strictness level 5+.

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Fix VST3 validator build and runtime issues

- Add platform-specific module loading sources from SDK (module_linux.cpp, etc.)
- Fix VST3ValidatorRunner to use correct SDK APIs:
  - Use template createInstance<T>() method
  - Use FUnknownPtr for interface casting
  - Remove incompatible ITestResult implementation
- Add sdk library to link dependencies
- Fix argument parsing to not auto-insert --validate when using --vst3-validator-mode

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Add ARC compile flag for macOS module_mac.mm

The VST3 SDK's module_mac.mm requires Automatic Reference Counting (ARC)
to be enabled. Add -fobjc-arc compile flag for this specific source file.

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Add platform-specific library linking for VST3 validator

- Add Ole32 and Shell32 libraries for Windows module loading
- Add Cocoa framework for macOS module loading
- Add hosting directory to include paths

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Add Windows-specific compile definitions for module_win32.cpp

Add NOMINMAX and WIN32_LEAN_AND_MEAN definitions to avoid conflicts
with JUCE's Windows header handling.

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Add exception handling and better error output to VST3 validator

- Add try-catch around validation logic to handle exceptions
- Add stderr output for errors to improve visibility in CI logs
- This helps diagnose validation failures on macOS and Windows

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Use COMPILE_FLAGS for Windows VST3 module definitions

- Use MSVC-specific /D flags for compile definitions
- Add _SILENCE_EXPERIMENTAL_FILESYSTEM_DEPRECATION_WARNING
- This ensures definitions are applied correctly for MSVC builds

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Use wrapper file for Windows VST3 module compilation

Instead of adding compile flags to the SDK's module_win32.cpp directly,
use a wrapper source file that sets up the necessary preprocessor
definitions (NOMINMAX, WIN32_LEAN_AND_MEAN, _UNICODE, etc.) before
including the SDK source. This ensures proper compilation environment
when building outside the VST3 SDK's CMake context.

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Use target-level compile definitions for Windows VST3 module

Replace wrapper file approach with target-level compile definitions.
This adds the necessary Windows macros (NOMINMAX, WIN32_LEAN_AND_MEAN,
_UNICODE, _CRT_SECURE_NO_WARNINGS, etc.) to the pluginval target when
building on Windows with VST3 validator enabled.

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Add SMTG_USE_STATIC_CRT and additional include directories

- Set SMTG_USE_STATIC_CRT=ON to match pluginval's static CRT linking
- Add vst and utility include directories for VST3 SDK module compilation

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Create OBJECT library for Windows VST3 module compilation

Isolate the Windows module_win32.cpp compilation into a separate OBJECT
library with its own compile settings, avoiding potential conflicts with
JUCE's compilation environment. The object library:
- Uses C++17 (matching SDK's validator)
- Has SDK-specific include directories
- Sets Windows compatibility definitions
- Uses static CRT to match pluginval

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Simplify OBJECT library include directories for Windows VST3 module

Use PUBLIC link to sdk_hosting to inherit its include directories
automatically, and only add the minimal additional includes needed.

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Simplify Windows VST3 module - use direct file inclusion

Remove the OBJECT library approach and add module_win32.cpp directly
to the pluginval sources like on other platforms. The Windows-specific
compile definitions (NOMINMAX, WIN32_LEAN_AND_MEAN, etc.) are already
set at the target level.

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Fix Windows build: compile module_win32.cpp with C++17

The VST3 SDK's module_win32.cpp uses std::filesystem::path::generic_u8string()
which returns std::u8string in C++20 but std::string in C++17. Since the SDK
code expects std::string, we compile this specific file with /std:c++17.

Also move _UNICODE and UNICODE definitions from target-level to file-level
(only for module_win32.cpp) to avoid breaking JUCE's LV2/lilv code which
uses ANSI Windows APIs.

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Bypass JUCE startup for --vst3-validator-mode subprocess

When running with --vst3-validator-mode, intercept the flag in main()
before JUCE initializes. This avoids the macOS "Periodic events are
already being generated" crash that occurred when the VST3 validator
subprocess tried to use JUCE's event loop.

The VST3 validator now runs as a pure C++ process without JUCE,
which is appropriate since it only uses the VST3 SDK APIs.

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Document CI run logs and setup instructions

Added CI run logs section with configuration and workflow details.

* Fix JUCE app initialization in custom main()

Add forward declaration for juce_CreateApplication and set
JUCEApplicationBase::createInstance before calling main().
This is required for JUCE to properly create the application instance.

Previous commit caused segfaults because createInstance wasn't set.

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* Trigger CI re-run

https://claude.ai/code/session_01AY9chvBEmsCVjNZSUkNcbw

* VST3:  Build validator from sdk and extract to a temp file at run time

* CI:   Added -DCMAKE_BUILD_TYPE to as-depenedency job

* Updated gitignore

---------

Co-authored-by: Claude <noreply@anthropic.com>

Author: drowaudio

.github/workflows/build.yaml

@@ -187,7 +187,7 @@ jobs:
           sudo apt-get install -y libasound2-dev libfreetype6-dev libx11-dev libxcomposite-dev libxcursor-dev libxinerama-dev libxrandr-dev mesa-common-dev libwebkit2gtk-4.1-dev ladspa-sdk
 
       - name: Configure
-        run: cmake -B build -S tests/pluginval_as_dependency -DJUCE_VERSION="${{ matrix.juce }}"
+        run: cmake -B build -S tests/pluginval_as_dependency -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE}} -DJUCE_VERSION="${{ matrix.juce }}"
 
       - name: Build
         run: cmake --build build --target pluginval --parallel 4

.gitignore

@@ -79,3 +79,4 @@ pluginval.build/
 pluginval.xcodeproj/
 pluginval_artefacts/
 
+.claude/*local*

CLAUDE.md

@@ -33,6 +33,44 @@ Follow these guidelines when working on this codebase:
 
 6. **Never speculate about unread code**: Never make claims about code you haven't opened. If the user references a specific file, you MUST read the file before answering. Investigate and read relevant files BEFORE answering questions about the codebase. Give grounded, hallucination-free answers based on actual file contents.
 
+## Getting CI Run Logs
+
+### Configuration
+
+- **Organisation:** `<organisation>`
+- **Repository:** `<repo>`
+
+For this project:
+- **Organisation:** `Tracktion`
+- **Repository:** `pluginval`
+
+### Setup
+
+Install the GitHub CLI:
+```bash
+brew install gh  # macOS
+# or
+sudo apt install gh  # Ubuntu/Debian
+```
+
+Authentication is handled via the `GH_TOKEN` environment variable (already configured).
+
+### Workflow
+
+1. **List recent workflow runs:**
+   ```bash
+   gh run list -R <organisation>/<repo>
+   ```
+
+2. **Find the most recent run for your branch** from the output above.
+
+3. **View failed log details:**
+   ```bash
+   gh run view -R <organisation>/<repo> <run_id> --log-failed
+   ```
+
+Replace `<run_id>` with the ID from step 2.
+
 ## Directory Structure
 
 ```
@@ -49,6 +87,9 @@ pluginval/
 │   ├── PluginvalLookAndFeel.h # Custom UI styling
 │   ├── StrictnessInfoPopup.h # Strictness level info UI
 │   ├── binarydata/           # Binary resources (icons)
+│   ├── vst3validator/        # Embedded VST3 validator integration
+│   │   ├── VST3ValidatorRunner.h
+│   │   └── VST3ValidatorRunner.cpp
 │   └── tests/                # Individual test implementations
 │       ├── BasicTests.cpp    # Core plugin tests (info, state, audio)
 │       ├── BusTests.cpp      # Audio bus configuration tests
@@ -59,7 +100,8 @@ pluginval/
 ├── modules/
 │   └── juce/                 # JUCE framework (git submodule)
 ├── cmake/
-│   └── CPM.cmake             # CMake Package Manager
+│   ├── CPM.cmake             # CMake Package Manager
+│   └── GenerateBinaryHeader.cmake  # Binary-to-C-header converter
 ├── tests/
 │   ├── AddPluginvalTests.cmake  # CMake module for CTest integration
 │   ├── test_plugins/         # Test plugin files
@@ -101,6 +143,7 @@ cmake --build Builds/Debug --config Debug
 | Option | Description | Default |
 |--------|-------------|---------|
 | `PLUGINVAL_FETCH_JUCE` | Fetch JUCE with pluginval | ON |
+| `PLUGINVAL_VST3_VALIDATOR` | Build with embedded VST3 validator | ON |
 | `WITH_ADDRESS_SANITIZER` | Enable AddressSanitizer | OFF |
 | `WITH_THREAD_SANITIZER` | Enable ThreadSanitizer | OFF |
 | `VST2_SDK_DIR` | Path to VST2 SDK (env var) | - |
@@ -177,6 +220,26 @@ struct Requirements {
 | `LocaleTest.cpp` | Locale handling verification |
 | `ExtremeTests.cpp` | Edge cases, stress tests |
 
+### VST3 Validator Integration
+
+The VST3 validator (Steinberg's vstvalidator) is embedded into pluginval when built with `PLUGINVAL_VST3_VALIDATOR=ON` (the default). This provides single-file distribution while keeping vstvalidator completely isolated from pluginval's link dependencies.
+
+**Architecture:**
+1. The VST3 SDK is fetched via CPM during CMake configure
+2. The SDK's own `validator` target is built as a separate executable
+3. A CMake script (`cmake/GenerateBinaryHeader.cmake`) converts the compiled binary into a C byte array header
+4. `VST3ValidatorRunner` (`Source/vst3validator/`) extracts the embedded binary to a temp file on first use
+5. When the `VST3validator` test runs, it spawns the extracted validator as a subprocess
+
+**Key files:**
+- `cmake/GenerateBinaryHeader.cmake` — binary-to-C-header conversion script
+- `Source/vst3validator/VST3ValidatorRunner.h/cpp` — extracts embedded binary, returns `juce::File`
+
+**Disabling embedded validator:**
+```bash
+cmake -B Builds -DPLUGINVAL_VST3_VALIDATOR=OFF .
+```
+
 ## Adding New Tests
 
 1. Create a subclass of `PluginTest`:
@@ -312,6 +375,7 @@ add_pluginval_tests(MyPluginTarget
 - **JUCE** (v8.0.x) - Audio application framework (git submodule)
 - **magic_enum** (v0.9.7) - Enum reflection (fetched via CPM)
 - **rtcheck** (optional, macOS) - Real-time safety checking (fetched via CPM)
+- **VST3 SDK** (v3.7.x) - Steinberg VST3 SDK for embedded validator (fetched via CPM, optional)
 
 ### System
 - macOS: CoreAudio, AudioUnit frameworks

CMakeLists.txt

@@ -65,6 +65,28 @@ if (pluginval_IS_TOP_LEVEL)
     CPMAddPackage("gh:juce-framework/juce#8.0.3")
 endif()
 
+
+# VST3 Validator integration - embeds Steinberg's vstvalidator directly into pluginval
+option(PLUGINVAL_VST3_VALIDATOR "Build with embedded VST3 validator" ON)
+
+if(PLUGINVAL_VST3_VALIDATOR)
+    # Use static CRT on Windows to match pluginval's settings
+    set(SMTG_USE_STATIC_CRT ON CACHE BOOL "" FORCE)
+
+    CPMAddPackage(
+        NAME vst3sdk
+        GITHUB_REPOSITORY steinbergmedia/vst3sdk
+        GIT_TAG v3.7.14_build_55
+        OPTIONS
+            "SMTG_ENABLE_VST3_PLUGIN_EXAMPLES OFF"
+            "SMTG_ENABLE_VST3_HOSTING_EXAMPLES OFF"
+            "SMTG_ENABLE_VSTGUI_SUPPORT OFF"
+            "SMTG_ADD_VSTGUI OFF"
+            "SMTG_RUN_VST_VALIDATOR OFF"
+            "SMTG_CREATE_BUNDLE_FOR_WINDOWS OFF"
+    )
+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})
@@ -109,6 +131,16 @@ set(SourceFiles
 target_sources(pluginval PRIVATE ${SourceFiles})
 source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/Source PREFIX Source FILES ${SourceFiles})
 
+# Add VST3 validator runner sources to pluginval (extracts embedded binary at runtime)
+if(PLUGINVAL_VST3_VALIDATOR)
+    set(VST3ValidatorFiles
+        Source/vst3validator/VST3ValidatorRunner.h
+        Source/vst3validator/VST3ValidatorRunner.cpp
+    )
+    target_sources(pluginval PRIVATE ${VST3ValidatorFiles})
+    source_group("Source/vst3validator" FILES ${VST3ValidatorFiles})
+endif()
+
 if (DEFINED ENV{VST2_SDK_DIR})
     target_compile_definitions(pluginval PRIVATE
         JUCE_PLUGINHOST_VST=1)
@@ -124,8 +156,10 @@ target_compile_definitions(pluginval PRIVATE
     JUCE_MODAL_LOOPS_PERMITTED=1
     JUCE_GUI_BASICS_INCLUDE_XHEADERS=1
     $<$<BOOL:${PLUGINVAL_ENABLE_RTCHECK}>:PLUGINVAL_ENABLE_RTCHECK=1>
+    $<$<BOOL:${PLUGINVAL_VST3_VALIDATOR}>:PLUGINVAL_VST3_VALIDATOR=1>
     VERSION="${CURRENT_VERSION}")
 
+
 if(MSVC AND NOT CMAKE_MSVC_RUNTIME_LIBRARY)
     # Default to statically linking the runtime libraries
     set_property(TARGET pluginval PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
@@ -143,6 +177,22 @@ if (${CMAKE_SYSTEM_NAME} MATCHES "Linux")
         -static-libstdc++)
 endif()
 
+# Embed the SDK's validator binary into pluginval
+if(PLUGINVAL_VST3_VALIDATOR)
+    set(VSTVALIDATOR_HEADER "${CMAKE_BINARY_DIR}/generated/vstvalidator_data.h")
+    add_custom_command(
+        OUTPUT "${VSTVALIDATOR_HEADER}"
+        COMMAND ${CMAKE_COMMAND}
+            -DINPUT_FILE=$<TARGET_FILE:validator>
+            -DOUTPUT_FILE=${VSTVALIDATOR_HEADER}
+            -P ${CMAKE_CURRENT_SOURCE_DIR}/cmake/GenerateBinaryHeader.cmake
+        DEPENDS validator
+        COMMENT "Embedding vstvalidator binary into header...")
+
+    target_sources(pluginval PRIVATE "${VSTVALIDATOR_HEADER}")
+    target_include_directories(pluginval PRIVATE "${CMAKE_BINARY_DIR}/generated")
+endif()
+
 if (PLUGINVAL_ENABLE_RTCHECK)
     target_link_libraries(pluginval PRIVATE
         rtcheck)

Source/CommandLine.cpp

@@ -290,7 +290,6 @@ static Option possibleOptions[] =
     { "--randomise",            false   },
     { "--sample-rates",         true    },
     { "--block-sizes",          true    },
-    { "--vst3validator",        true    },
     { "--rtcheck",              false   },
 };
 
@@ -384,8 +383,6 @@ static juce::String getHelpMessage()
   --disabled-tests [pathToFile]
     If specified, sets a path to a file that should have the names of disabled
     tests on each row.
-  --vst3validator [pathToValidator]
-    If specified, this will run the VST3 validator as part of the test process.
 
   --output-dir [pathToDir]
     If specified, sets a directory to store the log files. This can be useful
@@ -599,7 +596,6 @@ std::pair<juce::String, PluginTests::Options> parseCommandLine (const juce::Argu
     options.disabledTests       = getDisabledTests (args);
     options.sampleRates         = getSampleRates (args);
     options.blockSizes          = getBlockSizes (args);
-    options.vst3Validator       = getOptionValue (args, "--vst3validator", "", "Expected a path for the --vst3validator option");
     options.realtimeCheck       = magic_enum::enum_cast<RealtimeCheck> (getOptionValue (args, "--rtcheck", "", "Expected one of [disabled, enabled, relaxed]").toString().toStdString())
                                     .value_or (RealtimeCheck::disabled);
 
@@ -669,9 +665,6 @@ juce::StringArray createCommandLine (juce::String fileOrID, PluginTests::Options
         args.addArray ({ "--block-sizes", blockSizes.joinIntoString (",") });
     }
 
-    if (options.vst3Validator != juce::File())
-        args.addArray ({ "--vst3validator", options.vst3Validator.getFullPathName().quoted() });
-
     if (auto rtCheckMode = options.realtimeCheck;
         rtCheckMode != RealtimeCheck::disabled)
     {

Source/Main.cpp

@@ -18,6 +18,7 @@
 #include "CommandLine.h"
 #include "PluginvalLookAndFeel.h"
 
+
 //==============================================================================
 class PluginValidatorApplication  : public juce::JUCEApplication,
                                    private juce::AsyncUpdater
@@ -174,7 +175,6 @@ class PluginValidatorApplication  : public juce::JUCEApplication,
 };
 
 //==============================================================================
-// This macro generates the main() routine that launches the app.
 START_JUCE_APPLICATION (PluginValidatorApplication)
 
 juce::PropertiesFile& getAppPreferences()

Source/MainComponent.cpp

@@ -108,16 +108,6 @@ namespace
         return { 64, 128, 256, 512, 1024 };
     }
 
-    void setVST3Validator (juce::File f)
-    {
-        getAppPreferences().setValue ("vst3validator", f.getFullPathName());
-    }
-
-    juce::File getVST3Validator()
-    {
-        return getAppPreferences().getValue ("vst3validator", juce::String());
-    }
-
     void setRealtimeCheckMode (RealtimeCheck rt)
     {
         getAppPreferences().setValue ("realtimeCheckMode", juce::String (std::string (magic_enum::enum_name (rt))));
@@ -210,7 +200,6 @@ namespace
         options.outputDir = getOutputDir();
         options.sampleRates = getSampleRates();
         options.blockSizes = getBlockSizes();
-        options.vst3Validator = getVST3Validator();
         options.realtimeCheck = getRealtimeCheckMode();
 
         return options;
@@ -296,34 +285,6 @@ namespace
                                                                       }
                                                                   }));
     }
-
-    void showVST3ValidatorDialog()
-    {
-        juce::String message = TRANS("Set the location of the VST3 validator app");
-        auto app = getVST3Validator();
-
-        if (app.getFullPathName().isNotEmpty())
-            message << "\n\n" << app.getFullPathName().quoted();
-        else
-            message << "\n\n" << "\"None set\"";
-
-        std::shared_ptr<juce::AlertWindow> aw (juce::LookAndFeel::getDefaultLookAndFeel().createAlertWindow (TRANS("Set VST3 validator"), message,
-                                                                                                 TRANS("Choose"), TRANS("Don't use VST3 validator"), TRANS("Cancel"),
-                                                                                                 juce::AlertWindow::QuestionIcon, 3, nullptr));
-        aw->enterModalState (true, juce::ModalCallbackFunction::create ([aw] (int res)
-                                                                  {
-                                                                      if (res == 1)
-                                                                          setVST3Validator ({});
-
-                                                                      if (res == 1)
-                                                                      {
-                                                                          juce::FileChooser fc (TRANS("Choose VST3 validator"), {});
-
-                                                                          if (fc.browseForFileToOpen())
-                                                                              setVST3Validator (fc.getResult().getFullPathName());
-                                                                      }
-                                                                  }));
-    }
 }
 
 //==============================================================================
@@ -633,9 +594,6 @@ juce::PopupMenu MainComponent::createOptionsMenu()
     m.addItem (TRANS("Randomise tests"), true, getRandomiseTests(),
                [] { setRandomiseTests (! getRandomiseTests()); });
 
-    m.addItem (TRANS("Set VST3 validator location..."),
-               [] { showVST3ValidatorDialog(); });
-
     m.addSeparator();
 
     m.addItem (TRANS("Show settings folder"),

Source/PluginTests.h

@@ -50,7 +50,6 @@ struct PluginTests : public juce::UnitTest
         juce::StringArray disabledTests;                        /**< List of disabled tests. */
         std::vector<double> sampleRates;                        /**< List of sample rates. */
         std::vector<int> blockSizes;                            /**< List of block sizes. */
-        juce::File vst3Validator;                               /**< juce::File to use as the VST3 validator app. */
         RealtimeCheck realtimeCheck = RealtimeCheck::disabled;  /**< The type of real-time safety checking to perform. */
     };