Exiv2
cr2image.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  */
27 #ifndef CR2IMAGE_HPP_
28 #define CR2IMAGE_HPP_
29 
30 // *****************************************************************************
31 #include "exiv2lib_export.h"
32 
33 // included header files
34 #include "image.hpp"
35 
36 // *****************************************************************************
37 // namespace extensions
38 namespace Exiv2 {
39 
40 // *****************************************************************************
41 // class definitions
42 
43  // Add CR2 to the supported image formats
44  namespace ImageType {
45  const int cr2 = 7;
46  }
47 
52  class EXIV2API Cr2Image : public Image {
53  public:
55 
56 
71  Cr2Image(BasicIo::AutoPtr io, bool create);
73 
75 
76  void readMetadata();
77  void writeMetadata();
84  void printStructure(std::ostream& out, PrintStructureOption option,int depth);
89  void setComment(const std::string& comment);
91 
93 
94  std::string mimeType() const;
95  int pixelWidth() const;
96  int pixelHeight() const;
98 
99  private:
101 
102  Cr2Image(const Cr2Image& rhs);
105  Cr2Image& operator=(const Cr2Image& rhs);
107 
108  }; // class Cr2Image
109 
115  class EXIV2API Cr2Parser {
116  public:
122  static ByteOrder decode(
123  ExifData& exifData,
124  IptcData& iptcData,
125  XmpData& xmpData,
126  const byte* pData,
127  uint32_t size
128  );
133  static WriteMethod encode(
134  BasicIo& io,
135  const byte* pData,
136  uint32_t size,
137  ByteOrder byteOrder,
138  const ExifData& exifData,
139  const IptcData& iptcData,
140  const XmpData& xmpData
141  );
142 
143  }; // class Cr2Parser
144 
145 // *****************************************************************************
146 // template, inline and free functions
147 
148  // These could be static private functions on Image subclasses but then
149  // ImageFactory needs to be made a friend.
155  EXIV2API Image::AutoPtr newCr2Instance(BasicIo::AutoPtr io, bool create);
156 
158  EXIV2API bool isCr2Type(BasicIo& iIo, bool advance);
159 
160 } // namespace Exiv2
161 
162 #endif // #ifndef CR2IMAGE_HPP_
An interface for simple binary IO.
Definition: basicio.hpp:55
A container for XMP data. This is a top-level class of the Exiv2 library.
Definition: xmp_exiv2.hpp:173
std::auto_ptr< Image > AutoPtr
Image auto_ptr type.
Definition: image.hpp:84
A container for Exif data. This is a top-level class of the Exiv2 library. The container holds Exifda...
Definition: exif.hpp:434
ByteOrder
Type to express the byte order (little or big endian)
Definition: types.hpp:113
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
PrintStructureOption
Options for printStructure.
Definition: image.hpp:67
A container for IPTC data. This is a top-level class of the Exiv2 library.
Definition: iptc.hpp:173
Stateless parser class for data in CR2 format. Images use this class to decode and encode CR2 data...
Definition: cr2image.hpp:115
WriteMethod
Type to indicate write method used by TIFF parsers.
Definition: types.hpp:116
std::auto_ptr< BasicIo > AutoPtr
BasicIo auto_ptr type.
Definition: basicio.hpp:58
Class to access raw Canon CR2 images. Exif metadata is supported directly, IPTC is read from the Exif...
Definition: cr2image.hpp:52
EXIV2API Image::AutoPtr newCr2Instance(BasicIo::AutoPtr io, bool create)
Create a new Cr2Image instance and return an auto-pointer to it. Caller owns the returned object and ...
Definition: cr2image.cpp:203
IPTC string type.
Definition: types.hpp:147
const int cr2
CR2 image type (see class Cr2Image)
Definition: cr2image.hpp:45
EXIV2API bool isCr2Type(BasicIo &iIo, bool advance)
Check if the file iIo is a CR2 image.
Definition: cr2image.cpp:212
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of ...
Definition: asfvideo.hpp:36
Exiv2 type for the Exif user comment.
Definition: types.hpp:150