TIFFCompressor Class Reference

TIFF encoder class. More...

#include <TIFFCompressor.h>

Inheritance diagram for TIFFCompressor:

Public Member Functions
	TIFFCompressor (int compression, int quality)
	Constructor.
void	setCompression (int compression)
	Set compression type: 0: None, 1: LZW, 2: Deflate, 3: JPEG, 4: WebP, 5: ZStandard.
void	setQuality (int quality)
	Set the compression level.
void	InitCompression (const RawTile &rawtile, unsigned int strip_height)
	Initialize strip based compression.
unsigned int	CompressStrip (unsigned char *source, unsigned char *output, unsigned int tile_height)
	Compress a strip of image data.
unsigned int	Finish (unsigned char *output)
	Finish the strip based compression and free memory.
unsigned int	Compress (RawTile &t)
	Compress an entire buffer of image data at once in one command.
const char *	getMimeType () const
	Return the TIFF mime type.
const char *	getSuffix () const
	Return the image filename suffix.
ImageEncoding	getImageEncoding () const
	Get compression type.
Public Member Functions inherited from Compressor
	Compressor (int compressionLevel)
	Constructor.
unsigned int	getHeaderSize () const
	Return the image header size.
unsigned char *	getHeader ()
	Return a pointer to the image header itself.
int	getQuality () const
	Get the current quality level.
bool	defaultQuality () const
	Check whether we are using the default or whether user has requested a specific quality level.
void	setResolution (float x, float y, int units)
	Set the physical output resolution.
void	embedICCProfile (const bool embed)
	Embed ICC profile.
void	embedXMPMetadata (const bool embed)
	Embed XMP metadata.
void	embedExifMetadata (const bool embed)
	Embed EXIF metadata.
void	setMetadata (const std::map< const std::string, const std::string > &metadata)
	Set general metadata.
virtual void	injectMetadata (RawTile &t)
	Inject metadata into raw bitstream.

Static Public Member Functions
static std::string	getCompressionName (int code)
	Static utility function to get compression in human-readable form.

Additional Inherited Members
Protected Member Functions inherited from Compressor
virtual void	writeExifMetadata ()
	Write EXIF metadata.
Protected Attributes inherited from Compressor
int	Q
	Quality or compression level for all image types.
bool	default_quality
	Whether compression level is default or has been set manually.
unsigned char *	header
	Pointer to the header data for the output image.
unsigned int	header_size
	Size of the header data.
int	dpi_units
	Physical resolution units: 0 for unknown, 1 for dots/inch or 2 for dots/cm.
float	dpi_x
	Physical resolution (pixels per physical unit) for X direction.
float	dpi_y
	Physical resolution (pixels per phyisical unit) in Y direction.
std::map< const std::string, const std::string >	metadata
	Metadata.
std::string	icc
	ICC Profile.
bool	embedICC
	Whether ICC profile should be embedded.
std::string	xmp
	XMP metadata.
bool	embedXMP
	Whether XMP metadata should be embedded.
std::string	exif
	EXIF metadata.
bool	embedEXIF
	Whether EXIF metadata should be embedded.

Detailed Description

TIFF encoder class.

Constructor & Destructor Documentation

TIFFCompressor()

TIFFCompressor::TIFFCompressor ( int  compression, int  quality  )

inline

Constructor.

Parameters

compression	compression (encoding) type: 0: None, 1: LZW, 2: Deflate, 3: JPEG, 4: WebP, 5: ZStandard
quality	compression level

References Compressor::Q, and setCompression().

Member Function Documentation

Compress()

unsigned int TIFFCompressor::Compress ( RawTile &  t )

virtual

Compress an entire buffer of image data at once in one command.

Parameters

t	tile of image data

Returns

size of compressed data

Reimplemented from Compressor.

References RawTile::allocate(), RawTile::bpc, tiff_mem::buffer, RawTile::capacity, tiff_mem::capacity, RawTile::channels, RawTile::compressionType, tiff_mem::current, RawTile::data, RawTile::dataLength, RawTile::deallocate(), tiff_mem::end, RawTile::height, Compressor::icc, RawTile::memoryManaged, Compressor::Q, RawTile::quality, RawTile::width, and Compressor::xmp.

CompressStrip()

unsigned int TIFFCompressor::CompressStrip ( unsigned char *  source, unsigned char *  output, unsigned int  tile_height  )

virtual

Compress a strip of image data.

Parameters

source	source image data
tile_height	pixel height of the tile we are compressing
output	output_buffer

Returns

size of compressed strip

Reimplemented from Compressor.

References tiff_mem::buffer, and tiff_mem::end.

Finish()

unsigned int TIFFCompressor::Finish ( unsigned char *  output )

virtual

Finish the strip based compression and free memory.

Parameters

output

Output buffer

Returns

size of output generated

Reimplemented from Compressor.

References tiff_mem::buffer, and tiff_mem::end.

getCompressionName()

static std::string TIFFCompressor::getCompressionName ( int  code )

inlinestatic

Static utility function to get compression in human-readable form.

Parameters

code	compression code

Returns

human-readable compression name

Referenced by QLT::run().

getImageEncoding()

ImageEncoding TIFFCompressor::getImageEncoding ( ) const

inlinevirtual

Get compression type.

Reimplemented from Compressor.

getMimeType()

const char * TIFFCompressor::getMimeType ( ) const

inlinevirtual

Return the TIFF mime type.

Reimplemented from Compressor.

getSuffix()

const char * TIFFCompressor::getSuffix ( ) const

inlinevirtual

Return the image filename suffix.

Reimplemented from Compressor.

InitCompression()

void TIFFCompressor::InitCompression ( const RawTile &  rawtile, unsigned int  strip_height  )

virtual

Initialize strip based compression.

For strip based encoding, we need to first initialize with InitCompression, then compress a single strip at a time using CompressStrip and finally clean up using Finish

Parameters

rawtile	RawTile object containing the image to be compressed
strip_height	height in pixels of the strip we want to compress

Reimplemented from Compressor.

References RawTile::bpc, tiff_mem::buffer, tiff_mem::capacity, RawTile::channels, tiff_mem::current, RawTile::data, RawTile::dataLength, tiff_mem::end, RawTile::height, Compressor::icc, RawTile::width, and Compressor::xmp.

setCompression()

void TIFFCompressor::setCompression ( int  compression )

inline

Set compression type: 0: None, 1: LZW, 2: Deflate, 3: JPEG, 4: WebP, 5: ZStandard.

Parameters

compression

compression type

Referenced by QLT::run(), and TIFFCompressor().

setQuality()

void TIFFCompressor::setQuality ( int  quality )

inlinevirtual

Set the compression level.

Parameters

quality

compression level for JPEG or WebP (both 0-100)

Reimplemented from Compressor.

References Compressor::default_quality, and Compressor::Q.

Referenced by QLT::run().

---

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

• TIFFCompressor.h
• TIFFCompressor.cc