Full replay gain support for track metadata, file tags and library

res/schema.xml

@@ -395,4 +395,14 @@ METADATA
       ALTER TABLE library ADD COLUMN coverart_hash INTEGER DEFAULT 0;
     </sql>
   </revision>
+  <revision version="25" min_compatible="3">
+    <description>
+      Add full replay gain support including peak amplitude. The default
+      value for the peak amplitude is "undefined", represented by any
+      negative value. The internal constant for "undefined" is -1.0.
+    </description>
+    <sql>
+      ALTER TABLE library ADD COLUMN replaygain_peak REAL DEFAULT -1.0;
+    </sql>
+  </revision>
 </schema>

src/analyserrg.cpp

@@ -31,8 +31,7 @@ bool AnalyserGain::initialise(TrackPointer tio, int sampleRate, int totalSamples
 
 bool AnalyserGain::loadStored(TrackPointer tio) const {
     bool bAnalyserEnabled = (bool)m_pConfigReplayGain->getValueString(ConfigKey("[ReplayGain]","ReplayGainAnalyserEnabled")).toInt();
-    float fReplayGain = tio->getReplayGain();
-    if (fReplayGain != 0 || !bAnalyserEnabled) {
+    if (tio->getReplayGain().hasRatio() || !bAnalyserEnabled) {
         return true;
     }
     return false;
@@ -76,11 +75,9 @@ void AnalyserGain::finalise(TrackPointer tio) {
         return;
     }
 
-    float fReplayGain_Result = db2ratio(ReplayGainOutput);
+    Mixxx::ReplayGain replayGain(tio->getReplayGain());
+    replayGain.setRatio(db2ratio(ReplayGainOutput));
+    tio->setReplayGain(replayGain);
 
-    //qDebug() << "ReplayGain result is" << ReplayGainOutput << "pow:" << fReplayGain_Result;
-    //qDebug()<<"ReplayGain outputs "<< ReplayGainOutput << "db for track "<< tio->getLocation();
-    tio->setReplayGain(fReplayGain_Result);
-    //if(fReplayGain_Result) qDebug() << "ReplayGain Analyser found a ReplayGain value of "<< 20*log10(fReplayGain_Result) << "dB for track " << (tio->getLocation());
     m_bStepControl=false;
 }

src/basetrackplayer.cpp

@@ -168,8 +168,8 @@ void BaseTrackPlayerImpl::slotLoadTrack(TrackPointer track, bool bPlay) {
                 m_pKey, SLOT(slotSet(double)));
 
         // Listen for updates to the file's Replay Gain
-        connect(m_pLoadedTrack.data(), SIGNAL(ReplayGainUpdated(double)),
-                this, SLOT(slotSetReplayGain(double)));
+        connect(m_pLoadedTrack.data(), SIGNAL(ReplayGainUpdated(Mixxx::ReplayGain)),
+                this, SLOT(slotSetReplayGain(Mixxx::ReplayGain)));
     }
 
     // Request a new track from the reader
@@ -231,7 +231,7 @@ void BaseTrackPlayerImpl::slotFinishLoading(TrackPointer pTrackInfoObject)
     m_pDuration->set(m_pLoadedTrack->getDuration());
     m_pBPM->slotSet(m_pLoadedTrack->getBpm());
     m_pKey->slotSet(m_pLoadedTrack->getKey());
-    m_pReplayGain->set(m_pLoadedTrack->getReplayGain());
+    m_pReplayGain->set(m_pLoadedTrack->getReplayGain().getRatio());
 
     // Update the PlayerInfo class that is used in EngineShoutcast to replace
     // the metadata of a stream
@@ -298,19 +298,19 @@ TrackPointer BaseTrackPlayerImpl::getLoadedTrack() const {
     return m_pLoadedTrack;
 }
 
-void BaseTrackPlayerImpl::slotSetReplayGain(double replayGain) {
+void BaseTrackPlayerImpl::slotSetReplayGain(Mixxx::ReplayGain replayGain) {
     // Do not change replay gain when track is playing because
     // this may lead to an unexpected volume change
     if (m_pPlay->get() == 0.0) {
-        m_pReplayGain->set(replayGain);
+        m_pReplayGain->set(replayGain.getRatio());
     } else {
         m_replaygainPending = true;
     }
 }
 
 void BaseTrackPlayerImpl::slotPlayToggled(double v) {
     if (!v && m_replaygainPending) {
-        m_pReplayGain->set(m_pLoadedTrack->getReplayGain());
+        m_pReplayGain->set(m_pLoadedTrack->getReplayGain().getRatio());
         m_replaygainPending = false;
     }
 }

src/basetrackplayer.h

@@ -68,7 +68,7 @@ class BaseTrackPlayerImpl : public BaseTrackPlayer {
     void slotFinishLoading(TrackPointer pTrackInfoObject);
     void slotLoadFailed(TrackPointer pTrackInfoObject, QString reason);
     void slotUnloadTrack(TrackPointer track);
-    void slotSetReplayGain(double replayGain);
+    void slotSetReplayGain(Mixxx::ReplayGain replayGain);
     void slotPlayToggled(double);
 
   private:

src/dlgtrackinfo.cpp

@@ -159,6 +159,8 @@ void DlgTrackInfo::populateFields(TrackPointer pTrack) {
     txtBitrate->setText(QString(pTrack->getBitrateStr()) + (" ") + tr("kbps"));
     txtBpm->setText(pTrack->getBpmStr());
     txtKey->setText(pTrack->getKeyText());
+    const Mixxx::ReplayGain replayGain(pTrack->getReplayGain());
+    txtReplayGain->setText(Mixxx::ReplayGain::ratioToString(replayGain.getRatio()));
     BeatsPointer pBeats = pTrack->getBeats();
     bool beatsSupportsSet = !pBeats || (pBeats->getCapabilities() & Beats::BEATSCAP_SET);
     bool enableBpmEditing = !pTrack->hasBpmLock() && beatsSupportsSet;
@@ -434,6 +436,7 @@ void DlgTrackInfo::clear() {
     txtLocation->setPlainText("");
     txtBitrate->setText("");
     txtBpm->setText("");
+    txtReplayGain->setText("");
 
     m_cueMap.clear();
     cueTable->clearContents();

src/dlgtrackinfo.ui

@@ -473,7 +473,7 @@
         </widget>
        </item>
        <item>
-        <layout class="QGridLayout" name="gridLayout_4" columnstretch="0,1,1,1,1,1,1,1">
+        <layout class="QGridLayout" name="gridLayout_4" columnstretch="0,1,0,1,0,1">
          <item row="0" column="0">
           <widget class="QLabel" name="lblDuration">
            <property name="font">
@@ -490,6 +490,16 @@
            </property>
           </widget>
          </item>
+         <item row="0" column="1">
+          <widget class="QLabel" name="txtDuration">
+           <property name="text">
+            <string/>
+           </property>
+           <property name="textInteractionFlags">
+            <set>Qt::LinksAccessibleByMouse|Qt::TextSelectableByKeyboard|Qt::TextSelectableByMouse</set>
+           </property>
+          </widget>
+         </item>
          <item row="0" column="2">
           <widget class="QLabel" name="lblBpm">
            <property name="font">
@@ -506,34 +516,34 @@
            </property>
           </widget>
          </item>
-         <item row="1" column="0">
-          <widget class="QLabel" name="lblLocation">
+         <item row="0" column="3">
+          <widget class="QLabel" name="txtBpm">
+           <property name="text">
+            <string/>
+           </property>
+           <property name="textInteractionFlags">
+            <set>Qt::LinksAccessibleByMouse|Qt::TextSelectableByKeyboard|Qt::TextSelectableByMouse</set>
+           </property>
+          </widget>
+         </item>
+         <item row="0" column="4">
+          <widget class="QLabel" name="lblReplayGain">
            <property name="font">
             <font>
              <weight>75</weight>
              <bold>true</bold>
             </font>
            </property>
            <property name="text">
-            <string>Location:</string>
+            <string>Replay Gain:</string>
            </property>
            <property name="alignment">
-            <set>Qt::AlignLeading|Qt::AlignLeft|Qt::AlignTop</set>
-           </property>
-          </widget>
-         </item>
-         <item row="0" column="1">
-          <widget class="QLabel" name="txtDuration">
-           <property name="text">
-            <string/>
-           </property>
-           <property name="textInteractionFlags">
-            <set>Qt::LinksAccessibleByMouse|Qt::TextSelectableByKeyboard|Qt::TextSelectableByMouse</set>
+            <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
            </property>
           </widget>
          </item>
-         <item row="0" column="3">
-          <widget class="QLabel" name="txtBpm">
+         <item row="0" column="5">
+          <widget class="QLabel" name="txtReplayGain">
            <property name="text">
             <string/>
            </property>
@@ -542,7 +552,7 @@
            </property>
           </widget>
          </item>
-         <item row="0" column="4">
+         <item row="1" column="0">
           <widget class="QLabel" name="lblBitrate">
            <property name="font">
             <font>
@@ -558,7 +568,7 @@
            </property>
           </widget>
          </item>
-         <item row="0" column="5">
+         <item row="1" column="1">
           <widget class="QLabel" name="txtBitrate">
            <property name="text">
             <string/>
@@ -568,7 +578,7 @@
            </property>
           </widget>
          </item>
-         <item row="0" column="6">
+         <item row="1" column="2">
           <widget class="QLabel" name="lblType">
            <property name="font">
             <font>
@@ -584,7 +594,7 @@
            </property>
           </widget>
          </item>
-         <item row="0" column="7">
+         <item row="1" column="3">
           <widget class="QLabel" name="txtType">
            <property name="text">
             <string/>
@@ -594,7 +604,23 @@
            </property>
           </widget>
          </item>
-         <item row="1" column="1" colspan="7">
+         <item row="2" column="0">
+          <widget class="QLabel" name="lblLocation">
+           <property name="font">
+            <font>
+             <weight>75</weight>
+             <bold>true</bold>
+            </font>
+           </property>
+           <property name="text">
+            <string>Location:</string>
+           </property>
+           <property name="alignment">
+            <set>Qt::AlignLeading|Qt::AlignLeft|Qt::AlignTop</set>
+           </property>
+          </widget>
+         </item>
+         <item row="2" column="1" colspan="5">
           <widget class="QPlainTextEdit" name="txtLocation">
            <property name="enabled">
             <bool>true</bool>

src/library/basesqltablemodel.cpp

@@ -105,6 +105,8 @@ void BaseSqlTableModel::initHeaderData() {
                         tr("Preview"), 50);
     setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_COVERART,
                         tr("Cover Art"), 90);
+    setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_REPLAYGAIN,
+                        tr("Replay Gain"), 50);
 }
 
 QSqlDatabase BaseSqlTableModel::database() const {
@@ -172,7 +174,8 @@ bool BaseSqlTableModel::isColumnHiddenByDefault(int column) {
             (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_YEAR)) ||
             (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_GROUPING)) ||
             (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_LOCATION)) ||
-            (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_ALBUMARTIST))) {
+            (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_ALBUMARTIST)) ||
+            (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_REPLAYGAIN))) {
         return true;
     }
     return false;
