xmp_exiv2.hpp

// ***************************************************************** -*- C++ -*-
/*
 * Copyright (C) 2004-2021 Exiv2 authors
 * This program is part of the Exiv2 distribution.
 *
 * 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
 * of the License, 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.
 */
#ifndef XMP_HPP_
#define XMP_HPP_
 
// *****************************************************************************
#include "exiv2lib_export.h"
 
// included header files
#include "metadatum.hpp"
#include "properties.hpp"
 
// *****************************************************************************
// namespace extensions
namespace Exiv2 {
 
// *****************************************************************************
// class declarations
    class ExifData;
 
// *****************************************************************************
// class definitions

    class EXIV2API Xmpdatum : public Metadatum {
    public:


        explicit Xmpdatum(const XmpKey& key,
                          const Value* pValue =0);
        Xmpdatum(const Xmpdatum& rhs);
        virtual ~Xmpdatum();



        Xmpdatum& operator=(const Xmpdatum& rhs);
        Xmpdatum& operator=(const std::string& value);
        Xmpdatum& operator=(const char* value);
        Xmpdatum& operator=(const bool& value);
        template<typename T>
        Xmpdatum& operator=(const T& value);
        Xmpdatum& operator=(const Value& value);
        void setValue(const Value* pValue);
        int setValue(const std::string& value);



        long copy(byte* buf, ByteOrder byteOrder) const;
        std::ostream& write(std::ostream& os, const ExifData* pMetadata =0) const;
        std::string key() const;
        const char* familyName() const;
        std::string groupName() const;
        std::string tagName() const;
        std::string tagLabel() const;
        uint16_t tag() const;
        TypeId typeId() const;
        const char* typeName() const;
        // Todo: Remove this method from the baseclass
        long typeSize() const;
        long count() const;
        long size() const;
        std::string toString() const;
        std::string toString(long n) const;
        long toLong(long n =0) const;
        float toFloat(long n =0) const;
        Rational toRational(long n =0) const;
        Value::AutoPtr getValue() const;
        const Value& value() const;
 
    private:
        // Pimpl idiom
        struct Impl;
        std::auto_ptr<Impl> p_;
 
    }; // class Xmpdatum

    typedef std::vector<Xmpdatum> XmpMetadata;

    class EXIV2API XmpData {
    public:
        XmpData() : xmpMetadata_(), xmpPacket_(), usePacket_(0) {}

        typedef XmpMetadata::iterator iterator;
        typedef XmpMetadata::const_iterator const_iterator;



        Xmpdatum& operator[](const std::string& key);
        int add(const XmpKey& key, const Value* value);
        int add(const Xmpdatum& xmpdatum);
        /*
        @brief Delete the Xmpdatum at iterator position pos, return the
                position of the next Xmpdatum.
 
        @note  Iterators into the metadata, including pos, are potentially
                invalidated by this call.
        @brief Delete the Xmpdatum at iterator position pos and update pos
        */
        iterator erase(XmpData::iterator pos);
        void eraseFamily(XmpData::iterator& pos);
        void clear();
        void sortByKey();
        iterator begin();
        iterator end();
        iterator findKey(const XmpKey& key);



        const_iterator begin() const;
        const_iterator end() const;
        const_iterator findKey(const XmpKey& key) const;
        bool empty() const;
        long count() const;

        bool usePacket() const { return usePacket_; } ;

        bool usePacket(bool b) { bool r = usePacket_; usePacket_=b ; return r; };
        void setPacket(const std::string& xmpPacket) { xmpPacket_ = xmpPacket ; usePacket(false); };
        // ! getPacket
        const std::string& xmpPacket() const { return xmpPacket_ ; };

 
    private:
        // DATA
        XmpMetadata xmpMetadata_;
        std::string xmpPacket_  ;
        bool        usePacket_  ;
    }; // class XmpData

    class EXIV2API XmpParser {
    public:
        enum XmpFormatFlags {
            omitPacketWrapper   = 0x0010UL,  
            readOnlyPacket      = 0x0020UL,  
            useCompactFormat    = 0x0040UL,  
            includeThumbnailPad = 0x0100UL,  
            exactPacketLength   = 0x0200UL,  
            writeAliasComments  = 0x0400UL,  
            omitAllFormatting   = 0x0800UL   
        };

        static int decode(      XmpData&     xmpData,
                          const std::string& xmpPacket);
        static int encode(      std::string& xmpPacket,
                          const XmpData&     xmpData,
                                uint16_t     formatFlags =useCompactFormat,
                                uint32_t     padding =0);
        typedef void (*XmpLockFct)(void* pLockData, bool lockUnlock);

        static bool initialize(XmpParser::XmpLockFct xmpLockFct =0, void* pLockData =0);
        static void terminate();
 
    private:
        static void registerNs(const std::string& ns,
                               const std::string& prefix);
        static void unregisterNs(const std::string& ns);

        static void registeredNamespaces(Exiv2::Dictionary&);
 
        // DATA
        static bool initialized_; 
        static XmpLockFct xmpLockFct_;
        static void* pLockData_;
 
    friend class XmpProperties; // permit XmpProperties -> registerNs() and registeredNamespaces()
 
    }; // class XmpParser
 
// *****************************************************************************
// free functions, template and inline definitions
 
    inline Xmpdatum& Xmpdatum::operator=(const char* value)
    {
        return Xmpdatum::operator=(std::string(value));
    }
 
    inline Xmpdatum& Xmpdatum::operator=(const bool& value)
    {
        return operator=(value ? "True" : "False");
    }
 
    template<typename T>
    Xmpdatum& Xmpdatum::operator=(const T& value)
    {
        setValue(Exiv2::toString(value));
        return *this;
    }
 
}                                       // namespace Exiv2
 
#endif                                  // #ifndef XMP_HPP_