dmetadata.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2006-02-23
 * Description : item metadata interface
 *
 * Copyright (C) 2006-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2006-2013 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2013      by Veaceslav Munteanu <veaceslav dot munteanu90 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_DMETA_DATA_H
#define DIGIKAM_DMETA_DATA_H
 
// Qt includes
 
#include <QByteArray>
#include <QUrl>
 
// Local includes
 
#include "metaengine.h"
#include "metaengine_data.h"
#include "metaenginesettingscontainer.h"
#include "metadatainfo.h"
#include "captionvalues.h"
#include "photoinfocontainer.h"
#include "videoinfocontainer.h"
#include "digikam_export.h"
#include "dmetadatasettings.h"
 
namespace Digikam
{
 
class Template;
class IccProfile;
 
// TODO: merge with MetaEngine class.
 
class DIGIKAM_EXPORT DMetadata : public MetaEngine
{
 
public:
 
    enum VIDEOCOLORMODEL
    {
        VIDEOCOLORMODEL_UNKNOWN = 1000,
        VIDEOCOLORMODEL_OTHER,
        VIDEOCOLORMODEL_SRGB,
        VIDEOCOLORMODEL_BT709,
        VIDEOCOLORMODEL_BT601
    };
 
public:
 
    typedef QMap<QString, QString> CountryCodeMap;
 
public:
 
    DMetadata();
    explicit DMetadata(const QString& filePath);
    explicit DMetadata(const MetaEngineData& data);
    ~DMetadata();
 
public: // Settings helpers
 
    void registerMetadataSettings();
    void setSettings(const MetaEngineSettingsContainer& settings);
 
public: // File I/O helpers
 
    bool load(const QString& filePath, Backend* backend = nullptr);
    bool save(const QString& filePath, bool setVersion = false)                                                         const;
    bool applyChanges(bool setVersion = false)                                                                          const;
 
    bool loadUsingRawEngine(const QString& filePath);
 
public: // History helpers
 
    QString getItemHistory()                                                                                            const;
    bool    setItemHistory(const QString& imageHistoryXml)                                                              const;
    bool    hasItemHistoryTag()                                                                                         const;
 
    QString getItemUniqueId()                                                                                           const;
    bool    setItemUniqueId(const QString& uuid)                                                                        const;
 
public: // Faces helpers
 
    bool getItemFacesMap(QMultiMap<QString, QVariant>& facesPath)                                                       const;
 
    bool setItemFacesMap(const QMultiMap<QString, QVariant>& facesPath, bool write, const QSize& size = QSize())       const;
 
    bool removeItemFacesMap()                                                                                           const;
 
public: // Tags helpers
 
    bool getItemTagsPath(QStringList& tagsPath,
                         const DMetadataSettingsContainer& settings = DMetadataSettings::instance()->settings())        const;
    bool setItemTagsPath(const QStringList& tagsPath,
                         const DMetadataSettingsContainer& settings = DMetadataSettings::instance()->settings())        const;
 
    bool getACDSeeTagsPath(QStringList& tagsPath)                                                                       const;
 
    bool setACDSeeTagsPath(const QStringList& tagsPath)                                                                 const;
 
public: // Comments helpers
 
    CaptionsMap getItemComments(const DMetadataSettingsContainer& settings = DMetadataSettings::instance()->settings()) const;
    bool setItemComments(const CaptionsMap& comments,
                         const DMetadataSettingsContainer& settings = DMetadataSettings::instance()->settings())        const;
 
    CaptionsMap getItemTitles(const DMetadataSettingsContainer& settings = DMetadataSettings::instance()->settings())   const;
    bool setItemTitles(const CaptionsMap& title,
                       const DMetadataSettingsContainer& settings = DMetadataSettings::instance()->settings())          const;
 
    static MetaEngine::AltLangMap toAltLangMap(const QVariant& var);
 
public: // Labels helpers
 
    int  getItemRating(const DMetadataSettingsContainer& settings = DMetadataSettings::instance()->settings())          const;
    bool setItemRating(int rating,
                       const DMetadataSettingsContainer& settings = DMetadataSettings::instance()->settings())          const;
 
    int  getItemPickLabel()                                                                                             const;
    bool setItemPickLabel(int pickId)                                                                                   const;
 
    int  getItemColorLabel(const DMetadataSettingsContainer& settings = DMetadataSettings::instance()->settings())      const;
    bool setItemColorLabel(int colorId,
                           const DMetadataSettingsContainer& settings = DMetadataSettings::instance()->settings())      const;
 
public: // Template helpers
 