@@ -582,9 +585,7 @@ QVariant BaseSqlTableModel::data(const QModelIndex& index, int role) const {
             } else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM_LOCK)) {
                 value = value.toBool();
             } else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_YEAR)) {
-                if (Qt::DisplayRole == role) {
-                    value = Mixxx::TrackMetadata::formatCalendarYear(value.toString());
-                }
+                value = Mixxx::TrackMetadata::formatCalendarYear(value.toString());
             } else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TRACKNUMBER)) {
                 int track_number = value.toInt();
                 if (track_number <= 0) {
@@ -613,8 +614,9 @@ QVariant BaseSqlTableModel::data(const QModelIndex& index, int role) const {
                         value = KeyUtils::keyToString(key);
                     }
                 }
-                // Otherwise, just use the column value.
-            }
+            } else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_REPLAYGAIN)) {
+                value = Mixxx::ReplayGain::ratioToString(value.toDouble());
+            } // Otherwise, just use the column value.
 
             break;
         case Qt::EditRole:
@@ -722,7 +724,8 @@ Qt::ItemFlags BaseSqlTableModel::readWriteFlags(
             column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_DURATION) ||
             column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BITRATE) ||
             column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_DATETIMEADDED) ||
-            column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COVERART)) {
+            column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COVERART) ||
+            column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_REPLAYGAIN)) {
         return defaultFlags;
     } else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TIMESPLAYED))  {
         return defaultFlags | Qt::ItemIsUserCheckable;

src/library/basetrackcache.cpp

@@ -307,6 +307,8 @@ void BaseTrackCache::getTrackValueForColumn(TrackPointer pTrack,
         trackValue.setValue(pTrack->getBitrate());
     } else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM) == column) {
         trackValue.setValue(pTrack->getBpm());
+    } else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_REPLAYGAIN) == column) {
+        trackValue.setValue(pTrack->getReplayGain().getRatio());
     } else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_PLAYED) == column) {
         trackValue.setValue(pTrack->getPlayed());
     } else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TIMESPLAYED) == column) {
@@ -589,7 +591,8 @@ int BaseTrackCache::compareColumnValues(int sortColumn, Qt::SortOrder sortOrder,
             sortColumn == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM) ||
             sortColumn == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_DURATION) ||
             sortColumn == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TIMESPLAYED) ||
