lp1100882: Add support for track colors

CMakeLists.txt

@@ -332,6 +332,7 @@ add_library(mixxx-lib STATIC EXCLUDE_FROM_ALL
   src/library/browse/browsetablemodel.cpp
   src/library/browse/browsethread.cpp
   src/library/browse/foldertreemodel.cpp
+  src/library/colordelegate.cpp
   src/library/columncache.cpp
   src/library/coverart.cpp
   src/library/coverartcache.cpp
@@ -634,6 +635,7 @@ add_library(mixxx-lib STATIC EXCLUDE_FROM_ALL
   src/widget/wbattery.cpp
   src/widget/wbeatspinbox.cpp
   src/widget/wcolorpicker.cpp
+  src/widget/wcolorpickeraction.cpp
   src/widget/wcombobox.cpp
   src/widget/wcoverart.cpp
   src/widget/wcoverartlabel.cpp

build/depends.py

@@ -991,6 +991,7 @@ def sources(self, build):
                    "src/widget/wcoverartlabel.cpp",
                    "src/widget/wcoverartmenu.cpp",
                    "src/widget/wcolorpicker.cpp",
+                   "src/widget/wcolorpickeraction.cpp",
                    "src/widget/wcuemenupopup.cpp",
                    "src/widget/wsingletoncontainer.cpp",
                    "src/widget/wmainmenubar.cpp",
@@ -1112,6 +1113,7 @@ def sources(self, build):
                    "src/library/stareditor.cpp",
                    "src/library/bpmdelegate.cpp",
                    "src/library/previewbuttondelegate.cpp",
+                   "src/library/colordelegate.cpp",
                    "src/library/coverartdelegate.cpp",
                    "src/library/locationdelegate.cpp",
                    "src/library/tableitemdelegate.cpp",

res/schema.xml

@@ -481,4 +481,12 @@ METADATA
         );
     </sql>
   </revision>
+  <revision version="31" min_compatible="3">
+    <description>
+      Add track color support.
+    </description>
+    <sql>
+      ALTER TABLE library ADD COLUMN color INTEGER;
+    </sql>
+  </revision>
 </schema>

res/skins/default.qss

@@ -30,6 +30,10 @@ WCueMenuPopup #CueDeleteButton {
   qproperty-icon: url(:/images/ic_delete.svg);
 }
 
+WColorPicker QPushButton[noColor="true"] {
+  background-color: black;
+}
+
 WColorPicker QPushButton[checked="false"] {
   qproperty-icon: none;
 }

src/database/mixxxdb.cpp

@@ -11,7 +11,7 @@
 const QString MixxxDb::kDefaultSchemaFile(":/schema.xml");
 
 //static
-const int MixxxDb::kRequiredSchemaVersion = 30;
+const int MixxxDb::kRequiredSchemaVersion = 31;
 
 namespace {
 

src/library/basesqltablemodel.cpp

@@ -7,6 +7,7 @@
 #include "library/basesqltablemodel.h"
 
 #include "library/bpmdelegate.h"
+#include "library/colordelegate.h"
 #include "library/coverartdelegate.h"
 #include "library/locationdelegate.h"
 #include "library/previewbuttondelegate.h"
@@ -118,6 +119,8 @@ void BaseSqlTableModel::initHeaderData() {
                         tr("Preview"), 50);
     setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_COVERART,
                         tr("Cover Art"), 90);
+    setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_COLOR,
+                        tr("Color"), 10);
     setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_REPLAYGAIN,
                         tr("ReplayGain"), 50);
     setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_SAMPLERATE,
@@ -150,6 +153,7 @@ void BaseSqlTableModel::initSortColumnMapping() {
     m_columnIndexBySortColumnId[TrackModel::SortColumnId::SORTCOLUMN_RATING] = fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_RATING);
     m_columnIndexBySortColumnId[TrackModel::SortColumnId::SORTCOLUMN_KEY] = fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_KEY);
     m_columnIndexBySortColumnId[TrackModel::SortColumnId::SORTCOLUMN_PREVIEW] = fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_PREVIEW);
