Skip to content

Commit 0d509f7

Browse files
claudeclaude
committed
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
1 parent aa45515 commit 0d509f7

8 files changed

Lines changed: 429 additions & 61 deletions

File tree

‎CLAUDE.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ pluginval/
4949
│ ├── PluginvalLookAndFeel.h # Custom UI styling
5050
│ ├── StrictnessInfoPopup.h # Strictness level info UI
5151
│ ├── binarydata/ # Binary resources (icons)
52+
│ ├── vst3validator/ # Embedded VST3 validator integration
53+
│ │ ├── VST3ValidatorRunner.h
54+
│ │ └── VST3ValidatorRunner.cpp
5255
│ └── tests/ # Individual test implementations
5356
│ ├── BasicTests.cpp # Core plugin tests (info, state, audio)
5457
│ ├── BusTests.cpp # Audio bus configuration tests
@@ -101,6 +104,7 @@ cmake --build Builds/Debug --config Debug
101104
| Option | Description | Default |
102105
|--------|-------------|---------|
103106
| `PLUGINVAL_FETCH_JUCE` | Fetch JUCE with pluginval | ON |
107+
| `PLUGINVAL_VST3_VALIDATOR` | Build with embedded VST3 validator | ON |
104108
| `WITH_ADDRESS_SANITIZER` | Enable AddressSanitizer | OFF |
105109
| `WITH_THREAD_SANITIZER` | Enable ThreadSanitizer | OFF |
106110
| `VST2_SDK_DIR` | Path to VST2 SDK (env var) | - |
@@ -177,6 +181,27 @@ struct Requirements {
177181
| `LocaleTest.cpp` | Locale handling verification |
178182
| `ExtremeTests.cpp` | Edge cases, stress tests |
179183
184+
### VST3 Validator Integration
185+
186+
The VST3 validator (Steinberg's vstvalidator) is embedded directly into pluginval when built with `PLUGINVAL_VST3_VALIDATOR=ON` (the default). This eliminates the need to provide an external validator binary path.
187+
188+
**Architecture:**
189+
1. The VST3 SDK is fetched via CPM during CMake configure
190+
2. `VST3ValidatorRunner` (`Source/vst3validator/`) wraps the SDK's validation functionality
191+
3. When the `VST3validator` test runs, it spawns pluginval with `--vst3-validator-mode`
192+
4. This subprocess runs the embedded validator code in isolation (crash protection)
193+
194+
**Internal CLI mode:**
195+
```bash
196+
# Used internally by the VST3validator test - not for direct use
197+
pluginval --vst3-validator-mode /path/to/plugin.vst3 [-e] [-v]
198+
```
199+
200+
**Disabling embedded validator:**
201+
```bash
202+
cmake -B Builds -DPLUGINAL_VST3_VALIDATOR=OFF .
203+
```
204+
180205
## Adding New Tests
181206

182207
1. Create a subclass of `PluginTest`:
@@ -312,6 +337,7 @@ add_pluginval_tests(MyPluginTarget
312337
- **JUCE** (v8.0.x) - Audio application framework (git submodule)
313338
- **magic_enum** (v0.9.7) - Enum reflection (fetched via CPM)
314339
- **rtcheck** (optional, macOS) - Real-time safety checking (fetched via CPM)
340+
- **VST3 SDK** (v3.7.x) - Steinberg VST3 SDK for embedded validator (fetched via CPM, optional)
315341
316342
### System
317343
- macOS: CoreAudio, AudioUnit frameworks

‎CMakeLists.txt‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,23 @@ if(PLUGINVAL_ENABLE_RTCHECK)
5252
CPMAddPackage("gh:Tracktion/rtcheck#main")
5353
endif()
5454

55+
# VST3 Validator integration - embeds Steinberg's vstvalidator directly into pluginval
56+
option(PLUGINVAL_VST3_VALIDATOR "Build with embedded VST3 validator" ON)
57+
58+
if(PLUGINVAL_VST3_VALIDATOR)
59+
CPMAddPackage(
60+
NAME vst3sdk
61+
GITHUB_REPOSITORY steinbergmedia/vst3sdk
62+
GIT_TAG v3.7.14_build_55
63+
OPTIONS
64+
"SMTG_ENABLE_VST3_PLUGIN_EXAMPLES OFF"
65+
"SMTG_ENABLE_VST3_HOSTING_EXAMPLES OFF"
66+
"SMTG_ENABLE_VSTGUI_SUPPORT OFF"
67+
"SMTG_ADD_VSTGUI OFF"
68+
"SMTG_RUN_VST_VALIDATOR OFF"
69+
"SMTG_CREATE_BUNDLE_FOR_WINDOWS OFF"
70+
)
71+
endif()
5572

5673
option(PLUGINVAL_FETCH_JUCE "Fetch JUCE along with pluginval" ON)
5774

@@ -103,6 +120,24 @@ set(SourceFiles
103120
target_sources(pluginval PRIVATE ${SourceFiles})
104121
source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/Source PREFIX Source FILES ${SourceFiles})
105122

123+
# Add VST3 validator sources if enabled
124+
if(PLUGINVAL_VST3_VALIDATOR)
125+
set(VST3ValidatorFiles
126+
Source/vst3validator/VST3ValidatorRunner.h
127+
Source/vst3validator/VST3ValidatorRunner.cpp
128+
)
129+
target_sources(pluginval PRIVATE ${VST3ValidatorFiles})
130+
source_group("Source/vst3validator" FILES ${VST3ValidatorFiles})
131+
132+
target_include_directories(pluginval PRIVATE
133+
${vst3sdk_SOURCE_DIR}
134+
${vst3sdk_SOURCE_DIR}/pluginterfaces
135+
${vst3sdk_SOURCE_DIR}/base
136+
${vst3sdk_SOURCE_DIR}/public.sdk
137+
${vst3sdk_SOURCE_DIR}/public.sdk/source
138+
)
139+
endif()
140+
106141
if (DEFINED ENV{VST2_SDK_DIR})
107142
target_compile_definitions(pluginval PRIVATE
108143
JUCE_PLUGINHOST_VST=1)
@@ -118,6 +153,7 @@ target_compile_definitions(pluginval PRIVATE
118153
JUCE_MODAL_LOOPS_PERMITTED=1
119154
JUCE_GUI_BASICS_INCLUDE_XHEADERS=1
120155
$<$<BOOL:${PLUGINVAL_ENABLE_RTCHECK}>:PLUGINVAL_ENABLE_RTCHECK=1>
156+
$<$<BOOL:${PLUGINVAL_VST3_VALIDATOR}>:PLUGINVAL_VST3_VALIDATOR=1>
121157
VERSION="${CURRENT_VERSION}")
122158

123159
if(MSVC AND NOT CMAKE_MSVC_RUNTIME_LIBRARY)
@@ -137,6 +173,11 @@ if (${CMAKE_SYSTEM_NAME} MATCHES "Linux")
137173
-static-libstdc++)
138174
endif()
139175

176+
if (PLUGINVAL_VST3_VALIDATOR)
177+
target_link_libraries(pluginval PRIVATE
178+
sdk_hosting)
179+
endif()
180+
140181
if (PLUGINVAL_ENABLE_RTCHECK)
141182
target_link_libraries(pluginval PRIVATE
142183
rtcheck)

‎Source/CommandLine.cpp‎

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
#include "CrashHandler.h"
1818
#include "PluginTests.h"
1919

20+
#if PLUGINVAL_VST3_VALIDATOR
21+
#include "vst3validator/VST3ValidatorRunner.h"
22+
#endif
23+
2024
#if JUCE_MAC
2125
#include <signal.h>
2226
#include <sys/types.h>
@@ -286,7 +290,6 @@ static Option possibleOptions[] =
286290
{ "--randomise", false },
287291
{ "--sample-rates", true },
288292
{ "--block-sizes", true },
289-
{ "--vst3validator", true },
290293
{ "--rtcheck", false },
291294
};
292295

@@ -380,8 +383,6 @@ static juce::String getHelpMessage()
380383
--disabled-tests [pathToFile]
381384
If specified, sets a path to a file that should have the names of disabled
382385
tests on each row.
383-
--vst3validator [pathToValidator]
384-
If specified, this will run the VST3 validator as part of the test process.
385386
386387
--output-dir [pathToDir]
387388
If specified, sets a directory to store the log files. This can be useful
@@ -542,6 +543,36 @@ static void performCommandLine (CommandLineValidator& validator, const juce::Arg
542543
printStrictnessHelp (level);
543544
}});
544545

