implement setting super and meta knobs from effect presets

mixxxdj · Apr 3, 2020 · 06af565 · 06af565
1 parent 720f61d
commit 06af565
Show file tree

Hide file tree

Showing 9 changed files with 43 additions and 20 deletions.
diff --git a/src/effects/effectchainslot.cpp b/src/effects/effectchainslot.cpp
@@ -189,8 +189,9 @@ void EffectChainSlot::setDescription(const QString& description) {
 void EffectChainSlot::loadEffect(const unsigned int iEffectSlotNumber,
         const EffectManifestPointer pManifest,
         std::unique_ptr<EffectProcessor> pProcessor,
-        EffectPresetPointer pPreset) {
-    m_effectSlots[iEffectSlotNumber]->loadEffect(pManifest, std::move(pProcessor), pPreset, m_enabledInputChannels);
+        EffectPresetPointer pPreset,
+        bool adoptMetaknobFromPreset) {
+    m_effectSlots[iEffectSlotNumber]->loadEffect(pManifest, std::move(pProcessor), pPreset, m_enabledInputChannels, adoptMetaknobFromPreset);
 }
 
 void EffectChainSlot::sendParameterUpdate() {

diff --git a/src/effects/effectchainslot.h b/src/effects/effectchainslot.h
@@ -90,7 +90,8 @@ class EffectChainSlot : public QObject {
     virtual void loadEffect(const unsigned int iEffectSlotNumber,
             const EffectManifestPointer pManifest,
             std::unique_ptr<EffectProcessor> pProcessor,
-            EffectPresetPointer pPreset);
+            EffectPresetPointer pPreset,
+            bool adoptMetaknobFromPreset = false);
 
   signals:
     // Signal that whoever is in charge of this EffectChainSlot should load the

diff --git a/src/effects/effectslot.cpp b/src/effects/effectslot.cpp
@@ -214,7 +214,8 @@ EffectParameterSlotBasePointer EffectSlot::getEffectParameterSlot(
 void EffectSlot::loadEffect(const EffectManifestPointer pManifest,
         std::unique_ptr<EffectProcessor> pProcessor,
         EffectPresetPointer pEffectPreset,
-        const QSet<ChannelHandleAndGroup>& activeChannels) {
+        const QSet<ChannelHandleAndGroup>& activeChannels,
+        bool adoptMetaknobFromPreset) {
     if (kEffectDebugOutput) {
         if (pManifest != nullptr) {
             qDebug() << this << m_group << "loading effect" << pManifest->id() << pEffectPreset.get() << pProcessor.get();
@@ -283,12 +284,18 @@ void EffectSlot::loadEffect(const EffectManifestPointer pManifest,
 
     m_pControlLoaded->forceSet(1.0);
 
-    // TODO: load meta knob from preset
     if (m_pEffectsManager->isAdoptMetaknobValueEnabled()) {
-        slotEffectMetaParameter(m_pControlMetaParameter->get(), true);
+        if (adoptMetaknobFromPreset) {
+            // Update the ControlObject value, but do not sync the parameters
+            // with slotEffectMetaParameter. This allows presets to intentionally
+            // save parameters in a state inconsistent with the metaknob.
+            m_pControlMetaParameter->set(pEffectPreset->metaParameter());
+        } else {
+            slotEffectMetaParameter(m_pControlMetaParameter->get(), true);
+        }
     } else {
-        m_pControlMetaParameter->set(m_pManifest->metaknobDefault());
-        slotEffectMetaParameter(m_pManifest->metaknobDefault(), true);
+        m_pControlMetaParameter->set(pEffectPreset->metaParameter());
+        slotEffectMetaParameter(pEffectPreset->metaParameter(), true);
     }
 
     emit effectChanged();

diff --git a/src/effects/effectslot.h b/src/effects/effectslot.h
@@ -43,7 +43,8 @@ class EffectSlot : public QObject {
     void loadEffect(const EffectManifestPointer pManifest,
             std::unique_ptr<EffectProcessor> pProcessor,
             EffectPresetPointer pPreset,
-            const QSet<ChannelHandleAndGroup>& activeChannels);
+            const QSet<ChannelHandleAndGroup>& activeChannels,
+            bool adoptMetaknobFromPreset = false);
 
     inline int getEffectSlotNumber() const {
         return m_iEffectNumber;

diff --git a/src/effects/effectsmanager.cpp b/src/effects/effectsmanager.cpp
@@ -158,11 +158,12 @@ void EffectsManager::loadEqualizerEffect(const QString& deckGroup,
 void EffectsManager::loadEffect(EffectChainSlotPointer pChainSlot,
         const int iEffectSlotNumber,
         const EffectManifestPointer pManifest,
-        EffectPresetPointer pPreset) {
+        EffectPresetPointer pPreset,
+        bool adoptMetaknobFromPreset) {
     if (pPreset == nullptr) {
         pPreset = m_defaultPresets.value(pManifest);
     }
-    pChainSlot->loadEffect(iEffectSlotNumber, pManifest, createProcessor(pManifest), pPreset);
+    pChainSlot->loadEffect(iEffectSlotNumber, pManifest, createProcessor(pManifest), pPreset, adoptMetaknobFromPreset);
 }
 
 std::unique_ptr<EffectProcessor> EffectsManager::createProcessor(
@@ -188,6 +189,10 @@ void EffectsManager::loadEffectChainPreset(EffectChainSlotPointer pChainSlot,
     VERIFY_OR_DEBUG_ASSERT(pPreset) {
         return;
     }
+    // Set the superknob before loading the effects so it does not change their
+    // metaknobs
+    pChainSlot->setSuperParameter(pPreset->superKnob());
+
     int effectSlot = 0;
     for (const auto& pEffectPreset : pPreset->effectPresets()) {
         if (pEffectPreset->isNull()) {
@@ -200,11 +205,10 @@ void EffectsManager::loadEffectChainPreset(EffectChainSlotPointer pChainSlot,
             continue;
         }
         EffectManifestPointer pManifest = pBackend->getManifest(pEffectPreset->id());
-        pChainSlot->loadEffect(effectSlot, pManifest, createProcessor(pManifest), pEffectPreset);
+        pChainSlot->loadEffect(effectSlot, pManifest, createProcessor(pManifest), pEffectPreset, true);
         effectSlot++;
     }
     pChainSlot->setMixMode(pPreset->mixMode());
-    pChainSlot->setSuperParameter(pPreset->superKnob());
 }
 
 const QList<EffectManifestPointer> EffectsManager::getAvailableEffectManifestsFiltered(

diff --git a/src/effects/effectsmanager.h b/src/effects/effectsmanager.h
@@ -90,7 +90,8 @@ class EffectsManager : public QObject {
             EffectChainSlotPointer pChainSlot,
             const int iEffectSlotNumber,
             const EffectManifestPointer pManifest,
-            EffectPresetPointer pPreset = nullptr);
+            EffectPresetPointer pPreset = nullptr,
+            bool adoptMetaknobFromPreset = false);
 
     std::unique_ptr<EffectProcessor> createProcessor(
             const EffectManifestPointer pManifest);

diff --git a/src/effects/presets/effectpreset.h b/src/effects/presets/effectpreset.h
@@ -19,6 +19,10 @@ class EffectPreset {
         return m_id;
     }
 
+    bool isNull() const {
+        return m_id.isEmpty();
+    }
+
     EffectBackendType backendType() const {
         return m_backendType;
     }

diff --git a/src/effects/specialeffectchainslots.cpp b/src/effects/specialeffectchainslots.cpp
@@ -116,8 +116,9 @@ void QuickEffectChainSlot::loadEffect(
         const unsigned int iEffectSlotNumber,
         const EffectManifestPointer pManifest,
         std::unique_ptr<EffectProcessor> pProcessor,
-        EffectPresetPointer pPreset) {
-    EffectChainSlot::loadEffect(iEffectSlotNumber, pManifest, std::move(pProcessor), pPreset);
+        EffectPresetPointer pPreset,
+        bool adoptMetaknobFromPreset) {
+    EffectChainSlot::loadEffect(iEffectSlotNumber, pManifest, std::move(pProcessor), pPreset, adoptMetaknobFromPreset);
     slotControlChainSuperParameter(m_pControlChainSuperParameter->get(), true);
 }
 
@@ -150,10 +151,11 @@ void EqualizerEffectChainSlot::loadEffect(
         const unsigned int iEffectSlotNumber,
         const EffectManifestPointer pManifest,
         std::unique_ptr<EffectProcessor> pProcessor,
-        EffectPresetPointer pPreset) {
+        EffectPresetPointer pPreset,
+        bool adoptMetaknobFromPreset) {
     // TODO: preserve effect parameters when loading new effect. This will allow
     // for easy comparison of the sound of different equalizer effects.
-    EffectChainSlot::loadEffect(iEffectSlotNumber, pManifest, std::move(pProcessor), pPreset);
+    EffectChainSlot::loadEffect(iEffectSlotNumber, pManifest, std::move(pProcessor), pPreset, adoptMetaknobFromPreset);
     m_pCOFilterWaveform->set(pManifest->isMixingEQ());
 }
 

diff --git a/src/effects/specialeffectchainslots.h b/src/effects/specialeffectchainslots.h
@@ -40,7 +40,8 @@ class QuickEffectChainSlot : public PerGroupEffectChainSlot {
     void loadEffect(const unsigned int iEffectSlotNumber,
             const EffectManifestPointer pManifest,
             std::unique_ptr<EffectProcessor> pProcessor,
-            EffectPresetPointer pPreset) override;
+            EffectPresetPointer pPreset,
+            bool adoptMetaknobFromPreset = false) override;
 
     static QString formatEffectChainSlotGroup(const QString& group);
     static QString formatEffectSlotGroup(const QString& group,
@@ -55,7 +56,8 @@ class EqualizerEffectChainSlot : public PerGroupEffectChainSlot {
     void loadEffect(const unsigned int iEffectSlotNumber,
             const EffectManifestPointer pManifest,
             std::unique_ptr<EffectProcessor> pProcessor,
-            EffectPresetPointer pPreset) override;
+            EffectPresetPointer pPreset,
+            bool adoptMetaknobFromPreset = false) override;
 
     static QString formatEffectChainSlotGroup(const QString& group);
     static QString formatEffectSlotGroup(const QString& group);