11#include "exiv2lib_export.h"
14#include "datasets.hpp"
15#include "metadatum.hpp"
90 std::ostream&
write(std::ostream& os,
const ExifData* pMetadata =
nullptr)
const override;
97 [[nodiscard]] std::string
key()
const override;
107 [[nodiscard]] uint16_t
record()
const;
108 [[nodiscard]]
const char*
familyName()
const override;
109 [[nodiscard]] std::string
groupName()
const override;
114 [[nodiscard]] std::string
tagName()
const override;
115 [[nodiscard]] std::string
tagLabel()
const override;
116 [[nodiscard]] std::string
tagDesc()
const override;
118 [[nodiscard]] uint16_t
tag()
const override;
120 [[nodiscard]]
const char*
typeName()
const override;
121 [[nodiscard]]
size_t typeSize()
const override;
122 [[nodiscard]]
size_t count()
const override;
123 [[nodiscard]]
size_t size()
const override;
124 [[nodiscard]] std::string
toString()
const override;
125 [[nodiscard]] std::string
toString(
size_t n)
const override;
126 [[nodiscard]] int64_t
toInt64(
size_t n = 0)
const override;
127 [[nodiscard]]
float toFloat(
size_t n = 0)
const override;
130 [[nodiscard]]
const Value&
value()
const override;
199 iptcMetadata_.clear();
207 return iptcMetadata_.begin();
211 return iptcMetadata_.end();
217 iterator findKey(
const IptcKey& key);
222 iterator findId(uint16_t dataset, uint16_t record = IptcDataSets::application2);
229 return iptcMetadata_.begin();
233 return iptcMetadata_.end();
239 [[nodiscard]] const_iterator findKey(
const IptcKey& key)
const;
244 [[nodiscard]] const_iterator findId(uint16_t dataset, uint16_t record = IptcDataSets::application2)
const;
247 return iptcMetadata_.empty();
251 [[nodiscard]]
size_t count()
const {
252 return iptcMetadata_.size();
256 [[nodiscard]]
size_t size()
const;
259 [[nodiscard]]
const char* detectCharset()
const;
262 static void printStructure(std::ostream& out,
const Slice<byte*>& bytes,
size_t depth);
287 static int decode(
IptcData& iptcData,
const byte* pData,
size_t size);
301 static constexpr byte marker_ = 0x1C;
A container for Exif data. This is a top-level class of the Exiv2 library. The container holds Exifda...
Definition exif.hpp:379
A container for IPTC data. This is a top-level class of the Exiv2 library.
Definition iptc.hpp:153
iterator begin()
Begin of the metadata.
Definition iptc.hpp:206
const_iterator begin() const
Begin of the metadata.
Definition iptc.hpp:228
bool empty() const
Return true if there is no IPTC metadata.
Definition iptc.hpp:246
iterator erase(iterator pos)
Delete the Iptcdatum at iterator position pos, return the position of the next Iptcdatum....
Definition iptc.cpp:274
const_iterator end() const
End of the metadata.
Definition iptc.hpp:232
iterator end()
End of the metadata.
Definition iptc.hpp:210
int add(const IptcKey &key, const Value *value)
Add an Iptcdatum from the supplied key and value pair. This method copies (clones) the value....
Definition iptc.cpp:234
IptcMetadata::const_iterator const_iterator
IptcMetadata const iterator type.
Definition iptc.hpp:158
IptcMetadata::iterator iterator
IptcMetadata iterator type.
Definition iptc.hpp:156
size_t count() const
Get the number of metadata entries.
Definition iptc.hpp:251
Iptcdatum & operator[](const std::string &key)
Returns a reference to the Iptcdatum that is associated with a particular key. If IptcData does not a...
Definition iptc.cpp:209
void clear()
Delete all Iptcdatum instances resulting in an empty container.
Definition iptc.hpp:198
Concrete keys for IPTC metadata.
Definition datasets.hpp:237
std::unique_ptr< IptcKey > UniquePtr
Shortcut for an IptcKey auto pointer.
Definition datasets.hpp:240
Stateless parser class for IPTC data. Images use this class to decode and encode binary IPTC data.
Definition iptc.hpp:274
static int decode(IptcData &iptcData, const byte *pData, size_t size)
Decode binary IPTC data in IPTC IIM4 format from a buffer pData of length size to the provided metada...
Definition iptc.cpp:363
static DataBuf encode(const IptcData &iptcData)
Encode the IPTC datasets from iptcData to a binary representation in IPTC IIM4 format.
Definition iptc.cpp:422
An IPTC metadatum ("dataset"), consisting of an IptcKey and a Value and methods to manipulate these.
Definition iptc.hpp:33
const char * familyName() const override
Return the name of the metadata family (which is also the first part of the key)
Definition iptc.cpp:88
std::string recordName() const
Return the name of the record (deprecated)
Definition iptc.cpp:80
std::string toString() const override
Return the value as a string.
Definition iptc.cpp:132
~Iptcdatum() override=default
Destructor.
void setValue(const Value *pValue) override
Set the value. This method copies (clones) the value pointed to by pValue.
Definition iptc.cpp:195
Value::UniquePtr getValue() const override
Return an auto-pointer to a copy (clone) of the value. The caller owns this copy and the auto-poiner ...
Definition iptc.cpp:152
std::string key() const override
Return the key of the Iptcdatum. The key is of the form 'Iptc.recordName.datasetName'....
Definition iptc.cpp:76
uint16_t record() const
Return the record id.
Definition iptc.cpp:84
std::string tagName() const override
Return the name of the tag (aka dataset)
Definition iptc.cpp:96
size_t copy(byte *buf, ByteOrder byteOrder) const override
Write value to a data buffer and return the number of bytes written.
Definition iptc.cpp:68
size_t typeSize() const override
Return the size in bytes of one component of this type.
Definition iptc.cpp:120
Iptcdatum & operator=(const Iptcdatum &rhs)
Assignment operator.
Definition iptc.cpp:162
std::string tagDesc() const override
Return a description for the tag.
Definition iptc.cpp:104
uint16_t tag() const override
Return the tag (aka dataset) number.
Definition iptc.cpp:108
int64_t toInt64(size_t n=0) const override
Return the n-th component of the value converted to int64_t. The return value is -1 if the value is n...
Definition iptc.cpp:140
float toFloat(size_t n=0) const override
Return the n-th component of the value converted to float. The return value is -1 if the value is not...
Definition iptc.cpp:144
std::string tagLabel() const override
Return a label for the tag.
Definition iptc.cpp:100
const Value & value() const override
Return a constant reference to the value.
Definition iptc.cpp:156
Rational toRational(size_t n=0) const override
Return the n-th component of the value converted to Rational. The return value is -1/1 if the value i...
Definition iptc.cpp:148
std::string groupName() const override
Return the name of the metadata group (which is also the second part of the key)
Definition iptc.cpp:92
const char * typeName() const override
Return the name of the type.
Definition iptc.cpp:116
TypeId typeId() const override
Return the type id of the value.
Definition iptc.cpp:112
std::ostream & write(std::ostream &os, const ExifData *pMetadata=nullptr) const override
Write the interpreted value to an output stream, return the stream.
Definition iptc.cpp:72
size_t size() const override
Return the size of the value in bytes.
Definition iptc.cpp:128
size_t count() const override
Return the number of components in the value.
Definition iptc.cpp:124
Iptcdatum(const IptcKey &key, const Value *pValue=nullptr)
Constructor for new tags created by an application. The Iptcdatum is created from a key / value pair....
Definition iptc.cpp:56
Common interface for all types of values used with metadata.
Definition value.hpp:33
std::unique_ptr< Value > UniquePtr
Shortcut for a Value auto pointer.
Definition value.hpp:36
Class CrwImage to access Canon CRW images. References: The Canon RAW (CRW) File Format by Phil Harv...
Definition asfvideo.hpp:15
std::vector< Iptcdatum > IptcMetadata
Container type to hold all metadata.
Definition iptc.hpp:141
TypeId
Exiv2 value type identifiers.
Definition types.hpp:70
std::pair< int32_t, int32_t > Rational
8 byte signed rational type.
Definition types.hpp:31
ByteOrder
Type to express the byte order (little or big endian)
Definition types.hpp:34
Utility class containing a character array. All it does is to take care of memory allocation and dele...
Definition types.hpp:124
Slice (= view) for STL containers.
Definition slice.hpp:421