Exiv2
mrwimage.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  */
28 #ifndef MRWIMAGE_HPP_
29 #define MRWIMAGE_HPP_
30 
31 // *****************************************************************************
32 #include "exiv2lib_export.h"
33 
34 // included header files
35 #include "image.hpp"
36 
37 // *****************************************************************************
38 // namespace extensions
39 namespace Exiv2 {
40 
41 // *****************************************************************************
42 // class definitions
43 
44  // Add MRW to the supported image formats
45  namespace ImageType {
46  const int mrw = 5;
47  }
48 
53  class EXIV2API MrwImage : public Image {
54  public:
56 
57 
72  MrwImage(BasicIo::AutoPtr io, bool create);
74 
76 
77  void readMetadata();
82  void writeMetadata();
87  void setExifData(const ExifData& exifData);
92  void setIptcData(const IptcData& iptcData);
97  void setComment(const std::string& comment);
99 
101 
102  std::string mimeType() const;
103  int pixelWidth() const;
104  int pixelHeight() const;
106 
107  private:
109 
110  MrwImage(const MrwImage& rhs);
113  MrwImage& operator=(const MrwImage& rhs);
115 
116  }; // class MrwImage
117 
118 // *****************************************************************************
119 // template, inline and free functions
120 
121  // These could be static private functions on Image subclasses but then
122  // ImageFactory needs to be made a friend.
128  EXIV2API Image::AutoPtr newMrwInstance(BasicIo::AutoPtr io, bool create);
129 
131  EXIV2API bool isMrwType(BasicIo& iIo, bool advance);
132 
133 } // namespace Exiv2
134 
135 #endif // #ifndef MRWIMAGE_HPP_
Exiv2::MrwImage::readMetadata
void readMetadata()
Read all metadata supported by a specific image format from the image. Before this method is called,...
Definition: mrwimage.cpp:94
Exiv2::MrwImage::pixelWidth
int pixelWidth() const
Return the pixel width of the image.
Definition: mrwimage.cpp:58
Exiv2::BasicIo::error
virtual int error() const =0
Returns 0 if the IO source is in a valid state, otherwise nonzero.
Exiv2::DataBuf::pData_
byte * pData_
Pointer to the buffer, 0 if none has been allocated.
Definition: types.hpp:269
Exiv2::Image::iptcData_
IptcData iptcData_
IPTC data container.
Definition: image.hpp:489
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:590
Exiv2::MrwImage::MrwImage
MrwImage(BasicIo::AutoPtr io, bool create)
Constructor that can either open an existing MRW image or create a new image from scratch....
Definition: mrwimage.cpp:48
Exiv2::MrwImage::setIptcData
void setIptcData(const IptcData &iptcData)
Todo: Not supported yet, requires writeMetadata(). Calling this function will throw an Error(kerInval...
Definition: mrwimage.cpp:82
Exiv2::ExifData::const_iterator
ExifMetadata::const_iterator const_iterator
ExifMetadata const iterator type.
Definition: exif.hpp:439
Exiv2::MrwImage
Class to access raw Minolta MRW images. Exif metadata is supported directly, IPTC is read from the Ex...
Definition: mrwimage.hpp:53
Exiv2::comment
@ comment
Exiv2 type for the Exif user comment.
Definition: types.hpp:150
Exiv2::strError
EXIV2API std::string strError()
Return a system error message and the error code (errno). See strerror(3).
Definition: futils.cpp:356
Exiv2::ImageType::mrw
const int mrw
MRW image type (see class MrwImage)
Definition: mrwimage.hpp:46
Exiv2::isMrwType
EXIV2API bool isMrwType(BasicIo &iIo, bool advance)
Check if the file iIo is a MRW image.
Definition: mrwimage.cpp:171
Exiv2::Image::exifData_
ExifData exifData_
Exif data container.
Definition: image.hpp:488
Exiv2::TiffParser::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 TIFF format to the provided metadata ...
Definition: tiffimage.cpp:251
Exiv2::ExifData::end
iterator end()
End of the metadata.
Definition: exif.hpp:492
Exiv2::Image::clearMetadata
virtual void clearMetadata()
Erase all buffered metadata. Metadata is not removed from the actual image until the writeMetadata() ...
Definition: image.cpp:549
enforce.hpp
Port of D's enforce() to C++ & Exiv2.
Exiv2::Image::setByteOrder
void setByteOrder(ByteOrder byteOrder)
Set the byte order to encode the Exif metadata in.
Definition: image.cpp:686
enforce
void enforce(bool condition, const T &arg1)
Ensure that condition is true, otherwise throw an exception of the type exception_t.
Definition: enforce.hpp:43
mrwimage.hpp
Minolta RAW image, implemented using the following references: Minolta Raw file format by Dalibor Jel...
Exiv2::DataBuf
Utility class containing a character array. All it does is to take care of memory allocation and dele...
Definition: types.hpp:204
Exiv2::ExifKey
Concrete keys for Exif metadata and access to Exif tag reference data.
Definition: tags.hpp:148
Exiv2::DataBuf::size_
long size_
The current size of the buffer.
Definition: types.hpp:271
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
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of ...
Definition: asfvideo.hpp:36
image.hpp
Exiv2::Image::io_
BasicIo::AutoPtr io_
Image data IO pointer.
Definition: image.hpp:487
Exiv2::ByteOrder
ByteOrder
Type to express the byte order (little or big endian)
Definition: types.hpp:113
Exiv2::MrwImage::pixelHeight
int pixelHeight() const
Return the pixel height of the image.
Definition: mrwimage.cpp:67
Exiv2::Image::AutoPtr
std::auto_ptr< Image > AutoPtr
Image auto_ptr type.
Definition: image.hpp:84
Exiv2::MrwImage::setComment
void setComment(const std::string &comment)
Not supported. MRW format does not contain a comment. Calling this function will throw an Error(kerIn...
Definition: mrwimage.cpp:88
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:323
Exiv2::IptcData
A container for IPTC data. This is a top-level class of the Exiv2 library.
Definition: iptc.hpp:173
Exiv2::string
@ string
IPTC string type.
Definition: types.hpp:147
Exiv2::BasicIo::seek
virtual int seek(long offset, Position pos)=0
Move the current IO position.
Exiv2::BasicIo
An interface for simple binary IO.
Definition: basicio.hpp:55
Exiv2::Image::xmpData_
XmpData xmpData_
XMP data container.
Definition: image.hpp:490
Exiv2::Image
Abstract base class defining the interface for an image. This is the top-level interface to the Exiv2...
Definition: image.hpp:81
Exiv2::MrwImage::setExifData
void setExifData(const ExifData &exifData)
Todo: Not supported yet, requires writeMetadata(). Calling this function will throw an Error(kerInval...
Definition: mrwimage.cpp:76
Exiv2::newMrwInstance
EXIV2API Image::AutoPtr newMrwInstance(BasicIo::AutoPtr io, bool create)
Create a new MrwImage instance and return an auto-pointer to it. Caller owns the returned object and ...
Definition: mrwimage.cpp:162
futils.hpp
Basic file utility functions required by Exiv2.
Exiv2::getULong
EXIV2API uint32_t getULong(const byte *buf, ByteOrder byteOrder)
Read a 4 byte unsigned long value from the data buffer.
Definition: types.cpp:283
error.hpp
Error class for exceptions, log message class.
Exiv2::MrwImage::writeMetadata
void writeMetadata()
Todo: Write metadata back to the image. This method is not yet implemented. Calling it will throw an ...
Definition: mrwimage.cpp:154
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
Exiv2::MrwImage::mimeType
std::string mimeType() const
Return the MIME type of the image.
Definition: mrwimage.cpp:53