iptc.hpp

Go to the documentation of this file.

// ***************************************************************** -*- 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 IPTC_HPP_
#define IPTC_HPP_
 
// *****************************************************************************
#include "exiv2lib_export.h"
 
// included header files
#include "metadatum.hpp"
#include "datasets.hpp"
 
// *****************************************************************************
// namespace extensions
namespace Exiv2 {
 
// *****************************************************************************
// class declarations
    class ExifData;
 
// *****************************************************************************
// class definitions
 
    class EXIV2API Iptcdatum : public Metadatum {
    public:
 
 
        explicit Iptcdatum(const IptcKey& key,
                           const Value* pValue =0);
        Iptcdatum(const Iptcdatum& rhs);
        virtual ~Iptcdatum();
 
 
 
        Iptcdatum& operator=(const Iptcdatum& rhs);
        Iptcdatum& operator=(const uint16_t& value);
        Iptcdatum& operator=(const std::string& value);
        Iptcdatum& 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;
        std::string recordName() const;
        uint16_t record() 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;
        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:
        // DATA
        IptcKey::AutoPtr key_;                  
        Value::AutoPtr   value_;                
 
    }; // class Iptcdatum
 
    typedef std::vector<Iptcdatum> IptcMetadata;
 
    class EXIV2API IptcData {
    public:
        typedef IptcMetadata::iterator iterator;
        typedef IptcMetadata::const_iterator const_iterator;
 
        // Use the compiler generated constructors and assignment operator
 
 
 
        Iptcdatum& operator[](const std::string& key);
        int add(const IptcKey& key, Value* value);
        int add(const Iptcdatum& iptcdatum);
        iterator erase(iterator pos);
        void clear() { iptcMetadata_.clear(); }
        void sortByKey();
        void sortByTag();
        iterator begin() { return iptcMetadata_.begin(); }
        iterator end() { return iptcMetadata_.end(); }
        iterator findKey(const IptcKey& key);
        iterator findId(uint16_t dataset,
                        uint16_t record = IptcDataSets::application2);
 
 
 
        const_iterator begin() const { return iptcMetadata_.begin(); }
        const_iterator end() const { return iptcMetadata_.end(); }
        const_iterator findKey(const IptcKey& key) const;
        const_iterator findId(uint16_t dataset,
                              uint16_t record = IptcDataSets::application2) const;
        bool empty() const { return count() == 0; }
        long count() const { return static_cast<long>(iptcMetadata_.size()); }
        long size() const;
        const char *detectCharset() const;
        static void printStructure(std::ostream& out, const Slice<byte*>& bytes,uint32_t depth);
 
    private:
        // DATA
        IptcMetadata iptcMetadata_;
    }; // class IptcData
 
    class EXIV2API IptcParser {
    public:
        static int decode(
                  IptcData& iptcData,
            const byte*     pData,
                  uint32_t  size
        );
        static DataBuf encode(
            const IptcData& iptcData
        );
 
    private:
        // Constant data
        static const byte marker_;      // Dataset marker
 
    }; // class IptcParser
 
}                                       // namespace Exiv2
 
#endif                                  // #ifndef IPTC_HPP_