lsi::CPi Class Reference

Implementation of a packet iterator (PI). More...

#include <LSIPi.h>

List of all members.

Classes
struct	opj_pi_comp
struct	opj_pi_iterator
struct	opj_pi_resolution
Public Types
typedef struct lsi::CPi::opj_pi_resolution	opj_pi_resolution_t
typedef struct lsi::CPi::opj_pi_comp	opj_pi_comp_t
typedef struct lsi::CPi::opj_pi_iterator	opj_pi_iterator_t
Static Public Member Functions
static opj_pi_iterator_t *LSE_CALL	pi_initialise_encode (CJpegImage::opj_image_t *_pImage, CJ2k::opj_cp_t *_pcCp, LSINT32 _i32TileNo, CJ2k::J2K_T2_MODE _t2Mode)
static LSBOOL LSE_CALL	pi_create_encode (opj_pi_iterator_t *_ppiPi, CJ2k::opj_cp_t *_pcCp, LSINT32 _i32TileNo, LSINT32 _i32PiNo, LSINT32 _i32TpNum, LSINT32 _i32TpPos, CJ2k::J2K_T2_MODE _t2Mode, LSINT32 _i32CurTotTp)
static opj_pi_iterator_t *LSE_CALL	pi_create_decode (CJpegImage::opj_image_t *_piImage, CJ2k::opj_cp_t *_pcCp, LSINT32 _i32TileNo)
static LSVOID LSE_CALL	pi_destroy (opj_pi_iterator_t *_ppiPi, CJ2k::opj_cp_t *_pcCp, LSINT32 _i32TileNo)
static LSBOOL LSE_CALL	pi_next (opj_pi_iterator_t *_ppiPi)
Static Protected Member Functions
static LSBOOL LSE_CALL	pi_next_lrcp (opj_pi_iterator_t *_ppiPi)
static LSBOOL LSE_CALL	pi_next_rlcp (opj_pi_iterator_t *_ppiPi)
static LSBOOL LSE_CALL	pi_next_rpcl (opj_pi_iterator_t *_ppiPi)
static LSBOOL LSE_CALL	pi_next_pcrl (opj_pi_iterator_t *_ppiPi)
static LSBOOL LSE_CALL	pi_next_cprl (opj_pi_iterator_t *_ppiPi)

---

Detailed Description

Implementation of a packet iterator (PI).

Class CPi Description: Implementation of a packet iterator (PI).

---

Member Typedef Documentation

typedef struct lsi::CPi::opj_pi_comp lsi::CPi::opj_pi_comp_t

FIXME: documentation

typedef struct lsi::CPi::opj_pi_iterator lsi::CPi::opj_pi_iterator_t

Packet iterator.

typedef struct lsi::CPi::opj_pi_resolution lsi::CPi::opj_pi_resolution_t

FIXME: documentation

---

Member Function Documentation

static opj_pi_iterator_t* LSE_CALL lsi::CPi::pi_create_decode	(	CJpegImage::opj_image_t *	_piImage,
		CJ2k::opj_cp_t *	_pcCp,
		LSINT32	_i32TileNo
	)		[static]

Create a packet iterator for the decoder.

Parameters:

_piImage	Raw image for which the packets will be listed.
_pcCp	Coding parameters.
_i32TileNo	Number that identifies the tile for which to list the packets.

Returns:

Returns a packet iterator that points to the first packet of the tile.

See also:

pi_destroy

static LSBOOL LSE_CALL lsi::CPi::pi_create_encode	(	opj_pi_iterator_t *	_ppiPi,
		CJ2k::opj_cp_t *	_pcCp,
		LSINT32	_i32TileNo,
		LSINT32	_i32PiNo,
		LSINT32	_i32TpNum,
		LSINT32	_i32TpPos,
		CJ2k::J2K_T2_MODE	_t2Mode,
		LSINT32	_i32CurTotTp
	)		[static]

Modify the packet iterator for enabling tile part generation.

Parameters:

