[WIP] Enable Setting hotcue color via controlobject

res/controllers/common-controller-scripts.js

@@ -413,6 +413,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/cuecontrol.cpp

@@ -299,6 +299,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);
@@ -1018,6 +1019,14 @@ HotcueControl::HotcueControl(QString group, int i)
     m_hotcueEnabled = new ControlObject(keyForControl(i, "enabled"));
     m_hotcueEnabled->setReadOnly();
 
+    // NOTE(Swiftb0y): since ControlObjects only deal with double values,
+    // the Color is stored as a QRgb (which is just a unsigned int
+    // representation of the color (AARRGGBB)
+    m_hotcueColor = new ControlObject(keyForControl(i, "color"));
+    connect(m_hotcueColor, SIGNAL(valueChanged(double)),
+            this, SLOT(slotHotcueColorChanged(double)),
+            Qt::DirectConnection);
+
     m_hotcueSet = new ControlPushButton(keyForControl(i, "set"));
     connect(m_hotcueSet, SIGNAL(valueChanged(double)),
             this, SLOT(slotHotcueSet(double)),
@@ -1057,6 +1066,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;
@@ -1099,6 +1109,11 @@ void HotcueControl::slotHotcuePositionChanged(double newPosition) {
     emit(hotcuePositionChanged(this, newPosition));
 }
 
+void HotcueControl::slotHotcueColorChanged(double newColor) {
+    m_pCue->setColor(QColor(static_cast<QRgb>(newColor)));
+    emit(hotcueColorChanged(this, newColor));
+}
+
 double HotcueControl::getPosition() const {
     return m_hotcuePosition->get();
 }
@@ -1109,7 +1124,16 @@ void HotcueControl::setCue(CuePointer pCue) {
     // because we have a null check for valid data else where in the code
     m_pCue = pCue;
 }
+QColor HotcueControl::getColor() const {
+    // QRgb is just an unsigned int  representation of the
+    // color components (AARRGGBB) so conversion
+    // from double shouldn't be an issue
+    return QColor::fromRgb(static_cast<QRgb>(m_hotcueColor->get()));
+}
 
+void HotcueControl::setColor(QColor newColor) {
+    m_hotcueColor->set(static_cast<double>(newColor.rgb()));
+}
 void HotcueControl::resetCue() {
     // clear pCue first because we have a null check for valid data else where
     // in the code

src/engine/cuecontrol.h

@@ -30,6 +30,8 @@ class HotcueControl : public QObject {
     void setCue(CuePointer pCue);
     void resetCue();
     void setPosition(double position);
+    void setColor(QColor newColor);
+    QColor 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 newColor);
 
   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 newColor);
     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/dlgtrackinfo.cpp

@@ -1,6 +1,7 @@
 #include <QDesktopServices>
 #include <QtDebug>
 #include <QStringBuilder>
+#include <QComboBox>
 
 #include "library/dlgtrackinfo.h"
 #include "sources/soundsourceproxy.h"
@@ -11,9 +12,11 @@
 #include "track/keyfactory.h"
 #include "track/keyutils.h"
 #include "util/duration.h"
+#include "util/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));
 
@@ -332,12 +335,30 @@ void DlgTrackInfo::populateCues(TrackPointer pTrack) {
         // Make the duration read only
         durationItem->setFlags(Qt::NoItemFlags);
 
+
+        QComboBox* colorComboBox = new QComboBox();
+        const QList<QColor>& predefinedColors = Color::predefinedColors;
+        for (int i = 0; i < predefinedColors.count(); i++) {
+            QColor color = predefinedColors.at(i);
+            colorComboBox->addItem(Color::displayName(color), color);
+            const QModelIndex idx = colorComboBox->model()->index(i, 0);
+            colorComboBox->model()->setData(idx, color, Qt::BackgroundColorRole);
+            colorComboBox->setItemData(i, Color::chooseContrastColor(color), Qt::TextColorRole);
+
+        }
+        const QColor cueColor = pCue->getColor();
+        colorComboBox->setCurrentIndex(predefinedColors.contains(cueColor)
+                ? predefinedColors.indexOf(cueColor)
+                : 0);
+
         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->setItem(row, 3, new QTableWidgetItem(cueColor.name().toUpper()));
+        cueTable->setCellWidget(row, 3, colorComboBox);
+        cueTable->setItem(row, 4, new QTableWidgetItem(pCue->getLabel()));
         row += 1;
     }
     cueTable->setSortingEnabled(true);
@@ -381,10 +402,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()));
@@ -404,6 +428,15 @@ void DlgTrackInfo::saveTrack() {
             pCue->setHotCue(-1);
         }
 
+        auto colorComboBox = qobject_cast<QComboBox*>(colorWidget);
+        if (colorComboBox) {
+            QColor color = Color::predefinedColors.at(colorComboBox->currentIndex());
+            if (color.isValid()) {
+                pCue->setColor(color);
+            }
+        }
+        // do nothing for now.
+
         QString label = labelItem->data(Qt::DisplayRole).toString();
         pCue->setLabel(label);
     }
@@ -444,7 +477,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>

src/skin/skincontext.h

@@ -14,6 +14,7 @@
 
 #include "preferences/usersettings.h"
 #include "skin/pixmapsource.h"
+#include "util/color.h"
 #include "widget/wsingletoncontainer.h"
 #include "widget/wpixmapstore.h"
 
@@ -266,6 +267,18 @@ class SkinContext {
         return m_scaleFactor;
     }
 
+    ColorsRepresentation getCueColorsRepresentation(const QDomNode& node) const {
+        ColorsRepresentation colorsReprsentation = Color::defaultRepresentation;
+        for (QLatin1String colorName : Color::predefinedColorsNames) {
+            QColor representation = selectColor(node, "Cue" + colorName);
+            if (representation.isValid()) {
+                QColor originalColor = Color::predefinedColorFromName(colorName);
+                colorsReprsentation.setRepresentation(originalColor, representation);
+            }
+        }
+        return colorsReprsentation;
+    }
+
   private:
     PixmapSource getPixmapSourceInner(const QString& filename) const;