ImfCompression.h File Reference

#include "ImfForward.h"
#include <string>

Include dependency graph for ImfCompression.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
IMF_EXPORT void	getCompressionNameFromId (Compression id, std::string &name)
	Returns a codec ID's short name (lowercase). More...
IMF_EXPORT void	getCompressionDescriptionFromId (Compression id, std::string &desc)
	Returns a codec ID's short description (lowercase). More...
IMF_EXPORT void	getCompressionIdFromName (const std::string &name, Compression &id)
	Returns the codec name's ID, NUM_COMPRESSION_METHODS if not found. More...
IMF_EXPORT bool	isValidCompression (int id)
	Return true if a compression id exists. More...
IMF_EXPORT void	getCompressionNamesString (const std::string &separator, std::string &in)
	Return a string enumerating all compression names, with a custom separator. More...
IMF_EXPORT int	getCompressionNumScanlines (Compression id)
	Return the number of scan lines expected by a given compression method. More...
IMF_EXPORT bool	isLossyCompression (Compression id)
	Return true is the compression method exists and doesn't preserves data integrity. More...
IMF_EXPORT bool	isValidDeepCompression (Compression id)
	Return true is the compression method exists and supports deep data. More...
IMF_EXPORT void	setDefaultZipCompressionLevel (int level)
IMF_EXPORT void	setDefaultDwaCompressionLevel (float level)
	Controls the default quality level for the DWA lossy compression. More...

Variables
OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER enum IMF_EXPORT_ENUM	Compression
	NO_COMPRESSION = 0
	RLE_COMPRESSION = 1
	ZIPS_COMPRESSION = 2
	ZIP_COMPRESSION = 3
	PIZ_COMPRESSION = 4
	PXR24_COMPRESSION = 5
	B44_COMPRESSION = 6
	B44A_COMPRESSION = 7
	DWAA_COMPRESSION = 8
	DWAB_COMPRESSION = 9

Function Documentation

IMF_EXPORT void getCompressionDescriptionFromId	(	Compression	id,
		std::string &	desc
	)

Returns a codec ID's short description (lowercase).

IMF_EXPORT void getCompressionIdFromName	(	const std::string &	name,
		Compression &	id
	)

Returns the codec name's ID, NUM_COMPRESSION_METHODS if not found.

IMF_EXPORT void getCompressionNameFromId	(	Compression	id,
		std::string &	name
	)

Returns a codec ID's short name (lowercase).

IMF_EXPORT void getCompressionNamesString	(	const std::string &	separator,
		std::string &	in
	)

Return a string enumerating all compression names, with a custom separator.

IMF_EXPORT int getCompressionNumScanlines

(

Compression

id

)

Return the number of scan lines expected by a given compression method.

IMF_EXPORT bool isLossyCompression

(

Compression

id

)

Return true is the compression method exists and doesn't preserves data integrity.

IMF_EXPORT bool isValidCompression

(

int

id

)

Return true if a compression id exists.

IMF_EXPORT bool isValidDeepCompression

(

Compression

id

)

Return true is the compression method exists and supports deep data.

IMF_EXPORT void setDefaultDwaCompressionLevel

(

float

level

)

Controls the default quality level for the DWA lossy compression.

IMF_EXPORT void setDefaultZipCompressionLevel

(

int

level

)

Controls the default zip compression level used. Zip is used for the 2 zip levels as well as some modes of the DWAA/B compression.

Variable Documentation

B44_COMPRESSION = 6

Definition at line 39 of file ImfCompression.h.

B44A_COMPRESSION = 7

Definition at line 42 of file ImfCompression.h.

OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER enum IMF_EXPORT_ENUM Compression

Definition at line 25 of file ImfCompression.h.

DWAA_COMPRESSION = 8

Definition at line 45 of file ImfCompression.h.

DWAB_COMPRESSION = 9

Definition at line 49 of file ImfCompression.h.

NO_COMPRESSION = 0

Definition at line 27 of file ImfCompression.h.

PIZ_COMPRESSION = 4

Definition at line 35 of file ImfCompression.h.

PXR24_COMPRESSION = 5

Definition at line 37 of file ImfCompression.h.

RLE_COMPRESSION = 1

Definition at line 29 of file ImfCompression.h.

ZIP_COMPRESSION = 3

Definition at line 33 of file ImfCompression.h.

ZIPS_COMPRESSION = 2

Definition at line 31 of file ImfCompression.h.