Exiv2
xmpsidecar.hpp
1 // ***************************************************************** -*- C++ -*-
2 /*
3  * Copyright (C) 2004-2021 Exiv2 authors
4  * This program is part of the Exiv2 distribution.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.
19  */
20 #ifndef XMPSIDECAR_HPP_
21 #define XMPSIDECAR_HPP_
22 
23 // *****************************************************************************
24 #include "exiv2lib_export.h"
25 
26 // included header files
27 #include "image.hpp"
28 
29 // *****************************************************************************
30 // namespace extensions
31 namespace Exiv2 {
32 
33 // *****************************************************************************
34 // class definitions
35 
36  // Add XMP to the supported image formats
37  namespace ImageType {
38  const int xmp = 10;
39  }
40 
44  class EXIV2API XmpSidecar : public Image {
45  public:
47 
48 
61  XmpSidecar(BasicIo::AutoPtr io, bool create);
63 
65 
66  void readMetadata();
67  void writeMetadata();
72  void setComment(const std::string& comment);
74 
76 
77  std::string mimeType() const;
79 
80  private:
82 
83  XmpSidecar(const XmpSidecar& rhs);
86  XmpSidecar& operator=(const XmpSidecar& rhs);
88 
89  Exiv2::Dictionary dates_;
90 
91  }; // class XmpSidecar
92 
93 // *****************************************************************************
94 // template, inline and free functions
95 
96  // These could be static private functions on Image subclasses but then
97  // ImageFactory needs to be made a friend.
103  EXIV2API Image::AutoPtr newXmpInstance(BasicIo::AutoPtr io, bool create);
104 
106  EXIV2API bool isXmpType(BasicIo& iIo, bool advance);
107 
108 } // namespace Exiv2
109 
110 #endif // #ifndef XMPSIDECAR_HPP_
Exiv2::MemIo
Provides binary IO on blocks of memory by implementing the BasicIo interface. A copy-on-write impleme...
Definition: basicio.hpp:540
Exiv2::XmpSidecar::XmpSidecar
XmpSidecar(BasicIo::AutoPtr io, bool create)
Constructor for an XMP sidecar file. Since the constructor can not return a result,...
Definition: xmpsidecar.cpp:48
Exiv2::ImageType::xmp
const int xmp
XMP sidecar files (see class XmpSidecar)
Definition: xmpsidecar.hpp:38
Exiv2::isXmpType
EXIV2API bool isXmpType(BasicIo &iIo, bool advance)
Check if the file iIo is an XMP sidecar file.
Definition: xmpsidecar.cpp:203
Exiv2::Image::xmpPacket_
std::string xmpPacket_
XMP packet.
Definition: image.hpp:490
Exiv2::BasicIo::error
virtual int error() const =0
Returns 0 if the IO source is in a valid state, otherwise nonzero.
Exiv2::Image::iptcData_
IptcData iptcData_
IPTC data container.
Definition: image.hpp:486
Exiv2::IoCloser
Utility class that closes a BasicIo instance upon destruction. Meant to be used as a stack variable i...
Definition: basicio.hpp:264
Exiv2::Dictionary_i
Dictionary::const_iterator Dictionary_i
typedef for Dictionary iterator
Definition: datasets.hpp:372
Exiv2::XmpSidecar::readMetadata
void readMetadata()
Read all metadata supported by a specific image format from the image. Before this method is called,...
Definition: xmpsidecar.cpp:70
Exiv2::XmpSidecar::mimeType
std::string mimeType() const
Return the MIME type of the image.
Definition: xmpsidecar.cpp:59
Exiv2::comment
@ comment
Exiv2 type for the Exif user comment.
Definition: types.hpp:139
Exiv2::XmpData::begin
iterator begin()
Begin of the metadata.
Definition: xmp.cpp:518
Exiv2::strError
EXIV2API std::string strError()
Return a system error message and the error code (errno). See strerror(3).
Definition: futils.cpp:316
Exiv2::Image::exifData_
ExifData exifData_
Exif data container.
Definition: image.hpp:485
Exiv2::copyIptcToXmp
EXIV2API void copyIptcToXmp(const IptcData &iptcData, XmpData &xmpData, const char *iptcCharset=0)
Convert (copy) IPTC datasets to XMP properties.
Definition: convert.cpp:1320
Exiv2::XmpKey
Concrete keys for XMP metadata.
Definition: properties.hpp:230
Exiv2::Image::clearMetadata
virtual void clearMetadata()
Erase all buffered metadata. Metadata is not removed from the actual image until the writeMetadata() ...
Definition: image.cpp:570
Exiv2::XmpData::findKey
iterator findKey(const XmpKey &key)
Find the first Xmpdatum with the given key, return an iterator to it.
Definition: xmp.cpp:502
Exiv2::newXmpInstance
EXIV2API Image::AutoPtr newXmpInstance(BasicIo::AutoPtr io, bool create)
Create a new XmpSidecar instance and return an auto-pointer to it. Caller owns the returned object an...
Definition: xmpsidecar.cpp:194
Exiv2::XmpParser::useCompactFormat
@ useCompactFormat
Use a compact form of RDF.
Definition: xmp_exiv2.hpp:274
Exiv2::copyXmpToExif
EXIV2API void copyXmpToExif(const XmpData &xmpData, ExifData &exifData)
Convert (copy) XMP properties to Exif tags.
Definition: convert.cpp:1301
Exiv2::XmpParser::omitPacketWrapper
@ omitPacketWrapper
Omit the XML packet wrapper.
Definition: xmp_exiv2.hpp:272
Exiv2::XmpParser::encode
static int encode(std::string &xmpPacket, const XmpData &xmpData, uint16_t formatFlags=useCompactFormat, uint32_t padding=0)
Encode (serialize) XMP metadata from xmpData into a string xmpPacket. The XMP packet returned in the ...
Definition: xmp.cpp:1000
Exiv2::BasicIo::eof
virtual bool eof() const =0
Returns true if the IO position has reached the end, otherwise false.
Exiv2::BasicIo::read
virtual DataBuf read(long rcount)=0
Read data from the IO source. Reading starts at the current IO position and the position is advanced ...
Exiv2::copyExifToXmp
EXIV2API void copyExifToXmp(const ExifData &exifData, XmpData &xmpData)
Convert (copy) Exif tags to XMP properties.
Definition: convert.cpp:1288
Exiv2
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of ...
Definition: asfvideo.hpp:36
Exiv2::XmpData
A container for XMP data. This is a top-level class of the Exiv2 library.
Definition: xmp_exiv2.hpp:166
convert.hpp
Exif and IPTC conversions to and from XMP.
Exiv2::XmpSidecar
Class to access XMP sidecar files. They contain only XMP metadata.
Definition: xmpsidecar.hpp:44
EXV_WARNING
#define EXV_WARNING
Shorthand for a temp warning log message object and return its ostringstream.
Definition: error.hpp:148
Exiv2::XmpSidecar::writeMetadata
void writeMetadata()
Write metadata back to the image.
Definition: xmpsidecar.cpp:129
Exiv2::XmpData::const_iterator
XmpMetadata::const_iterator const_iterator
XmpMetadata const iterator type.
Definition: xmp_exiv2.hpp:174
Exiv2::Image::io_
BasicIo::AutoPtr io_
Image data IO pointer.
Definition: image.hpp:484
Exiv2::Image::AutoPtr
std::auto_ptr< Image > AutoPtr
Image auto_ptr type.
Definition: image.hpp:81
Exiv2::Image::xmpPacket
virtual std::string & xmpPacket()
Return a modifiable reference to the raw XMP packet.
Definition: image.cpp:595
Exiv2::copyXmpToIptc
EXIV2API void copyXmpToIptc(const XmpData &xmpData, IptcData &iptcData)
Convert (copy) XMP properties to IPTC datasets.
Definition: convert.cpp:1338
Exiv2::BasicIo::AutoPtr
std::auto_ptr< BasicIo > AutoPtr
BasicIo auto_ptr type.
Definition: basicio.hpp:58
Exiv2::Image::writeXmpFromPacket
bool writeXmpFromPacket() const
Return the flag indicating the source when writing XMP metadata.
Definition: image.cpp:757
Exiv2::Error
BasicError< char > Error
Error class used for exceptions (std::string based)
Definition: error.hpp:324
Exiv2::Dictionary
std::map< std::string, std::string > Dictionary
typedef for string:string map
Definition: datasets.hpp:364
EXV_ERROR
#define EXV_ERROR
Shorthand for a temp error log message object and return its ostringstream.
Definition: error.hpp:150
Exiv2::BasicIo::seek
virtual int seek(long offset, Position pos)=0
Move the current IO position.
Exiv2::toString
std::string toString(const T &arg)
Utility function to convert the argument of any type to a string.
Definition: types.hpp:510
Exiv2::BasicIo
An interface for simple binary IO.
Definition: basicio.hpp:55
Exiv2::Image::xmpData_
XmpData xmpData_
XMP data container.
Definition: image.hpp:487
Exiv2::XmpSidecar::setComment
void setComment(const std::string &comment)
Not supported. XMP sidecar files do not contain a comment. Calling this function will throw an instan...
Definition: xmpsidecar.cpp:64
Exiv2::Image
Abstract base class defining the interface for an image. This is the top-level interface to the Exiv2...
Definition: image.hpp:78
Exiv2::XmpData::end
iterator end()
End of the metadata.
Definition: xmp.cpp:523
Exiv2::XmpParser::decode
static int decode(XmpData &xmpData, const std::string &xmpPacket)
Decode XMP metadata from an XMP packet xmpPacket into xmpData. The format of the XMP packet must foll...
Definition: xmp.cpp:887
error.hpp
Error class for exceptions, log message class.