loadingdescription.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2006-01-16
 * Description : image file IO threaded interface.
 *
 * Copyright (C) 2006-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2012-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_LOADING_DESCRIPTION_H
#define DIGIKAM_LOADING_DESCRIPTION_H
 
// Qt includes
 
#include <QFlags>
 
// Local includes
 
#include "dimg.h"
#include "digikam_export.h"
#include "previewsettings.h"
 
namespace Digikam
{
 
class IccTransform;
class ThumbnailIdentifier;
 
class DIGIKAM_EXPORT LoadingDescription
{
public:
 
    enum ColorManagementSettings
    {
        NoColorConversion,
        ApplyTransform,    
        ConvertForEditor,
        ConvertToSRGB,
        ConvertForDisplay, 
        ConvertForOutput   
    };
 
    enum RawDecodingHint
    {
        RawDecodingDefaultSettings,
        RawDecodingGlobalSettings,
        RawDecodingCustomSettings,
        RawDecodingTimeOptimized
    };
 
public:
 
    class PreviewParameters
    {
    public:
 
        enum PreviewType
        {
            NoPreview,
            PreviewImage,
            Thumbnail,
            DetailThumbnail
        };
 
        enum PreviewFlag
        {
            NoFlags         = 0,
            OnlyPregenerate = 1 << 0
        };
        Q_DECLARE_FLAGS(PreviewFlags, PreviewFlag)
 
    public:
 
        explicit PreviewParameters();
 
        bool onlyPregenerate()                          const;
 
        bool operator==(const PreviewParameters& other) const;
 
    public:
 
        PreviewType     type;
        int             size;
        PreviewFlags    flags;
        PreviewSettings previewSettings;
        QVariant        extraParameter;
        QVariant        storageReference;
    };
 
    // ---------------------------------------------------------------------
 
    class PostProcessingParameters
    {
    public:
 
        explicit PostProcessingParameters()
        {
            colorManagement = NoColorConversion;
        }
 
    public:
 
        bool needsProcessing()                                 const;
 
        void         setTransform(const IccTransform& transform);
        bool         hasTransform()                            const;
        IccTransform transform()                               const;
 
        void         setProfile(const IccProfile& profile);
        bool         hasProfile()                              const;
        IccProfile   profile()                                 const;
 
        bool operator==(const PostProcessingParameters& other) const;
 
    public:
 
        ColorManagementSettings colorManagement;
        QVariant                iccData;
    };
 
public:
 
    LoadingDescription();
 
    explicit LoadingDescription(const QString& filePath,
                                ColorManagementSettings = NoColorConversion);
 
    LoadingDescription(const QString& filePath,
                       const DRawDecoding& settings,
                       RawDecodingHint rawDecodingHint = RawDecodingCustomSettings,
                       ColorManagementSettings = NoColorConversion);
 
    LoadingDescription(const QString& filePath,
                       const PreviewSettings& settings,
                       int size,
                       ColorManagementSettings = NoColorConversion,
                       PreviewParameters::PreviewType = PreviewParameters::PreviewImage);
 
    QString             cacheKey()                                      const;
 
    bool                needCheckRawDecoding()                          const;
 
    QStringList         lookupCacheKeys()                               const;
 
    bool                isReducedVersion()                              const;
 
    bool                isThumbnail()                                   const;
 
    bool                isPreviewImage()                                const;
 
    ThumbnailIdentifier thumbnailIdentifier()                           const;
 
    bool operator==(const LoadingDescription& other)                    const;
    bool operator!=(const LoadingDescription& other)                    const;
 
    bool equalsIgnoreReducedVersion(const LoadingDescription& other)    const;
 
    bool equalsOrBetterThan(const LoadingDescription& other)            const;
 
public:
 
    static QStringList possibleCacheKeys(const QString& filePath);
    static QStringList possibleThumbnailCacheKeys(const QString& filePath);
 
public:
 
    QString                  filePath;
    DRawDecoding             rawDecodingSettings;
    RawDecodingHint          rawDecodingHint;
    PreviewParameters        previewParameters;
    PostProcessingParameters postProcessingParameters;
};
 
} // namespace Digikam
 
Q_DECLARE_OPERATORS_FOR_FLAGS(Digikam::LoadingDescription::PreviewParameters::PreviewFlags)
 
#endif // DIGIKAM_LOADING_DESCRIPTION_H