[WIP] Effects Refactoring #1705

kshitij98 · 2018-06-07T01:33:04Z

The pull request is at a very initial stage and a lot of work still needs to be done on it.

The current scope of this PR is:

Consolidate EffectChain and EffectChainSlot class
Remove EffectChainManager
Remove EngineEffectRack
Remove EffectRack
Consolidate Effect/EffectSlot
Remove unnecessary code from EffectParameter
Implement parameter hiding and rearrangement (skip implementing GUI for now)
Reimplement saving/loading from XML with new EffectChainPreset & EffectPreset classes.

There is some confusion with the current naming of classes. The newly proposed class names are:

EffectState -> EffectProcessorState
EffectChain/EffectChainSlot -> EffectRack
EngineEffectChain -> EngineEffectRack (loaded using EffectRackPreset)
Effect/EffectSlot -> EffectSlot
EngineEffect -> EngineEffectSlot (loaded using EffectPreset)
EffectProcessor -> EffectProcessor

NOTE: XML loading and saving has been commented out and will be re-implemented with the new Preset classes

Be-ing

This looks like a decent start. Untangling the mess from the old architecture won't happen all at once, so I don't expect you to take care of everything I am pointing out now in the next commit.

In general, wherever the old EffectChainSlot class called a function of m_pEffectChain, remove the old function of the EffectChain class and move its contents to the function of the old EffectChainSlot class where it was called.

src/effects/effectchainslot.cpp

src/effects/defs.h

src/effects/effect.cpp

src/effects/effectchainslot.cpp

src/engine/effects/engineeffect.cpp

src/effects/effectrack.cpp

src/effects/effectchainslot.cpp

src/effects/effectchainslot.h

src/effects/effectrack.cpp

src/effects/effectchainslot.cpp

src/effects/effectsmanager.cpp

Be-ing · 2018-06-08T21:11:21Z

Please make your next commit simply removing commented out and outdated code. Then it will be easier to review the code you actually change in following commits.

src/effects/effectrack.cpp

src/effects/effectchainslot.cpp

Be-ing · 2018-06-09T21:07:40Z

I am repeating the plan we came up with in our private Zulip chat:

Finish simplifying EffectChainSlot
Remove EffectChainManager
Remove EffectRack/EngineEffectRack
Consolidate Effect/EffectSlot
Reimplement saving/loading from XML with new EffectChainPreset & EffectPreset classes.

daschuer · 2018-06-10T12:16:55Z

I think we will need the EffectRack layer.

Be-ing · 2018-06-10T12:24:01Z

Why? It does nothing but overcomplicate the code. Everything done at the effect rack layer can and should be moved down to the effect chain layer. The superfluous rack layer requires breaking the abstraction of the chain layer.

Be-ing · 2018-06-10T15:53:08Z

@kshitij98 did you change the email you configured to be associated with your Git commits? The new commits are showing as being from a different GitHub user.

src/effects/effectchainslot.cpp

kshitij98 · 2018-06-10T16:21:38Z

@kshitij98 did you change the email you configured to be associated with your Git commits? The new commits are showing as being from a different GitHub user.

My laptop was not working fine yesterday so I had to use a friend's pc for the same. I forgot to change the config setting of git. Should I reset the author of the previous commits?

Be-ing · 2018-06-10T16:59:39Z

When you're done consolidating EffectChain/EffectChainSlot, rebase and squash your work down to one commit to remove the temporary intermediate code from the Git history. At that time you can remove the other email associated with the new commits. For now let's just keep going.

src/preferences/dialog/dlgprefeq.cpp

src/engine/effects/engineeffectchain.cpp

src/engine/effects/engineeffect.cpp

src/effects/effectrack.cpp

src/effects/effectchainslot.cpp

Be-ing · 2018-06-12T11:15:30Z

The regular effects are not being applied if they are enabled for an input channel on startup. After toggling the routing switch they work. I am trying to debug this...

Be-ing · 2018-06-12T13:59:19Z

I have sent you a pull request to fix the initialization process.

src/effects/effectchainslot.cpp

src/effects/effectchainslot.h

src/effects/effectrack.cpp

src/effects/effectchainslot.h

Be-ing · 2018-06-12T14:15:49Z

