facepipeline.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-09-03
 * Description : Integrated, multithread face detection / recognition
 *
 * Copyright (C) 2010-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2012-2022 by Gilles Caulier <caulier dot gilles 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 DIGIKAM_FACE_PIPELINE_H
#define DIGIKAM_FACE_PIPELINE_H
 
// Local includes
 
#include "facepipelinepackage.h"
 
namespace Digikam
{
 
class FacePipeline : public QObject
{
    Q_OBJECT
 
public:
 
    enum FilterMode
    {
        ScanAll,
 
        SkipAlreadyScanned,
 
        ReadUnconfirmedFaces,
 
        ReadFacesForTraining,
 
        ReadConfirmedFaces
    };
 
    enum WriteMode
    {
        NormalWrite,
 
        OverwriteUnconfirmed
    };
 
public:
 
    explicit FacePipeline();
    ~FacePipeline() override;
 
    void plugDatabaseFilter(FilterMode mode);
    void plugRerecognizingDatabaseFilter();
    void plugRetrainingDatabaseFilter();
    void plugFacePreviewLoader();
    void plugFaceDetector();
    void plugParallelFaceDetectors();
    void plugFaceRecognizer();
    void plugDatabaseWriter(WriteMode mode);
    void plugDatabaseEditor();
    void plugTrainer();
    void plugDetectionBenchmarker();
    void plugRecognitionBenchmarker();
    void construct();
 
    void cancel();
 
    void shutDown();
 
    bool hasFinished()           const;
    QString benchmarkResult()    const;
 
    void setPriority(QThread::Priority priority);
    QThread::Priority priority() const;
 
public Q_SLOTS:
 
    bool process(const ItemInfo& info);
    bool process(const ItemInfo& info, const DImg& image);
 
    FaceTagsIface confirm(const ItemInfo& info,
                          const FaceTagsIface& face,
                          int assignedTagId = 0,
                          const TagRegion& assignedRegion = TagRegion());
    FaceTagsIface confirm(const ItemInfo& info,
                          const FaceTagsIface& face,
                          const DImg& image,
                          int assignedTagId = 0,
                          const TagRegion& assignedRegion = TagRegion());
    void train(const ItemInfo& info,
               const QList<FaceTagsIface>& faces);
    void train(const ItemInfo& info,
               const QList<FaceTagsIface>& faces,
               const DImg& image);
 
    void remove(const ItemInfo& info,
                const FaceTagsIface& face);
 
    FaceTagsIface addManually(const ItemInfo& info,
                              const DImg& image,
                              const TagRegion& assignedRegion);
 
    FaceTagsIface editRegion(const ItemInfo& info,
                             const DImg& image,
                             const FaceTagsIface& databaseFace,
                             const TagRegion& newRegion);
 
    FaceTagsIface editTag(const ItemInfo& info,
                          const FaceTagsIface& databaseFace,
                          int newTagId);
 
    void process(const QList<ItemInfo>& infos);
 
    void setAccuracyAndModel(double accuracy, bool yolo);
 
Q_SIGNALS:
 
    void scheduled();
 
    void started(const QString& message);
 
    void processing(const FacePipelinePackage& package);
 
    void processed(const FacePipelinePackage& package);
    void progressValueChanged(float progress);
 
    void finished();
 
    void skipped(const QList<ItemInfo>& skippedInfos);
 
public:
 
    class Private;
 
private:
 
    // Disable
    explicit FacePipeline(QObject*)              = delete;
    FacePipeline(const FacePipeline&)            = delete;
    FacePipeline& operator=(const FacePipeline&) = delete;
 
private:
 
    Private* const d;
    friend class Private;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_FACE_PIPELINE_H