Now resolve the preferred track artworks during scan steps
This commit is contained in:
emeric
@@ -39,14 +39,6 @@
|
||||
|
||||
namespace lms::artwork
|
||||
{
|
||||
namespace
|
||||
{
|
||||
bool isImageFound(const ArtworkService::ImageFindResult& res)
|
||||
{
|
||||
return !std::holds_alternative<std::monostate>(res);
|
||||
}
|
||||
} // namespace
|
||||
|
||||
std::unique_ptr<IArtworkService> createArtworkService(db::Db& db, const std::filesystem::path& defaultReleaseCoverSvgPath, const std::filesystem::path& defaultArtistImageSvgPath)
|
||||
{
|
||||
return std::make_unique<ArtworkService>(db, defaultReleaseCoverSvgPath, defaultArtistImageSvgPath);
|
||||
@@ -170,72 +162,15 @@ namespace lms::artwork
|
||||
db::Session& session{ _db.getTLSSession() };
|
||||
auto transaction{ session.createReadTransaction() };
|
||||
|
||||
{
|
||||
db::TrackEmbeddedImage::FindParameters params;
|
||||
params.setTrack(trackId);
|
||||
params.setImageTypes({ db::ImageType::Media });
|
||||
params.setSortMethod(db::TrackEmbeddedImageSortMethod::SizeDesc);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::TrackEmbeddedImage::find(session, params, [&](const db::TrackEmbeddedImage::pointer& image) { res = image->getId(); });
|
||||
}
|
||||
|
||||
if (isImageFound(res))
|
||||
return res;
|
||||
|
||||
// Fallback on another track of the same disc
|
||||
const db::Track::pointer track{ db::Track::find(session, trackId) };
|
||||
if (!track)
|
||||
return res;
|
||||
|
||||
const db::ReleaseId releaseId{ track->getReleaseId() };
|
||||
if (!releaseId.isValid())
|
||||
return res;
|
||||
|
||||
{
|
||||
db::TrackEmbeddedImage::FindParameters params;
|
||||
params.setRelease(releaseId);
|
||||
params.setDiscNumber(track->getDiscNumber());
|
||||
params.setImageTypes({ db::ImageType::Media });
|
||||
params.setSortMethod(db::TrackEmbeddedImageSortMethod::TrackNumberThenSizeDesc);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::TrackEmbeddedImage::find(session, params, [&](const db::TrackEmbeddedImage::pointer& image) { res = image->getId(); });
|
||||
}
|
||||
|
||||
if (isImageFound(res))
|
||||
return res;
|
||||
|
||||
// Fallback on front cover for this track
|
||||
{
|
||||
db::TrackEmbeddedImage::FindParameters params;
|
||||
params.setTrack(trackId);
|
||||
params.setImageTypes({ db::ImageType::FrontCover });
|
||||
params.setSortMethod(db::TrackEmbeddedImageSortMethod::SizeDesc);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::TrackEmbeddedImage::find(session, params, [&](const db::TrackEmbeddedImage::pointer& image) { res = image->getId(); });
|
||||
}
|
||||
|
||||
if (isImageFound(res))
|
||||
return res;
|
||||
#if 0
|
||||
// Fallback on external cover of the release
|
||||
if (const db::Release::pointer release{ db::Release::find(session, releaseId) })
|
||||
{
|
||||
if (const db::ImageId imageId{ release->getImageId() }; imageId.isValid())
|
||||
res = imageId;
|
||||
}
|
||||
#endif
|
||||
if (isImageFound(res))
|
||||
return res;
|
||||
|
||||
// Fallback on the first front cover found on the release
|
||||
{
|
||||
db::TrackEmbeddedImage::FindParameters params;
|
||||
params.setRelease(releaseId);
|
||||
params.setImageTypes({ db::ImageType::FrontCover });
|
||||
params.setSortMethod(db::TrackEmbeddedImageSortMethod::DiscNumberThenTrackNumberThenSizeDesc);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::TrackEmbeddedImage::find(session, params, [&](const db::TrackEmbeddedImage::pointer& image) { res = image->getId(); });
|
||||
}
|
||||
const db::Artwork::pointer artwork{ track->getPreferredArtwork() };
|
||||
if (artwork && artwork->getImageId().isValid())
|
||||
res = artwork->getImageId();
|
||||
else if (artwork && artwork->getTrackEmbeddedImageId().isValid())
|
||||
res = artwork->getTrackEmbeddedImageId();
|
||||
|
||||
return res;
|
||||
}
|
||||
@@ -246,33 +181,15 @@ namespace lms::artwork
|
||||
auto transaction{ session.createReadTransaction() };
|
||||
ImageFindResult res;
|
||||
|
||||
{
|
||||
db::TrackEmbeddedImage::FindParameters params;
|
||||
params.setTrack(trackId);
|
||||
params.setImageTypes({ db::ImageType::Media });
|
||||
params.setSortMethod(db::TrackEmbeddedImageSortMethod::SizeDesc);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::TrackEmbeddedImage::find(session, params, [&](const db::TrackEmbeddedImage::pointer& image) { res = image->getId(); });
|
||||
}
|
||||
|
||||
if (isImageFound(res))
|
||||
const db::Track::pointer track{ db::Track::find(session, trackId) };
|
||||
if (!track)
|
||||
return res;
|
||||
|
||||
// fallback on another track of the same disc
|
||||
if (const db::Track::pointer track{ db::Track::find(session, trackId) })
|
||||
{
|
||||
const db::ReleaseId releaseId{ track->getReleaseId() };
|
||||
if (releaseId.isValid())
|
||||
{
|
||||
db::TrackEmbeddedImage::FindParameters params;
|
||||
params.setRelease(releaseId);
|
||||
params.setDiscNumber(track->getDiscNumber());
|
||||
params.setImageTypes({ db::ImageType::Media });
|
||||
params.setSortMethod(db::TrackEmbeddedImageSortMethod::TrackNumberThenSizeDesc);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::TrackEmbeddedImage::find(session, params, [&](const db::TrackEmbeddedImage::pointer& image) { res = image->getId(); });
|
||||
}
|
||||
}
|
||||
const db::Artwork::pointer artwork{ track->getPreferredMediaArtwork() };
|
||||
if (artwork && artwork->getImageId().isValid())
|
||||
res = artwork->getImageId();
|
||||
else if (artwork && artwork->getTrackEmbeddedImageId().isValid())
|
||||
res = artwork->getTrackEmbeddedImageId();
|
||||
|
||||
return res;
|
||||
}
|
||||
|
||||
@@ -8,6 +8,7 @@ add_library(lmsscanner STATIC
|
||||
impl/scanners/LyricsFileScanner.cpp
|
||||
impl/scanners/PlayListFileScanner.cpp
|
||||
impl/scanners/Utils.cpp
|
||||
impl/steps/ArtworkUtils.cpp
|
||||
impl/steps/FileScanQueue.cpp
|
||||
impl/steps/ScanErrorLogger.cpp
|
||||
impl/steps/ScanStepArtistReconciliation.cpp
|
||||
@@ -15,6 +16,7 @@ add_library(lmsscanner STATIC
|
||||
impl/steps/ScanStepAssociateExternalLyrics.cpp
|
||||
impl/steps/ScanStepAssociatePlayListTracks.cpp
|
||||
impl/steps/ScanStepAssociateReleaseImages.cpp
|
||||
impl/steps/ScanStepAssociateTrackImages.cpp
|
||||
impl/steps/ScanStepBase.cpp
|
||||
impl/steps/ScanStepCheckForDuplicatedFiles.cpp
|
||||
impl/steps/ScanStepCheckForRemovedFiles.cpp
|
||||
|
||||
@@ -41,6 +41,7 @@
|
||||
#include "steps/ScanStepAssociateExternalLyrics.hpp"
|
||||
#include "steps/ScanStepAssociatePlayListTracks.hpp"
|
||||
#include "steps/ScanStepAssociateReleaseImages.hpp"
|
||||
#include "steps/ScanStepAssociateTrackImages.hpp"
|
||||
#include "steps/ScanStepCheckForDuplicatedFiles.hpp"
|
||||
#include "steps/ScanStepCheckForRemovedFiles.hpp"
|
||||
#include "steps/ScanStepCompact.hpp"
|
||||
@@ -463,6 +464,7 @@ namespace lms::scanner
|
||||
_scanSteps.emplace_back(std::make_unique<ScanStepUpdateLibraryFields>(params));
|
||||
_scanSteps.emplace_back(std::make_unique<ScanStepAssociateArtistImages>(params));
|
||||
_scanSteps.emplace_back(std::make_unique<ScanStepAssociateReleaseImages>(params));
|
||||
_scanSteps.emplace_back(std::make_unique<ScanStepAssociateTrackImages>(params)); // must come after ScanStepAssociateReleaseImages
|
||||
_scanSteps.emplace_back(std::make_unique<ScanStepAssociateExternalLyrics>(params));
|
||||
_scanSteps.emplace_back(std::make_unique<ScanStepRemoveOrphanedDbEntries>(params));
|
||||
_scanSteps.emplace_back(std::make_unique<ScanStepCompact>(params));
|
||||
|
||||
@@ -30,10 +30,7 @@ namespace lms::db
|
||||
class Session;
|
||||
} // namespace lms::db
|
||||
|
||||
namespace lms::scanner
|
||||
namespace lms::scanner::utils
|
||||
{
|
||||
namespace utils
|
||||
{
|
||||
db::ObjectPtr<db::Directory> getOrCreateDirectory(db::Session& session, const std::filesystem::path& path, const db::ObjectPtr<db::MediaLibrary>& mediaLibrary);
|
||||
} // namespace utils
|
||||
} // namespace lms::scanner
|
||||
db::ObjectPtr<db::Directory> getOrCreateDirectory(db::Session& session, const std::filesystem::path& path, const db::ObjectPtr<db::MediaLibrary>& mediaLibrary);
|
||||
} // namespace lms::scanner::utils
|
||||
@@ -0,0 +1,104 @@
|
||||
/*
|
||||
* Copyright (C) 2024 Emeric Poupon
|
||||
*
|
||||
* This file is part of LMS.
|
||||
*
|
||||
* LMS 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.
|
||||
*
|
||||
* LMS 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 LMS. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include "ArtworkUtils.hpp"
|
||||
|
||||
#include "database/Artwork.hpp"
|
||||
#include "database/Image.hpp"
|
||||
#include "database/Session.hpp"
|
||||
#include "database/Track.hpp"
|
||||
#include "database/TrackEmbeddedImage.hpp"
|
||||
|
||||
namespace lms::scanner::utils
|
||||
{
|
||||
namespace
|
||||
{
|
||||
std::filesystem::path toPath(db::Session& session, const db::TrackEmbeddedImageId trackEmbeddedImageId)
|
||||
{
|
||||
session.checkReadTransaction();
|
||||
|
||||
std::filesystem::path res;
|
||||
|
||||
db::Track::FindParameters params;
|
||||
params.setEmbeddedImage(trackEmbeddedImageId);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::Track::find(session, params, [&](const db::Track::pointer& track) {
|
||||
res = track->getAbsoluteFilePath();
|
||||
});
|
||||
|
||||
return res;
|
||||
}
|
||||
|
||||
std::filesystem::path toPath(db::Session& session, db::ImageId imageId)
|
||||
{
|
||||
session.checkReadTransaction();
|
||||
|
||||
db::Image::pointer image{ db::Image::find(session, imageId) };
|
||||
return image ? image->getAbsoluteFilePath() : std::filesystem::path{};
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
db::ObjectPtr<db::Artwork> getOrCreateArtworkFromTrackEmbeddedImage(db::Session& session, db::TrackEmbeddedImageId trackEmbeddedImageId)
|
||||
{
|
||||
assert(trackEmbeddedImageId.isValid());
|
||||
session.checkWriteTransaction();
|
||||
|
||||
db::ObjectPtr<db::Artwork> artwork{ db::Artwork::find(session, trackEmbeddedImageId) };
|
||||
if (!artwork)
|
||||
{
|
||||
db::TrackEmbeddedImage::pointer trackEmbeddedImage{ db::TrackEmbeddedImage::find(session, trackEmbeddedImageId) };
|
||||
assert(trackEmbeddedImage);
|
||||
artwork = session.create<db::Artwork>(trackEmbeddedImage);
|
||||
}
|
||||
return artwork;
|
||||
}
|
||||
|
||||
db::ObjectPtr<db::Artwork> getOrCreateArtworkFromImage(db::Session& session, db::ImageId imageId)
|
||||
{
|
||||
assert(imageId.isValid());
|
||||
session.checkWriteTransaction();
|
||||
|
||||
db::ObjectPtr<db::Artwork> artwork{ db::Artwork::find(session, imageId) };
|
||||
if (!artwork)
|
||||
{
|
||||
db::Image::pointer image{ db::Image::find(session, imageId) };
|
||||
assert(image);
|
||||
artwork = session.create<db::Artwork>(image);
|
||||
}
|
||||
return artwork;
|
||||
}
|
||||
|
||||
std::filesystem::path toPath(db::Session& session, db::ArtworkId artworkId)
|
||||
{
|
||||
session.checkReadTransaction();
|
||||
|
||||
db::Artwork::pointer artwork{ db::Artwork::find(session, artworkId) };
|
||||
if (!artwork)
|
||||
return std::filesystem::path{};
|
||||
|
||||
if (artwork->getTrackEmbeddedImageId().isValid())
|
||||
return toPath(session, artwork->getTrackEmbeddedImageId());
|
||||
if (artwork->getImageId().isValid())
|
||||
return toPath(session, artwork->getImageId());
|
||||
|
||||
return std::filesystem::path{};
|
||||
}
|
||||
|
||||
} // namespace lms::scanner::utils
|
||||
@@ -0,0 +1,41 @@
|
||||
/*
|
||||
* Copyright (C) 2024 Emeric Poupon
|
||||
*
|
||||
* This file is part of LMS.
|
||||
*
|
||||
* LMS 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.
|
||||
*
|
||||
* LMS 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 LMS. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <filesystem>
|
||||
|
||||
#include "database/ArtworkId.hpp"
|
||||
#include "database/ImageId.hpp"
|
||||
#include "database/Object.hpp"
|
||||
#include "database/TrackEmbeddedImageId.hpp"
|
||||
|
||||
namespace lms::db
|
||||
{
|
||||
class Artwork;
|
||||
class Session;
|
||||
} // namespace lms::db
|
||||
|
||||
namespace lms::scanner::utils
|
||||
{
|
||||
db::ObjectPtr<db::Artwork> getOrCreateArtworkFromTrackEmbeddedImage(db::Session& session, db::TrackEmbeddedImageId trackEmbeddedImageId);
|
||||
db::ObjectPtr<db::Artwork> getOrCreateArtworkFromImage(db::Session& session, db::ImageId imageId);
|
||||
|
||||
std::filesystem::path toPath(db::Session& session, db::ArtworkId artworkId);
|
||||
} // namespace lms::scanner::utils
|
||||
@@ -38,14 +38,15 @@
|
||||
#include "database/TrackEmbeddedImage.hpp"
|
||||
#include "database/TrackEmbeddedImageId.hpp"
|
||||
|
||||
#include "ArtworkUtils.hpp"
|
||||
#include "ScanContext.hpp"
|
||||
|
||||
namespace lms::scanner
|
||||
{
|
||||
namespace
|
||||
{
|
||||
using PreferredArtwork = std::variant<std::monostate, db::TrackEmbeddedImageId, db::ImageId>;
|
||||
bool isSameArtwork(PreferredArtwork preferredArtwork, const db::Artwork::pointer& artwork)
|
||||
using Artwork = std::variant<std::monostate, db::TrackEmbeddedImageId, db::ImageId>;
|
||||
bool isSameArtwork(Artwork preferredArtwork, const db::ObjectPtr<db::Artwork>& artwork)
|
||||
{
|
||||
if (std::holds_alternative<std::monostate>(preferredArtwork))
|
||||
return !artwork;
|
||||
@@ -59,30 +60,10 @@ namespace lms::scanner
|
||||
return false;
|
||||
}
|
||||
|
||||
std::filesystem::path toPath(db::Session& session, const db::TrackEmbeddedImageId trackEmbeddedImageId)
|
||||
{
|
||||
std::filesystem::path res;
|
||||
|
||||
db::Track::FindParameters params;
|
||||
params.setEmbeddedImage(trackEmbeddedImageId);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::Track::find(session, params, [&](const db::Track::pointer& track) {
|
||||
res = track->getAbsoluteFilePath();
|
||||
});
|
||||
|
||||
return res;
|
||||
}
|
||||
|
||||
std::filesystem::path toPath(db::Session& session, const db::ImageId imageId)
|
||||
{
|
||||
db::Image::pointer image{ db::Image::find(session, imageId) };
|
||||
return image ? image->getAbsoluteFilePath() : std::filesystem::path{};
|
||||
}
|
||||
|
||||
struct ReleaseImageAssociation
|
||||
{
|
||||
db::ReleaseId releaseId;
|
||||
PreferredArtwork preferredArtwork;
|
||||
Artwork preferredArtwork;
|
||||
};
|
||||
using ReleaseImageAssociationContainer = std::deque<ReleaseImageAssociation>;
|
||||
|
||||
@@ -120,7 +101,7 @@ namespace lms::scanner
|
||||
return image;
|
||||
}
|
||||
|
||||
db::Image::pointer computeBestReleaseImage(SearchReleaseImageContext& searchContext, const db::Release::pointer& release)
|
||||
db::Image::pointer computePreferredReleaseImage(SearchReleaseImageContext& searchContext, const db::Release::pointer& release)
|
||||
{
|
||||
db::Image::pointer image;
|
||||
|
||||
@@ -168,11 +149,11 @@ namespace lms::scanner
|
||||
return image;
|
||||
}
|
||||
|
||||
PreferredArtwork computeBestReleaseArtwork(SearchReleaseImageContext& searchContext, const db::Release::pointer& release)
|
||||
Artwork computePreferredReleaseArtwork(SearchReleaseImageContext& searchContext, const db::Release::pointer& release)
|
||||
{
|
||||
const db::Image::pointer image{ computeBestReleaseImage(searchContext, release) };
|
||||
const db::Image::pointer image{ computePreferredReleaseImage(searchContext, release) };
|
||||
if (image)
|
||||
return PreferredArtwork{ image->getId() };
|
||||
return Artwork{ image->getId() };
|
||||
|
||||
// Fallback on embedded Front image
|
||||
db::TrackEmbeddedImageId trackEmbeddedImageId;
|
||||
@@ -187,7 +168,7 @@ namespace lms::scanner
|
||||
}
|
||||
|
||||
if (trackEmbeddedImageId.isValid())
|
||||
return PreferredArtwork{ trackEmbeddedImageId };
|
||||
return Artwork{ trackEmbeddedImageId };
|
||||
|
||||
// Fallback on embedded media image
|
||||
{
|
||||
@@ -201,9 +182,9 @@ namespace lms::scanner
|
||||
}
|
||||
|
||||
if (trackEmbeddedImageId.isValid())
|
||||
return PreferredArtwork{ trackEmbeddedImageId };
|
||||
return Artwork{ trackEmbeddedImageId };
|
||||
|
||||
return PreferredArtwork{};
|
||||
return Artwork{};
|
||||
}
|
||||
|
||||
bool fetchNextReleaseArtworksToUpdate(SearchReleaseImageContext& searchContext, ReleaseImageAssociationContainer& releaseImageAssociations)
|
||||
@@ -216,7 +197,7 @@ namespace lms::scanner
|
||||
auto transaction{ searchContext.session.createReadTransaction() };
|
||||
|
||||
db::Release::find(searchContext.session, searchContext.lastRetrievedReleaseId, readBatchSize, [&](const db::Release::pointer& release) {
|
||||
const PreferredArtwork preferredArtwork{ computeBestReleaseArtwork(searchContext, release) };
|
||||
const Artwork preferredArtwork{ computePreferredReleaseArtwork(searchContext, release) };
|
||||
const db::Artwork::pointer currentPreferredArtwork{ release->getPreferredArtwork() };
|
||||
|
||||
if (!isSameArtwork(preferredArtwork, currentPreferredArtwork))
|
||||
@@ -228,30 +209,6 @@ namespace lms::scanner
|
||||
return releaseId != searchContext.lastRetrievedReleaseId;
|
||||
}
|
||||
|
||||
db::Artwork::pointer getOrCreateArtworkFromTrackEmbeddedImage(db::Session& session, const db::TrackEmbeddedImageId& trackEmbeddedImageId)
|
||||
{
|
||||
db::Artwork::pointer artwork{ db::Artwork::find(session, trackEmbeddedImageId) };
|
||||
if (!artwork)
|
||||
{
|
||||
db::TrackEmbeddedImage::pointer trackEmbeddedImage{ db::TrackEmbeddedImage::find(session, trackEmbeddedImageId) };
|
||||
assert(trackEmbeddedImage);
|
||||
artwork = session.create<db::Artwork>(trackEmbeddedImage);
|
||||
}
|
||||
return artwork;
|
||||
}
|
||||
|
||||
db::Artwork::pointer getOrCreateArtworkFromImage(db::Session& session, const db::ImageId& imageId)
|
||||
{
|
||||
db::Artwork::pointer artwork{ db::Artwork::find(session, imageId) };
|
||||
if (!artwork)
|
||||
{
|
||||
db::Image::pointer image{ db::Image::find(session, imageId) };
|
||||
assert(image);
|
||||
artwork = session.create<db::Artwork>(image);
|
||||
}
|
||||
return artwork;
|
||||
}
|
||||
|
||||
void updateReleaseArtwork(db::Session& session, const ReleaseImageAssociation& releaseImageAssociation)
|
||||
{
|
||||
db::Release::pointer release{ db::Release::find(session, releaseImageAssociation.releaseId) };
|
||||
@@ -260,21 +217,16 @@ namespace lms::scanner
|
||||
db::Artwork::pointer artwork;
|
||||
|
||||
if (const db::TrackEmbeddedImageId * trackEmbeddedImageId{ std::get_if<db::TrackEmbeddedImageId>(&releaseImageAssociation.preferredArtwork) })
|
||||
{
|
||||
artwork = getOrCreateArtworkFromTrackEmbeddedImage(session, *trackEmbeddedImageId);
|
||||
LMS_LOG(DBUPDATER, DEBUG, "Updating preferred artwork in release '" << release->getName() << "' with embedded image in track " << toPath(session, *trackEmbeddedImageId));
|
||||
}
|
||||
artwork = utils::getOrCreateArtworkFromTrackEmbeddedImage(session, *trackEmbeddedImageId);
|
||||
else if (const db::ImageId * imageId{ std::get_if<db::ImageId>(&releaseImageAssociation.preferredArtwork) })
|
||||
{
|
||||
artwork = getOrCreateArtworkFromImage(session, *imageId);
|
||||
LMS_LOG(DBUPDATER, DEBUG, "Updating preferred artwork in release '" << release->getName() << "' with image " << toPath(session, *imageId));
|
||||
}
|
||||
else
|
||||
{
|
||||
LMS_LOG(DBUPDATER, DEBUG, "Removing preferred artwork from release '" << release->getName() << "'");
|
||||
}
|
||||
artwork = utils::getOrCreateArtworkFromImage(session, *imageId);
|
||||
|
||||
release.modify()->setPreferredArtwork(artwork);
|
||||
|
||||
if (artwork)
|
||||
LMS_LOG(DBUPDATER, DEBUG, "Updated preferred artwork in release '" << release->getName() << "' with image in " << utils::toPath(session, artwork->getId()));
|
||||
else
|
||||
LMS_LOG(DBUPDATER, DEBUG, "Removed preferred artwork from release '" << release->getName() << "'");
|
||||
}
|
||||
|
||||
void updateReleaseImages(db::Session& session, ReleaseImageAssociationContainer& imageAssociations)
|
||||
|
||||
@@ -0,0 +1,298 @@
|
||||
/*
|
||||
* Copyright (C) 2025 Emeric Poupon
|
||||
*
|
||||
* This file is part of LMS.
|
||||
*
|
||||
* LMS 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.
|
||||
*
|
||||
* LMS 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 LMS. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include "ScanStepAssociateTrackImages.hpp"
|
||||
|
||||
#include <cassert>
|
||||
#include <deque>
|
||||
#include <variant>
|
||||
|
||||
#include "core/ILogger.hpp"
|
||||
#include "database/Artwork.hpp"
|
||||
#include "database/Db.hpp"
|
||||
#include "database/Directory.hpp"
|
||||
#include "database/Image.hpp"
|
||||
#include "database/Release.hpp"
|
||||
#include "database/Session.hpp"
|
||||
#include "database/Track.hpp"
|
||||
#include "database/TrackEmbeddedImage.hpp"
|
||||
#include "database/TrackEmbeddedImageId.hpp"
|
||||
|
||||
#include "ArtworkUtils.hpp"
|
||||
#include "ScanContext.hpp"
|
||||
|
||||
namespace lms::scanner
|
||||
{
|
||||
namespace
|
||||
{
|
||||
// May come from an embedded image in a track, or from what has been previously resolved for the release
|
||||
using Artwork = std::variant<std::monostate, db::TrackEmbeddedImageId, db::ArtworkId>;
|
||||
bool isSameArtwork(Artwork preferredArtwork, const db::ObjectPtr<db::Artwork>& artwork)
|
||||
{
|
||||
if (std::holds_alternative<std::monostate>(preferredArtwork))
|
||||
return !artwork;
|
||||
|
||||
if (const db::TrackEmbeddedImageId* trackEmbeddedImageId = std::get_if<db::TrackEmbeddedImageId>(&preferredArtwork))
|
||||
return artwork && *trackEmbeddedImageId == artwork->getTrackEmbeddedImageId();
|
||||
|
||||
if (const db::ArtworkId* artworkId = std::get_if<db::ArtworkId>(&preferredArtwork))
|
||||
return artwork && *artworkId == artwork->getId();
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
bool isValid(const Artwork& res)
|
||||
{
|
||||
return !std::holds_alternative<std::monostate>(res);
|
||||
}
|
||||
|
||||
struct TrackImageAssociation
|
||||
{
|
||||
db::Track::pointer track;
|
||||
Artwork preferredArtwork;
|
||||
Artwork preferredMediaArtwork;
|
||||
};
|
||||
using TrackImageAssociationContainer = std::deque<TrackImageAssociation>;
|
||||
|
||||
struct SearchTrackImageContext
|
||||
{
|
||||
db::Session& session;
|
||||
db::TrackId lastRetrievedTrackId;
|
||||
std::size_t processedTrackCount{};
|
||||
};
|
||||
|
||||
Artwork computePreferredTrackArtwork(SearchTrackImageContext& searchContext, const db::Track::pointer& track)
|
||||
{
|
||||
// Try to get a media image
|
||||
Artwork res;
|
||||
{
|
||||
db::TrackEmbeddedImage::FindParameters params;
|
||||
params.setTrack(track->getId());
|
||||
params.setImageTypes({ db::ImageType::Media });
|
||||
params.setSortMethod(db::TrackEmbeddedImageSortMethod::SizeDesc);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::TrackEmbeddedImage::find(searchContext.session, params, [&](const db::TrackEmbeddedImage::pointer& image) { res = image->getId(); });
|
||||
}
|
||||
|
||||
if (isValid(res))
|
||||
return res;
|
||||
|
||||
// Fallback on another track of the same disc
|
||||
const db::ReleaseId releaseId{ track->getReleaseId() };
|
||||
if (!releaseId.isValid())
|
||||
return Artwork{};
|
||||
|
||||
{
|
||||
db::TrackEmbeddedImage::FindParameters params;
|
||||
params.setRelease(releaseId);
|
||||
params.setDiscNumber(track->getDiscNumber());
|
||||
params.setImageTypes({ db::ImageType::Media });
|
||||
params.setSortMethod(db::TrackEmbeddedImageSortMethod::TrackNumberThenSizeDesc);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::TrackEmbeddedImage::find(searchContext.session, params, [&](const db::TrackEmbeddedImage::pointer& image) { res = image->getId(); });
|
||||
}
|
||||
|
||||
if (isValid(res))
|
||||
return res;
|
||||
|
||||
// Fallback on front cover for this track
|
||||
{
|
||||
db::TrackEmbeddedImage::FindParameters params;
|
||||
params.setTrack(track->getId());
|
||||
params.setImageTypes({ db::ImageType::FrontCover });
|
||||
params.setSortMethod(db::TrackEmbeddedImageSortMethod::SizeDesc);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::TrackEmbeddedImage::find(searchContext.session, params, [&](const db::TrackEmbeddedImage::pointer& image) { res = image->getId(); });
|
||||
}
|
||||
|
||||
if (isValid(res))
|
||||
return res;
|
||||
|
||||
// Fallback on the artwork already resolved for the release
|
||||
if (const db::Release::pointer release{ db::Release::find(searchContext.session, releaseId) })
|
||||
{
|
||||
db::ArtworkId artworkId{ release->getPreferredArtworkId() };
|
||||
if (artworkId.isValid())
|
||||
res = artworkId;
|
||||
}
|
||||
|
||||
return res;
|
||||
}
|
||||
|
||||
Artwork computePreferredTrackMediaArtwork(SearchTrackImageContext& searchContext, const db::Track::pointer& track)
|
||||
{
|
||||
Artwork res;
|
||||
{
|
||||
db::TrackEmbeddedImage::FindParameters params;
|
||||
params.setTrack(track->getId());
|
||||
params.setImageTypes({ db::ImageType::Media });
|
||||
params.setSortMethod(db::TrackEmbeddedImageSortMethod::SizeDesc);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::TrackEmbeddedImage::find(searchContext.session, params, [&](const db::TrackEmbeddedImage::pointer& image) { res = image->getId(); });
|
||||
}
|
||||
|
||||
if (isValid(res))
|
||||
return res;
|
||||
|
||||
// fallback on another track of the same disc
|
||||
if (const db::ReleaseId releaseId{ track->getReleaseId() }; releaseId.isValid())
|
||||
{
|
||||
db::TrackEmbeddedImage::FindParameters params;
|
||||
params.setRelease(releaseId);
|
||||
params.setDiscNumber(track->getDiscNumber());
|
||||
params.setImageTypes({ db::ImageType::Media });
|
||||
params.setSortMethod(db::TrackEmbeddedImageSortMethod::TrackNumberThenSizeDesc);
|
||||
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
||||
db::TrackEmbeddedImage::find(searchContext.session, params, [&](const db::TrackEmbeddedImage::pointer& image) { res = image->getId(); });
|
||||
}
|
||||
|
||||
return res;
|
||||
}
|
||||
|
||||
bool fetchNextTrackArtworksToUpdate(SearchTrackImageContext& searchContext, TrackImageAssociationContainer& trackImageAssociations)
|
||||
{
|
||||
const db::TrackId trackId{ searchContext.lastRetrievedTrackId };
|
||||
|
||||
{
|
||||
constexpr std::size_t readBatchSize{ 100 };
|
||||
|
||||
auto transaction{ searchContext.session.createReadTransaction() };
|
||||
|
||||
db::Track::find(searchContext.session, searchContext.lastRetrievedTrackId, readBatchSize, [&](const db::Track::pointer& track) {
|
||||
const Artwork preferredArtwork{ computePreferredTrackArtwork(searchContext, track) };
|
||||
const Artwork preferredMediaArtwork{ computePreferredTrackMediaArtwork(searchContext, track) };
|
||||
|
||||
const db::Artwork::pointer currentPreferredArtwork{ track->getPreferredArtwork() };
|
||||
const db::Artwork::pointer currentPreferredMediaArtwork{ track->getPreferredMediaArtwork() };
|
||||
|
||||
if (!isSameArtwork(preferredArtwork, currentPreferredArtwork)
|
||||
|| !isSameArtwork(preferredMediaArtwork, currentPreferredMediaArtwork))
|
||||
{
|
||||
trackImageAssociations.push_back(TrackImageAssociation{ track, preferredArtwork, preferredMediaArtwork });
|
||||
}
|
||||
|
||||
searchContext.processedTrackCount++;
|
||||
});
|
||||
}
|
||||
|
||||
return trackId != searchContext.lastRetrievedTrackId;
|
||||
}
|
||||
|
||||
void updateTrackPreferredArtwork(db::Session& session, db::Track::pointer& track, Artwork preferredArtwork)
|
||||
{
|
||||
db::Artwork::pointer artwork;
|
||||
if (const db::TrackEmbeddedImageId * trackEmbeddedImageId{ std::get_if<db::TrackEmbeddedImageId>(&preferredArtwork) })
|
||||
artwork = utils::getOrCreateArtworkFromTrackEmbeddedImage(session, *trackEmbeddedImageId);
|
||||
else if (const db::ArtworkId * artworkId{ std::get_if<db::ArtworkId>(&preferredArtwork) })
|
||||
artwork = db::Artwork::find(session, *artworkId);
|
||||
|
||||
// Using track.modify() is quite CPU intensive as the track class has too many fields
|
||||
db::Track::updatePreferredArtwork(session, track->getId(), artwork->getId());
|
||||
if (artwork)
|
||||
LMS_LOG(DBUPDATER, DEBUG, "Updated preferred artwork in track " << track->getAbsoluteFilePath() << " with image in " << utils::toPath(session, artwork->getId()));
|
||||
else
|
||||
LMS_LOG(DBUPDATER, DEBUG, "Removed preferred artwork from track " << track->getAbsoluteFilePath());
|
||||
}
|
||||
|
||||
void updateTrackPreferredMediaArtwork(db::Session& session, db::Track::pointer& track, Artwork preferredArtwork)
|
||||
{
|
||||
db::Artwork::pointer artwork;
|
||||
if (const db::TrackEmbeddedImageId * trackEmbeddedImageId{ std::get_if<db::TrackEmbeddedImageId>(&preferredArtwork) })
|
||||
artwork = utils::getOrCreateArtworkFromTrackEmbeddedImage(session, *trackEmbeddedImageId);
|
||||
else if (const db::ArtworkId * artworkId{ std::get_if<db::ArtworkId>(&preferredArtwork) })
|
||||
artwork = db::Artwork::find(session, *artworkId);
|
||||
|
||||
// Using track.modify() is quite CPU intensive as the track class has too many fields
|
||||
db::Track::updatePreferredMediaArtwork(session, track->getId(), artwork->getId());
|
||||
if (artwork)
|
||||
LMS_LOG(DBUPDATER, DEBUG, "Updated preferred media artwork in track '" << track->getAbsoluteFilePath() << "' with image in " << utils::toPath(session, artwork->getId()));
|
||||
else
|
||||
LMS_LOG(DBUPDATER, DEBUG, "Removed preferred media artwork from track '" << track->getAbsoluteFilePath() << "'");
|
||||
}
|
||||
|
||||
void updateTrackPreferredArtworks(db::Session& session, const TrackImageAssociation& trackImageAssociation)
|
||||
{
|
||||
db::Track::pointer track{ trackImageAssociation.track };
|
||||
|
||||
{
|
||||
const db::Artwork::pointer currentPreferredArtwork{ track->getPreferredArtwork() };
|
||||
if (!isSameArtwork(trackImageAssociation.preferredArtwork, currentPreferredArtwork))
|
||||
updateTrackPreferredArtwork(session, track, trackImageAssociation.preferredArtwork);
|
||||
}
|
||||
|
||||
{
|
||||
const db::Artwork::pointer currentPreferredMediaArtwork{ track->getPreferredMediaArtwork() };
|
||||
if (!isSameArtwork(trackImageAssociation.preferredMediaArtwork, currentPreferredMediaArtwork))
|
||||
updateTrackPreferredMediaArtwork(session, track, trackImageAssociation.preferredMediaArtwork);
|
||||
}
|
||||
}
|
||||
|
||||
void updateTrackPreferredArtworks(db::Session& session, TrackImageAssociationContainer& imageAssociations)
|
||||
{
|
||||
constexpr std::size_t writeBatchSize{ 50 };
|
||||
|
||||
while (!imageAssociations.empty())
|
||||
{
|
||||
auto transaction{ session.createWriteTransaction() };
|
||||
|
||||
for (std::size_t i{}; !imageAssociations.empty() && i < writeBatchSize; ++i)
|
||||
{
|
||||
updateTrackPreferredArtworks(session, imageAssociations.front());
|
||||
imageAssociations.pop_front();
|
||||
}
|
||||
}
|
||||
}
|
||||
} // namespace
|
||||
|
||||
ScanStepAssociateTrackImages::ScanStepAssociateTrackImages(InitParams& initParams)
|
||||
: ScanStepBase{ initParams }
|
||||
{
|
||||
}
|
||||
|
||||
bool ScanStepAssociateTrackImages::needProcess(const ScanContext& context) const
|
||||
{
|
||||
return context.stats.nbChanges() > 0;
|
||||
}
|
||||
|
||||
void ScanStepAssociateTrackImages::process(ScanContext& context)
|
||||
{
|
||||
auto& session{ _db.getTLSSession() };
|
||||
|
||||
{
|
||||
auto transaction{ session.createReadTransaction() };
|
||||
context.currentStepStats.totalElems = db::Track::getCount(session);
|
||||
}
|
||||
|
||||
SearchTrackImageContext searchContext{
|
||||
.session = session,
|
||||
.lastRetrievedTrackId = {},
|
||||
};
|
||||
|
||||
TrackImageAssociationContainer trackImageAssociations;
|
||||
while (fetchNextTrackArtworksToUpdate(searchContext, trackImageAssociations))
|
||||
{
|
||||
if (_abortScan)
|
||||
return;
|
||||
|
||||
updateTrackPreferredArtworks(session, trackImageAssociations);
|
||||
context.currentStepStats.processedElems = searchContext.processedTrackCount;
|
||||
_progressCallback(context.currentStepStats);
|
||||
}
|
||||
}
|
||||
} // namespace lms::scanner
|
||||
@@ -0,0 +1,40 @@
|
||||
/*
|
||||
* Copyright (C) 2024 Emeric Poupon
|
||||
*
|
||||
* This file is part of LMS.
|
||||
*
|
||||
* LMS 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.
|
||||
*
|
||||
* LMS 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 LMS. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "ScanStepBase.hpp"
|
||||
|
||||
namespace lms::scanner
|
||||
{
|
||||
class ScanStepAssociateTrackImages : public ScanStepBase
|
||||
{
|
||||
public:
|
||||
ScanStepAssociateTrackImages(InitParams& initParams);
|
||||
~ScanStepAssociateTrackImages() override = default;
|
||||
ScanStepAssociateTrackImages(const ScanStepAssociateTrackImages&) = delete;
|
||||
ScanStepAssociateTrackImages& operator=(const ScanStepAssociateTrackImages&) = delete;
|
||||
|
||||
private:
|
||||
ScanStep getStep() const override { return ScanStep::AssociateReleaseImages; }
|
||||
core::LiteralString getStepName() const override { return "Associate track images"; }
|
||||
bool needProcess(const ScanContext& context) const override;
|
||||
void process(ScanContext& context) override;
|
||||
};
|
||||
} // namespace lms::scanner
|
||||
Reference in New Issue
Block a user