Celartem::DjVu::DjVuEncoder::Params Struct Reference

#include <djv_djvuencoder.h>

List of all members.

Public Member Functions
	Params (EncodeMode inEncoderMode=emAuto, size_t inFgSubsample=12, size_t inFgQuality=75, size_t inBgSubsample=3, size_t inBgQuality=75, size_t inUpsample=1)
void	loadFromProfile (const String &inProfileName)
void	loadFromXmlFile (const String &inXmlFileName)
Public Attributes
EncodeMode	encodeMode
	The foreground type.
size_t	upsample
size_t	fgSubsample
	The subsample ratio of the FG44 foreground.
IW44::IW44Encoder::Params	fgParams
	The FG44/PM44 foreground configuration.
size_t	bgSubsample
	The subsample ratio of the BG44 background.
IW44::IW44Encoder::Params	bgParams
	The BG44 background configuration.
Segmenter::Params	segParams
	Segmenter configuration.
JB2::JB2Encoder::Params	jb2Params
	JB2 configuration.
u32	flags

---

Detailed Description

This struct contains parameters to configure the DjVu encoder settings.

Definition at line 72 of file djv_djvuencoder.h.

---

Constructor & Destructor Documentation

Celartem::DjVu::DjVuEncoder::Params::Params	(	EncodeMode	inEncoderMode = emAuto,
		size_t	inFgSubsample = 12,
		size_t	inFgQuality = 75,
		size_t	inBgSubsample = 3,
		size_t	inBgQuality = 75,
		size_t	inUpsample = 1
	)			[inline]

Initialize a new Params structure.

Definition at line 167 of file djv_djvuencoder.h.

---

Member Function Documentation

void Celartem::DjVu::DjVuEncoder::Params::loadFromProfile

(

const String &

inProfileName

)

Load configuration from the specified profile.

Parameters:

inProfileName

Name of a profile to load.

void Celartem::DjVu::DjVuEncoder::Params::loadFromXmlFile

(

const String &

inXmlFileName

)

Load configuration from the specified XML file.

Parameters:

inXmlFileName

File name of a XML file.

---

Member Data Documentation

EncodeMode Celartem::DjVu::DjVuEncoder::Params::encodeMode

The foreground type.

It should be one of EncodeMode enumeration. The default is emAuto. The following table illustrates what EncodeMode supports what parameters:

encodeMode	fgSubsample	fgParams	bgSubsample	bgParams
emFG44	x	x	x	x
emColorJB2			x	x
emPicture				x
emBitonal

Definition at line 105 of file djv_djvuencoder.h.

size_t Celartem::DjVu::DjVuEncoder::Params::upsample

If this value is not equal to 1, DjVuEncoder::encodePage method firstly upsamples the input image with the specified upsample coeffecient; 2 to upsample the image twice.
Note that if any mask is explicitly specified on the call of DjVuEncoder::encodePage, this parameter is simply ignored. The default is 1.

Definition at line 115 of file djv_djvuencoder.h.

size_t Celartem::DjVu::DjVuEncoder::Params::fgSubsample

The subsample ratio of the FG44 foreground.

This value must be in the range of 1-12. The default is 12.
It is only supported by emFG44.
Please note that the final output size also depends on the upsample value.

Definition at line 124 of file djv_djvuencoder.h.

IW44::IW44Encoder::Params Celartem::DjVu::DjVuEncoder::Params::fgParams

The FG44/PM44 foreground configuration.

It is only supported by emFG44.
For more information, see IW44Encoder class.

Definition at line 130 of file djv_djvuencoder.h.

size_t Celartem::DjVu::DjVuEncoder::Params::bgSubsample

The subsample ratio of the BG44 background.

This value must be in the range of 1-12. The default is 3.
It is only supported by emFG44, emPicture and emColorJB2.
Please note that the final output size also depends on the upsample value.

Definition at line 140 of file djv_djvuencoder.h.

IW44::IW44Encoder::Params Celartem::DjVu::DjVuEncoder::Params::bgParams

The BG44 background configuration.

It is only supported by emFG44, emPicture and emColorJB2.
For more information, see IW44Encoder class.

Definition at line 147 of file djv_djvuencoder.h.

Segmenter::Params Celartem::DjVu::DjVuEncoder::Params::segParams

Segmenter configuration.

Segmenter related parameters which is used on segmentation.

Definition at line 152 of file djv_djvuencoder.h.

JB2::JB2Encoder::Params Celartem::DjVu::DjVuEncoder::Params::jb2Params

JB2 configuration.

JB2 related parameters which is used on JB2 encoding.

Definition at line 157 of file djv_djvuencoder.h.

u32 Celartem::DjVu::DjVuEncoder::Params::flags

Any combination of EncodeFlags enumeration values.

Definition at line 162 of file djv_djvuencoder.h.

---

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

• djv_djvuencoder.h

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:27 2008.