#include <djv_iw44encoder.h>

Public Member Functions
	Params (Intent inIntent, size_t inQuality, CBCRMode inCbcrMode=cbcrNormal, size_t inCbcrDelay=cbcrDelayAuto)
	Params (Intent inIntent, const ChunkConfig *inChunkConfigs, size_t inChunkConfigCount, CBCRMode inCbcrMode=cbcrNormal, size_t inCbcrDelay=cbcrDelayAuto)
	Params (Intent inIntent, SliceCallback sliceCallback, void *sliceCallbackContext, CBCRMode inCbcrMode=cbcrNormal, size_t inCbcrDelay=cbcrDelayAuto)
void	configureChunks (Intent inIntent, size_t inQuality)
Public Attributes
Intent	intent
	Intent of the encoding.
size_t	quality
	Quality of the IW44 encoding.
CBCRMode	cbcrMode
	Cb-Cr (chrominance) mode.
size_t	cbcrDelay
	The chrominance delay counter in 0 - 127.
SimpleArray< ChunkConfig >	chunkConfigs
	Configurations for IW44 chunks.
SliceCallback	sliceCallback
	Callback function called on each slice encoding iteration.
void *	sliceCallbackContext
	User defined parameter for callback.

Detailed Description

This struct contains parameters to configure the IW44 encoder settings.

Constructor & Destructor Documentation

Celartem::DjVu::IW44Encoder::Params::Params	(	Intent	inIntent,
		size_t	inQuality,
		CBCRMode	inCbcrMode = `cbcrNormal`,
		size_t	inCbcrDelay = `cbcrDelayAuto`
	)			`[inline]`

Initializes the structure by specifying quality value.

Parameters:

	inIntent	The intent of encoding. This is one of the Intent enumeration values.
	inQuality	The encoding quality in 0-100. 100 for the highest quality but the largest size. 0 for the lowest quality and the smallest file size. The default is 75.
	inCbcrMode	The CBCRMode. The default is cbcrNormal. If inIntent is BM44, CBCRMode is forced to change to cbcrNone ignoring this value.
	inCbcrDelay	The chrominance delay counter in 0 - 127. In addition to these range of values, cbcrDelayAuto can be used to make encoder determine it from other parameters. This value is used to specify how many slices contains only luminance (Y) component. The default is cbcrDelayAuto.

Celartem::DjVu::IW44Encoder::Params::Params	(	Intent	inIntent,
		const ChunkConfig *	inChunkConfigs,
		size_t	inChunkConfigCount,
		CBCRMode	inCbcrMode = `cbcrNormal`,
		size_t	inCbcrDelay = `cbcrDelayAuto`
	)			`[inline]`

Initializes the structure by specifying chunk configurations.

Parameters:

	inIntent	The intent of encoding. This is one of the Intent enumeration values.
	inChunkConfigs	The pointer to the ChunkConfig array.
	inChunkConfigCount	The number of elements in the inChunkConfigs.
	inCbcrMode	The CBCRMode. The default is cbcrNormal. If inIntent is BM44, CBCRMode is forced to change to cbcrNone ignoring this value.
	inCbcrDelay	The chrominance delay counter in 0 - 127. In addition to these range of values, cbcrDelayAuto can be used to make encoder determine it from other parameters. This value is used to specify how many slices contains only luminance (Y) component. The default is cbcrDelayAuto.

Celartem::DjVu::IW44Encoder::Params::Params	(	Intent	inIntent,
		SliceCallback	sliceCallback,
		void *	sliceCallbackContext,
		CBCRMode	inCbcrMode = `cbcrNormal`,
		size_t	inCbcrDelay = `cbcrDelayAuto`
	)			`[inline]`

Initializes the structure by specifying slice callback function.

Parameters:

	inIntent	The intent of encoding. This is one of the Intent enumeration values.
	inSliceCallback	The pointer to the callback function which is called right after each of slice encoding iteration.
	inSliceCallbackContext	The pointer to user defined context data. It is given to the callback specified as inSliceCallback.
	inCbcrMode	The CBCRMode. The default is cbcrNormal. If inIntent is BM44, CBCRMode is forced to change to cbcrNone ignoring this value.
	inCbcrDelay	The chrominance delay counter in 0 - 127. In addition to these range of values, cbcrDelayAuto can be used to make encoder determine it from other parameters. This value is used to specify how many slices contains only luminance (Y) component. The default is cbcrDelayAuto.

Member Function Documentation

void Celartem::DjVu::IW44Encoder::Params::configureChunks	(	Intent	inIntent,
		size_t	inQuality
	)

This method is a helper method, which configures chunkConfigs from the specified intent and quality.
Note that this method never changes intent and quality variable of the instance but just modifies chunkConfig variable due to the specified parameter.

Parameters:

	inIntent	The intent of encoding. This is one of the Intent enumeration values.
	inQuality	The encoding quality in 0-100. 100 for the highest quality but the largest size. 0 for the lowest quality and the smallest file size. The default is 75.

Member Data Documentation

size_t Celartem::DjVu::IW44Encoder::Params::cbcrDelay

The chrominance delay counter in 0 - 127.

The chrominance delay counter in 0 - 127. In addition to these range of values, cbcrDelayAuto can be used to make encoder determine it from other parameters. This value is used to specify how many slices contains only luminance (Y) component.
The default is cbcrDelayAuto.

CBCRMode Celartem::DjVu::IW44Encoder::Params::cbcrMode

Cb-Cr (chrominance) mode.

The default is cbcrNormal. If inIntent is BM44, CBCRMode is forced to change to cbcrNone ignoring this value.

SimpleArray<ChunkConfig> Celartem::DjVu::IW44Encoder::Params::chunkConfigs

Configurations for IW44 chunks.

This parameter is only used when the following conditions are met:

chunkConfigs is NOT empty
sliceCallback is NULL
sliceCallbackContext is NULL And then quality variable is simply ignored.

Referenced by Params().

Intent Celartem::DjVu::IW44Encoder::Params::intent

Intent of the encoding.

The intent of the encoding. IW44Encoder configures the internal parameters according to the intent.

size_t Celartem::DjVu::IW44Encoder::Params::quality

Quality of the IW44 encoding.

100 for the highest quality but the largest size. 0 for the lowest quality and the smallest file size.
The default is 75.
This parameter is only used when the following conditions are met:

chunkConfigs is empty
sliceCallback is NULL
sliceCallbackContext is NULL

chunkConfigs will be configured when needed according to this parameter. To configure chunkConfigs before calling IW44Encoder::create, use configureChunks method.

SliceCallback Celartem::DjVu::IW44Encoder::Params::sliceCallback

Callback function called on each slice encoding iteration.

The pointer to the callback function which is called right after each of slice encoding iteration.

void* Celartem::DjVu::IW44Encoder::Params::sliceCallbackContext

User defined parameter for callback.

The pointer to user defined context data. It is given to the callback specified as sliceCallback.

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

djv_iw44encoder.h

Celartem::DjVu::IW44Encoder::Params Struct Reference

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation