The JPEG-2000 file format Reader/Writer (JP2). More...

#include <LSIJp2.h>

Classes
struct	opj_jp2
struct	opj_jp2_box
struct	opj_jp2_cdef
struct	opj_jp2_cdef_info_t
struct	opj_jp2_cmap_comp
struct	opj_jp2_color
struct	opj_jp2_comps
struct	opj_jp2_pclr
Public Types
typedef struct lsi::CJp2::opj_jp2_cdef_info_t *	LPopj_jp2_cdef_info_t
typedef struct lsi::CJp2::opj_jp2_cdef_info_t	LPCopj_jp2_cdef_info_t
typedef struct lsi::CJp2::opj_jp2_cdef	opj_jp2_cdef_t
typedef struct lsi::CJp2::opj_jp2_cmap_comp	opj_jp2_cmap_comp_t
typedef struct lsi::CJp2::opj_jp2_pclr	opj_jp2_pclr_t
typedef struct lsi::CJp2::opj_jp2_color	opj_jp2_color_t
typedef struct lsi::CJp2::opj_jp2_comps	opj_jp2_comps_t
typedef struct lsi::CJp2::opj_jp2	opj_jp2_t
typedef struct lsi::CJp2::opj_jp2_box	opj_jp2_box_t
Static Public Member Functions
static LSVOID LSE_CALL	jp2_write_jp2h (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio)
static LSBOOL LSE_CALL	jp2_read_jp2h (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio, opj_jp2_color_t *_pjcColor)
static opj_jp2_t *LSE_CALL	jp2_create_decompress (CJpegCommonStructs::opj_common_ptr _cpInfo)
static LSVOID LSE_CALL	jp2_destroy_decompress (opj_jp2_t *_pjJp2)
static LSVOID LSE_CALL	jp2_setup_decoder (opj_jp2_t _pjJp2, CJpegCommonStructs::opj_dparameters_t _pdParameters)
static CJpegImage::opj_image_t *LSE_CALL	jp2_decode (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio, CJpegCommonStructs::opj_codestream_info_t *_pciInfo)
static opj_jp2_t *LSE_CALL	jp2_create_compress (CJpegCommonStructs::opj_common_ptr _cpInfo)
static LSVOID LSE_CALL	jp2_destroy_compress (opj_jp2_t *_pjJp2)
static LSVOID LSE_CALL	jp2_setup_encoder (opj_jp2_t _pjJp2, CJpegCommonStructs::opj_cparameters_t _pdParameters, CJpegImage::opj_image_t *_piImage)
static LSBOOL LSE_CALL	jp2_encode (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio, CJpegImage::opj_image_t _piImage, CJpegCommonStructs::opj_codestream_info_t _pciInfo)
Static Protected Member Functions
static LSBOOL LSE_CALL	jp2_read_boxhdr (CJpegCommonStructs::opj_common_ptr _cpInfo, CCio::opj_cio_t _pcCio, opj_jp2_box_t _pjbBox)
static LSBOOL LSE_CALL	jp2_read_ihdr (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio)
static LSVOID LSE_CALL	jp2_write_ihdr (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio)
static LSVOID LSE_CALL	jp2_write_bpcc (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio)
static LSBOOL LSE_CALL	jp2_read_bpcc (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio)
static LSVOID LSE_CALL	jp2_write_colr (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio)
static LSVOID LSE_CALL	jp2_write_ftyp (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio)
static LSBOOL LSE_CALL	jp2_read_ftyp (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio)
static LSINT32 LSE_CALL	jp2_write_jp2c (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio, CJpegImage::opj_image_t _piImage, CJpegCommonStructs::opj_codestream_info_t _pciInfo)
static LSBOOL LSE_CALL	jp2_read_jp2c (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio, LSUINT32 _pui32CodeStreamLen, LSUINT32 _pui32CodeStreamOffset)
static LSVOID LSE_CALL	jp2_write_jp (CCio::opj_cio_t *_pcCio)
static LSBOOL LSE_CALL	jp2_read_jp (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio)
static LSBOOL LSE_CALL	jp2_read_struct (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio, opj_jp2_color_t *_pjcColor)
static LSVOID LSE_CALL	jp2_apply_pclr (opj_jp2_color_t _pjcColor, CJpegImage::opj_image_t _piImage)
static LSBOOL LSE_CALL	jp2_read_pclr (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio, opj_jp2_box_t _pjbBox, opj_jp2_color_t _pjcColor)
static LSBOOL LSE_CALL	jp2_read_cmap (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio, opj_jp2_box_t _pjbBox, opj_jp2_color_t _pjcColor)
static LSBOOL LSE_CALL	jp2_read_colr (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio, opj_jp2_box_t _pjbBox, opj_jp2_color_t _pjcColor)
static LSBOOL LSE_CALL	jp2_read_cdef (opj_jp2_t _pjJp2, CCio::opj_cio_t _pcCio, opj_jp2_box_t _pjbBox, opj_jp2_color_t _pjcColor)
static LSVOID LSE_CALL	free_color_data (opj_jp2_color_t *_pjcColor)
static LSVOID LSE_CALL	jp2_apply_cdef (CJpegImage::opj_image_t _piImage, opj_jp2_color_t _pjcColor)
static LSVOID LSE_CALL	jp2_free_pclr (opj_jp2_color_t *_pjcColor)

