feat: store tracklist as tag comment on recording

acolombier · Oct 13, 2024 · 5108a46 · 5108a46
1 parent 34dde6f
commit 5108a46
Show file tree

Hide file tree

Showing 19 changed files with 362 additions and 158 deletions.
diff --git a/src/encoder/encoder.cpp b/src/encoder/encoder.cpp
@@ -155,3 +155,29 @@ EncoderRecordingSettingsPointer EncoderFactory::getEncoderRecordingSettings(Enco
         return std::make_shared<EncoderWaveSettings>(pConfig, ENCODING_WAVE);
     }
 }
+
+void Encoder::addToTracklist(const QString& artist,
+        const QString& title,
+        std::chrono::seconds timecode) {
+    auto recordedDuration = timecode.count();
+    m_trackList.append(
+            QStringLiteral("%1: %2 - %3")
+                    .arg(QString("%1:%2:%3")
+                                    .arg(recordedDuration / (60 * 60),
+                                            2,
+                                            'f',
+                                            0,
+                                            '0') // hours
+                                    .arg((recordedDuration / 60) % 60,
+                                            2,
+                                            'f',
+                                            0,
+                                            '0') // minutes
+                                    .arg(recordedDuration % 60, 2, 'f', 0, '0'),
+                            artist.trimmed().isEmpty()
+                                    ? QObject::tr("(Unknown Artist)")
+                                    : artist,
+                            title.trimmed().isEmpty()
+                                    ? QObject::tr("(Unknown Title)")
+                                    : title));
+}
diff --git a/src/encoder/encoder.h b/src/encoder/encoder.h
@@ -1,5 +1,6 @@
 #pragma once
 
+#include <chrono>
 #include <memory>
 
 #include "encoder/encoderrecordingsettings.h"
@@ -32,11 +33,23 @@ class Encoder {
     virtual void encodeBuffer(const CSAMPLE *samples, const int size) = 0;
     // Adds metadata to the encoded audio, i.e., the ID3 tag. Currently only used
     // by EngineRecord, ShoutConnection does something different.
-    virtual void updateMetaData(const QString& artist, const QString& title, const QString& album) = 0;
+    virtual void updateMetaData(const QString& artist,
+            const QString& title,
+            const QString& album,
+            std::chrono::seconds timecode = {}) = 0;
     // called at the end when encoding is finished
     virtual void flush() = 0;
     // Setup the encoder with the specific settings
     virtual void setEncoderSettings(const EncoderSettings& settings) = 0;
+
+  protected:
+    void addToTracklist(const QString& artist, const QString& title, std::chrono::seconds timecode);
+    QStringList getTrackList() const {
+        return m_trackList;
+    }
+
+  private:
+    QStringList m_trackList;
 };
 
 typedef std::shared_ptr<Encoder> EncoderPointer;

diff --git a/src/encoder/encoderfdkaac.cpp b/src/encoder/encoderfdkaac.cpp
@@ -1,5 +1,7 @@
 #include "encoder/encoderfdkaac.h"
 
+#include <qglobal.h>
+
 #ifdef __APPLE__
 #include <QCoreApplication>
 #endif
@@ -439,9 +441,14 @@ void EncoderFdkAac::processFIFO() {
     }
 }
 
