Formula: Add host transport to state table (#8488)

* Formula: Add host transport to state table

Author: nuoun

scripts/misc/Formula-state-variable-test.lua

@@ -17,6 +17,7 @@ function init(state)
     print("highest_key", state.highest_key)
     print("hold", state.hold)
     print("intphase", state.intphase)
+    print("is_playing", state.is_playing)
     print("is_rendering_to_ui", state.is_rendering_to_ui)
     print("is_voice", state.is_voice)
     print("key", state.key)
@@ -79,6 +80,7 @@ function process(state)
         print("highest_key", state.highest_key)
         print("hold", state.hold)
         print("intphase", state.intphase)
+        print("is_playing", state.is_playing)
         print("is_rendering_to_ui", state.is_rendering_to_ui)
         print("is_voice", state.is_voice)
         print("key", state.key)

src/common/SurgeStorage.h

@@ -1620,6 +1620,7 @@ class alignas(16) SurgeStorage
     float temposyncratio, temposyncratio_inv; // 1.f is 120 BPM
     float unstreamedTempo{120.f};             // this one is in actual BPM
     double songpos;
+    bool isPlaying{false}; // host transport state
     void init_tables();
     float nyquist_pitch;
     int last_key[2]; // TODO: FIX SCENE ASSUMPTION

src/common/SurgeSynthesizer.cpp

@@ -4324,6 +4324,7 @@ void SurgeSynthesizer::resetStateFromTimeData()
     if (time_data.timeSigDenominator < 1)
         time_data.timeSigDenominator = 4;
     storage.songpos = time_data.ppqPos;
+    storage.isPlaying = time_data.isPlaying;
     if (time_data.tempo > 0)
     {
         storage.temposyncratio = time_data.tempo / 120.f;

src/common/SurgeSynthesizer.h

@@ -42,6 +42,7 @@ struct timedata
 {
     double ppqPos, tempo;
     int timeSigNumerator = 4, timeSigDenominator = 4;
+    bool isPlaying = false;
 };
 
 struct parametermeta

src/common/dsp/modulators/FormulaModulationHelper.cpp

@@ -276,6 +276,7 @@ end
 
             addn("tempo", s.tempo);
             addn("songpos", s.songpos);
+            addb("is_playing", s.isPlaying);
             addn("pb_range_up", s.pbrange_up);
             addn("pb_range_dn", s.pbrange_dn);
             addn("mpe_bendrange", s.mpebendrange);
@@ -650,6 +651,7 @@ void valueAt(int phaseIntPart, float phaseFracPart, SurgeStorage *storage,
     addn("phase", phaseFracPart);
     addn("tempo", s->tempo);
     addn("songpos", s->songpos);
+    addb("is_playing", s->isPlaying);
 
     addn("pb", s->pitchbend);
     addn("pb_range_up", s->pbrange_up);
@@ -876,27 +878,27 @@ enum showFilter
 bool isUserDefined(std::string str)
 {
     // clang-format off
-    static constexpr std::array<std::string_view, 59> keywords = {
-        "amplitude",     "attack",        "block_size",
-        "cc_breath",     "cc_expr",       "cc_mw",
-        "cc_sus",        "chan_at",       "channel",
-        "clamp_output",  "cycle",         "decay",
-        "deform",        "delay",         "highest_key",
-        "hold",          "intphase",      "is_rendering_to_ui",
-        "is_voice",      "key",           "labels",
-        "latest_key",    "lfo_id",        "lowest_key",
-        "macros",        "mpe_bend",      "mpe_bendrange",
-        "mpe_enabled",   "mpe_pressure",  "mpe_timbre",
-        "output",        "pb",            "pb_range_dn",
-        "pb_range_up",   "phase",         "play_mode",
-        "poly_at",       "poly_limit",    "rate",
-        "rel_velocity",  "release",       "released",
-        "retrigger_AEG", "retrigger_FEG", "samplerate",
-        "scene_mode",    "songpos",       "split_point",
-        "startphase",    "sustain",       "tempo",
-        "tuned_key",     "use_amplitude", "use_envelope",
-        "use_rate",      "velocity",      "voice_count",
-        "voice_id",      "subscriptions"};
+    static constexpr std::array<std::string_view, 60> keywords = {
+        "amplitude",          "attack",        "block_size",
+        "cc_breath",          "cc_expr",       "cc_mw",
+        "cc_sus",             "chan_at",       "channel",
+        "clamp_output",       "cycle",         "decay",
+        "deform",             "delay",         "highest_key",
+        "hold",               "intphase",      "is_playing",
+        "is_rendering_to_ui", "is_voice",      "key",
+        "labels",             "latest_key",    "lfo_id",
+        "lowest_key",         "macros",        "mpe_bend",
+        "mpe_bendrange",      "mpe_enabled",   "mpe_pressure",
+        "mpe_timbre",         "output",        "pb",
+        "pb_range_dn",        "pb_range_up",   "phase",
+        "play_mode",          "poly_at",       "poly_limit",
+        "rate",               "rel_velocity",  "release",
+        "released",           "retrigger_AEG", "retrigger_FEG",
+        "samplerate",         "scene_mode",    "songpos",
+        "split_point",        "startphase",    "sustain",
+        "tempo",              "tuned_key",     "use_amplitude",
+        "use_envelope",       "use_rate",      "velocity",
+        "voice_count",        "voice_id",      "subscriptions"};
     // clang-format on
 
     auto foundInList = std::find(keywords.begin(), keywords.end(), str) != keywords.end();

src/common/dsp/modulators/FormulaModulationHelper.h

@@ -71,6 +71,7 @@ struct EvaluatorState
     float rate, amp, phase, deform;
     float tempo;
     double songpos;
+    bool isPlaying{false};
 
     bool retrigger_AEG{false}, retrigger_FEG{false};
 

src/common/dsp/modulators/LFOModulationSource.cpp

@@ -483,6 +483,7 @@ void LFOModulationSource::attackFrom(float start)
         formulastate.deform = localcopy[ideform].f;
         formulastate.tempo = storage->temposyncratio * 120.0;
         formulastate.songpos = storage->songpos;
+        formulastate.isPlaying = storage->isPlaying;
 
         formulastate.isVoice = isVoice;
 
@@ -1211,6 +1212,7 @@ void LFOModulationSource::process_block()
         formulastate.deform = localcopy[ideform].f;
         formulastate.tempo = storage->temposyncratio * 120.0;
         formulastate.songpos = storage->songpos;
+        formulastate.isPlaying = storage->isPlaying;
 
         formulastate.isVoice = isVoice;
 

src/surge-xt/SurgeSynthProcessor.cpp

@@ -791,6 +791,7 @@ void SurgeSynthProcessor::processBlockPlayhead()
         juce::AudioPlayHead::CurrentPositionInfo cp;
         playhead->getCurrentPosition(cp);
         surge->time_data.tempo = cp.bpm;
+        surge->time_data.isPlaying = cp.isPlaying;
 
         // isRecording should always imply isPlaying but better safe than sorry
         if (cp.isPlaying || cp.isRecording)
@@ -819,6 +820,10 @@ void SurgeSynthProcessor::processBlockPlayhead()
         surge->time_data.tempo = standaloneTempo;
         surge->time_data.timeSigNumerator = 4;
         surge->time_data.timeSigDenominator = 4;
+
+        // Formula modulator only, in standalone the transport is always set running.
+        surge->time_data.isPlaying = (wrapperType == wrapperType_Standalone);
+
         surge->resetStateFromTimeData();
     }
 }

src/surge-xt/gui/overlays/LuaEditors.cpp

@@ -2300,6 +2300,7 @@ struct ExpandingFormulaDebugger : public juce::Component,
             formulastate.deform = localcopy[lfodata->deform.param_id_in_scene].f;
             formulastate.tempo = storage->temposyncratio * 120.0;
             formulastate.songpos = storage->songpos;
+            formulastate.isPlaying = storage->isPlaying;
 
             Surge::Formula::setupEvaluatorStateFrom(lfoDebugger->formulastate,
                                                     editor->storage->getPatch(), editor->scene);