    bool     setMetadataTemplate(const Template& t)                                                                     const;
    Template getMetadataTemplate()                                                                                      const;
    bool     removeMetadataTemplate()                                                                                   const;
 
    bool getCopyrightInformation(Template& t)                                                                           const;
 
public: // EXIF helpers
 
    IccProfile getIccProfile()                                                                                          const;
 
    bool setIccProfile(const IccProfile& profile);
 
    bool removeExifColorSpace()                                                                                         const;
 
    int  getMSecsInfo()                                                                                                 const;
 
    bool mSecTimeStamp(const char* const exifTagName, int& ms)                                                          const;
 
    bool removeExifTags(const QStringList& tagFilters);
 
private:
 
    QString getExifTagStringFromTagsList(const QStringList& tagsList)                                                   const;
 
public: // IPTC helpers
 
    IptcCoreContactInfo getCreatorContactInfo()                                                                         const;
    bool setCreatorContactInfo(const IptcCoreContactInfo& info)                                                         const;
 
    IptcCoreLocationInfo getIptcCoreLocation()                                                                          const;
    bool setIptcCoreLocation(const IptcCoreLocationInfo& location)                                                      const;
 
    QStringList getIptcCoreSubjects()                                                                                   const;
 
    bool removeIptcTags(const QStringList& tagFilters);
 
    static CountryCodeMap countryCodeMap();
 
private:
 
    bool setIptcTag(const QString& text,
                    int maxLength,
                    const char* const debugLabel,
                    const char* const tagKey)                                                                           const;
 
    QVariant fromIptcEmulateList(const char* const iptcTagName)                                                         const;
    QVariant fromIptcEmulateLangAlt(const char* const iptcTagName)                                                      const;
 
public: // XMP helpers
 
    bool addToXmpTagStringBag(const char* const xmpTagName, const QStringList& entriesToAdd)                            const;
 
    bool removeFromXmpTagStringBag(const char* const xmpTagName, const QStringList& entriesToRemove)                    const;
 
    QStringList getXmpKeywords()                                                                                        const;
 
    bool setXmpKeywords(const QStringList& newKeywords)                                                                 const;
 
    bool removeXmpKeywords(const QStringList& keywordsToRemove);
 
    QStringList getXmpSubjects()                                                                                        const;
 
    bool setXmpSubjects(const QStringList& newSubjects)                                                                 const;
 
    bool removeXmpSubjects(const QStringList& subjectsToRemove);
 
    QStringList getXmpSubCategories()                                                                                   const;
 
    bool setXmpSubCategories(const QStringList& newSubCategories)                                                       const;
 
    bool removeXmpSubCategories(const QStringList& categoriesToRemove);
 
    bool removeXmpTags(const QStringList& tagFilters);
 
private:
 
    QVariant fromXmpList(const char* const xmpTagName)                                                                  const;
    QVariant fromXmpLangAlt(const char* const xmpTagName)                                                               const;
 
public: // Video helpers
 
    bool loadUsingFFmpeg(const QString& filePath);
 
    VideoInfoContainer getVideoInformation()                                                                            const;
 
    static QString videoColorModelToString(VIDEOCOLORMODEL videoColorModel);
 
public: // Photo helpers
 
    QString getLensDescription()                                                                                        const;
 
    QString getCameraSerialNumber()                                                                                     const;
 
    PhotoInfoContainer getPhotographInformation()                                                                       const;
 
    static double apexApertureToFNumber(double aperture);
    static double apexShutterSpeedToExposureTime(double shutterSpeed);
 
public: // Generic helpers
 
    QVariant     getMetadataField(MetadataInfo::Field field)                                                            const;
    QVariantList getMetadataFields(const MetadataFields& fields)                                                        const;
 
    static QString     valueToString (const QVariant& value, MetadataInfo::Field field);
    static QStringList valuesToString(const QVariantList& list, const MetadataFields& fields);
 
    static QMap<int, QString> possibleValuesForEnumField(MetadataInfo::Field field);
 
private:
 
    QVariant fromExifOrXmp(const char* const exifTagName, const char* const xmpTagName)                                 const;
    QVariant fromIptcOrXmp(const char* const iptcTagName, const char* const xmpTagName)                                 const;
    QVariant fromExifOrXmpList(const QStringList& tagList)                                                              const;
    bool hasValidField(const QVariantList& list)                                                                        const;
    QVariant toStringListVariant(const QStringList& list)                                                               const;
 
private:
 
    bool loadUsingLibheif(const QString& filePath);
 
private:
 
    bool loadUsingImageMagick(const QString& filePath);
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DMETA_DATA_H