546+
#if PLUGINVAL_VST3_VALIDATOR
547+
cli.addCommand ({ "--vst3-validator-mode",
548+
"--vst3-validator-mode [pathToPlugin] [-e] [-v]",
549+
"Runs the embedded VST3 validator on the plugin (internal use).", juce::String(),
550+
[] (const auto& args)
551+
{
552+
auto pluginPath = getOptionValue (args, "--vst3-validator-mode", "",
553+
"Expected a plugin path for --vst3-validator-mode").toString();
554+
555+
if (pluginPath.isEmpty())
556+
{
557+
std::cerr << "Error: No plugin path specified\n";
558+
juce::JUCEApplication::getInstance()->setApplicationReturnValue (1);
559+
juce::JUCEApplication::getInstance()->quit();
560+
return;
561+
}
562+
563+
vst3validator::Options opts;
564+
opts.pluginPath = pluginPath.toStdString();
565+
opts.extendedMode = args.containsOption ("-e");
566+
opts.verbose = args.containsOption ("-v");
567+
568+
auto result = vst3validator::runValidator (opts);
569+
570+
std::cout << result.output;
571+
juce::JUCEApplication::getInstance()->setApplicationReturnValue (result.exitCode);
572+
juce::JUCEApplication::getInstance()->quit();
573+
}});
574+
#endif
575+
545576
if (const auto retValue = cli.findAndRunCommand (args); retValue != 0)
546577
{
547578
juce::JUCEApplication::getInstance()->setApplicationReturnValue (retValue);
@@ -566,7 +597,11 @@ bool shouldPerformCommandLine (const juce::String& commandLine)
566597
|| args.containsOption ("--version")
567598
|| args.containsOption ("--validate")
568599
|| args.containsOption ("--run-tests")
569-
|| args.containsOption ("--strictness-help");
600+
|| args.containsOption ("--strictness-help")
601+
#if PLUGINVAL_VST3_VALIDATOR
602+
|| args.containsOption ("--vst3-validator-mode")
603+
#endif
604+
;
570605
}
571606

