Merge branch 'develop' into feature/rtcheck

# Conflicts:
#	.github/workflows/build.yaml

Author: drowaudio

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: drowaudio

.github/workflows/build.yaml

@@ -23,7 +23,7 @@ jobs:
             test-binary: ./pluginval
             container: ubuntu:22.04
           - name: macOS
-            os: macos-12
+            os: macos-13
             app: pluginval.app
             test-binary: pluginval.app/Contents/MacOS/pluginval
           - name: Windows
@@ -54,7 +54,7 @@ jobs:
       - name: Setup Environment Variables
         shell: bash
         run: |
-          VERSION=$(cat VERSION)
+          VERSION=$(head -n1 VERSION)
           echo "VERSION=$VERSION" >> $GITHUB_ENV
           echo "APP_DIR=${{ env.BUILD_DIR }}/${{ env.BINARY_NAME }}_artefacts/${{ env.BUILD_TYPE }}" >> $GITHUB_ENV
           echo "ZIP_FILE_NAME=${{ env.BINARY_NAME }}_${{ matrix.name }}.zip" >> $GITHUB_ENV
@@ -64,15 +64,15 @@ 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
-      
+
       - name: Install dependencies (Linux)
         if: ${{ matrix.name == 'Linux' }}
         run: |
           sudo add-apt-repository ppa:ubuntu-toolchain-r/test
           sudo apt-get update
           sudo apt-get install -y freeglut3-dev g++ libasound2-dev libcurl4-openssl-dev libfreetype6-dev libjack-jackd2-dev libx11-dev libxcomposite-dev libxcursor-dev libxinerama-dev libxrandr-dev mesa-common-dev ladspa-sdk webkit2gtk-4.0 libgtk-3-dev xvfb
           sudo /usr/bin/Xvfb $DISPLAY &
-          
+
       - name: Make VST2 SDK available
         shell: bash
         run: |
@@ -111,11 +111,11 @@ jobs:
       - name: Cache JUCE example plugin binaries
         id: cache-plugins
         uses: actions/cache@v3
-        with: 
+        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 }}
-          
+
       - name: Build JUCE example plugins
         if: steps.cache-plugins.outputs.cache-hit != 'true'
         working-directory: modules/juce
@@ -144,13 +144,11 @@ jobs:
           cp -R ${{ env.PLUGIN_CACHE_PATH }}/DSPModulePluginDemo_artefacts/Release/AU/DSPModulePluginDemo.component ~/Library/Audio/Plug-Ins/Components/
           killall -9 AudioComponentRegistrar # kick the AU registrar
           ${{ env.APP_DIR }}/${{ matrix.test-binary }} --strictness-level 10 --validate  ~/Library/Audio/Plug-Ins/Components/DSPModulePluginDemo.component
-    
+
       - name: Codesign (macOS)
         if: ${{ matrix.name == 'macOS' }}
-        run: |
-          codesign --force -s "${{ secrets.DEVELOPER_ID_APPLICATION}}" -v ${{ env.APP_DIR }}/${{ matrix.app }}/Contents/Libraries/librtcheck.dylib --entitlements ${{ env.BUILD_DIR }}/${{ env.BINARY_NAME }}_artefacts/JuceLibraryCode/${{ env.BINARY_NAME }}.entitlements --deep --strict --options=runtime --timestamp
-          codesign --force -s "${{ secrets.DEVELOPER_ID_APPLICATION}}" -v ${{ env.APP_DIR }}/${{ matrix.app }} --entitlements ${{ env.BUILD_DIR }}/${{ env.BINARY_NAME }}_artefacts/JuceLibraryCode/${{ env.BINARY_NAME }}.entitlements --deep --strict --options=runtime --timestamp
-      
+        run: codesign --force -s "${{ secrets.DEVELOPER_ID_APPLICATION}}" -v ${{ env.APP_DIR }}/${{ matrix.app }} --entitlements ${{ env.BUILD_DIR }}/${{ env.BINARY_NAME }}_artefacts/JuceLibraryCode/${{ env.BINARY_NAME }}.entitlements --deep --strict --options=runtime --timestamp
+
       - name: "Notarize and staple (macOS)"
         if: ${{ matrix.name == 'macOS' }}
         working-directory: ${{ env.APP_DIR }}
