hslfilter.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 : Hue/Saturation/Lightness 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_HSL_FILTER_H
#define DIGIKAM_HSL_FILTER_H
 
// Local includes
 
#include "digikam_export.h"
#include "dimgthreadedfilter.h"
#include "digikam_globals.h"
 
namespace Digikam
{
 
class DImg;
 
class DIGIKAM_EXPORT HSLContainer
{
 
public:
 
    explicit HSLContainer()
      : hue       (0.0),
        saturation(0.0),
        vibrance  (0.0),
        lightness (0.0)
    {
    };
 
    ~HSLContainer()
    {
    };
 
public:
 
    double hue;
    double saturation;
    double vibrance;
    double lightness;
};
 
// -----------------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT HSLFilter : public DImgThreadedFilter
{
    Q_OBJECT
 
public:
 
    explicit HSLFilter(QObject* const parent = nullptr);
    explicit HSLFilter(DImg* const orgImage, QObject* const parent = nullptr, const HSLContainer& settings = HSLContainer());
    ~HSLFilter()                                           override;
 
    static QString FilterIdentifier()
    {
        return QLatin1String("digikam:HSLFilter");
    }
 
    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 setHue(double val);
    void setSaturation(double val);
    void setLightness(double val);
    void applyHSL(DImg& image);
    int  vibranceBias(double sat, double hue, double vib, bool sixteenbit);
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_HSL_FILTER_H