1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
/* ============================================================
 *
 * 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      by Gilles Caulier <caulier dot gilles at gmail dot com>
 * SPDX-FileCopyrightText: 2024      by Michael Miller <michael underscore miller at msn dot com>
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * ============================================================ */

#include "facepipelineedit.h"

// Qt includes

#include <QList>
#include <QSet>
#include <QElapsedTimer>
#include <QRectF>

// local includes

#include "digikam_debug.h"
#include "digikam_opencv.h"
#include "sharedqueue.h"
#include "album.h"
#include "iteminfo.h"
#include "coredb.h"
#include "facescansettings.h"
#include "dimg.h"
#include "previewloadthread.h"
#include "faceutils.h"
#include "facepipelinepackagebase.h"
#include "thumbnailloadthread.h"
#include "identityprovider.h"
#include "identity.h"
#include "dnnsfaceextractor.h"
#include "metadatahub.h"
#include "scancontroller.h"

namespace Digikam
{
// -----------------------------------------------------------------------------------------------

class Q_DECL_HIDDEN FacePipelineEditCreator
{
public:

    FacePipelineEdit object;
};

Q_GLOBAL_STATIC(FacePipelineEditCreator, FacePipelineEditCreator)

// -----------------------------------------------------------------------------------------------

FacePipelineEdit::FacePipelineEdit() : FacePipelineBase(FaceScanSettings())
{
}

FacePipelineEdit::~FacePipelineEdit()
{
}

FacePipelineEdit* FacePipelineEdit::instance()
{
    return &FacePipelineEditCreator->object;
}

FaceTagsIface FacePipelineEdit::confirmFace(const ItemInfo& info, const FaceTagsIface& face, int tagId, bool retrain)
{
    MLPipelineQueue* nextQueue = queues.value(MLPipelineStage::Loader);

    FacePipelinePackageBase* package = new FacePipelinePackageBase(info, face, tagId, face.region(), DImg(), FacePipelinePackageBase::EditPipelineAction::Confirm, retrain);
    enqueue(nextQueue, package);

    return FaceTagsEditor::confirmedEntry(face, tagId, face.region());

}

void FacePipelineEdit::removeFace(const ItemInfo& info, const FaceTagsIface& face)
{
    MLPipelineQueue* nextQueue = queues.value(MLPipelineStage::Writer);

    FacePipelinePackageBase* package = new FacePipelinePackageBase(info, face, face.tagId(), face.region(), DImg(), FacePipelinePackageBase::EditPipelineAction::Remove, face.isConfirmedName());
    enqueue(nextQueue, package);
}

FaceTagsIface FacePipelineEdit::editTag(const ItemInfo& info, const FaceTagsIface& face, int newTagId)
{
    MLPipelineQueue* nextQueue = queues.value(MLPipelineStage::Writer);

    FacePipelinePackageBase* package = new FacePipelinePackageBase(info, face, newTagId, face.region(), DImg(), FacePipelinePackageBase::EditPipelineAction::EditTag, face.isConfirmedName());
    enqueue(nextQueue, package);

    FaceTagsIface newFace(package->face);
    newFace.setTagId(newTagId);

    return newFace;
}

FaceTagsIface FacePipelineEdit::editRegion(const ItemInfo& info, const FaceTagsIface& face, TagRegion& region, const DImg& image, bool retrain)<--- Parameter 'region' can be declared as reference to const
{
    MLPipelineQueue* nextQueue = queues.value(MLPipelineStage::Writer);

    FacePipelinePackageBase* package = new FacePipelinePackageBase(info, face, face.tagId(), region, image, FacePipelinePackageBase::EditPipelineAction::EditRegion, retrain);
    enqueue(nextQueue, package);

    FaceTagsIface newFace(package->face);
    newFace.setRegion(TagRegion());

    return newFace;
}

FaceTagsIface FacePipelineEdit::addManually(const ItemInfo& info, const DImg& image, const TagRegion& region, bool retrain)
{
    MLPipelineQueue* nextQueue = queues.value(MLPipelineStage::Writer);

    FaceTagsIface face = FaceTagsEditor::unconfirmedEntry(info.id(), -1, region);

    FacePipelinePackageBase* package = new FacePipelinePackageBase(info, face, face.tagId(), face.region(), image, FacePipelinePackageBase::EditPipelineAction::AddManually, retrain);
    enqueue(nextQueue, package);

    return face;

}

bool FacePipelineEdit::start()
{
    if (!started)
    {
        started = true;

        {            
            // 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 FacePipelineBase::start();
    }
    else
    {
        return true;
    }
}

void FacePipelineEdit::cancel()
{
    FacePipelineBase::cancel();
}

bool FacePipelineEdit::loader()
{
    return commonFaceThumbnailLoader(QStringLiteral("FacePipelineEdit"), MLPipelineStage::Loader, MLPipelineStage::Extractor);
}

bool FacePipelineEdit::extractor()
{
    return commonFaceThumbnailExtractor(QStringLiteral("FacePipelineEdit"), MLPipelineStage::Extractor, MLPipelineStage::Writer);
}

bool FacePipelineEdit::writer()
{
    // All threads start with the same basic functions
    MLPipelineQueue *thisQueue, *nextQueue = nullptr;
    stageStart(QThread::LowPriority, MLPipelineStage::Writer, MLPipelineStage::None, thisQueue, nextQueue);
    FacePipelinePackageBase* package = nullptr;
    QElapsedTimer timer;
    //--------------------------------------------------------------------------------

    FaceUtils utils;
    IdentityProvider* idProvider = IdentityProvider::instance();

    ThumbnailLoadThread* thumbnailLoadThread = new ThumbnailLoadThread;
    // thumbnailLoadThread = ThumbnailLoadThread::defaultThread();

    thumbnailLoadThread->setPixmapRequested(false);
    thumbnailLoadThread->setThumbnailSize(ThumbnailLoadThread::maximumThumbnailSize());
    thumbnailLoadThread->setPriority(QThread::NormalPriority);

    while (!cancelled)
    {
        try
        {
            package = static_cast<FacePipelinePackageBase*>(dequeue(thisQueue));
            if (queueEndSignal() == package)
            {
                // end of queue signal

                break;
            }
            performanceProfileList[MLPipelineStage::Writer].maxQueueCount = qMax(performanceProfileList[MLPipelineStage::Writer].maxQueueCount, thisQueue->size());
            ++performanceProfileList[MLPipelineStage::Writer].itemCount;

            timer.start();

            //////////////////////////////////////////////////////////////////////////////////////////////
            // start pipeline stage specific code

            switch (package->action)
            {
                case FacePipelinePackageBase::EditPipelineAction::Confirm:
                {
                    FaceTagsIface confirmedFace = utils.confirmName(package->face, package->tagId, package->face.region());

                    Identity identity    = utils.identityForTag(confirmedFace.tagId());

                    if (0 != package->features.rows)
                    {
                        idProvider->addTraining(identity, confirmedFace.hash(), package->features);
                    }
                    else
                    {
                        qCDebug(DIGIKAM_FACESENGINE_LOG) << "FacePipelineEdit::writer(): bad mat";    
                    }
                    break;
                }
                case FacePipelinePackageBase::EditPipelineAction::Remove:
                {
                    utils.removeFace(package->face);
                    break;
                }
                case FacePipelinePackageBase::EditPipelineAction::EditTag:
                {
                    // Change Tag operation.
                    utils.changeTag(package->face, package->tagId);
                    break;
                }
                case FacePipelinePackageBase::EditPipelineAction::EditRegion:
                {
                    if (package->face.region() != package->region)
                    {
                        utils.changeRegion(package->face, package->region);
                    }
                    break;
                }
                case FacePipelinePackageBase::EditPipelineAction::AddManually:
                {
                    utils.addManually(utils.unconfirmedEntry(package->info.id(), package->tagId, package->region));
                }
                    // if      (package->face.isNull())
                    // {
                    //     // Add Manually.

                    //     FaceTagsIface newFace = utils.unconfirmedEntry(package->info.id(), package->face.assignedTagId, package->face.assignedRegion);
                    //     utils.addManually(newFace);
                    //     // add << FacePipelineFaceTagsIface(newFace);
                    // }
                    // else if (package->face.assignedRegion.isValid())
                    // {
                    //     add << FacePipelineFaceTagsIface();
                    // }       
            }

            // update the tags

            if (utils.normalTagChanged())
            {
                MetadataHub hub;
                hub.load(package->info);

                ScanController::FileMetadataWrite writeScope(package->info);
                writeScope.changed(hub.writeToMetadata(package->info, MetadataHub::WRITE_TAGS));
            }

            // store the thumbnails if we have an image

            if (!package->image.isNull())
            {
                QList<FaceTagsIface> faces;
                faces << package->face;
                utils.storeThumbnails(thumbnailLoadThread, package->info.filePath(), faces, package->image);
            }

            // retrain the face classifier if the retrain flag is set

            if (package->retrain)
            {
                FaceClassifier::instance()->retrain();
            }

            // send a notification that the image was processed

            notify(MLPipelineNotification::notifyProcessed, package->info.name(), package->info.filePath(), package->faceRects.size(), package->thumbnail);

            // delete the package

            delete package;

            // end pipeline stage specific code
            //////////////////////////////////////////////////////////////////////////////////////////////

            performanceProfileList[MLPipelineStage::Writer].elapsedTime += timer.elapsed();
            performanceProfileList[MLPipelineStage::Writer].maxElapsedTime = qMax(performanceProfileList[MLPipelineStage::Writer].maxElapsedTime, timer.elapsed());
        }
        catch(const std::exception& e)
        {
            std::cerr << e.what() << '\n';
        }
        catch(...)
        {
            qCDebug(DIGIKAM_FACESENGINE_LOG) << "FacePipelineEdit::writer(): unknown error.  Restarting...";
            if (package)
            {
                delete package;
            }
        }        
    }

    //--------------------------------------------------------------------------------
    // all threads end with the same basic functions
    stageEnd(MLPipelineStage::Writer, MLPipelineStage::None);

    return true;
}

void FacePipelineEdit::addMoreWorkers()
{
    // edit pipeline is always single thread per stage
}

}

#include "moc_facepipelineedit.cpp"