A standard TIFF IFD entry consisting of a value which is an array of offsets to image data areas. The sizes of the image data areas are provided in a related TiffSizeEntry, tag and group of which are set in the constructor. More...

#include <tiffcomposite_int.hpp>

Inheritance diagram for Exiv2::Internal::TiffImageEntry:

[legend]

Public Member Functions
Manipulators
void	setStrips (const Value pSize, const byte pData, size_t sizeData, size_t baseOffset) override
	Set the data areas ("strips").

Public Member Functions inherited from Exiv2::Internal::TiffDataEntryBase
	TiffDataEntryBase (uint16_t tag, IfdId group, uint16_t szTag, IfdId szGroup)
	Constructor.

uint16_t	szTag () const
	Return the group of the entry which has the size.

IfdId	szGroup () const
	Return the group of the entry which has the size.

Public Member Functions inherited from Exiv2::Internal::TiffEntryBase
constexpr	TiffEntryBase (uint16_t tag, IfdId group, TiffType tiffType=ttUndefined)
	Default constructor.

	~TiffEntryBase () override=default
	Virtual destructor.

TiffEntryBase &	operator= (const TiffEntryBase &)=delete
	Assignment operator.

void	encode (TiffEncoder &encoder, const Exifdatum *datum)
	Encode a TIFF component from the metadatum provided and information from the encoder as needed.

void	setOffset (size_t offset)
	Set the offset.

void	setData (byte *pData, size_t size, std::shared_ptr< DataBuf > storage)
	Set pointer and size of the entry's data (not taking ownership of the data).

void	setData (std::shared_ptr< DataBuf > buf)
	Set the entry's data buffer. A shared_ptr is used to manage the DataBuf because TiffEntryBase has a clone method so it is possible (in theory) for the DataBuf to have multiple owners.

void	updateValue (Value::UniquePtr value, ByteOrder byteOrder)
	Update the value. Takes ownership of the pointer passed in.

void	setValue (Value::UniquePtr value)
	Set tag value. Takes ownership of the pointer passed in.

TiffType	tiffType () const
	Return the TIFF type.

size_t	offset () const
	Return the offset to the data area relative to the base for the component (usually the start of the TIFF header)

int	idx () const override
	Return the unique id of the entry in the image.

const byte *	pData () const
	Return a pointer to the binary representation of the value of this component.

const Value *	pValue () const
	Return a const pointer to the converted value of this component.

Public Member Functions inherited from Exiv2::Internal::TiffComponent
constexpr	TiffComponent (uint16_t tag, IfdId group)
	Constructor.

virtual	~TiffComponent ()=default
	Virtual destructor.

	TiffComponent (const TiffComponent &)=default

TiffComponent &	operator= (const TiffComponent &)=default

TiffComponent *	addPath (uint16_t tag, TiffPath &tiffPath, TiffComponent *pRoot, UniquePtr object=nullptr)
	Add a TIFF entry tag to the component. Components on the path to the entry are added if they don't exist yet.

TiffComponent *	addChild (UniquePtr tiffComponent)
	Add a child to the component. Default is to do nothing.

TiffComponent *	addNext (UniquePtr tiffComponent)
	Add a "next" component to the component. Default is to do nothing.

void	accept (TiffVisitor &visitor)
	Interface to accept visitors (Visitor pattern). Visitors can perform operations on all components of the composite.

void	setStart (const byte *pStart)
	Set a pointer to the start of the binary representation of the component in a memory buffer. The buffer must be allocated and freed outside of this class.

size_t	write (IoWrapper &ioWrapper, ByteOrder byteOrder, size_t offset, size_t valueIdx, size_t dataIdx, size_t &imageIdx)
	Write a TiffComponent to a binary image.

uint16_t	tag () const
	Return the tag of this entry.

IfdId	group () const
	Return the group id of this component.

byte *	start () const
	Return a pointer to the start of the binary representation of the component.

UniquePtr	clone () const
	Return an auto-pointer to a copy of itself (deep copy, but without any children). The caller owns this copy and the auto-pointer ensures that it will be deleted.

size_t	writeData (IoWrapper &ioWrapper, ByteOrder byteOrder, size_t offset, size_t dataIdx, size_t &imageIdx) const
	Write the IFD data of this component to a binary image. Return the number of bytes written. Components derived from TiffEntryBase implement this method if needed.

size_t	writeImage (IoWrapper &ioWrapper, ByteOrder byteOrder) const
	Write the image data of this component to a binary image. Return the number of bytes written. TIFF components implement this method if needed.

size_t	size () const
	Return the size in bytes of the IFD value of this component when written to a binary image.

size_t	count () const
	Return the number of components in this component.

size_t	sizeData () const
	Return the size in bytes of the IFD data of this component when written to a binary image. This is a support function for write(). Components derived from TiffEntryBase implement this method corresponding to their implementation of writeData().

