Class to access RIFF video files. More...

#include <riffvideo.hpp>

Inheritance diagram for Exiv2::RiffVideo:

Public Member Functions
Creators
	RiffVideo (BasicIo::AutoPtr io)
	Constructor for a Riff video. Since the constructor can not return a result, callers should check the good() method after object construction to determine success or failure. More...

Manipulators
void	printStructure (std::ostream &out, PrintStructureOption option, int depth)
	Print out the structure of image file. More...

void	readMetadata ()
	Read all metadata supported by a specific image format from the image. Before this method is called, the image metadata will be cleared. More...

void	writeMetadata ()
	Write metadata back to the image. More...

Public Member Functions inherited from Exiv2::Image
	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 owns an IO instance. See subclass constructor doc.

virtual	~Image ()
	Virtual Destructor.

virtual void	setExifData (const ExifData &exifData)
	Assign new Exif data. The new Exif data is not written to the image until the writeMetadata() method is called. More...

virtual void	clearExifData ()
	Erase any buffered Exif data. Exif data is not removed from the actual image until the writeMetadata() method is called.

virtual void	setIptcData (const IptcData &iptcData)
	Assign new IPTC data. The new IPTC data is not written to the image until the writeMetadata() method is called. More...

virtual void	clearIptcData ()
	Erase any buffered IPTC data. IPTC data is not removed from the actual image until the writeMetadata() method is called.

virtual void	setXmpPacket (const std::string &xmpPacket)
	Assign a raw XMP packet. The new XMP packet is not written to the image until the writeMetadata() method is called. More...

virtual void	clearXmpPacket ()
	Erase the buffered XMP packet. XMP data is not removed from the actual image until the writeMetadata() method is called. More...

virtual void	setXmpData (const XmpData &xmpData)
	Assign new XMP data. The new XMP data is not written to the image until the writeMetadata() method is called. More...

virtual void	clearXmpData ()
	Erase any buffered XMP data. XMP data is not removed from the actual image until the writeMetadata() method is called. More...

virtual void	setComment (const std::string &comment)
	Set the image comment. The new comment is not written to the image until the writeMetadata() method is called. More...

virtual void	clearComment ()
	Erase any buffered comment. Comment is not removed from the actual image until the writeMetadata() method is called.

virtual void	setIccProfile (DataBuf &iccProfile, bool bTestValid=true)
	Set the image iccProfile. The new profile is not written to the image until the writeMetadata() method is called. More...

virtual void	clearIccProfile ()
	Erase iccProfile. the profile is not removed from the actual image until the writeMetadata() method is called.

virtual bool	iccProfileDefined ()
	Erase iccProfile. the profile is not removed from the actual image until the writeMetadata() method is called.

virtual DataBuf *	iccProfile ()
	return iccProfile

virtual void	setMetadata (const Image &image)
	Copy all existing metadata from source Image. The data is copied into internal buffers and is not written to the image until the writeMetadata() method is called. More...

virtual void	clearMetadata ()
	Erase all buffered metadata. Metadata is not removed from the actual image until the writeMetadata() method is called.

virtual ExifData &	exifData ()
	Returns an ExifData instance containing currently buffered Exif data. More...

virtual IptcData &	iptcData ()
	Returns an IptcData instance containing currently buffered IPTC data. More...

virtual XmpData &	xmpData ()
	Returns an XmpData instance containing currently buffered XMP data. More...

virtual std::string &	xmpPacket ()
	Return a modifiable reference to the raw XMP packet.

void	writeXmpFromPacket (bool flag)
	Determine the source when writing XMP. More...

void	setByteOrder (ByteOrder byteOrder)
	Set the byte order to encode the Exif metadata in. More...

void	printTiffStructure (BasicIo &io, std::ostream &out, PrintStructureOption option, int depth, size_t offset=0)
	Print out the structure of image file. More...

void	printIFDStructure (BasicIo &io, std::ostream &out, Exiv2::PrintStructureOption option, uint32_t start, bool bSwap, char c, int depth)
	Print out the structure of a TIFF IFD.

