Modulator name api refactor (#7265)

Move the modulator name functions and mpe status to better parts of the code base (free functions and storage, respectively)
---------

Co-authored-by: Phil Stone <[email protected]>
Co-authored-by: Paul Walker <[email protected]>

src/common/CMakeLists.txt

@@ -105,6 +105,7 @@ add_library(${PROJECT_NAME}
   FxPresetAndClipboardManager.h
   LuaSupport.cpp
   LuaSupport.h
+  ModulationSource.cpp
   ModulationSource.h
   ModulatorPresetManager.cpp
   ModulatorPresetManager.h

src/common/ModulationSource.cpp

@@ -0,0 +1,262 @@
+/*
+ * Surge XT - a free and open source hybrid synthesizer,
+ * built by Surge Synth Team
+ *
+ * Learn more at https://surge-synthesizer.github.io/
+ *
+ * Copyright 2018-2023, various authors, as described in the GitHub
+ * transaction log.
+ *
+ * Surge XT is released under the GNU General Public Licence v3
+ * or later (GPL-3.0-or-later). The license is found in the "LICENSE"
+ * file in the root of this repository, or at
+ * https://www.gnu.org/licenses/gpl-3.0.en.html
+ *
+ * Surge was a commercial product from 2004-2018, copyright and ownership
+ * held by Claes Johanson at Vember Audio during that period.
+ * Claes made Surge open source in September 2018.
+ *
+ * All source for Surge XT is available at
+ * https://github.com/surge-synthesizer/surge
+ */
+
+#include "ModulationSource.h"
+#include "SurgeStorage.h"
+
+class SurgeStorage;
+
+namespace ModulatorName
+{
+
+std::string modulatorName(const SurgeStorage *s, int i, bool button, int current_scene,
+                          int forScene)
+{
+    if ((i >= ms_lfo1 && i <= ms_slfo6))
+    {
+        int idx = i - ms_lfo1;
+        bool isS = idx >= 6;
+        int fnum = idx % 6;
+        auto useScene = forScene >= 0 ? forScene : current_scene;
+        auto *lfodata = &(s->getPatch().scene[useScene].lfo[i - ms_lfo1]);
+
+        std::string sceneL = "Scene", shortsceneL = "S-";
+
+        if (forScene >= 0)
+        {
+            sceneL = fmt::format("Scene {:c}", 'A' + forScene);
+            shortsceneL = fmt::format("{:c} S-", 'A' + forScene);
+        }
+
+        std::string txt;
+
+        if (lfodata->shape.val.i == lt_envelope)
+        {
+            if (button)
+                txt = fmt::format("{:s}ENV {:d}", (isS ? shortsceneL : ""), fnum + 1);
+            else
+                txt = fmt::format("{:s} Envelope {:d}", (isS ? sceneL : "Voice"), fnum + 1);
+        }
+        else if (lfodata->shape.val.i == lt_stepseq)
+        {
+            if (button)
+                txt = fmt::format("{:s}SEQ {:d}", (isS ? shortsceneL : ""), fnum + 1);
+            else
+                txt = fmt::format("{:s} Step Sequencer {:d}", (isS ? sceneL : "Voice"), fnum + 1);
+        }
+        else if (lfodata->shape.val.i == lt_mseg)
+        {
+            if (button)
+                txt = fmt::format("{:s}MSEG {:d}", (isS ? shortsceneL : ""), fnum + 1);
+            else
+                txt = fmt::format("{:s} MSEG {:d}", (isS ? sceneL : "Voice"), fnum + 1);
+        }
+        else if (lfodata->shape.val.i == lt_formula)
+        {
+            if (button)
+                txt = fmt::format("{:s}FORM {:d}", (isS ? shortsceneL : ""), fnum + 1);
+            else
+                txt = fmt::format("{:s} Formula {:d}", (isS ? sceneL : "Voice"), fnum + 1);
+        }
+        else
+        {
+            if (button)
+                txt = fmt::format("{:s}LFO {:d}", (isS ? shortsceneL : ""), fnum + 1);
+            else
+                txt = fmt::format("{:s} LFO {:d}", (isS ? sceneL : "Voice"), fnum + 1);
+        }
+
+        return txt;
+    }
+
+    if (i >= ms_ctrl1 && i <= ms_ctrl8)
+    {
+        if (button)
+        {
+            std::string ccl = std::string(s->getPatch().CustomControllerLabel[i - ms_ctrl1]);
+
+            if (ccl == "-")
+            {
+                return std::string(modsource_names[i]);
+            }
+            else
+            {
+                return ccl;
+            }
+        }
+        else
+        {
+            std::string ccl = std::string(s->getPatch().CustomControllerLabel[i - ms_ctrl1]);
+
+            if (ccl == "-")
+            {
+                return std::string(modsource_names[i]);
+            }
+            else
+            {
+                return ccl + " (" + modsource_names[i] + ")";
+            }
+        }
+    }
+
+    if (i == ms_aftertouch && s->mpeEnabled)
+    {
+        return "MPE Pressure";
+    }
+
+    if (i == ms_timbre && s->mpeEnabled)
+    {
+        return "MPE Timbre";
+    }
+
+    if (button)
+    {
+        return std::string(modsource_names_button[i]);
+    }
+    else
+    {
+        return std::string(modsource_names[i]);
+    }
+}
+
+std::string modulatorIndexExtension(const SurgeStorage *s, int scene, int ms, int index,
+                                    bool shortV)
+{
+    if (ModulatorName::supportsIndexedModulator(scene, (modsources)ms))
+    {
+        if (ms == ms_random_bipolar)
+        {
+            if (index == 0)
+                return shortV ? "" : " (Uniform)";
+            if (index == 1)
+                return shortV ? " N" : " (Normal)";
+        }
+        if (ms == ms_random_unipolar)
+        {
+            if (index == 0)
+                return shortV ? "" : " (Uniform)";
+            if (index == 1)
+                return shortV ? " HN" : " (Half Normal)";
+        }
+        if (ms == ms_lowest_key || ms == ms_latest_key || ms == ms_highest_key)
+        {
+            return (index == 0 ? " Key" : " Voice");
+        }
+
+        if (ms >= ms_lfo1 && ms <= ms_slfo6)
+        {
+            auto lf = &(s->getPatch().scene[scene].lfo[ms - ms_lfo1]);
+            if (lf->shape.val.i != lt_formula)
+            {
+                if (index == 0)
+                    return "";
+                if (index == 1)
+                {
+                    if (shortV)
+                        return " Raw";
+                    return " (" + Surge::GUI::toOSCase("Raw Waveform") + ")";
+                }
+                if (index == 2)
+                {
+                    if (shortV)
+                        return " EG";
+                    return Surge::GUI::toOSCase(" (EG Only)");
+                }
+            }
+        }
+
+        if (shortV)
+            return "." + std::to_string(index + 1);
+        else
+            return std::string(" Out ") + std::to_string(index + 1);
+    }
+    return "";
+}
+
+std::string modulatorNameWithIndex(const SurgeStorage *s, int scene, int ms, int index,
+                                   bool forButton, bool useScene, bool baseNameOnly)
+{
+    int lfo_id = ms - ms_lfo1;
+    bool hasOverride = isLFO((modsources)ms) && index >= 0 &&
+                       s->getPatch().LFOBankLabel[scene][lfo_id][index][0] != 0;
+
+    if (baseNameOnly)
+    {
+        auto base = modulatorName(s, ms, scene, true, useScene ? scene : -1);
+
+        if (ModulatorName::supportsIndexedModulator(scene, (modsources)ms))
+        {
+            base += ModulatorName::modulatorIndexExtension(s, scene, ms, index, true);
+        }
+
+        return base;
+    }
+
+    if (!hasOverride)
+    {
+        auto base = modulatorName(s, ms, forButton, useScene ? scene : -1);
+
+        if (index >= 0 && ModulatorName::supportsIndexedModulator(scene, (modsources)ms))
+        {
+            base += ModulatorName::modulatorIndexExtension(s, scene, ms, index, forButton);
+        }
+
+        return base;
+    }
+    else
+    {
+        if (forButton)
+        {
+            return s->getPatch().LFOBankLabel[scene][ms - ms_lfo1][index];
+        }
+
+        // Long name is alias (button name)
+        auto base = modulatorName(s, ms, true, useScene ? scene : -1, scene);
+
+        if (ModulatorName::supportsIndexedModulator(scene, (modsources)ms))
+        {
+            base += ModulatorName::modulatorIndexExtension(s, scene, ms, index, true);
+        }
+
+        std::string res = s->getPatch().LFOBankLabel[scene][ms - ms_lfo1][index];
+        res = res + " (" + base + ")";
+        return res;
+    }
+}
+
+// This is a copy of a trivial function from SurgeSynthesizer
+bool supportsIndexedModulator(int scene, modsources modsource)
+{
+    if (modsource >= ms_lfo1 && modsource <= ms_slfo6)
+    {
+        return true;
+        // auto lf = &(storage.getPatch().scene[scene].lfo[modsource - ms_lfo1]);
+        // return lf->shape.val.i == lt_formula;
+    }
+
+    if (modsource == ms_random_bipolar || modsource == ms_random_unipolar)
+    {
+        return true;
+    }
+    return false;
+}
+} // namespace ModulatorName

src/common/ModulationSource.h

@@ -236,6 +236,20 @@ inline bool canModulateVoiceModulators(modsources ms)
     return (ms <= ms_ctrl8) || ms == ms_timbre;
 }
 
+class SurgeStorage;
+
+namespace ModulatorName
+{
+std::string modulatorName(const SurgeStorage *s, int ms, bool forButton, int current_scene,
+                          int forScene = -1);
+std::string modulatorIndexExtension(const SurgeStorage *s, int scene, int ms, int index,
+                                    bool shortV = false);
+std::string modulatorNameWithIndex(const SurgeStorage *s, int scene, int ms, int index,
+                                   bool forButton, bool useScene, bool baseNameOnly = false);
+bool supportsIndexedModulator(int scene, modsources modsource);
+
+} // namespace ModulatorName
+
 struct ModulationRouting
 {
     int source_id;

src/common/SurgeStorage.h

@@ -1451,6 +1451,8 @@ class alignas(16) SurgeStorage
 
     std::atomic<bool> mapChannelToOctave; // When other midi modes come along, clean this up.
 
+    bool mpeEnabled{false};
+
     static constexpr double MIDI_0_FREQ = Tunings::MIDI_0_FREQ;
     // this value needs to be passed along to FilterCoefficientMaker
 

src/common/SurgeSynthesizer.cpp

@@ -55,7 +55,7 @@ using CMSKey = ControllerModulationSourceVector<1>; // sigh see #4286 for failed
 SurgeSynthesizer::SurgeSynthesizer(PluginLayer *parent, const std::string &suppliedDataPath)
     : storage(suppliedDataPath), hpA{cutl::make_array<BiquadFilter, n_hpBQ>(&storage)},
       hpB{cutl::make_array<BiquadFilter, n_hpBQ>(&storage)}, _parent(parent), halfbandA(6, true),
-      halfbandB(6, true), halfbandIN(6, true)
+      halfbandB(6, true), halfbandIN(6, true), mpeEnabled(storage.mpeEnabled)
 {
     switch_toggled_queued = false;
     audio_processing_active = false;

src/common/SurgeSynthesizer.h

@@ -467,7 +467,7 @@ class alignas(16) SurgeSynthesizer
     std::unique_ptr<Effect> fx[n_fx_slots];
     std::atomic<bool> halt_engine;
     MidiChannelState channelState[16];
-    bool mpeEnabled = false;
+    bool &mpeEnabled;
     int mpeVoices = 0;
     int mpeGlobalPitchBendRange = 0;
 

src/surge-python/surgepy.cpp

@@ -893,6 +893,10 @@ class SurgeSynthesizerWithPythonExtensions : public SurgeSynthesizer
     {
         return storage.tuningApplicationMode;
     }
+
+    void setMPEEnabled(bool m) { storage.mpeEnabled = m; }
+
+    bool getMPEEnabled() const { return storage.mpeEnabled; }
 };
 
 SurgeSynthesizer *createSurge(float sr)
@@ -1042,7 +1046,8 @@ PYBIND11_MODULE(surgepy, m)
         .def("remapToStandardKeyboard",
              &SurgeSynthesizerWithPythonExtensions::remapToStandardKeyboard,
              "Return to standard C-centered keyboard mapping")
-        .def_readwrite("mpeEnabled", &SurgeSynthesizerWithPythonExtensions::mpeEnabled)
+        .def_property("mpeEnabled", &SurgeSynthesizerWithPythonExtensions::getMPEEnabled,
+                      &SurgeSynthesizerWithPythonExtensions::setMPEEnabled)
         .def_property("tuningApplicationMode",
                       &SurgeSynthesizerWithPythonExtensions::getTuningApplicationMode,
                       &SurgeSynthesizerWithPythonExtensions::setTuningApplicationMode);