EffectChainSlot is down to about 600 lines of code :D

Be-ing · 2018-06-12T14:30:07Z

I am thinking we should rename EffectChainSlot to EffectChain now. What do you think?

kshitij98 · 2018-12-29T07:04:29Z

Please write more descriptive commit messages. Even something as simple as "rename some variables in EffectSlot" is better.

I have edited the previous commit messages

Be-ing · 2018-12-29T19:57:20Z

kshitij98#10

daschuer

Unfortunately this PR is still blocked by the open discussion about the future CO namespace. We are talking here about 8000 alias COs.

I understand the reasons for the renaming, but we should pretty sure that this reason outweighs all the related work and that the new namespace helps us for future changes. Later renaming because of new features will be harder due to the created naming legacy.

I think both is doubtful, and the old name space is well considered and not that bad. I also do not like the idea of cycling the names, this will create even more confusion. Unit and Rack means here totally different things. A perfect recipe for confusion.

If it turns out I am the only one with this opinion we can do the change, otherwise lets postpone the renaming and revert this PR to the existing nomenclature.

daschuer · 2018-06-30T18:03:22Z

src/controllers/controlpickermenu.cpp

+    for (int deck = 1; deck <= iNumDecks; ++deck) {
+        QMenu* deckMenu = addSubmenu(QString("Deck %1").arg(deck), eqMenu);
+        for (int effect = kMaxEqs - 1; effect >= 0; --effect) {
+            const QString group = EqualizerEffectChainSlot::formatEffectSlotGroup(


What is EqualizerEffectChainSlot? This is not Part of the wiki description.

We have not done the renaming yet. EqualizerEffectChainSlot is what the wiki describes as EqualizerEffectRack.

src/effects/effectslot.cpp

daschuer · 2018-12-31T00:07:41Z

So the current state here is that the Rack classes where removed, but the CO namespace is still unchanged? If we stick with this for a first step, it will work for me.

Be-ing · 2018-12-31T00:08:18Z

Yes, that is the current state of the code.

daschuer · 2018-12-31T00:09:35Z

src/effects/effectsmanager.cpp

 #include "engine/effects/engineeffectchain.h"
 #include "util/assert.h"

 namespace {
+const QString kStandardEffectRackGroup = "[EffectRack1]";


daschuer · 2018-12-31T00:11:53Z

src/effects/effectsmanager.cpp

 #include "engine/effects/engineeffectchain.h"
 #include "util/assert.h"

 namespace {
+const QString kStandardEffectRackGroup = "[EffectRack1]";
+const QString kOutputEffectRackGroup = "[OutputEffectRack]";


daschuer · 2018-12-31T00:12:29Z

src/effects/effectsmanager.cpp

 #include "engine/effects/engineeffectchain.h"
 #include "util/assert.h"

 namespace {
+const QString kStandardEffectRackGroup = "[EffectRack1]";
+const QString kOutputEffectRackGroup = "[OutputEffectRack]";
+const QString kQuickEffectRackGroup = "[QuickEffectRack1]";


daschuer · 2018-12-31T00:12:42Z

src/effects/effectsmanager.cpp

+const QString kStandardEffectRackGroup = "[EffectRack1]";
+const QString kOutputEffectRackGroup = "[OutputEffectRack]";
+const QString kQuickEffectRackGroup = "[QuickEffectRack1]";
+const QString kEqualizerEffectRackGroup = "[EqualizerRack1]";


daschuer · 2018-12-31T00:14:59Z

src/effects/effectsmanager.cpp

+const QString kStandardEffectRackGroup = "[EffectRack1]";
+const QString kOutputEffectRackGroup = "[OutputEffectRack]";
+const QString kQuickEffectRackGroup = "[QuickEffectRack1]";
+const QString kEqualizerEffectRackGroup = "[EqualizerRack1]";
 const QString kEffectGroupSeparator = "_";
 const QString kGroupClose = "]";


kGroupOpen is missing. We use [ and ] everywhere as characters in the code. Imho this one clutters the code more than it helps, can we just remove it?

I'd be in favor of removing it.

Added comments

function pointers for signal-slot connections in effects system

- Removed EffectSlot::getParameterForSlot - Removed EffectParameter::valueChanged signal

Be-ing

This is off to a good start!

src/effects/effectpreset.cpp

src/effects/effectchainpreset.h

src/effects/effectxmlelements.h

- Added EffectChainPreset class - Added EffectPreset class - Added EffectsManager::loadEffectChainPresets

Be-ing · 2019-02-18T00:10:53Z

src/effects/effectsmanager.cpp

+    file.close();
+
+    QDomElement root = doc.documentElement();
+    QDomElement rackElement = XmlParse::selectElement(root, EffectXml::Rack);


Add a comment explaining that this element is superfluous but it is kept for backwards compatibility.

Be-ing · 2020-04-01T23:34:48Z

continued here: #2618

Be-ing suggested changes Jun 7, 2018

View reviewed changes

Be-ing suggested changes Jun 8, 2018

View reviewed changes

Be-ing reviewed Jun 8, 2018

View reviewed changes

src/effects/effectchainslot.cpp Outdated Show resolved Hide resolved

Be-ing reviewed Jun 8, 2018

View reviewed changes

src/effects/effectchainslot.cpp Show resolved Hide resolved

Be-ing reviewed Jun 8, 2018

View reviewed changes

src/effects/effectsmanager.cpp Outdated Show resolved Hide resolved

Be-ing reviewed Jun 9, 2018

View reviewed changes

src/effects/effectrack.cpp Outdated Show resolved Hide resolved

Be-ing reviewed Jun 9, 2018

View reviewed changes

src/effects/effectchainslot.cpp Outdated Show resolved Hide resolved

Be-ing reviewed Jun 9, 2018

View reviewed changes

src/effects/effectchainslot.cpp Show resolved Hide resolved

kshitij98 force-pushed the effects_refactoring branch from b11322c to ad9c680 Compare June 10, 2018 15:32

Be-ing reviewed Jun 10, 2018

View reviewed changes

src/effects/effectchainslot.cpp Outdated Show resolved Hide resolved

Be-ing suggested changes Jun 10, 2018

View reviewed changes

kshitij98 force-pushed the effects_refactoring branch from 1da9dc2 to 5372b09 Compare June 10, 2018 23:12

Be-ing suggested changes Jun 11, 2018

View reviewed changes

src/effects/effectchainslot.cpp Outdated Show resolved Hide resolved

src/effects/effectchainslot.cpp Outdated Show resolved Hide resolved

kshitij98 force-pushed the effects_refactoring branch from fa08ebc to b6cdbfa Compare June 12, 2018 07:54

Be-ing suggested changes Jun 12, 2018

View reviewed changes

src/effects/effectchainslot.cpp Outdated Show resolved Hide resolved

src/effects/effectchainslot.cpp Outdated Show resolved Hide resolved

Be-ing reviewed Jun 12, 2018

View reviewed changes

src/effects/effectchainslot.cpp Outdated Show resolved Hide resolved

Be-ing reviewed Jun 12, 2018

View reviewed changes

src/effects/effectchainslot.cpp Outdated Show resolved Hide resolved

Be-ing suggested changes Jun 12, 2018

View reviewed changes

kshitij98 and others added 2 commits December 29, 2018 14:37

Merge branch 'master' into effects_refactoring

584bb6a

function pointers for signal-slot connections in effects system

5527c03

daschuer requested changes Dec 30, 2018

View reviewed changes

Be-ing suggested changes Dec 31, 2018

View reviewed changes

src/effects/effectslot.cpp Outdated Show resolved Hide resolved

src/effects/effectslot.cpp Show resolved Hide resolved

src/effects/effectslot.cpp Show resolved Hide resolved

daschuer requested changes Dec 31, 2018

View reviewed changes

kshitij98 and others added 6 commits January 2, 2019 09:57

Removed redundant block from switch case

cdd440e

Added comment in load Parameter

1345726

Removed EffectSlot::getEngineEffect()

b9b1429

Added comments

Merge pull request #10 from Be-ing/effects_refactoring

b9605cc

function pointers for signal-slot connections in effects system

Added assertion parameterSlotIndex < numParameterSlots

c672bbd

Added comment in EffectParameter

acf0f4f

Be-ing modified the milestones: 2.3.0, 2.4.0 Feb 7, 2019

kshitij98 added 3 commits February 12, 2019 00:04

Shifted slotValueChanged to EffectParameterSlotBase

73fecb7

Simplified parameter value updates

d7d5657

- Removed EffectSlot::getParameterForSlot - Removed EffectParameter::valueChanged signal

Merge remote-tracking branch 'upstream/master' into effects_refactoring

2ef7b92

Be-ing suggested changes Feb 17, 2019

View reviewed changes

src/effects/effectpreset.cpp Outdated Show resolved Hide resolved

src/effects/effectchainpreset.h Outdated Show resolved Hide resolved

src/effects/effectchainpreset.h Outdated Show resolved Hide resolved

src/effects/effectxmlelements.h Outdated Show resolved Hide resolved

Added Effect Preset classes

2fab19a

- Added EffectChainPreset class - Added EffectPreset class - Added EffectsManager::loadEffectChainPresets

kshitij98 force-pushed the effects_refactoring branch from 6b908bf to 2fab19a Compare February 17, 2019 19:40

Be-ing reviewed Feb 18, 2019

View reviewed changes

Be-ing mentioned this pull request Aug 11, 2019

SCons: Decode stdout from subprocess #2201

Merged

Be-ing mentioned this pull request Dec 9, 2019

Native Instruments Traktor Kontrol S2 MK3 mapping #2348

Merged

Be-ing mentioned this pull request Apr 1, 2020

effect chain preset saving/loading, custom effect defaults, and parameter hiding/rearrangement #2618

Closed

15 tasks

Be-ing closed this Apr 1, 2020

mixxxbot mentioned this pull request Aug 23, 2022

Combine EQ and XFader to Mixer page in Preferencs #9401

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Effects Refactoring #1705

[WIP] Effects Refactoring #1705

kshitij98 commented Jun 7, 2018 •

edited

Loading

Be-ing left a comment

Be-ing commented Jun 8, 2018

Be-ing commented Jun 9, 2018

daschuer commented Jun 10, 2018

Be-ing commented Jun 10, 2018 •

edited

Loading

Be-ing commented Jun 10, 2018

kshitij98 commented Jun 10, 2018 •

edited

Loading

Be-ing commented Jun 10, 2018

Be-ing commented Jun 12, 2018

Be-ing commented Jun 12, 2018

Be-ing commented Jun 12, 2018

Be-ing commented Jun 12, 2018

kshitij98 commented Dec 29, 2018

Be-ing commented Dec 29, 2018

daschuer left a comment

daschuer Jun 30, 2018

Be-ing Dec 30, 2018

daschuer commented Dec 31, 2018

Be-ing commented Dec 31, 2018

daschuer Dec 31, 2018

daschuer Dec 31, 2018

daschuer Dec 31, 2018

daschuer Dec 31, 2018

daschuer Dec 31, 2018

Be-ing Dec 31, 2018

Be-ing left a comment

Be-ing Feb 18, 2019

Be-ing commented Apr 1, 2020

[WIP] Effects Refactoring #1705

[WIP] Effects Refactoring #1705

Conversation

kshitij98 commented Jun 7, 2018 • edited Loading

Be-ing left a comment

Choose a reason for hiding this comment

Be-ing commented Jun 8, 2018

Be-ing commented Jun 9, 2018

daschuer commented Jun 10, 2018

Be-ing commented Jun 10, 2018 • edited Loading

Be-ing commented Jun 10, 2018

kshitij98 commented Jun 10, 2018 • edited Loading

Be-ing commented Jun 10, 2018

Be-ing commented Jun 12, 2018

Be-ing commented Jun 12, 2018

Be-ing commented Jun 12, 2018

Be-ing commented Jun 12, 2018

kshitij98 commented Dec 29, 2018

Be-ing commented Dec 29, 2018

daschuer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daschuer commented Dec 31, 2018

Be-ing commented Dec 31, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Be-ing left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Be-ing commented Apr 1, 2020

kshitij98 commented Jun 7, 2018 •

edited

Loading

Be-ing commented Jun 10, 2018 •

edited

Loading

kshitij98 commented Jun 10, 2018 •

edited

Loading