Feature/synthdef instance (#18)

Implementation of synthdef persistance into plugin with midi handling

Author: asb2m10

.github/workflows/project-pipeline.yml

@@ -143,3 +143,4 @@ jobs:
           ${{github.workspace}}/build/*_artefacts/${{ env.BUILD_TYPE }}/VST3/*.vst3/**
           ${{github.workspace}}/build/*_artefacts/${{ env.BUILD_TYPE }}/CLAP/*.clap/**
           ${{github.workspace}}/build/*_artefacts/${{ env.BUILD_TYPE }}/Standalone/*.exe
+          #${{github.workspace}}/build/*_artefacts/${{ env.BUILD_TYPE }}/Standalone/*.pdb

CMakeLists.txt

@@ -41,6 +41,7 @@ set_property(SOURCE ${SC_DIR}/common/SC_Filesystem_macos.cpp PROPERTY COMPILE_FL
 
 set(CMAKE_MODULE_PATH ${SC_DIR}/cmake_modules)
 include (${SC_DIR}/cmake_modules/FinalFile.cmake)
+
 if (NOT APPLE AND NOT WIN32)
 	set(SNDFILE_INCLUDE_DIR ${SC_DIR}/external_libraries/libsndfile)
 	include (${SC_DIR}/cmake_modules/FindSndfile.cmake)
@@ -51,7 +52,7 @@ else()
 	FetchContent_Declare(
     	sndfile
     	GIT_REPOSITORY "https://github.com/libsndfile/libsndfile"
-    	GIT_TAG 17a19ab264fcf238f46104cea9af9a0a5ca3786d
+    	GIT_TAG ea9ff560b4c2086c2f1cae3f02287768a0de4673
     	GIT_PROGRESS TRUE
     	GIT_SHALLOW TRUE
 	)
@@ -87,7 +88,7 @@ include_directories(${SC_DIR}/external_libraries
 	${SC_DIR}/include/plugin_interface
     ${SC_DIR}/server/scsynth/
 	${SC_DIR}/server/common
-    ${CMAKE_CURRENT_SOURCE_DIR}/Source
+    ${CMAKE_CURRENT_SOURCE_DIR}/source
 	)
 
 # This is a hack since we will define our own Driver
@@ -136,8 +137,8 @@ if(MSVC)
     set(${flag} "${${flag}} /wd4996") # The POSIX name for this item is deprecated.
   endforeach()
 
-# this flag causes MSVC to correctly report __cplusplus, which prevents a compiler error 
-# caused by some versions of libsndfile's C++ header redefining nullptr as NULL. 
+# this flag causes MSVC to correctly report __cplusplus, which prevents a compiler error
+# caused by some versions of libsndfile's C++ header redefining nullptr as NULL.
 # See https://devblogs.microsoft.com/cppblog/msvc-now-correctly-reports-__cplusplus/
   add_compile_options("/Zc:__cplusplus")
 
@@ -152,7 +153,7 @@ endif(MSVC)
 IF (EXISTS ${SC_DIR}/build/common)
 	include_directories(${SC_DIR}/build/common)
 ELSE()
-	include_directories(Source/generated)
+	include_directories(source/generated)
 ENDIF()
 
 if (NOT Boost_FOUND)
@@ -162,17 +163,17 @@ endif()
 
 list(APPEND CMAKE_CXX_SOURCE_FILE_EXTENSIONS c)
 
-project(PluginCollider VERSION 0.1.0)
+project(PluginCollider VERSION 0.2.0)
 
 add_subdirectory(libs/JUCE)             # If you've put JUCE in a subdirectory called JUCE
 
 juce_add_plugin(PluginCollider
     # VERSION ...                               # Set this if the plugin version is different to the project version
-     ICON_BIG  Resources/ui/plugincollider_256x256.png
+     ICON_BIG  resources/ui/plugincollider_256x256.png
     # ICON_SMALL ...
     COMPANY_NAME "Digital Suburban"                 # Specify the name of the plugin's author
 	BUNDLE_ID "com.digitalsuburban.PluginCollider"  # The bundle identifier for the plugin, if it should be a standalone bundle
-    IS_SYNTH FALSE                                  # Is this a synth or an effect?
+    IS_SYNTH TRUE                                  # Is this a synth or an effect?
     NEEDS_MIDI_INPUT TRUE                           # Does the plugin need midi input?
     # NEEDS_MIDI_OUTPUT TRUE/FALSE                  # Does the plugin need midi output?
     # IS_MIDI_EFFECT TRUE/FALSE                     # Is this plugin a MIDI effect?
@@ -205,6 +206,10 @@ if (WIN32)
 	${SC_DIR}/common/SC_Filesystem_win.cpp)
 endif (WIN32)
 
+target_sources(PluginCollider
+PRIVATE
+source/ext/value_tree_debugger.cpp)
+
 if (NOT SC_DYNAMIC_PLUGINS)
 target_sources(PluginCollider
     PRIVATE
@@ -271,12 +276,12 @@ target_sources(PluginCollider
 	${SC_DIR}/server/scsynth/SC_World.cpp
 
 	# plugincollider itself =============================
-	Source/UDPPort.cpp 
-	Source/OSCMessages.cpp
-    Source/PluginEditor.cpp
-    Source/PluginProcessor.cpp
-	Source/SCProcess.cpp
-	Source/SCPluginDriver.cpp
+	source/UDPPort.cpp
+	source/OSCMessages.cpp
+    source/PluginEditor.cpp
+    source/PluginProcessor.cpp
+	source/SCProcess.cpp
+	source/SCPluginDriver.cpp
 
 	${boost_system_sources}
 	${boost_filesystem_sources})
@@ -294,6 +299,7 @@ target_link_libraries(PluginCollider
     PRIVATE
         # AudioPluginData           # If we'd created a binary data target, we'd link to it here
         juce::juce_audio_utils
+		juce::juce_osc
     PUBLIC
         juce::juce_recommended_config_flags
         juce::juce_recommended_lto_flags

README.md

@@ -3,34 +3,63 @@ Plugincollider
 
 Plugincollider is a generic (cross-platform/plugin format) wrapper that allows using a [SuperCollider](https://supercollider.github.io/) server inside a VST3 or AU plugin. The embedded server may be controlled over OSC as usual.
 
-Now support Linux, macOS and Windows.
+![plugincollider screenshot](resources/ui/screenshot_bitwig.png)
 
-An external installation of [SuperCollider](https://supercollider.github.io/) is required to run the interpreted code. For now Plugincollider only acts as a server; consider this as a scsynth replacement. The classic SuperCollider UI is still used to send "synths/code" the the server that is running inside the plugin.
+Now support Linux, macOS and Windows.
 
 *Plugincollider is based on AU version of https://github.com/supercollider/SuperColliderAU*
 
-# State of the project
+## State of the project
 
 SuperCollider is a highly modular ecosystem (sc-plugins, scsynth definitions) that needs to be adapted for each platform from the VST3/clap component. For now consider this as a vanilla scsynth implementation with no external plugins.
 
 Latest build are available from [https://github.com/asb2m10/plugincollider/actions](https://github.com/asb2m10/plugincollider/actions)
 
-### Known issues
+## Usage - Supercollider server
+Plugincollider can be used as a standard SuperCollider server by using the SC IDE (or any other sclang client). You can test the plugin by using this SC code (where Plugincollider is running at 127.0.0.1:8898) :
 
-* Be sure to set your DAW latency size to a power of two (256, 512, 1024) otherwise some SC plugins might not work properly.
-* If you are running multiple VST instances, scsynth errors messages might end up into one specific unrelated vst logs since scsynth is design to be run into one single process. Some DAWs has a "Dedicated process" runtime that might resolve the issue.
+    o = ServerOptions.new;
+    s = Server.remote(\Plugincollider, NetAddr("127.0.0.1", 8898), o);
+    { [SinOsc.ar(439, 0, 0.2), SinOsc.ar(444, 0, 0.2)] }.play(s);
 
-### TODO
+## Usage - SynthDefs files
 
-- [ ] implement /midi and /velocity from DAW midi message
-- [ ] more accurate OSC DAW timing
-- [ ] *macOS* enable Plugincollider to use SuperCollider scsynth plugin that the user previously installed
-- [ ] move OSC messages to realtime (dsp) thread
-- [x] *Windows* bundle sndfile.dll within the plugin installation
+Plugincollider can load previously compiled [SynthDefs](resources/scsyndef) (*.scsyndef) that will be saved within the DAW plugin state. No installation/usage of Supercollider afterwards is required if you want to exclusively use scsyndef files.
+
+If the SynthDef has arguments, they will be exposed to the plugin and the user can set the lower and upper values for each arguments. The user can then easily change them from the Plugincollider UI.
+
+### FX Mode
+
+If there is a SynthDef loaded, the plugin can be put in "FX Mode" that will run this SynthDef on a single node every time the plugin is running. This can be useful if you want to use the plugin as an effect or a drone/noodle.
+
+### Non-Fx Mode (Synth Mode)
+
+In this mode (and when a SynthDef is loaded), everytime Plugincollider receives a midi node, it will trigger this synth based on those parameters:
 
-### macOS notes
+| Midi Event         | ScSynDef args | Conversion                                                          |
+| ------------------ | ------------- | ------------------------------------------------------------------- |
+| note-on midi note  | freq          | Converts midi node (0-127) to frequency (hz)                        |
+| note-on velocity   | amp           | Converts midi velocity (0-127) to amp(0.0-1.0), linearly (for now). |
+| note-off           | gate          | Sends gate=0 on midi note off                                       |
+
+If for example your SynthDef doesn't have the gate arguments, the node will be freed once the note off is triggered.
+
+# Known issues
+
+* Be sure to set your DAW latency size to a power of two (256, 512, 1024) otherwise some SC plugins might not work properly.
+* If you are running multiple VST instances, scsynth errors messages might end up into one specific unrelated vst logs since scsynth is design to be run into one single process. Some DAWs has a "Dedicated process" runtime that might resolve this issue.
+* PluginCollider is currently built with "static" SC-plugin. It is great because you don't need any SuperCollider installation but it cannot load additional SC-plugins. This will be resolved when we will be able to package the plugin on any platform. (you can disable this by building PluginCollider with the SC_DYNAMIC_PLUGINS directive)
+* On Windows, if you are using the github releases, be sure to update the [MSVC Runtime](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#visual-studio-2015-2017-2019-and-2022) to the latest version
+
+# TODO
+- [ ] add [CLAP](https://github.com/free-audio/clap) plugin format
+- [ ] assign scsyndef parameters to controlbus (and plug parameters values)
+- [ ] multi scsyndef support
+- [x] implement /freq and /amp from DAW midi message
+- [ ] *macOS* enable Plugincollider to use SuperCollider scsynth plugin that the user previously installed (handle notarization)
+- [x] *Windows* bundle sndfile.dll within the plugin installation
+- [ ] more accurate OSC DAW timing
 
-macOS makes it harder to use shared libraries from SuperCollider to Plugincollider. It is easier to build it from your computer for now. I will check how I can do this without having to repackage everything in the plugin within the distribution.
 
 # Interacting with SuperCollider server (scsynth) from DAW
 
@@ -47,13 +76,13 @@ Plugin parameters are now linked to the first 32 control buses. The SC code must
             var sig = SinOsc.ar(freq);
             Out.ar(sig, sig!2 * 1);
         }).play(s);
-    
+
     b = Bus.control(s, 1);
     x.map(\freq, b)
 
 Please note that control buses are not yet read from server to DAW.
 
-## Build instructions
+# Build instructions
 
 Be sure to install SuperCollider and JUCE dependencies; dont forget [sndfile](https://github.com/libsndfile/libsndfile) on Linux. Then clone recursivly the repository and build Plugincollider like a normal cmake project :
 
@@ -63,9 +92,3 @@ Be sure to install SuperCollider and JUCE dependencies; dont forget [sndfile](ht
     cd build
     cmake ..       # add `-G Xcode` if you want to use Xcode
     make
-
-In order to test the plugin, with sclang execute this code (replace port 8898 where the server port is actually running):
-
-    o = ServerOptions.new;
-    s = Server.remote(\Plugincollider, NetAddr("127.0.0.1", 8898), o);
-    { [SinOsc.ar(439, 0, 0.2), SinOsc.ar(444, 0, 0.2)] }.play(s);