imagecurves.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2004-12-01
 * Description : image curves manipulation methods.
 *
 * Copyright (C) 2004-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_IMAGE_CURVES_H
#define DIGIKAM_IMAGE_CURVES_H
 
// Qt includes
 
#include <QSharedDataPointer>
#include <QPoint>
#include <QPolygon>
#include <QUrl>
 
// Local includes
 
#include "digikam_globals.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class CurvesContainer;
 
class DIGIKAM_EXPORT ImageCurves
{
 
public:
 
    const static int NUM_POINTS       = 17;
 
    const static int NUM_CHANNELS     = 5;
 
    const static int MULTIPLIER_16BIT = 255;
 
    enum CurveType
    {
        CURVE_SMOOTH = 0,            
        CURVE_FREE                   
    };
 
    typedef double CRMatrix[4][4];
 
public:
 
    explicit ImageCurves(bool sixteenBit);
    explicit ImageCurves(const CurvesContainer& container);
    ImageCurves(const ImageCurves& other);
    ~ImageCurves();
 
    ImageCurves& operator=(const ImageCurves& other);
 
    void fillFromOtherCurves(ImageCurves* const otherCurves);
 
 
 
    void   curvesReset();
    void   curvesChannelReset(int channel);
    void   curvesCalculateCurve(int channel);
    void   curvesCalculateAllCurves();
    float  curvesLutFunc(int n_channels, int channel, float value);
    void   curvesLutSetup(int nchannels);
    void   curvesLutProcess(uchar* const srcPR, uchar* const destPR, int w, int h);
 
 
    void   setCurveValue(int channel, int bin, int val);
    void   setCurvePointX(int channel, int point, int x);
    void   setCurvePointY(int channel, int point, int y);
    void   setCurveType(int channel, CurveType type);
    void   setCurveType(CurveType type);
 
    void   setCurvePoint(int channel, int point, const QPoint& val);
    void   setCurvePoints(int channel, const QPolygon& vals);
    void   setCurveValues(int channel, const QPolygon& vals);
 
    void   unsetCurvePoint(int channel, int point);
 
 
    bool   isDirty()                                     const;
    bool   isSixteenBits()                               const;
 
    int       getCurveValue(int channel, int bin)        const;
    int       getCurvePointX(int channel, int point)     const;
    int       getCurvePointY(int channel, int point)     const;
    CurveType getCurveType(int channel)                  const;
 
    bool     isCurvePointEnabled(int channel, int point) const;
    QPoint   getCurvePoint(int channel, int point)       const;
    QPolygon getCurvePoints(int channel)                 const;
    QPolygon getCurveValues(int channel)                 const;
 
    void   setContainer(const CurvesContainer& container);
 
    CurvesContainer getContainer()                       const;
 
    CurvesContainer getContainer(int channel)            const;
 
    bool isLinear(int channel)                           const;
    bool isLinear()                                      const;
 
    QByteArray channelToBinary(int channel)              const;
 
    bool setChannelFromBinary(int channel, const QByteArray& array);
 
 
    bool saveCurvesToGimpCurvesFile(const QUrl& fileUrl) const;
    bool loadCurvesFromGimpCurvesFile(const QUrl& fileUrl);
 
    static QPoint getDisabledValue();
 
private:
 
    void curvesPlotCurve(int channel, int p1, int p2, int p3, int p4);
    void curvesCRCompose(CRMatrix a, CRMatrix b, CRMatrix ab);
    void freeLutData();
 
private:
 
    class Private;
    QSharedDataPointer<Private> d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_IMAGE_CURVES_H