facialrecognition_wrapper.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam
 *
 * Date        : 2010-06-16
 * Description : The recognition wrapper
 *
 * Copyright (C)      2010 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C)      2010 by Aditya Bhatt <adityabhatt1991 at gmail dot com>
 * Copyright (C) 2010-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C)      2020 by Nghia Duong <minhnghiaduong997 at gmail dot com>
 *
 * This program 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 2, or (at your option)
 * any later version.
 *
 * This program 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.
 *
 * ============================================================ */
 
#ifndef FACIAL_RECOGNITION_WRAPPER_H
#define FACIAL_RECOGNITION_WRAPPER_H
 
// Qt includes
 
#include <QExplicitlySharedDataPointer>
#include <QImage>
#include <QList>
#include <QMultiMap>
#include <QVariant>
 
// Local includes
 
#include "digikam_export.h"
#include "identity.h"
#include "dataproviders.h"
 
namespace Digikam
{
 
class DIGIKAM_GUI_EXPORT FacialRecognitionWrapper
{
public:
 
    explicit FacialRecognitionWrapper();
    FacialRecognitionWrapper(const FacialRecognitionWrapper&);
 
    ~FacialRecognitionWrapper();
 
public:
 
    bool integrityCheck();
 
    void vacuum();
 
public:
 
    // --- Backend parameters (facesengine_interface_setup.cpp) --------------------------
    void        setParameter(const QString& parameter, const QVariant& value);
    void        setParameters(const QVariantMap& parameters);
    QVariantMap parameters()                                                const;
 
    // --- Identity management (facesengine_interface_identity.cpp) -----------------------------------------
 
 
    QList<Identity> allIdentities()                                         const;
    Identity        identity(int id)                                        const;
 
    Identity findIdentity(const QString& attribute, const QString& value)   const;
 
    Identity findIdentity(const QMultiMap<QString, QString>& attributes)         const;
 
    Identity addIdentity(const QMultiMap<QString, QString>& attributes);
 
    Identity addIdentityDebug(const QMultiMap<QString, QString>& attributes);
 
    void addIdentityAttributes(int id, const QMultiMap<QString, QString>& attributes);
    void addIdentityAttribute(int id, const QString& attribute, const QString& value);
    void setIdentityAttributes(int id, const QMultiMap<QString, QString>& attributes);
 
    void deleteIdentity(const Identity& identityToBeDeleted);
 
    void deleteIdentities(QList<Identity> identitiesToBeDeleted);
 
    // --- Faces Training management (facesengine_interface_training.cpp) ----------------------------------------------------
    void train(const QList<Identity>& identitiesToBeTrained,
               TrainingDataProvider* const data,
               const QString& trainingContext);
    void train(const Identity& identityToBeTrained,
               TrainingDataProvider* const data,
               const QString& trainingContext);
 
    void train(const Identity& identityToBeTrained,
               QImage* image,
               const QString& trainingContext);
    void train(const Identity& identityToBeTrained,
               const QList<QImage*>& images,
               const QString& trainingContext);
 
    void clearAllTraining(const QString& trainingContext = QString());
 
    void clearTraining(const QList<Identity>& identitiesToClean,
                       const QString& trainingContext = QString());
 
    // --- Recognition management (facesengine_interface_recognize.cpp) -------------------
 
    // TODO : review to see if this function is necessary
    //int recommendedImageSize(const QSize& availableSize = QSize()) const;
 
    QList<Identity> recognizeFaces(ImageListProvider* const images);
    QList<Identity> recognizeFaces(const QList<QImage*>& images);
    Identity        recognizeFace(QImage* const image);
 
private:
 
    // Disable
    FacialRecognitionWrapper& operator=(const FacialRecognitionWrapper&) = delete;
 
private:
 
    class Private;
    static Private* d;
};
 
} // namespace Digikam
 
#endif // FACIAL_RECOGNITION_WRAPPER_H