enable embedding of presets during build

add EMBED_PRESETS option to cmake
add -e option to build_plugins.sh

Author: drlight-code

CMakeLists.txt

@@ -18,10 +18,10 @@ function(add_osccontrol_target TARGET FORMATS)
         # EDITOR_WANTS_KEYBOARD_FOCUS TRUE/FALSE    # Does the editor need keyboard focus?
         COPY_PLUGIN_AFTER_BUILD FALSE               # Should the plugin be installed to a default location after building?
         PLUGIN_MANUFACTURER_CODE drLt               # A four-character manufacturer id with at least one upper-case character
-        # PLUGIN_CODE oscL                            # A unique four-character plugin id with at least one upper-case character
-        PLUGIN_NAME ${TARGET}
-        FORMATS ${FORMATS}                          # The formats to build. Other valid formats are: AAX Unity VST AU AUv3
-        PRODUCT_NAME ${TARGET})                     # The name of the final executable, which can differ from the target name
+        # PLUGIN_CODE oscL                          # A unique four-character plugin id with at least one upper-case character
+        PLUGIN_NAME "${TARGET}"
+        FORMATS "${FORMATS}"                        # The formats to build. Other valid formats are: AAX Unity VST AU AUv3
+        PRODUCT_NAME "${TARGET}")                   # The name of the final executable, which can differ from the target name
 endfunction()
 
 function(configure_osccontrol_target TARGET)
@@ -56,15 +56,26 @@ function(configure_osccontrol_target TARGET)
         Source/UIComponentFactory.h
         )
 
