commit 81e8acb65682d35c1b82cfecadbc85b487f9fbd0
parent cc357a1dd6a3b686fd4eb77a0eb8a9c20e6d2b82
Author: jatinchowdhury18 <[email protected]>
Date: Sun, 13 Sep 2020 15:57:58 -0700
Implement mix groups feature (#87)
* Set up basic mix group controlling with OSC (WIP)
* Completed first pass of mix groups feature
Co-authored-by: jatinchowdhury18 <[email protected]>
Diffstat:
8 files changed, 308 insertions(+), 2 deletions(-)
diff --git a/Plugin/CHOWTapeModel.jucer b/Plugin/CHOWTapeModel.jucer
@@ -31,6 +31,16 @@
<FILE id="oFI05X" name="TooltipComp.cpp" compile="1" resource="0" file="Source/GUI/TooltipComp.cpp"/>
<FILE id="BpGwTA" name="TooltipComp.h" compile="0" resource="0" file="Source/GUI/TooltipComp.h"/>
</GROUP>
+ <GROUP id="{DCA33FEB-7151-818B-57ED-905929FEF150}" name="MixGroups">
+ <FILE id="plu32m" name="MixGroupsController.cpp" compile="1" resource="0"
+ file="Source/MixGroups/MixGroupsController.cpp"/>
+ <FILE id="vwS6BX" name="MixGroupsController.h" compile="0" resource="0"
+ file="Source/MixGroups/MixGroupsController.h"/>
+ <FILE id="yc5D3k" name="MixGroupsParamReceiver.cpp" compile="1" resource="0"
+ file="Source/MixGroups/MixGroupsParamReceiver.cpp"/>
+ <FILE id="hGI0mn" name="MixGroupsParamReceiver.h" compile="0" resource="0"
+ file="Source/MixGroups/MixGroupsParamReceiver.h"/>
+ </GROUP>
<GROUP id="{71C1FCA8-E7B0-3B66-1340-F140C452FF6F}" name="Presets">
<GROUP id="{AB6F221D-98B5-9782-2241-321BA5DFB83C}" name="PresetConfigs">
<FILE id="AymGjK" name="Default.xml" compile="0" resource="1" file="Source/Presets/PresetConfigs/Default.xml"/>
@@ -118,6 +128,7 @@
<MODULEPATH id="juce_dsp" path="Juce/modules"/>
<MODULEPATH id="foleys_gui_magic" path="."/>
<MODULEPATH id="juce_opengl" path="Juce/modules"/>
+ <MODULEPATH id="juce_osc" path="Juce/modules"/>
</MODULEPATHS>
</XCODE_MAC>
<VS2017 targetFolder="Builds/VisualStudio2017">
@@ -142,6 +153,7 @@
<MODULEPATH id="juce_dsp" path="Juce/modules"/>
<MODULEPATH id="foleys_gui_magic" path="."/>
<MODULEPATH id="juce_opengl" path="Juce/modules"/>
+ <MODULEPATH id="juce_osc" path="Juce/modules"/>
</MODULEPATHS>
</VS2017>
<LINUX_MAKE targetFolder="Builds/LinuxMakefile">
@@ -165,6 +177,7 @@
<MODULEPATH id="juce_dsp" path="Juce/modules"/>
<MODULEPATH id="foleys_gui_magic" path="."/>
<MODULEPATH id="juce_opengl" path="Juce/modules"/>
+ <MODULEPATH id="juce_osc" path="Juce/modules"/>
</MODULEPATHS>
</LINUX_MAKE>
</EXPORTFORMATS>
@@ -185,6 +198,7 @@
<MODULE id="juce_gui_basics" showAllCode="1" useLocalCopy="0" useGlobalPath="0"/>
<MODULE id="juce_gui_extra" showAllCode="1" useLocalCopy="0" useGlobalPath="0"/>
<MODULE id="juce_opengl" showAllCode="1" useLocalCopy="0" useGlobalPath="0"/>
+ <MODULE id="juce_osc" showAllCode="1" useLocalCopy="0" useGlobalPath="0"/>
</MODULES>
<LIVE_SETTINGS>
<WINDOWS/>
diff --git a/Plugin/Source/GUI/Assets/gui.xml b/Plugin/Source/GUI/Assets/gui.xml
@@ -141,9 +141,13 @@
name="Hysteresis Mode" caption="Hysteresis Mode" caption-size="0"
combo-text="FFEAA92C" caption-color="FFFFFFFF" max-height="100"
margin="" parameter="mode" combo-background="00000000" tooltip="Selects the mode to use for hysteresis processing. Choose between 2nd/4th order Runge-Kutta method, 4 or 8 Newton-Raphson iterations, or revert to version 1.0."/>
+ <ComboBox lookAndFeel="ComboBoxLNF" padding="0" border="0" background-color="00000000"
+ name="Mix Group" caption="Mix Group" caption-size="0" flex-grow="0.9"
+ combo-text="FFEAA92C" caption-color="FFFFFFFF" max-height="100" margin="0"
+ parameter="mix_group" combo-background="00000000" tooltip="Adds this plugin to a mix group. If you add this plugin to a group, the parameter settings will be copied to all other plugins in the group, and their parameters will remain in sync."/>
<presets margin="5" padding="0" background-color="00000000" border-color="595C6B"
radius="" border="" lookAndFeel="ComboBoxLNF" tooltip="Selects a preset for the plugin."
- flex-grow="1.8" max-height="100"/>
+ flex-grow="1.75" max-height="100"/>
</View>
</View>
</magic>
diff --git a/Plugin/Source/MixGroups/MixGroupsController.cpp b/Plugin/Source/MixGroups/MixGroupsController.cpp
@@ -0,0 +1,171 @@
+#include "MixGroupsController.h"
+
+using namespace MixGroupsConstants;
+
+MixGroupsController::MixGroupsController (AudioProcessorValueTreeState& vts,
+ AudioProcessor* proc) :
+ vts (vts)
+{
+ // connect sender
+ sender.connect ("127.0.0.1", portNum);
+
+ // load parameters
+ auto params = proc->getParameters();
+ loadParameterList (params);
+
+ // set up receiver
+ paramReceiver->loadReceiverListeners (paramList);
+ paramReceiver->addChangeListener (this);
+
+ mixGroupParam = vts.getRawParameterValue (mixGroupParamID);
+}
+
+void MixGroupsController::createParameterLayout (std::vector<std::unique_ptr<RangedAudioParameter>>& params)
+{
+ params.push_back (std::make_unique<AudioParameterChoice> (mixGroupParamID, "Mix Group", StringArray ({"N/A", "1", "2", "3", "4"}), 0));
+}
+
+void MixGroupsController::loadParameterList (Array<AudioProcessorParameter*>& params)
+{
+ // iterate over parameters
+ for (auto* param : params)
+ {
+ auto paramWithID = dynamic_cast<AudioProcessorParameterWithID*> (param);
+
+ if (paramWithID == nullptr)
+ continue;
+
+ auto paramID = paramWithID->paramID;
+ vts.addParameterListener (paramID, this);
+
+ if (paramID != mixGroupParamID)
+ paramList.addIfNotAlreadyThere (paramID);
+ }
+}
+
+void MixGroupsController::parameterChanged (const String& parameterID, float newValue)
+{
+ int mixGroup = (int) mixGroupParam->load();
+ if (mixGroup == 0) // no mix group, don't bother sending
+ return;
+
+ if (parameterID == mixGroupParamID) // mix group was changed
+ {
+ OSCMessage message (allParamsAddress);
+ message.addArgument (uuid.toString());
+ message.addArgument (mixGroup);
+
+ for (const auto& paramID : paramList)
+ {
+ auto param = vts.getParameter (paramID);
+ auto value = param->convertFrom0to1 (param->getValue());
+
+ message.addArgument (paramID);
+ message.addArgument (value);
+ }
+
+ sender.send (message);
+
+ return;
+ }
+
+ if (! paramList.contains (parameterID)) // parameter is not in list
+ return;
+
+ sendParameter (parameterID, mixGroup, newValue);
+}
+
+void MixGroupsController::sendParameter (const String& paramID, int mixGroup, float value)
+{
+ String address = oscAddressPrefix + paramID;
+ String pluginID = uuid.toString();
+
+ sender.send (address, pluginID, mixGroup, value);
+}
+
+void MixGroupsController::changeListenerCallback (ChangeBroadcaster* source)
+{
+ if (source != paramReceiver)
+ return;
+
+ // get message from receiver, we already know this will be a valid message!
+ auto& message = paramReceiver->getOSCMessage();
+
+ // get address
+ auto address = message.getAddressPattern().toString();
+
+ // special case: all parameters
+ if (address == allParamsAddress)
+ {
+ parseAllParams (message);
+ return;
+ }
+
+ // get paramID from address
+ auto paramID = address.fromFirstOccurrenceOf (oscAddressPrefix, false, false);
+ auto param = vts.getParameter (paramID);
+
+ if (param == nullptr) // invalid parameter
+ return;
+
+ String pluginID = message[0].getString();
+ if (uuid == pluginID) // this message came from me!
+ return;
+
+ int mixGroup = message[1].getInt32();
+ if (mixGroup != (int) mixGroupParam->load()) // received message does not apply to this mix group
+ return;
+
+ auto value = message[2].getFloat32();
+ param->setValueNotifyingHost (param->convertTo0to1 (value));
+}
+
+void MixGroupsController::parseAllParams (const OSCMessage& message)
+{
+ if (message.size() % 2 != 0) // must have even number of arguments!
+ return;
+
+ String pluginID = message[0].getString();
+ if (uuid == pluginID) // this message came from me!
+ return;
+
+ int mixGroup = message[1].getInt32();
+ if (mixGroup != (int) mixGroupParam->load()) // received message does not apply to this mix group
+ return;
+
+ for (int argIdx = 2; argIdx < message.size(); argIdx += 2)
+ {
+ auto temp1 = message[argIdx];
+ auto temp2 = message[argIdx+1];
+ if (! (message[argIdx].isString() && message[argIdx + 1].isFloat32())) // incorrect format...
+ continue;
+
+ String paramID = message[argIdx].getString();
+ auto param = vts.getParameter (paramID);
+
+ if (param == nullptr) // invalid parameter
+ continue;
+
+ auto value = message[argIdx + 1].getFloat32();
+ param->setValueNotifyingHost (param->convertTo0to1 (value));
+ }
+}
+
+bool MixGroupsController::isValidOSCMessage (const OSCMessage& message)
+{
+ // special case: all parameters
+ if (message.getAddressPattern() == allParamsAddress && message.size() > 2)
+ return true;
+
+ // other valid messages will be of the form: string, int, float
+ if (message.size() != 3)
+ return false;
+
+ bool isValid = true;
+
+ isValid &= message[0].isString();
+ isValid &= message[1].isInt32();
+ isValid &= message[2].isFloat32();
+
+ return isValid;
+}
diff --git a/Plugin/Source/MixGroups/MixGroupsController.h b/Plugin/Source/MixGroups/MixGroupsController.h
@@ -0,0 +1,45 @@
+#ifndef MIXGROUPSCONTROLLER_H_INCLUDED
+#define MIXGROUPSCONTROLLER_H_INCLUDED
+
+#include "MixGroupsParamReceiver.h"
+
+namespace MixGroupsConstants
+{
+ constexpr int portNum = 1818;
+ const String oscAddressPrefix = "/chowdsp/tape/";
+ const String allParamsAddress = oscAddressPrefix + "all";
+ const String mixGroupParamID = "mix_group";
+}
+
+/** Class to control syncing parameters between multiple mix groups */
+class MixGroupsController : private AudioProcessorValueTreeState::Listener,
+ private ChangeListener
+{
+public:
+ MixGroupsController (AudioProcessorValueTreeState& vts, AudioProcessor* proc);
+
+ static void createParameterLayout (std::vector<std::unique_ptr<RangedAudioParameter>>& params);
+
+ void parameterChanged (const String& parameterID, float newValue) override;
+ void changeListenerCallback (ChangeBroadcaster* source) override;
+ void sendParameter (const String& paramID, int mixGroup, float value);
+
+ void parseAllParams (const OSCMessage& message);
+
+ static bool isValidOSCMessage (const OSCMessage& message);
+
+private:
+ void loadParameterList (Array<AudioProcessorParameter*>& params);
+
+ AudioProcessorValueTreeState& vts;
+ std::atomic<float>* mixGroupParam = nullptr;
+ Array<String> paramList;
+ OSCSender sender;
+ Uuid uuid;
+
+ SharedResourcePointer<MixGroupsParamReceiver> paramReceiver;
+
+ JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (MixGroupsController)
+};
+
+#endif // MIXGROUPSCONTROLLER_H_INCLUDED
diff --git a/Plugin/Source/MixGroups/MixGroupsParamReceiver.cpp b/Plugin/Source/MixGroups/MixGroupsParamReceiver.cpp
@@ -0,0 +1,38 @@
+#include "MixGroupsParamReceiver.h"
+#include "MixGroupsController.h"
+
+MixGroupsParamReceiver::MixGroupsParamReceiver()
+{
+ // connect datagram socket
+ socket.bindToPort (MixGroupsConstants::portNum);
+ socket.setEnablePortReuse (true);
+ connectToSocket (socket);
+}
+
+void MixGroupsParamReceiver::loadReceiverListeners (Array<String>& paramList)
+{
+ if (listenersInitialized) // listeners are already set up!
+ return;
+
+ for (auto& paramID : paramList)
+ addListener (this, MixGroupsConstants::oscAddressPrefix + paramID);
+
+ addListener (this, MixGroupsConstants::oscAddressPrefix + "all");
+
+ listenersInitialized = true;
+}
+
+void MixGroupsParamReceiver::oscMessageReceived (const OSCMessage& message)
+{
+ // clear existing OSC message
+ oscMessage.clear();
+
+ if (message.isEmpty()) // no message!
+ return;
+
+ if (! MixGroupsController::isValidOSCMessage (message))
+ return;
+
+ oscMessage = message;
+ sendChangeMessage();
+}
diff --git a/Plugin/Source/MixGroups/MixGroupsParamReceiver.h b/Plugin/Source/MixGroups/MixGroupsParamReceiver.h
@@ -0,0 +1,29 @@
+#ifndef MIXGROUPSPARAMRECEIVER
+#define MIXGROUPSPARAMRECEIVER
+
+#include <JuceHeader.h>
+
+/**
+ * Class to receive parameter info from other instances of the plugin.
+ * Create instances of this class with a SharedResourcePointer, otherwise
+ * the messages won't sync correctly between instances of the plugin.
+ */
+class MixGroupsParamReceiver : public ChangeBroadcaster,
+ private OSCReceiver,
+ private OSCReceiver::ListenerWithOSCAddress<OSCReceiver::MessageLoopCallback>
+{
+public:
+ MixGroupsParamReceiver();
+
+ void oscMessageReceived (const OSCMessage& message) override;
+ void loadReceiverListeners (Array<String>& paramList);
+ const OSCMessage& getOSCMessage() { return oscMessage; }
+
+private:
+ DatagramSocket socket;
+ OSCMessage oscMessage { "/noaddress" };
+ bool listenersInitialized = false;
+};
+
+#endif // MIXGROUPSPARAMRECEIVER
+
diff --git a/Plugin/Source/PluginProcessor.cpp b/Plugin/Source/PluginProcessor.cpp
@@ -30,7 +30,8 @@ ChowtapeModelAudioProcessor::ChowtapeModelAudioProcessor()
hysteresis (vts),
degrade (vts),
chewer (vts),
- flutter (vts)
+ flutter (vts),
+ mixGroupsController (vts, this)
{
for (int ch = 0; ch < 2; ++ch)
lossFilter[ch].reset (new LossFilter (vts));
@@ -61,6 +62,7 @@ AudioProcessorValueTreeState::ParameterLayout ChowtapeModelAudioProcessor::creat
Flutter::createParameterLayout (params);
DegradeProcessor::createParameterLayout (params);
ChewProcessor::createParameterLayout (params);
+ MixGroupsController::createParameterLayout (params);
return { params.begin(), params.end() };
}
diff --git a/Plugin/Source/PluginProcessor.h b/Plugin/Source/PluginProcessor.h
@@ -22,6 +22,7 @@
#include "Presets/PresetManager.h"
#include "GUI/MyLNF.h"
#include "GUI/AutoUpdating.h"
+#include "MixGroups/MixGroupsController.h"
//==============================================================================
/**
@@ -97,6 +98,8 @@ private:
AutoUpdater updater;
bool needsUpdate = false;
+ MixGroupsController mixGroupsController;
+
//==============================================================================
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ChowtapeModelAudioProcessor)
};