-void EncoderFdkAac::updateMetaData(
-        const QString& artist, const QString& title, const QString& album) {
-    (void)artist, (void)title, (void)album;
+void EncoderFdkAac::updateMetaData(const QString& artist,
+        const QString& title,
+        const QString& album,
+        std::chrono::seconds timecode) {
+    Q_UNUSED(artist);
+    Q_UNUSED(title);
+    Q_UNUSED(album);
+    Q_UNUSED(timecode);
 }
 
 void EncoderFdkAac::flush() {

diff --git a/src/encoder/encoderfdkaac.h b/src/encoder/encoderfdkaac.h
@@ -16,7 +16,10 @@ class EncoderFdkAac : public Encoder {
 
     int initEncoder(mixxx::audio::SampleRate sampleRate, QString* pUserErrorMessage) override;
     void encodeBuffer(const CSAMPLE* samples, const int sampleCount) override;
-    void updateMetaData(const QString& artist, const QString& title, const QString& album) override;
+    void updateMetaData(const QString& artist,
+            const QString& title,
+            const QString& album,
+            std::chrono::seconds timecode = {}) override;
     void flush() override;
     void setEncoderSettings(const EncoderSettings& settings) override;
 

diff --git a/src/encoder/encoderffmpegcore.cpp b/src/encoder/encoderffmpegcore.cpp
@@ -189,12 +189,15 @@ void EncoderFfmpegCore::encodeBuffer(const CSAMPLE *samples, const int size) {
 //
 // Currently this method is used before init() once to save artist, title and album
 //
-void EncoderFfmpegCore::updateMetaData(const QString& artist, const QString& title, const QString& album) {
+void EncoderFfmpegCore::updateMetaData(const QString& artist,
+        const QString& title,
+        const QString& album,
+        std::chrono::seconds timecode) {
     qDebug() << "ffmpegencodercore: UpdateMetadata: !" << artist << " - " << title <<
              " - " << album;
-    m_strMetaDataTitle = title;
-    m_strMetaDataArtist = artist;
-    m_strMetaDataAlbum = album;
+    Q_UNUSED(artist);
+    Q_UNUSED(title);
+    Q_UNUSED(album);
 }
 
 int EncoderFfmpegCore::initEncoder(

diff --git a/src/encoder/encoderffmpegcore.h b/src/encoder/encoderffmpegcore.h
@@ -44,7 +44,10 @@ class EncoderFfmpegCore : public Encoder {
     ~EncoderFfmpegCore();
     int initEncoder(mixxx::audio::SampleRate sampleRate, QString* pUserErrorMessage) override;
     void encodeBuffer(const CSAMPLE *samples, const int size) override;
-    void updateMetaData(const QString& artist, const QString& title, const QString& album) override;
+    void updateMetaData(const QString& artist,
+            const QString& title,
+            const QString& album,
+            std::chrono::seconds timecode = {}) override;
     void flush() override;
     void setEncoderSettings(const EncoderSettings& settings) override;
 protected:
@@ -70,9 +73,6 @@ class EncoderFfmpegCore : public Encoder {
     EncoderCallback* m_pCallback;
     TrackPointer m_pMetaData;
 
-    QString m_strMetaDataTitle;
-    QString m_strMetaDataArtist;
-    QString m_strMetaDataAlbum;
     QFile m_pFile;
 
     QByteArray m_strReadByteArray;

diff --git a/src/encoder/encodermp3.cpp b/src/encoder/encodermp3.cpp
@@ -1,13 +1,23 @@
 #include "encoder/encodermp3.h"
 
+#include <lame/lame.h>
 #include <limits.h>
+#include <qbytearrayview.h>
+#include <qobject.h>
+#include <qstringliteral.h>
 
+#include <QByteArray>
 #include <QObject>
 #include <QtDebug>
 
 #include "audio/types.h"
 #include "encoder/encodercallback.h"
 #include "encoder/encodermp3settings.h"
+#include "util/assert.h"
+
+namespace {
+constexpr size_t kHeaderPadding = 10000;
+}
 
 // Automatic thresholds for switching the encoder to mono
 // They have been chosen by testing and to keep the same number
@@ -81,7 +91,7 @@ void EncoderMp3::setEncoderSettings(const EncoderSettings& settings) {
     }
 }
 
-int EncoderMp3::bufferOutGrow(int size) {
+size_t EncoderMp3::bufferOutGrow(size_t size) {
     if (m_bufferOutSize >= size) {
         return 0;
     }
@@ -95,7 +105,7 @@ int EncoderMp3::bufferOutGrow(int size) {
     return 0;
 }
 
-int EncoderMp3::bufferInGrow(int size) {
+size_t EncoderMp3::bufferInGrow(size_t size) {
     if (m_bufferInSize >= size) {
         return 0;
     }
@@ -127,16 +137,45 @@ void EncoderMp3::flush() {
     // `lame_get_lametag_frame` returns the number of bytes copied into buffer,
     // or the required buffer size, if the provided buffer is too small.
     // Function failed, if the return value is larger than `m_bufferOutSize`!
-    int numBytes = static_cast<int>(
-            lame_get_lametag_frame(m_lameFlags, m_bufferOut, m_bufferOutSize));
+    size_t numBytes = lame_get_lametag_frame(m_lameFlags, m_bufferOut, m_bufferOutSize);
     if (numBytes > m_bufferOutSize) {
         bufferOutGrow(numBytes);
         numBytes = static_cast<int>(lame_get_lametag_frame(
                 m_lameFlags, m_bufferOut, m_bufferOutSize));
     }
-    // Write the lame/xing header.
+
+    // Ideally, we should shift the file content forward to insert the header
+    // (ID3v2 & Xing frame) dynamically, but `EncoderCallback` doesn't support
+    // that so we use the static header padding and truncate the tracklist if
+    // too long
+    size_t tracklistMaxSize = kHeaderPadding - numBytes -
+            lame_get_id3v2_tag(m_lameFlags, nullptr, 0);
+    auto trackList = getTrackList().join("\n");
+    if (!trackList.isEmpty()) {
+        // Because of the static header size offset, we need to ensure that the
+        // tracklist comment won't make the header overflow on the MP3 frames,
+        // we we truncate to the max value
+        auto currentSize = static_cast<size_t>(trackList.size());
+        if (currentSize > tracklistMaxSize - 1) { // -1 since we need a byte for the NULL terminator
+            trackList = trackList.left(tracklistMaxSize - 4) + "...";
+        }
+        id3tag_set_comment(m_lameFlags, trackList.toLatin1());
+    }
+
+    size_t id3HeaderNumBytes = lame_get_id3v2_tag(m_lameFlags, nullptr, 0);
+    QByteArray id3Buffer(id3HeaderNumBytes, 0);
+
+    DEBUG_ASSERT(lame_get_id3v2_tag(m_lameFlags,
+                         (unsigned char*)id3Buffer.data(),
+                         id3HeaderNumBytes) == id3HeaderNumBytes);
+    DEBUG_ASSERT(id3Buffer.size() + numBytes <= kHeaderPadding);
+
     m_pCallback->seek(0);
-    m_pCallback->write(nullptr, m_bufferOut, 0, numBytes);
+    // Write the lame/xing header.
+    m_pCallback->write((const unsigned char*)id3Buffer.constData(),
+            m_bufferOut,
+            id3Buffer.size(),
+            numBytes);
 }
 
 void EncoderMp3::encodeBuffer(const CSAMPLE *samples, const int size) {
@@ -173,6 +212,10 @@ void EncoderMp3::initStream() {
 
     m_bufferIn[0] = (float *)malloc(m_bufferOutSize * sizeof(float));
     m_bufferIn[1] = (float *)malloc(m_bufferOutSize * sizeof(float));
+
+    // Add a static header padding, which will be filled one termination
+    QByteArray headerPad(kHeaderPadding, 0);
+    m_pCallback->write(nullptr, (unsigned char*)headerPad.constData(), 0, headerPad.size());
 }
 
 int EncoderMp3::initEncoder(mixxx::audio::SampleRate sampleRate, QString* pUserErrorMessage) {
@@ -219,6 +262,8 @@ int EncoderMp3::initEncoder(mixxx::audio::SampleRate sampleRate, QString* pUserE
 
     //ID3 Tag if fields are not NULL
     id3tag_init(m_lameFlags);
+    // ID3 tags will be written manually when flushing the encoder.
+    lame_set_write_id3tag_automatic(m_lameFlags, 0);
     if (!m_metaDataTitle.isEmpty()) {
         id3tag_set_title(m_lameFlags, m_metaDataTitle.toLatin1().constData());
     }
@@ -240,8 +285,15 @@ int EncoderMp3::initEncoder(mixxx::audio::SampleRate sampleRate, QString* pUserE
     return 0;
 }
 
-void EncoderMp3::updateMetaData(const QString& artist, const QString& title, const QString& album) {
-    m_metaDataTitle = title;
-    m_metaDataArtist = artist;
-    m_metaDataAlbum = album;
+void EncoderMp3::updateMetaData(const QString& artist,
+        const QString& title,
+        const QString& album,
+        std::chrono::seconds timecode) {
+    if (m_bufferOut == nullptr) {
+        m_metaDataTitle = title;
+        m_metaDataArtist = artist;
+        m_metaDataAlbum = album;
+    } else {
+        addToTracklist(artist, title, timecode);
+    }
 }
diff --git a/src/encoder/encodermp3.h b/src/encoder/encodermp3.h
@@ -16,14 +16,17 @@ class EncoderMp3 final : public Encoder {
 
     int initEncoder(mixxx::audio::SampleRate sampleRate, QString* pUserErrorMessage) override;
     void encodeBuffer(const CSAMPLE *samples, const int size) override;
-    void updateMetaData(const QString& artist, const QString& title, const QString& album) override;
+    void updateMetaData(const QString& artist,
+            const QString& title,
+            const QString& album,
+            std::chrono::seconds timecode = {}) override;
     void flush() override;
     void setEncoderSettings(const EncoderSettings& settings) override;
 
   private:
     void initStream();
-    int bufferOutGrow(int size);
-    int bufferInGrow(int size);
+    size_t bufferOutGrow(size_t size);
+    size_t bufferInGrow(size_t size);
 
     lame_t m_lameFlags;
     QString m_metaDataTitle;
@@ -35,9 +38,9 @@ class EncoderMp3 final : public Encoder {
     vbr_mode m_encoding_mode;
     MPEG_mode_e m_stereo_mode;
     unsigned char *m_bufferOut;
-    int m_bufferOutSize;
+    size_t m_bufferOutSize;
     float* m_bufferIn[2];
-    int m_bufferInSize;
+    size_t m_bufferInSize;
 
     EncoderCallback* m_pCallback;
 };
diff --git a/src/encoder/encoderopus.cpp b/src/encoder/encoderopus.cpp
@@ -1,5 +1,7 @@
 #include "encoder/encoderopus.h"
 
+#include <qglobal.h>
+
 #include <QByteArray>
 #include <QMapIterator>
 #include <QRandomGenerator>
@@ -460,10 +462,18 @@ void EncoderOpus::writePage(ogg_packet* pPacket) {
     } while(!ogg_page_eos(&m_oggPage));
 }
 
-void EncoderOpus::updateMetaData(const QString& artist, const QString& title, const QString& album) {
-    m_opusComments.insert("ARTIST", artist);
-    m_opusComments.insert("TITLE", title);
-    m_opusComments.insert("ALBUM", album);
+void EncoderOpus::updateMetaData(const QString& artist,
+        const QString& title,
+        const QString& album,
+        std::chrono::seconds timecode) {
+    // We assume all the base tags are added at the same time, so only check for ARTIST presence
+    if (!m_opusComments.contains("ARTIST")) {
+        m_opusComments.insert("ARTIST", artist);
+        m_opusComments.insert("TITLE", title);
+        m_opusComments.insert("ALBUM", album);
+    }
+    // Tracklist tag not supported in OPUS
+    Q_UNUSED(timecode);
 }
 
 void EncoderOpus::flush() {

diff --git a/src/encoder/encoderopus.h b/src/encoder/encoderopus.h
@@ -28,7 +28,10 @@ class EncoderOpus: public Encoder {
 
     int initEncoder(mixxx::audio::SampleRate sampleRate, QString* pUserErrorMessage) override;
     void encodeBuffer(const CSAMPLE *samples, const int size) override;
-    void updateMetaData(const QString& artist, const QString& title, const QString& album) override;
+    void updateMetaData(const QString& artist,
+            const QString& title,
+            const QString& album,
+            std::chrono::seconds timecode = {}) override;
     void flush() override;
     void setEncoderSettings(const EncoderSettings& settings) override;
 

diff --git a/src/encoder/encodervorbis.cpp b/src/encoder/encodervorbis.cpp
@@ -1,5 +1,6 @@
 #include "encoder/encodervorbis.h"
 
+#include <qglobal.h>
 #include <stdlib.h> // needed for random num gen
 #include <time.h>   // needed for random num gen
 #include <vorbis/vorbisenc.h>
@@ -31,6 +32,9 @@ EncoderVorbis::EncoderVorbis(EncoderCallback* pCallback)
 
 EncoderVorbis::~EncoderVorbis() {
     if (m_bStreamInitialized) {
+        auto trackList = m_trackList.join("\n");
+        vorbis_comment_add_tag(&m_vcomment, "COMMENT", trackList.toUtf8().constData());
+
         ogg_stream_clear(&m_oggs);
         vorbis_block_clear(&m_vblock);
         vorbis_dsp_clear(&m_vdsp);
@@ -161,10 +165,17 @@ void EncoderVorbis::encodeBuffer(const CSAMPLE *samples, const int size) {
  *
  * Currently this method is used before init() once to save artist, title and album
 */
-void EncoderVorbis::updateMetaData(const QString& artist, const QString& title, const QString& album) {
-    m_metaDataTitle = title;
-    m_metaDataArtist = artist;
-    m_metaDataAlbum = album;
+void EncoderVorbis::updateMetaData(const QString& artist,
+        const QString& title,
+        const QString& album,
+        std::chrono::seconds timecode) {
+    if (!m_bStreamInitialized) {
+        m_metaDataTitle = title;
+        m_metaDataArtist = artist;
+        m_metaDataAlbum = album;
+    }
+    // Tracklist tag not supported in OGG
+    Q_UNUSED(timecode);
 }
 
 void EncoderVorbis::initStream() {