// ***************************************************************** -*- C++ -*- /* * Copyright (C) 2004-2009 Andreas Huggel * * 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. */ /*! @file iptc.hpp @brief Encoding and decoding of IPTC data @version $Rev$ @author Brad Schick (brad) brad@robotbattle.com @date 31-Jul-04, brad: created */ #ifndef IPTC_HPP_ #define IPTC_HPP_ // ***************************************************************************** // included header files #include "metadatum.hpp" #include "types.hpp" #include "error.hpp" #include "value.hpp" #include "datasets.hpp" // + standard includes #include #include // ***************************************************************************** // namespace extensions namespace Exiv2 { // ***************************************************************************** // class declarations class ExifData; // ***************************************************************************** // class definitions /*! @brief An IPTC metadatum ("dataset"), consisting of an IptcKey and a Value and methods to manipulate these. */ class EXIV2API Iptcdatum : public Metadatum { public: //! @name Creators //@{ /*! @brief Constructor for new tags created by an application. The %Iptcdatum is created from a key / value pair. %Iptcdatum copies (clones) the value if one is provided. Alternatively, a program can create an 'empty' %Iptcdatum with only a key and set the value using setValue(). @param key The key of the %Iptcdatum. @param pValue Pointer to a %Iptcdatum value. @throw Error if the key cannot be parsed and converted to a tag number and record id. */ explicit Iptcdatum(const IptcKey& key, const Value* pValue =0); //! Copy constructor Iptcdatum(const Iptcdatum& rhs); //! Destructor virtual ~Iptcdatum(); //@} //! @name Manipulators //@{ //! Assignment operator Iptcdatum& operator=(const Iptcdatum& rhs); /*! @brief Assign \em value to the %Iptcdatum. The type of the new Value is set to UShortValue. */ Iptcdatum& operator=(const uint16_t& value); /*! @brief Assign \em value to the %Iptcdatum. Calls setValue(const std::string&). */ Iptcdatum& operator=(const std::string& value); /*! @brief Assign \em value to the %Iptcdatum. Calls setValue(const Value*). */ Iptcdatum& operator=(const Value& value); void setValue(const Value* pValue); /*! @brief Set the value to the string \em value, using Value::read(const std::string&). If the %Iptcdatum does not have a Value yet, then a %Value of the correct type for this %Iptcdatum is created. If that fails (because of an unknown dataset), a StringValue is created. Return 0 if the value was read successfully. */ int setValue(const std::string& value); //@} //! @name Accessors //@{ long copy(byte* buf, ByteOrder byteOrder) const { return value_.get() == 0 ? 0 : value_->copy(buf, byteOrder); } std::ostream& write(std::ostream& os, const ExifData* pMetadata =0) const; /*! @brief Return the key of the Iptcdatum. The key is of the form 'Iptc.recordName.datasetName'. Note however that the key is not necessarily unique, i.e., an IptcData object may contain multiple metadata with the same key. */ std::string key() const { return key_.get() == 0 ? "" : key_->key(); } /*! @brief Return the name of the record (deprecated) @return record name */ std::string recordName() const { return key_.get() == 0 ? "" : key_->recordName(); } /*! @brief Return the record id @return record id */ uint16_t record() const { return key_.get() == 0 ? 0 : key_->record(); } const char* familyName() const { return key_.get() == 0 ? "" : key_->familyName(); } std::string groupName() const { return key_.get() == 0 ? "" : key_->groupName(); } /*! @brief Return the name of the tag (aka dataset) @return tag name */ std::string tagName() const { return key_.get() == 0 ? "" : key_->tagName(); } std::string tagLabel() const { return key_.get() == 0 ? "" : key_->tagLabel(); } //! Return the tag (aka dataset) number uint16_t tag() const { return key_.get() == 0 ? 0 : key_->tag(); } TypeId typeId() const { return value_.get() == 0 ? invalidTypeId : value_->typeId(); } const char* typeName() const { return TypeInfo::typeName(typeId()); } long typeSize() const { return TypeInfo::typeSize(typeId()); } long count() const { return value_.get() == 0 ? 0 : value_->count(); } long size() const { return value_.get() == 0 ? 0 : value_->size(); } std::string toString() const { return value_.get() == 0 ? "" : value_->toString(); } std::string toString(long n) const { return value_.get() == 0 ? "" : value_->toString(n); } long toLong(long n =0) const { return value_.get() == 0 ? -1 : value_->toLong(n); } float toFloat(long n =0) const { return value_.get() == 0 ? -1 : value_->toFloat(n); } Rational toRational(long n =0) const { return value_.get() == 0 ? Rational(-1, 1) : value_->toRational(n); } Value::AutoPtr getValue() const { return value_.get() == 0 ? Value::AutoPtr(0) : value_->clone(); } const Value& value() const; //@} private: // DATA IptcKey::AutoPtr key_; //!< Key Value::AutoPtr value_; //!< Value }; // class Iptcdatum //! Container type to hold all metadata typedef std::vector IptcMetadata; //! Unary predicate that matches an Iptcdatum with given record and dataset class EXIV2API FindMetadatumById { public: //! Constructor, initializes the object with the record and dataset id FindMetadatumById(uint16_t dataset, uint16_t record) : dataset_(dataset), record_(record) {} /*! @brief Returns true if the record and dataset id of the argument Iptcdatum is equal to that of the object. */ bool operator()(const Iptcdatum& iptcdatum) const { return dataset_ == iptcdatum.tag() && record_ == iptcdatum.record(); } private: // DATA uint16_t dataset_; uint16_t record_; }; // class FindMetadatumById /*! @brief A container for IPTC data. This is a top-level class of the %Exiv2 library. Provide high-level access to the IPTC data of an image: - read IPTC information from JPEG files - access metadata through keys and standard C++ iterators - add, modify and delete metadata - write IPTC data to JPEG files - extract IPTC metadata to files, insert from these files */ class EXIV2API IptcData { public: //! IptcMetadata iterator type typedef IptcMetadata::iterator iterator; //! IptcMetadata const iterator type typedef IptcMetadata::const_iterator const_iterator; // Use the compiler generated constructors and assignment operator //! @name Manipulators //@{ /*! @brief Returns a reference to the %Iptcdatum that is associated with a particular \em key. If %IptcData does not already contain such an %Iptcdatum, operator[] adds object \em Iptcdatum(key). @note Since operator[] might insert a new element, it can't be a const member function. */ Iptcdatum& operator[](const std::string& key); /*! @brief Add an %Iptcdatum from the supplied key and value pair. This method copies (clones) the value. A check for non-repeatable datasets is performed. @return 0 if successful;
6 if the dataset already exists and is not repeatable */ int add(const IptcKey& key, Value* value); /*! @brief Add a copy of the Iptcdatum to the IPTC metadata. A check for non-repeatable datasets is performed. @return 0 if successful;
6 if the dataset already exists and is not repeatable;
*/ int add(const Iptcdatum& iptcdatum); /*! @brief Delete the Iptcdatum at iterator position pos, return the position of the next Iptcdatum. Note that iterators into the metadata, including pos, are potentially invalidated by this call. */ iterator erase(iterator pos); /*! @brief Delete all Iptcdatum instances resulting in an empty container. */ void clear() { iptcMetadata_.clear(); } //! Sort metadata by key void sortByKey(); //! Sort metadata by tag (aka dataset) void sortByTag(); //! Begin of the metadata iterator begin() { return iptcMetadata_.begin(); } //! End of the metadata iterator end() { return iptcMetadata_.end(); } /*! @brief Find the first Iptcdatum with the given key, return an iterator to it. */ iterator findKey(const IptcKey& key); /*! @brief Find the first Iptcdatum with the given record and dataset it, return a const iterator to it. */ iterator findId(uint16_t dataset, uint16_t record = IptcDataSets::application2); //@} //! @name Accessors //@{ //! Begin of the metadata const_iterator begin() const { return iptcMetadata_.begin(); } //! End of the metadata const_iterator end() const { return iptcMetadata_.end(); } /*! @brief Find the first Iptcdatum with the given key, return a const iterator to it. */ const_iterator findKey(const IptcKey& key) const; /*! @brief Find the first Iptcdatum with the given record and dataset number, return a const iterator to it. */ const_iterator findId(uint16_t dataset, uint16_t record = IptcDataSets::application2) const; //! Return true if there is no IPTC metadata bool empty() const { return count() == 0; } //! Get the number of metadata entries long count() const { return static_cast(iptcMetadata_.size()); } /*! @brief Return the exact size of all contained IPTC metadata */ long size() const; //@} private: // DATA IptcMetadata iptcMetadata_; }; // class IptcData /*! @brief Stateless parser class for IPTC data. Images use this class to decode and encode binary IPTC data. */ class EXIV2API IptcParser { public: /*! @brief Decode binary IPTC data in IPTC IIM4 format from a buffer \em pData of length \em size to the provided metadata container. @param iptcData Metadata container to add the decoded IPTC datasets to. @param pData Pointer to the data buffer to read from. @param size Number of bytes in the data buffer. @return 0 if successful;
5 if the binary IPTC data is invalid or corrupt */ static int decode( IptcData& iptcData, const byte* pData, uint32_t size ); /*! @brief Encode the IPTC datasets from \em iptcData to a binary representation in IPTC IIM4 format. Convert the IPTC datasets to binary format and return it. Caller owns the returned buffer. The copied data follows the IPTC IIM4 standard. @return Data buffer containing the binary IPTC data in IPTC IIM4 format. */ static DataBuf encode( const IptcData& iptcData ); private: // Constant data static const byte marker_; // Dataset marker }; // class IptcParser } // namespace Exiv2 #endif // #ifndef IPTC_HPP_