size_t	sizeImage () const
	Return the size in bytes of the image data of this component when written to a binary image. This is a support function for write(). TIFF components implement this method corresponding to their implementation of writeImage().

Protected Member Functions
Protected Manipulators
void	doAccept (TiffVisitor &visitor) override
	Implements accept().

void	doEncode (TiffEncoder &encoder, const Exifdatum *datum) override
	Implements encode().

size_t	doWrite (IoWrapper &ioWrapper, ByteOrder byteOrder, size_t offset, size_t valueIdx, size_t dataIdx, size_t &imageIdx) override
	Implements write(). Write pointers into the image data area to the ioWrapper. Return the number of bytes written. The valueIdx and dataIdx arguments are not used.

Protected Member Functions inherited from Exiv2::Internal::TiffEntryBase
	TiffEntryBase (const TiffEntryBase &rhs)
	Copy constructor (used to implement clone()).

void	setCount (size_t count)
	Set the number of components in this entry.

void	setIdx (int idx)
	Set the unique id of the entry in the image.

size_t	doCount () const override
	Implements count().

std::shared_ptr< DataBuf >	storage () const
	Used (internally) to create another reference to the DataBuf reference by storage_.

Protected Member Functions inherited from Exiv2::Internal::TiffComponent
virtual TiffComponent *	doAddPath (uint16_t tag, TiffPath &tiffPath, TiffComponent *pRoot, TiffComponent::UniquePtr object)
	Implements addPath(). The default implementation does nothing.

virtual TiffComponent *	doAddChild (UniquePtr tiffComponent)
	Implements addChild(). The default implementation does nothing.

virtual TiffComponent *	doAddNext (UniquePtr tiffComponent)
	Implements addNext(). The default implementation does nothing.

Friends
class	TiffEncoder

Protected Accessors
TiffImageEntry *	doClone () const override
	Internal virtual copy constructor, implements clone().

size_t	doWriteData (IoWrapper &ioWrapper, ByteOrder byteOrder, size_t offset, size_t dataIdx, size_t &imageIdx) const override
	Implements writeData(). Write the image data area to the ioWrapper. Return the number of bytes written.

size_t	doWriteImage (IoWrapper &ioWrapper, ByteOrder byteOrder) const override
	Implements writeImage(). Write the image data area to the ioWrapper. Return the number of bytes written.

size_t	doSize () const override
	Implements size(). Return the size of the strip pointers.

size_t	doSizeData () const override
	Implements sizeData(). Return the size of the image data area.

size_t	doSizeImage () const override
	Implements sizeImage(). Return the size of the image data area.

Additional Inherited Members
Public Types inherited from Exiv2::Internal::TiffComponent
using	UniquePtr = std::unique_ptr< TiffComponent >
	TiffComponent auto_ptr type.

using	Components = std::vector< UniquePtr >
	Container type to hold all metadata.

Static Protected Member Functions inherited from Exiv2::Internal::TiffEntryBase
static size_t	writeOffset (byte *buf, size_t offset, TiffType tiffType, ByteOrder byteOrder)
	Helper function to write an offset to a preallocated binary buffer.

Detailed Description

A standard TIFF IFD entry consisting of a value which is an array of offsets to image data areas. The sizes of the image data areas are provided in a related TiffSizeEntry, tag and group of which are set in the constructor.

The data is not extracted into the higher level metadata tags, it is only copied to the target image when the image is written. This component is used, e.g., for Exif.Image.StripOffsets for which the sizes are provided in Exif.Image.StripByteCounts.

Member Function Documentation

◆ doAccept()

void Exiv2::Internal::TiffImageEntry::doAccept ( TiffVisitor & visitor )

overrideprotectedvirtual

Implements accept().

Implements Exiv2::Internal::TiffComponent.

References Exiv2::Internal::TiffVisitor::visitImageEntry().

◆ doClone()

TiffImageEntry * Exiv2::Internal::TiffImageEntry::doClone ( ) const

overrideprotectedvirtual

Internal virtual copy constructor, implements clone().

Implements Exiv2::Internal::TiffComponent.

◆ doEncode()

void Exiv2::Internal::TiffImageEntry::doEncode	(	TiffEncoder &	encoder,
		const Exifdatum *	datum
	)

overrideprotectedvirtual

Implements encode().

Implements Exiv2::Internal::TiffEntryBase.

References Exiv2::Internal::TiffEncoder::encodeImageEntry().

◆ doSize()

size_t Exiv2::Internal::TiffImageEntry::doSize ( ) const

overrideprotectedvirtual

Implements size(). Return the size of the strip pointers.

Reimplemented from Exiv2::Internal::TiffEntryBase.

◆ doSizeData()

