dimgthreadedfilter.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2005-05-25
 * Description : threaded image filter class.
 *
 * Copyright (C) 2005-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2007-2012 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * 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_DIMG_THREADED_FILTER_H
#define DIGIKAM_DIMG_THREADED_FILTER_H
 
// Local includes
 
#include "digikam_export.h"
#include "dimg.h"
#include "dynamicthread.h"
#include "filteraction.h"
 
class QObject;
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DImgThreadedFilter : public DynamicThread
{
    Q_OBJECT
 
public:
 
    explicit DImgThreadedFilter(QObject* const parent = nullptr, const QString& name = QString());
 
    DImgThreadedFilter(DImg* const orgImage,
                       QObject* const parent,
                       const QString& name = QString());
 
    ~DImgThreadedFilter() override;
 
    void setupFilter(const DImg& orgImage);
 
    void setupAndStartDirectly(const DImg& orgImage,
                               DImgThreadedFilter* const master,
                               int progressBegin = 0,
                               int progressEnd = 100);
 
    void setOriginalImage(const DImg& orgImage);
    void setFilterName(const QString& name);
 
    DImg getTargetImage()
    {
        return m_destImage;
    };
 
    const QString& filterName()
    {
        return m_name;
    };
 
    QList<int> multithreadedSteps(int stop, int start = 0)                      const;
 
    virtual void startFilter();
 
    virtual void cancelFilter();
 
    virtual void startFilterDirectly();
 
    virtual FilterAction filterAction()                                               = 0;
 
    virtual void readParameters(const FilterAction&)                                  = 0;
 
    virtual QString filterIdentifier()                                          const = 0;
 
    virtual QList<int> supportedVersions()                                      const;
 
    void setFilterVersion(int version);
    int filterVersion()                                                         const;
 
    virtual bool parametersSuccessfullyRead()                                   const;
    virtual QString readParametersError(const FilterAction& actionThatFailed)   const;
 
Q_SIGNALS:
 
    void started();
 
    void progress(int progress);
 
    void finished(bool success);
 
protected:
 
    virtual void initFilter();
 
    void run() override;
 
    virtual void filterImage() = 0;
 
    virtual void cleanupFilter() {};
 
    void postProgress(int progress);
 
protected:
 
    DImgThreadedFilter(DImgThreadedFilter* const master,
                       const DImg& orgImage,
                       const DImg& destImage,
                       int progressBegin = 0,
                       int progressEnd = 100,
                       const QString& name = QString());
 
    void initSlave(DImgThreadedFilter* const master,
                   int progressBegin = 0,
                   int progressEnd = 100);
 
    void setSlave(DImgThreadedFilter* const slave);
 
    virtual int modulateProgress(int progress);
 
    void initMaster();
    virtual void prepareDestImage();
 
    template <class Filter>
 
    class DefaultFilterAction : public FilterAction
    {
    public:
 
        explicit DefaultFilterAction(FilterAction::Category category = FilterAction::ReproducibleFilter)
            : FilterAction(Filter::FilterIdentifier(), Filter::CurrentVersion(), category)
        {
            setDisplayableName(Filter::DisplayableName());
        }
 
        explicit DefaultFilterAction(bool isReproducible)
            : FilterAction(Filter::FilterIdentifier(), Filter::CurrentVersion(),
                           isReproducible ? FilterAction::ReproducibleFilter : FilterAction::ComplexFilter)
        {
            setDisplayableName(Filter::DisplayableName());
        }
 
        void supportOlderVersionIf(int version, bool condition)
        {
            if (condition && (version <= m_version))
            {
                m_version = version;
            }
        }
 
    };
 
protected:
 
    int                 m_version;
 
    bool                m_wasCancelled;
 
    int                 m_progressBegin;
    int                 m_progressSpan;
    int                 m_progressCurrent;  
 
    QString             m_name;
 
    DImg                m_orgImage;
 
    DImg                m_destImage;
 
    DImgThreadedFilter* m_slave;
 
    DImgThreadedFilter* m_master;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DIMG_THREADED_FILTER_H