396 lines
14 KiB
C++
396 lines
14 KiB
C++
/* This file is part of Clementine.
|
|
Copyright 2014, David Sansome <me@davidsansome.com>
|
|
Copyright 2021, Lukas Prediger <lumip@lumip.de>
|
|
|
|
Clementine is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
Clementine is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with Clementine. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "cddasongloader.h"
|
|
|
|
#include <gst/gst.h>
|
|
#include <gst/tag/tag.h>
|
|
|
|
#include <QtConcurrentRun>
|
|
|
|
#include "cddadevice.h"
|
|
#include "core/logging.h"
|
|
#include "core/timeconstants.h"
|
|
|
|
CddaSongLoader::CddaSongLoader(const QUrl& url, QObject* parent)
|
|
: QObject(parent), url_(url), cdda_(nullptr), may_load_(true), disc_() {
|
|
connect(this, &CddaSongLoader::MusicBrainzDiscIdLoaded, this,
|
|
&CddaSongLoader::LoadAudioCDTags);
|
|
connect(this, &CddaSongLoader::SongsLoaded,
|
|
[this](const SongList& song_list) {
|
|
SetDiscTracks(song_list, /*has_titles=*/false);
|
|
});
|
|
connect(this, &CddaSongLoader::SongsDurationLoaded,
|
|
[this](const SongList& song_list) {
|
|
SetDiscTracks(song_list, /*has_titles=*/false);
|
|
});
|
|
connect(this, &CddaSongLoader::SongsMetadataLoaded,
|
|
[this](const SongList& song_list) {
|
|
SetDiscTracks(song_list, /*has_titles=*/true);
|
|
});
|
|
}
|
|
|
|
CddaSongLoader::~CddaSongLoader() {
|
|
// The LoadSongsFromCdda methods runs concurrently in a thread and we need to
|
|
// wait for it to terminate. There's no guarantee that it has terminated when
|
|
// destructor is invoked.
|
|
may_load_ = false;
|
|
loading_future_.waitForFinished();
|
|
}
|
|
|
|
QUrl CddaSongLoader::GetUrlFromTrack(int track_number) const {
|
|
QString track;
|
|
if (url_.isEmpty()) {
|
|
track = QString("cdda://%1").arg(track_number);
|
|
} else {
|
|
track = QString("cdda://%1/%2").arg(url_.path()).arg(track_number);
|
|
}
|
|
return CddaDevice::TrackStrToUrl(track);
|
|
}
|
|
|
|
bool CddaSongLoader::IsActive() const { return loading_future_.isRunning(); }
|
|
|
|
void CddaSongLoader::LoadSongs() {
|
|
// only dispatch a new thread for loading tracks if not already running.
|
|
if (!IsActive()) {
|
|
QMutexLocker lock(&disc_mutex_);
|
|
disc_ = Disc();
|
|
loading_future_ =
|
|
QtConcurrent::run(this, &CddaSongLoader::LoadSongsFromCdda);
|
|
}
|
|
}
|
|
|
|
bool CddaSongLoader::ParseSongTags(SongList& songs, GstTagList* tags,
|
|
gint* track_no) {
|
|
//// cdiocddasrc reads cd-text with following mapping from cdio
|
|
///
|
|
/// DISC LEVEL :
|
|
/// CDTEXT_FIELD_PERFORMER -> GST_TAG_ALBUM_ARTIST
|
|
/// CDTEXT_FIELD_TITLE -> GST_TAG_ALBUM
|
|
/// CDTEXT_FIELD_GENRE -> GST_TAG_GENRE
|
|
///
|
|
/// TRACK LEVEL :
|
|
/// CDTEXT_FIELD_PERFORMER -> GST_TAG_ARTIST
|
|
/// CDTEXT_FIELD_TITLE -> GST_TAG_TITLE
|
|
|
|
guint track_number;
|
|
if (!gst_tag_list_get_uint(tags, GST_TAG_TRACK_NUMBER, &track_number)) {
|
|
qLog(Error) << "Track tags do not contain track number!";
|
|
return false;
|
|
}
|
|
|
|
Q_ASSERT(track_number != 0u);
|
|
Q_ASSERT(static_cast<int>(track_number) <= songs.size());
|
|
Song& song = songs[static_cast<int>(track_number - 1)];
|
|
*track_no = static_cast<gint>(track_number) - 1;
|
|
|
|
// qLog(Debug) << gst_tag_list_to_string(tags);
|
|
|
|
bool has_loaded_tags = false;
|
|
|
|
gchar* buffer = nullptr;
|
|
if (gst_tag_list_get_string(tags, GST_TAG_ALBUM, &buffer)) {
|
|
has_loaded_tags = true;
|
|
song.set_album(QString::fromUtf8(buffer));
|
|
g_free(buffer);
|
|
}
|
|
|
|
if (gst_tag_list_get_string(tags, GST_TAG_ALBUM_ARTIST, &buffer)) {
|
|
has_loaded_tags = true;
|
|
song.set_albumartist(QString::fromUtf8(buffer));
|
|
g_free(buffer);
|
|
}
|
|
|
|
if (gst_tag_list_get_string(tags, GST_TAG_GENRE, &buffer)) {
|
|
has_loaded_tags = true;
|
|
song.set_genre(QString::fromUtf8(buffer));
|
|
g_free(buffer);
|
|
}
|
|
|
|
if (gst_tag_list_get_string(tags, GST_TAG_ARTIST, &buffer)) {
|
|
has_loaded_tags = true;
|
|
song.set_artist(QString::fromUtf8(buffer));
|
|
g_free(buffer);
|
|
}
|
|
|
|
if (gst_tag_list_get_string(tags, GST_TAG_TITLE, &buffer)) {
|
|
has_loaded_tags = true;
|
|
song.set_title(QString::fromUtf8(buffer));
|
|
g_free(buffer);
|
|
}
|
|
|
|
guint64 duration;
|
|
if (gst_tag_list_get_uint64(tags, GST_TAG_DURATION, &duration)) {
|
|
has_loaded_tags = true;
|
|
song.set_length_nanosec(duration);
|
|
}
|
|
|
|
song.set_track(track_number);
|
|
song.set_id(track_number);
|
|
song.set_filetype(Song::Type_Cdda);
|
|
song.set_valid(true);
|
|
song.set_url(GetUrlFromTrack(track_number));
|
|
return has_loaded_tags;
|
|
}
|
|
|
|
void CddaSongLoader::LoadSongsFromCdda() {
|
|
SongList initial_song_list;
|
|
|
|
if (!may_load_) return;
|
|
// Create gstreamer cdda element
|
|
GError* error = nullptr;
|
|
GstElement* cdda_ = gst_element_factory_make("cdiocddasrc", nullptr);
|
|
if (error) {
|
|
qLog(Error) << error->code << QString::fromLocal8Bit(error->message);
|
|
}
|
|
if (cdda_ == nullptr) {
|
|
emit SongsLoaded(initial_song_list);
|
|
emit Finished();
|
|
return;
|
|
}
|
|
|
|
if (!url_.isEmpty()) {
|
|
g_object_set(cdda_, "device",
|
|
g_strdup(url_.path().toLocal8Bit().constData()), nullptr);
|
|
}
|
|
if (g_object_class_find_property(G_OBJECT_GET_CLASS(cdda_),
|
|
"paranoia-mode")) {
|
|
g_object_set(cdda_, "paranoia-mode", 0, nullptr);
|
|
}
|
|
|
|
// Change the element's state to ready and paused, to be able to query it
|
|
if (gst_element_set_state(cdda_, GST_STATE_READY) ==
|
|
GST_STATE_CHANGE_FAILURE ||
|
|
gst_element_set_state(cdda_, GST_STATE_PAUSED) ==
|
|
GST_STATE_CHANGE_FAILURE) {
|
|
gst_element_set_state(cdda_, GST_STATE_NULL);
|
|
gst_object_unref(GST_OBJECT(cdda_));
|
|
|
|
emit SongsLoaded(initial_song_list);
|
|
emit Finished();
|
|
return;
|
|
}
|
|
|
|
// Get number of tracks
|
|
GstFormat track_fmt = gst_format_get_by_nick("track");
|
|
gint64 num_tracks = 0;
|
|
if (!gst_element_query_duration(cdda_, track_fmt, &num_tracks)) {
|
|
qLog(Error) << "Error while querying cdda GstElement for track count";
|
|
gst_object_unref(GST_OBJECT(cdda_));
|
|
|
|
emit SongsLoaded(initial_song_list);
|
|
emit Finished();
|
|
return;
|
|
}
|
|
|
|
for (int track_number = 1; track_number <= num_tracks; track_number++) {
|
|
// Init song
|
|
Song song;
|
|
song.set_id(track_number);
|
|
song.set_valid(true);
|
|
song.set_filetype(Song::Type_Cdda);
|
|
song.set_url(GetUrlFromTrack(track_number));
|
|
song.set_title(QString("Track %1").arg(track_number));
|
|
song.set_track(track_number);
|
|
initial_song_list << song;
|
|
}
|
|
emit SongsLoaded(initial_song_list);
|
|
|
|
SongList tagged_song_list(initial_song_list);
|
|
|
|
gst_tag_register_musicbrainz_tags();
|
|
|
|
GstElement* pipeline = gst_pipeline_new("pipeline");
|
|
GstElement* sink = gst_element_factory_make("fakesink", NULL);
|
|
gst_bin_add_many(GST_BIN(pipeline), cdda_, sink, nullptr);
|
|
gst_element_link(cdda_, sink);
|
|
gst_element_set_state(pipeline, GST_STATE_READY);
|
|
gst_element_set_state(pipeline, GST_STATE_PAUSED);
|
|
|
|
// Get TOC and TAG messages
|
|
GstMessage* msg = nullptr;
|
|
GstMessageType msg_filter =
|
|
static_cast<GstMessageType>(GST_MESSAGE_TOC | GST_MESSAGE_TAG);
|
|
QString musicbrainz_discid;
|
|
bool loaded_cd_tags = false;
|
|
while (may_load_ && msg_filter &&
|
|
(msg = gst_bus_timed_pop_filtered(GST_ELEMENT_BUS(pipeline),
|
|
10 * GST_SECOND, msg_filter))) {
|
|
if (GST_MESSAGE_TYPE(msg) == GST_MESSAGE_TOC) {
|
|
// Handle TOC message: get tracks duration
|
|
GstToc* toc;
|
|
gst_message_parse_toc(msg, &toc, nullptr);
|
|
if (toc) {
|
|
GList* entries = gst_toc_get_entries(toc);
|
|
if (entries && initial_song_list.size() <= g_list_length(entries)) {
|
|
int i = 0;
|
|
for (GList* node = entries; node != nullptr; node = node->next) {
|
|
GstTocEntry* entry = static_cast<GstTocEntry*>(node->data);
|
|
quint64 duration = 0;
|
|
gint64 start, stop;
|
|
if (gst_toc_entry_get_start_stop_times(entry, &start, &stop))
|
|
duration = stop - start;
|
|
initial_song_list[i++].set_length_nanosec(duration);
|
|
}
|
|
emit SongsDurationLoaded(initial_song_list);
|
|
msg_filter = static_cast<GstMessageType>(
|
|
static_cast<int>(msg_filter) ^ GST_MESSAGE_TOC);
|
|
}
|
|
gst_toc_unref(toc);
|
|
}
|
|
} else if (GST_MESSAGE_TYPE(msg) == GST_MESSAGE_TAG) {
|
|
// Handle TAG message: generate MusicBrainz DiscId and read CD-TEXT if
|
|
// present
|
|
|
|
gint64
|
|
track_number_from_query; // track number gstreamer thinks we are at
|
|
gst_element_query_position(cdda_, track_fmt, &track_number_from_query);
|
|
|
|
GstTagList* tags = nullptr;
|
|
gst_message_parse_tag(msg, &tags);
|
|
char* string_mb = nullptr;
|
|
if (musicbrainz_discid.isEmpty() &&
|
|
gst_tag_list_get_string(tags, GST_TAG_CDDA_MUSICBRAINZ_DISCID,
|
|
&string_mb)) {
|
|
musicbrainz_discid = QString::fromUtf8(string_mb);
|
|
g_free(string_mb);
|
|
qLog(Info) << "MusicBrainz discid: " << musicbrainz_discid;
|
|
}
|
|
|
|
gint track_number_from_tags; // track number contained in the tag message
|
|
loaded_cd_tags |=
|
|
ParseSongTags(tagged_song_list, tags, &track_number_from_tags);
|
|
gst_tag_list_free(tags);
|
|
|
|
// We may receive a tag message for a track we have already seen, not for
|
|
// the track we seeked to previously, i.e., track_number_from_tags and
|
|
// track_number_from_query do not agree. If we would just wait now,
|
|
// nothing else would happen: It seems, gstreamer will for some reason not
|
|
// pass the tag message for the song we seeked to in this case or it gets
|
|
// lost somewhere. We can't seek again to the track we want to see,
|
|
// because gstreamer thinks we are already there and will do nothing. We
|
|
// therefore seek to the previous track and resume from there.
|
|
// note(lumip): There's a slight risk of an infinite loop here where if
|
|
// the above behavior repeats consistently, but in my tests this does not
|
|
// happen.
|
|
if (track_number_from_tags < track_number_from_query) {
|
|
qLog(Debug) << "message query mismatch! : " << track_number_from_tags
|
|
<< " vs " << track_number_from_query;
|
|
gst_element_seek_simple(
|
|
pipeline, track_fmt,
|
|
static_cast<GstSeekFlags>(GST_SEEK_FLAG_FLUSH |
|
|
GST_SEEK_FLAG_TRICKMODE),
|
|
track_number_from_tags);
|
|
continue;
|
|
}
|
|
gint next_track_number = track_number_from_tags + 1;
|
|
|
|
if (next_track_number < num_tracks) {
|
|
// more to go, seek to next track to get a tag message for it
|
|
gst_element_seek_simple(
|
|
pipeline, track_fmt,
|
|
static_cast<GstSeekFlags>(GST_SEEK_FLAG_FLUSH |
|
|
GST_SEEK_FLAG_TRICKMODE),
|
|
next_track_number);
|
|
} else // we are done with reading track tags: do no longer filter
|
|
msg_filter = static_cast<GstMessageType>(static_cast<int>(msg_filter) ^
|
|
GST_MESSAGE_TAG);
|
|
}
|
|
gst_message_unref(msg);
|
|
}
|
|
if (loaded_cd_tags) emit SongsMetadataLoaded(tagged_song_list);
|
|
|
|
if (!musicbrainz_discid.isEmpty())
|
|
emit MusicBrainzDiscIdLoaded(musicbrainz_discid);
|
|
else {
|
|
// no musicbrainz id was loaded, no further udpates will follow
|
|
emit Finished();
|
|
}
|
|
|
|
// cleanup
|
|
gst_element_set_state(pipeline, GST_STATE_NULL);
|
|
// This will also cause cdda_ to be unref'd.
|
|
gst_object_unref(pipeline);
|
|
}
|
|
|
|
void CddaSongLoader::LoadAudioCDTags(const QString& musicbrainz_discid) const {
|
|
MusicBrainzClient* musicbrainz_client = new MusicBrainzClient;
|
|
connect(musicbrainz_client,
|
|
SIGNAL(Finished(const QString&, const QString&,
|
|
MusicBrainzClient::ResultList)),
|
|
SLOT(ProcessMusicBrainzResponse(const QString&, const QString&,
|
|
MusicBrainzClient::ResultList)));
|
|
|
|
musicbrainz_client->StartDiscIdRequest(musicbrainz_discid);
|
|
}
|
|
|
|
void CddaSongLoader::ProcessMusicBrainzResponse(
|
|
const QString& artist, const QString& album,
|
|
const MusicBrainzClient::ResultList& results) {
|
|
MusicBrainzClient* musicbrainz_client =
|
|
qobject_cast<MusicBrainzClient*>(sender());
|
|
musicbrainz_client->deleteLater();
|
|
if (results.empty()) {
|
|
// no real update; signal that no further updates will follow now
|
|
emit Finished();
|
|
return;
|
|
}
|
|
|
|
{
|
|
QMutexLocker lock(&disc_mutex_);
|
|
|
|
if (disc_.tracks.length() != results.length()) {
|
|
qLog(Warning) << "Number of tracks in metadata does not match number of "
|
|
"songs on disc!";
|
|
// no idea how to recover; signal that no further updates will follow now
|
|
emit Finished();
|
|
return;
|
|
}
|
|
|
|
for (int i = 0; i < results.length(); ++i) {
|
|
const MusicBrainzClient::Result& new_song_info = results[i];
|
|
Song& song = disc_.tracks[i];
|
|
|
|
if (!disc_.has_titles) song.set_title(new_song_info.title_);
|
|
if (song.album().isEmpty()) song.set_album(album);
|
|
if (song.artist().isEmpty()) song.set_artist(artist);
|
|
|
|
if (song.length_nanosec() == -1)
|
|
song.set_length_nanosec(new_song_info.duration_msec_ * kNsecPerMsec);
|
|
if (song.track() < 1) song.set_track(new_song_info.track_);
|
|
if (song.year() == -1) song.set_year(new_song_info.year_);
|
|
}
|
|
disc_.has_titles = true;
|
|
}
|
|
|
|
emit SongsMetadataLoaded(disc_.tracks);
|
|
emit Finished(); // no further updates will follow
|
|
}
|
|
|
|
void CddaSongLoader::SetDiscTracks(const SongList& songs, bool has_titles) {
|
|
QMutexLocker lock(&disc_mutex_);
|
|
disc_.tracks = songs;
|
|
disc_.has_titles = has_titles;
|
|
emit SongsUpdated(disc_.tracks);
|
|
}
|
|
|
|
SongList CddaSongLoader::cached_tracks() const {
|
|
QMutexLocker lock(&disc_mutex_);
|
|
return disc_.tracks;
|
|
}
|