-            sortColumn == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_RATING)) {
+            sortColumn == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_RATING) ||
+            sortColumn == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_REPLAYGAIN)) {
         // Sort as floats.
         double delta = val1.toDouble() - val2.toDouble();
 

src/library/browse/browsetablemodel.cpp

@@ -39,6 +39,7 @@ BrowseTableModel::BrowseTableModel(QObject* parent,
     header_data.insert(COLUMN_KEY, tr("Key"));
     header_data.insert(COLUMN_TYPE, tr("Type"));
     header_data.insert(COLUMN_BITRATE, tr("Bitrate"));
+    header_data.insert(COLUMN_REPLAYGAIN, tr("Replay Gain"));
     header_data.insert(COLUMN_LOCATION, tr("Location"));
     header_data.insert(COLUMN_ALBUMARTIST, tr("Album Artist"));
     header_data.insert(COLUMN_GROUPING, tr("Grouping"));
@@ -151,7 +152,8 @@ bool BrowseTableModel::isColumnHiddenByDefault(int column) {
             column == COLUMN_GROUPING ||
             column == COLUMN_LOCATION ||
             column == COLUMN_ALBUMARTIST ||
-            column == COLUMN_FILE_CREATION_TIME) {
+            column == COLUMN_FILE_CREATION_TIME ||
+            column == COLUMN_REPLAYGAIN) {
         return true;
     }
     return false;
@@ -305,7 +307,8 @@ Qt::ItemFlags BrowseTableModel::flags(const QModelIndex &index) const {
             column == COLUMN_DURATION ||
             column == COLUMN_TYPE ||
             column == COLUMN_FILE_MODIFIED_TIME ||
-            column == COLUMN_FILE_CREATION_TIME) {
+            column == COLUMN_FILE_CREATION_TIME ||
+            column == COLUMN_REPLAYGAIN) {
         return defaultFlags;
     } else {
         return defaultFlags | Qt::ItemIsEditable;

src/library/browse/browsetablemodel.h

@@ -31,6 +31,7 @@ const int COLUMN_ALBUMARTIST = 16;
 const int COLUMN_GROUPING = 17;
 const int COLUMN_FILE_MODIFIED_TIME = 18;
 const int COLUMN_FILE_CREATION_TIME = 19;
+const int COLUMN_REPLAYGAIN = 20;
 
 
 // The BrowseTable models displays tracks

src/library/browse/browsethread.cpp

@@ -255,6 +255,13 @@ void BrowseThread::populateModel() {
         item->setData(creationTime, Qt::UserRole);
         row_data.insert(COLUMN_FILE_CREATION_TIME, item);
 
+        const Mixxx::ReplayGain replayGain(tio.getReplayGain());
+        item = new QStandardItem(
+                Mixxx::ReplayGain::ratioToString(replayGain.getRatio()));
+        item->setToolTip(item->text());
+        item->setData(item->text(), Qt::UserRole);
+        row_data.insert(COLUMN_REPLAYGAIN, item);
+
         rows.append(row_data);
         ++row;
         // If 10 tracks have been analyzed, send it to GUI