add catalogue number library column and metadata support

implements support for catalogue number metadata field and library column:
- adds CatalogueNumber property to AlbumInfo (always enabled, not behind __EXTRA_METADATA__)
- adds database schema migration (revision 41) for catalogue_number column
- implements tag reading/writing for ID3v2 (TXXX:CATALOGNUMBER), Vorbis (CATALOGNUMBER), MP4 (----:com.apple.iTunes:CATALOGNUMBER), and APEv2 (CatalogNumber)
- adds Track getter/setter methods for catalogue number
- updates TrackDAO for database persistence (INSERT, UPDATE, SELECT)
- adds library column with sorting and display support
- column is editable in library view

uses existing TagLib wrapper functions and Mixxx metadata infrastructure. follows MusicBrainz Picard tag mapping conventions for catalogue number field.

Fixes #12583

Author: Milkii Brewster

res/schema.xml

@@ -593,4 +593,12 @@ reapplying those migrations.
       ALTER TABLE library ADD COLUMN tuning_frequency_hz FLOAT DEFAULT 0.0;
     </sql>
   </revision>
+  <revision version="41" min_compatible="3">
+    <description>
+      Add catalogue_number column to library table.
+    </description>
+    <sql>
+      ALTER TABLE library ADD COLUMN catalogue_number TEXT DEFAULT '';
+    </sql>
+  </revision>
 </schema>

src/database/mixxxdb.cpp

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

src/library/basesqltablemodel.cpp