@@ -159,17 +157,17 @@ jobs:
           xcrun notarytool submit ${{ env.ZIP_FILE_NAME }} --apple-id ${{ secrets.NOTARIZATION_USERNAME }} --password ${{ secrets.NOTARIZATION_PASSWORD }} --team-id ${{ secrets.TEAM_ID }} --wait
           xcrun stapler staple ${{ matrix.app }}
           rm ${{ env.ZIP_FILE_NAME }}
-      
+
       - name: Create zip files
         working-directory: ${{ env.APP_DIR }}
         run: 7z a -aoa -tzip ${{ env.ZIP_FILE_NAME }} ${{ matrix.app }}
-      
+
       - name: Upload zip files
         uses: actions/upload-artifact@v4
         with:
           name: ${{ env.ZIP_FILE_NAME }}
           path: ${{ env.APP_DIR }}/${{ env.ZIP_FILE_NAME }}
-      
+
   # Create release for tagged refs
   deploy:
     if: contains(github.ref, 'tags/v')
@@ -178,20 +176,19 @@ jobs:
     steps:
       # Needed to grab CHANGELIST.md
       - uses: actions/checkout@v3
-                
+
       - name: Get Artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: ./
 
       - name: Display structure of downloaded files
         run: ls -la
 
       - name: Create Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           body_path: CHANGELIST.md
