/* ============================================================ * * This file is a part of digiKam project * https://www.digikam.org * * Date : 2010-08-08 * Description : FaceEngine database interface allowing easy manipulation of face tags * * SPDX-FileCopyrightText: 2010-2011 by Aditya Bhatt * SPDX-FileCopyrightText: 2010-2011 by Marcel Wiesweg * SPDX-FileCopyrightText: 2012-2026 by Gilles Caulier * SPDX-FileCopyrightText: 2024-2025 by Michael Miller * * SPDX-License-Identifier: GPL-2.0-or-later * * ============================================================ */ #include "faceutils.h" // Qt includes #include // Local includes #include "digikam_debug.h" #include "coredbaccess.h" #include "coredbconstants.h" #include "coredboperationgroup.h" #include "coredb.h" #include "dimg.h" #include "facetags.h" #include "itemtagpair.h" #include "tagproperties.h" #include "tagscache.h" #include "tagregion.h" #include "thumbnailloadthread.h" #include "albummanager.h" #include "identityprovider.h" namespace Digikam { FaceUtils::FaceUtils(QObject* const parent) : QObject(parent) { } // --- Mark for scanning and training --- bool FaceUtils::hasBeenScanned(qlonglong imageid) const { return hasBeenScanned(ItemInfo(imageid)); } bool FaceUtils::hasBeenScanned(const ItemInfo& info) const { return info.tagIds().contains(FaceTags::scannedForFacesTagId()); } bool FaceUtils::normalTagChanged() const { return m_normalTagChanged; } void FaceUtils::markAsScanned(qlonglong imageid, bool hasBeenScanned) const { markAsScanned(ItemInfo(imageid), hasBeenScanned); } void FaceUtils::markAsScanned(const ItemInfo& info, bool hasBeenScanned) const { if (hasBeenScanned) { ItemInfo(info).setTag(FaceTags::scannedForFacesTagId()); } else { ItemInfo(info).removeTag(FaceTags::scannedForFacesTagId()); } } /** * Convert between FacesEngine results and FaceTagsIface. */ QList FaceUtils::toFaceTagsIfaces(qlonglong imageid, const QList& detectedFaces, const QList& recognitionResults, const QSize& fullSize) const { QList faces; for (int i = 0 ; i < detectedFaces.size() ; ++i) { Identity identity; if (!recognitionResults.isEmpty()) { identity = recognitionResults[i]; } // We'll get the unknownPersonTagId if the identity is null. int tagId = FaceTags::getOrCreateTagForIdentity(identity.attributesMap()); QRect fullSizeRect = TagRegion::relativeToAbsolute(detectedFaces[i], fullSize); FaceTagsIface::Type type = (identity.isNull() ? FaceTagsIface::UnknownName : FaceTagsIface::UnconfirmedName); if (!tagId || !fullSizeRect.isValid()) { faces << FaceTagsIface(); continue; } /* qCDebug(DIGIKAM_GENERAL_LOG) << "New Entry" << fullSizeRect << tagId; */ faces << FaceTagsIface(type, imageid, tagId, TagRegion(fullSizeRect)); } return faces; } /** * Images in faces and thumbnails. */ void FaceUtils::storeThumbnails(ThumbnailLoadThread* const thread, const QString& filePath, const QList& databaseFaces, const DImg& image) { for (const FaceTagsIface& face : std::as_const(databaseFaces)) { QList rects; QRect orgRect = face.region().toRect(); rects << orgRect; rects << faceRectToDisplayRect(orgRect); for (const QRect& rect : std::as_const(rects)) { QRect mapped = TagRegion::mapFromOriginalSize(image, rect); QImage detail = image.copyQImage(mapped); thread->storeDetailThumbnail(filePath, rect, detail, true); } } } // --- Face detection: merging results --- QList FaceUtils::writeUnconfirmedResults(qlonglong imageid, const QList& detectedFaces, const QList& recognitionResults, const QSize& fullSize) { // Build list of new entries. QList newFaces = toFaceTagsIfaces(imageid, detectedFaces, recognitionResults, fullSize); if (newFaces.isEmpty()) { return newFaces; } return writeUnconfirmedResults(imageid, newFaces); } QList FaceUtils::writeUnconfirmedResults(qlonglong imageid, QList& newFaces, const QList& recognitionResults) { for(int i = 0 ; i < newFaces.size() ; ++i) { newFaces[i].setTagId(FaceTags::getOrCreateTagForIdentity(recognitionResults.at(i).attributesMap())); } return writeUnconfirmedResults(imageid, newFaces); } QList FaceUtils::writeUnconfirmedResults(qlonglong imageid, QList& newFaces) { if (newFaces.isEmpty()) { return newFaces; } // List of existing entries. QList currentFaces = databaseFaces(imageid); // Merge new with existing entries. for (int i = 0 ; i < newFaces.size() ; ++i) { FaceTagsIface& newFace = newFaces[i]; QList overlappingEntries; for (const FaceTagsIface& oldFace : std::as_const(currentFaces)) { double minOverlap = (oldFace.isConfirmedName() ? 0.25 : 0.5); if (oldFace.region().intersects(newFace.region(), minOverlap)) { overlappingEntries << oldFace; qCDebug(DIGIKAM_GENERAL_LOG) << "Entry" << oldFace.region() << oldFace.tagId() << "overlaps" << newFace.region() << newFace.tagId() << ", skipping"; } } // The purpose if the next scope is to merge entries: // A confirmed face will never be overwritten. // If a name is set to an old face, it will only be replaced by a new face with a name. if (!overlappingEntries.isEmpty()) { if (newFace.isUnknownName()) { // We have no name in the new face. Do we have one in the old faces? for (int j = 0 ; j < overlappingEntries.size() ; ++j) { const FaceTagsIface& oldFace = overlappingEntries.at(j); if (oldFace.isUnknownName()) { // Remove old face. } else { // Skip new entry if any overlapping face has a name, and we do not. newFace = FaceTagsIface(); break; } } } else { // We have a name in the new face. Do we have names in overlapping faces? for (int j = 0 ; j < overlappingEntries.size() ; ++j) { const FaceTagsIface& oldFace = overlappingEntries[j]; if (oldFace.isUnknownName()) { // Remove old face. } else if (oldFace.isUnconfirmedName()) { if (oldFace.tagId() == newFace.tagId()) { // Remove smaller face. if (oldFace.region().intersects(newFace.region(), 1)) { newFace = FaceTagsIface(); break; } // Else remove old face. } else { // Assume new recognition is more trained, remove older face. } } else if (oldFace.isConfirmedName()) { // Skip new entry, confirmed has of course priority. newFace = FaceTagsIface(); } } } } // If we did not decide to skip this face, add is to the db now. if (!newFace.isNull()) { // List will contain all old entries that should still be removed. removeFaces(overlappingEntries); ItemTagPair pair(imageid, newFace.tagId()); // UnconfirmedName and UnknownName have the same attribute. addFaceAndTag(pair, newFace, FaceTagsIface::attributesForFlags(FaceTagsIface::UnconfirmedName), false); // If the face is unconfirmed and the tag is not the unknown person tag, set the unconfirmed person property. if (newFace.isUnconfirmedType() && !FaceTags::isTheUnknownPerson(newFace.tagId())) { ItemTagPair unconfirmedPair(imageid, FaceTags::unconfirmedPersonTagId()); unconfirmedPair.addProperty(ImageTagPropertyName::autodetectedPerson(), newFace.getAutodetectedPersonString()); } } } return newFaces; } /* Identity FaceUtils::identityForTag(int tagId, FacialRecognitionWrapper& recognizer) const */ Identity FaceUtils::identityForTag(int tagId) const { QMultiMap attributes = FaceTags::identityAttributes(tagId); Identity identity = IdentityProvider::instance()->findIdentity(attributes); if (!identity.isNull()) { qCDebug(DIGIKAM_GENERAL_LOG) << "Found FacesEngine identity" << identity.id() << "for tag" << tagId; return identity; } qCDebug(DIGIKAM_GENERAL_LOG) << "Adding new FacesEngine identity with attributes" << attributes; identity = IdentityProvider::instance()->addIdentity(attributes); FaceTags::applyTagIdentityMapping(tagId, identity.attributesMap()); return identity; } int FaceUtils::tagForIdentity(const Identity& identity) const { return FaceTags::getOrCreateTagForIdentity(identity.attributesMap()); } // --- Editing normal tags, reimplemented with MetadataHub --- void FaceUtils::addNormalTag(qlonglong imageId, int tagId) { FaceTagsEditor::addNormalTag(imageId, tagId); m_normalTagChanged |= !FaceTags::isSystemPersonTagId(tagId); } void FaceUtils::removeNormalTag(qlonglong imageId, int tagId) { FaceTagsEditor::removeNormalTag(imageId, tagId); m_normalTagChanged |= !FaceTags::isSystemPersonTagId(tagId); if (!FaceTags::isSystemPersonTagId(tagId)) { qlonglong faceItemId = CoreDbAccess().db()->getFirstItemWithFaceTag(tagId); /** * If the face just removed was the final face * associated with that Tag, reset Tag Icon. */ if (faceItemId == -1) { TAlbum* const album = AlbumManager::instance()->findTAlbum(tagId); if (album && (album->iconId() != 0)) { QString err; if (!AlbumManager::instance()->updateTAlbumIcon(album, QString(), 0, err)) { qCDebug(DIGIKAM_GENERAL_LOG) << err; } } } } } void FaceUtils::removeNormalTags(qlonglong imageId, const QList& tagIds) { FaceTagsEditor::removeNormalTags(imageId, tagIds); for (int tid : tagIds) { m_normalTagChanged |= !FaceTags::isSystemPersonTagId(tid); } } // --- Utilities --- QRect FaceUtils::faceRectToDisplayRect(const QRect& rect) { /** * Do not change that value unless you know what you do. * There are a lot of pregenerated thumbnails in user's databases, * expensive to regenerate, depending on this very value. */ int margin = qMax(rect.width(), rect.height()); margin /= 10; return rect.adjusted(-margin, -margin, margin, margin); } } // Namespace Digikam #include "moc_faceutils.cpp"