/* ============================================================ * * This file is a part of digiKam project * https://www.digikam.org * * Date : 2024-11-10 * Description : Performs face detection and recognition * * SPDX-FileCopyrightText: 2024-2026 by Gilles Caulier * SPDX-FileCopyrightText: 2024-2025 by Michael Miller * * SPDX-License-Identifier: GPL-2.0-or-later * * ============================================================ */ #include "facepipelinerecognize.h" // Qt includes #include #include #include #include // KDE includes #include // Local includes #include "digikam_debug.h" #include "digikam_opencv.h" #include "sharedqueue.h" #include "collectionmanager.h" #include "album.h" #include "iteminfo.h" #include "coredb.h" #include "facescansettings.h" #include "dimg.h" #include "faceutils.h" #include "facepipelinepackagebase.h" #include "identityprovider.h" #include "identity.h" #include "dnnsfaceextractor.h" #include "faceclassifier.h" #include "metadatahub.h" #include "scancontroller.h" namespace Digikam { FacePipelineRecognize::FacePipelineRecognize(const FaceScanSettings& _settings) : FacePipelineBase(_settings) { } bool FacePipelineRecognize::start() { FacePipelineBase::start(); QVariantMap params; params[QLatin1String("detectAccuracy")] = settings.detectAccuracy; params[QLatin1String("detectModel")] = settings.detectModel; params[QLatin1String("detectSize")] = settings.detectSize; params[QLatin1String("recognizeAccuracy")] = settings.recognizeAccuracy; params[QLatin1String("recognizeModel")] = settings.recognizeModel; detector.setParameters(params); { // use the mutex to synchronize the start of the threads QMutexLocker lock(&mutex); // add the worker threads for this pipeline addWorker(MLPipelineStage::Finder); addWorker(MLPipelineStage::Loader); addWorker(MLPipelineStage::Extractor); addWorker(MLPipelineStage::Classifier); addWorker(MLPipelineStage::Writer); } return true; } bool FacePipelineRecognize::finder() { ActionThreadBase::setCurrentThreadName(QString::fromLatin1("FaceReco%1").arg(QLatin1String(__FUNCTION__))); // To customize thread name MLPIPELINE_FINDER_START(settings.workerThreadPriority, MLPipelineStage::Loader); /* ========================================================================================= * Pipeline finder specific initialization code * * Use the block from here to MLPIPELINE_FINDER_END to find the IDs images to process. * The code in this block is run once per stage initialization. The number of instances * is alaways 1. */ // get the IDs to process FaceUtils utils; QSet filter; int serialNumber = 0; for (const Album* const album : std::as_const(settings.albums)) { if (cancelled) { break; } if (!album->isTrashAlbum()) { QList imageIds; // get the image IDs for the album if (album->type() == Album::PHYSICAL) { imageIds = CoreDbAccess().db()->getImageIds(album->id(), DatabaseItem::Status::Visible, true); } else if (album->type() == Album::TAG) { imageIds = CoreDbAccess().db()->getItemIDsInTag(album->id()); } // iterate over the image IDs and add unique IDs to the queue for processing for (qlonglong imageId : std::as_const(imageIds)) { // filter out duplicate image IDs if (!filter.contains(imageId)) { // quick check if we should add threads. if (!moreCpu) { moreCpu = checkMoreWorkers(totalItemCount, imageIds.size(), settings.useFullCpu); } QList faces = utils.unconfirmedFaceTagsIfaces(imageId); for (const FaceTagsIface& face : std::as_const(faces)) { ++totalItemCount; filter << imageId; enqueue(nextQueue, new FacePipelinePackageBase(imageId, face, ++serialNumber)); } } } } } for (const ItemInfo& info : std::as_const(settings.infos)) { // filter out duplicate image IDs qlonglong imageId = info.id(); if (!filter.contains(imageId)) { QList faces = utils.unconfirmedFaceTagsIfaces(imageId); for (const FaceTagsIface& face : std::as_const(faces)) { ++totalItemCount; filter << imageId; enqueue(nextQueue, new FacePipelinePackageBase(imageId, face, ++serialNumber)); } } } /* ========================================================================================= * Pipeline finder specific cleanup * * Use the block from here to MLPIPELINE_FINDER_END to clean up any resources used by the stage. */ MLPIPELINE_FINDER_END(MLPipelineStage::Loader); } bool FacePipelineRecognize::loader() { ActionThreadBase::setCurrentThreadName(QString::fromLatin1("FaceReco%1").arg(QLatin1String(__FUNCTION__))); // To customize thread name return commonFaceThumbnailLoader(QStringLiteral("FacePipelineRecognize"), settings.workerThreadPriority, MLPipelineStage::Loader, MLPipelineStage::Extractor); } bool FacePipelineRecognize::extractor() { ActionThreadBase::setCurrentThreadName(QString::fromLatin1("FaceReco%1").arg(QLatin1String(__FUNCTION__))); // To customize thread name return commonFaceThumbnailExtractor(QStringLiteral("FacePipelineRecognize"), settings.workerThreadPriority, MLPipelineStage::Extractor, MLPipelineStage::Classifier); } bool FacePipelineRecognize::classifier() { ActionThreadBase::setCurrentThreadName(QString::fromLatin1("FaceReco%1").arg(QLatin1String(__FUNCTION__))); // To customize thread name MLPIPELINE_STAGE_START(settings.workerThreadPriority, MLPipelineStage::Classifier, MLPipelineStage::Writer); FacePipelinePackageBase* package = nullptr; /* ========================================================================================= * Pipeline stage specific initialization code * * Use the block from here to MLPIPELINE_LOOP_START to initialize the stage. * The code in this block is run once per stage initialization. The number of instances * is at least 1. More instances are created by addMoreWorkers if needed. */ FaceClassifier* const classifier = FaceClassifier::instance(); classifier->setParameters(settings); MLPIPELINE_LOOP_START(MLPipelineStage::Classifier, thisQueue); package = static_cast(mlpackage); /* ========================================================================================= * Start pipeline stage specific loop * * All code from here to MLPIPELINE_LOOP_END is in a try/catch block and loop. * This loop is run once per image. */ { // verify the feature mat is the correct size if ( (2 == package->features.dims) && (1 == package->features.rows) && (128 == package->features.cols) ) { // classify the features package->label = classifier->predict(package->features, package->exclusionIdentityIds); } enqueue(nextQueue, package); package = nullptr; } /* ========================================================================================= * End pipeline stage specific loop */ MLPIPELINE_LOOP_END(MLPipelineStage::Classifier, "FacePipelineRecognize::classifier"); /* ========================================================================================= * Pipeline stage specific cleanup * * Use the block from here to MLPIPELINE_STAGE_END to clean up any resources used by the stage. */ MLPIPELINE_STAGE_END(MLPipelineStage::Classifier, MLPipelineStage::Writer); } bool FacePipelineRecognize::writer() { ActionThreadBase::setCurrentThreadName(QString::fromLatin1("FaceReco%1").arg(QLatin1String(__FUNCTION__))); // To customize thread name MLPIPELINE_STAGE_START(settings.workerThreadPriority, MLPipelineStage::Writer, MLPipelineStage::None); FacePipelinePackageBase* package = nullptr; /* ========================================================================================= * Pipeline stage specific initialization code * * Use the block from here to MLPIPELINE_LOOP_START to initialize the stage. * The code in this block is run once per stage initialization. The number of instances * is at least 1. More instances are created by addMoreWorkers if needed. */ FaceUtils utils; const IdentityProvider* const idProvider = IdentityProvider::instance(); MLPIPELINE_LOOP_START(MLPipelineStage::Writer, thisQueue); package = static_cast(mlpackage); /* ========================================================================================= * Start pipeline stage specific loop * * All code from here to MLPIPELINE_LOOP_END is in a try/catch block and loop. * This loop is run once per image. */ { QString displayName; int matches = 0; if (FaceClassifier::UNKNOWN_LABEL_ID != package->label) { Identity identity = idProvider->identity(package->label); int tagId = FaceTags::getOrCreateTagForIdentity(identity.attributesMap()); if (package->face.tagId() != tagId) { utils.changeSuggestedName(package->face, tagId); } displayName += identity.attribute(QStringLiteral("name")); matches = 1; } else { if (package->face.isUnconfirmedName()) { utils.changeTag(package->face, FaceTags::unknownPersonTagId()); } } // if (utils.normalTagChanged()) // { // MetadataHub hub; // hub.load(package->info); // ScanController::FileMetadataWrite writeScope(package->info); // writeScope.changed(hub.writeToMetadata(package->info, MetadataHub::WRITE_TAGS)); // } QString albumName = CollectionManager::instance()->albumRootLabel(package->info.albumRootId()); // send a notification that the image was processed notify(MLPipelineNotification::notifyProcessed, package->info.name(), albumName + package->info.relativePath(), displayName, matches, package->thumbnail); // delete the package delete package; package = nullptr; } /* ========================================================================================= * End pipeline stage specific loop */ MLPIPELINE_LOOP_END(MLPipelineStage::Writer, "FacePipelineRecognize::writer"); /* ========================================================================================= * Pipeline stage specific cleanup * * Use the block from here to MLPIPELINE_STAGE_END to clean up any resources used by the stage. */ MLPIPELINE_STAGE_END(MLPipelineStage::Writer, MLPipelineStage::None); } void FacePipelineRecognize::addMoreWorkers() { // use the performanceProfile metrics to find the slowest stages // and add more workers to those stages // for the recognition pipeline, the extractor is the slowest stage // so add 1 more loader and 2 more extractors addWorker(Loader); addWorker(Extractor); addWorker(Extractor); } } // namespace Digikam #include "moc_facepipelinerecognize.cpp"