-    target_compile_definitions(${TARGET}
-        PUBLIC
+    target_compile_definitions(${TARGET} PUBLIC
         # JUCE_WEB_BROWSER and JUCE_USE_CURL would be on by default, but you might not need them.
         JUCE_WEB_BROWSER=0  # If you remove this, add `NEEDS_WEB_BROWSER TRUE` to the `juce_add_plugin` call
         JUCE_USE_CURL=0     # If you remove this, add `NEEDS_CURL TRUE` to the `juce_add_plugin` call
         JUCE_VST3_CAN_REPLACE_VST2=0
         JUCE_MODAL_LOOPS_PERMITTED=1 # allow modal loops for now to enable file chooser dialog
         YAML_CPP_STATIC_DEFINE=1
+    )
+
+    if(EMBED_PRESETS AND NOT "${TARGET}" STREQUAL "osccontrol-light")
+        STRING(REGEX REPLACE "^osc-" "" PRESET ${TARGET})
+        target_compile_definitions("${TARGET}" PUBLIC EMBED_PRESET)
+        juce_add_binary_data("${TARGET}-data"
+            HEADER_NAME "EmbeddedPreset.h"
+            NAMESPACE "osccontrol_embedded_preset"
+            SOURCES "Presets/${PRESET}.yaml"
         )
+        set_target_properties("${TARGET}-data" PROPERTIES POSITION_INDEPENDENT_CODE TRUE)
+        target_link_libraries(${TARGET} PRIVATE "${TARGET}-data")
+    endif()
 
     target_link_libraries(${TARGET} PRIVATE
         osccontrol-light-data
@@ -87,15 +98,16 @@ juce_add_binary_data(osccontrol-light-data SOURCES
 set_target_properties(osccontrol-light-data PROPERTIES POSITION_INDEPENDENT_CODE TRUE)
 
 # we always build the interactive gui version of the plugin as VST3 and standalone application
-message("creating build target for osccontrol-light standalone application")
-message("creating build target for osccontrol-light VST3 plugin")
+message("creating build target for osccontrol-light (Standalone)")
+message("creating build target for osccontrol-light (VST3)")
 add_osccontrol_target(osccontrol-light "Standalone;VST3")
 configure_osccontrol_target(osccontrol-light)
 
-set(PRESET_NAMES "" CACHE STRING "list of presets for which a plugin is built")
-foreach(PRESET_NAME ${PRESET_NAMES})
-    message("creating build target for ${PRESET_NAME} preset VST3 plugin")
-    set(PRESET_TARGET "osc-${PRESET_NAME}")
+set(PRESETS "" CACHE STRING "list of presets for which a plugin is built")
+set(EMBED_PRESETS "" CACHE BOOL "embed preset definition at build time")
+foreach(PRESET ${PRESETS})
+    message("creating build target for ${PRESET} preset (VST3)")
+    set(PRESET_TARGET "osc-${PRESET}")
     add_osccontrol_target(${PRESET_TARGET} "VST3")
     configure_osccontrol_target(${PRESET_TARGET})
 endforeach()

Source/PluginProcessor.cpp

@@ -18,6 +18,12 @@
 
 */
 
+#include "BinaryData.h"
+#ifdef EMBED_PRESET
+  #include "EmbeddedPreset.h"
+#endif
+
+
 #include "PresetParser.h"
 
 #include "ControlElementHost.h"
@@ -41,42 +47,39 @@ OSCControlAudioProcessor() :
     filenamePlugin = filePlugin.getFileNameWithoutExtension();
     auto filenameLog = filenamePlugin + ".log";
 
+    namePlugin = filenamePlugin;
+
     fileLogger = std::make_unique<FileLogger>
         (filePlugin.getParentDirectory().getChildFile(filenameLog),
          "osccontrol-light debug log", 0);
 
     Logger::setCurrentLogger(fileLogger.get());
-    
+
     Logger::writeToLog(filePlugin.getFullPathName());
     Logger::writeToLog(filenamePlugin);
 
     auto pathPreset =
         SystemStats::getEnvironmentVariable("OSCCONTROL_PRESET_PATH", "");
     dirPreset = File (pathPreset);
 
-    if (filenamePlugin != "osccontrol-light") {
-        auto presetToLoad =
-            filenamePlugin.fromFirstOccurrenceOf
-			("osc", false, false).trimCharactersAtStart("-");
-
-        if (presetToLoad.isNotEmpty()) {
-            Logger::writeToLog("presetToLoad: " + presetToLoad);
-            namePlugin = filenamePlugin;
-
-            if (pathPreset == "") {
-                AlertWindow::showMessageBox
-                (AlertWindow::AlertIconType::WarningIcon,
-                    String("Error loading osccontrol-light with preset: ") + presetToLoad,
-                    "When running osccontrol-light in headless mode "
-                    "for DAW integration, make sure that "
-                    "OSCCONTROL_PRESET_PATH is set properly in "
-                    "the environment!"); // TODO freak out!!
-            }
+    auto presetToLoad = namePlugin.fromFirstOccurrenceOf
+        ("osc-", false, false).trimCharactersAtStart("-");
+    Logger::writeToLog("presetToLoad: " + presetToLoad);
+
+    if (presetToLoad != "osccontrol-light" && presetToLoad.isNotEmpty()) {
+        if (!dirPreset.exists()) {
+            auto message =
+                String("Error loading osccontrol-light with preset: ") + presetToLoad +
+                "When running osccontrol-light in headless mode "
+                "for DAW integration, make sure that "
+                "OSCCONTROL_PRESET_PATH is set properly in "
+                "the environment!";
 
-            auto presetFile = locatePresetFile(presetToLoad);
-            hasUserInterface = false;
-            initializeHeadless(presetFile);
+            throw std::runtime_error (message.toStdString ());
         }
+
+        hasUserInterface = false;
+        initializeHeadless(presetToLoad);
     }
 }
 
@@ -90,7 +93,7 @@ OSCControlAudioProcessor::
 File
 OSCControlAudioProcessor::
 locatePresetFile
-(String namePreset)
+(String const & namePreset)
 {
     auto filenamePreset = namePreset + ".yaml";
     auto files = dirPreset.findChildFiles
@@ -109,11 +112,22 @@ locatePresetFile
 void
 OSCControlAudioProcessor::
 initializeHeadless
-(File filePreset)
+(String const & namePreset)
 {
     Logger::writeToLog("initializeHeadless");
 
-    PresetParser preset (filePreset);
+#ifdef EMBED_PRESET
+    int sourceSize = 0;
+    const void * sourceData =
+        osccontrol_embedded_preset::getNamedResource(
+            osccontrol_embedded_preset::namedResourceList[0], sourceSize);
+    MemoryInputStream inputStream(sourceData, sourceSize, false);
+#else
+    auto presetFile = locatePresetFile(namePreset);
+    FileInputStream inputStream(presetFile);
+#endif
+
+    PresetParser preset (inputStream);
 
     oscSender = std::make_unique<OSCSender> ();
     oscSender->connect (preset.getHost (), preset.getPort ());

Source/PluginProcessor.h

@@ -35,8 +35,8 @@ class OSCControlAudioProcessor :
     OSCControlAudioProcessor();
     ~OSCControlAudioProcessor();
 
-    File locatePresetFile(String namePreset);
-    void initializeHeadless(File filePreset);
+    File locatePresetFile(String const & namePreset);
+    void initializeHeadless(String const & namePreset);
 
     void prepareToPlay (double sampleRate, int samplesPerBlock) override;
     void releaseResources() override;

Source/PresetPage.cpp

@@ -45,11 +45,10 @@ PresetPage::
 
 void
 PresetPage::
-loadFromFile
-(File filePreset)
+load
+(InputStream & inputStream)
 {
-    PresetParser preset (filePreset);
-    auto presetPath = filePreset.getFullPathName ();
+    PresetParser preset (inputStream);
 
     host = preset.getHost ();
     port = preset.getPort ();
@@ -77,6 +76,16 @@ loadFromFile
     container->setBounds (areaContainer);
 }
 
+void
+PresetPage::
+loadFromFile
+(File const & file)
+{
+    FileInputStream inputStream(file);
+    load(inputStream);
+}
+
+
 Value &
 PresetPage::
 getHostValue()

Source/PresetPage.h

@@ -33,7 +33,8 @@ class PresetPage :
     PresetPage ();
     ~PresetPage ();
 
-    void loadFromFile (File filePreset);
+    void load (InputStream & inputStream);
+    void loadFromFile (File const & file);
 
     Value & getHostValue ();
     Value & getPortValue ();

Source/PresetParser.cpp

@@ -32,19 +32,18 @@ PresetParser::mapTypeNames =
 
 PresetParser::
 PresetParser
-(File filePreset)
+(InputStream & inputStream)
 {
-    auto pathPreset = filePreset.getFullPathName().toStdString();
     try {
-        config = YAML::LoadFile(pathPreset);
+        config = YAML::Load(inputStream.readString().toStdString());
     }
     catch (YAML::BadFile &e) {
-        std::string message = "Unable to load config: " + pathPreset;
+        std::string message = "Could not parse preset";
         throw std::runtime_error(message);
     }
 
     if(config.IsNull()) {
-        std::string message = "Empty config: " + pathPreset;
+        std::string message = "Could not parse preset";
         throw std::runtime_error(message);
     }
 }

Source/PresetParser.h

@@ -30,7 +30,7 @@ class PresetParser
 {
 public:
 
-    PresetParser(File filePreset);
+    PresetParser(InputStream & inputStream);
 
     String getHost() const;
     int getPort() const;

build_plugins.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 function print_usage {
-    printf "Usage: %s: [-j <jobs>] [-v] [<preset> ...]\n" $0
+    printf "Usage: %s: [-j <jobs>] [-v] [-e] [<preset> ...]\n" $0
     echo ""
     echo "Build the osccontrol plugin."
     echo ""
@@ -13,12 +13,14 @@ function print_usage {
     echo "Options:"
     echo "<preset> ...: list of preset names separated with spaces"
     echo "-j<jobs>: run build in parallel with <jobs> threads"
-    echo "-v: print cmake progress output"
+    echo "-v: verbosely print cmake output"
+    echo "-e: embed presets during build"
 }
 
 JOBS=1
 VERBOSE=0
-while getopts ":hvj:" opt; do
+EMBED=""
+while getopts ":hvej:" opt; do
     case ${opt} in
         \? )
             echo "Invalid option: $OPTARG" 1>&2
@@ -46,20 +48,25 @@ while getopts ":hvj:" opt; do
         v)
             VERBOSE=1
             ;;
+        e)
+            EMBED="-DEMBED_PRESETS=ON"
+            ;;
     esac
 done
 shift $((OPTIND -1))
 
-PRESET_NAMES=""
+PRESETS=""
 for preset in "$@"
 do
-    PRESET_NAMES="$PRESET_NAMES;$preset"
+    PRESETS="$PRESETS;$preset"
 done
 
 echo "creating cmake config in 'build' directory"
 mkdir -p build ; cd build
-echo "cmake -DPRESET_NAMES=$PRESET_NAMES .."
-cmake -DPRESET_NAMES=$PRESET_NAMES ..
+
+COMMAND="cmake -DPRESETS=$PRESETS $EMBED .."
+echo $COMMAND
+$COMMAND
 
 echo "building osccontrol plugins... "
 if [ "$VERBOSE" -ne 0 ] ; then