Exiv2
pngimage.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 PNGIMAGE_HPP_
21 #define PNGIMAGE_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 // *****************************************************************************
35 // class definitions
36 
37  // Add PNG to the supported image formats
38  namespace ImageType
39  {
40  const int png = 6;
41  }
42 
47  class EXIV2API PngImage : public Image {
48  public:
50 
51 
66  PngImage(BasicIo::AutoPtr io, bool create);
68 
70 
71  void readMetadata();
72  void writeMetadata();
73 
80  void printStructure(std::ostream& out, PrintStructureOption option,int depth);
82 
84 
85  std::string mimeType() const;
87 
88  private:
90 
91  PngImage(const PngImage& rhs);
94  PngImage& operator=(const PngImage& rhs);
102  void doWriteMetadata(BasicIo& oIo);
104 
105  std::string profileName_;
106 
107  }; // class PngImage
108 
109 // *****************************************************************************
110 // template, inline and free functions
111 
112  // These could be static private functions on Image subclasses but then
113  // ImageFactory needs to be made a friend.
119  EXIV2API Image::AutoPtr newPngInstance(BasicIo::AutoPtr io, bool create);
120 
122  EXIV2API bool isPngType(BasicIo& iIo, bool advance);
123 
124 } // namespace Exiv2
125 
126 #endif // #ifndef PNGIMAGE_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 PNG images. Exif and IPTC metadata are supported directly.
Definition: pngimage.hpp:47
void readMetadata()
Read all metadata supported by a specific image format from the image. Before this method is called,...
void writeMetadata()
Write metadata back to the image.
PngImage(BasicIo::AutoPtr io, bool create)
Constructor that can either open an existing PNG image or create a new image from scratch....
std::string mimeType() const
Return the MIME type of the image.
void printStructure(std::ostream &out, PrintStructureOption option, int depth)
Print out the structure of image file.
const int png
PNG image type (see class PngImage)
Definition: pngimage.hpp:40
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of ...
Definition: asfvideo.hpp:36
PrintStructureOption
Options for printStructure.
Definition: image.hpp:64
EXIV2API Image::AutoPtr newPngInstance(BasicIo::AutoPtr io, bool create)
Create a new PngImage instance and return an auto-pointer to it. Caller owns the returned object and ...
EXIV2API bool isPngType(BasicIo &iIo, bool advance)
Check if the file iIo is a PNG image.