Exiv2
Loading...
Searching...
No Matches
rafimage.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 RAFIMAGE_HPP_
21#define RAFIMAGE_HPP_
22
23// *****************************************************************************
24#include "exiv2lib_export.h"
25
26// included header files
27#include "image.hpp"
28#include "basicio.hpp"
29#include "types.hpp"
30
31// + standard includes
32#include <string>
33
34// *****************************************************************************
35// namespace extensions
36namespace Exiv2 {
37
38// *****************************************************************************
39// class definitions
40
41 // Add RAF to the supported image formats
42 namespace ImageType {
43 const int raf = 8;
44 }
45
50 class EXIV2API RafImage : public Image {
51 public:
53
54
69 RafImage(BasicIo::AutoPtr io, bool create);
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
109 RafImage(const RafImage& rhs);
111 RafImage& operator=(const RafImage& rhs);
113
114 }; // class RafImage
115
116// *****************************************************************************
117// template, inline and free functions
118
119 // These could be static private functions on Image subclasses but then
120 // ImageFactory needs to be made a friend.
126 EXIV2API Image::AutoPtr newRafInstance(BasicIo::AutoPtr io, bool create);
127
129 EXIV2API bool isRafType(BasicIo& iIo, bool advance);
130
131} // namespace Exiv2
132
133#endif // #ifndef RAFIMAGE_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 setExifData(const ExifData &exifData)
Todo: Not supported yet, requires writeMetadata(). Calling this function will throw an Error(kerInval...
Definition rafimage.cpp:72
void writeMetadata()
Todo: Write metadata back to the image. This method is not yet implemented. Calling it will throw an ...
Definition rafimage.cpp:391
void printStructure(std::ostream &out, PrintStructureOption option, int depth)
Print out the structure of image file.
Definition rafimage.cpp:90
void readMetadata()
Read all metadata supported by a specific image format from the image. Before this method is called,...
Definition rafimage.cpp:300
int pixelHeight() const
Return the pixel height of the image.
Definition rafimage.cpp:63
void setComment(const std::string &comment)
Not supported. RAF format does not contain a comment. Calling this function will throw an Error(kerIn...
Definition rafimage.cpp:84
std::string mimeType() const
Return the MIME type of the image.
Definition rafimage.cpp:49
RafImage(BasicIo::AutoPtr io, bool create)
Constructor that can either open an existing RAF image or create a new image from scratch....
Definition rafimage.cpp:44
int pixelWidth() const
Return the pixel width of the image.
Definition rafimage.cpp:54
void setIptcData(const IptcData &iptcData)
Todo: Not supported yet, requires writeMetadata(). Calling this function will throw an Error(kerInval...
Definition rafimage.cpp:78
Supported image formats.
Definition asfvideo.hpp:42
const int raf
RAF image type (see class RafImage).
Definition rafimage.hpp:43
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 isRafType(BasicIo &iIo, bool advance)
Check if the file iIo is a RAF image.
Definition rafimage.cpp:408
EXIV2API Image::AutoPtr newRafInstance(BasicIo::AutoPtr io, bool create)
Create a new RafImage instance and return an auto-pointer to it. Caller owns the returned object and ...
Definition rafimage.cpp:399