icctransform.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2005-11-18
 * Description : a class to apply ICC color correction to image.
 *
 * Copyright (C) 2005-2006 by F.J. Cruz <fj dot cruz at supercable dot es>
 * Copyright (C) 2009      by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2005-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_ICC_TRANSFORM_H
#define DIGIKAM_ICC_TRANSFORM_H
 
// Qt includes
 
#include <QByteArray>
#include <QMetaType>
#include <QString>
 
// Local includes
 
#include "dimg.h"
#include "digikam_export.h"
 
class QImage;
 
namespace Digikam
{
 
class DImgLoaderObserver;
class TransformDescription;
 
class DIGIKAM_EXPORT IccTransform
{
public:
 
    enum RenderingIntent
    {
        Perceptual           = 0,
        RelativeColorimetric = 1,
        Saturation           = 2,
        AbsoluteColorimetric = 3
    };
 
public:
 
    explicit IccTransform();
    ~IccTransform();
 
    IccTransform(const IccTransform& other);
    IccTransform& operator=(const IccTransform& other);
 
    bool apply(DImg& image, DImgLoaderObserver* const observer = nullptr);
 
    bool apply(QImage& qimage);
 
    void close();
 
    void setEmbeddedProfile(const DImg& image);
    void setInputProfile(const IccProfile& profile);
 
    void setOutputProfile(const IccProfile& profile);
 
    void setProofProfile(const IccProfile& profile);
 
    void setDoNotEmbedOutputProfile(bool doNotEmbed);
 
    void setIntent(RenderingIntent intent);
    void setIntent(int intent)
    {
        setIntent((RenderingIntent)intent);
    }
 
    void setProofIntent(RenderingIntent intent);
    void setProofIntent(int intent)
    {
        setProofIntent((RenderingIntent)intent);
    }
 
    void setUseBlackPointCompensation(bool useBPC);
    void setCheckGamut(bool checkGamut);
    void setCheckGamutMaskColor(const QColor& color);
 
    IccProfile embeddedProfile()         const;
    IccProfile inputProfile()            const;
    IccProfile outputProfile()           const;
    IccProfile proofProfile()            const;
 
    RenderingIntent intent()             const;
    RenderingIntent proofIntent()        const;
    bool isUsingBlackPointCompensation() const;
    bool isCheckingGamut()               const;
    QColor checkGamutMaskColor()         const;
 
    bool willHaveEffect();
 
    IccProfile effectiveInputProfile()   const;
 
    static void init();
 
private:
 
    bool checkProfiles();
    TransformDescription getDescription(const DImg& image);
    TransformDescription getProofingDescription(const DImg& image);
    TransformDescription getDescription(const QImage& image);
    bool open(TransformDescription& description);
    bool openProofing(TransformDescription& description);
    void transform(DImg& img, const TransformDescription&,
                   DImgLoaderObserver* const observer = nullptr);
    void transform(QImage& img, const TransformDescription&);
 
public:
 
    class Private;
 
private:
 
    QSharedDataPointer<Private> d;
};
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::IccTransform)
 
#endif // DIGIKAM_ICC_TRANSFORM_H