Exiv2
Loading...
Searching...
No Matches
rw2image.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 RW2IMAGE_HPP_
21#define RW2IMAGE_HPP_
22
23// *****************************************************************************
24#include "exiv2lib_export.h"
25
26// included header files
27#include "image.hpp"
28
29// *****************************************************************************
30// namespace extensions
31namespace Exiv2 {
32
33// *****************************************************************************
34// class definitions
35
36 // Add RW2 to the supported image formats
37 namespace ImageType {
38 const int rw2 = 16;
39 }
40
46 class EXIV2API Rw2Image : public Image {
47 public:
49
50
64
66
67 void printStructure(std::ostream& out, PrintStructureOption option,int depth);
68 void readMetadata();
73 void writeMetadata();
78 void setExifData(const ExifData& exifData);
83 void setIptcData(const IptcData& iptcData);
88 void setComment(const std::string& comment);
90
92
93 std::string mimeType() const;
94 int pixelWidth() const;
95 int pixelHeight() const;
97
98 private:
100
101
102 Rw2Image(const Rw2Image& rhs);
104 Rw2Image& operator=(const Rw2Image& rhs);
106
107 }; // class Rw2Image
108
114 class EXIV2API Rw2Parser {
115 public:
121 static ByteOrder decode(
122 ExifData& exifData,
123 IptcData& iptcData,
124 XmpData& xmpData,
125 const byte* pData,
126 uint32_t size
127 );
128
129 }; // class Rw2Parser
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 newRw2Instance(BasicIo::AutoPtr io, bool create);
142
144 EXIV2API bool isRw2Type(BasicIo& iIo, bool advance);
145
146} // namespace Exiv2
147
148#endif // #ifndef RW2IMAGE_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
virtual std::string comment() const
Return a copy of the image comment. May be an empty string.
Definition image.cpp:742
std::auto_ptr< Image > AutoPtr
Image auto_ptr type.
Definition image.hpp:81
virtual BasicIo & io() const
Return a reference to the BasicIo instance being used for Io.
Definition image.cpp:752
virtual IptcData & iptcData()
Returns an IptcData instance containing currently buffered IPTC data.
Definition image.cpp:585
virtual ExifData & exifData()
Returns an ExifData instance containing currently buffered Exif data.
Definition image.cpp:580
Image(int imageType, uint16_t supportedMetadata, BasicIo::AutoPtr io)
Constructor taking the image type, a bitmap of the supported metadata types and an auto-pointer that ...
Definition image.cpp:167
A container for IPTC data. This is a top-level class of the Exiv2 library.
Definition iptc.hpp:170
void readMetadata()
Read all metadata supported by a specific image format from the image. Before this method is called,...
Definition rw2image.cpp:107
int pixelHeight() const
Return the pixel height of the image.
Definition rw2image.cpp:64
void setExifData(const ExifData &exifData)
Todo: Not supported yet, requires writeMetadata(). Calling this function will throw an Error(kerInval...
Definition rw2image.cpp:74
Rw2Image(BasicIo::AutoPtr io)
Constructor to open an existing RW2 image. Since the constructor can not return a result,...
Definition rw2image.cpp:44
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:86
void setIptcData(const IptcData &iptcData)
Todo: Not supported yet, requires writeMetadata(). Calling this function will throw an Error(kerInval...
Definition rw2image.cpp:80
int pixelWidth() const
Return the pixel width of the image.
Definition rw2image.cpp:54
std::string mimeType() const
Return the MIME type of the image.
Definition rw2image.cpp:49
void writeMetadata()
Todo: Write metadata back to the image. This method is not yet implemented. Calling it will throw an ...
Definition rw2image.cpp:214
void printStructure(std::ostream &out, PrintStructureOption option, int depth)
Print out the structure of image file.
Definition rw2image.cpp:92
Stateless parser class for data in RW2 format. Images use this class to decode and encode RW2 data....
Definition rw2image.hpp:114
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:220
A container for XMP data. This is a top-level class of the Exiv2 library.
Definition xmp_exiv2.hpp:166
Supported image formats.
Definition asfvideo.hpp:42
const int rw2
RW2 image type (see class Rw2Image).
Definition rw2image.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 isRw2Type(BasicIo &iIo, bool advance)
Check if the file iIo is a RW2 image.
Definition rw2image.cpp:250
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:241
ByteOrder
Type to express the byte order (little or big endian).
Definition types.hpp:102