Optimize control code

CMakeLists.txt

@@ -1333,6 +1333,7 @@ set(MIXXX_LIB_PRECOMPILED_HEADER
   src/control/control.h
   src/control/controlaudiotaperpot.h
   src/control/controlbehavior.h
+  src/control/controlbuttonmode.h
   src/control/controlcompressingproxy.h
   src/control/controleffectknob.h
   src/control/controlencoder.h

src/broadcast/broadcastmanager.cpp

@@ -22,7 +22,7 @@ BroadcastManager::BroadcastManager(SettingsManager* pSettingsManager,
     const bool persist = true;
     m_pBroadcastEnabled = new ControlPushButton(
             ConfigKey(BROADCAST_PREF_KEY,"enabled"), persist);
-    m_pBroadcastEnabled->setButtonMode(ControlPushButton::TOGGLE);
+    m_pBroadcastEnabled->setButtonMode(mixxx::control::ButtonMode::Toggle);
     connect(m_pBroadcastEnabled,
             &ControlPushButton::valueChanged,
             this,

src/control/control.cpp

@@ -30,14 +30,14 @@ QWeakPointer<ControlDoublePrivate> s_pDefaultCO;
 } // namespace
 
 ControlDoublePrivate::ControlDoublePrivate()
-        : m_bPersistInConfiguration(false),
-          m_bIgnoreNops(true),
-          m_bTrack(false),
-          m_trackType(Stat::UNSPECIFIED),
+        : m_trackType(Stat::UNSPECIFIED),
           m_trackFlags(Stat::COUNT | Stat::SUM | Stat::AVERAGE |
                   Stat::SAMPLE_VARIANCE | Stat::MIN | Stat::MAX),
+          m_bTrack(false),
           // default CO is read only
           m_confirmRequired(true),
+          m_bPersistInConfiguration(false),
+          m_bIgnoreNops(true),
           m_kbdRepeatable(false) {
     m_value.setValue(0.0);
 }
@@ -51,13 +51,13 @@ ControlDoublePrivate::ControlDoublePrivate(
         double defaultValue)
         : m_key(key),
           m_pCreatorCO(pCreatorCO),
-          m_bPersistInConfiguration(bPersist),
-          m_bIgnoreNops(bIgnoreNops),
-          m_bTrack(bTrack),
           m_trackType(Stat::UNSPECIFIED),
           m_trackFlags(Stat::COUNT | Stat::SUM | Stat::AVERAGE |
                   Stat::SAMPLE_VARIANCE | Stat::MIN | Stat::MAX),
+          m_bTrack(bTrack),
           m_confirmRequired(false),
+          m_bPersistInConfiguration(bPersist),
+          m_bIgnoreNops(bIgnoreNops),
           m_kbdRepeatable(false) {
     initialize(defaultValue);
 }

src/control/control.h

@@ -183,8 +183,31 @@ class ControlDoublePrivate : public QObject {
 
     const ConfigKey m_key;
 
+    QSharedPointer<ControlNumericBehavior> m_pBehavior;
+
+    // User-visible, i18n name for what the control is.
+    QString m_name;
+
+    // User-visible, i18n description for what the control does.
+    QString m_description;
+
+    // The control value.
+    ControlValueAtomic<double> m_value;
+    // The default control value.
+    ControlValueAtomic<double> m_defaultValue;
+
     QAtomicPointer<ControlObject> m_pCreatorCO;
 
+    QString m_trackKey;
+
+    // Note: keep the order of the members below to not introduce gaps due to
+    // memory alignment in this often used class. Whether to track value changes
+    // with the stats framework.
+    int m_trackType;
+    int m_trackFlags;
+    bool m_bTrack;
+    bool m_confirmRequired;
+
     // Whether the control should persist in the Mixxx user configuration. The
     // value is loaded from configuration when the control is created and
     // written to the configuration when the control is deleted.
@@ -193,28 +216,10 @@ class ControlDoublePrivate : public QObject {
     // Whether to ignore sets which would have no effect.
     bool m_bIgnoreNops;
 
-    // Whether to track value changes with the stats framework.
-    bool m_bTrack;
-    QString m_trackKey;
-    int m_trackType;
-    int m_trackFlags;
-    bool m_confirmRequired;
-
-    // User-visible, i18n name for what the control is.
-    QString m_name;
-
-    // User-visible, i18n description for what the control does.
-    QString m_description;
 
     // If true, this control will be issued repeatedly if the keyboard key is held.
     bool m_kbdRepeatable;
 
-    // The control value.
-    ControlValueAtomic<double> m_value;
-    // The default control value.
-    ControlValueAtomic<double> m_defaultValue;
-
-    QSharedPointer<ControlNumericBehavior> m_pBehavior;
 };
 
 /// The constant ControlDoublePrivate version is used as dummy for default

src/control/controlbehavior.cpp

@@ -342,8 +342,8 @@ double ControlLinSteppedIntPotBehavior::parameterToValue(double dParam) {
 const int ControlPushButtonBehavior::kPowerWindowTimeMillis = 300;
 const int ControlPushButtonBehavior::kLongPressLatchingTimeMillis = 300;
 
-ControlPushButtonBehavior::ControlPushButtonBehavior(ButtonMode buttonMode,
-                                                     int iNumStates)
+ControlPushButtonBehavior::ControlPushButtonBehavior(mixxx::control::ButtonMode buttonMode,
+        int iNumStates)
         : m_buttonMode(buttonMode),
           m_iNumStates(iNumStates) {
 }
@@ -364,7 +364,7 @@ void ControlPushButtonBehavior::setValueFromMidi(
     }
 
     // This block makes push-buttons act as power window buttons.
-    if (m_buttonMode == POWERWINDOW && m_iNumStates == 2) {
+    if (m_buttonMode == mixxx::control::ButtonMode::PowerWindow && m_iNumStates == 2) {
         auto* timer = getTimer();
         if (pressed) {
             // Toggle on press
@@ -376,7 +376,8 @@ void ControlPushButtonBehavior::setValueFromMidi(
             // Disable after releasing a long press
             pControl->set(0., nullptr);
         }
-    } else if (m_buttonMode == TOGGLE || m_buttonMode == LONGPRESSLATCHING) {
+    } else if (m_buttonMode == mixxx::control::ButtonMode::Toggle ||
+            m_buttonMode == mixxx::control::ButtonMode::LongPressLatching) {
         // This block makes push-buttons act as toggle buttons.
         if (m_iNumStates > 1) { // multistate button
             if (pressed) {
@@ -387,14 +388,14 @@ void ControlPushButtonBehavior::setValueFromMidi(
                 double value = pControl->get();
                 value = (int)(value + 1.) % m_iNumStates;
                 pControl->set(value, nullptr);
-                if (m_buttonMode == LONGPRESSLATCHING) {
+                if (m_buttonMode == mixxx::control::ButtonMode::LongPressLatching) {
                     auto* timer = getTimer();
                     timer->setSingleShot(true);
                     timer->start(kLongPressLatchingTimeMillis);
                 }
             } else {
                 double value = pControl->get();
-                if (m_buttonMode == LONGPRESSLATCHING &&
+                if (m_buttonMode == mixxx::control::ButtonMode::LongPressLatching &&
                         getTimer()->isActive() && value >= 1.) {
                     // revert toggle if button is released too early
                     value = (int)(value - 1.) % m_iNumStates;

src/control/controlbehavior.h

@@ -1,8 +1,9 @@
 #pragma once
 
-#include <QTimer>
 #include <QScopedPointer>
+#include <QTimer>
 
+#include "control/controlbuttonmode.h"
 #include "controllers/midi/midimessage.h"
 
 class ControlDoublePrivate;
@@ -130,17 +131,7 @@ class ControlPushButtonBehavior : public ControlNumericBehavior {
     static const int kPowerWindowTimeMillis;
     static const int kLongPressLatchingTimeMillis;
 
-    // TODO(XXX) Duplicated from ControlPushButton. It's complicated and
-    // annoying to share them so I just copied them.
-    enum ButtonMode {
-         PUSH = 0,
-         TOGGLE,
-         POWERWINDOW,
-         LONGPRESSLATCHING,
-         TRIGGER
-    };
-
-    ControlPushButtonBehavior(ButtonMode buttonMode, int iNumStates);
+    ControlPushButtonBehavior(mixxx::control::ButtonMode buttonMode, int iNumStates);
     void setValueFromMidi(
             MidiOpCode o, double dParam, ControlDoublePrivate* pControl)
                 override;
@@ -154,7 +145,7 @@ class ControlPushButtonBehavior : public ControlNumericBehavior {
         }
         return m_pushTimer.data();
     }
-    ButtonMode m_buttonMode;
+    mixxx::control::ButtonMode m_buttonMode;
     int m_iNumStates;
     QScopedPointer<QTimer> m_pushTimer;
 };

src/control/controlbuttonmode.h

@@ -0,0 +1,23 @@
+#pragma once
+
+// required for Qt-Macros
+#include <qobjectdefs.h>
+
+namespace mixxx {
+
+namespace control {
+
+Q_NAMESPACE
+
+enum class ButtonMode {
+    Push,
+    Toggle,
+    PowerWindow,
+    LongPressLatching,
+    Trigger
+};
+
+Q_ENUM_NS(ButtonMode);
+
+} // namespace control
+} // namespace mixxx

src/control/controlmodel.cpp

@@ -20,6 +20,9 @@ ControlModel::ControlModel(QObject* pParent)
 
     QSet<ConfigKey> controlKeys;
 
+    // Reserve memory for m_controls, which will be used later in addControl
+    m_controls.reserve(controlsList.size());
+
     for (const QSharedPointer<ControlDoublePrivate>& pControl : controlsList) {
         if (!pControl) {
             continue;

src/control/controlpushbutton.cpp

@@ -8,39 +8,50 @@
    -------- ------------------------------------------------------ */
 ControlPushButton::ControlPushButton(const ConfigKey& key, bool bPersist, double defaultValue)
         : ControlObject(key, false, false, bPersist, defaultValue),
-          m_buttonMode(PUSH),
+          m_buttonMode(mixxx::control::ButtonMode::Push),
           m_iNoStates(2) {
-    if (m_pControl) {
-        m_pControl->setBehavior(
-                new ControlPushButtonBehavior(
-                        static_cast<ControlPushButtonBehavior::ButtonMode>(m_buttonMode),
-                        m_iNoStates));
+    updateBehavior();
+}
+
+ControlPushButton::~ControlPushButton() = default;
+
+void ControlPushButton::setButtonMode(mixxx::control::ButtonMode mode) {
+    if (m_buttonMode != mode) {
+        m_buttonMode = mode;
+        updateBehavior();
     }
 }
 
-ControlPushButton::~ControlPushButton() {
+void ControlPushButton::setStates(int num_states) {
+    if (m_iNoStates != num_states) {
+        m_iNoStates = num_states;
+        updateBehavior();
+    }
 }
 
-// Tell this PushButton how to act on rising and falling edges
-void ControlPushButton::setButtonMode(enum ButtonMode mode) {
-    //qDebug() << "Setting " << m_Key.group << m_Key.item << "as toggle";
-    m_buttonMode = mode;
+void ControlPushButton::setBehavior(mixxx::control::ButtonMode mode, int num_states) {
+    bool shouldUpdate = false;
+    if (m_buttonMode != mode) {
+        m_buttonMode = mode;
+        shouldUpdate = true;
+    }
+    if (m_iNoStates != num_states) {
+        m_iNoStates = num_states;
+        shouldUpdate = true;
+    }
+
+    // If we would update unconditional, the state would be set always to the default value
+    if (shouldUpdate) {
+        updateBehavior();
+    }
+}
 
+// private
+void ControlPushButton::updateBehavior() {
     if (m_pControl) {
         m_pControl->setBehavior(
                 new ControlPushButtonBehavior(
-                        static_cast<ControlPushButtonBehavior::ButtonMode>(m_buttonMode),
+                        m_buttonMode,
                         m_iNoStates));
     }
 }
-
-void ControlPushButton::setStates(int num_states) {
-    m_iNoStates = num_states;
-
-    if (m_pControl) {
-            m_pControl->setBehavior(
-                    new ControlPushButtonBehavior(
-                            static_cast<ControlPushButtonBehavior::ButtonMode>(m_buttonMode),
-                            m_iNoStates));
-    }
-}

src/control/controlpushbutton.h

@@ -1,69 +1,40 @@
-/***************************************************************************
-                          controlpushbutton.h  -  description
-                             -------------------
-    begin                : Wed Feb 20 2002
-    copyright            : (C) 2002 by Tue and Ken Haste Andersen
-    email                :
- ***************************************************************************/
-
-/***************************************************************************
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- ***************************************************************************/
-
-#ifndef CONTROLPUSHBUTTON_H
-#define CONTROLPUSHBUTTON_H
+#pragma once
 
+#include "control/controlbuttonmode.h"
 #include "control/controlobject.h"
 
-/**
-  *@author Tue and Ken Haste Andersen
-  */
-
 class ControlPushButton : public ControlObject {
     Q_OBJECT
   public:
-    enum ButtonMode {
-         PUSH = 0,
-         TOGGLE,
-         POWERWINDOW,
-         LONGPRESSLATCHING,
-         TRIGGER,
-    };
-
-    static QString buttonModeToString(int mode) {
-        switch(mode) {
-            case ControlPushButton::PUSH:
-                return "PUSH";
-            case ControlPushButton::TOGGLE:
-                return "TOGGLE";
-            case ControlPushButton::POWERWINDOW:
-                return "POWERWINDOW";
-            case ControlPushButton::LONGPRESSLATCHING:
-                return "LONGPRESSLATCHING";
-            case ControlPushButton::TRIGGER:
-                return "TRIGGER";
-            default:
-                return "UNKNOWN";
+    static QString buttonModeToString(mixxx::control::ButtonMode buttonMode) {
+        switch (buttonMode) {
+        case mixxx::control::ButtonMode::Push:
+            return QStringLiteral("Push");
+        case mixxx::control::ButtonMode::Toggle:
+            return QStringLiteral("Toggle");
+        case mixxx::control::ButtonMode::PowerWindow:
+            return QStringLiteral("PowerWindow");
+        case mixxx::control::ButtonMode::LongPressLatching:
+            return QStringLiteral("LongPressLatching");
+        case mixxx::control::ButtonMode::Trigger:
+            return QStringLiteral("Trigger");
         }
+        DEBUG_ASSERT(false);
+        return "Unknown";
     }
 
     ControlPushButton(const ConfigKey& key, bool bPersist = false, double defaultValue = 0.0);
     virtual ~ControlPushButton();
 
-    inline ButtonMode getButtonMode() const {
+    inline mixxx::control::ButtonMode getButtonMode() const {
         return m_buttonMode;
     }
-    void setButtonMode(enum ButtonMode mode);
+    void setButtonMode(mixxx::control::ButtonMode mode);
     void setStates(int num_states);
+    void setBehavior(mixxx::control::ButtonMode mode, int num_states);
 
   private:
-    enum ButtonMode m_buttonMode;
+    void updateBehavior();
+    enum mixxx::control::ButtonMode m_buttonMode;
     int m_iNoStates;
 };
-
-#endif