Detailed Description

The JPEG-2000 file format Reader/Writer (JP2).

Class CJp2 Description: The JPEG-2000 file format Reader/Writer (JP2).

Member Typedef Documentation

typedef struct lsi::CJp2::opj_jp2_cdef_info_t * lsi::CJp2::LPopj_jp2_cdef_info_t

Channel description: channel index, type, assocation.

typedef struct lsi::CJp2::opj_jp2_box lsi::CJp2::opj_jp2_box_t

JP2 Box.

typedef struct lsi::CJp2::opj_jp2_cdef lsi::CJp2::opj_jp2_cdef_t

Channel descriptions and number of descriptions.

typedef struct lsi::CJp2::opj_jp2_cmap_comp lsi::CJp2::opj_jp2_cmap_comp_t

Component mappings: channel index, mapping type, palette index.

typedef struct lsi::CJp2::opj_jp2_color lsi::CJp2::opj_jp2_color_t

Collector for ICC profile, palette, component mapping, channel description.

typedef struct lsi::CJp2::opj_jp2_comps lsi::CJp2::opj_jp2_comps_t

JP2 component.

typedef struct lsi::CJp2::opj_jp2_pclr lsi::CJp2::opj_jp2_pclr_t

Palette data: table entries, palette columns.

typedef struct lsi::CJp2::opj_jp2 lsi::CJp2::opj_jp2_t

JPEG-2000 file format reader/writer.

Member Function Documentation

static LSVOID LSE_CALL lsi::CJp2::free_color_data ( opj_jp2_color_t * _pjcColor ) [static, protected]

Undocumented function from the OpenJpeg Library.

Parameters:

_pjcColor Undocumented parameter from the OpenJpeg Library.

static LSVOID LSE_CALL lsi::CJp2::jp2_apply_cdef	(	CJpegImage::opj_image_t *	_piImage,
		opj_jp2_color_t *	_pjcColor
	)		`[static, protected]`

Undocumented function from the OpenJpeg Library.

Parameters:

_piImage	Undocumented parameter from the OpenJpeg Library.
_pjcColor	Undocumented parameter from the OpenJpeg Library.

static LSVOID LSE_CALL lsi::CJp2::jp2_apply_pclr	(	opj_jp2_color_t *	_pjcColor,
		CJpegImage::opj_image_t *	_piImage
	)		`[static, protected]`

Apply collected palette data.

Parameters:

_pjcColor	Collector for profile, cdef and pclr data.
_piImage	Undocumented parameter from the OpenJpeg Library.

static opj_jp2_t* LSE_CALL lsi::CJp2::jp2_create_compress ( CJpegCommonStructs::opj_common_ptr _cpInfo ) [static]

Creates a JP2 compression structure.

Parameters:

_cpInfo Codec context info.

Returns:: Returns a handle to a JP2 compressor if successful, returns NULL otherwise.

static opj_jp2_t* LSE_CALL lsi::CJp2::jp2_create_decompress ( CJpegCommonStructs::opj_common_ptr _cpInfo ) [static]

Creates a JP2 decompression structure.

Parameters:

_cpInfo Codec context info.

Returns:: Returns a handle to a JP2 decompressor if successful, returns NULL otherwise.

static CJpegImage::opj_image_t* LSE_CALL lsi::CJp2::jp2_decode	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio,
		CJpegCommonStructs::opj_codestream_info_t *	_pciInfo
	)		`[static]`

Decode an image from a JPEG-2000 file stream.

Parameters:

_pjJp2	JP2 decompressor handle.
_pcCio	Input buffer stream.
_pciInfo	Codestream information structure if required, NULL otherwise.

Returns:: Returns a decoded image if successful, returns NULL otherwise.

static LSVOID LSE_CALL lsi::CJp2::jp2_destroy_compress ( opj_jp2_t * _pjJp2 ) [static]

Destroy a JP2 compressor handle.

Parameters:

_pjJp2 JP2 compressor handle to destroy.

static LSVOID LSE_CALL lsi::CJp2::jp2_destroy_decompress ( opj_jp2_t * _pjJp2 ) [static]

Destroy a JP2 decompressor handle.

Parameters:

_pjJp2 JP2 decompressor handle to destroy.

