Exiv2
rw2image.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 RW2IMAGE_HPP_
28 #define RW2IMAGE_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 RW2 to the supported image formats
44  namespace ImageType {
45  const int rw2 = 16;
46  }
47 
53  class EXIV2API Rw2Image : public Image {
54  public:
56 
57 
69  explicit Rw2Image(BasicIo::AutoPtr io);
71 
73 
74  void printStructure(std::ostream& out, PrintStructureOption option,int depth);
75  void readMetadata();
80  void writeMetadata();
85  void setExifData(const ExifData& exifData);
90  void setIptcData(const IptcData& iptcData);
95  void setComment(const std::string& comment);
97 
99 
100  std::string mimeType() const;
101  int pixelWidth() const;
102  int pixelHeight() const;
104 
105  private:
107 
108  Rw2Image(const Rw2Image& rhs);
111  Rw2Image& operator=(const Rw2Image& rhs);
113 
114  }; // class Rw2Image
115 
121  class EXIV2API Rw2Parser {
122  public:
128  static ByteOrder decode(
129  ExifData& exifData,
130  IptcData& iptcData,
131  XmpData& xmpData,
132  const byte* pData,
133  uint32_t size
134  );
135 
136  }; // class Rw2Parser
137 
138 // *****************************************************************************
139 // template, inline and free functions
140 
141  // These could be static private functions on Image subclasses but then
142  // ImageFactory needs to be made a friend.
148  EXIV2API Image::AutoPtr newRw2Instance(BasicIo::AutoPtr io, bool create);
149 
151  EXIV2API bool isRw2Type(BasicIo& iIo, bool advance);
152 
153 } // namespace Exiv2
154 
155 #endif // #ifndef RW2IMAGE_HPP_
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:489
Exiv2::Rw2Image::setExifData
void setExifData(const ExifData &exifData)
Todo: Not supported yet, requires writeMetadata(). Calling this function will throw an Error(kerInval...
Definition: rw2image.cpp:80
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::Rw2Image::writeMetadata
void writeMetadata()
Todo: Write metadata back to the image. This method is not yet implemented. Calling it will throw an ...
Definition: rw2image.cpp:220
Exiv2::ExifData::add
void add(const ExifKey &key, const Value *pValue)
Add an Exifdatum from the supplied key and value pair. This method copies (clones) key and value....
Definition: exif.cpp:573
Exiv2::ExifData::begin
iterator begin()
Begin of the metadata.
Definition: exif.hpp:490
Exiv2::Rw2Image::pixelWidth
int pixelWidth() const
Return the pixel width of the image.
Definition: rw2image.cpp:60
Exiv2::ExifData::const_iterator
ExifMetadata::const_iterator const_iterator
ExifMetadata const iterator type.
Definition: exif.hpp:439
Exiv2::Rw2Image
Class to access raw Panasonic RW2 images. Exif metadata is supported directly, IPTC and XMP are read ...
Definition: rw2image.hpp:53
Exiv2::ExifData::erase
iterator erase(iterator pos)
Delete the Exifdatum at iterator position pos, return the position of the next exifdatum....
Definition: exif.cpp:616
Exiv2::comment
@ comment
Exiv2 type for the Exif user comment.
Definition: types.hpp:150
Exiv2::Rw2Parser::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 RW2 format to the provided metadata c...
Definition: rw2image.cpp:226
Exiv2::strError
EXIV2API std::string strError()
Return a system error message and the error code (errno). See strerror(3).
Definition: futils.cpp:356
Exiv2::PreviewPropertiesList
std::vector< PreviewProperties > PreviewPropertiesList
Container type to hold all preview images metadata.
Definition: preview.hpp:68
Exiv2::isRw2Type
EXIV2API bool isRw2Type(BasicIo &iIo, bool advance)
Check if the file iIo is a RW2 image.
Definition: rw2image.cpp:256
EXV_COUNTOF
#define EXV_COUNTOF(a)
Macro to determine the size of an array.
Definition: types.hpp:517
Exiv2::Internal::TiffHeaderBase::read
virtual 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: tiffimage_int.cpp:1849
Exiv2::Image::exifData_
ExifData exifData_
Exif data container.
Definition: image.hpp:488
Exiv2::ExifData::end
iterator end()
End of the metadata.
Definition: exif.hpp:492
Exiv2::Rw2Image::Rw2Image
Rw2Image(BasicIo::AutoPtr io)
Constructor to open an existing RW2 image. Since the constructor can not return a result,...
Definition: rw2image.cpp:50
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
rw2image_int.hpp
Internal classes to support RW2 image format.
Exiv2::Rw2Image::setComment
void setComment(const std::string &comment)
Not supported. RW2 format does not contain a comment. Calling this function will throw an Error(kerIn...
Definition: rw2image.cpp:92
Exiv2::Rw2Image::readMetadata
void readMetadata()
Read all metadata supported by a specific image format from the image. Before this method is called,...
Definition: rw2image.cpp:113
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:1589
Exiv2::ImageFactory::open
static Image::AutoPtr open(const std::string &path, bool useCurl=true)
Create an Image subclass of the appropriate type by reading the specified file. Image type is derived...
Definition: image.cpp:901
Exiv2::PreviewImage::pData
const byte * pData() const
Return a pointer to the image data for read-only access.
Definition: preview.cpp:1097
Exiv2::Rw2Image::printStructure
void printStructure(std::ostream &out, PrintStructureOption option, int depth)
Print out the structure of image file.
Definition: rw2image.cpp:98
Exiv2::Image::setByteOrder
void setByteOrder(ByteOrder byteOrder)
Set the byte order to encode the Exif metadata in.
Definition: image.cpp:686
preview.hpp
Classes to access all preview images embedded in an image.
tiffimage_int.hpp
Internal class TiffParserWorker to parse TIFF data.
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:531
Exiv2::Rw2Image::mimeType
std::string mimeType() const
Return the MIME type of the image.
Definition: rw2image.cpp:55
Exiv2::PreviewManager::getPreviewProperties
PreviewPropertiesList getPreviewProperties() const
Return the properties of all preview images in a list sorted by preview width * height,...
Definition: preview.cpp:1144
Exiv2::ExifKey
Concrete keys for Exif metadata and access to Exif tag reference data.
Definition: tags.hpp:148
Exiv2::BasicIo::eof
virtual bool eof() const =0
Returns true if the IO position has reached the end, otherwise false.
Exiv2::Internal::Tag::pana
const uint32_t pana
Special tag: root IFD of Panasonic RAW images.
Definition: tiffcomposite_int.hpp:83
Exiv2::Internal::Rw2Header
Panasonic RW2 header structure.
Definition: rw2image_int.hpp:49
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::Image::imageType
int imageType() const
set type support for this image format
Definition: image.hpp:483
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:173
Exiv2::Image::io
virtual BasicIo & io() const
Return a reference to the BasicIo instance being used for Io.
Definition: image.cpp:731
image.hpp
Exiv2::ImageType::none
const int none
Not an image.
Definition: image.hpp:48
Exiv2::PreviewManager::getPreviewImage
PreviewImage getPreviewImage(const PreviewProperties &properties) const
Return the preview image for the given preview properties.
Definition: preview.cpp:1161
EXV_WARNING
#define EXV_WARNING
Shorthand for a temp warning log message object and return its ostringstream.
Definition: error.hpp:148
Exiv2::PreviewImage
Class that holds preview image properties and data buffer.
Definition: preview.hpp:73
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::newRw2Instance
EXIV2API Image::AutoPtr newRw2Instance(BasicIo::AutoPtr io, bool create)
Create a new Rw2Image instance and return an auto-pointer to it. Caller owns the returned object and ...
Definition: rw2image.cpp:247
Exiv2::ExifData::empty
bool empty() const
Return true if there is no Exif metadata.
Definition: exif.hpp:512
Exiv2::Image::AutoPtr
std::auto_ptr< Image > AutoPtr
Image auto_ptr type.
Definition: image.hpp:84
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::ImageType::rw2
const int rw2
RW2 image type (see class Rw2Image)
Definition: rw2image.hpp:45
Exiv2::string
@ string
IPTC string type.
Definition: types.hpp:147
Exiv2::Rw2Parser
Stateless parser class for data in RW2 format. Images use this class to decode and encode RW2 data....
Definition: rw2image.hpp:121
Exiv2::PrintStructureOption
PrintStructureOption
Options for printStructure.
Definition: image.hpp:67
Exiv2::PreviewManager
Class for extracting preview images from image metadata.
Definition: preview.hpp:168
Exiv2::Rw2Image::setIptcData
void setIptcData(const IptcData &iptcData)
Todo: Not supported yet, requires writeMetadata(). Calling this function will throw an Error(kerInval...
Definition: rw2image.cpp:86
Exiv2::BasicIo::seek
virtual int seek(long offset, Position pos)=0
Move the current IO position.
Exiv2::PreviewImage::size
uint32_t size() const
Return the size of the preview image in bytes.
Definition: preview.cpp:1102
Exiv2::ExifData::iterator
ExifMetadata::iterator iterator
ExifMetadata iterator type.
Definition: exif.hpp:437
Exiv2::BasicIo
An interface for simple binary IO.
Definition: basicio.hpp:55
Exiv2::Image::xmpData_
XmpData xmpData_
XMP data container.
Definition: image.hpp:490
rw2image.hpp
Class Rw2Image.
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::Rw2Image::pixelHeight
int pixelHeight() const
Return the pixel height of the image.
Definition: rw2image.cpp:70
futils.hpp
Basic file utility functions required by Exiv2.
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:1666
error.hpp
Error class for exceptions, log message class.
Exiv2::Image::exifData
virtual ExifData & exifData()
Returns an ExifData instance containing currently buffered Exif data.
Definition: image.cpp:559
tiffcomposite_int.hpp
Internal classes used in a TIFF composite structure.
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