bcgfilter.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2005-03-06
 * Description : a Brightness/Contrast/Gamma image filter.
 *
 * Copyright (C) 2005      by Renchi Raju <renchi dot raju at gmail dot com>
 * Copyright (C) 2005-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2010      by Martin Klapetek <martin dot klapetek 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_BCG_FILTER_H
#define DIGIKAM_BCG_FILTER_H
 
// Local includes
 
#include "bcgcontainer.h"
#include "digikam_export.h"
#include "dimgthreadedfilter.h"
#include "digikam_globals.h"
 
namespace Digikam
{
 
class DImg;
 
class DIGIKAM_EXPORT BCGFilter : public DImgThreadedFilter
{
    Q_OBJECT
 
public:
 
    explicit BCGFilter(QObject* const parent = nullptr);
    explicit BCGFilter(DImg* const orgImage,
                       QObject* const parent = nullptr,
                       const BCGContainer& settings = BCGContainer());
    explicit BCGFilter(const BCGContainer& settings,
                       DImgThreadedFilter* const master,
                       const DImg& orgImage,
                       const DImg& destImage,
                       int progressBegin = 0,
                       int progressEnd = 100);
    ~BCGFilter()                                                  override;
 
    static QString FilterIdentifier()
    {
        return QLatin1String("digikam:BCGFilter");
    }
 
    static QString DisplayableName();
 
    static QList<int> SupportedVersions()
    {
        return QList<int>() << 1;
    }
 
    static int CurrentVersion()
    {
        return 1;
    }
 
    QString filterIdentifier()                              const override
    {
        return FilterIdentifier();
    }
 
    FilterAction filterAction()                                   override;
 
    void readParameters(const FilterAction& action)               override;
 
private:
 
    void filterImage()                                            override;
 
    void reset();
    void setGamma(double val);
    void setBrightness(double val);
    void setContrast(double val);
    void applyBCG(const DImg& image);
    void applyBCG(uchar* const bits, uint width, uint height, bool sixteenBits);
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_BCG_FILTER_H