2 * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
3 * Copyright (c) 2002-2007, Professor Benoit Macq
4 * Copyright (c) 2001-2003, David Janssens
5 * Copyright (c) 2002-2003, Yannick Verschueren
6 * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
7 * Copyright (c) 2005, Herve Drolon, FreeImage Team
8 * Copyright (c) 2006-2007, Parvatha Elangovan
9 * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
10 * Copyright (c) 2011, Mickael Savinaud, Communications & Systemes <mickael.savinaud@c-s.fr>
12 * All rights reserved.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
39 @brief The JPEG-2000 Codestream Reader/Writer (J2K)
41 The functions in J2K.C have for goal to read/write the several parts of the codestream: markers and data.
44 /** @defgroup J2K J2K - JPEG-2000 codestream reader/writer */
47 #define J2K_CP_CSTY_PRT 0x01
48 #define J2K_CP_CSTY_SOP 0x02
49 #define J2K_CP_CSTY_EPH 0x04
50 #define J2K_CCP_CSTY_PRT 0x01
51 #define J2K_CCP_CBLKSTY_LAZY 0x01 /**< Selective arithmetic coding bypass */
52 #define J2K_CCP_CBLKSTY_RESET 0x02 /**< Reset context probabilities on coding pass boundaries */
53 #define J2K_CCP_CBLKSTY_TERMALL 0x04 /**< Termination on each coding pass */
54 #define J2K_CCP_CBLKSTY_VSC 0x08 /**< Vertically stripe causal context */
55 #define J2K_CCP_CBLKSTY_PTERM 0x10 /**< Predictable termination */
56 #define J2K_CCP_CBLKSTY_SEGSYM 0x20 /**< Segmentation symbols are used */
57 #define J2K_CCP_QNTSTY_NOQNT 0
58 #define J2K_CCP_QNTSTY_SIQNT 1
59 #define J2K_CCP_QNTSTY_SEQNT 2
61 /* ----------------------------------------------------------------------- */
63 #define J2K_MS_SOC 0xff4f /**< SOC marker value */
64 #define J2K_MS_SOT 0xff90 /**< SOT marker value */
65 #define J2K_MS_SOD 0xff93 /**< SOD marker value */
66 #define J2K_MS_EOC 0xffd9 /**< EOC marker value */
67 #define J2K_MS_SIZ 0xff51 /**< SIZ marker value */
68 #define J2K_MS_COD 0xff52 /**< COD marker value */
69 #define J2K_MS_COC 0xff53 /**< COC marker value */
70 #define J2K_MS_RGN 0xff5e /**< RGN marker value */
71 #define J2K_MS_QCD 0xff5c /**< QCD marker value */
72 #define J2K_MS_QCC 0xff5d /**< QCC marker value */
73 #define J2K_MS_POC 0xff5f /**< POC marker value */
74 #define J2K_MS_TLM 0xff55 /**< TLM marker value */
75 #define J2K_MS_PLM 0xff57 /**< PLM marker value */
76 #define J2K_MS_PLT 0xff58 /**< PLT marker value */
77 #define J2K_MS_PPM 0xff60 /**< PPM marker value */
78 #define J2K_MS_PPT 0xff61 /**< PPT marker value */
79 #define J2K_MS_SOP 0xff91 /**< SOP marker value */
80 #define J2K_MS_EPH 0xff92 /**< EPH marker value */
81 #define J2K_MS_CRG 0xff63 /**< CRG marker value */
82 #define J2K_MS_COM 0xff64 /**< COM marker value */
83 #define J2K_MS_CBD 0xff78 /**< CBD marker value */
84 #define J2K_MS_MCC 0xff75 /**< MCC marker value */
85 #define J2K_MS_MCT 0xff74 /**< MCT marker value */
86 #define J2K_MS_MCO 0xff77 /**< MCO marker value */
88 #define J2K_MS_UNK 0 /**< UNKNOWN marker value */
92 #define J2K_MS_EPC 0xff68 /**< EPC marker value (Part 11: JPEG 2000 for Wireless) */
93 #define J2K_MS_EPB 0xff66 /**< EPB marker value (Part 11: JPEG 2000 for Wireless) */
94 #define J2K_MS_ESD 0xff67 /**< ESD marker value (Part 11: JPEG 2000 for Wireless) */
95 #define J2K_MS_RED 0xff69 /**< RED marker value (Part 11: JPEG 2000 for Wireless) */
98 #define J2K_MS_SEC 0xff65 /**< SEC marker value (Part 8: Secure JPEG 2000) */
99 #define J2K_MS_INSEC 0xff94 /**< INSEC marker value (Part 8: Secure JPEG 2000) */
100 #endif /* USE_JPSEC */
103 /* ----------------------------------------------------------------------- */
106 * Values that specify the status of the decoding process when decoding the main header.
107 * These values may be combined with a | operator.
109 typedef enum J2K_STATUS {
110 J2K_STATE_NONE = 0x0000, /**< a SOC marker is expected */
111 J2K_STATE_MHSOC = 0x0001, /**< a SOC marker is expected */
112 J2K_STATE_MHSIZ = 0x0002, /**< a SIZ marker is expected */
113 J2K_STATE_MH = 0x0004, /**< the decoding process is in the main header */
114 J2K_STATE_TPHSOT = 0x0008, /**< the decoding process is in a tile part header and expects a SOT marker */
115 J2K_STATE_TPH = 0x0010, /**< the decoding process is in a tile part header */
116 J2K_STATE_MT = 0x0020, /**< the EOC marker has just been read */
117 J2K_STATE_NEOC = 0x0040, /**< the decoding process must not expect a EOC marker because the codestream is truncated */
119 J2K_STATE_EOC = 0x0100, /**< the decoding process has encountered the EOC marker */
120 J2K_STATE_ERR = 0x8000 /**< the decoding process has encountered an error (FIXME warning V1 = 0x0080)*/
124 * Type of elements storing in the MCT data
126 typedef enum MCT_ELEMENT_TYPE
128 MCT_TYPE_INT16 = 0, /** MCT data is stored as signed shorts*/
129 MCT_TYPE_INT32 = 1, /** MCT data is stored as signed integers*/
130 MCT_TYPE_FLOAT = 2, /** MCT data is stored as floats*/
131 MCT_TYPE_DOUBLE = 3 /** MCT data is stored as doubles*/
132 } J2K_MCT_ELEMENT_TYPE;
137 typedef enum MCT_ARRAY_TYPE
139 MCT_TYPE_DEPENDENCY = 0,
140 MCT_TYPE_DECORRELATION = 1,
142 } J2K_MCT_ARRAY_TYPE;
144 /* ----------------------------------------------------------------------- */
149 typedef enum T2_MODE {
150 THRESH_CALC = 0, /** Function called in Rate allocation process*/
151 FINAL_PASS = 1 /** Function called in Tier 2 process*/
155 * Quantization stepsize
157 typedef struct opj_stepsize {
165 Tile-component coding parameters
167 typedef struct opj_tccp
171 /** number of resolutions */
172 OPJ_UINT32 numresolutions;
173 /** code-blocks width */
175 /** code-blocks height */
177 /** code-block coding style */
179 /** discrete wavelet transform identifier */
181 /** quantisation style */
183 /** stepsizes used for quantization */
184 opj_stepsize_t stepsizes[OPJ_J2K_MAXBANDS];
185 /** number of guard bits */
187 /** Region Of Interest shift */
189 /** precinct width */
190 OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
191 /** precinct height */
192 OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
193 /** the dc_level_shift **/
194 OPJ_INT32 m_dc_level_shift;
203 typedef struct opj_mct_data
205 J2K_MCT_ELEMENT_TYPE m_element_type;
206 J2K_MCT_ARRAY_TYPE m_array_type;
209 OPJ_UINT32 m_data_size;
216 typedef struct opj_simple_mcc_decorrelation_data
219 OPJ_UINT32 m_nb_comps;
220 opj_mct_data_t * m_decorrelation_array;
221 opj_mct_data_t * m_offset_array;
222 OPJ_UINT32 m_is_irreversible : 1;
224 opj_simple_mcc_decorrelation_data_t;
227 Tile coding parameters :
228 this structure is used to store coding/decoding parameters common to all
229 tiles (information like COD, COC in main header)
231 typedef struct opj_tcp
235 /** progression order */
237 /** number of layers */
238 OPJ_UINT32 numlayers;
239 OPJ_UINT32 num_layers_to_decode;
240 /** multi-component transform identifier */
242 /** rates of layers */
243 OPJ_FLOAT32 rates[100];
244 /** number of progression order changes */
246 /** progression order changes */
248 /** packet header store there for futur use in t2_decode_packet */
250 /** used to keep a track of the allocated memory */
251 OPJ_BYTE *ppt_buffer;
252 /** Number of bytes stored inside ppt_data*/
253 OPJ_UINT32 ppt_data_size;
254 /** size of ppt_data*/
256 /** add fixed_quality */
257 OPJ_FLOAT32 distoratio[100];
258 /** tile-component coding parameters */
260 /** number of tile parts for the tile. */
261 OPJ_UINT32 m_nb_tile_parts;
262 /** data for the tile */
265 OPJ_UINT32 m_data_size;
266 /** encoding norms */
267 OPJ_FLOAT64 * mct_norms;
268 /** the mct decoding matrix */
269 OPJ_FLOAT32 * m_mct_decoding_matrix;
270 /** the mct coding matrix */
271 OPJ_FLOAT32 * m_mct_coding_matrix;
273 opj_mct_data_t * m_mct_records;
274 /** the number of mct records. */
275 OPJ_UINT32 m_nb_mct_records;
276 /** the max number of mct records. */
277 OPJ_UINT32 m_nb_max_mct_records;
279 opj_simple_mcc_decorrelation_data_t * m_mcc_records;
280 /** the number of mct records. */
281 OPJ_UINT32 m_nb_mcc_records;
282 /** the max number of mct records. */
283 OPJ_UINT32 m_nb_max_mcc_records;
286 /***** FLAGS *******/
287 /** If ppt == 1 --> there was a PPT marker for the present tile */
289 /** indicates if a POC marker has been used O:NO, 1:YES */
296 typedef struct opj_encoding_param
298 /** Digital cinema profile*/
299 OPJ_CINEMA_MODE m_cinema;
300 /** Maximum rate for each component. If == 0, component size limitation is not considered */
301 OPJ_UINT32 m_max_comp_size;
302 /** Position of tile part flag in progression order*/
305 OPJ_INT32 *m_matrice;
306 /** Flag determining tile part generation*/
308 /** allocation by rate/distortion */
309 OPJ_UINT32 m_disto_alloc : 1;
310 /** allocation by fixed layer */
311 OPJ_UINT32 m_fixed_alloc : 1;
312 /** add fixed_quality */
313 OPJ_UINT32 m_fixed_quality : 1;
314 /** Enabling Tile part generation*/
315 OPJ_UINT32 m_tp_on : 1;
317 opj_encoding_param_t;
319 typedef struct opj_decoding_param
321 /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
323 /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
326 opj_decoding_param_t;
332 typedef struct opj_cp
334 /** Size of the image in bits*/
337 OPJ_RSIZ_CAPABILITIES rsiz;
339 OPJ_UINT32 tx0; /* MSD see norm */
341 OPJ_UINT32 ty0; /* MSD see norm */
348 /** number of tiles in width */
350 /** number of tiles in heigth */
353 /** packet header store there for futur use in t2_decode_packet */
355 /** size of the ppm_data*/
357 /** size of the ppm_data*/
358 OPJ_UINT32 ppm_data_read;
360 OPJ_BYTE *ppm_data_current;
362 /** packet header storage original buffer */
363 OPJ_BYTE *ppm_buffer;
364 /** pointer remaining on the first byte of the first header if ppm is used */
365 OPJ_BYTE *ppm_data_first;
366 /** Number of bytes actually stored inside the ppm_data */
367 OPJ_UINT32 ppm_data_size;
368 /** use in case of multiple marker PPM (number of info already store) */
370 /** use in case of multiple marker PPM (case on non-finished previous info) */
371 OPJ_INT32 ppm_previous;
373 /** tile coding parameters */
378 opj_decoding_param_t m_dec;
379 opj_encoding_param_t m_enc;
386 /** enables writing of EPC in MH, thus activating JPWL */
388 /** enables writing of EPB, in case of activated JPWL */
390 /** enables writing of ESD, in case of activated JPWL */
392 /** enables writing of informative techniques of ESD, in case of activated JPWL */
394 /** enables writing of RED, in case of activated JPWL */
396 /** error protection method for MH (0,1,16,32,37-128) */
398 /** tile number of header protection specification (>=0) */
399 int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
400 /** error protection methods for TPHs (0,1,16,32,37-128) */
401 int hprot_TPH[JPWL_MAX_NO_TILESPECS];
402 /** tile number of packet protection specification (>=0) */
403 int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
404 /** packet number of packet protection specification (>=0) */
405 int pprot_packno[JPWL_MAX_NO_PACKSPECS];
406 /** error protection methods for packets (0,1,16,32,37-128) */
407 int pprot[JPWL_MAX_NO_PACKSPECS];
408 /** enables writing of ESD, (0/2/4 bytes) */
410 /** sensitivity addressing size (0=auto/2/4 bytes) */
412 /** sensitivity range (0-3) */
414 /** sensitivity method for MH (-1,0-7) */
416 /** tile number of sensitivity specification (>=0) */
417 int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
418 /** sensitivity methods for TPHs (-1,0-7) */
419 int sens_TPH[JPWL_MAX_NO_TILESPECS];
420 /** enables JPWL correction at the decoder */
422 /** expected number of components at the decoder */
424 /** maximum number of tiles at the decoder */
425 OPJ_UINT32 max_tiles;
426 #endif /* USE_JPWL */
428 /******** FLAGS *********/
429 /** if ppm == 1 --> there was a PPM marker*/
431 /** tells if the parameter is a coding or decoding one */
432 OPJ_UINT32 m_is_decoder : 1;
437 typedef struct opj_j2k_dec
439 /** locate in which part of the codestream the decoder is (main header, tile header, end) */
442 * store decoding parameters common to all tiles (information like COD, COC in main header)
444 opj_tcp_t *m_default_tcp;
445 OPJ_BYTE *m_header_data;
446 OPJ_UINT32 m_header_data_size;
447 /** to tell the tile part length */
448 OPJ_UINT32 m_sot_length;
449 /** Only tiles index in the correct range will be decoded.*/
450 OPJ_UINT32 m_start_tile_x;
451 OPJ_UINT32 m_start_tile_y;
452 OPJ_UINT32 m_end_tile_x;
453 OPJ_UINT32 m_end_tile_y;
455 * Decoded area set by the user
462 /** Index of the tile to decode (used in get_tile) */
463 OPJ_INT32 m_tile_ind_to_dec;
464 /** Position of the last SOT marker read */
465 OPJ_OFF_T m_last_sot_read_pos;
468 * Indicate that the current tile-part is assume as the last tile part of the codestream.
469 * It is useful in the case of PSot is equal to zero. The sot length will be compute in the
470 * SOD reader function. FIXME NOT USED for the moment
472 OPJ_BOOL m_last_tile_part;
473 /** to tell that a tile can be decoded. */
474 OPJ_UINT32 m_can_decode : 1;
475 OPJ_UINT32 m_discard_tiles : 1;
476 OPJ_UINT32 m_skip_data : 1;
480 typedef struct opj_j2k_enc
482 /** Tile part number, regardless of poc, for each new poc, tp is reset to 1*/
483 OPJ_UINT32 m_current_poc_tile_part_number; /* tp_num */
485 /** Tile part number currently coding, taking into account POC. m_current_tile_part_number holds the total number of tile parts while encoding the last tile part.*/
486 OPJ_UINT32 m_current_tile_part_number; /*cur_tp_num */
489 locate the start position of the TLM marker
490 after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
492 OPJ_OFF_T m_tlm_start;
494 * Stores the sizes of the tlm.
496 OPJ_BYTE * m_tlm_sot_offsets_buffer;
498 * The current offset of the tlm buffer.
500 OPJ_BYTE * m_tlm_sot_offsets_current;
502 /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
503 /** used in TLMmarker*/
504 OPJ_UINT32 m_total_tile_parts; /* totnum_tp */
506 /* encoded data for a tile */
507 OPJ_BYTE * m_encoded_tile_data;
509 /* size of the encoded_data */
510 OPJ_UINT32 m_encoded_tile_size;
512 /* encoded data for a tile */
513 OPJ_BYTE * m_header_tile_data;
515 /* size of the encoded_data */
516 OPJ_UINT32 m_header_tile_data_size;
525 JPEG-2000 codestream reader/writer
527 typedef struct opj_j2k
529 /* J2K codestream is decoded*/
530 OPJ_BOOL m_is_decoder;
535 opj_j2k_dec_t m_decoder;
536 opj_j2k_enc_t m_encoder;
540 /** pointer to the internal/private encoded / decoded image */
541 opj_image_t* m_private_image;
543 /* pointer to the output image (decoded)*/
544 opj_image_t* m_output_image;
546 /** Coding parameters */
549 /** the list of procedures to exec **/
550 opj_procedure_list_t * m_procedure_list;
552 /** the list of validation procedures to follow to make sure the code is valid **/
553 opj_procedure_list_t * m_validation_list;
555 /** helper used to write the index file */
556 opj_codestream_index_t *cstr_index;
558 /** number of the tile curently concern by coding/decoding */
559 OPJ_UINT32 m_current_tile_number;
561 /** the current tile coder/decoder **/
562 struct opj_tcd * m_tcd;
570 /** @name Exported functions */
572 /* ----------------------------------------------------------------------- */
575 Setup the decoder decoding parameters using user parameters.
576 Decoding parameters are returned in j2k->cp.
577 @param j2k J2K decompressor handle
578 @param parameters decompression parameters
580 void opj_j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
583 * Creates a J2K compression structure
585 * @return Returns a handle to a J2K compressor if successful, returns NULL otherwise
587 opj_j2k_t* opj_j2k_create_compress(void);
590 void opj_j2k_setup_encoder( opj_j2k_t *p_j2k,
591 opj_cparameters_t *parameters,
593 opj_event_mgr_t * p_manager);
596 Converts an enum type progression order to string type
598 char *opj_j2k_convert_progression_order(OPJ_PROG_ORDER prg_order);
600 /* ----------------------------------------------------------------------- */
606 * Ends the decompression procedures and possibiliy add data to be read after the
609 OPJ_BOOL opj_j2k_end_decompress(opj_j2k_t *j2k,
610 opj_stream_private_t *p_stream,
611 opj_event_mgr_t * p_manager);
614 * Reads a jpeg2000 codestream header structure.
616 * @param p_stream the stream to read data from.
617 * @param p_j2k the jpeg2000 codec.
618 * @param p_image FIXME DOC
619 * @param p_manager the user event manager.
621 * @return true if the box is valid.
623 OPJ_BOOL opj_j2k_read_header( opj_stream_private_t *p_stream,
625 opj_image_t** p_image,
626 opj_event_mgr_t* p_manager );
630 * Destroys a jpeg2000 codec.
632 * @param p_j2k the jpeg20000 structure to destroy.
634 void opj_j2k_destroy (opj_j2k_t *p_j2k);
637 * Destroys a codestream index structure.
639 * @param p_cstr_ind the codestream index parameter to destroy.
641 void j2k_destroy_cstr_index (opj_codestream_index_t *p_cstr_ind);
645 * @param p_j2k the jpeg2000 codec.
646 * @param p_tile_index
647 * @param p_data FIXME DOC
648 * @param p_data_size FIXME DOC
649 * @param p_stream the stream to write data to.
650 * @param p_manager the user event manager.
652 OPJ_BOOL opj_j2k_decode_tile ( opj_j2k_t * p_j2k,
653 OPJ_UINT32 p_tile_index,
655 OPJ_UINT32 p_data_size,
656 opj_stream_private_t *p_stream,
657 opj_event_mgr_t * p_manager );
660 * Reads a tile header.
661 * @param p_j2k the jpeg2000 codec.
662 * @param p_tile_index FIXME DOC
663 * @param p_data_size FIXME DOC
664 * @param p_tile_x0 FIXME DOC
665 * @param p_tile_y0 FIXME DOC
666 * @param p_tile_x1 FIXME DOC
667 * @param p_tile_y1 FIXME DOC
668 * @param p_nb_comps FIXME DOC
669 * @param p_go_on FIXME DOC
670 * @param p_stream the stream to write data to.
671 * @param p_manager the user event manager.
673 OPJ_BOOL opj_j2k_read_tile_header ( opj_j2k_t * p_j2k,
674 OPJ_UINT32 * p_tile_index,
675 OPJ_UINT32 * p_data_size,
676 OPJ_INT32 * p_tile_x0,
677 OPJ_INT32 * p_tile_y0,
678 OPJ_INT32 * p_tile_x1,
679 OPJ_INT32 * p_tile_y1,
680 OPJ_UINT32 * p_nb_comps,
682 opj_stream_private_t *p_stream,
683 opj_event_mgr_t * p_manager );
687 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
689 * @param p_j2k the jpeg2000 codec.
690 * @param p_image FIXME DOC
691 * @param p_start_x the left position of the rectangle to decode (in image coordinates).
692 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
693 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
694 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
695 * @param p_manager the user event manager
697 * @return true if the area could be set.
699 OPJ_BOOL opj_j2k_set_decode_area( opj_j2k_t *p_j2k,
700 opj_image_t* p_image,
701 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
702 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
703 opj_event_mgr_t * p_manager );
706 * Creates a J2K decompression structure.
708 * @return a handle to a J2K decompressor if successful, NULL otherwise.
710 opj_j2k_t* opj_j2k_create_decompress(void);
714 * Dump some elements from the J2K decompression structure .
716 *@param p_j2k the jpeg2000 codec.
717 *@param flag flag to describe what elments are dump.
718 *@param out_stream output stream where dump the elements.
721 void j2k_dump (opj_j2k_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
726 * Dump an image header structure.
728 *@param image the image header to dump.
729 *@param dev_dump_flag flag to describe if we are in the case of this function is use outside j2k_dump function
730 *@param out_stream output stream where dump the elements.
732 void j2k_dump_image_header(opj_image_t* image, OPJ_BOOL dev_dump_flag, FILE* out_stream);
735 * Dump a component image header structure.
737 *@param comp the component image header to dump.
738 *@param dev_dump_flag flag to describe if we are in the case of this function is use outside j2k_dump function
739 *@param out_stream output stream where dump the elements.
741 void j2k_dump_image_comp_header(opj_image_comp_t* comp, OPJ_BOOL dev_dump_flag, FILE* out_stream);
744 * Get the codestream info from a JPEG2000 codec.
746 *@param p_j2k the component image header to dump.
748 *@return the codestream information extract from the jpg2000 codec
750 opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_t* p_j2k);
753 * Get the codestream index from a JPEG2000 codec.
755 *@param p_j2k the component image header to dump.
757 *@return the codestream index extract from the jpg2000 codec
759 opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_t* p_j2k);
762 * Decode an image from a JPEG-2000 codestream
763 * @param j2k J2K decompressor handle
764 * @param p_stream FIXME DOC
765 * @param p_image FIXME DOC
766 * @param p_manager FIXME DOC
769 OPJ_BOOL opj_j2k_decode(opj_j2k_t *j2k,
770 opj_stream_private_t *p_stream,
771 opj_image_t *p_image,
772 opj_event_mgr_t *p_manager);
775 OPJ_BOOL opj_j2k_get_tile( opj_j2k_t *p_j2k,
776 opj_stream_private_t *p_stream,
777 opj_image_t* p_image,
778 opj_event_mgr_t * p_manager,
779 OPJ_UINT32 tile_index );
781 OPJ_BOOL opj_j2k_set_decoded_resolution_factor(opj_j2k_t *p_j2k,
782 OPJ_UINT32 res_factor,
783 opj_event_mgr_t * p_manager);
788 * @param p_j2k the jpeg2000 codec.
789 * @param p_tile_index FIXME DOC
790 * @param p_data FIXME DOC
791 * @param p_data_size FIXME DOC
792 * @param p_stream the stream to write data to.
793 * @param p_manager the user event manager.
795 OPJ_BOOL opj_j2k_write_tile ( opj_j2k_t * p_j2k,
796 OPJ_UINT32 p_tile_index,
798 OPJ_UINT32 p_data_size,
799 opj_stream_private_t *p_stream,
800 opj_event_mgr_t * p_manager );
803 * Encodes an image into a JPEG-2000 codestream
805 OPJ_BOOL opj_j2k_encode_v2( opj_j2k_t * p_j2k,
806 opj_stream_private_t *cio,
807 opj_event_mgr_t * p_manager );
810 * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
812 * @param p_j2k the jpeg2000 codec.
813 * @param p_stream the stream object.
814 * @param p_image FIXME DOC
815 * @param p_manager the user event manager.
817 * @return true if the codec is valid.
819 OPJ_BOOL opj_j2k_start_compress(opj_j2k_t *p_j2k,
820 opj_stream_private_t *p_stream,
821 opj_image_t * p_image,
822 opj_event_mgr_t * p_manager);
825 * Ends the compression procedures and possibiliy add data to be read after the
828 OPJ_BOOL opj_j2k_end_compress( opj_j2k_t *p_j2k,
829 opj_stream_private_t *cio,
830 opj_event_mgr_t * p_manager);
832 OPJ_BOOL opj_j2k_setup_mct_encoding (opj_tcp_t * p_tcp, opj_image_t * p_image);