@@ -722,6 +722,8 @@ bool BaseSqlTableModel::setTrackValueForColumn(
         pTrack->setAlbum(value.toString());
     } else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_ALBUMARTIST) == column) {
         pTrack->setAlbumArtist(value.toString());
+    } else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_CATALOGUENUMBER) == column) {
+        pTrack->setCatalogueNumber(value.toString());
     } else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_YEAR) == column) {
         pTrack->setYear(value.toString());
     } else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_GENRE) == column) {

src/library/columncache.cpp

@@ -164,6 +164,9 @@ constexpr ColumnProperties kColumnPropertiesByEnum[] = {
         DI(ColumnCache::COLUMN_LIBRARYTABLE_LAST_PLAYED_AT){&LIBRARYTABLE_LAST_PLAYED_AT,
                 QT_TRANSLATE_NOOP("BaseTrackTableModel", "Last Played"),
                 kDefaultColumnWidth * 3},
+        DI(ColumnCache::COLUMN_LIBRARYTABLE_CATALOGUENUMBER){&LIBRARYTABLE_CATALOGUENUMBER,
+                QT_TRANSLATE_NOOP("BaseTrackTableModel", "Catalogue #"),
+                kDefaultColumnWidth * 2},
         DI(ColumnCache::COLUMN_TRACKLOCATIONSTABLE_LOCATION){&TRACKLOCATIONSTABLE_LOCATION,
                 QT_TRANSLATE_NOOP("BaseTrackTableModel", "Location"),
                 kDefaultColumnWidth * 6},

src/library/columncache.h

@@ -58,6 +58,7 @@ class ColumnCache : public QObject {
         COLUMN_LIBRARYTABLE_COVERART_DIGEST,
         COLUMN_LIBRARYTABLE_COVERART_HASH,
         COLUMN_LIBRARYTABLE_LAST_PLAYED_AT,
+        COLUMN_LIBRARYTABLE_CATALOGUENUMBER,
 
         COLUMN_TRACKLOCATIONSTABLE_LOCATION,
         COLUMN_TRACKLOCATIONSTABLE_DIRECTORY,

src/library/dao/trackdao.cpp

@@ -442,6 +442,7 @@ void TrackDAO::addTracksPrepare() {
             "title,"
             "album,"
             "album_artist,"
+            "catalogue_number,"
             "year,"
             "genre,"
             "tracknumber,"
@@ -491,6 +492,7 @@ void TrackDAO::addTracksPrepare() {
             ":title,"
             ":album,"
             ":album_artist,"
+            ":catalogue_number,"
             ":year,"
             ":genre,"
             ":tracknumber,"
@@ -597,6 +599,7 @@ void bindTrackLibraryValues(
     pTrackLibraryQuery->bindValue(":title", trackInfo.getTitle());
     pTrackLibraryQuery->bindValue(":album", albumInfo.getTitle());
     pTrackLibraryQuery->bindValue(":album_artist", albumInfo.getArtist());
+    pTrackLibraryQuery->bindValue(":catalogue_number", albumInfo.getCatalogueNumber());
     pTrackLibraryQuery->bindValue(":year", trackInfo.getYear());
     pTrackLibraryQuery->bindValue(":genre", trackInfo.getGenre());
     pTrackLibraryQuery->bindValue(":composer", trackInfo.getComposer());
@@ -1174,6 +1177,10 @@ void setTrackAlbumArtist(const QSqlRecord& record, const int column, Track* pTra
     pTrack->setAlbumArtist(record.value(column).toString());
 }
 
+void setTrackCatalogueNumber(const QSqlRecord& record, const int column, Track* pTrack) {
+    pTrack->setCatalogueNumber(record.value(column).toString());
+}
+
 void setTrackYear(const QSqlRecord& record, const int column, Track* pTrack) {
     pTrack->setYear(record.value(column).toString());
 }
@@ -1392,6 +1399,7 @@ TrackPointer TrackDAO::getTrackById(TrackId trackId) const {
             {"title", setTrackTitle},
             {"album", setTrackAlbum},
             {"album_artist", setTrackAlbumArtist},
+            {"catalogue_number", setTrackCatalogueNumber},
             {"year", setTrackYear},
             {"genre", setTrackGenre},
             {"composer", setTrackComposer},
@@ -1700,6 +1708,7 @@ bool TrackDAO::updateTrack(const Track& track) const {
             "title=:title,"
             "album=:album,"
             "album_artist=:album_artist,"
+            "catalogue_number=:catalogue_number,"
             "year=:year,"
             "genre=:genre,"
             "composer=:composer,"

src/library/dao/trackschema.h

@@ -15,6 +15,7 @@ const QString LIBRARYTABLE_ARTIST = QStringLiteral("artist");
 const QString LIBRARYTABLE_TITLE = QStringLiteral("title");
 const QString LIBRARYTABLE_ALBUM = QStringLiteral("album");
 const QString LIBRARYTABLE_ALBUMARTIST = QStringLiteral("album_artist");
+const QString LIBRARYTABLE_CATALOGUENUMBER = QStringLiteral("catalogue_number");
 const QString LIBRARYTABLE_YEAR = QStringLiteral("year");
 const QString LIBRARYTABLE_GENRE = QStringLiteral("genre");
 const QString LIBRARYTABLE_COMPOSER = QStringLiteral("composer");

src/library/trackmodel.h

@@ -97,6 +97,7 @@ class TrackModel {
         LastPlayedAt = 31,
         PlaylistDateTimeAdded = 32,
         TuningFrequency = 33,
+        CatalogueNumber = 34,
 
         // IdMax terminates the list of columns, it must be always after the last item
         IdMax,

src/track/albuminfo.cpp

@@ -5,6 +5,7 @@ namespace mixxx {
 
 bool operator==(const AlbumInfo& lhs, const AlbumInfo& rhs) {
     return (lhs.getArtist() == rhs.getArtist()) &&
+            (lhs.getCatalogueNumber() == rhs.getCatalogueNumber()) &&
 #if defined(__EXTRA_METADATA__)
             (lhs.getCopyright() == rhs.getCopyright()) &&
             (lhs.getLicense() == rhs.getLicense()) &&
@@ -20,6 +21,7 @@ bool operator==(const AlbumInfo& lhs, const AlbumInfo& rhs) {
 QDebug operator<<(QDebug dbg, const AlbumInfo& arg) {
     dbg << "AlbumInfo{";
     arg.dbgArtist(dbg);
+    arg.dbgCatalogueNumber(dbg);
 #if defined(__EXTRA_METADATA__)
     arg.dbgCopyright(dbg);
     arg.dbgLicense(dbg);

src/track/albuminfo.h

@@ -13,6 +13,7 @@ namespace mixxx {
 class AlbumInfo final {
     // Properties in alphabetical order
     MIXXX_DECL_PROPERTY(QString, artist, Artist)
+    MIXXX_DECL_PROPERTY(QString, catalogueNumber, CatalogueNumber)
 #if defined(__EXTRA_METADATA__)
     MIXXX_DECL_PROPERTY(QString, copyright, Copyright)
     MIXXX_DECL_PROPERTY(QString, license, License)