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-2012, Centre National d'Etudes Spatiales (CNES), France
11 * Copyright (c) 2012, CS Systemes d'Information, France
13 * All rights reserved.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
40 @brief The JPEG-2000 Codestream Reader/Writer (J2K)
42 The functions in J2K.C have for goal to read/write the several parts of the codestream: markers and data.
45 /** @defgroup J2K J2K - JPEG-2000 codestream reader/writer */
48 #define J2K_CP_CSTY_PRT 0x01
49 #define J2K_CP_CSTY_SOP 0x02
50 #define J2K_CP_CSTY_EPH 0x04
51 #define J2K_CCP_CSTY_PRT 0x01
52 #define J2K_CCP_CBLKSTY_LAZY 0x01 /**< Selective arithmetic coding bypass */
53 #define J2K_CCP_CBLKSTY_RESET 0x02 /**< Reset context probabilities on coding pass boundaries */
54 #define J2K_CCP_CBLKSTY_TERMALL 0x04 /**< Termination on each coding pass */
55 #define J2K_CCP_CBLKSTY_VSC 0x08 /**< Vertically stripe causal context */
56 #define J2K_CCP_CBLKSTY_PTERM 0x10 /**< Predictable termination */
57 #define J2K_CCP_CBLKSTY_SEGSYM 0x20 /**< Segmentation symbols are used */
58 #define J2K_CCP_QNTSTY_NOQNT 0
59 #define J2K_CCP_QNTSTY_SIQNT 1
60 #define J2K_CCP_QNTSTY_SEQNT 2
62 #define OPJ_J2K_DEFAULT_CBLK_DATA_SIZE 8192
64 /* ----------------------------------------------------------------------- */
66 #define J2K_MS_SOC 0xff4f /**< SOC marker value */
67 #define J2K_MS_SOT 0xff90 /**< SOT marker value */
68 #define J2K_MS_SOD 0xff93 /**< SOD marker value */
69 #define J2K_MS_EOC 0xffd9 /**< EOC marker value */
70 #define J2K_MS_SIZ 0xff51 /**< SIZ marker value */
71 #define J2K_MS_COD 0xff52 /**< COD marker value */
72 #define J2K_MS_COC 0xff53 /**< COC marker value */
73 #define J2K_MS_RGN 0xff5e /**< RGN marker value */
74 #define J2K_MS_QCD 0xff5c /**< QCD marker value */
75 #define J2K_MS_QCC 0xff5d /**< QCC marker value */
76 #define J2K_MS_POC 0xff5f /**< POC marker value */
77 #define J2K_MS_TLM 0xff55 /**< TLM marker value */
78 #define J2K_MS_PLM 0xff57 /**< PLM marker value */
79 #define J2K_MS_PLT 0xff58 /**< PLT marker value */
80 #define J2K_MS_PPM 0xff60 /**< PPM marker value */
81 #define J2K_MS_PPT 0xff61 /**< PPT marker value */
82 #define J2K_MS_SOP 0xff91 /**< SOP marker value */
83 #define J2K_MS_EPH 0xff92 /**< EPH marker value */
84 #define J2K_MS_CRG 0xff63 /**< CRG marker value */
85 #define J2K_MS_COM 0xff64 /**< COM marker value */
86 #define J2K_MS_CBD 0xff78 /**< CBD marker value */
87 #define J2K_MS_MCC 0xff75 /**< MCC marker value */
88 #define J2K_MS_MCT 0xff74 /**< MCT marker value */
89 #define J2K_MS_MCO 0xff77 /**< MCO marker value */
91 #define J2K_MS_UNK 0 /**< UNKNOWN marker value */
95 #define J2K_MS_EPC 0xff68 /**< EPC marker value (Part 11: JPEG 2000 for Wireless) */
96 #define J2K_MS_EPB 0xff66 /**< EPB marker value (Part 11: JPEG 2000 for Wireless) */
97 #define J2K_MS_ESD 0xff67 /**< ESD marker value (Part 11: JPEG 2000 for Wireless) */
98 #define J2K_MS_RED 0xff69 /**< RED marker value (Part 11: JPEG 2000 for Wireless) */
101 #define J2K_MS_SEC 0xff65 /**< SEC marker value (Part 8: Secure JPEG 2000) */
102 #define J2K_MS_INSEC 0xff94 /**< INSEC marker value (Part 8: Secure JPEG 2000) */
103 #endif /* USE_JPSEC */
106 /* ----------------------------------------------------------------------- */
109 * Values that specify the status of the decoding process when decoding the main header.
110 * These values may be combined with a | operator.
112 typedef enum J2K_STATUS {
113 J2K_STATE_NONE = 0x0000, /**< a SOC marker is expected */
114 J2K_STATE_MHSOC = 0x0001, /**< a SOC marker is expected */
115 J2K_STATE_MHSIZ = 0x0002, /**< a SIZ marker is expected */
116 J2K_STATE_MH = 0x0004, /**< the decoding process is in the main header */
117 J2K_STATE_TPHSOT = 0x0008, /**< the decoding process is in a tile part header and expects a SOT marker */
118 J2K_STATE_TPH = 0x0010, /**< the decoding process is in a tile part header */
119 J2K_STATE_MT = 0x0020, /**< the EOC marker has just been read */
120 J2K_STATE_NEOC = 0x0040, /**< the decoding process must not expect a EOC marker because the codestream is truncated */
122 J2K_STATE_EOC = 0x0100, /**< the decoding process has encountered the EOC marker */
123 J2K_STATE_ERR = 0x8000 /**< the decoding process has encountered an error (FIXME warning V1 = 0x0080)*/
127 * Type of elements storing in the MCT data
129 typedef enum MCT_ELEMENT_TYPE
131 MCT_TYPE_INT16 = 0, /** MCT data is stored as signed shorts*/
132 MCT_TYPE_INT32 = 1, /** MCT data is stored as signed integers*/
133 MCT_TYPE_FLOAT = 2, /** MCT data is stored as floats*/
134 MCT_TYPE_DOUBLE = 3 /** MCT data is stored as doubles*/
135 } J2K_MCT_ELEMENT_TYPE;
140 typedef enum MCT_ARRAY_TYPE
142 MCT_TYPE_DEPENDENCY = 0,
143 MCT_TYPE_DECORRELATION = 1,
145 } J2K_MCT_ARRAY_TYPE;
147 /* ----------------------------------------------------------------------- */
152 typedef enum T2_MODE {
153 THRESH_CALC = 0, /** Function called in Rate allocation process*/
154 FINAL_PASS = 1 /** Function called in Tier 2 process*/
158 * Quantization stepsize
160 typedef struct opj_stepsize {
168 Tile-component coding parameters
170 typedef struct opj_tccp
174 /** number of resolutions */
175 OPJ_UINT32 numresolutions;
176 /** code-blocks width */
178 /** code-blocks height */
180 /** code-block coding style */
182 /** discrete wavelet transform identifier */
184 /** quantisation style */
186 /** stepsizes used for quantization */
187 opj_stepsize_t stepsizes[OPJ_J2K_MAXBANDS];
188 /** number of guard bits */
190 /** Region Of Interest shift */
192 /** precinct width */
193 OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
194 /** precinct height */
195 OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
196 /** the dc_level_shift **/
197 OPJ_INT32 m_dc_level_shift;
206 typedef struct opj_mct_data
208 J2K_MCT_ELEMENT_TYPE m_element_type;
209 J2K_MCT_ARRAY_TYPE m_array_type;
212 OPJ_UINT32 m_data_size;
219 typedef struct opj_simple_mcc_decorrelation_data
222 OPJ_UINT32 m_nb_comps;
223 opj_mct_data_t * m_decorrelation_array;
224 opj_mct_data_t * m_offset_array;
225 OPJ_UINT32 m_is_irreversible : 1;
227 opj_simple_mcc_decorrelation_data_t;
230 Tile coding parameters :
231 this structure is used to store coding/decoding parameters common to all
232 tiles (information like COD, COC in main header)
234 typedef struct opj_tcp
238 /** progression order */
240 /** number of layers */
241 OPJ_UINT32 numlayers;
242 OPJ_UINT32 num_layers_to_decode;
243 /** multi-component transform identifier */
245 /** rates of layers */
246 OPJ_FLOAT32 rates[100];
247 /** number of progression order changes */
249 /** progression order changes */
251 /** packet header store there for futur use in t2_decode_packet */
253 /** used to keep a track of the allocated memory */
254 OPJ_BYTE *ppt_buffer;
255 /** Number of bytes stored inside ppt_data*/
256 OPJ_UINT32 ppt_data_size;
257 /** size of ppt_data*/
259 /** add fixed_quality */
260 OPJ_FLOAT32 distoratio[100];
261 /** tile-component coding parameters */
263 /** number of tile parts for the tile. */
264 OPJ_UINT32 m_nb_tile_parts;
265 /** data for the tile */
268 OPJ_UINT32 m_data_size;
269 /** encoding norms */
270 OPJ_FLOAT64 * mct_norms;
271 /** the mct decoding matrix */
272 OPJ_FLOAT32 * m_mct_decoding_matrix;
273 /** the mct coding matrix */
274 OPJ_FLOAT32 * m_mct_coding_matrix;
276 opj_mct_data_t * m_mct_records;
277 /** the number of mct records. */
278 OPJ_UINT32 m_nb_mct_records;
279 /** the max number of mct records. */
280 OPJ_UINT32 m_nb_max_mct_records;
282 opj_simple_mcc_decorrelation_data_t * m_mcc_records;
283 /** the number of mct records. */
284 OPJ_UINT32 m_nb_mcc_records;
285 /** the max number of mct records. */
286 OPJ_UINT32 m_nb_max_mcc_records;
289 /***** FLAGS *******/
290 /** If ppt == 1 --> there was a PPT marker for the present tile */
292 /** indicates if a POC marker has been used O:NO, 1:YES */
299 typedef struct opj_encoding_param
301 /** Digital cinema profile*/
302 OPJ_CINEMA_MODE m_cinema;
303 /** Maximum rate for each component. If == 0, component size limitation is not considered */
304 OPJ_UINT32 m_max_comp_size;
305 /** Position of tile part flag in progression order*/
308 OPJ_INT32 *m_matrice;
309 /** Flag determining tile part generation*/
311 /** allocation by rate/distortion */
312 OPJ_UINT32 m_disto_alloc : 1;
313 /** allocation by fixed layer */
314 OPJ_UINT32 m_fixed_alloc : 1;
315 /** add fixed_quality */
316 OPJ_UINT32 m_fixed_quality : 1;
317 /** Enabling Tile part generation*/
318 OPJ_UINT32 m_tp_on : 1;
320 opj_encoding_param_t;
322 typedef struct opj_decoding_param
324 /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
326 /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
329 opj_decoding_param_t;
335 typedef struct opj_cp
337 /** Size of the image in bits*/
340 OPJ_RSIZ_CAPABILITIES rsiz;
342 OPJ_UINT32 tx0; /* MSD see norm */
344 OPJ_UINT32 ty0; /* MSD see norm */
351 /** number of tiles in width */
353 /** number of tiles in heigth */
356 /** packet header store there for futur use in t2_decode_packet */
358 /** size of the ppm_data*/
360 /** size of the ppm_data*/
361 OPJ_UINT32 ppm_data_read;
363 OPJ_BYTE *ppm_data_current;
365 /** packet header storage original buffer */
366 OPJ_BYTE *ppm_buffer;
367 /** pointer remaining on the first byte of the first header if ppm is used */
368 OPJ_BYTE *ppm_data_first;
369 /** Number of bytes actually stored inside the ppm_data */
370 OPJ_UINT32 ppm_data_size;
371 /** use in case of multiple marker PPM (number of info already store) */
373 /** use in case of multiple marker PPM (case on non-finished previous info) */
374 OPJ_INT32 ppm_previous;
376 /** tile coding parameters */
381 opj_decoding_param_t m_dec;
382 opj_encoding_param_t m_enc;
389 /** enables writing of EPC in MH, thus activating JPWL */
391 /** enables writing of EPB, in case of activated JPWL */
393 /** enables writing of ESD, in case of activated JPWL */
395 /** enables writing of informative techniques of ESD, in case of activated JPWL */
397 /** enables writing of RED, in case of activated JPWL */
399 /** error protection method for MH (0,1,16,32,37-128) */
401 /** tile number of header protection specification (>=0) */
402 int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
403 /** error protection methods for TPHs (0,1,16,32,37-128) */
404 int hprot_TPH[JPWL_MAX_NO_TILESPECS];
405 /** tile number of packet protection specification (>=0) */
406 int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
407 /** packet number of packet protection specification (>=0) */
408 int pprot_packno[JPWL_MAX_NO_PACKSPECS];
409 /** error protection methods for packets (0,1,16,32,37-128) */
410 int pprot[JPWL_MAX_NO_PACKSPECS];
411 /** enables writing of ESD, (0/2/4 bytes) */
413 /** sensitivity addressing size (0=auto/2/4 bytes) */
415 /** sensitivity range (0-3) */
417 /** sensitivity method for MH (-1,0-7) */
419 /** tile number of sensitivity specification (>=0) */
420 int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
421 /** sensitivity methods for TPHs (-1,0-7) */
422 int sens_TPH[JPWL_MAX_NO_TILESPECS];
423 /** enables JPWL correction at the decoder */
425 /** expected number of components at the decoder */
427 /** maximum number of tiles at the decoder */
428 OPJ_UINT32 max_tiles;
429 #endif /* USE_JPWL */
431 /******** FLAGS *********/
432 /** if ppm == 1 --> there was a PPM marker*/
434 /** tells if the parameter is a coding or decoding one */
435 OPJ_UINT32 m_is_decoder : 1;
440 typedef struct opj_j2k_dec
442 /** locate in which part of the codestream the decoder is (main header, tile header, end) */
445 * store decoding parameters common to all tiles (information like COD, COC in main header)
447 opj_tcp_t *m_default_tcp;
448 OPJ_BYTE *m_header_data;
449 OPJ_UINT32 m_header_data_size;
450 /** to tell the tile part length */
451 OPJ_UINT32 m_sot_length;
452 /** Only tiles index in the correct range will be decoded.*/
453 OPJ_UINT32 m_start_tile_x;
454 OPJ_UINT32 m_start_tile_y;
455 OPJ_UINT32 m_end_tile_x;
456 OPJ_UINT32 m_end_tile_y;
458 * Decoded area set by the user
465 /** Index of the tile to decode (used in get_tile) */
466 OPJ_INT32 m_tile_ind_to_dec;
467 /** Position of the last SOT marker read */
468 OPJ_OFF_T m_last_sot_read_pos;
471 * Indicate that the current tile-part is assume as the last tile part of the codestream.
472 * It is useful in the case of PSot is equal to zero. The sot length will be compute in the
473 * SOD reader function. FIXME NOT USED for the moment
475 OPJ_BOOL m_last_tile_part;
476 /** to tell that a tile can be decoded. */
477 OPJ_UINT32 m_can_decode : 1;
478 OPJ_UINT32 m_discard_tiles : 1;
479 OPJ_UINT32 m_skip_data : 1;
483 typedef struct opj_j2k_enc
485 /** Tile part number, regardless of poc, for each new poc, tp is reset to 1*/
486 OPJ_UINT32 m_current_poc_tile_part_number; /* tp_num */
488 /** 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.*/
489 OPJ_UINT32 m_current_tile_part_number; /*cur_tp_num */
492 locate the start position of the TLM marker
493 after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
495 OPJ_OFF_T m_tlm_start;
497 * Stores the sizes of the tlm.
499 OPJ_BYTE * m_tlm_sot_offsets_buffer;
501 * The current offset of the tlm buffer.
503 OPJ_BYTE * m_tlm_sot_offsets_current;
505 /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
506 /** used in TLMmarker*/
507 OPJ_UINT32 m_total_tile_parts; /* totnum_tp */
509 /* encoded data for a tile */
510 OPJ_BYTE * m_encoded_tile_data;
512 /* size of the encoded_data */
513 OPJ_UINT32 m_encoded_tile_size;
515 /* encoded data for a tile */
516 OPJ_BYTE * m_header_tile_data;
518 /* size of the encoded_data */
519 OPJ_UINT32 m_header_tile_data_size;
528 JPEG-2000 codestream reader/writer
530 typedef struct opj_j2k
532 /* J2K codestream is decoded*/
533 OPJ_BOOL m_is_decoder;
538 opj_j2k_dec_t m_decoder;
539 opj_j2k_enc_t m_encoder;
543 /** pointer to the internal/private encoded / decoded image */
544 opj_image_t* m_private_image;
546 /* pointer to the output image (decoded)*/
547 opj_image_t* m_output_image;
549 /** Coding parameters */
552 /** the list of procedures to exec **/
553 opj_procedure_list_t * m_procedure_list;
555 /** the list of validation procedures to follow to make sure the code is valid **/
556 opj_procedure_list_t * m_validation_list;
558 /** helper used to write the index file */
559 opj_codestream_index_t *cstr_index;
561 /** number of the tile curently concern by coding/decoding */
562 OPJ_UINT32 m_current_tile_number;
564 /** the current tile coder/decoder **/
565 struct opj_tcd * m_tcd;
573 /** @name Exported functions */
575 /* ----------------------------------------------------------------------- */
578 Setup the decoder decoding parameters using user parameters.
579 Decoding parameters are returned in j2k->cp.
580 @param j2k J2K decompressor handle
581 @param parameters decompression parameters
583 void opj_j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
586 * Creates a J2K compression structure
588 * @return Returns a handle to a J2K compressor if successful, returns NULL otherwise
590 opj_j2k_t* opj_j2k_create_compress(void);
593 void opj_j2k_setup_encoder( opj_j2k_t *p_j2k,
594 opj_cparameters_t *parameters,
596 opj_event_mgr_t * p_manager);
599 Converts an enum type progression order to string type
601 char *opj_j2k_convert_progression_order(OPJ_PROG_ORDER prg_order);
603 /* ----------------------------------------------------------------------- */
609 * Ends the decompression procedures and possibiliy add data to be read after the
612 OPJ_BOOL opj_j2k_end_decompress(opj_j2k_t *j2k,
613 opj_stream_private_t *p_stream,
614 opj_event_mgr_t * p_manager);
617 * Reads a jpeg2000 codestream header structure.
619 * @param p_stream the stream to read data from.
620 * @param p_j2k the jpeg2000 codec.
621 * @param p_image FIXME DOC
622 * @param p_manager the user event manager.
624 * @return true if the box is valid.
626 OPJ_BOOL opj_j2k_read_header( opj_stream_private_t *p_stream,
628 opj_image_t** p_image,
629 opj_event_mgr_t* p_manager );
633 * Destroys a jpeg2000 codec.
635 * @param p_j2k the jpeg20000 structure to destroy.
637 void opj_j2k_destroy (opj_j2k_t *p_j2k);
640 * Destroys a codestream index structure.
642 * @param p_cstr_ind the codestream index parameter to destroy.
644 void j2k_destroy_cstr_index (opj_codestream_index_t *p_cstr_ind);
648 * @param p_j2k the jpeg2000 codec.
649 * @param p_tile_index
650 * @param p_data FIXME DOC
651 * @param p_data_size FIXME DOC
652 * @param p_stream the stream to write data to.
653 * @param p_manager the user event manager.
655 OPJ_BOOL opj_j2k_decode_tile ( opj_j2k_t * p_j2k,
656 OPJ_UINT32 p_tile_index,
658 OPJ_UINT32 p_data_size,
659 opj_stream_private_t *p_stream,
660 opj_event_mgr_t * p_manager );
663 * Reads a tile header.
664 * @param p_j2k the jpeg2000 codec.
665 * @param p_tile_index FIXME DOC
666 * @param p_data_size FIXME DOC
667 * @param p_tile_x0 FIXME DOC
668 * @param p_tile_y0 FIXME DOC
669 * @param p_tile_x1 FIXME DOC
670 * @param p_tile_y1 FIXME DOC
671 * @param p_nb_comps FIXME DOC
672 * @param p_go_on FIXME DOC
673 * @param p_stream the stream to write data to.
674 * @param p_manager the user event manager.
676 OPJ_BOOL opj_j2k_read_tile_header ( opj_j2k_t * p_j2k,
677 OPJ_UINT32 * p_tile_index,
678 OPJ_UINT32 * p_data_size,
679 OPJ_INT32 * p_tile_x0,
680 OPJ_INT32 * p_tile_y0,
681 OPJ_INT32 * p_tile_x1,
682 OPJ_INT32 * p_tile_y1,
683 OPJ_UINT32 * p_nb_comps,
685 opj_stream_private_t *p_stream,
686 opj_event_mgr_t * p_manager );
690 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
692 * @param p_j2k the jpeg2000 codec.
693 * @param p_image FIXME DOC
694 * @param p_start_x the left position of the rectangle to decode (in image coordinates).
695 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
696 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
697 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
698 * @param p_manager the user event manager
700 * @return true if the area could be set.
702 OPJ_BOOL opj_j2k_set_decode_area( opj_j2k_t *p_j2k,
703 opj_image_t* p_image,
704 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
705 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
706 opj_event_mgr_t * p_manager );
709 * Creates a J2K decompression structure.
711 * @return a handle to a J2K decompressor if successful, NULL otherwise.
713 opj_j2k_t* opj_j2k_create_decompress(void);
717 * Dump some elements from the J2K decompression structure .
719 *@param p_j2k the jpeg2000 codec.
720 *@param flag flag to describe what elments are dump.
721 *@param out_stream output stream where dump the elements.
724 void j2k_dump (opj_j2k_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
729 * Dump an image header structure.
731 *@param image the image header to dump.
732 *@param dev_dump_flag flag to describe if we are in the case of this function is use outside j2k_dump function
733 *@param out_stream output stream where dump the elements.
735 void j2k_dump_image_header(opj_image_t* image, OPJ_BOOL dev_dump_flag, FILE* out_stream);
738 * Dump a component image header structure.
740 *@param comp the component image header to dump.
741 *@param dev_dump_flag flag to describe if we are in the case of this function is use outside j2k_dump function
742 *@param out_stream output stream where dump the elements.
744 void j2k_dump_image_comp_header(opj_image_comp_t* comp, OPJ_BOOL dev_dump_flag, FILE* out_stream);
747 * Get the codestream info from a JPEG2000 codec.
749 *@param p_j2k the component image header to dump.
751 *@return the codestream information extract from the jpg2000 codec
753 opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_t* p_j2k);
756 * Get the codestream index from a JPEG2000 codec.
758 *@param p_j2k the component image header to dump.
760 *@return the codestream index extract from the jpg2000 codec
762 opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_t* p_j2k);
765 * Decode an image from a JPEG-2000 codestream
766 * @param j2k J2K decompressor handle
767 * @param p_stream FIXME DOC
768 * @param p_image FIXME DOC
769 * @param p_manager FIXME DOC
772 OPJ_BOOL opj_j2k_decode(opj_j2k_t *j2k,
773 opj_stream_private_t *p_stream,
774 opj_image_t *p_image,
775 opj_event_mgr_t *p_manager);
778 OPJ_BOOL opj_j2k_get_tile( opj_j2k_t *p_j2k,
779 opj_stream_private_t *p_stream,
780 opj_image_t* p_image,
781 opj_event_mgr_t * p_manager,
782 OPJ_UINT32 tile_index );
784 OPJ_BOOL opj_j2k_set_decoded_resolution_factor(opj_j2k_t *p_j2k,
785 OPJ_UINT32 res_factor,
786 opj_event_mgr_t * p_manager);
791 * @param p_j2k the jpeg2000 codec.
792 * @param p_tile_index FIXME DOC
793 * @param p_data FIXME DOC
794 * @param p_data_size FIXME DOC
795 * @param p_stream the stream to write data to.
796 * @param p_manager the user event manager.
798 OPJ_BOOL opj_j2k_write_tile ( opj_j2k_t * p_j2k,
799 OPJ_UINT32 p_tile_index,
801 OPJ_UINT32 p_data_size,
802 opj_stream_private_t *p_stream,
803 opj_event_mgr_t * p_manager );
806 * Encodes an image into a JPEG-2000 codestream
808 OPJ_BOOL opj_j2k_encode( opj_j2k_t * p_j2k,
809 opj_stream_private_t *cio,
810 opj_event_mgr_t * p_manager );
813 * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
815 * @param p_j2k the jpeg2000 codec.
816 * @param p_stream the stream object.
817 * @param p_image FIXME DOC
818 * @param p_manager the user event manager.
820 * @return true if the codec is valid.
822 OPJ_BOOL opj_j2k_start_compress(opj_j2k_t *p_j2k,
823 opj_stream_private_t *p_stream,
824 opj_image_t * p_image,
825 opj_event_mgr_t * p_manager);
828 * Ends the compression procedures and possibiliy add data to be read after the
831 OPJ_BOOL opj_j2k_end_compress( opj_j2k_t *p_j2k,
832 opj_stream_private_t *cio,
833 opj_event_mgr_t * p_manager);
835 OPJ_BOOL opj_j2k_setup_mct_encoding (opj_tcp_t * p_tcp, opj_image_t * p_image);