Exiv2
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pgfimage.hpp
Go to the documentation of this file.
1 // ***************************************************************** -*- C++ -*-
2 /*
3  * Copyright (C) 2004-2018 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  */
30 #ifndef PGFIMAGE_HPP_
31 #define PGFIMAGE_HPP_
32 
33 // *****************************************************************************
34 #include "exiv2lib_export.h"
35 
36 // included header files
37 #include "image.hpp"
38 
39 // *****************************************************************************
40 // namespace extensions
41 namespace Exiv2
42 {
43 
44 // *****************************************************************************
45 // class definitions
46 
47  // Add PGF to the supported image formats
48  namespace ImageType
49  {
50  const int pgf = 17;
51  }
52 
57  class EXIV2API PgfImage : public Image {
58  public:
60 
61 
76  PgfImage(BasicIo::AutoPtr io, bool create);
78 
80 
81  void readMetadata();
82  void writeMetadata();
84 
86 
87  std::string mimeType() const { return "image/pgf"; }
89 
90  private:
91  bool bSwap_; // true for bigEndian hardware, else false
93 
94  PgfImage(const PgfImage& rhs);
97  PgfImage& operator=(const PgfImage& rhs);
105  void doWriteMetadata(BasicIo& oIo);
107  byte readPgfMagicNumber(BasicIo& iIo);
109  uint32_t readPgfHeaderSize(BasicIo& iIo);
111  DataBuf readPgfHeaderStructure(BasicIo& iIo, int& width,int & height);
113 
114  }; // class PgfImage
115 
116 // *****************************************************************************
117 // template, inline and free functions
118 
119  // These could be static private functions on Image subclasses but then
120  // ImageFactory needs to be made a friend.
126  EXIV2API Image::AutoPtr newPgfInstance(BasicIo::AutoPtr io, bool create);
127 
129  EXIV2API bool isPgfType(BasicIo& iIo, bool advance);
130 
131 } // namespace Exiv2
132 
133 #endif // #ifndef PGFIMAGE_HPP_
An interface for simple binary IO.
Definition: basicio.hpp:55
std::auto_ptr< Image > AutoPtr
Image auto_ptr type.
Definition: image.hpp:84
EXIV2API bool isPgfType(BasicIo &iIo, bool advance)
Check if the file iIo is a PGF image.
Definition: pgfimage.cpp:333
Utility class containing a character array. All it does is to take care of memory allocation and dele...
Definition: types.hpp:204
Class to access PGF images. Exif and IPTC metadata are supported directly.
Definition: pgfimage.hpp:57
uint8_t byte
1 byte unsigned integer type.
Definition: types.hpp:105
Abstract base class defining the interface for an image. This is the top-level interface to the Exiv2...
Definition: image.hpp:81
std::string mimeType() const
Return the MIME type of the image.
Definition: pgfimage.hpp:87
std::auto_ptr< BasicIo > AutoPtr
BasicIo auto_ptr type.
Definition: basicio.hpp:58
IPTC string type.
Definition: types.hpp:147
EXIV2API Image::AutoPtr newPgfInstance(BasicIo::AutoPtr io, bool create)
Create a new PgfImage instance and return an auto-pointer to it. Caller owns the returned object and ...
Definition: pgfimage.cpp:323
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of ...
Definition: asfvideo.hpp:36
const int pgf
PGF image type (see class PgfImage)
Definition: pgfimage.hpp:50