Exiv2
orfimage.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 ORFIMAGE_HPP_
21 #define ORFIMAGE_HPP_
22 
23 // *****************************************************************************
24 #include "exiv2lib_export.h"
25 
26 // included header files
27 #include "tiffimage.hpp"
28 
29 // *****************************************************************************
30 // namespace extensions
31 namespace Exiv2 {
32 
33 // *****************************************************************************
34 // class definitions
35 
36  // Add ORF to the supported image formats
37  namespace ImageType {
38  const int orf = 9;
39  }
40 
45  class EXIV2API OrfImage : public TiffImage {
46  public:
48 
49 
64  OrfImage(BasicIo::AutoPtr io, bool create);
66 
68 
69  void printStructure(std::ostream& out, PrintStructureOption option,int depth);
70  void readMetadata();
71  void writeMetadata();
76  void setComment(const std::string& comment);
78 
80 
81  std::string mimeType() const;
82  int pixelWidth() const;
83  int pixelHeight() const;
85 
86  private:
88 
89  OrfImage(const OrfImage& rhs);
92  OrfImage& operator=(const OrfImage& rhs);
94 
95  }; // class OrfImage
96 
102  class EXIV2API OrfParser {
103  public:
109  static ByteOrder decode(
110  ExifData& exifData,
111  IptcData& iptcData,
112  XmpData& xmpData,
113  const byte* pData,
114  uint32_t size
115  );
120  static WriteMethod encode(
121  BasicIo& io,
122  const byte* pData,
123  uint32_t size,
124  ByteOrder byteOrder,
125  const ExifData& exifData,
126  const IptcData& iptcData,
127  const XmpData& xmpData
128  );
129  }; // class OrfParser
130 
131 // *****************************************************************************
132 // template, inline and free functions
133 
134  // These could be static private functions on Image subclasses but then
135  // ImageFactory needs to be made a friend.
141  EXIV2API Image::AutoPtr newOrfInstance(BasicIo::AutoPtr io, bool create);
142 
144  EXIV2API bool isOrfType(BasicIo& iIo, bool advance);
145 
146 } // namespace Exiv2
147 
148 #endif // #ifndef ORFIMAGE_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
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 Olympus ORF images. Exif metadata is supported directly, IPTC is read from the Ex...
Definition: orfimage.hpp:45
Stateless parser class for data in ORF format. Images use this class to decode and encode ORF data....
Definition: orfimage.hpp:102
Class to access TIFF images. Exif metadata is supported directly, IPTC is read from the Exif data,...
Definition: tiffimage.hpp:52
A container for XMP data. This is a top-level class of the Exiv2 library.
Definition: xmp_exiv2.hpp:166
const int orf
ORF image type (see class OrfImage)
Definition: orfimage.hpp:38
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 bool isOrfType(BasicIo &iIo, bool advance)
Check if the file iIo is an ORF image.
Definition: orfimage.cpp:216
@ comment
Exiv2 type for the Exif user comment.
Definition: types.hpp:139
ByteOrder
Type to express the byte order (little or big endian)
Definition: types.hpp:102
WriteMethod
Type to indicate write method used by TIFF parsers.
Definition: types.hpp:105
EXIV2API Image::AutoPtr newOrfInstance(BasicIo::AutoPtr io, bool create)
Create a new OrfImage instance and return an auto-pointer to it. Caller owns the returned object and ...
Definition: orfimage.cpp:207