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_
An interface for simple binary IO.
Definition: basicio.hpp:55
std::auto_ptr< BasicIo > AutoPtr
BasicIo auto_ptr type.
Definition: basicio.hpp:58
Abstract base class defining the interface for an image. This is the top-level interface to the Exiv2...
Definition: image.hpp:78
std::auto_ptr< Image > AutoPtr
Image auto_ptr type.
Definition: image.hpp:81
Class to access XMP sidecar files. They contain only XMP metadata.
Definition: xmpsidecar.hpp:44
const int xmp
XMP sidecar files (see class XmpSidecar)
Definition: xmpsidecar.hpp:38
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of ...
Definition: asfvideo.hpp:36
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
@ comment
Exiv2 type for the Exif user comment.
Definition: types.hpp:139
EXIV2API bool isXmpType(BasicIo &iIo, bool advance)
Check if the file iIo is an XMP sidecar file.
Definition: xmpsidecar.cpp:203
std::map< std::string, std::string > Dictionary
typedef for string:string map
Definition: datasets.hpp:364