static LSBOOL LSE_CALL lsi::CJp2::jp2_encode	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio,
		CJpegImage::opj_image_t *	_piImage,
		CJpegCommonStructs::opj_codestream_info_t *	_pciInfo
	)		`[static]`

Encode an image into a JPEG-2000 file stream.

Parameters:

_pjJp2	JP2 compressor handle.
_pcCio	Output buffer stream.
_piImage	Image to encode.
_pciInfo	Codestream information structure if required, NULL otherwise.

Returns:: Returns true if successful, returns false otherwise.

static LSVOID LSE_CALL lsi::CJp2::jp2_free_pclr ( opj_jp2_color_t * _pjcColor ) [static, protected]

Undocumented function from the OpenJpeg Library.

Parameters:

_pjcColor Undocumented parameter from the OpenJpeg Library.

static LSBOOL LSE_CALL lsi::CJp2::jp2_read_boxhdr	(	CJpegCommonStructs::opj_common_ptr	_cpInfo,
		CCio::opj_cio_t *	_pcCio,
		opj_jp2_box_t *	_pjbBox
	)		`[static, protected]`

Read box headers.

Parameters:

_cpInfo	Codec context info.
_pcCio	Input stream.
box.

Returns:: Returns true if successful, returns false otherwise.

static LSBOOL LSE_CALL lsi::CJp2::jp2_read_bpcc	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio
	)		`[static, protected]`

Undocumented function from the OpenJpeg Library.

Parameters:

_pjJp2	JP2 handle.
Input	Output buffer stream.

Returns:: Returns true if successful, returns false otherwise.

static LSBOOL LSE_CALL lsi::CJp2::jp2_read_cdef	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio,
		opj_jp2_box_t *	_pjbBox,
		opj_jp2_color_t *	_pjcColor
	)		`[static, protected]`

Undocumented function from the OpenJpeg Library.

Parameters:

_pjJp2	JP2 handle.
_pcCio	Input buffer stream.
_pjbBox	Undocumented parameter from the OpenJpeg Library.
_pjcColor	Collector for profile, cdef and pclr data.

Returns:: Returns true if successful, returns false otherwise.

static LSBOOL LSE_CALL lsi::CJp2::jp2_read_cmap	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio,
		opj_jp2_box_t *	_pjbBox,
		opj_jp2_color_t *	_pjcColor
	)		`[static, protected]`

Collect component mapping data.

Parameters:

_pjJp2	JP2 handle.
_pcCio	Input buffer stream.
_pjbBox	Undocumented parameter from the OpenJpeg Library.
_pjcColor	Collector for profile, cdef and pclr data.

Returns:: Returns true if successful, returns false otherwise.

static LSBOOL LSE_CALL lsi::CJp2::jp2_read_colr	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio,
		opj_jp2_box_t *	_pjbBox,
		opj_jp2_color_t *	_pjcColor
	)		`[static, protected]`

Collect color specification data.

Parameters:

_pjJp2	JP2 handle.
_pcCio	Input buffer stream.
_pjbBox	Undocumented parameter from the OpenJpeg Library.
_pjcColor	Collector for profile, cdef and pclr data.

Returns:: Returns true if successful, returns false otherwise.

static LSBOOL LSE_CALL lsi::CJp2::jp2_read_ftyp	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio
	)		`[static, protected]`

Read the FTYP box - File type box.

Parameters:

_pjJp2	JP2 handle.
_pcCio	Input buffer stream.

Returns:: Returns true if successful, returns false otherwise.

static LSBOOL LSE_CALL lsi::CJp2::jp2_read_ihdr	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio
	)		`[static, protected]`

Read the IHDR box - Image Header box.

Parameters:

_pjJp2	JP2 handle.
_pcCio	Input buffer stream.

Returns:: Returns true if successful, returns false otherwise.

static LSBOOL LSE_CALL lsi::CJp2::jp2_read_jp	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio
	)		`[static, protected]`

Read the JP box - JPEG 2000 signature.

Parameters:

_pjJp2	JP2 handle.
_pcCio	Input buffer stream.

Returns:: Returns true if successful, returns false otherwise.

static LSBOOL LSE_CALL lsi::CJp2::jp2_read_jp2c	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio,
		LSUINT32 *	_pui32CodeStreamLen,
		LSUINT32 *	_pui32CodeStreamOffset
	)		`[static, protected]`

Undocumented function from the OpenJpeg Library.

Parameters:

_pjJp2	Undocumented parameter from the OpenJpeg Library.
_pcCio	Undocumented parameter from the OpenJpeg Library.
_pui32CodeStreamLen	Undocumented parameter from the OpenJpeg Library.
_pui32CodeStreamOffset	Undocumented parameter from the OpenJpeg Library.