bool	isBigEndianPlatform ()
	is the host platform bigEndian

bool	isLittleEndianPlatform ()
	is the host platform littleEndian

bool	isStringType (uint16_t type)

bool	isShortType (uint16_t type)

bool	isLongType (uint16_t type)

bool	isLongLongType (uint16_t type)

bool	isRationalType (uint16_t type)

bool	is2ByteType (uint16_t type)

bool	is4ByteType (uint16_t type)

bool	is8ByteType (uint16_t type)

bool	isPrintXMP (uint16_t type, Exiv2::PrintStructureOption option)

bool	isPrintICC (uint16_t type, Exiv2::PrintStructureOption option)

uint64_t	byteSwap (uint64_t value, bool bSwap) const

uint32_t	byteSwap (uint32_t value, bool bSwap) const

uint16_t	byteSwap (uint16_t value, bool bSwap) const

uint16_t	byteSwap2 (const DataBuf &buf, size_t offset, bool bSwap) const

uint32_t	byteSwap4 (const DataBuf &buf, size_t offset, bool bSwap) const

uint64_t	byteSwap8 (const DataBuf &buf, size_t offset, bool bSwap) const

ByteOrder	byteOrder () const
	Return the byte order in which the Exif metadata of the image is encoded. Initially, it is not set (invalidByteOrder).

bool	good () const
	Check if the Image instance is valid. Use after object construction. More...

virtual int	pixelWidth () const
	Return the pixel width of the image.

virtual int	pixelHeight () const
	Return the pixel height of the image.

virtual const ExifData &	exifData () const
	Returns an ExifData instance containing currently buffered Exif data. More...

virtual const IptcData &	iptcData () const
	Returns an IptcData instance containing currently buffered IPTC data. More...

virtual const XmpData &	xmpData () const
	Returns an XmpData instance containing currently buffered XMP data. More...

virtual std::string	comment () const
	Return a copy of the image comment. May be an empty string.

virtual const std::string &	xmpPacket () const
	Return the raw XMP packet as a string.

virtual BasicIo &	io () const
	Return a reference to the BasicIo instance being used for Io. More...

AccessMode	checkMode (MetadataId metadataId) const
	Returns the access mode, i.e., the metadata functions, which this image supports for the metadata type metadataId. More...

bool	supportsMetadata (MetadataId metadataId) const
	Check if image supports a particular type of metadata. This method is deprecated. Use checkMode() instead.

bool	writeXmpFromPacket () const
	Return the flag indicating the source when writing XMP metadata.

const NativePreviewList &	nativePreviews () const
	Return list of native previews. This is meant to be used only by the PreviewManager.

void	setTypeSupported (int imageType, uint16_t supportedMetadata)
	set type support for this image format

int	imageType () const
	set type support for this image format

Accessors
std::string	mimeType () const
	Return the MIME type of the image. More...

const char *	printAudioEncoding (uint64_t i)

void	decodeBlock ()
	Check for a valid tag and decode the block at the current IO position. Calls tagDecoder() or skips to next tag, if required.

void	tagDecoder (Exiv2::DataBuf &buf, unsigned long size)
	Interpret tag information, and call the respective function to save it in the respective XMP container. Decodes a Tag Information and saves it in the respective XMP container, if the block size is small. More...

void	junkHandler (long size)
	Interpret Junk tag information, and save it in the respective XMP container. More...

void	streamHandler (long size)
	Interpret Stream tag information, and save it in the respective XMP container. More...

void	streamFormatHandler (long size)
	Interpret Stream Format tag information, and save it in the respective XMP container. More...

void	aviHeaderTagsHandler (long size)
	Interpret Riff Header tag information, and save it in the respective XMP container. More...

void	listHandler (long size)
	Interpret Riff List tag information, and save it in the respective XMP container. More...

void	streamDataTagHandler (long size)
	Interpret Riff Stream Data tag information, and save it in the respective XMP container. More...

