OpenJPEG: jp2.h File Reference

OpenJPEG 2.3.0

Data Structures | Macros | Typedefs | Enumerations
jp2.h File Reference

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

Go to the source code of this file.

## Data Structures
struct | opj_jp2_cdef_info
| Channel description: channel index, type, association More...
struct | opj_jp2_cdef
| Channel descriptions and number of descriptions More...
struct | opj_jp2_cmap_comp
| Component mappings: channel index, mapping type, palette index More...
struct | opj_jp2_pclr
| Palette data: table entries, palette columns More...
struct | opj_jp2_color
| Collector for ICC profile, palette, component mapping, channel description More...
struct | opj_jp2_comps
| JP2 component More...
struct | opj_jp2
| JPEG-2000 file format reader/writer More...
struct | opj_jp2_box
| JP2 Box More...
struct | opj_jp2_header_handler
struct | opj_jp2_img_header_writer_handler

## Macros
#define | JP2_JP 0x6a502020
| JPEG 2000 signature box. More...
#define | JP2_FTYP 0x66747970
| File type box. More...
#define | JP2_JP2H 0x6a703268
| JP2 header box (super-box) More...
#define | JP2_IHDR 0x69686472
| Image header box. More...
#define | JP2_COLR 0x636f6c72
| Colour specification box. More...
#define | JP2_JP2C 0x6a703263
| Contiguous codestream box. More...
#define | JP2_URL 0x75726c20
| Data entry URL box. More...
#define | JP2_PCLR 0x70636c72
| Palette box. More...
#define | JP2_CMAP 0x636d6170
| Component Mapping box. More...
#define | JP2_CDEF 0x63646566
| Channel Definition box. More...
#define | JP2_DTBL 0x6474626c
| Data Reference box. More...
#define | JP2_BPCC 0x62706363
| Bits per component box. More...
#define | JP2_JP2 0x6a703220
| File type fields. More...

## Typedefs
typedef struct opj_jp2_cdef_info | opj_jp2_cdef_info_t
| Channel description: channel index, type, association More...
typedef struct opj_jp2_cdef | opj_jp2_cdef_t
| Channel descriptions and number of descriptions More...
typedef struct opj_jp2_cmap_comp | opj_jp2_cmap_comp_t
| Component mappings: channel index, mapping type, palette index More...
typedef struct opj_jp2_pclr | opj_jp2_pclr_t
| Palette data: table entries, palette columns More...
typedef struct opj_jp2_color | opj_jp2_color_t
| Collector for ICC profile, palette, component mapping, channel description More...
typedef struct opj_jp2_comps | opj_jp2_comps_t
| JP2 component More...
typedef struct opj_jp2 | opj_jp2_t
| JPEG-2000 file format reader/writer More...
typedef struct opj_jp2_box | opj_jp2_box_t
| JP2 Box More...
typedef struct opj_jp2_header_handler | opj_jp2_header_handler_t
typedef struct opj_jp2_img_header_writer_handler | opj_jp2_img_header_writer_handler_t

## Enumerations
enum | JP2_STATE { JP2_STATE_NONE = 0x0, JP2_STATE_SIGNATURE = 0x1, JP2_STATE_FILE_TYPE = 0x2, JP2_STATE_HEADER = 0x4, JP2_STATE_CODESTREAM = 0x8, JP2_STATE_END_CODESTREAM = 0x10, JP2_STATE_UNKNOWN = 0x7fffffff }
| < Resolution box (super-box) More...
enum | JP2_IMG_STATE { JP2_IMG_STATE_NONE = 0x0, JP2_IMG_STATE_UNKNOWN = 0x7fffffff }

