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_
Exiv2::OrfImage::pixelHeight
int pixelHeight() const
Return the pixel height of the image.
Definition: orfimage.cpp:66
Exiv2::isOrfType
EXIV2API bool isOrfType(BasicIo &iIo, bool advance)
Check if the file iIo is an ORF image.
Definition: orfimage.cpp:216
Exiv2::OrfImage::readMetadata
void readMetadata()
Read all metadata supported by a specific image format from the image. Before this method is called,...
Definition: orfimage.cpp:96
Exiv2::BasicIo::error
virtual int error() const =0
Returns 0 if the IO source is in a valid state, otherwise nonzero.
Exiv2::Image::iptcData_
IptcData iptcData_
IPTC data container.
Definition: image.hpp:486
Exiv2::IoCloser
Utility class that closes a BasicIo instance upon destruction. Meant to be used as a stack variable i...
Definition: basicio.hpp:264
Exiv2::ExifData::findKey
iterator findKey(const ExifKey &key)
Find the first Exifdatum with the given key, return an iterator to it.
Definition: exif.cpp:605
Exiv2::Internal::IfdId
IfdId
Type to specify the IFD to which a metadata belongs.
Definition: tags_int.hpp:46
Exiv2::ExifData::begin
iterator begin()
Begin of the metadata.
Definition: exif.hpp:490
Exiv2::OrfImage::writeMetadata
void writeMetadata()
Write metadata back to the image.
Definition: orfimage.cpp:119
Exiv2::ExifData::const_iterator
ExifMetadata::const_iterator const_iterator
ExifMetadata const iterator type.
Definition: exif.hpp:439
Exiv2::ExifData::erase
iterator erase(iterator pos)
Delete the Exifdatum at iterator position pos, return the position of the next exifdatum....
Definition: exif.cpp:631
Exiv2::comment
@ comment
Exiv2 type for the Exif user comment.
Definition: types.hpp:139
Exiv2::strError
EXIV2API std::string strError()
Return a system error message and the error code (errno). See strerror(3).
Definition: futils.cpp:316
Exiv2::Internal::FindExifdatum
Unary predicate that matches an Exifdatum with a given IfdId.
Definition: tiffimage_int.hpp:469
Exiv2::OrfParser::decode
static ByteOrder decode(ExifData &exifData, IptcData &iptcData, XmpData &xmpData, const byte *pData, uint32_t size)
Decode metadata from a buffer pData of length size with data in ORF format to the provided metadata c...
Definition: orfimage.cpp:146
Exiv2::Image::exifData_
ExifData exifData_
Exif data container.
Definition: image.hpp:485
Exiv2::ExifData::end
iterator end()
End of the metadata.
Definition: exif.hpp:492
Exiv2::OrfImage::pixelWidth
int pixelWidth() const
Return the pixel width of the image.
Definition: orfimage.cpp:57
Exiv2::OrfImage::setComment
void setComment(const std::string &comment)
Not supported. ORF format does not contain a comment. Calling this function will throw an Error(kerIn...
Definition: orfimage.cpp:75
Exiv2::Image::setTypeSupported
void setTypeSupported(int imageType, uint16_t supportedMetadata)
set type support for this image format
Definition: image.hpp:471
Exiv2::Image::clearMetadata
virtual void clearMetadata()
Erase all buffered metadata. Metadata is not removed from the actual image until the writeMetadata() ...
Definition: image.cpp:570
Exiv2::Internal::TiffMapping::findEncoder
static EncoderFct findEncoder(const std::string &make, uint32_t extendedTag, IfdId group)
Find special encoder function for a key.
Definition: tiffimage_int.cpp:1654
Exiv2::Internal::OrfHeader::read
bool read(const byte *pData, uint32_t size)
Read the image header from a data buffer. Return false if the data buffer does not contain an image h...
Definition: orfimage_int.cpp:36
Exiv2::Internal::TiffMapping::findDecoder
static DecoderFct findDecoder(const std::string &make, uint32_t extendedTag, IfdId group)
Find the decoder function for a key.
Definition: tiffimage_int.cpp:1640
Exiv2::Image::setByteOrder
void setByteOrder(ByteOrder byteOrder)
Set the byte order to encode the Exif metadata in.
Definition: image.cpp:707
Exiv2::Image::byteOrder
ByteOrder byteOrder() const
Return the byte order in which the Exif metadata of the image is encoded. Initially,...
Definition: image.cpp:712
Exiv2::OrfImage::OrfImage
OrfImage(BasicIo::AutoPtr io, bool create)
Constructor that can either open an existing ORF image or create a new image from scratch....
Definition: orfimage.cpp:46
Exiv2::newOrfInstance
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
Exiv2::OrfParser
Stateless parser class for data in ORF format. Images use this class to decode and encode ORF data....
Definition: orfimage.hpp:102
Exiv2::Image::printTiffStructure
void printTiffStructure(BasicIo &io, std::ostream &out, PrintStructureOption option, int depth, size_t offset=0)
Print out the structure of image file.
Definition: image.cpp:552
Exiv2::ExifKey
Concrete keys for Exif metadata and access to Exif tag reference data.
Definition: tags.hpp:140
Exiv2::BasicIo::eof
virtual bool eof() const =0
Returns true if the IO position has reached the end, otherwise false.
Exiv2::BasicIo::read
virtual DataBuf read(long rcount)=0
Read data from the IO source. Reading starts at the current IO position and the position is advanced ...
Exiv2::Internal::OrfHeader
Olympus ORF header structure.
Definition: orfimage_int.hpp:39
Exiv2::Image::imageType
int imageType() const
set type support for this image format
Definition: image.hpp:480
Exiv2
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of ...
Definition: asfvideo.hpp:36
Exiv2::XmpData
A container for XMP data. This is a top-level class of the Exiv2 library.
Definition: xmp_exiv2.hpp:166
Exiv2::Image::io
virtual BasicIo & io() const
Return a reference to the BasicIo instance being used for Io.
Definition: image.cpp:752
Exiv2::ImageType::none
const int none
Not an image.
Definition: image.hpp:45
Exiv2::TiffImage
Class to access TIFF images. Exif metadata is supported directly, IPTC is read from the Exif data,...
Definition: tiffimage.hpp:52
Exiv2::ImageType::orf
const int orf
ORF image type (see class OrfImage)
Definition: orfimage.hpp:38
Exiv2::Internal::TiffParserWorker::encode
static WriteMethod encode(BasicIo &io, const byte *pData, uint32_t size, const ExifData &exifData, const IptcData &iptcData, const XmpData &xmpData, uint32_t root, FindEncoderFct findEncoderFct, TiffHeaderBase *pHeader, OffsetWriter *pOffsetWriter)
Encode TIFF metadata from the metadata containers into a memory block blob.
Definition: tiffimage_int.cpp:1747
Exiv2::Image::io_
BasicIo::AutoPtr io_
Image data IO pointer.
Definition: image.hpp:484
Exiv2::ByteOrder
ByteOrder
Type to express the byte order (little or big endian)
Definition: types.hpp:102
Exiv2::Image::AutoPtr
std::auto_ptr< Image > AutoPtr
Image auto_ptr type.
Definition: image.hpp:81
Exiv2::BasicIo::AutoPtr
std::auto_ptr< BasicIo > AutoPtr
BasicIo auto_ptr type.
Definition: basicio.hpp:58
Exiv2::Error
BasicError< char > Error
Error class used for exceptions (std::string based)
Definition: error.hpp:324
Exiv2::IptcData
A container for IPTC data. This is a top-level class of the Exiv2 library.
Definition: iptc.hpp:170
Exiv2::PrintStructureOption
PrintStructureOption
Options for printStructure.
Definition: image.hpp:64
Exiv2::OrfImage::printStructure
void printStructure(std::ostream &out, PrintStructureOption option, int depth)
Print out the structure of image file.
Definition: orfimage.cpp:81
Exiv2::BasicIo::seek
virtual int seek(long offset, Position pos)=0
Move the current IO position.
Exiv2::OrfImage::mimeType
std::string mimeType() const
Return the MIME type of the image.
Definition: orfimage.cpp:52
Exiv2::BasicIo
An interface for simple binary IO.
Definition: basicio.hpp:55
Exiv2::Image::xmpData_
XmpData xmpData_
XMP data container.
Definition: image.hpp:487
Exiv2::OrfParser::encode
static WriteMethod encode(BasicIo &io, const byte *pData, uint32_t size, ByteOrder byteOrder, const ExifData &exifData, const IptcData &iptcData, const XmpData &xmpData)
Encode metadata from the provided metadata to ORF format. See TiffParser::encode().
Definition: orfimage.cpp:165
Exiv2::WriteMethod
WriteMethod
Type to indicate write method used by TIFF parsers.
Definition: types.hpp:105
Exiv2::Internal::TiffHeaderBase::byteOrder
virtual ByteOrder byteOrder() const
Return the byte order (little or big endian).
Definition: tiffimage_int.cpp:1956
Exiv2::Internal::TiffParserWorker::decode
static ByteOrder decode(ExifData &exifData, IptcData &iptcData, XmpData &xmpData, const byte *pData, uint32_t size, uint32_t root, FindDecoderFct findDecoderFct, TiffHeaderBase *pHeader=0)
Decode TIFF metadata from a data buffer pData of length size into the provided metadata containers.
Definition: tiffimage_int.cpp:1717
error.hpp
Error class for exceptions, log message class.
Exiv2::OrfImage
Class to access raw Olympus ORF images. Exif metadata is supported directly, IPTC is read from the Ex...
Definition: orfimage.hpp:45
Exiv2::ExifData
A container for Exif data. This is a top-level class of the Exiv2 library. The container holds Exifda...
Definition: exif.hpp:434