| Exiv2

Loading...
Searching...
No Matches
tiffimage.hpp
1// SPDX-License-Identifier: GPL-2.0-or-later
2
3#ifndef TIFFIMAGE_HPP_
4#define TIFFIMAGE_HPP_
5
6// *****************************************************************************
7#include "exiv2lib_export.h"
8
9// included header files
10#include "image.hpp"
11
12// *****************************************************************************
13// namespace extensions
14 namespace Exiv2 {
15// *****************************************************************************
16// class definitions
17
22 class EXIV2API TiffImage : public Image {
23 public:
25
26
41 TiffImage(BasicIo::UniquePtr io, bool create);
43
45
46 void readMetadata() override;
47 void writeMetadata() override;
48
55 void printStructure(std::ostream& out, PrintStructureOption option, size_t depth) override;
56
61 void setComment(const std::string&) override;
63
65
66 std::string mimeType() const override;
67 uint32_t pixelWidth() const override;
68 uint32_t pixelHeight() const override;
70
71 private:
73
74
75 std::string primaryGroup() const;
77
78 // DATA
79 mutable std::string primaryGroup_;
80 mutable std::string mimeType_;
81 mutable uint32_t pixelWidthPrimary_{0};
82 mutable uint32_t pixelHeightPrimary_{0};
83
84}; // class TiffImage
85
91 class EXIV2API TiffParser {
92 public:
106 static ByteOrder decode(ExifData& exifData, IptcData& iptcData, XmpData& xmpData, const byte* pData, size_t size);
140 static WriteMethod encode(BasicIo& io, const byte* pData, size_t size, ByteOrder byteOrder, ExifData& exifData,
141 IptcData& iptcData, XmpData& xmpData);
142
143}; // class TiffParser
144
145// *****************************************************************************
146// template, inline and free functions
147
148// These could be static private functions on Image subclasses but then
149// ImageFactory needs to be made a friend.
155EXIV2API Image::UniquePtr newTiffInstance(BasicIo::UniquePtr io, bool create);
156
158EXIV2API bool isTiffType(BasicIo& iIo, bool advance);
159
160} // namespace Exiv2
161
162#endif // #ifndef TIFFIMAGE_HPP_
Exiv2::BasicIo
An interface for simple binary IO.
Definition basicio.hpp:35
Exiv2::BasicIo::UniquePtr
std::unique_ptr< BasicIo > UniquePtr
BasicIo auto_ptr type.
Definition basicio.hpp:38
Exiv2::ExifData
A container for Exif data. This is a top-level class of the Exiv2 library. The container holds Exifda...
Definition exif.hpp:379
Exiv2::Image::Image
Image(ImageType type, uint16_t supportedMetadata, BasicIo::UniquePtr io)
Constructor taking the image type, a bitmap of the supported metadata types and an auto-pointer that ...
Definition image.cpp:132
Exiv2::Image::io
virtual BasicIo & io() const
Return a reference to the BasicIo instance being used for Io.
Definition image.cpp:696
Exiv2::Image::UniquePtr
std::unique_ptr< Image > UniquePtr
Image auto_ptr type.
Definition image.hpp:53
Exiv2::IptcData
A container for IPTC data. This is a top-level class of the Exiv2 library.
Definition iptc.hpp:153
Exiv2::TiffImage::readMetadata
void readMetadata() override
Read all metadata supported by a specific image format from the image. Before this method is called,...
Definition tiffimage.cpp:131
Exiv2::TiffImage::writeMetadata
void writeMetadata() override
Write metadata back to the image.
Definition tiffimage.cpp:164
Exiv2::TiffImage::TiffImage
TiffImage(BasicIo::UniquePtr io, bool create)
Constructor that can either open an existing TIFF image or create a new image from scratch....
Definition tiffimage.cpp:41
Exiv2::TiffImage::mimeType
std::string mimeType() const override
Return the MIME type of the image.
Definition tiffimage.cpp:59
Exiv2::TiffImage::pixelHeight
uint32_t pixelHeight() const override
Return the pixel height of the image.
Definition tiffimage.cpp:113
Exiv2::TiffImage::pixelWidth
uint32_t pixelWidth() const override
Return the pixel width of the image.
Definition tiffimage.cpp:100
Exiv2::TiffImage::printStructure
void printStructure(std::ostream &out, PrintStructureOption option, size_t depth) override
Print out the structure of image file.
Definition tiffimage.cpp:262
Exiv2::TiffImage::setComment
void setComment(const std::string &) override
Not supported. TIFF format does not contain a comment. Calling this function will throw an Error(Erro...
Definition tiffimage.cpp:126
Exiv2::TiffParser
Stateless parser class for data in TIFF format. Images use this class to decode and encode TIFF data....
Definition tiffimage.hpp:91
Exiv2::TiffParser::encode
static WriteMethod encode(BasicIo &io, const byte *pData, size_t size, ByteOrder byteOrder, ExifData &exifData, IptcData &iptcData, XmpData &xmpData)
Encode metadata from the provided metadata to TIFF format.
Definition tiffimage.cpp:219
Exiv2::TiffParser::decode
static ByteOrder decode(ExifData &exifData, IptcData &iptcData, XmpData &xmpData, const byte *pData, size_t size)
Decode metadata from a buffer pData of length size with data in TIFF format to the provided metadata ...
Definition tiffimage.cpp:207
Exiv2::XmpData
A container for XMP data. This is a top-level class of the Exiv2 library.
Definition xmp_exiv2.hpp:138
Exiv2
Class CrwImage to access Canon CRW images. References: The Canon RAW (CRW) File Format by Phil Harv...
Definition asfvideo.hpp:15
Exiv2::newTiffInstance
EXIV2API Image::UniquePtr newTiffInstance(BasicIo::UniquePtr io, bool create)
Create a new TiffImage instance and return an auto-pointer to it. Caller owns the returned object and...
Definition tiffimage.cpp:239
Exiv2::PrintStructureOption
PrintStructureOption
Options for printStructure.
Definition image.hpp:38
Exiv2::isTiffType
EXIV2API bool isTiffType(BasicIo &iIo, bool advance)
Check if the file iIo is a TIFF image.
Definition tiffimage.cpp:247
Exiv2::ByteOrder
ByteOrder
Type to express the byte order (little or big endian).
Definition types.hpp:34
Exiv2::WriteMethod
WriteMethod
Type to indicate write method used by TIFF parsers.
Definition types.hpp:41