bwsepiafilter.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 : black and white image filter.
 *
 * 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_BW_SEPIA_FILTER_H
#define DIGIKAM_BW_SEPIA_FILTER_H
 
// Qt includes
 
#include <QPolygon>
 
// Local includes
 
#include "digikam_export.h"
#include "dimgthreadedfilter.h"
#include "digikam_globals.h"
#include "bcgfilter.h"
#include "curvesfilter.h"
#include "tonalityfilter.h"
 
namespace Digikam
{
 
class DImg;
 
class DIGIKAM_EXPORT BWSepiaContainer
{
 
public:
 
    enum BlackWhiteConversionType
    {
        BWNoFilter = 0,       
        BWGreenFilter,
        BWOrangeFilter,
        BWRedFilter,
        BWYellowFilter,
        BWYellowGreenFilter,
        BWBlueFilter,
 
        BWGeneric,            
        BWAgfa200X,
        BWAgfapan25,
        BWAgfapan100,
        BWAgfapan400,
        BWIlfordDelta100,
        BWIlfordDelta400,
        BWIlfordDelta400Pro3200,
        BWIlfordFP4,
        BWIlfordHP5,
        BWIlfordPanF,
        BWIlfordXP2Super,
        BWKodakTmax100,
        BWKodakTmax400,
        BWKodakTriX,
 
        BWIlfordSFX200,       
        BWIlfordSFX400,
        BWIlfordSFX800,
 
        BWNoTone,             
        BWSepiaTone,
        BWBrownTone,
        BWColdTone,
        BWSeleniumTone,
        BWPlatinumTone,
        BWGreenTone,
 
        // Filter version 2
        BWKodakHIE            
    };
 
public:
 
    BWSepiaContainer()
        : preview    (false),
          previewType(BWGeneric),
          filmType   (BWGeneric),
          filterType (BWNoFilter),
          toneType   (BWNoTone),
          strength   (1.0)
    {
    };
 
    explicit BWSepiaContainer(int ptype)
        : preview    (true),
          previewType(ptype),
          filmType   (BWGeneric),
          filterType (BWNoFilter),
          toneType   (BWNoTone),
          strength   (1.0)
    {
    };
 
    BWSepiaContainer(int ptype, const CurvesContainer& container)
        : preview    (true),
          previewType(ptype),
          filmType   (BWGeneric),
          filterType (BWNoFilter),
          toneType   (BWNoTone),
          strength   (1.0),
          curvesPrm  (container)
    {
    };
 
    ~BWSepiaContainer()
    {
    };
 
public:
 
    bool            preview;
 
    int             previewType;
    int             filmType;
    int             filterType;
    int             toneType;
 
    double          strength;
 
    CurvesContainer curvesPrm;
 
    BCGContainer    bcgPrm;
};
 
// -----------------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT BWSepiaFilter : public DImgThreadedFilter
{
    Q_OBJECT
 
public:
 
    explicit BWSepiaFilter(QObject* const parent = nullptr);
    explicit BWSepiaFilter(DImg* orgImage,
                           QObject* const parent = nullptr,
                           const BWSepiaContainer& settings = BWSepiaContainer());
    ~BWSepiaFilter()                                        override;
 
    static QString FilterIdentifier()
    {
        return QLatin1String("digikam:BWSepiaFilter");
    }
 
    static QString DisplayableName();
 
    static QList<int> SupportedVersions()
    {
        return QList<int>() << 1 << 2;
    }
 
    static int CurrentVersion()
    {
        return 2;
    }
 
    QString filterIdentifier()                        const override
    {
        return FilterIdentifier();
    }
 
    FilterAction filterAction()                             override;
    void readParameters(const FilterAction& action)         override;
 
private:
 
    void filterImage()                                      override;
 
    DImg getThumbnailForEffect(const DImg& img);
 
    void blackAndWhiteConversion(DImg& img, int type);
    void applyChannelMixer(DImg& img);
    void applyInfraredFilter(DImg& img, int sensibility);
    void applyToneFilter(DImg& img, TonalityContainer& settings);
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_BW_SEPIA_FILTER_H