void	infoTagsHandler ()
	Interpret INFO tag information, and save it in the respective XMP container.

void	nikonTagsHandler ()
	Interpret Nikon Tags related to Video information, and save it in the respective XMP container.

void	odmlTagsHandler ()
	Interpret OpenDML tag information, and save it in the respective XMP container.

void	skipListData ()
	Skips Particular Blocks of Metadata List.

void	dateTimeOriginal (long size, int i=0)
	Interprets DateTimeOriginal tag or stream name tag information, and save it in the respective XMP container. More...

double	returnSampleRate (Exiv2::DataBuf &buf, long divisor=1)
	Calculates Sample Rate of a particular stream. More...

void	fillAspectRatio (long width=1, long height=1)
	Calculates Aspect Ratio of a video, and stores it in the respective XMP container. More...

void	fillDuration (double frame_rate, long frame_count)
	Calculates Duration of a video, and stores it in the respective XMP container. More...

Additional Inherited Members
Public Types inherited from Exiv2::Image
typedef std::auto_ptr< Image >	AutoPtr
	Image auto_ptr type.

Protected Member Functions inherited from Exiv2::Image
const std::string &	tagName (uint16_t tag)
	Return tag name for given tag id.

const char *	typeName (uint16_t tag) const
	Return tag type for given tag id.

Protected Attributes inherited from Exiv2::Image
BasicIo::AutoPtr	io_
	Image data IO pointer.

ExifData	exifData_
	Exif data container.

IptcData	iptcData_
	IPTC data container.

XmpData	xmpData_
	XMP data container.

DataBuf	iccProfile_
	ICC buffer (binary data)

std::string	comment_
	User comment.

std::string	xmpPacket_
	XMP packet.

int	pixelWidth_
	image pixel width

int	pixelHeight_
	image pixel height

NativePreviewList	nativePreviews_
	list of native previews

Detailed Description

Class to access RIFF video files.

Constructor & Destructor Documentation

◆ RiffVideo()

Exiv2::RiffVideo::RiffVideo ( BasicIo::AutoPtr io )

Constructor for a Riff video. Since the constructor can not return a result, callers should check the good() method after object construction to determine success or failure.

Parameters

io An auto-pointer that owns a BasicIo instance used for reading and writing image metadata. Important: The constructor takes ownership of the passed in BasicIo instance through the auto-pointer. Callers should not continue to use the BasicIo instance after it is passed to this method. Use the Image::io() method to get a temporary reference.

Member Function Documentation

◆ aviHeaderTagsHandler()

void Exiv2::RiffVideo::aviHeaderTagsHandler ( long size )

protected

Interpret Riff Header tag information, and save it in the respective XMP container.

Parameters

size	Size of the data block used to store Tag Information.

◆ dateTimeOriginal()

void Exiv2::RiffVideo::dateTimeOriginal	(	long	size,
		int	i = `0`
	)

protected

Interprets DateTimeOriginal tag or stream name tag information, and save it in the respective XMP container.

Parameters

size	Size of the data block used to store Tag Information.
i	parameter used to overload function

◆ fillAspectRatio()

void Exiv2::RiffVideo::fillAspectRatio	(	long	width = `1`,
		long	height = `1`
	)

protected

Calculates Aspect Ratio of a video, and stores it in the respective XMP container.

Parameters

width	Width of the video.
height	Height of the video.

◆ fillDuration()

void Exiv2::RiffVideo::fillDuration	(	double	frame_rate,
		long	frame_count
	)

protected

Calculates Duration of a video, and stores it in the respective XMP container.

Parameters

frame_rate	Frame rate of the video.
frame_count	Total number of frames present in the video.

◆ junkHandler()

void Exiv2::RiffVideo::junkHandler ( long size )

protected

Interpret Junk tag information, and save it in the respective XMP container.

Parameters

size	Size of the data block used to store Tag Information.

◆ listHandler()

void Exiv2::RiffVideo::listHandler ( long size )