572607
//==============================================================================
@@ -595,7 +630,6 @@ std::pair<juce::String, PluginTests::Options> parseCommandLine (const juce::Argu
595630
options.disabledTests = getDisabledTests (args);
596631
options.sampleRates = getSampleRates (args);
597632
options.blockSizes = getBlockSizes (args);
598-
options.vst3Validator = getOptionValue (args, "--vst3validator", "", "Expected a path for the --vst3validator option");
599633
options.realtimeCheck = magic_enum::enum_cast<RealtimeCheck> (getOptionValue (args, "--rtcheck", "", "Expected one of [disabled, enabled, relaxed]").toString().toStdString())
600634
.value_or (RealtimeCheck::disabled);
601635

@@ -665,9 +699,6 @@ juce::StringArray createCommandLine (juce::String fileOrID, PluginTests::Options
665699
args.addArray ({ "--block-sizes", blockSizes.joinIntoString (",") });
666700
}
667701

668-
if (options.vst3Validator != juce::File())
669-
args.addArray ({ "--vst3validator", options.vst3Validator.getFullPathName().quoted() });
670-
671702
if (auto rtCheckMode = options.realtimeCheck;
672703
rtCheckMode != RealtimeCheck::disabled)
673704
{

‎Source/MainComponent.cpp‎

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -108,16 +108,6 @@ namespace
108108
return { 64, 128, 256, 512, 1024 };
109109
}
110110

111-
void setVST3Validator (juce::File f)
112-
{
113-
getAppPreferences().setValue ("vst3validator", f.getFullPathName());
114-
}
115-
116-
juce::File getVST3Validator()
117-
{
118-
return getAppPreferences().getValue ("vst3validator", juce::String());
119-
}
120-
121111
void setRealtimeCheckMode (RealtimeCheck rt)
122112
{
123113
getAppPreferences().setValue ("realtimeCheckMode", juce::String (std::string (magic_enum::enum_name (rt))));
@@ -210,7 +200,6 @@ namespace
210200
options.outputDir = getOutputDir();
211201
options.sampleRates = getSampleRates();
212202
options.blockSizes = getBlockSizes();
213-
options.vst3Validator = getVST3Validator();
214203
options.realtimeCheck = getRealtimeCheckMode();
215204

216205
return options;
@@ -296,34 +285,6 @@ namespace
296285
}
297286
}));
298287
}
299-
300-
void showVST3ValidatorDialog()
301-
{
302-
juce::String message = TRANS("Set the location of the VST3 validator app");
303-
auto app = getVST3Validator();
304-
305-
if (app.getFullPathName().isNotEmpty())
306-
message << "\n\n" << app.getFullPathName().quoted();
307-
else
308-
message << "\n\n" << "\"None set\"";
309-
310-
std::shared_ptr<juce::AlertWindow> aw (juce::LookAndFeel::getDefaultLookAndFeel().createAlertWindow (TRANS("Set VST3 validator"), message,
311-
TRANS("Choose"), TRANS("Don't use VST3 validator"), TRANS("Cancel"),
312-
juce::AlertWindow::QuestionIcon, 3, nullptr));
313-
aw->enterModalState (true, juce::ModalCallbackFunction::create ([aw] (int res)
314-
{
315-
if (res == 1)
316-
setVST3Validator ({});
317-
318-
if (res == 1)
319-
{
320-
juce::FileChooser fc (TRANS("Choose VST3 validator"), {});
321-
322-
if (fc.browseForFileToOpen())
323-
setVST3Validator (fc.getResult().getFullPathName());
324-
}
325-
}));
326-
}
327288
}
328289

