Exiv2
gifimage.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 GIFIMAGE_HPP_
29 #define GIFIMAGE_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 GIF to the supported image formats
45  namespace ImageType {
46  const int gif = 11;
47  }
48 
53  class EXIV2API GifImage : public Image {
55 
56  GifImage(const GifImage& rhs);
59  GifImage& operator=(const GifImage& rhs);
61 
62  public:
64 
65 
77  explicit GifImage(BasicIo::AutoPtr io);
79 
81 
82  void readMetadata();
87  void writeMetadata();
92  void setExifData(const ExifData& exifData);
97  void setIptcData(const IptcData& iptcData);
102  void setComment(const std::string& comment);
104 
106 
107  std::string mimeType() const;
109 
110  }; // class GifImage
111 
112 // *****************************************************************************
113 // template, inline and free functions
114 
115  // These could be static private functions on Image subclasses but then
116  // ImageFactory needs to be made a friend.
122  EXIV2API Image::AutoPtr newGifInstance(BasicIo::AutoPtr io, bool create);
123 
125  EXIV2API bool isGifType(BasicIo& iIo, bool advance);
126 
127 } // namespace Exiv2
128 
129 #endif // #ifndef GIFIMAGE_HPP_
Exiv2::BasicIo::error
virtual int error() const =0
Returns 0 if the IO source is in a valid state, otherwise nonzero.
Exiv2::newGifInstance
EXIV2API Image::AutoPtr newGifInstance(BasicIo::AutoPtr io, bool create)
Create a new GifImage instance and return an auto-pointer to it. Caller owns the returned object and ...
Definition: gifimage.cpp:106
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::isGifType
EXIV2API bool isGifType(BasicIo &iIo, bool advance)
Check if the file iIo is a GIF image.
Definition: gifimage.cpp:116
Exiv2::comment
@ comment
Exiv2 type for the Exif user comment.
Definition: types.hpp:150
Exiv2::GifImage
Class to access raw GIF images. Exif/IPTC metadata are supported directly.
Definition: gifimage.hpp:53
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::gif
const int gif
GIF image type (see class GifImage)
Definition: gifimage.hpp:46
gifimage.hpp
GIF image, implemented using the following references: GIF89 specification by W3C
Exiv2::Image::pixelHeight_
int pixelHeight_
image pixel height
Definition: image.hpp:495
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
Exiv2::GifImage::mimeType
std::string mimeType() const
Return the MIME type of the image.
Definition: gifimage.cpp:49
Exiv2::getShort
EXIV2API int16_t getShort(const byte *buf, ByteOrder byteOrder)
Read a 2 byte signed short value from the data buffer.
Definition: types.cpp:318
Exiv2::Image::pixelWidth_
int pixelWidth_
image pixel width
Definition: image.hpp:494
Exiv2::GifImage::setComment
void setComment(const std::string &comment)
Not supported. Calling this function will throw an instance of Error(kerInvalidSettingForImage).
Definition: gifimage.cpp:66
Exiv2::GifImage::readMetadata
void readMetadata()
Read all metadata supported by a specific image format from the image. Before this method is called,...
Definition: gifimage.cpp:72
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::GifImage::setIptcData
void setIptcData(const IptcData &iptcData)
Todo: Not supported yet(?). Calling this function will throw an instance of Error(kerInvalidSettingFo...
Definition: gifimage.cpp:60
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::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::GifImage::setExifData
void setExifData(const ExifData &exifData)
Todo: Not supported yet(?). Calling this function will throw an instance of Error(kerInvalidSettingFo...
Definition: gifimage.cpp:54
Exiv2::string
@ string
IPTC string type.
Definition: types.hpp:147
Exiv2::GifImage::writeMetadata
void writeMetadata()
Todo: Write metadata back to the image. This method is not yet(?) implemented. Calling it will throw ...
Definition: gifimage.cpp:98
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
Abstract base class defining the interface for an image. This is the top-level interface to the Exiv2...
Definition: image.hpp:81
futils.hpp
Basic file utility functions required by Exiv2.
error.hpp
Error class for exceptions, log message class.
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