## Functions
Exported functions
void | opj_jp2_setup_decoder (opj_jp2_t *jp2, opj_dparameters_t *parameters)
| Setup the decoder decoding parameters using user parameters. More...
OPJ_BOOL | opj_jp2_set_threads (opj_jp2_t *jp2, OPJ_UINT32 num_threads)
| Allocates worker threads for the compressor/decompressor. More...
OPJ_BOOL | opj_jp2_decode (opj_jp2_t *jp2, opj_stream_private_t *p_stream, opj_image_t *p_image, opj_event_mgr_t *p_manager)
| Decode an image from a JPEG-2000 file stream. More...
OPJ_BOOL | opj_jp2_setup_encoder (opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image, opj_event_mgr_t *p_manager)
| Setup the encoder parameters using the current image and using user parameters. More...
OPJ_BOOL | opj_jp2_encode (opj_jp2_t *jp2, opj_stream_private_t *stream, opj_event_mgr_t *p_manager)
| Encode an image into a JPEG-2000 file stream More...
OPJ_BOOL | opj_jp2_start_compress (opj_jp2_t *jp2, opj_stream_private_t *stream, opj_image_t *p_image, opj_event_mgr_t *p_manager)
| Starts a compression scheme, i.e. More...
OPJ_BOOL | opj_jp2_end_compress (opj_jp2_t *jp2, opj_stream_private_t *cio, opj_event_mgr_t *p_manager)
| Ends the compression procedures and possibiliy add data to be read after the codestream. More...
OPJ_BOOL | opj_jp2_end_decompress (opj_jp2_t *jp2, opj_stream_private_t *cio, opj_event_mgr_t *p_manager)
| Ends the decompression procedures and possibiliy add data to be read after the codestream. More...
OPJ_BOOL | opj_jp2_read_header (opj_stream_private_t *p_stream, opj_jp2_t *jp2, opj_image_t **p_image, opj_event_mgr_t *p_manager)
| Reads a jpeg2000 file header structure. More...
OPJ_BOOL | opj_jp2_set_decoded_components (opj_jp2_t *jp2, OPJ_UINT32 numcomps, const OPJ_UINT32 *comps_indices, opj_event_mgr_t *p_manager)
| Sets the indices of the components to decode. More...
OPJ_BOOL | opj_jp2_read_tile_header (opj_jp2_t *p_jp2, OPJ_UINT32 *p_tile_index, OPJ_UINT32 *p_data_size, OPJ_INT32 *p_tile_x0, OPJ_INT32 *p_tile_y0, OPJ_INT32 *p_tile_x1, OPJ_INT32 *p_tile_y1, OPJ_UINT32 *p_nb_comps, OPJ_BOOL *p_go_on, opj_stream_private_t *p_stream, opj_event_mgr_t *p_manager)
| Reads a tile header. More...
OPJ_BOOL | opj_jp2_write_tile (opj_jp2_t *p_jp2, OPJ_UINT32 p_tile_index, OPJ_BYTE *p_data, OPJ_UINT32 p_data_size, opj_stream_private_t *p_stream, opj_event_mgr_t *p_manager)
| Writes a tile. More...
OPJ_BOOL | opj_jp2_decode_tile (opj_jp2_t *p_jp2, OPJ_UINT32 p_tile_index, OPJ_BYTE *p_data, OPJ_UINT32 p_data_size, opj_stream_private_t *p_stream, opj_event_mgr_t *p_manager)
| Decode tile data. More...
opj_jp2_t * | opj_jp2_create (OPJ_BOOL p_is_decoder)
| Creates a jpeg2000 file decompressor. More...
void | opj_jp2_destroy (opj_jp2_t *jp2)
| Destroy a JP2 decompressor handle More...
OPJ_BOOL | opj_jp2_set_decode_area (opj_jp2_t *p_jp2, opj_image_t *p_image, OPJ_INT32 p_start_x, OPJ_INT32 p_start_y, OPJ_INT32 p_end_x, OPJ_INT32 p_end_y, opj_event_mgr_t *p_manager)
| Sets the given area to be decoded. More...
OPJ_BOOL | opj_jp2_get_tile (opj_jp2_t *p_jp2, opj_stream_private_t *p_stream, opj_image_t *p_image, opj_event_mgr_t *p_manager, OPJ_UINT32 tile_index)
OPJ_BOOL | opj_jp2_set_decoded_resolution_factor (opj_jp2_t *p_jp2, OPJ_UINT32 res_factor, opj_event_mgr_t *p_manager)
void | jp2_dump (opj_jp2_t *p_jp2, OPJ_INT32 flag, FILE *out_stream)
| Dump some elements from the JP2 decompression structure . More...
opj_codestream_info_v2_t * | jp2_get_cstr_info (opj_jp2_t *p_jp2)
| Get the codestream info from a JPEG2000 codec. More...
opj_codestream_index_t * | jp2_get_cstr_index (opj_jp2_t *p_jp2)
| Get the codestream index from a JPEG2000 codec. More...

## Detailed Description

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