+    m_columnIndexBySortColumnId[TrackModel::SortColumnId::SORTCOLUMN_COLOR] = fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COLOR);
     m_columnIndexBySortColumnId[TrackModel::SortColumnId::SORTCOLUMN_COVERART] = fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COVERART);
     m_columnIndexBySortColumnId[TrackModel::SortColumnId::SORTCOLUMN_SAMPLERATE] = fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_SAMPLERATE);
 
@@ -795,6 +799,8 @@ QVariant BaseSqlTableModel::data(const QModelIndex& index, int role) const {
                 if (value.canConvert(QMetaType::Int)) {
                     value = QVariant::fromValue(StarRating(value.toInt()));
                 }
+            } else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COLOR)) {
+                value = QString();
             }
             break;
         case Qt::CheckStateRole:
@@ -1135,6 +1141,8 @@ QAbstractItemDelegate* BaseSqlTableModel::delegateForColumn(const int i, QObject
         return new PreviewButtonDelegate(pTableView, i);
     } else if (i == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_NATIVELOCATION)) {
         return new LocationDelegate(pTableView);
+    } else if (i == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COLOR)) {
+        return new ColorDelegate(pTableView);
     } else if (i == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COVERART)) {
         CoverArtDelegate* pCoverDelegate = new CoverArtDelegate(pTableView);
         connect(pCoverDelegate,

src/library/basetrackcache.cpp

@@ -469,6 +469,8 @@ void BaseTrackCache::getTrackValueForColumn(TrackPointer pTrack,
         trackValue.setValue(static_cast<int>(pTrack->getKey()));
     } else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM_LOCK) == column) {
         trackValue.setValue(pTrack->isBpmLocked());
+    } else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COLOR) == column) {
+        trackValue.setValue(toQVariant(pTrack->getColor()));
     } else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COVERART_LOCATION) == column) {
         trackValue.setValue(pTrack->getCoverInfo().coverLocation);
     } else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COVERART_HASH) == column ||

src/library/colordelegate.cpp

@@ -0,0 +1,34 @@
+#include "library/colordelegate.h"
+
+#include <QColor>
+#include <QPainter>
+#include <QStyle>
+#include <QTableView>
+
+#include "library/trackmodel.h"
+#include "util/color/rgbcolor.h"
+
+ColorDelegate::ColorDelegate(QTableView* pTableView)
+        : TableItemDelegate(pTableView) {
+}
+
+void ColorDelegate::paintItem(QPainter* painter, const QStyleOptionViewItem& option, const QModelIndex& index) const {
+    const auto color = mixxx::RgbColor::optional(index.data());
+
+    if (!color) {
+        // Filter out track color that is hidden
+        if (option.state & QStyle::State_Selected) {
+            painter->fillRect(option.rect, option.palette.highlight());
+        }
+        return;
+    }
+
+    painter->fillRect(option.rect, toQColor(color));
+
+    // Paint transparent highlight if row is selected
+    if (option.state & QStyle::State_Selected) {
+        QColor highlightColor = option.palette.highlight().color();
+        highlightColor.setAlpha(0x60);
+        painter->fillRect(option.rect, highlightColor);
+    }
+}

src/library/colordelegate.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include <QModelIndex>
+#include <QPainter>
+#include <QStyleOptionViewItem>
+
+#include "library/tableitemdelegate.h"
+
+class ColorDelegate : public TableItemDelegate {
+    Q_OBJECT
+  public:
+    explicit ColorDelegate(QTableView* pTableView);
+
+    void paintItem(
+            QPainter* painter,
+            const QStyleOptionViewItem& option,
+            const QModelIndex& index) const override;
+};

src/library/columncache.cpp

