owen/lms
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Reworked scanner to use taglib to extract images, now support images in APE tags. This is a step forward multiple image support per track

Browse Source
This commit is contained in:
emeric
2025-03-09 11:20:30 +01:00
parent b5e79d48a6
commit 5effbf99a1
27 changed files with 1151 additions and 353 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/libs/services/artwork/CMakeLists.txt
+1 -1
View File
@@ -14,8 +14,8 @@ target_include_directories(lmsartwork PRIVATE
)
target_link_libraries(lmsartwork PRIVATE
lmsav
lmsimage
lmsmetadata
)
target_link_libraries(lmsartwork PUBLIC
src/libs/services/artwork/impl/ArtworkService.cpp
+52 -62
View File
@@ -22,8 +22,6 @@
#include <algorithm>
#include <functional>
#include "av/IAudioFile.hpp"
#include "av/Types.hpp"
#include "core/IConfig.hpp"
#include "core/ILogger.hpp"
#include "core/String.hpp"
@@ -35,6 +33,7 @@
#include "image/Exception.hpp"
#include "image/IEncodedImage.hpp"
#include "image/Image.hpp"
#include "metadata/IAudioFileParser.hpp"
namespace lms::cover
{
@@ -55,6 +54,7 @@ namespace lms::cover
const std::filesystem::path& defaultReleaseCoverSvgPath,
const std::filesystem::path& defaultArtistImageSvgPath)
: _db{ db }
, _audioFileParser{ metadata::createAudioFileParser(metadata::AudioFileParserParameters{}) }
, _cache{ core::Service<core::IConfig>::get()->getULong("cover-max-cache-size", 30) * 1000 * 1000 }
{
setJpegQuality(core::Service<core::IConfig>::get()->getULong("cover-jpeg-quality", 75));
@@ -66,61 +66,7 @@ namespace lms::cover
_defaultArtistImage = image::readImage(defaultArtistImageSvgPath); // may throw
}
std::unique_ptr<image::IEncodedImage> ArtworkService::getFromAvMediaFile(const av::IAudioFile& input, std::optional<image::ImageSize> width) const
{
struct CandidatePicture
{
av::Picture picture;
bool isFront{};
std::size_t index;
// > means is better candidate
bool operator>(const CandidatePicture& other) const
{
if (!isFront && other.isFront)
return false;
if (isFront && !other.isFront)
return true;
return index < other.index;
}
};
auto metadataHasFrontKeyword{ [](const av::IAudioFile::MetadataMap& metadata) {
return std::any_of(std::cbegin(metadata), std::cend(metadata), [](const auto& keyValue) { return core::stringUtils::stringCaseInsensitiveContains(keyValue.second, "front"); });
} };
std::vector<CandidatePicture> candidatePictures;
std::size_t pictureIndex{};
input.visitAttachedPictures([&](const av::Picture& picture, const av::IAudioFile::MetadataMap& metadata) {
candidatePictures.emplace_back(CandidatePicture{ picture, metadataHasFrontKeyword(metadata), pictureIndex++ });
});
std::stable_sort(std::begin(candidatePictures), std::end(candidatePictures), std::greater<>());
std::unique_ptr<image::IEncodedImage> image;
for (const CandidatePicture& candidatePicture : candidatePictures)
{
try
{
if (!width)
{
image = image::readImage(candidatePicture.picture.data, candidatePicture.picture.mimeType);
}
else
{
auto rawImage{ image::decodeImage(candidatePicture.picture.data) };
rawImage->resize(*width);
image = image::encodeToJPEG(*rawImage, _jpegQuality);
}
}
catch (const image::Exception& e)
{
LMS_LOG(COVER, ERROR, "Cannot read embedded cover: " << e.what());
}
}
return image;
}
ArtworkService::~ArtworkService() = default;
std::unique_ptr<image::IEncodedImage> ArtworkService::getFromImageFile(const std::filesystem::path& p, std::optional<image::ImageSize> width) const
{
@@ -175,18 +121,62 @@ namespace lms::cover
std::unique_ptr<image::IEncodedImage> ArtworkService::getTrackImage(const std::filesystem::path& p, std::optional<image::ImageSize> width) const
{
std::unique_ptr<image::IEncodedImage> image;
struct CandidateImage
{
std::unique_ptr<image::IEncodedImage> image;
bool isFront{};
std::size_t index;
// > means is better candidate
bool operator>(const CandidateImage& other) const
{
if (!isFront && other.isFront)
return false;
if (isFront && !other.isFront)
return true;
return index < other.index;
}
};
std::vector<CandidateImage> candidateImages;
std::size_t pictureIndex{};
try
{
image = getFromAvMediaFile(*av::parseAudioFile(p), width);
_audioFileParser->parseImages(p, [&](const metadata::Image& parsedImage) {
std::unique_ptr<image::IEncodedImage> image;
try
{
if (!width)
{
image = image::readImage(parsedImage.data, parsedImage.mimeType);
}
else
{
auto rawImage{ image::decodeImage(parsedImage.data) };
rawImage->resize(*width);
image = image::encodeToJPEG(*rawImage, _jpegQuality);
}
}
catch (const image::Exception& e)
{
LMS_LOG(COVER, ERROR, "Cannot decode image from track " << p << ": " << e.what());
}
candidateImages.emplace_back(CandidateImage{ .image = std::move(image), .isFront = parsedImage.type == metadata::Image::Type::FrontCover, .index = pictureIndex++ });
});
}
catch (av::Exception& e)
catch (const metadata::Exception& e)
{
LMS_LOG(COVER, ERROR, "Cannot get covers from track " << p << ": " << e.what());
LMS_LOG(COVER, ERROR, "Cannot parse images from track " << p << ": " << e.what());
}
return image;
std::stable_sort(std::begin(candidateImages), std::end(candidateImages), std::greater<>());
if (!candidateImages.empty())
return std::move(candidateImages.front().image);
return {};
}
std::shared_ptr<image::IEncodedImage> ArtworkService::getImage(db::ImageId imageId, std::optional<image::ImageSize> width)
src/libs/services/artwork/impl/ArtworkService.hpp
+4 -4
View File
@@ -32,9 +32,9 @@ namespace lms::db
class Session;
}
namespace lms::av
namespace lms::metadata
{
class IAudioFile;
class IAudioFileParser;
}
namespace lms::cover
@@ -43,7 +43,7 @@ namespace lms::cover
{
public:
ArtworkService(db::Db& db, const std::filesystem::path& defaultReleaseCoverSvgPath, const std::filesystem::path& defaultArtistImageSvgPath);
~ArtworkService() override = default;
~ArtworkService() override;
ArtworkService(const ArtworkService&) = delete;
ArtworkService& operator=(const ArtworkService&) = delete;
@@ -56,7 +56,6 @@ namespace lms::cover
void flushCache() override;
void setJpegQuality(unsigned quality) override;
std::unique_ptr<image::IEncodedImage> getFromAvMediaFile(const av::IAudioFile& input, std::optional<image::ImageSize> width) const;
std::unique_ptr<image::IEncodedImage> getFromImageFile(const std::filesystem::path& p, std::optional<image::ImageSize> width) const;
std::unique_ptr<image::IEncodedImage> getTrackImage(const std::filesystem::path& path, std::optional<image::ImageSize> width) const;
@@ -64,6 +63,7 @@ namespace lms::cover
db::Db& _db;
std::unique_ptr<metadata::IAudioFileParser> _audioFileParser;
ImageCache _cache;
std::shared_ptr<image::IEncodedImage> _defaultReleaseCover;
std::shared_ptr<image::IEncodedImage> _defaultArtistImage;
src/libs/services/scanner/impl/scanners/AudioFileScanner.cpp
+38 -14
View File
@@ -37,13 +37,16 @@
#include "database/TrackFeatures.hpp"
#include "database/TrackLyrics.hpp"
#include "database/Types.hpp"
#include "image/Exception.hpp"
#include "image/Image.hpp"
#include "metadata/Exception.hpp"
#include "metadata/IParser.hpp"
#include "metadata/IAudioFileParser.hpp"
#include "IFileScanOperation.hpp"
#include "ScanContext.hpp"
#include "ScannerSettings.hpp"
#include "Utils.hpp"
#include "metadata/Types.hpp"
namespace lms::scanner
{
@@ -345,7 +348,7 @@ namespace lms::scanner
return db::Advisory::UnSet;
}
db::Track::pointer findMovedTrackBySizeAndMetaData(db::Session& session, const metadata::Track& parsedTrack, const FileInfo& fileInfo)
db::Track::pointer findMovedTrackBySizeAndMetaData(db::Session& session, const metadata::Track& parsedTrack, bool hasEmbeddedCover, const FileInfo& fileInfo)
{
db::Track::FindParameters params;
// Add as many fields as possible to limit errors
@@ -359,7 +362,7 @@ namespace lms::scanner
}
if (parsedTrack.position)
params.setTrackNumber(*parsedTrack.position);
params.setHasEmbeddedImage(parsedTrack.hasCover);
params.setHasEmbeddedImage(hasEmbeddedCover);
params.setFileSize(fileInfo.fileSize);
bool error{};
@@ -387,7 +390,7 @@ namespace lms::scanner
class AudioFileScanOperation : public IFileScanOperation
{
public:
AudioFileScanOperation(const FileToScan& fileToScan, db::Db& db, metadata::IParser& parser, const ScannerSettings& settings)
AudioFileScanOperation(const FileToScan& fileToScan, db::Db& db, metadata::IAudioFileParser& parser, const ScannerSettings& settings)
: _file{ fileToScan.file }
, _mediaLibrary{ fileToScan.mediaLibrary }
, _db{ db }
@@ -408,9 +411,10 @@ namespace lms::scanner
const std::filesystem::path _file;
const MediaLibraryInfo _mediaLibrary;
db::Db& _db;
metadata::IParser& _parser;
metadata::IAudioFileParser& _parser;
const ScannerSettings& _settings;
std::unique_ptr<metadata::Track> _parsedTrack;
bool _hasEmbeddedCover{};
};
void AudioFileScanOperation::scan()
@@ -420,7 +424,19 @@ namespace lms::scanner
try
{
_parsedTrack = _parser.parse(_file);
_parsedTrack = _parser.parseMetaData(_file);
_parser.parseImages(_file, [&](const metadata::Image& image) {
try
{
image::probeImage(image.data);
_hasEmbeddedCover = true;
}
catch (const image::Exception& e)
{
LMS_LOG(DBUPDATER, ERROR, "Failed to parse image in track file " << _file);
}
});
}
catch (const metadata::Exception& e)
{
@@ -505,7 +521,7 @@ namespace lms::scanner
if (!track)
{
// maybe the file just moved?
track = findMovedTrackBySizeAndMetaData(dbSession, *_parsedTrack, *fileInfo);
track = findMovedTrackBySizeAndMetaData(dbSession, *_parsedTrack, _hasEmbeddedCover, *fileInfo);
if (track)
{
LMS_LOG(DBUPDATER, DEBUG, "Considering track " << _file << " moved from " << track->getAbsoluteFilePath());
@@ -646,7 +662,7 @@ namespace lms::scanner
track.modify()->setTrackMBID(_parsedTrack->mbid);
if (auto trackFeatures{ db::TrackFeatures::find(dbSession, track->getId()) })
trackFeatures.remove(); // TODO: only if MBID changed?
track.modify()->setHasCover(_parsedTrack->hasCover);
track.modify()->setHasCover(_hasEmbeddedCover);
track.modify()->setCopyright(_parsedTrack->copyright);
track.modify()->setCopyrightURL(_parsedTrack->copyrightURL);
track.modify()->setAdvisory(getAdvisory(_parsedTrack->advisory));
@@ -686,18 +702,26 @@ namespace lms::scanner
throw core::LmsException{ "Invalid value for 'scanner-parser-read-style'" };
}
metadata::AudioFileParserParameters createAudioFileParserParameters(const ScannerSettings& settings)
{
metadata::AudioFileParserParameters params;
params.userExtraTags = settings.extraTags;
params.artistTagDelimiters = settings.artistTagDelimiters;
params.defaultTagDelimiters = settings.defaultTagDelimiters;
params.backend = metadata::ParserBackend::TagLib;
params.readStyle = getParserReadStyle();
return params;
}
} // namespace
AudioFileScanner::AudioFileScanner(db::Db& db, const ScannerSettings& settings)
: _db{ db }
, _settings{ settings }
, _metadataParser{ metadata::createParser(metadata::ParserBackend::TagLib, getParserReadStyle()) } // For now, always use TagLib
, _metadataParser{ metadata::createAudioFileParser(createAudioFileParserParameters(settings)) } // For now, always use TagLib
{
std::vector<std::string> tagsToParse{ _extraTagsToParse };
tagsToParse.insert(std::end(tagsToParse), std::cbegin(settings.extraTags), std::cend(settings.extraTags));
_metadataParser->setUserExtraTags(tagsToParse);
_metadataParser->setArtistTagDelimiters(settings.artistTagDelimiters);
_metadataParser->setDefaultTagDelimiters(settings.defaultTagDelimiters);
}
AudioFileScanner::~AudioFileScanner() = default;
src/libs/services/scanner/impl/scanners/AudioFileScanner.hpp
+2 -6
View File
@@ -19,9 +19,6 @@
#pragma once
#include <string>
#include <vector>
#include "IFileScanner.hpp"
namespace lms
@@ -33,7 +30,7 @@ namespace lms
namespace metadata
{
class IParser;
class IAudioFileParser;
}
} // namespace lms
@@ -57,7 +54,6 @@ namespace lms::scanner
db::Db& _db;
const ScannerSettings& _settings;
std::unique_ptr<metadata::IParser> _metadataParser;
const std::vector<std::string> _extraTagsToParse;
std::unique_ptr<metadata::IAudioFileParser> _metadataParser;
};
} // namespace lms::scanner