#34 Aggregared keys state to track coupled divisions.

Author: Archie3d

Source/aeolus/division.cpp

@@ -181,14 +181,19 @@ void Division::setPersistentState(const juce::var& v)
     }
 }
 
-void Division::populateLinkedDivisions()
+void Division::clearLinkedDivisions()
 {
     _linkedDivisions.clear();
+    _linkedFromDivisions.clear();
+}
 
+void Division::populateLinkedDivisions()
+{
     for (const auto& name : _linkedDivisionNames) {
         if (auto* division = _engine.getDivisionByName(name)) {
-            Link link{division, false};
+            Link link{ division, false };
             _linkedDivisions.push_back(link);
+            division->_linkedFromDivisions.push_back(this);
         }
     }
 }
@@ -358,7 +363,10 @@ void Division::noteOn(int note, int midiChannel)
     for (int stopIndex = 0; stopIndex < (int)_stops.size(); ++stopIndex)
         triggerVoicesForStop(stopIndex, note);
 
-    _keysState.set(note);
+    if (midiChannel != 0) {
+        // Update keys state only when triggered by the assigned MIDI channel
+        _keysState.set(note);
+    }
 
     // Forward to the linked divisions
     for (auto& link : _linkedDivisions) {
@@ -387,7 +395,10 @@ void Division::noteOff(int note, int midiChannel)
         voice = voice->next();
     }
 
