/* This file is part of Strawberry. Copyright 2013, David Sansome Copyright 2018-2021, Jonas Kvinge Strawberry 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. Strawberry 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 Strawberry. If not, see . */ #include "config.h" #include "tagreadertaglib.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #ifdef HAVE_TAGLIB_DSFFILE # include #endif #ifdef HAVE_TAGLIB_DSDIFFFILE # include #endif #include #include #include #include #include #include #include #include #include #include "core/logging.h" #include "core/messagehandler.h" #include "core/timeconstants.h" class FileRefFactory { public: FileRefFactory() = default; virtual ~FileRefFactory() = default; virtual TagLib::FileRef *GetFileRef(const QString &filename) = 0; private: Q_DISABLE_COPY(FileRefFactory) }; class TagLibFileRefFactory : public FileRefFactory { public: TagLibFileRefFactory() = default; TagLib::FileRef *GetFileRef(const QString &filename) override { #ifdef Q_OS_WIN32 return new TagLib::FileRef(filename.toStdWString().c_str()); #else return new TagLib::FileRef(QFile::encodeName(filename).constData()); #endif } private: Q_DISABLE_COPY(TagLibFileRefFactory) }; namespace { TagLib::String StdStringToTaglibString(const std::string &s) { return TagLib::String(s.c_str(), TagLib::String::UTF8); } TagLib::String QStringToTaglibString(const QString &s) { return TagLib::String(s.toUtf8().constData(), TagLib::String::UTF8); } } // namespace namespace { const char *kMP4_OriginalYear_ID = "----:com.apple.iTunes:ORIGINAL YEAR"; const char *kMP4_FMPS_Playcount_ID = "----:com.apple.iTunes:FMPS_Playcount"; const char *kMP4_FMPS_Rating_ID = "----:com.apple.iTunes:FMPS_Rating"; const char *kASF_OriginalDate_ID = "WM/OriginalReleaseTime"; const char *kASF_OriginalYear_ID = "WM/OriginalReleaseYear"; } // namespace TagReaderTagLib::TagReaderTagLib() : factory_(new TagLibFileRefFactory) {} TagReaderTagLib::~TagReaderTagLib() { delete factory_; } bool TagReaderTagLib::IsMediaFile(const QString &filename) const { qLog(Debug) << "Checking for valid file" << filename; std::unique_ptr fileref(factory_->GetFileRef(filename)); return fileref && !fileref->isNull() && fileref->file() && fileref->tag(); } spb::tagreader::SongMetadata_FileType TagReaderTagLib::GuessFileType(TagLib::FileRef *fileref) const { if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_WAV; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_FLAC; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_WAVPACK; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_OGGFLAC; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_OGGVORBIS; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_OGGOPUS; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_OGGSPEEX; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_MPEG; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_MP4; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_ASF; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_AIFF; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_MPC; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_TRUEAUDIO; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_APE; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_MOD; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_S3M; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_XM; if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_IT; #ifdef HAVE_TAGLIB_DSFFILE if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_DSF; #endif #ifdef HAVE_TAGLIB_DSDIFFFILE if (dynamic_cast(fileref->file())) return spb::tagreader::SongMetadata_FileType_DSDIFF; #endif return spb::tagreader::SongMetadata_FileType_UNKNOWN; } void TagReaderTagLib::ReadFile(const QString &filename, spb::tagreader::SongMetadata *song) const { const QByteArray url(QUrl::fromLocalFile(filename).toEncoded()); const QFileInfo fileinfo(filename); qLog(Debug) << "Reading tags from" << filename; song->set_basefilename(DataCommaSizeFromQString(fileinfo.fileName())); song->set_url(url.constData(), url.size()); song->set_filesize(fileinfo.size()); song->set_mtime(fileinfo.lastModified().isValid() ? fileinfo.lastModified().toSecsSinceEpoch() : 0); #if (QT_VERSION >= QT_VERSION_CHECK(5, 10, 0)) song->set_ctime(fileinfo.birthTime().isValid() ? fileinfo.birthTime().toSecsSinceEpoch() : fileinfo.lastModified().isValid() ? fileinfo.lastModified().toSecsSinceEpoch() : 0); #else song->set_ctime(fileinfo.created().isValid() ? fileinfo.created().toSecsSinceEpoch() : fileinfo.lastModified().isValid() ? fileinfo.lastModified().toSecsSinceEpoch() : 0); #endif song->set_lastseen(QDateTime::currentDateTime().toSecsSinceEpoch()); std::unique_ptr fileref(factory_->GetFileRef(filename)); if (fileref->isNull()) { qLog(Info) << "TagLib hasn't been able to read" << filename << "file"; return; } song->set_filetype(GuessFileType(fileref.get())); if (fileref->audioProperties()) { song->set_bitrate(fileref->audioProperties()->bitrate()); song->set_samplerate(fileref->audioProperties()->sampleRate()); song->set_length_nanosec(fileref->audioProperties()->lengthInMilliseconds() * kNsecPerMsec); } TagLib::Tag *tag = fileref->tag(); if (tag) { Decode(tag->title(), song->mutable_title()); Decode(tag->artist(), song->mutable_artist()); // TPE1 Decode(tag->album(), song->mutable_album()); Decode(tag->genre(), song->mutable_genre()); song->set_year(static_cast(tag->year())); song->set_track(static_cast(tag->track())); song->set_valid(true); } QString disc; QString compilation; QString lyrics; // Handle all the files which have VorbisComments (Ogg, OPUS, ...) in the same way; // apart, so we keep specific behavior for some formats by adding another "else if" block below. if (TagLib::Ogg::XiphComment *xiph_comment = dynamic_cast(fileref->file()->tag())) { ParseOggTag(xiph_comment->fieldListMap(), &disc, &compilation, song); TagLib::List pictures = xiph_comment->pictureList(); if (!pictures.isEmpty()) { for (TagLib::FLAC::Picture *picture : pictures) { if (picture->type() == TagLib::FLAC::Picture::FrontCover && picture->data().size() > 0) { song->set_art_automatic(kEmbeddedCover); break; } } } } if (TagLib::FLAC::File *file_flac = dynamic_cast(fileref->file())) { song->set_bitdepth(file_flac->audioProperties()->bitsPerSample()); if (file_flac->xiphComment()) { ParseOggTag(file_flac->xiphComment()->fieldListMap(), &disc, &compilation, song); TagLib::List pictures = file_flac->pictureList(); if (!pictures.isEmpty()) { for (TagLib::FLAC::Picture *picture : pictures) { if (picture->type() == TagLib::FLAC::Picture::FrontCover && picture->data().size() > 0) { song->set_art_automatic(kEmbeddedCover); break; } } } } if (tag) Decode(tag->comment(), song->mutable_comment()); } else if (TagLib::WavPack::File *file_wavpack = dynamic_cast(fileref->file())) { song->set_bitdepth(file_wavpack->audioProperties()->bitsPerSample()); if (file_wavpack->APETag()) { ParseAPETag(file_wavpack->APETag()->itemListMap(), &disc, &compilation, song); } if (tag) Decode(tag->comment(), song->mutable_comment()); } else if (TagLib::APE::File *file_ape = dynamic_cast(fileref->file())) { if (file_ape->APETag()) { ParseAPETag(file_ape->APETag()->itemListMap(), &disc, &compilation, song); } song->set_bitdepth(file_ape->audioProperties()->bitsPerSample()); if (tag) Decode(tag->comment(), song->mutable_comment()); } else if (TagLib::MPEG::File *file_mpeg = dynamic_cast(fileref->file())) { if (file_mpeg->ID3v2Tag()) { const TagLib::ID3v2::FrameListMap &map = file_mpeg->ID3v2Tag()->frameListMap(); if (!map["TPOS"].isEmpty()) disc = TStringToQString(map["TPOS"].front()->toString()).trimmed(); if (!map["TCOM"].isEmpty()) Decode(map["TCOM"].front()->toString(), song->mutable_composer()); // content group if (!map["TIT1"].isEmpty()) Decode(map["TIT1"].front()->toString(), song->mutable_grouping()); // ID3v2: lead performer/soloist if (!map["TPE1"].isEmpty()) Decode(map["TPE1"].front()->toString(), song->mutable_performer()); // original artist/performer if (!map["TOPE"].isEmpty()) Decode(map["TOPE"].front()->toString(), song->mutable_performer()); // Skip TPE1 (which is the artist) here because we already fetched it // non-standard: Apple, Microsoft if (!map["TPE2"].isEmpty()) Decode(map["TPE2"].front()->toString(), song->mutable_albumartist()); if (!map["TCMP"].isEmpty()) compilation = TStringToQString(map["TCMP"].front()->toString()).trimmed(); if (!map["TDOR"].isEmpty()) { song->set_originalyear(map["TDOR"].front()->toString().substr(0, 4).toInt()); } else if (!map["TORY"].isEmpty()) { song->set_originalyear(map["TORY"].front()->toString().substr(0, 4).toInt()); } if (!map["USLT"].isEmpty()) { Decode(map["USLT"].front()->toString(), song->mutable_lyrics()); } else if (!map["SYLT"].isEmpty()) { Decode(map["SYLT"].front()->toString(), song->mutable_lyrics()); } if (!map["APIC"].isEmpty()) song->set_art_automatic(kEmbeddedCover); // Find a suitable comment tag. For now we ignore iTunNORM comments. for (uint i = 0 ; i < map["COMM"].size() ; ++i) { const TagLib::ID3v2::CommentsFrame *frame = dynamic_cast(map["COMM"][i]); if (frame && TStringToQString(frame->description()) != "iTunNORM") { Decode(frame->text(), song->mutable_comment()); break; } } if (TagLib::ID3v2::UserTextIdentificationFrame *frame_fmps_rating = TagLib::ID3v2::UserTextIdentificationFrame::find(file_mpeg->ID3v2Tag(), "FMPS_Rating")) { TagLib::StringList frame_field_list = frame_fmps_rating->fieldList(); if (frame_field_list.size() > 1) { float rating = TStringToQString(frame_field_list[1]).toFloat(); if (song->rating() <= 0 && rating > 0 && rating <= 1.0) { song->set_rating(rating); } } } if (!map["POPM"].isEmpty()) { const TagLib::ID3v2::PopularimeterFrame *frame = dynamic_cast(map["POPM"].front()); if (frame) { if (song->playcount() <= 0 && frame->counter() > 0) { song->set_playcount(frame->counter()); } if (song->rating() <= 0 && frame->rating() > 0) { song->set_rating(ConvertPOPMRating(frame->rating())); } } } } } else if (TagLib::MP4::File *file_mp4 = dynamic_cast(fileref->file())) { song->set_bitdepth(file_mp4->audioProperties()->bitsPerSample()); if (file_mp4->tag()) { TagLib::MP4::Tag *mp4_tag = file_mp4->tag(); // Find album artists if (mp4_tag->item("aART").isValid()) { TagLib::StringList album_artists = mp4_tag->item("aART").toStringList(); if (!album_artists.isEmpty()) { Decode(album_artists.front(), song->mutable_albumartist()); } } // Find album cover art if (mp4_tag->item("covr").isValid()) { song->set_art_automatic(kEmbeddedCover); } if (mp4_tag->item("disk").isValid()) { disc = TStringToQString(TagLib::String::number(mp4_tag->item("disk").toIntPair().first)); } if (mp4_tag->item("\251wrt").isValid()) { Decode(mp4_tag->item("\251wrt").toStringList().toString(", "), song->mutable_composer()); } if (mp4_tag->item("\251grp").isValid()) { Decode(mp4_tag->item("\251grp").toStringList().toString(" "), song->mutable_grouping()); } if (mp4_tag->item("\251lyr").isValid()) { Decode(mp4_tag->item("\251lyr").toStringList().toString(" "), song->mutable_lyrics()); } if (mp4_tag->item(kMP4_OriginalYear_ID).isValid()) { song->set_originalyear(TStringToQString(mp4_tag->item(kMP4_OriginalYear_ID).toStringList().toString('\n')).left(4).toInt()); } { TagLib::MP4::Item item = mp4_tag->item(kMP4_FMPS_Playcount_ID); if (item.isValid()) { const int playcount = TStringToQString(item.toStringList().toString('\n')).toInt(); if (song->playcount() <= 0 && playcount > 0) { song->set_playcount(static_cast(playcount)); } } } { TagLib::MP4::Item item = mp4_tag->item(kMP4_FMPS_Rating_ID); if (item.isValid()) { const float rating = TStringToQString(item.toStringList().toString('\n')).toFloat(); if (song->rating() <= 0 && rating > 0) { song->set_rating(rating); } } } Decode(mp4_tag->comment(), song->mutable_comment()); } } else if (TagLib::ASF::File *file_asf = dynamic_cast(fileref->file())) { song->set_bitdepth(file_asf->audioProperties()->bitsPerSample()); if (file_asf->tag()) { Decode(file_asf->tag()->comment(), song->mutable_comment()); const TagLib::ASF::AttributeListMap &attributes_map = file_asf->tag()->attributeListMap(); if (attributes_map.contains(kASF_OriginalDate_ID)) { const TagLib::ASF::AttributeList &attributes = attributes_map[kASF_OriginalDate_ID]; if (!attributes.isEmpty()) { song->set_originalyear(TStringToQString(attributes.front().toString()).left(4).toInt()); } } else if (attributes_map.contains(kASF_OriginalYear_ID)) { const TagLib::ASF::AttributeList &attributes = attributes_map[kASF_OriginalYear_ID]; if (!attributes.isEmpty()) { song->set_originalyear(TStringToQString(attributes.front().toString()).left(4).toInt()); } } if (attributes_map.contains("FMPS/Playcount")) { const TagLib::ASF::AttributeList &attributes = attributes_map["FMPS/Playcount"]; if (!attributes.isEmpty()) { int playcount = TStringToQString(attributes.front().toString()).toInt(); if (song->playcount() <= 0 && playcount > 0) { song->set_playcount(static_cast(playcount)); } } } if (attributes_map.contains("FMPS/Rating")) { const TagLib::ASF::AttributeList& attributes = attributes_map["FMPS/Rating"]; if (!attributes.isEmpty()) { float rating = TStringToQString(attributes.front().toString()).toFloat(); if (song->rating() <= 0 && rating > 0) { song->set_rating(rating); } } } } } else if (TagLib::MPC::File *file_mpc = dynamic_cast(fileref->file())) { if (file_mpc->APETag()) { ParseAPETag(file_mpc->APETag()->itemListMap(), &disc, &compilation, song); } if (tag) Decode(tag->comment(), song->mutable_comment()); } else if (tag) { Decode(tag->comment(), song->mutable_comment()); } if (!disc.isEmpty()) { const qint64 i = disc.indexOf('/'); if (i != -1) { // disc.right( i ).toInt() is total number of discs, we don't use this at the moment song->set_disc(disc.left(i).toInt()); } else { song->set_disc(disc.toInt()); } } if (compilation.isEmpty()) { // well, it wasn't set, but if the artist is VA assume it's a compilation if (QStringFromStdString(song->artist()).compare("various artists") == 0 || QStringFromStdString(song->albumartist()).compare("various artists") == 0) { song->set_compilation(true); } } else { song->set_compilation(compilation.toInt() == 1); } if (!lyrics.isEmpty()) song->set_lyrics(lyrics.toStdString()); // Set integer fields to -1 if they're not valid if (song->track() <= 0) { song->set_track(-1); } if (song->disc() <= 0) { song->set_disc(-1); } if (song->year() <= 0) { song->set_year(-1); } if (song->originalyear() <= 0) { song->set_originalyear(-1); } if (song->samplerate() <= 0) { song->set_samplerate(-1); } if (song->bitdepth() <= 0) { song->set_bitdepth(-1); } if (song->bitrate() <= 0) { song->set_bitrate(-1); } if (song->lastplayed() <= 0) { song->set_lastplayed(-1); } } void TagReaderTagLib::Decode(const TagLib::String &tag, std::string *output) { QString tmp = TStringToQString(tag).trimmed(); output->assign(DataCommaSizeFromQString(tmp)); } void TagReaderTagLib::Decode(const QString &tag, std::string *output) { output->assign(DataCommaSizeFromQString(tag)); } void TagReaderTagLib::ParseOggTag(const TagLib::Ogg::FieldListMap &map, QString *disc, QString *compilation, spb::tagreader::SongMetadata *song) const { if (!map["COMPOSER"].isEmpty()) Decode(map["COMPOSER"].front(), song->mutable_composer()); if (!map["PERFORMER"].isEmpty()) Decode(map["PERFORMER"].front(), song->mutable_performer()); if (!map["CONTENT GROUP"].isEmpty()) Decode(map["CONTENT GROUP"].front(), song->mutable_grouping()); if (!map["GROUPING"].isEmpty()) Decode(map["GROUPING"].front(), song->mutable_grouping()); if (!map["ALBUMARTIST"].isEmpty()) Decode(map["ALBUMARTIST"].front(), song->mutable_albumartist()); else if (!map["ALBUM ARTIST"].isEmpty()) Decode(map["ALBUM ARTIST"].front(), song->mutable_albumartist()); if (!map["ORIGINALDATE"].isEmpty()) song->set_originalyear(TStringToQString(map["ORIGINALDATE"].front()).left(4).toInt()); else if (!map["ORIGINALYEAR"].isEmpty()) song->set_originalyear(TStringToQString(map["ORIGINALYEAR"].front()).toInt()); if (!map["DISCNUMBER"].isEmpty()) *disc = TStringToQString( map["DISCNUMBER"].front() ).trimmed(); if (!map["COMPILATION"].isEmpty()) *compilation = TStringToQString( map["COMPILATION"].front() ).trimmed(); if (!map["COVERART"].isEmpty()) song->set_art_automatic(kEmbeddedCover); if (!map["METADATA_BLOCK_PICTURE"].isEmpty()) song->set_art_automatic(kEmbeddedCover); if (!map["FMPS_PLAYCOUNT"].isEmpty() && song->playcount() <= 0) { const int playcount = TStringToQString(map["FMPS_PLAYCOUNT"].front()).trimmed().toInt(); song->set_playcount(static_cast(playcount)); } if (!map["FMPS_RATING"].isEmpty() && song->rating() <= 0) song->set_rating(TStringToQString(map["FMPS_RATING"].front()).trimmed().toFloat()); if (!map["LYRICS"].isEmpty()) Decode(map["LYRICS"].front(), song->mutable_lyrics()); else if (!map["UNSYNCEDLYRICS"].isEmpty()) Decode(map["UNSYNCEDLYRICS"].front(), song->mutable_lyrics()); } void TagReaderTagLib::ParseAPETag(const TagLib::APE::ItemListMap &map, QString *disc, QString *compilation, spb::tagreader::SongMetadata *song) const { TagLib::APE::ItemListMap::ConstIterator it = map.find("ALBUM ARTIST"); if (it != map.end()) { TagLib::StringList album_artists = it->second.values(); if (!album_artists.isEmpty()) { Decode(album_artists.front(), song->mutable_albumartist()); } } if (map.find("COVER ART (FRONT)") != map.end()) song->set_art_automatic(kEmbeddedCover); if (map.contains("COMPILATION")) { *compilation = TStringToQString(TagLib::String::number(map["COMPILATION"].toString().toInt())); } if (map.contains("DISC")) { *disc = TStringToQString(TagLib::String::number(map["DISC"].toString().toInt())); } if (map.contains("PERFORMER")) { Decode(map["PERFORMER"].values().toString(", "), song->mutable_performer()); } if (map.contains("COMPOSER")) { Decode(map["COMPOSER"].values().toString(", "), song->mutable_composer()); } if (map.contains("GROUPING")) { Decode(map["GROUPING"].values().toString(" "), song->mutable_grouping()); } if (map.contains("LYRICS")) { Decode(map["LYRICS"].toString(), song->mutable_lyrics()); } if (map.contains("FMPS_PLAYCOUNT")) { const int playcount = TStringToQString(map["FMPS_PLAYCOUNT"].toString()).toInt(); if (song->playcount() <= 0 && playcount > 0) { song->set_playcount(static_cast(playcount)); } } if (map.contains("FMPS_RATING")) { const float rating = TStringToQString(map["FMPS_RATING"].toString()).toFloat(); if (song->rating() <= 0 && rating > 0) { song->set_rating(rating); } } } void TagReaderTagLib::SetVorbisComments(TagLib::Ogg::XiphComment *vorbis_comments, const spb::tagreader::SongMetadata &song) const { vorbis_comments->addField("COMPOSER", StdStringToTaglibString(song.composer()), true); vorbis_comments->addField("PERFORMER", StdStringToTaglibString(song.performer()), true); vorbis_comments->addField("GROUPING", StdStringToTaglibString(song.grouping()), true); vorbis_comments->addField("DISCNUMBER", QStringToTaglibString(song.disc() <= 0 ? QString() : QString::number(song.disc())), true); vorbis_comments->addField("COMPILATION", QStringToTaglibString(song.compilation() ? "1" : QString()), true); // Try to be coherent, the two forms are used but the first one is preferred vorbis_comments->addField("ALBUMARTIST", StdStringToTaglibString(song.albumartist()), true); vorbis_comments->removeFields("ALBUM ARTIST"); vorbis_comments->addField("LYRICS", StdStringToTaglibString(song.lyrics()), true); vorbis_comments->removeFields("UNSYNCEDLYRICS"); } bool TagReaderTagLib::SaveFile(const QString &filename, const spb::tagreader::SongMetadata &song) const { if (filename.isEmpty()) return false; qLog(Debug) << "Saving tags to" << filename; std::unique_ptr fileref(factory_->GetFileRef(filename));; if (!fileref || fileref->isNull()) return false; fileref->tag()->setTitle(song.title().empty() ? TagLib::String() : StdStringToTaglibString(song.title())); fileref->tag()->setArtist(song.artist().empty() ? TagLib::String() : StdStringToTaglibString(song.artist())); fileref->tag()->setAlbum(song.album().empty() ? TagLib::String() : StdStringToTaglibString(song.album())); fileref->tag()->setGenre(song.genre().empty() ? TagLib::String() : StdStringToTaglibString(song.genre())); fileref->tag()->setComment(song.comment().empty() ? TagLib::String() : StdStringToTaglibString(song.comment())); fileref->tag()->setYear(song.year() <= 0 ? 0 : song.year()); fileref->tag()->setTrack(song.track() <= 0 ? 0 : song.track()); bool result = false; if (TagLib::FLAC::File *file_flac = dynamic_cast(fileref->file())) { TagLib::Ogg::XiphComment *tag = file_flac->xiphComment(true); if (!tag) return false; SetVorbisComments(tag, song); } else if (TagLib::WavPack::File *file_wavpack = dynamic_cast(fileref->file())) { TagLib::APE::Tag *tag = file_wavpack->APETag(true); if (!tag) return false; SaveAPETag(tag, song); } else if (TagLib::APE::File *file_ape = dynamic_cast(fileref->file())) { TagLib::APE::Tag *tag = file_ape->APETag(true); if (!tag) return false; SaveAPETag(tag, song); } else if (TagLib::MPC::File *file_mpc = dynamic_cast(fileref->file())) { TagLib::APE::Tag *tag = file_mpc->APETag(true); if (!tag) return false; SaveAPETag(tag, song); } else if (TagLib::MPEG::File *file_mpeg = dynamic_cast(fileref->file())) { TagLib::ID3v2::Tag *tag = file_mpeg->ID3v2Tag(true); if (!tag) return false; SetTextFrame("TPOS", song.disc() <= 0 ? QString() : QString::number(song.disc()), tag); SetTextFrame("TCOM", song.composer().empty() ? std::string() : song.composer(), tag); SetTextFrame("TIT1", song.grouping().empty() ? std::string() : song.grouping(), tag); SetTextFrame("TOPE", song.performer().empty() ? std::string() : song.performer(), tag); // Skip TPE1 (which is the artist) here because we already set it SetTextFrame("TPE2", song.albumartist().empty() ? std::string() : song.albumartist(), tag); SetTextFrame("TCMP", song.compilation() ? QString::number(1) : QString(), tag); SetUnsyncLyricsFrame(song.lyrics().empty() ? std::string() : song.lyrics(), tag); } else if (TagLib::MP4::File *file_mp4 = dynamic_cast(fileref->file())) { TagLib::MP4::Tag *tag = file_mp4->tag(); if (!tag) return false; tag->setItem("disk", TagLib::MP4::Item(song.disc() <= 0 -1 ? 0 : song.disc(), 0)); tag->setItem("\251wrt", TagLib::StringList(TagLib::String(song.composer(), TagLib::String::UTF8))); tag->setItem("\251grp", TagLib::StringList(TagLib::String(song.grouping(), TagLib::String::UTF8))); tag->setItem("\251lyr", TagLib::StringList(TagLib::String(song.lyrics(), TagLib::String::UTF8))); tag->setItem("aART", TagLib::StringList(TagLib::String(song.albumartist(), TagLib::String::UTF8))); tag->setItem("cpil", TagLib::StringList(song.compilation() ? "1" : "0")); } // Handle all the files which have VorbisComments (Ogg, OPUS, ...) in the same way; // apart, so we keep specific behavior for some formats by adding another "else if" block above. if (TagLib::Ogg::XiphComment *xiph_comment = dynamic_cast(fileref->file()->tag())) { SetVorbisComments(xiph_comment, song); } result = fileref->save(); #ifdef Q_OS_LINUX if (result) { // Linux: inotify doesn't seem to notice the change to the file unless we change the timestamps as well. (this is what touch does) utimensat(0, QFile::encodeName(filename).constData(), nullptr, 0); } #endif // Q_OS_LINUX return result; } void TagReaderTagLib::SaveAPETag(TagLib::APE::Tag *tag, const spb::tagreader::SongMetadata &song) const { tag->setItem("album artist", TagLib::APE::Item("album artist", TagLib::StringList(song.albumartist().c_str()))); tag->addValue("disc", QStringToTaglibString(song.disc() <= 0 ? QString() : QString::number(song.disc())), true); tag->setItem("composer", TagLib::APE::Item("composer", TagLib::StringList(song.composer().c_str()))); tag->setItem("grouping", TagLib::APE::Item("grouping", TagLib::StringList(song.grouping().c_str()))); tag->setItem("performer", TagLib::APE::Item("performer", TagLib::StringList(song.performer().c_str()))); tag->setItem("lyrics", TagLib::APE::Item("lyrics", TagLib::String(song.lyrics()))); tag->addValue("compilation", QStringToTaglibString(song.compilation() ? QString::number(1) : QString()), true); } void TagReaderTagLib::SetTextFrame(const char *id, const QString &value, TagLib::ID3v2::Tag *tag) const { const QByteArray utf8(value.toUtf8()); SetTextFrame(id, std::string(utf8.constData(), utf8.length()), tag); } void TagReaderTagLib::SetTextFrame(const char *id, const std::string &value, TagLib::ID3v2::Tag *tag) const { TagLib::ByteVector id_vector(id); QVector frames_buffer; // Store and clear existing frames while (tag->frameListMap().contains(id_vector) && tag->frameListMap()[id_vector].size() != 0) { frames_buffer.push_back(tag->frameListMap()[id_vector].front()->render()); tag->removeFrame(tag->frameListMap()[id_vector].front()); } if (value.empty()) return; // If no frames stored create empty frame if (frames_buffer.isEmpty()) { TagLib::ID3v2::TextIdentificationFrame frame(id_vector, TagLib::String::UTF8); frames_buffer.push_back(frame.render()); } // Update and add the frames for (int i = 0 ; i < frames_buffer.size() ; ++i) { TagLib::ID3v2::TextIdentificationFrame *frame = new TagLib::ID3v2::TextIdentificationFrame(frames_buffer.at(i)); if (i == 0) { frame->setText(StdStringToTaglibString(value)); } // add frame takes ownership and clears the memory tag->addFrame(frame); } } void TagReaderTagLib::SetUserTextFrame(const QString &description, const QString &value, TagLib::ID3v2::Tag *tag) const { const QByteArray descr_utf8(description.toUtf8()); const QByteArray value_utf8(value.toUtf8()); SetUserTextFrame(std::string(descr_utf8.constData(), descr_utf8.length()), std::string(value_utf8.constData(), value_utf8.length()), tag); } void TagReaderTagLib::SetUserTextFrame(const std::string &description, const std::string &value, TagLib::ID3v2::Tag *tag) const { const TagLib::String t_description = StdStringToTaglibString(description); TagLib::ID3v2::UserTextIdentificationFrame *frame = TagLib::ID3v2::UserTextIdentificationFrame::find(tag, t_description); if (frame) { tag->removeFrame(frame); } // Create and add a new frame frame = new TagLib::ID3v2::UserTextIdentificationFrame(TagLib::String::UTF8); frame->setDescription(t_description); frame->setText(StdStringToTaglibString(value)); tag->addFrame(frame); } void TagReaderTagLib::SetUnsyncLyricsFrame(const std::string &value, TagLib::ID3v2::Tag *tag) const { TagLib::ByteVector id_vector("USLT"); QVector frames_buffer; // Store and clear existing frames while (tag->frameListMap().contains(id_vector) && tag->frameListMap()[id_vector].size() != 0) { frames_buffer.push_back(tag->frameListMap()[id_vector].front()->render()); tag->removeFrame(tag->frameListMap()[id_vector].front()); } if (value.empty()) return; // If no frames stored create empty frame if (frames_buffer.isEmpty()) { TagLib::ID3v2::UnsynchronizedLyricsFrame frame(TagLib::String::UTF8); frame.setDescription("Clementine editor"); frames_buffer.push_back(frame.render()); } // Update and add the frames for (int i = 0 ; i < frames_buffer.size() ; ++i) { TagLib::ID3v2::UnsynchronizedLyricsFrame *frame = new TagLib::ID3v2::UnsynchronizedLyricsFrame(frames_buffer.at(i)); if (i == 0) { frame->setText(StdStringToTaglibString(value)); } // add frame takes ownership and clears the memory tag->addFrame(frame); } } QByteArray TagReaderTagLib::LoadEmbeddedArt(const QString &filename) const { if (filename.isEmpty()) return QByteArray(); qLog(Debug) << "Loading art from" << filename; #ifdef Q_OS_WIN32 TagLib::FileRef fileref(filename.toStdWString().c_str()); #else TagLib::FileRef fileref(QFile::encodeName(filename).constData()); #endif if (fileref.isNull() || !fileref.file()) return QByteArray(); // FLAC if (TagLib::FLAC::File *flac_file = dynamic_cast(fileref.file())) { if (flac_file->xiphComment()) { TagLib::List pictures = flac_file->pictureList(); if (!pictures.isEmpty()) { for (TagLib::FLAC::Picture *picture : pictures) { if (picture->type() == TagLib::FLAC::Picture::FrontCover && picture->data().size() > 0) { QByteArray data(picture->data().data(), picture->data().size()); if (!data.isEmpty()) { return data; } } } } } } // WavPack if (TagLib::WavPack::File *wavpack_file = dynamic_cast(fileref.file())) { if (wavpack_file->APETag()) { return LoadEmbeddedAPEArt(wavpack_file->APETag()->itemListMap()); } } // APE if (TagLib::APE::File *ape_file = dynamic_cast(fileref.file())) { if (ape_file->APETag()) { return LoadEmbeddedAPEArt(ape_file->APETag()->itemListMap()); } } // MPC if (TagLib::MPC::File *mpc_file = dynamic_cast(fileref.file())) { if (mpc_file->APETag()) { return LoadEmbeddedAPEArt(mpc_file->APETag()->itemListMap()); } } // Ogg Vorbis / Opus / Speex if (TagLib::Ogg::XiphComment *xiph_comment = dynamic_cast(fileref.file()->tag())) { TagLib::Ogg::FieldListMap map = xiph_comment->fieldListMap(); TagLib::List pictures = xiph_comment->pictureList(); if (!pictures.isEmpty()) { for (TagLib::FLAC::Picture *picture : pictures) { if (picture->type() == TagLib::FLAC::Picture::FrontCover && picture->data().size() > 0) { QByteArray data(picture->data().data(), picture->data().size()); if (!data.isEmpty()) { return data; } } } } // Ogg lacks a definitive standard for embedding cover art, but it seems b64 encoding a field called COVERART is the general convention if (map.contains("COVERART")) { return QByteArray::fromBase64(map["COVERART"].toString().toCString()); } return QByteArray(); } // MP3 if (TagLib::MPEG::File *file_mp3 = dynamic_cast(fileref.file())) { if (file_mp3->ID3v2Tag()) { TagLib::ID3v2::FrameList apic_frames = file_mp3->ID3v2Tag()->frameListMap()["APIC"]; if (apic_frames.isEmpty()) { return QByteArray(); } TagLib::ID3v2::AttachedPictureFrame *picture = static_cast(apic_frames.front()); return QByteArray(reinterpret_cast(picture->picture().data()), picture->picture().size()); } } // MP4/AAC if (TagLib::MP4::File *aac_file = dynamic_cast(fileref.file())) { TagLib::MP4::Tag *tag = aac_file->tag(); if (tag && tag->item("covr").isValid()) { const TagLib::MP4::CoverArtList &art_list = tag->item("covr").toCoverArtList(); if (!art_list.isEmpty()) { // Just take the first one for now const TagLib::MP4::CoverArt &art = art_list.front(); return QByteArray(art.data().data(), art.data().size()); } } } return QByteArray(); } QByteArray TagReaderTagLib::LoadEmbeddedAPEArt(const TagLib::APE::ItemListMap &map) const { QByteArray ret; TagLib::APE::ItemListMap::ConstIterator it = map.find("COVER ART (FRONT)"); if (it != map.end()) { TagLib::ByteVector data = it->second.binaryData(); int pos = data.find('\0') + 1; if ((pos > 0) && (static_cast(pos) < data.size())) { ret = QByteArray(data.data() + pos, data.size() - pos); } } return ret; } bool TagReaderTagLib::SaveEmbeddedArt(const QString &filename, const QByteArray &data) { if (filename.isEmpty()) return false; qLog(Debug) << "Saving art to" << filename; #ifdef Q_OS_WIN32 TagLib::FileRef fileref(filename.toStdWString().c_str()); #else TagLib::FileRef fileref(QFile::encodeName(filename).constData()); #endif if (fileref.isNull() || !fileref.file()) return false; // FLAC if (TagLib::FLAC::File *flac_file = dynamic_cast(fileref.file())) { TagLib::Ogg::XiphComment *vorbis_comments = flac_file->xiphComment(true); if (!vorbis_comments) return false; flac_file->removePictures(); if (!data.isEmpty()) { TagLib::FLAC::Picture *picture = new TagLib::FLAC::Picture(); picture->setType(TagLib::FLAC::Picture::FrontCover); picture->setMimeType("image/jpeg"); picture->setData(TagLib::ByteVector(data.constData(), data.size())); flac_file->addPicture(picture); } } // Ogg Vorbis / Opus / Speex else if (TagLib::Ogg::XiphComment *xiph_comment = dynamic_cast(fileref.file()->tag())) { xiph_comment->removeAllPictures(); if (!data.isEmpty()) { TagLib::FLAC::Picture *picture = new TagLib::FLAC::Picture(); picture->setType(TagLib::FLAC::Picture::FrontCover); picture->setMimeType("image/jpeg"); picture->setData(TagLib::ByteVector(data.constData(), data.size())); xiph_comment->addPicture(picture); } } // MP3 else if (TagLib::MPEG::File *file_mp3 = dynamic_cast(fileref.file())) { TagLib::ID3v2::Tag *tag = file_mp3->ID3v2Tag(); if (!tag) return false; // Remove existing covers TagLib::ID3v2::FrameList apiclist = tag->frameListMap()["APIC"]; for (TagLib::ID3v2::FrameList::ConstIterator it = apiclist.begin() ; it != apiclist.end() ; ++it ) { TagLib::ID3v2::AttachedPictureFrame *frame = dynamic_cast(*it); tag->removeFrame(frame, false); } if (!data.isEmpty()) { // Add new cover TagLib::ID3v2::AttachedPictureFrame *frontcover = nullptr; frontcover = new TagLib::ID3v2::AttachedPictureFrame("APIC"); frontcover->setType(TagLib::ID3v2::AttachedPictureFrame::FrontCover); frontcover->setMimeType("image/jpeg"); frontcover->setPicture(TagLib::ByteVector(data.constData(), data.count())); tag->addFrame(frontcover); } } // MP4/AAC else if (TagLib::MP4::File *aac_file = dynamic_cast(fileref.file())) { TagLib::MP4::Tag *tag = aac_file->tag(); if (!tag) return false; TagLib::MP4::CoverArtList covers; if (data.isEmpty()) { if (tag->contains("covr")) tag->removeItem("covr"); } else { covers.append(TagLib::MP4::CoverArt(TagLib::MP4::CoverArt::JPEG, TagLib::ByteVector(data.constData(), data.count()))); tag->setItem("covr", covers); } } // Not supported. else return false; return fileref.file()->save(); } TagLib::ID3v2::PopularimeterFrame *TagReaderTagLib::GetPOPMFrameFromTag(TagLib::ID3v2::Tag *tag) { TagLib::ID3v2::PopularimeterFrame *frame = nullptr; const TagLib::ID3v2::FrameListMap &map = tag->frameListMap(); if (!map["POPM"].isEmpty()) { frame = dynamic_cast(map["POPM"].front()); } if (!frame) { frame = new TagLib::ID3v2::PopularimeterFrame(); tag->addFrame(frame); } return frame; } float TagReaderTagLib::ConvertPOPMRating(const int POPM_rating) { if (POPM_rating < 0x01) return 0.0; else if (POPM_rating < 0x40) return 0.20; else if (POPM_rating < 0x80) return 0.40; else if (POPM_rating < 0xC0) return 0.60; else if (POPM_rating < 0xFC) return 0.80; return 1.0; } int TagReaderTagLib::ConvertToPOPMRating(const float rating) { if (rating < 0.20) return 0x00; else if (rating < 0.40) return 0x01; else if (rating < 0.60) return 0x40; else if (rating < 0.80) return 0x80; else if (rating < 1.0) return 0xC0; return 0xFF; } bool TagReaderTagLib::SaveSongPlaycountToFile(const QString &filename, const spb::tagreader::SongMetadata &song) const { if (filename.isEmpty()) return false; qLog(Debug) << "Saving song playcount to" << filename; std::unique_ptr fileref(factory_->GetFileRef(filename)); if (!fileref || fileref->isNull()) return false; if (TagLib::FLAC::File *flac_file = dynamic_cast(fileref->file())) { TagLib::Ogg::XiphComment *vorbis_comments = flac_file->xiphComment(true); if (!vorbis_comments) return false; if (song.playcount() > 0) { vorbis_comments->addField("FMPS_PLAYCOUNT", TagLib::String::number(static_cast(song.playcount())), true); } else { vorbis_comments->removeFields("FMPS_PLAYCOUNT"); } } else if (TagLib::WavPack::File *wavpack_file = dynamic_cast(fileref->file())) { TagLib::APE::Tag *tag = wavpack_file->APETag(true); if (!tag) return false; if (song.playcount() > 0) { tag->setItem("FMPS_PlayCount", TagLib::APE::Item("FMPS_PlayCount", TagLib::String::number(static_cast(song.playcount())))); } } else if (TagLib::APE::File *ape_file = dynamic_cast(fileref->file())) { TagLib::APE::Tag *tag = ape_file->APETag(true); if (!tag) return false; if (song.playcount() > 0) { tag->setItem("FMPS_PlayCount", TagLib::APE::Item("FMPS_PlayCount", TagLib::String::number(static_cast(song.playcount())))); } } else if (TagLib::Ogg::XiphComment *xiph_comment = dynamic_cast(fileref->file()->tag())) { if (song.playcount() > 0) { xiph_comment->addField("FMPS_PLAYCOUNT", TagLib::String::number(static_cast(song.playcount())), true); } else { xiph_comment->removeFields("FMPS_PLAYCOUNT"); } } else if (TagLib::MPEG::File *mpeg_file = dynamic_cast(fileref->file())) { TagLib::ID3v2::Tag *tag = mpeg_file->ID3v2Tag(true); if (!tag) return false; if (song.playcount() > 0) { SetUserTextFrame("FMPS_PlayCount", QString::number(song.playcount()), tag); TagLib::ID3v2::PopularimeterFrame *frame = GetPOPMFrameFromTag(tag); if (frame) { frame->setCounter(song.playcount()); } } } else if (TagLib::MP4::File *mp4_file = dynamic_cast(fileref->file())) { TagLib::MP4::Tag *tag = mp4_file->tag(); if (!tag) return false; if (song.playcount() > 0) { tag->setItem(kMP4_FMPS_Playcount_ID, TagLib::MP4::Item(TagLib::String::number(static_cast(song.playcount())))); } } else if (TagLib::MPC::File *mpc_file = dynamic_cast(fileref->file())) { TagLib::APE::Tag *tag = mpc_file->APETag(true); if (!tag) return false; if (song.playcount() > 0) { tag->setItem("FMPS_PlayCount", TagLib::APE::Item("FMPS_PlayCount", TagLib::String::number(static_cast(song.playcount())))); } } else if (TagLib::ASF::File *asf_file = dynamic_cast(fileref->file())) { TagLib::ASF::Tag *tag = asf_file->tag(); if (!tag) return false; if (song.playcount() > 0) { tag->addAttribute("FMPS/Playcount", TagLib::ASF::Attribute(QStringToTaglibString(QString::number(song.playcount())))); } } else { return true; } bool ret = fileref->save(); #ifdef Q_OS_LINUX if (ret) { // Linux: inotify doesn't seem to notice the change to the file unless we change the timestamps as well. (this is what touch does) utimensat(0, QFile::encodeName(filename).constData(), nullptr, 0); } #endif // Q_OS_LINUX return ret; } bool TagReaderTagLib::SaveSongRatingToFile(const QString &filename, const spb::tagreader::SongMetadata &song) const { if (filename.isNull()) return false; qLog(Debug) << "Saving song rating to" << filename; if (song.rating() < 0) { return true; } std::unique_ptr fileref(factory_->GetFileRef(filename)); if (!fileref || fileref->isNull()) return false; if (TagLib::FLAC::File *flac_file = dynamic_cast(fileref->file())) { TagLib::Ogg::XiphComment *vorbis_comments = flac_file->xiphComment(true); if (!vorbis_comments) return false; if (song.rating() > 0) { vorbis_comments->addField("FMPS_RATING", QStringToTaglibString(QString::number(song.rating())), true); } else { vorbis_comments->removeFields("FMPS_RATING"); } } else if (TagLib::WavPack::File *wavpack_file = dynamic_cast(fileref->file())) { TagLib::APE::Tag *tag = wavpack_file->APETag(true); if (!tag) return false; tag->setItem("FMPS_Rating", TagLib::APE::Item("FMPS_Rating", TagLib::StringList(QStringToTaglibString(QString::number(song.rating()))))); } else if (TagLib::APE::File *ape_file = dynamic_cast(fileref->file())) { TagLib::APE::Tag *tag = ape_file->APETag(true); if (!tag) return false; tag->setItem("FMPS_Rating", TagLib::APE::Item("FMPS_Rating", TagLib::StringList(QStringToTaglibString(QString::number(song.rating()))))); } else if (TagLib::Ogg::XiphComment *xiph_comment = dynamic_cast(fileref->file()->tag())) { if (song.rating() > 0) { xiph_comment->addField("FMPS_RATING", QStringToTaglibString(QString::number(song.rating())), true); } else { xiph_comment->removeFields("FMPS_RATING"); } } else if (TagLib::MPEG::File *mpeg_file = dynamic_cast(fileref->file())) { TagLib::ID3v2::Tag *tag = mpeg_file->ID3v2Tag(true); if (!tag) return false; SetUserTextFrame("FMPS_Rating", QString::number(song.rating()), tag); TagLib::ID3v2::PopularimeterFrame *frame = GetPOPMFrameFromTag(tag); if (frame) { frame->setRating(ConvertToPOPMRating(song.rating())); } } else if (TagLib::MP4::File *mp4_file = dynamic_cast(fileref->file())) { TagLib::MP4::Tag *tag = mp4_file->tag(); if (!tag) return false; tag->setItem(kMP4_FMPS_Rating_ID, TagLib::StringList(QStringToTaglibString(QString::number(song.rating())))); } else if (TagLib::ASF::File *asf_file = dynamic_cast(fileref->file())) { TagLib::ASF::Tag *tag = asf_file->tag(); if (!tag) return false; tag->addAttribute("FMPS/Rating", TagLib::ASF::Attribute(QStringToTaglibString(QString::number(song.rating())))); } else if (TagLib::MPC::File *mpc_file = dynamic_cast(fileref->file())) { TagLib::APE::Tag *tag = mpc_file->APETag(true); if (!tag) return false; tag->setItem("FMPS_Rating", TagLib::APE::Item("FMPS_Rating", TagLib::StringList(QStringToTaglibString(QString::number(song.rating()))))); } else { return true; } bool ret = fileref->save(); #ifdef Q_OS_LINUX if (ret) { // Linux: inotify doesn't seem to notice the change to the file unless we change the timestamps as well. (this is what touch does) utimensat(0, QFile::encodeName(filename).constData(), nullptr, 0); } #endif // Q_OS_LINUX return ret; }