329290
//==============================================================================
@@ -629,9 +590,6 @@ juce::PopupMenu MainComponent::createOptionsMenu()
629590
m.addItem (TRANS("Randomise tests"), true, getRandomiseTests(),
630591
[] { setRandomiseTests (! getRandomiseTests()); });
631592

632-
m.addItem (TRANS("Set VST3 validator location..."),
633-
[] { showVST3ValidatorDialog(); });
634-
635593
m.addSeparator();
636594

637595
m.addItem (TRANS("Show settings folder"),

‎Source/PluginTests.h‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ struct PluginTests : public juce::UnitTest
5050
juce::StringArray disabledTests; /**< List of disabled tests. */
5151
std::vector<double> sampleRates; /**< List of sample rates. */
5252
std::vector<int> blockSizes; /**< List of block sizes. */
53-
juce::File vst3Validator; /**< juce::File to use as the VST3 validator app. */
5453
RealtimeCheck realtimeCheck = RealtimeCheck::disabled; /**< The type of real-time safety checking to perform. */
5554
};
5655

‎Source/tests/BasicTests.cpp‎

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -875,6 +875,7 @@ static AUvalTest auvalTest;
875875

876876
//==============================================================================
877877
/** Runs Steinberg's validator on the plugin if it's a VST3.
878+
Uses the embedded VST3 validator when built with PLUGINVAL_VST3_VALIDATOR.
878879
*/
879880
struct VST3validator : public PluginTest
880881
{
@@ -890,24 +891,27 @@ struct VST3validator : public PluginTest
890891
if (desc.pluginFormatName != "VST3")
891892
return;
892893

893-
auto vst3Validator = ut.getOptions().vst3Validator;
894+
#if ! PLUGINVAL_VST3_VALIDATOR
895+
ut.logMessage ("INFO: Skipping vst3 validator (not built with VST3 validator support)");
896+
return;
897+
#else
898+
// Use the current pluginval executable with --vst3-validator-mode
899+
auto pluginvalExe = juce::File::getSpecialLocation (juce::File::currentExecutableFile);
894900

895-
if (vst3Validator == juce::File())
896-
{
897-
ut.logMessage ("INFO: Skipping vst3 validator as validator path hasn't been set");
898-
return;
899-
}
900-
901-
juce::StringArray cmd (vst3Validator.getFullPathName());
901+
juce::StringArray cmd;
902+
cmd.add (pluginvalExe.getFullPathName());
903+
cmd.add ("--vst3-validator-mode");
904+
cmd.add (ut.getFileOrID());
902905

903906
if (ut.getOptions().strictnessLevel > 5)
904907
cmd.add ("-e");
905908

906-
cmd.add (ut.getFileOrID());
909+
if (ut.getOptions().verbose)
910+
cmd.add ("-v");
907911

908912
juce::ChildProcess cp;
909913
const auto started = cp.start (cmd);
910-
ut.expect (started, "VST3 validator app has been set but is unable to start");
914+
ut.expect (started, "Failed to start VST3 validator mode");
911915

912916
if (! started)
913917
return;
@@ -947,14 +951,19 @@ struct VST3validator : public PluginTest
947951

948952
if (! exitedCleanly && ! ut.getOptions().verbose)
949953
ut.logMessage (outputBuffer.toString());
954+
#endif
950955
}
951956

952957
std::vector<TestDescription> getDescription (int level) const override
953958
{
959+
#if ! PLUGINVAL_VST3_VALIDATOR
960+
return { { name, "Disabled (not built with VST3 validator support)" } };
961+
#else
954962
if (level > 5)
955963
return { { name, "Runs Steinberg's vstvalidator with -e flag for extended validation (VST3 only)" } };
956964

957965
return { { name, "Runs Steinberg's vstvalidator on the plugin file (VST3 only)" } };
966+
#endif
958967
}
959968
};
960969

0 commit comments

Comments
 (0)