Merge pull request #2969 from xerus2000/playermanager-handle

PlayerManager: Identify players by ChannelHandle

src/effects/effectchain.cpp

@@ -155,12 +155,12 @@ void EffectChain::setEnabled(bool enabled) {
     emit enabledChanged(enabled);
 }
 
-void EffectChain::enableForInputChannel(const ChannelHandleAndGroup& handle_group) {
+void EffectChain::enableForInputChannel(const ChannelHandleAndGroup& handleGroup) {
     // TODO(Be): remove m_enabledChannels from this class and move this logic
     // to EffectChainSlot
-    bool bWasAlreadyEnabled = m_enabledInputChannels.contains(handle_group);
+    bool bWasAlreadyEnabled = m_enabledInputChannels.contains(handleGroup);
     if (!bWasAlreadyEnabled) {
-        m_enabledInputChannels.insert(handle_group);
+        m_enabledInputChannels.insert(handleGroup);
     }
 
     // The allocation of EffectStates below may be expensive, so avoid it if
@@ -172,7 +172,7 @@ void EffectChain::enableForInputChannel(const ChannelHandleAndGroup& handle_grou
     EffectsRequest* request = new EffectsRequest();
     request->type = EffectsRequest::ENABLE_EFFECT_CHAIN_FOR_INPUT_CHANNEL;
     request->pTargetChain = m_pEngineEffectChain;
-    request->EnableInputChannelForChain.pChannelHandle = &handle_group.handle();
+    request->EnableInputChannelForChain.pChannelHandle = &handleGroup.handle();
 
     // Allocate EffectStates here in the main thread to avoid allocating
     // memory in the realtime audio callback thread. Pointers to the
@@ -191,7 +191,7 @@ void EffectChain::enableForInputChannel(const ChannelHandleAndGroup& handle_grou
         if (m_effects[i] != nullptr) {
             for (const auto& outputChannel : m_pEffectsManager->registeredOutputChannels()) {
                 if (kEffectDebugOutput) {
-                    qDebug() << debugString() << "EffectChain::enableForInputChannel creating EffectState for input" << handle_group << "output" << outputChannel;
+                    qDebug() << debugString() << "EffectChain::enableForInputChannel creating EffectState for input" << handleGroup << "output" << outputChannel;
                 }
                 statesMap.insert(outputChannel.handle(),
                         m_effects[i]->createState(bufferParameters));
@@ -208,25 +208,25 @@ void EffectChain::enableForInputChannel(const ChannelHandleAndGroup& handle_grou
     request->EnableInputChannelForChain.pEffectStatesMapArray = pEffectStatesMapArray;
 
     m_pEffectsManager->writeRequest(request);
-    emit channelStatusChanged(handle_group.name(), true);
+    emit channelStatusChanged(handleGroup.name(), true);
 }
 
-bool EffectChain::enabledForChannel(const ChannelHandleAndGroup& handle_group) const {
-    return m_enabledInputChannels.contains(handle_group);
+bool EffectChain::enabledForChannel(const ChannelHandleAndGroup& handleGroup) const {
+    return m_enabledInputChannels.contains(handleGroup);
 }
 
-void EffectChain::disableForInputChannel(const ChannelHandleAndGroup& handle_group) {
-    if (m_enabledInputChannels.remove(handle_group)) {
+void EffectChain::disableForInputChannel(const ChannelHandleAndGroup& handleGroup) {
+    if (m_enabledInputChannels.remove(handleGroup)) {
         if (!m_bAddedToEngine) {
             return;
         }
         EffectsRequest* request = new EffectsRequest();
         request->type = EffectsRequest::DISABLE_EFFECT_CHAIN_FOR_INPUT_CHANNEL;
         request->pTargetChain = m_pEngineEffectChain;
-        request->DisableInputChannelForChain.pChannelHandle = &handle_group.handle();
+        request->DisableInputChannelForChain.pChannelHandle = &handleGroup.handle();
         m_pEffectsManager->writeRequest(request);
 
-        emit channelStatusChanged(handle_group.name(), false);
+        emit channelStatusChanged(handleGroup.name(), false);
     }
 }
 

src/effects/effectchain.h

@@ -39,10 +39,10 @@ class EffectChain : public QObject {
     void setEnabled(bool enabled);
 
     // Activates EffectChain processing for the provided channel.
-    void enableForInputChannel(const ChannelHandleAndGroup& handle_group);
-    bool enabledForChannel(const ChannelHandleAndGroup& handle_group) const;
+    void enableForInputChannel(const ChannelHandleAndGroup& handleGroup);
+    bool enabledForChannel(const ChannelHandleAndGroup& handleGroup) const;
     const QSet<ChannelHandleAndGroup>& enabledChannels() const;
-    void disableForInputChannel(const ChannelHandleAndGroup& handle_group);
+    void disableForInputChannel(const ChannelHandleAndGroup& handleGroup);
 
     EffectChainPointer prototype() const;
 

src/effects/effectchainmanager.cpp

@@ -18,22 +18,22 @@ EffectChainManager::~EffectChainManager() {
     //qDebug() << debugString() << "destroyed";
 }
 
-void EffectChainManager::registerInputChannel(const ChannelHandleAndGroup& handle_group) {
-    VERIFY_OR_DEBUG_ASSERT(!m_registeredInputChannels.contains(handle_group)) {
+void EffectChainManager::registerInputChannel(const ChannelHandleAndGroup& handleGroup) {
+    VERIFY_OR_DEBUG_ASSERT(!m_registeredInputChannels.contains(handleGroup)) {
         return;
     }
-    m_registeredInputChannels.insert(handle_group);
+    m_registeredInputChannels.insert(handleGroup);
 
     for (auto& pRack : m_standardEffectRacks) {
-        pRack->registerInputChannel(handle_group);
+        pRack->registerInputChannel(handleGroup);
     }
 }
 
-void EffectChainManager::registerOutputChannel(const ChannelHandleAndGroup& handle_group) {
-    VERIFY_OR_DEBUG_ASSERT(!m_registeredOutputChannels.contains(handle_group)) {
+void EffectChainManager::registerOutputChannel(const ChannelHandleAndGroup& handleGroup) {
+    VERIFY_OR_DEBUG_ASSERT(!m_registeredOutputChannels.contains(handleGroup)) {
         return;
     }
-    m_registeredOutputChannels.insert(handle_group);
+    m_registeredOutputChannels.insert(handleGroup);
 }
 
 StandardEffectRackPointer EffectChainManager::addStandardEffectRack() {

src/effects/effectchainmanager.h

@@ -24,12 +24,12 @@ class EffectChainManager : public QObject {
                        EffectsManager* pEffectsManager);
     virtual ~EffectChainManager();
 
-    void registerInputChannel(const ChannelHandleAndGroup& handle_group);
+    void registerInputChannel(const ChannelHandleAndGroup& handleGroup);
     const QSet<ChannelHandleAndGroup>& registeredInputChannels() const {
         return m_registeredInputChannels;
     }
 
-    void registerOutputChannel(const ChannelHandleAndGroup& handle_group);
+    void registerOutputChannel(const ChannelHandleAndGroup& handleGroup);
     const QSet<ChannelHandleAndGroup>& registeredOutputChannels() const {
         return m_registeredOutputChannels;
     }

src/effects/effectchainslot.cpp

@@ -242,9 +242,9 @@ void EffectChainSlot::updateRoutingSwitches() {
     }
     for (const ChannelInfo* pChannelInfo : m_channelInfoByName) {
         if (pChannelInfo->pEnabled->toBool()) {
-            m_pEffectChain->enableForInputChannel(pChannelInfo->handle_group);
+            m_pEffectChain->enableForInputChannel(pChannelInfo->handleGroup);
         } else {
-            m_pEffectChain->disableForInputChannel(pChannelInfo->handle_group);
+            m_pEffectChain->disableForInputChannel(pChannelInfo->handleGroup);
         }
     }
 }
@@ -314,27 +314,26 @@ EffectSlotPointer EffectChainSlot::addEffectSlot(const QString& group) {
     return pSlot;
 }
 
-void EffectChainSlot::registerInputChannel(const ChannelHandleAndGroup& handle_group) {
-    VERIFY_OR_DEBUG_ASSERT(!m_channelInfoByName.contains(handle_group.name())) {
+void EffectChainSlot::registerInputChannel(const ChannelHandleAndGroup& handleGroup) {
+    VERIFY_OR_DEBUG_ASSERT(!m_channelInfoByName.contains(handleGroup.name())) {
         return;
     }
 
     double initialValue = 0.0;
     int deckNumber;
-    if (PlayerManager::isDeckGroup(handle_group.name(), &deckNumber) &&
-        (m_iChainSlotNumber + 1) == (unsigned) deckNumber) {
+    if (PlayerManager::isDeckGroup(handleGroup.name(), &deckNumber) &&
+            (m_iChainSlotNumber + 1) == (unsigned)deckNumber) {
         initialValue = 1.0;
     }
     ControlPushButton* pEnableControl = new ControlPushButton(
-            ConfigKey(m_group, QString("group_%1_enable").arg(handle_group.name())),
-            true, initialValue);
+            ConfigKey(m_group, QString("group_%1_enable").arg(handleGroup.name())),
+            true,
+            initialValue);
     pEnableControl->setButtonMode(ControlPushButton::POWERWINDOW);
 
-    ChannelInfo* pInfo = new ChannelInfo(handle_group, pEnableControl);
-    m_channelInfoByName[handle_group.name()] = pInfo;
-    connect(pEnableControl, &ControlPushButton::valueChanged,
-            this, [this, handle_group] { slotChannelStatusChanged(handle_group.name()); });
-
+    ChannelInfo* pInfo = new ChannelInfo(handleGroup, pEnableControl);
+    m_channelInfoByName[handleGroup.name()] = pInfo;
+    connect(pEnableControl, &ControlPushButton::valueChanged, this, [this, handleGroup] { slotChannelStatusChanged(handleGroup.name()); });
 }
 
 void EffectChainSlot::slotEffectLoaded(EffectPointer pEffect, unsigned int slotNumber) {
@@ -433,12 +432,12 @@ void EffectChainSlot::slotControlChainPrevPreset(double v) {
 void EffectChainSlot::slotChannelStatusChanged(const QString& group) {
     if (m_pEffectChain) {
         ChannelInfo* pChannelInfo = m_channelInfoByName.value(group, NULL);
-        if (pChannelInfo != NULL && pChannelInfo->pEnabled != NULL) {
+        if (pChannelInfo != nullptr && pChannelInfo->pEnabled != nullptr) {
             bool bEnable = pChannelInfo->pEnabled->toBool();
             if (bEnable) {
-                m_pEffectChain->enableForInputChannel(pChannelInfo->handle_group);
+                m_pEffectChain->enableForInputChannel(pChannelInfo->handleGroup);
             } else {
-                m_pEffectChain->disableForInputChannel(pChannelInfo->handle_group);
+                m_pEffectChain->disableForInputChannel(pChannelInfo->handleGroup);
             }
         }
     }

src/effects/effectchainslot.h

@@ -34,7 +34,7 @@ class EffectChainSlot : public QObject {
     EffectChainPointer getEffectChain() const;
     EffectChainPointer getOrCreateEffectChain(EffectsManager* pEffectsManager);
 
-    void registerInputChannel(const ChannelHandleAndGroup& handle_group);
+    void registerInputChannel(const ChannelHandleAndGroup& handleGroup);
 
     double getSuperParameter() const;
     void setSuperParameter(double value, bool force = false);
@@ -153,15 +153,14 @@ class EffectChainSlot : public QObject {
 
     struct ChannelInfo {
         // Takes ownership of pEnabled.
-        ChannelInfo(const ChannelHandleAndGroup& handle_group, ControlObject* pEnabled)
-                : handle_group(handle_group),
+        ChannelInfo(const ChannelHandleAndGroup& handleGroup, ControlObject* pEnabled)
+                : handleGroup(handleGroup),
                   pEnabled(pEnabled) {
-
         }
         ~ChannelInfo() {
             delete pEnabled;
         }
-        ChannelHandleAndGroup handle_group;
+        ChannelHandleAndGroup handleGroup;
         ControlObject* pEnabled;
     };
     QMap<QString, ChannelInfo*> m_channelInfoByName;

src/effects/effectrack.cpp

@@ -73,9 +73,9 @@ void EffectRack::removeFromEngine() {
     m_pEngineEffectRack = NULL;
 }
 
-void EffectRack::registerInputChannel(const ChannelHandleAndGroup& handle_group) {
+void EffectRack::registerInputChannel(const ChannelHandleAndGroup& handleGroup) {
     foreach (EffectChainSlotPointer pChainSlot, m_effectChainSlots) {
-        pChainSlot->registerInputChannel(handle_group);
+        pChainSlot->registerInputChannel(handleGroup);
     }
 }
 
@@ -260,8 +260,8 @@ EffectChainSlotPointer StandardEffectRack::addEffectChainSlot() {
     // Register all the existing channels with the new EffectChain.
     const QSet<ChannelHandleAndGroup>& registeredChannels =
             m_pEffectChainManager->registeredInputChannels();
-    for (const ChannelHandleAndGroup& handle_group : registeredChannels) {
-        pChainSlot->registerInputChannel(handle_group);
+    for (const ChannelHandleAndGroup& handleGroup : registeredChannels) {
+        pChainSlot->registerInputChannel(handleGroup);
     }
 
     EffectChainSlotPointer pChainSlotPointer = EffectChainSlotPointer(pChainSlot);
@@ -300,9 +300,9 @@ OutputEffectRack::OutputEffectRack(EffectsManager* pEffectsManager,
     // TODO(Be): Remove this hideous hack to get the ChannelHandleAndGroup
     const QSet<ChannelHandleAndGroup>& registeredChannels =
             m_pEffectChainManager->registeredInputChannels();
-    for (const ChannelHandleAndGroup& handle_group : registeredChannels) {
-        if (handle_group.name() == "[MasterOutput]") {
-            masterHandleAndGroup = &handle_group;
+    for (const ChannelHandleAndGroup& handleGroup : registeredChannels) {
+        if (handleGroup.name() == "[MasterOutput]") {
+            masterHandleAndGroup = &handleGroup;
             break;
         }
     }
@@ -349,10 +349,10 @@ void PerGroupRack::setupForGroup(const QString& groupName) {
 
     // TODO(rryan): remove.
     const ChannelHandleAndGroup* handleAndGroup = nullptr;
-    for (const ChannelHandleAndGroup& handle_group :
-             m_pEffectChainManager->registeredInputChannels()) {
-        if (handle_group.name() == groupName) {
-            handleAndGroup = &handle_group;
+    for (const ChannelHandleAndGroup& handleGroup :
+            m_pEffectChainManager->registeredInputChannels()) {
+        if (handleGroup.name() == groupName) {
+            handleAndGroup = &handleGroup;
             break;
         }
     }

src/effects/effectrack.h

@@ -30,7 +30,7 @@ class EffectRack : public QObject {
     void removeFromEngine();
     EngineEffectRack* getEngineEffectRack();
 
-    void registerInputChannel(const ChannelHandleAndGroup& handle_group);
+    void registerInputChannel(const ChannelHandleAndGroup& handleGroup);
     int numEffectChainSlots() const;
     EffectChainSlotPointer getEffectChainSlot(int i);
 

src/effects/effectsmanager.cpp

@@ -106,16 +106,16 @@ void EffectsManager::slotBackendRegisteredEffect(EffectManifestPointer pManifest
     m_pNumEffectsAvailable->forceSet(m_availableEffectManifests.size());
 }
 
-void EffectsManager::registerInputChannel(const ChannelHandleAndGroup& handle_group) {
-    m_pEffectChainManager->registerInputChannel(handle_group);
+void EffectsManager::registerInputChannel(const ChannelHandleAndGroup& handleGroup) {
+    m_pEffectChainManager->registerInputChannel(handleGroup);
 }
 
 const QSet<ChannelHandleAndGroup>& EffectsManager::registeredInputChannels() const {
     return m_pEffectChainManager->registeredInputChannels();
 }
 
-void EffectsManager::registerOutputChannel(const ChannelHandleAndGroup& handle_group) {
-    m_pEffectChainManager->registerOutputChannel(handle_group);
+void EffectsManager::registerOutputChannel(const ChannelHandleAndGroup& handleGroup) {
+    m_pEffectChainManager->registerOutputChannel(handleGroup);
 }
 
 const QSet<ChannelHandleAndGroup>& EffectsManager::registeredOutputChannels() const {

src/effects/effectsmanager.h

@@ -47,8 +47,8 @@ class EffectsManager : public QObject {
     // takes ownership of the backend, and will delete it when EffectsManager is
     // being deleted. Not thread safe -- use only from the GUI thread.
     void addEffectsBackend(EffectsBackend* pEffectsBackend);
-    void registerInputChannel(const ChannelHandleAndGroup& handle_group);
-    void registerOutputChannel(const ChannelHandleAndGroup& handle_group);
+    void registerInputChannel(const ChannelHandleAndGroup& handleGroup);
+    void registerOutputChannel(const ChannelHandleAndGroup& handleGroup);
     const QSet<ChannelHandleAndGroup>& registeredInputChannels() const;
     const QSet<ChannelHandleAndGroup>& registeredOutputChannels() const;
 

src/engine/channelhandle.h

@@ -1,5 +1,13 @@
-#ifndef CHANNELHANDLE_H
-#define CHANNELHANDLE_H
+#pragma once
+
+#include <QHash>
+#include <QString>
+#include <QVarLengthArray>
+#include <QtDebug>
+#include <memory>
+
+#include "util/assert.h"
+
 // ChannelHandle defines a unique identifier for channels of audio in the engine
 // (e.g. headphone output, master output, deck 1, microphone 3). Previously we
 // used the group string of the channel in the engine to uniquely identify it
@@ -12,21 +20,13 @@
 // and equality of ChannelHandles are simple to calculate and a QVarLengthArray
 // can be used to create a fast associative container backed by a simple array
 // (since the keys are numbered [0, num_channels]).
-//
-// A helper class, ChannelHandleFactory, keeps a running count of handles that
-// have been assigned.
 
-#include <QHash>
-#include <QString>
-#include <QVarLengthArray>
-#include <QtDebug>
-#include <memory>
-
-#include "util/assert.h"
-
-// A wrapper around an integer handle. Used to uniquely identify and refer to
-// channels (headphone output, master output, deck 1, microphone 4, etc.) of
-// audio in the engine.
+/// A wrapper around an integer handle. Used to uniquely identify and refer to
+/// channels (headphone output, master output, deck 1, microphone 4, etc.) while
+/// avoiding slow QString comparisons incurred when using the group.
+///
+/// A helper class, ChannelHandleFactory, keeps a running count of handles that
+/// have been assigned.
 class ChannelHandle {
   public:
     ChannelHandle() : m_iHandle(-1) {
@@ -54,6 +54,14 @@ class ChannelHandle {
     friend class ChannelHandleFactory;
 };
 
+inline bool operator>(const ChannelHandle& h1, const ChannelHandle& h2) {
+    return h1.handle() > h2.handle();
+}
+
+inline bool operator<(const ChannelHandle& h1, const ChannelHandle& h2) {
+    return h1.handle() < h2.handle();
+}
+
 inline bool operator==(const ChannelHandle& h1, const ChannelHandle& h2) {
     return h1.handle() == h2.handle();
 }
@@ -108,9 +116,9 @@ inline QDebug operator<<(QDebug stream, const ChannelHandleAndGroup& g) {
 }
 
 inline uint qHash(
-        const ChannelHandleAndGroup& handle_group,
+        const ChannelHandleAndGroup& handleGroup,
         uint seed = 0) {
-    return qHash(handle_group.handle(), seed);
+    return qHash(handleGroup.handle(), seed);
 }
 
 // A helper class used by EngineMaster to assign ChannelHandles to channel group
@@ -219,5 +227,3 @@ class ChannelHandleMap {
     container_type m_data;
     T m_dummy;
 };
-
-#endif /* CHANNELHANDLE,_H */

src/engine/channels/engineaux.cpp

@@ -13,8 +13,8 @@
 #include "engine/effects/engineeffectsmanager.h"
 #include "util/sample.h"
 
-EngineAux::EngineAux(const ChannelHandleAndGroup& handle_group, EffectsManager* pEffectsManager)
-        : EngineChannel(handle_group, EngineChannel::CENTER, pEffectsManager,
+EngineAux::EngineAux(const ChannelHandleAndGroup& handleGroup, EffectsManager* pEffectsManager)
+        : EngineChannel(handleGroup, EngineChannel::CENTER, pEffectsManager,
                   /*isTalkoverChannel*/ false,
                   /*isPrimaryDeck*/ false),
           m_pInputConfigured(new ControlObject(ConfigKey(getGroup(), "input_configured"))),