-          draft: true
           files: |
             CHANGELIST.md/*
             pluginval_Linux.zip/*

CHANGELIST.md

@@ -1,9 +1,15 @@
 # pluginval Change List
 
+### 1.0.5
+- Added static linking to the Windows runtime so it should run on more Windows systems (particularly non-dev machines)
+- Made `PluginInfoTest` run on the message thread as the functions it calls aren't thread-safe 
+
 ### 1.0.4
+- Limit auval's stress test to 20 seconds (vs 600) [#135]
 - Fixed incorrect "ALL TESTS PASSED" message when validating out of process [#125]
-- Updated juce to 113009c074
+- Updated juce to 8.0.3 [#133]
 - Added LV2 support [#25]
+- Provide CMake module for registering pluginval tests with CTest [#123] 
 - Changed minimum Linux version to Ubuntu 22.04
 
 ### 1.0.3

CMakeLists.txt

@@ -1,20 +1,42 @@
 cmake_minimum_required(VERSION 3.15)
 
-file(READ VERSION CURRENT_VERSION)
+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 "")
-    
+
     # Uncomment to produce a universal binary
     # set(CMAKE_OSX_ARCHITECTURES arm64 x86_64)
     set(PLUGINVAL_ENABLE_RTCHECK ON)
 endif()
 
-# Uncomment to enable tsan
-# set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=thread")
-
+# sanitizer options, from https://github.com/sudara/cmake-includes/blob/main/Sanitizers.cmake
+# set the corresponding option ON to turn on Address/Thread Sanitizer
+option(WITH_ADDRESS_SANITIZER "Enable Address Sanitizer" OFF)
+option(WITH_THREAD_SANITIZER "Enable Thread Sanitizer" OFF)
+
+message(STATUS "Sanitizers: ASan=${WITH_ADDRESS_SANITIZER} TSan=${WITH_THREAD_SANITIZER}")
+if (WITH_ADDRESS_SANITIZER)
+    if (MSVC)
+        add_compile_options(/fsanitize=address)
+    elseif (CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+        # also enable UndefinedBehaviorSanitizer
+        # https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html
+        add_compile_options(-fsanitize=address,undefined -fno-omit-frame-pointer)
+        link_libraries(-fsanitize=address)
+    endif ()
+    message("Address Sanitizer enabled")
+endif ()
+
+if (WITH_THREAD_SANITIZER)
+    if (CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+        add_compile_options(-fsanitize=thread -g -fno-omit-frame-pointer)
+        link_libraries(-fsanitize=thread)
+        message("Thread Sanitizer enabled")
+    endif ()
+endif ()
 
 # Adds all the module sources so they appear correctly in the IDE
 set_property(GLOBAL PROPERTY USE_FOLDERS YES)
@@ -74,6 +96,7 @@ set(SourceFiles
     Source/MainComponent.cpp
     Source/PluginTests.cpp
     Source/tests/BasicTests.cpp
+    Source/tests/LocaleTest.cpp
     Source/tests/BusTests.cpp
     Source/tests/ParameterFuzzTests.cpp
     Source/TestUtilities.cpp
@@ -94,14 +117,16 @@ target_compile_definitions(pluginval PRIVATE
     JUCE_PLUGINHOST_LV2=1
     JUCE_USE_CURL=0
     JUCE_WEB_BROWSER=0
-    JUCER_ENABLE_GPL_MODE=1
-    JUCE_DISPLAY_SPLASH_SCREEN=0
     JUCE_MODAL_LOOPS_PERMITTED=1
-    JUCE_REPORT_APP_USAGE=0
     JUCE_GUI_BASICS_INCLUDE_XHEADERS=1
     $<$<BOOL:${PLUGINVAL_ENABLE_RTCHECK}>:PLUGINVAL_ENABLE_RTCHECK=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>")
+endif()
+
 target_link_libraries(pluginval PRIVATE
     juce::juce_audio_devices
     juce::juce_audio_processors

FUNDING.md

@@ -0,0 +1,35 @@
+# Funding
+
+Support the development of this project by sponsoring it!  
+Your contributions help maintain and improve this project, add new features, and keep documentation up-to-date.  
+
+## How to Sponsor
+
+You can sponsor this project through the following platforms:
+
+- **GitHub Sponsors**: [Become a sponsor on GitHub](https://github.com/sponsors/drowaudio)
+
+## Why Sponsor?
+
+- 💡 Influence the [roadmap](ROADMAP.md)
+- 🐞 Priority support on issues
+- ❤️ Help sustain open-source work
+
+## Tiers
+### Monthly:
+- 🥉 [$5](https://github.com/sponsors/drowaudio/sponsorships?sponsor=drowaudio&tier_id=535613)
+- 🥈 [$10](https://github.com/sponsors/drowaudio/sponsorships?sponsor=drowaudio&tier_id=535614)
+- 🥇 [$25](https://github.com/sponsors/drowaudio/sponsorships?sponsor=drowaudio&tier_id=535619)
+- 💎 [$50](https://github.com/sponsors/drowaudio/sponsorships?sponsor=drowaudio&tier_id=535620)
+
+### One-time
+- 🥉 [$50](https://github.com/sponsors/drowaudio/sponsorships?sponsor=drowaudio&tier_id=535616)
+- 🥈 [$100](https://github.com/sponsors/drowaudio/sponsorships?sponsor=drowaudio&tier_id=535618)
+- 🥇 [$500](https://github.com/sponsors/drowaudio/sponsorships?sponsor=drowaudio&tier_id=535615)
+- 💎 [$1000](https://github.com/sponsors/drowaudio/sponsorships?sponsor=drowaudio&tier_id=535617) one [roadmap](ROADMAP.md) item fully implemented
+
+
+---
+
+Thank you for considering sponsorship!  
+Your support makes open-source possible.  

README.md

@@ -15,6 +15,10 @@ If you are a plugin user looking to report a problem with a plugin to the develo
   - Run in GUI or headless mode
   - Validation is performed in a separate process to avoid crashing
 
+### Funding
+pluginval is a free, open source project but supporting it via funding is a great way to show your appreciation for it, speed up development and influence the [roadmap](ROADMAP.md).
+
+See [FUNDING.md](FUNDING.md) for more details and the bottom of this file for a list of our diamond sponsors.
 
 ### Installation
 
@@ -101,6 +105,30 @@ If you would like to contribute to the project please do! It's very simple to ad
 
 If you have a case you would like tests, please simply write the test in a fork and create a pull request. The more tests the better!
 
+### Cutting New Releases
+
+* Update VERSION (an extra newline is fine)
+* Update CHANGELIST.md
+* `git commit -am "Version 1.0.5"`
+* `git tag -a v1.0.5 -m "1.0.5 release"`
+* `git push --tags`
+
+## Roadmap
+Find more information on what's in the pipeline for pluginval [here](ROADMAP.md).
+
+## Sponsors
+Thanks to all those who sponsor pluginval's development and a special thanks to those at the diamond level:
+
+[💎 The Audio Programmer](https://theaudioprogrammer.com/?utm_source=pluginval)
+
+<a href="https://theaudioprogrammer.com/?utm_source=pluginval"><img width="75" height="75" alt="image" src="https://github.com/user-attachments/assets/7a6e2e8e-d4c7-461c-98db-d8c1df67be1b" />
+</a>
+
+[💎 Moonbase](https://moonbase.sh/?utm_source=pluginval)
+
+<a href="https://moonbase.sh/?utm_source=pluginval"><img width="517" height="75" alt="MB-banner" src="https://github.com/user-attachments/assets/80f5d6bf-2606-416d-8bb6-f02c66626377"/></a>
+
+
 License
 ----
 

ROADMAP.md

@@ -0,0 +1,13 @@
+# Roadmap
+
+There are lots of ways pluginval can be improved, some of these are listed below but we're open to Discussions on others.
+
+You can help get there by issuing PRs or [funding](FUNDING.md) development.
+
+- #### Integration of real-time safety checking (via RTsan or rtcheck)
+- #### Improved stack trace/crash reporting
+- #### Acceptance testing using input files and reference output files
+- #### Automatic integration of Asan/Tsan on platforms that allow it
+- #### More tests/logging
+- #### Integration with CTest
+- #### Improved command-line handling and json config file support

Source/CommandLine.cpp

@@ -239,7 +239,7 @@ namespace
     bool isPluginArgument (juce::String arg)
     {
         juce::AudioPluginFormatManager formatManager;
-        formatManager.addDefaultFormats();
+        juce::addDefaultFormatsToManager (formatManager);
 
         for (auto format : formatManager.getFormats())
             if (format->fileMightContainThisPluginType (arg))

Source/MainComponent.cpp

@@ -194,14 +194,14 @@ namespace
             message << "\n\n" << "\"None set\"";
 
         std::shared_ptr<juce::AlertWindow> aw (juce::LookAndFeel::getDefaultLookAndFeel().createAlertWindow (TRANS("Set Log File Directory"), message,
-                                                                                                 TRANS("Choose dir"), TRANS("Cancel"), TRANS("Don't save logs"),
+                                                                                                 TRANS("Choose dir"), TRANS("Don't save logs"), TRANS("Cancel"),
                                                                                                  juce::AlertWindow::QuestionIcon, 3, nullptr));
         aw->enterModalState (true, juce::ModalCallbackFunction::create ([aw] (int res)
                                                                   {
-                                                                      if (res == 3)
+                                                                      if (res == 1)
                                                                           getAppPreferences().setValue ("outputDir", juce::String());
 
-                                                                      if (res == 1)
+                                                                      if (res == 2)
                                                                       {
                                                                           const auto defaultDir = juce::File::getSpecialLocation (juce::File::userDesktopDirectory).getChildFile ("pluginval logs").getFullPathName();
                                                                           juce::FileChooser fc (TRANS("Directory to save log files"), defaultDir);
@@ -223,11 +223,11 @@ namespace
             message << "\n\n" << "\"None set\"";
 
         std::shared_ptr<juce::AlertWindow> aw (juce::LookAndFeel::getDefaultLookAndFeel().createAlertWindow (TRANS("Set VST3 validator"), message,
-                                                                                                 TRANS("Choose"), TRANS("Cancel"), TRANS("Don't use VST3 validator"),
+                                                                                                 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 == 3)
+                                                                      if (res == 1)
                                                                           setVST3Validator ({});
 
                                                                       if (res == 1)
@@ -246,7 +246,7 @@ namespace
 MainComponent::MainComponent (Validator& v)
     : validator (v)
 {
-    formatManager.addDefaultFormats();
+    juce::addDefaultFormatsToManager (formatManager);
 
     const auto tabCol = getLookAndFeel().findColour (juce::ResizableWindow::backgroundColourId);
     addAndMakeVisible (tabbedComponent);

Source/PluginTests.cpp

@@ -52,7 +52,7 @@ PluginTests::PluginTests (const juce::String& fileOrIdentifier, Options opts)
 {
     jassert (fileOrIdentifier.isNotEmpty());
     jassert (juce::isPositiveAndNotGreaterThan (options.strictnessLevel, 10));
-    formatManager.addDefaultFormats();
+    juce::addDefaultFormatsToManager (formatManager);
 }
 
 PluginTests::PluginTests (const juce::PluginDescription& desc, Options opts)
@@ -193,10 +193,10 @@ void PluginTests::testType (const juce::PluginDescription& pd)
                     {
                         juce::WaitableEvent completionEvent;
                         juce::MessageManager::callAsync ([&, this]() mutable
-                                                   {
-                                                       t->runTest (*this, *instance);
-                                                       completionEvent.signal();
-                                                   });
+                                                          {
+                                                              t->runTest (*this, *instance);
+                                                              completionEvent.signal();
+                                                          });
                         completionEvent.wait();
                     }
                     else