size_t Exiv2::Internal::TiffImageEntry::doSizeData ( ) const

overrideprotectedvirtual

Implements sizeData(). Return the size of the image data area.

Reimplemented from Exiv2::Internal::TiffEntryBase.

References Exiv2::Internal::TiffComponent::group(), and Exiv2::Internal::TiffComponent::sizeImage().

◆ doSizeImage()

size_t Exiv2::Internal::TiffImageEntry::doSizeImage ( ) const

overrideprotectedvirtual

Implements sizeImage(). Return the size of the image data area.

Reimplemented from Exiv2::Internal::TiffEntryBase.

References Exiv2::Internal::TiffEntryBase::pValue(), and Exiv2::Value::sizeDataArea().

◆ doWrite()

size_t Exiv2::Internal::TiffImageEntry::doWrite	(	IoWrapper &	ioWrapper,
		ByteOrder	byteOrder,
		size_t	offset,
		size_t	valueIdx,
		size_t	dataIdx,
		size_t &	imageIdx
	)

overrideprotectedvirtual

Implements write(). Write pointers into the image data area to the ioWrapper. Return the number of bytes written. The valueIdx and dataIdx arguments are not used.

Reimplemented from Exiv2::Internal::TiffEntryBase.

References Safe::add(), Exiv2::DataBuf::c_data(), Exiv2::DataBuf::data(), Exiv2::Internal::TiffComponent::group(), Exiv2::Internal::groupName(), Exiv2::Internal::TiffEntryBase::idx(), Exiv2::Internal::TiffEntryBase::offset(), Exiv2::Internal::TiffComponent::tag(), Exiv2::Internal::TiffEntryBase::tiffType(), Exiv2::Internal::IoWrapper::write(), and Exiv2::Internal::TiffEntryBase::writeOffset().

◆ doWriteData()

size_t Exiv2::Internal::TiffImageEntry::doWriteData	(	IoWrapper &	ioWrapper,
		ByteOrder	byteOrder,
		size_t	offset,
		size_t	dataIdx,
		size_t &	imageIdx
	)		const

overrideprotectedvirtual

Implements writeData(). Write the image data area to the ioWrapper. Return the number of bytes written.

This function writes the image data to the data area of the current directory. It is used for TIFF image entries in the makernote (large preview images) so that the image data remains in the makernote IFD.

Reimplemented from Exiv2::Internal::TiffEntryBase.

References Exiv2::Internal::TiffComponent::group(), and Exiv2::Internal::TiffComponent::writeImage().

◆ doWriteImage()

size_t Exiv2::Internal::TiffImageEntry::doWriteImage	(	IoWrapper &	ioWrapper,
		ByteOrder	byteOrder
	)		const

overrideprotectedvirtual

Implements writeImage(). Write the image data area to the ioWrapper. Return the number of bytes written.

Reimplemented from Exiv2::Internal::TiffEntryBase.

References Exiv2::DataBuf::c_data(), Exiv2::Value::dataArea(), Exiv2::Internal::TiffComponent::group(), Exiv2::Internal::groupName(), Exiv2::Internal::IoWrapper::putb(), Exiv2::Internal::TiffEntryBase::pValue(), Exiv2::Value::sizeDataArea(), Exiv2::Internal::TiffComponent::tag(), and Exiv2::Internal::IoWrapper::write().

◆ setStrips()

void Exiv2::Internal::TiffImageEntry::setStrips	(	const Value *	pSize,
		const byte *	pData,
		size_t	sizeData,
		size_t	baseOffset
	)

overridevirtual

Set the data areas ("strips").

Parameters

pSize	Pointer to the Value holding the sizes corresponding to this data entry.
pData	Pointer to the data area.
sizeData	Size of the data area.
baseOffset	Base offset into the data area.

Implements Exiv2::Internal::TiffDataEntryBase.

References Exiv2::Internal::TiffComponent::count(), Exiv2::Value::count(), EXV_WARNING, Exiv2::Internal::TiffComponent::group(), Exiv2::Internal::groupName(), Exiv2::Internal::TiffEntryBase::offset(), Exiv2::Internal::TiffEntryBase::pData(), Exiv2::Internal::TiffEntryBase::pValue(), Exiv2::Internal::TiffComponent::size(), Exiv2::Internal::TiffComponent::sizeData(), Exiv2::Internal::TiffComponent::tag(), and Exiv2::Value::toUint32().

The documentation for this class was generated from the following files:

tiffcomposite_int.hpp
tiffcomposite_int.cpp

Public Member Functions

Protected Member Functions

Friends

Protected Accessors

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ doAccept()

◆ doClone()

◆ doEncode()

◆ doSize()

◆ doSizeData()

◆ doSizeImage()

◆ doWrite()

◆ doWriteData()

◆ doWriteImage()

◆ setStrips()