-    _keysState.reset(note);
+    if (midiChannel != 0) {
+        // Update keys state only when triggered by the assigned MIDI channel.
+        _keysState.reset(note);
+    }
 
     // Forward to the linked divisions
     for (auto& link : _linkedDivisions) {
@@ -438,6 +449,7 @@ bool Division::process(AudioBuffer<float>& targetBuffer, AudioBuffer<float>& voi
     jassert(targetBuffer.getNumSamples() == SUB_FRAME_LENGTH);
     jassert(voiceBuffer.getNumSamples() == SUB_FRAME_LENGTH);
 
+    updateAggregatedKeysState();
     releaseVoicesOfDisabledStops();
     triggerVoicesOfEnabledStops();
 
@@ -554,28 +566,38 @@ void Division::releaseVoicesOfDisabledStops()
     auto* voice = _activeVoices.first();
 
     while (voice != nullptr) {
+        bool shouldRelease{ false };
+
         if (voice->isActive()) {
             const int stopIndex = voice->stopIndex();
 
             if (isPositiveAndBelow(stopIndex, _stops.size())) {
                 const auto& stop = _stops[stopIndex];
 
                 if (!stop.isEnabled())
-                    voice->release();
+                    shouldRelease = true;
+
+                if (voice->getNote() >= 0 && !_aggregatedKeysState[voice->getNote()])
+                    shouldRelease = true;
             }
         }
 
+        if (shouldRelease)
+            voice->release();
+
         voice = voice->next();
     }
 }
 
 void Division::triggerVoicesOfEnabledStops()
 {
-    if (_keysState.none()) {
+    if (_aggregatedKeysState.none()) {
         // No keys are pressed
         return;
     }
 
+    std::bitset<TOTAL_NOTES> missingNotes{ _aggregatedKeysState };
+
     for (int stopIndex = 0; stopIndex < _stops.size(); ++stopIndex) {
         auto& stop = _stops[stopIndex];
 
@@ -587,8 +609,11 @@ void Division::triggerVoicesOfEnabledStops()
         auto* voice = _activeVoices.first();
 
         while (voice != nullptr) {
-            if (voice->stopIndex() == stopIndex) {
+            const int voiceNote{ voice->getNote() };
+
+            if (voice->stopIndex() == stopIndex && voiceNote >= 0 && _aggregatedKeysState[voiceNote]) {
                 hasVoices = true;
+                missingNotes[voiceNote] = 0;
                 break;
             }
 
@@ -597,14 +622,28 @@ void Division::triggerVoicesOfEnabledStops()
 
         // Trigger voices for enabled stops
         if (!hasVoices) {
-            for (int note = 0; note < _keysState.size(); ++note) {
-                if (_keysState[note])
+            for (int note = 0; note < missingNotes.size(); ++note) {
+                if (missingNotes[note])
                     triggerVoicesForStop(stopIndex, note);
             }
         }
     }
 }
 
+void Division::updateAggregatedKeysState()
+{
+    _aggregatedKeysState = _keysState;
+
+    for (const auto* division : _linkedFromDivisions) {
+        for (const auto& link : division->_linkedDivisions) {
+            if (link.division == this && link.enabled) {
+                _aggregatedKeysState |= division->_aggregatedKeysState;
+                break;
+            }
+        }
+    }
+}
+
 bool Division::triggerVoicesForStop(int stopIndex, int note)
 {
     jassert(isPositiveAndBelow(stopIndex, _stops.size()));

Source/aeolus/division.h

@@ -85,6 +85,11 @@ class Division
     juce::String getName() const { return _name; }
     juce::String getMnemonic() const { return _mnemonic; }
 
+    /**
+     * Remove all the links between the divisions.
+     */
+    void clearLinkedDivisions();
+
     /**
      * Populate linked divisions from the division names.
      * This method must be called by the engine when all the divisions
@@ -164,6 +169,12 @@ class Division
 
 private:
 
+    /**
+     * This will construct the keys aggregated state from the division's keys state
+     * and all the coupled from divisions.
+     */
+    void updateAggregatedKeysState();
+
     bool triggerVoicesForStop(int stopIndex, int note);
 
     bool isAlreadyVoiced(int stopIndex, int node);
@@ -176,6 +187,7 @@ class Division
     /// List of linked divisions names.
     juce::StringArray _linkedDivisionNames;
     std::vector<Link> _linkedDivisions;
+    std::vector<Division*> _linkedFromDivisions;
 
     bool _hasSwell;         ///< Whetehr this division has a swell control.
     bool _hasTremulant;     ///< Whether this division has a remulant control.
@@ -205,6 +217,7 @@ class Division
     List<Voice> _activeVoices;  ///< Active voices on this division.
 
     std::bitset<TOTAL_NOTES> _keysState; ///< MIDI keys state 1 = on, 0 = off.
+    std::bitset<TOTAL_NOTES> _aggregatedKeysState;   ///< MIDI keys state aggregated from the coupled divisions.
 
     /// Tells whether this division has been triggered.
     /// This is used to avoid a division to be triggered multiple

Source/aeolus/engine.cpp

@@ -732,18 +732,26 @@ void Engine::populateDivisions()
         loadDivisionsFromConfig(stream);
     }
 
+    // Remove all the links if any.
+    for (auto* division : _divisions) {
+        division->clearLinkedDivisions();
+    }
+
+
     // Update division links after they've been loaded.
     for (auto* division : _divisions) {
         division->populateLinkedDivisions();
     }
+
+    // @todo Do we want the divisions to be reordered by the couplings?
 }
 
 // @internal Helper to populate key switches from a single number or a list
 static void populateKeySwitchesVector(std::vector<int>& switches, const var& v)
 {
     if (v.isVoid())
         return;
-    
+
     switches.clear();
 
     if (v.isInt()) {

Source/aeolus/voice.cpp

@@ -155,6 +155,14 @@ bool Voice::isForNote(int note) const noexcept
     return false;
 }
 
+int Voice::getNote() const
+{
+    if (_state.pipewave != nullptr)
+        return _state.pipewave->getNote();
+
+    return -1;
+}
+
 void Voice::resetAndReturnToPool()
 {
     _engine.getVoicePool().resetAndReturnToPool(this);

Source/aeolus/voice.h

@@ -50,6 +50,7 @@ class Voice : public ListItem<Voice>
     bool isOver() const noexcept;
     bool isActive() const noexcept;
     bool isForNote(int note) const noexcept;
+    int getNote() const;
 
     void setStopIndex(int idx) noexcept { _stopIndex = idx; }
     int stopIndex() const noexcept { return _stopIndex; }