@@ -61,6 +61,7 @@ void ColumnCache::setColumns(const QStringList& columns) {
     m_columnIndexByEnum[COLUMN_LIBRARYTABLE_KEY_ID] = fieldIndex(LIBRARYTABLE_KEY_ID);
     m_columnIndexByEnum[COLUMN_LIBRARYTABLE_BPM_LOCK] = fieldIndex(LIBRARYTABLE_BPM_LOCK);
     m_columnIndexByEnum[COLUMN_LIBRARYTABLE_PREVIEW] = fieldIndex(LIBRARYTABLE_PREVIEW);
+    m_columnIndexByEnum[COLUMN_LIBRARYTABLE_COLOR] = fieldIndex(LIBRARYTABLE_COLOR);
     m_columnIndexByEnum[COLUMN_LIBRARYTABLE_COVERART] = fieldIndex(LIBRARYTABLE_COVERART);
     m_columnIndexByEnum[COLUMN_LIBRARYTABLE_COVERART_SOURCE] = fieldIndex(LIBRARYTABLE_COVERART_SOURCE);
     m_columnIndexByEnum[COLUMN_LIBRARYTABLE_COVERART_TYPE] = fieldIndex(LIBRARYTABLE_COVERART_TYPE);

src/library/columncache.h

@@ -49,6 +49,7 @@ class ColumnCache : public QObject {
         COLUMN_LIBRARYTABLE_KEY_ID,
         COLUMN_LIBRARYTABLE_BPM_LOCK,
         COLUMN_LIBRARYTABLE_PREVIEW,
+        COLUMN_LIBRARYTABLE_COLOR,
         COLUMN_LIBRARYTABLE_COVERART,
         COLUMN_LIBRARYTABLE_COVERART_SOURCE,
         COLUMN_LIBRARYTABLE_COVERART_TYPE,

src/library/dao/trackdao.cpp

@@ -444,7 +444,7 @@ void TrackDAO::addTracksPrepare() {
     m_pQueryLibraryInsert->prepare("INSERT INTO library "
             "("
             "artist,title,album,album_artist,year,genre,tracknumber,tracktotal,composer,"
-            "grouping,filetype,location,comment,url,duration,rating,key,key_id,"
+            "grouping,filetype,location,color,comment,url,duration,rating,key,key_id,"
             "bitrate,samplerate,cuepoint,bpm,replaygain,replaygain_peak,wavesummaryhex,"
             "timesplayed,channels,mixxx_deleted,header_parsed,"
             "beats_version,beats_sub_version,beats,bpm_lock,"
@@ -453,7 +453,7 @@ void TrackDAO::addTracksPrepare() {
             "datetime_added"
             ") VALUES ("
             ":artist,:title,:album,:album_artist,:year,:genre,:tracknumber,:tracktotal,:composer,"
-            ":grouping,:filetype,:location,:comment,:url,:duration,:rating,:key,:key_id,"
+            ":grouping,:filetype,:location,:color,:comment,:url,:duration,:rating,:key,:key_id,"
             ":bitrate,:samplerate,:cuepoint,:bpm,:replaygain,:replaygain_peak,:wavesummaryhex,"
             ":timesplayed,:channels,:mixxx_deleted,:header_parsed,"
             ":beats_version,:beats_sub_version,:beats,:bpm_lock,"
@@ -520,6 +520,7 @@ namespace {
         pTrackLibraryQuery->bindValue(":tracknumber", track.getTrackNumber());
         pTrackLibraryQuery->bindValue(":tracktotal", track.getTrackTotal());
         pTrackLibraryQuery->bindValue(":filetype", track.getType());
+        pTrackLibraryQuery->bindValue(":color", toQVariant(track.getColor()));
         pTrackLibraryQuery->bindValue(":comment", track.getComment());
         pTrackLibraryQuery->bindValue(":url", track.getURL());
         pTrackLibraryQuery->bindValue(":duration", track.getDuration());
@@ -1039,6 +1040,12 @@ bool setTrackTotal(const QSqlRecord& record, const int column,
     return false;
 }
 
+bool setTrackColor(const QSqlRecord& record, const int column,
+                   TrackPointer pTrack) {
+    pTrack->setColor(mixxx::RgbColor::optional(record.value(column)));
+    return false;
+}
+
 bool setTrackComment(const QSqlRecord& record, const int column,
                      TrackPointer pTrack) {
     pTrack->setComment(record.value(column).toString());
@@ -1236,6 +1243,7 @@ TrackPointer TrackDAO::getTrackById(TrackId trackId) const {
         { "tracktotal", setTrackTotal },
         { "filetype", setTrackFiletype },
         { "rating", setTrackRating },
+        { "color", setTrackColor },
         { "comment", setTrackComment },
         { "url", setTrackUrl },
         { "duration", setTrackDuration },
@@ -1465,6 +1473,7 @@ bool TrackDAO::updateTrack(Track* pTrack) {
             "filetype=:filetype,"
             "tracknumber=:tracknumber,"
             "tracktotal=:tracktotal,"
+            "color=:color,"
             "comment=:comment,"
             "url=:url,"
             "duration=:duration,"

src/library/dao/trackschema.h

@@ -37,6 +37,7 @@ const QString LIBRARYTABLE_KEY = "key";
 const QString LIBRARYTABLE_KEY_ID = "key_id";
 const QString LIBRARYTABLE_BPM_LOCK = "bpm_lock";
 const QString LIBRARYTABLE_PREVIEW = "preview";
+const QString LIBRARYTABLE_COLOR = "color";
 const QString LIBRARYTABLE_COVERART = "coverart";
 const QString LIBRARYTABLE_COVERART_SOURCE = "coverart_source";
 const QString LIBRARYTABLE_COVERART_TYPE = "coverart_type";

src/library/mixxxlibraryfeature.cpp

@@ -60,6 +60,7 @@ MixxxLibraryFeature::MixxxLibraryFeature(Library* pLibrary,
             << "track_locations.fs_deleted"
             << "library." + LIBRARYTABLE_COMMENT
             << "library." + LIBRARYTABLE_MIXXXDELETED
+            << "library." + LIBRARYTABLE_COLOR
             << "library." + LIBRARYTABLE_COVERART_SOURCE
             << "library." + LIBRARYTABLE_COVERART_TYPE
             << "library." + LIBRARYTABLE_COVERART_LOCATION

src/library/trackmodel.h

@@ -80,6 +80,7 @@ class TrackModel {
         SORTCOLUMN_FILE_MODIFIED_TIME,
         SORTCOLUMN_FILE_CREATION_TIME,
         SORTCOLUMN_SAMPLERATE,
+        SORTCOLUMN_COLOR,
 
         // NUM_SORTCOLUMNS should always be the last item.
         NUM_SORTCOLUMNIDS

src/track/track.cpp

@@ -532,6 +532,18 @@ void Track::updatePlayCounter(bool bPlayed) {
     }
 }
 
+mixxx::RgbColor::optional_t Track::getColor() const {
+    QMutexLocker lock(&m_qMutex);
+    return m_record.getColor();
+}
+
+void Track::setColor(mixxx::RgbColor::optional_t color) {
+    QMutexLocker lock(&m_qMutex);
+    if (compareAndSet(&m_record.refColor(), color)) {
+        markDirtyAndUnlock(&lock);
+    }
+}
+
 QString Track::getComment() const {
     QMutexLocker lock(&m_qMutex);
     return m_record.getMetadata().getTrackInfo().getComment();

src/track/track.h

@@ -189,6 +189,10 @@ class Track : public QObject {
     QString getGenre() const;
     // Set genre
     void setGenre(const QString&);
+    // Returns the track color
+    mixxx::RgbColor::optional_t getColor() const;
+    // Sets the track color
+    void setColor(mixxx::RgbColor::optional_t);
     // Returns the user comment
     QString getComment() const;
     // Sets the user commnet

src/track/trackrecord.h

@@ -10,6 +10,7 @@
 #include "track/playcounter.h"
 
 #include "library/coverart.h"
+#include "util/color/rgbcolor.h"
 
 
 namespace mixxx {
@@ -44,6 +45,7 @@ class TrackRecord final {
     PROPERTY_SET_BYVAL_GET_BYREF(QString,     fileType,       FileType)
     PROPERTY_SET_BYVAL_GET_BYREF(QString,     url,            Url)
     PROPERTY_SET_BYVAL_GET_BYREF(PlayCounter, playCounter,    PlayCounter)
+    PROPERTY_SET_BYVAL_GET_BYREF(RgbColor::optional_t, color, Color)
     PROPERTY_SET_BYVAL_GET_BYREF(CuePosition, cuePoint,       CuePoint)
     PROPERTY_SET_BYVAL_GET_BYREF(int,         rating,         Rating)
     PROPERTY_SET_BYVAL_GET_BYREF(bool,        bpmLocked,      BpmLocked)

src/widget/wcolorpicker.cpp

@@ -12,7 +12,7 @@ namespace {
     const int kNumColumns = 4;
 }
 
-WColorPicker::WColorPicker(QWidget* parent)
+WColorPicker::WColorPicker(ColorOption colorOption, QWidget* parent)
         : QWidget(parent) {
     QGridLayout* pLayout = new QGridLayout();
     pLayout->setMargin(0);
@@ -34,7 +34,8 @@ WColorPicker::WColorPicker(QWidget* parent)
     int row = 0;
     int column = 0;
     for (const auto& pColor : Color::kPredefinedColorsSet.allColors) {
-        if (*pColor == *Color::kPredefinedColorsSet.noColor) {
+        if (colorOption != ColorOption::AllowNoColor &&
+                pColor == Color::kPredefinedColorsSet.noColor) {
             continue;
         }
 
@@ -43,10 +44,14 @@ WColorPicker::WColorPicker(QWidget* parent)
             pColorButton->setStyle(m_pStyle);
         }
 
-        // Set the background color of the button. This can't be overridden in skin stylesheets.
-        pColorButton->setStyleSheet(
-            QString("QPushButton { background-color: #%1; }").arg(pColor->m_defaultRgba.rgb(), 6, 16, QChar('0'))
-        );
+        if (pColor->m_defaultRgba.isValid()) {
+            // Set the background color of the button. This can't be overridden in skin stylesheets.
+            pColorButton->setStyleSheet(
+                    QString("QPushButton { background-color: #%1; }").arg(pColor->m_defaultRgba.rgb(), 6, 16, QChar('0'))
+            );
+        } else {
+            pColorButton->setProperty("noColor", true);
+        }
 
         pColorButton->setToolTip(pColor->m_sDisplayName);
         pColorButton->setCheckable(true);
@@ -59,9 +64,16 @@ WColorPicker::WColorPicker(QWidget* parent)
             row++;
         }
 
-        connect(pColorButton, &QPushButton::clicked, this, [pColor, this]() {
-            emit colorPicked(pColor);
-        });
+        connect(this,
+                &WColorPicker::colorPicked,
+                this,
+                &WColorPicker::slotColorPicked);
+        connect(pColorButton,
+                &QPushButton::clicked,
+                this,
+                [pColor, this]() {
+                    emit colorPicked(pColor);
+                });
     }
     setLayout(pLayout);
 }
@@ -106,3 +118,8 @@ void WColorPicker::useColorSet(PredefinedColorsRepresentation* pColorRepresentat
         pColorButton->setToolTip(pColor->m_sDisplayName);
     }
 }
+
+
+void WColorPicker::slotColorPicked(PredefinedColorPointer pColor) {
+    setSelectedColor(pColor);
+}