_ppiPi	Handle to the packet iterator generated in pi_initialise_encode.
_pcCp	Coding parameters.
_i32TileNo	Number that identifies the tile for which to list the packets.
_i32PiNo	Iterator index for _ppiPi.
_i32TpNum	Tile part number of the current tile.
_i32TpPos	The position of the tile part flag in the progression order.
_t2Mode	If 0 we are in the threshold calculation. If 1 we are in the final pass.
_i32CurTotTp	The total number of tile parts in the current tile.

Returns:

Returns true if an error is detected.

static LSVOID LSE_CALL lsi::CPi::pi_destroy	(	opj_pi_iterator_t *	_ppiPi,
		CJ2k::opj_cp_t *	_pcCp,
		LSINT32	_i32TileNo
	)		[static]

Destroy a packet iterator.

Parameters:

_ppiPi	Previously created packet iterator.
_pcCp	Coding parameters.
_i32TileNo	Number that identifies the tile for which the packets were listed.

See also:

pi_create

static opj_pi_iterator_t* LSE_CALL lsi::CPi::pi_initialise_encode	(	CJpegImage::opj_image_t *	_pImage,
		CJ2k::opj_cp_t *	_pcCp,
		LSINT32	_i32TileNo,
		CJ2k::J2K_T2_MODE	_t2Mode
	)		[static]

Create a packet iterator for the encoder.

Parameters:

_pImage	Raw image for which the packets will be listed.
_pcCp	Coding parameters.
_i32TileNo	Number that identifies the tile for which to list the packets.
_t2Mode	If 0 we are in the threshold calculation. If 1 we are in the final pass.

Returns:

Returns a packet iterator that points to the first packet of the tile.

See also:

pi_destroy

static LSBOOL LSE_CALL lsi::CPi::pi_next

(

opj_pi_iterator_t *

_ppiPi

)

[static]

Modify the packet iterator to point to the next packet.

Parameters:

_ppiPi

Packet iterator to modify.

Returns:

Returns false if _ppiPi pointed to the last packet or else returns true.

static LSBOOL LSE_CALL lsi::CPi::pi_next_cprl

(

opj_pi_iterator_t *

_ppiPi

)

[static, protected]

Get next packet in component-precinct-resolution-layer order.

Parameters:

_ppiPi

Packet iterator to modify.

Returns:

Returns false if _ppiPi pointed to the last packet, otherwise returns true.

static LSBOOL LSE_CALL lsi::CPi::pi_next_lrcp

(

opj_pi_iterator_t *

_ppiPi

)

[static, protected]

Get next packet in layer-resolution-component-precinct order.

Parameters:

_ppiPi

Packet iterator to modify.

Returns:

Returns false if _ppiPi pointed to the last packet, otherwise returns true.

static LSBOOL LSE_CALL lsi::CPi::pi_next_pcrl

(

opj_pi_iterator_t *

_ppiPi

)

[static, protected]

Get next packet in precinct-component-resolution-layer order.

Parameters:

_ppiPi

Packet iterator to modify.

Returns:

Returns false if _ppiPi pointed to the last packet, otherwise returns true.

static LSBOOL LSE_CALL lsi::CPi::pi_next_rlcp

(

opj_pi_iterator_t *

_ppiPi

)

[static, protected]

Get next packet in resolution-layer-component-precinct order.

Parameters:

_ppiPi

Packet iterator to modify.

Returns:

Returns false if _ppiPi pointed to the last packet, otherwise returns true.

static LSBOOL LSE_CALL lsi::CPi::pi_next_rpcl

(

opj_pi_iterator_t *

_ppiPi

)

[static, protected]

Get next packet in resolution-precinct-component-layer order.

Parameters:

_ppiPi

Packet iterator to modify.

Returns:

Returns false if _ppiPi pointed to the last packet, otherwise returns true.

---

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

• F:/My Projects/LSEngine/Modules/LSImageLib/Src/Jpeg/LSIPi.h