loadsavethread.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2005-12-17
 * Description : image file IO threaded interface.
 *
 * Copyright (C) 2005-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2005-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_LOAD_SAVE_THREAD_H
#define DIGIKAM_LOAD_SAVE_THREAD_H
 
// Qt includes
 
#include <QThread>
#include <QMutex>
#include <QList>
#include <QDateTime>
#include <QWaitCondition>
#include <QEvent>
 
// Local includes
 
#include "dimg.h"
#include "digikam_export.h"
#include "dynamicthread.h"
#include "loadingdescription.h"
 
namespace Digikam
{
 
class DMetadata;
class LoadSaveTask;
 
class DIGIKAM_EXPORT LoadSaveNotifier
{
public:
 
    LoadSaveNotifier();
    virtual ~LoadSaveNotifier();
 
    virtual void imageStartedLoading(const LoadingDescription& loadingDescription)                  = 0;
    virtual void loadingProgress(const LoadingDescription& loadingDescription, float progress)      = 0;
    virtual void imageLoaded(const LoadingDescription& loadingDescription, const DImg& img)         = 0;
    virtual void moreCompleteLoadingAvailable(const LoadingDescription& oldLoadingDescription,
                                              const LoadingDescription& newLoadingDescription)      = 0;
    virtual void imageStartedSaving(const QString& filePath)                                        = 0;
    virtual void savingProgress(const QString& filePath, float progress)                            = 0;
    virtual void imageSaved(const QString& filePath, bool success)                                  = 0;
    virtual void thumbnailLoaded(const LoadingDescription& loadingDescription, const QImage& img)   = 0;
 
private:
 
    Q_DISABLE_COPY(LoadSaveNotifier)
};
 
// -------------------------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT LoadSaveFileInfoProvider
{
public:
 
    LoadSaveFileInfoProvider();
    virtual ~LoadSaveFileInfoProvider();
 
    virtual int   orientationHint(const QString& path)  = 0;
 
    virtual QSize dimensionsHint(const QString& path)   = 0;
 
private:
 
    Q_DISABLE_COPY(LoadSaveFileInfoProvider)
};
 
// -------------------------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT LoadSaveThread : public DynamicThread,
                                      public LoadSaveNotifier
{
    Q_OBJECT
 
public:
 
    enum NotificationPolicy
    {
        NotificationPolicyDirect,
        NotificationPolicyTimeLimited
    };
 
    enum AccessMode
    {
        AccessModeRead,
        AccessModeReadWrite
    };
 
public:
 
    explicit LoadSaveThread(QObject* const parent = nullptr);
 
    ~LoadSaveThread() override;
 
    void load(const LoadingDescription& description);
 
    void save(const DImg& image, const QString& filePath, const QString& format);
 
    void setNotificationPolicy(NotificationPolicy notificationPolicy);
 
public:
 
    static void setInfoProvider(LoadSaveFileInfoProvider* const infoProvider);
    static LoadSaveFileInfoProvider* infoProvider();
 
    static int exifOrientation(const QString& filePath,
                               const DMetadata& metadata,
                               bool isRaw,
                               bool fromRawEmbeddedPreview);
 
Q_SIGNALS:
 
    void signalImageStartedLoading(const LoadingDescription& loadingDescription);
 
    void signalLoadingProgress(const LoadingDescription& loadingDescription, float progress);
 
    void signalImageLoaded(const LoadingDescription& loadingDescription, const DImg& img);
 
    void signalMoreCompleteLoadingAvailable(const LoadingDescription& oldLoadingDescription,
                                            const LoadingDescription& newLoadingDescription);
 
    void signalImageStartedSaving(const QString& filePath);
    void signalSavingProgress(const QString& filePath, float progress);
    void signalImageSaved(const QString& filePath, bool success);
 
    void signalThumbnailLoaded(const LoadingDescription& loadingDescription, const QImage& img);
 
public:
 
    void imageStartedLoading(const LoadingDescription& loadingDescription)                override;
    void loadingProgress(const LoadingDescription& loadingDescription, float progress)    override;
    void imageLoaded(const LoadingDescription& loadingDescription, const DImg& img)       override;
    void moreCompleteLoadingAvailable(const LoadingDescription& oldLoadingDescription,
                                      const LoadingDescription& newLoadingDescription)    override;
    void imageStartedSaving(const QString& filePath)                                      override;
    void savingProgress(const QString& filePath, float progress)                          override;
    void imageSaved(const QString& filePath, bool success)                                override;
    void thumbnailLoaded(const LoadingDescription& loadingDescription, const QImage& img) override;
 
    virtual bool querySendNotifyEvent() const;
    virtual void taskHasFinished();
 
protected:
 
    void run()                                                                            override;
 
    void notificationReceived();
 
protected:
 
    QMutex               m_mutex;
 
    QList<LoadSaveTask*> m_todo;
 
    LoadSaveTask*        m_currentTask;
 
    NotificationPolicy   m_notificationPolicy;
 
private:
 
    // Disable
    LoadSaveThread(const LoadSaveThread&)            = delete;
    LoadSaveThread& operator=(const LoadSaveThread&) = delete;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_LOAD_SAVE_THREAD_H