Enable setting hotcue color via controlobject

build/depends.py

@@ -1225,6 +1225,7 @@ def sources(self, build):
                    "src/util/widgetrendertimer.cpp",
                    "src/util/workerthread.cpp",
                    "src/util/workerthreadscheduler.cpp",
+                   "src/util/color/predefinedcolor.cpp"
                    ]
 
         proto_args = {

res/controllers/common-controller-scripts.js

@@ -442,6 +442,48 @@ bpm.tapButton = function(deck) {
 //     print("Script: BPM="+average+" setting to "+fRateScale);
 }
 
+// color - Basic Object used for convient interface with the hotcue_color ControlObjects
+color = {
+  // member should be set directly but only in the [0;255] range.
+  red: 0,
+  green: 0,
+  blue: 0,
+  alpha: 255,
+}
+
+
+/* -------- ------------------------------------------------------
+      color.fromCO
+   Purpose: Setter that splits the combined colors into their components
+            and sets the color components in the object
+   Input:   combined color value
+   Output:  -
+   -------- ------------------------------------------------------ */
+
+color.fromCO = function(color) {
+    this.alpha = color >> 24 & 0xFF;
+    this.red = color >> 16 & 0xFF;
+    this.green = color >> 8 & 0xFF;
+    this.blue = color & 0xFF;
+}
+/* -------- ------------------------------------------------------
+      color.toCO
+   Purpose: Combines the colors back into a single value that
+            that could be used to set the MixxxControl value
+   Input:   -
+   Output:  struct containing the color components
+   -------- ------------------------------------------------------ */
+color.toCO = function() {
+  // javascript objects don't have "access control" and this object
+  // doesn't provide setters (interaction is supposed to be done via direct access)
+  // so this getter function sanitizes the values on export.
+  return (this.alpha % 255) << 24 +
+         (this.red  % 255) << 16 +
+         (this.green % 255) << 8 +
+         this. blue % 255;
+}
+
+
 // ----------------- Common regular expressions --------------------------
 script.samplerRegEx = /^\[Sampler(\d+)\]$/
 script.channelRegEx = /^\[Channel(\d+)\]$/

src/engine/controls/cuecontrol.cpp

@@ -12,6 +12,7 @@
 #include "control/controlindicator.h"
 #include "vinylcontrol/defs_vinylcontrol.h"
 #include "util/sample.h"
+#include "util/color/color.h"
 
 // TODO: Convert these doubles to a standard enum
 // and convert elseif logic to switch statements
@@ -297,6 +298,7 @@ void CueControl::trackCuesUpdated() {
             } else {
                 // If the old hotcue is the same, then we only need to update
                 pControl->setPosition(pCue->getPosition());
+                pControl->setColor(pCue->getColor());
             }
             // Add the hotcue to the list of active hotcues
             active_hotcues.insert(hotcue);
@@ -1036,6 +1038,12 @@ HotcueControl::HotcueControl(QString group, int i)
     m_hotcueEnabled = new ControlObject(keyForControl(i, "enabled"));
     m_hotcueEnabled->setReadOnly();
 
+    // The id of the predefined color assigned to this color.
+    m_hotcueColor = new ControlObject(keyForControl(i, "color_id"));
+    connect(m_hotcueColor, SIGNAL(valueChanged(double)),
+            this, SLOT(slotHotcueColorChanged(double)),
+            Qt::DirectConnection);
+
     m_hotcueSet = new ControlPushButton(keyForControl(i, "set"));
     connect(m_hotcueSet, &ControlObject::valueChanged,
             this, &HotcueControl::slotHotcueSet,
@@ -1075,6 +1083,7 @@ HotcueControl::HotcueControl(QString group, int i)
 HotcueControl::~HotcueControl() {
     delete m_hotcuePosition;
     delete m_hotcueEnabled;
+    delete m_hotcueColor;
     delete m_hotcueSet;
     delete m_hotcueGoto;
     delete m_hotcueGotoAndPlay;
@@ -1117,6 +1126,11 @@ void HotcueControl::slotHotcuePositionChanged(double newPosition) {
     emit(hotcuePositionChanged(this, newPosition));
 }
 
+void HotcueControl::slotHotcueColorChanged(double newColorId) {
+    m_pCue->setColor(Color::predefinedColorSet.predefinedColorFromId(newColorId));
+    emit(hotcueColorChanged(this, newColorId));
+}
+
 double HotcueControl::getPosition() const {
     return m_hotcuePosition->get();
 }
@@ -1127,7 +1141,13 @@ void HotcueControl::setCue(CuePointer pCue) {
     // because we have a null check for valid data else where in the code
     m_pCue = pCue;
 }
+PredefinedColorPointer HotcueControl::getColor() const {
+    return Color::predefinedColorSet.predefinedColorFromId(m_hotcueColor->get());
+}
 
+void HotcueControl::setColor(PredefinedColorPointer newColor) {
+    m_hotcueColor->set(static_cast<double>(newColor->m_iId));
+}
 void HotcueControl::resetCue() {
     // clear pCue first because we have a null check for valid data else where
     // in the code

src/engine/controls/cuecontrol.h

@@ -30,6 +30,8 @@ class HotcueControl : public QObject {
     void setCue(CuePointer pCue);
     void resetCue();
     void setPosition(double position);
+    void setColor(PredefinedColorPointer newColor);
+    PredefinedColorPointer getColor() const;
 
     // Used for caching the preview state of this hotcue control.
     inline bool isPreviewing() {
@@ -54,6 +56,7 @@ class HotcueControl : public QObject {
     void slotHotcueActivatePreview(double v);
     void slotHotcueClear(double v);
     void slotHotcuePositionChanged(double newPosition);
+    void slotHotcueColorChanged(double newColorId);
 
   signals:
     void hotcueSet(HotcueControl* pHotcue, double v);
@@ -64,6 +67,7 @@ class HotcueControl : public QObject {
     void hotcueActivatePreview(HotcueControl* pHotcue, double v);
     void hotcueClear(HotcueControl* pHotcue, double v);
     void hotcuePositionChanged(HotcueControl* pHotcue, double newPosition);
+    void hotcueColorChanged(HotcueControl* pHotcue, double newColorId);
     void hotcuePlay(double v);
 
   private:
@@ -76,6 +80,7 @@ class HotcueControl : public QObject {
     // Hotcue state controls
     ControlObject* m_hotcuePosition;
     ControlObject* m_hotcueEnabled;
+    ControlObject* m_hotcueColor;
     // Hotcue button controls
     ControlObject* m_hotcueSet;
     ControlObject* m_hotcueGoto;

src/library/dao/cue.cpp

@@ -6,9 +6,9 @@
 
 #include "library/dao/cue.h"
 #include "util/assert.h"
+#include "util/color/color.h"
 
 namespace {
-    const QColor kDefaultColor = QColor("#FF0000");
     const QString kDefaultLabel = ""; // empty string, not null
 }
 
@@ -25,13 +25,13 @@ Cue::Cue(TrackId trackId)
           m_length(0.0),
           m_iHotCue(-1),
           m_label(kDefaultLabel),
-          m_color(kDefaultColor) {
+          m_color(Color::predefinedColorSet.noColor) {
     DEBUG_ASSERT(!m_label.isNull());
 }
 
 
 Cue::Cue(int id, TrackId trackId, Cue::CueType type, double position, double length,
-         int hotCue, QString label, QColor color)
+         int hotCue, QString label, PredefinedColorPointer color)
         : m_bDirty(false),
           m_iId(id),
           m_trackId(trackId),
@@ -138,12 +138,12 @@ void Cue::setLabel(const QString label) {
     emit(updated());
 }
 
-QColor Cue::getColor() const {
+PredefinedColorPointer Cue::getColor() const {
     QMutexLocker lock(&m_mutex);
     return m_color;
 }
 
-void Cue::setColor(const QColor color) {
+void Cue::setColor(const PredefinedColorPointer color) {
     QMutexLocker lock(&m_mutex);
     m_color = color;
     m_bDirty = true;

src/library/dao/cue.h

@@ -6,6 +6,7 @@
 #include <QColor>
 
 #include "track/trackid.h"
+#include "util/color/predefinedcolor.h"
 #include "util/memory.h"
 
 class CueDAO;
@@ -44,16 +45,16 @@ class Cue : public QObject {
     QString getLabel() const;
     void setLabel(QString label);
 
-    QColor getColor() const;
-    void setColor(QColor color);
+    PredefinedColorPointer getColor() const;
+    void setColor(PredefinedColorPointer color);
 
   signals:
     void updated();
 
   private:
     explicit Cue(TrackId trackId);
     Cue(int id, TrackId trackId, CueType type, double position, double length,
-        int hotCue, QString label, QColor color);
+        int hotCue, QString label, PredefinedColorPointer color);
     void setDirty(bool dirty);
     void setId(int id);
     void setTrackId(TrackId trackId);
@@ -68,7 +69,7 @@ class Cue : public QObject {
     double m_length;
     int m_iHotCue;
     QString m_label;
-    QColor m_color;
+    PredefinedColorPointer m_color;
 
     friend class Track;
     friend class CueDAO;

src/library/dao/cuedao.cpp

@@ -11,6 +11,8 @@
 #include "library/queryutil.h"
 #include "util/assert.h"
 #include "util/performancetimer.h"
+#include "util/color/color.h"
+#include "util/color/predefinedcolor.h"
 
 int CueDAO::cueCount() {
     qDebug() << "CueDAO::cueCount" << QThread::currentThread() << m_database.connectionName();
@@ -51,7 +53,8 @@ CuePointer CueDAO::cueFromRow(const QSqlQuery& query) const {
     int length = record.value(record.indexOf("length")).toInt();
     int hotcue = record.value(record.indexOf("hotcue")).toInt();
     QString label = record.value(record.indexOf("label")).toString();
-    QColor color = QColor::fromRgba(record.value(record.indexOf("color")).toInt());
+    int iColorId = record.value(record.indexOf("color")).toInt();
+    PredefinedColorPointer color = Color::predefinedColorSet.predefinedColorFromId(iColorId);
     CuePointer pCue(new Cue(id, trackId, (Cue::CueType)type,
                        position, length, hotcue, label, color));
     m_cues[id] = pCue;
@@ -145,7 +148,7 @@ bool CueDAO::saveCue(Cue* cue) {
         query.bindValue(":length", cue->getLength());
         query.bindValue(":hotcue", cue->getHotCue());
         query.bindValue(":label", cue->getLabel());
-        query.bindValue(":color", cue->getColor().rgba());
+        query.bindValue(":color", cue->getColor()->m_iId);
 
         if (query.exec()) {
             int id = query.lastInsertId().toInt();
@@ -173,7 +176,7 @@ bool CueDAO::saveCue(Cue* cue) {
         query.bindValue(":length", cue->getLength());
         query.bindValue(":hotcue", cue->getHotCue());
         query.bindValue(":label", cue->getLabel());
-        query.bindValue(":color", cue->getColor().rgba());
+        query.bindValue(":color", cue->getColor()->m_iId);
 
         if (query.exec()) {
             cue->setDirty(false);

src/library/dlgtrackinfo.cpp

@@ -1,6 +1,7 @@
 #include <QDesktopServices>
 #include <QtDebug>
 #include <QStringBuilder>
+#include <QComboBox>
 
 #include "util/desktophelper.h"
 #include "library/dlgtrackinfo.h"
@@ -12,9 +13,11 @@
 #include "track/keyfactory.h"
 #include "track/keyutils.h"
 #include "util/duration.h"
+#include "util/color/color.h"
 
 const int kFilterLength = 80;
 const int kMinBpm = 30;
+
 // Maximum allowed interval between beats (calculated from kMinBpm).
 const mixxx::Duration kMaxInterval = mixxx::Duration::fromMillis(1000.0 * (60.0 / kMinBpm));
 
@@ -274,7 +277,7 @@ void DlgTrackInfo::populateCues(TrackPointer pTrack) {
     QListIterator<CuePointer> it(cuePoints);
     while (it.hasNext()) {
         CuePointer pCue = it.next();
-        if (pCue->getType() == Cue::CUE || pCue->getType() == Cue::LOAD) {
+        if (pCue->getType() == Cue::CUE) {
             listPoints.push_back(pCue);
         }
     }
@@ -318,12 +321,30 @@ void DlgTrackInfo::populateCues(TrackPointer pTrack) {
         // Make the duration read only
         durationItem->setFlags(Qt::NoItemFlags);
 
+
+        QComboBox* colorComboBox = new QComboBox();
+        const QList<PredefinedColorPointer> predefinedColors = Color::predefinedColorSet.allColors;
+        for (int i = 0; i < predefinedColors.count(); i++) {
+            PredefinedColorPointer color = predefinedColors.at(i);
+            QColor defaultRgba = color->m_defaultRgba;
+            colorComboBox->addItem(color->m_sDisplayName, defaultRgba);
+            const QModelIndex idx = colorComboBox->model()->index(i, 0);
+            if (*color != *Color::predefinedColorSet.noColor) {
+                colorComboBox->model()->setData(idx, defaultRgba, Qt::BackgroundColorRole);
+            }
+            colorComboBox->setItemData(i, Color::chooseContrastColor(defaultRgba), Qt::TextColorRole);
+
+        }
+        PredefinedColorPointer cueColor = pCue->getColor();
+        colorComboBox->setCurrentIndex(Color::predefinedColorSet.predefinedColorIndex(cueColor));
+
         m_cueMap[row] = pCue;
         cueTable->insertRow(row);
         cueTable->setItem(row, 0, new QTableWidgetItem(rowStr));
         cueTable->setItem(row, 1, durationItem);
         cueTable->setItem(row, 2, new QTableWidgetItem(hotcue));
-        cueTable->setItem(row, 3, new QTableWidgetItem(pCue->getLabel()));
+        cueTable->setCellWidget(row, 3, colorComboBox);
+        cueTable->setItem(row, 4, new QTableWidgetItem(pCue->getLabel()));
         row += 1;
     }
     cueTable->setSortingEnabled(true);
@@ -367,10 +388,13 @@ void DlgTrackInfo::saveTrack() {
     for (int row = 0; row < cueTable->rowCount(); ++row) {
         QTableWidgetItem* rowItem = cueTable->item(row, 0);
         QTableWidgetItem* hotcueItem = cueTable->item(row, 2);
-        QTableWidgetItem* labelItem = cueTable->item(row, 3);
+        QWidget* colorWidget = cueTable->cellWidget(row, 3);
+        QTableWidgetItem* labelItem = cueTable->item(row, 4);
 
-        if (!rowItem || !hotcueItem || !labelItem)
+        VERIFY_OR_DEBUG_ASSERT(rowItem && hotcueItem && colorWidget && labelItem) {
+            qWarning() << "unable to retrieve cells from cueTable row";
             continue;
+        }
 
         int oldRow = rowItem->data(Qt::DisplayRole).toInt();
         CuePointer pCue(m_cueMap.value(oldRow, CuePointer()));
@@ -390,6 +414,13 @@ void DlgTrackInfo::saveTrack() {
             pCue->setHotCue(-1);
         }
 
+        auto colorComboBox = qobject_cast<QComboBox*>(colorWidget);
+        if (colorComboBox) {
+            PredefinedColorPointer color = Color::predefinedColorSet.allColors.at(colorComboBox->currentIndex());
+            pCue->setColor(color);
+        }
+        // do nothing for now.
+
         QString label = labelItem->data(Qt::DisplayRole).toString();
         pCue->setLabel(label);
     }
@@ -430,7 +461,6 @@ void DlgTrackInfo::unloadTrack(bool save) {
 }
 
 void DlgTrackInfo::clear() {
-
     disconnect(this, SLOT(updateTrackMetadata()));
     m_pLoadedTrack.reset();
 

src/library/dlgtrackinfo.ui

@@ -820,6 +820,11 @@ Often results in higher quality beatgrids, but will not do well on tracks that h
            <string>Hotcue</string>
           </property>
          </column>
+         <column>
+          <property name="text">
+           <string>Color</string>
+          </property>
+         </column>
          <column>
           <property name="text">
            <string>Label</string>