Exiv2
psdimage.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 PSDIMAGE_HPP_
21 #define PSDIMAGE_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 PSD to the supported image formats
37  namespace ImageType {
38  const int psd = 12;
39  }
40 
44  class EXIV2API PsdImage : public Image {
46 
47  PsdImage(const PsdImage& rhs);
50  PsdImage& operator=(const PsdImage& rhs);
52 
53  public:
55 
56 
68  explicit PsdImage(BasicIo::AutoPtr io);
70 
72 
73  void readMetadata();
74  void writeMetadata();
78  void setComment(const std::string& comment);
80 
82 
83 
94  std::string mimeType() const;
96 
97  private:
99 
100  void readResourceBlock(uint16_t resourceId, uint32_t resourceSize);
108  void doWriteMetadata(BasicIo& oIo);
109  uint32_t writeExifData(const ExifData& exifData, BasicIo& out);
111 
113 
114  uint32_t writeIptcData(const IptcData& iptcData, BasicIo& out) const;
115  uint32_t writeXmpData(const XmpData& xmpData, BasicIo& out) const;
117 
118  }; // class PsdImage
119 
120 // *****************************************************************************
121 // template, inline and free functions
122 
123  // These could be static private functions on Image subclasses but then
124  // ImageFactory needs to be made a friend.
130  EXIV2API Image::AutoPtr newPsdInstance(BasicIo::AutoPtr io, bool create);
131 
133  EXIV2API bool isPsdType(BasicIo& iIo, bool advance);
134 
135 } // namespace Exiv2
136 
137 #endif // #ifndef PSDIMAGE_HPP_
An interface for simple binary IO.
Definition: basicio.hpp:55
std::auto_ptr< BasicIo > AutoPtr
BasicIo auto_ptr type.
Definition: basicio.hpp:58
A container for Exif data. This is a top-level class of the Exiv2 library. The container holds Exifda...
Definition: exif.hpp:434
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
A container for IPTC data. This is a top-level class of the Exiv2 library.
Definition: iptc.hpp:170
Class to access raw Photoshop images.
Definition: psdimage.hpp:44
A container for XMP data. This is a top-level class of the Exiv2 library.
Definition: xmp_exiv2.hpp:166
const int psd
Photoshop (PSD) image type (see class PsdImage)
Definition: psdimage.hpp:38
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of ...
Definition: asfvideo.hpp:36
EXIV2API bool isPsdType(BasicIo &iIo, bool advance)
Check if the file iIo is a Photoshop image.
Definition: psdimage.cpp:696
EXIV2API Image::AutoPtr newPsdInstance(BasicIo::AutoPtr io, bool create)
Create a new PsdImage instance and return an auto-pointer to it. Caller owns the returned object and ...
Definition: psdimage.cpp:686
@ comment
Exiv2 type for the Exif user comment.
Definition: types.hpp:139