Returns:: Undocumented return from the OpenJpeg Library.

static LSBOOL LSE_CALL lsi::CJp2::jp2_read_jp2h	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio,
		opj_jp2_color_t *	_pjcColor
	)		`[static]`

Read the JP2 Header box (used in MJ2).

Parameters:

_pjJp2	JP2 handle.
_pcCio	Input buffer stream.
_pjcColor	Undocumented paramater from the OpenJpeg Library.

Returns:: Returns true if successful, returns false otherwise.

static LSBOOL LSE_CALL lsi::CJp2::jp2_read_pclr	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio,
		opj_jp2_box_t *	_pjbBox,
		opj_jp2_color_t *	_pjcColor
	)		`[static, protected]`

Collect palette data.

Parameters:

_pjJp2	JP2 handle.
_pcCio	Input buffer stream.
_pjbBox	Undocumented parameter from the OpenJpeg Library.
_pjcColor	Collector for profile, cdef and pclr data.

Returns:: Returns true if successful, returns false otherwise.

static LSBOOL LSE_CALL lsi::CJp2::jp2_read_struct	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio,
		opj_jp2_color_t *	_pjcColor
	)		`[static, protected]`

Decode the structure of a JP2 file.

Parameters:

_pjJp2	JP2 handle.
_pcCio	Input buffer stream.
_pjcColor	Collector for profile, cdef and pclr data.

Returns:: Returns true if successful, returns false otherwise.

static LSVOID LSE_CALL lsi::CJp2::jp2_setup_decoder	(	opj_jp2_t *	_pjJp2,
		CJpegCommonStructs::opj_dparameters_t *	_pdParameters
	)		`[static]`

Setup the decoder decoding parameters using user parameters. Decoding parameters are returned in _pjJp2->j2k->cp.

Parameters:

_pjJp2	JP2 decompressor handle.
_pdParameters	decompression _pdParameters.

static LSVOID LSE_CALL lsi::CJp2::jp2_setup_encoder	(	opj_jp2_t *	_pjJp2,
		CJpegCommonStructs::opj_cparameters_t *	_pdParameters,
		CJpegImage::opj_image_t *	_piImage
	)		`[static]`

Setup the encoder _pdParameters using the current image and using user _pdParameters. Coding _pdParameters are returned in _pjJp2->j2k->cp.

Parameters:

_pjJp2	JP2 compressor handle.
_pdParameters	compression parameters.
_piImage	input filled image.

static LSVOID LSE_CALL lsi::CJp2::jp2_write_bpcc	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio
	)		`[static, protected]`

Undocumented function from the OpenJpeg Library.

Parameters:

_pjJp2	JP2 handle.
_pcCio	Output buffer stream.

static LSVOID LSE_CALL lsi::CJp2::jp2_write_colr	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio
	)		`[static, protected]`

Undocumented function from the OpenJpeg Library.

Parameters:

_pjJp2	JP2 handle.
_pcCio	Output buffer stream.

static LSVOID LSE_CALL lsi::CJp2::jp2_write_ftyp	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio
	)		`[static, protected]`

Write the FTYP box - File type box.

Parameters:

_pjJp2	JP2 handle.
_pcCio	Output buffer stream.

static LSVOID LSE_CALL lsi::CJp2::jp2_write_ihdr	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio
	)		`[static, protected]`

Undocumented function from the OpenJpeg Library.

Parameters:

_pjJp2	JP2 handle.
_pcCio	Output buffer stream.

static LSVOID LSE_CALL lsi::CJp2::jp2_write_jp ( CCio::opj_cio_t * _pcCio ) [static, protected]

Undocumented function from the OpenJpeg Library.

Parameters:

_pcCio Undocumented parameter from the OpenJpeg Library.

static LSINT32 LSE_CALL lsi::CJp2::jp2_write_jp2c	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio,
		CJpegImage::opj_image_t *	_piImage,
		CJpegCommonStructs::opj_codestream_info_t *	_pciInfo
	)		`[static, protected]`

Undocumented function from the OpenJpeg Library.

Parameters:

_pjJp2	Undocumented parameter from the OpenJpeg Library.
_pcCio	Undocumented parameter from the OpenJpeg Library.
_piImage	Undocumented parameter from the OpenJpeg Library.
_pciInfo	Undocumented parameter from the OpenJpeg Library.

Returns:: Undocumented return from the OpenJpeg Library.

static LSVOID LSE_CALL lsi::CJp2::jp2_write_jp2h	(	opj_jp2_t *	_pjJp2,
		CCio::opj_cio_t *	_pcCio
	)		`[static]`

Write the JP2 Header box (used in MJ2).

Parameters:

_pjJp2	JP2 handle.
_pcCio	Output buffer stream.

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

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

lsi::CJp2 Class Reference

Classes

Public Types

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation