Exiv2
Loading...
Searching...
No Matches
bmpimage.hpp
Go to the documentation of this file.
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 */
27#ifndef BMPIMAGE_HPP_
28#define BMPIMAGE_HPP_
29
30// *****************************************************************************
31#include "exiv2lib_export.h"
32
33// included header files
34#include "image.hpp"
35
36// *****************************************************************************
37// namespace extensions
38namespace Exiv2 {
39
40// *****************************************************************************
41// class definitions
42
43 // Add Windows Bitmap (BMP) to the supported image formats
44 namespace ImageType {
45 const int bmp = 14;
46 }
47
52 class EXIV2API BmpImage : public Image {
54
55
56 BmpImage(const BmpImage& rhs);
58 BmpImage& operator=(const BmpImage& rhs);
60
61 public:
63
64
76 explicit BmpImage(BasicIo::AutoPtr io);
78
80
81 void readMetadata();
86 void writeMetadata();
91 void setExifData(const ExifData& exifData);
96 void setIptcData(const IptcData& iptcData);
101 void setComment(const std::string& comment);
103
105
106 std::string mimeType() const;
108
109 }; // class BmpImage
110
111// *****************************************************************************
112// template, inline and free functions
113
114 // These could be static private functions on Image subclasses but then
115 // ImageFactory needs to be made a friend.
121 EXIV2API Image::AutoPtr newBmpInstance(BasicIo::AutoPtr io, bool create);
122
124 EXIV2API bool isBmpType(BasicIo& iIo, bool advance);
125
126} // namespace Exiv2
127
128#endif // #ifndef BMPIMAGE_HPP_
An interface for simple binary IO.
Definition basicio.hpp:55
std::auto_ptr< BasicIo > AutoPtr
BasicIo auto_ptr type.
Definition basicio.hpp:58
void setComment(const std::string &comment)
Not supported. Calling this function will throw an instance of Error(kerInvalidSettingForImage).
Definition bmpimage.cpp:65
void writeMetadata()
Todo: Write metadata back to the image. This method is not yet(?) implemented. Calling it will throw ...
Definition bmpimage.cpp:115
void setIptcData(const IptcData &iptcData)
Todo: Not supported yet(?). Calling this function will throw an instance of Error(kerInvalidSettingFo...
Definition bmpimage.cpp:59
void setExifData(const ExifData &exifData)
Todo: Not supported yet(?). Calling this function will throw an instance of Error(kerInvalidSettingFo...
Definition bmpimage.cpp:53
std::string mimeType() const
Return the MIME type of the image.
Definition bmpimage.cpp:48
void readMetadata()
Read all metadata supported by a specific image format from the image. Before this method is called,...
Definition bmpimage.cpp:71
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
Supported image formats.
Definition asfvideo.hpp:42
const int bmp
Windows bitmap (bmp) image type (see class BmpImage).
Definition bmpimage.hpp:45
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of ...
Definition asfvideo.hpp:36
EXIV2API bool isBmpType(BasicIo &iIo, bool advance)
Check if the file iIo is a Windows Bitmap image.
Definition bmpimage.cpp:132
EXIV2API Image::AutoPtr newBmpInstance(BasicIo::AutoPtr io, bool create)
Create a new BmpImage instance and return an auto-pointer to it. Caller owns the returned object and ...
Definition bmpimage.cpp:123