protected

Interpret Riff List tag information, and save it in the respective XMP container.

Parameters

size	Size of the data block used to store Tag Information.

◆ mimeType()

std::string Exiv2::RiffVideo::mimeType ( ) const

virtual

Return the MIME type of the image.

Note: For each supported image format, the library knows only one MIME type. This may not be the most specific MIME type for that format. In particular, several RAW formats are variants of the TIFF format with the same magic as TIFF itself. Class TiffImage handles most of them and thus they all have MIME type "image/tiff", although a more specific MIME type may exist (e.g., "image/x-nikon-nef").

Implements Exiv2::Image.

◆ printStructure()

void Exiv2::RiffVideo::printStructure	(	std::ostream &	out,
		PrintStructureOption	option,
		int	depth
	)

virtual

Print out the structure of image file.

Exceptions

Error if reading of the file fails or the image data is not valid (does not look like data of the specific image type).

Warning: This function is not thread safe and intended for exiv2 -pS for debugging.; You may need to put the stream into binary mode (see src/actions.cpp)

Reimplemented from Exiv2::Image.

◆ readMetadata()

void Exiv2::RiffVideo::readMetadata ( )

virtual

Read all metadata supported by a specific image format from the image. Before this method is called, the image metadata will be cleared.

This method returns success even if no metadata is found in the image. Callers must therefore check the size of individual metadata types before accessing the data.

Exceptions

Error if opening or reading of the file fails or the image data is not valid (does not look like data of the specific image type).

Implements Exiv2::Image.

◆ returnSampleRate()

double Exiv2::RiffVideo::returnSampleRate	(	Exiv2::DataBuf &	buf,
		long	divisor = `1`
	)

protected

Calculates Sample Rate of a particular stream.

Parameters

buf	Data buffer with the dividend.
divisor	The Divisor required to calculate sample rate.

Returns: Return the sample rate of the stream.

◆ streamDataTagHandler()

void Exiv2::RiffVideo::streamDataTagHandler ( long size )

protected

Interpret Riff Stream Data tag information, and save it in the respective XMP container.

Parameters

size	Size of the data block used to store Tag Information.

◆ streamFormatHandler()

void Exiv2::RiffVideo::streamFormatHandler ( long size )

protected

Interpret Stream Format tag information, and save it in the respective XMP container.

Parameters

size	Size of the data block used to store Tag Information.

◆ streamHandler()

void Exiv2::RiffVideo::streamHandler ( long size )

protected

Interpret Stream tag information, and save it in the respective XMP container.

Parameters

size	Size of the data block used to store Tag Information.

◆ tagDecoder()

void Exiv2::RiffVideo::tagDecoder	(	Exiv2::DataBuf &	buf,
		unsigned long	size
	)

protected

Interpret tag information, and call the respective function to save it in the respective XMP container. Decodes a Tag Information and saves it in the respective XMP container, if the block size is small.

Parameters

buf	Data buffer which cotains tag ID.
size	Size of the data block used to store Tag Information.

◆ writeMetadata()

void Exiv2::RiffVideo::writeMetadata ( )

virtual

Write metadata back to the image.

All existing metadata sections in the image are either created, replaced, or erased. If values for a given metadata type have been assigned, a section for that metadata type will either be created or replaced. If no values have been assigned to a given metadata type, any exists section for that metadata type will be removed from the image.

Exceptions

Error if the operation fails

Implements Exiv2::Image.

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

riffvideo.hpp

Public Member Functions

Accessors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RiffVideo()

Member Function Documentation

◆ aviHeaderTagsHandler()

◆ dateTimeOriginal()

◆ fillAspectRatio()

◆ fillDuration()

◆ junkHandler()

◆ listHandler()

◆ mimeType()

◆ printStructure()

◆ readMetadata()

◆ returnSampleRate()

◆ streamDataTagHandler()

◆ streamFormatHandler()

◆ streamHandler()

◆ tagDecoder()

◆ writeMetadata()