2 * The copyright in this software is being made available under the 2-clauses
3 * BSD License, included below. This software may be subject to other third
4 * party and contributor rights, including patent rights, and no such rights
5 * are granted under this license.
7 * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
8 * Copyright (c) 2002-2014, Professor Benoit Macq
9 * Copyright (c) 2001-2003, David Janssens
10 * Copyright (c) 2002-2003, Yannick Verschueren
11 * Copyright (c) 2003-2007, Francois-Olivier Devaux
12 * Copyright (c) 2003-2014, Antonin Descampe
13 * Copyright (c) 2005, Herve Drolon, FreeImage Team
14 * Copyright (c) 2006-2007, Parvatha Elangovan
15 * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
16 * Copyright (c) 2011-2012, Centre National d'Etudes Spatiales (CNES), France
17 * Copyright (c) 2012, CS Systemes d'Information, France
19 * All rights reserved.
21 * Redistribution and use in source and binary forms, with or without
22 * modification, are permitted provided that the following conditions
24 * 1. Redistributions of source code must retain the above copyright
25 * notice, this list of conditions and the following disclaimer.
26 * 2. Redistributions in binary form must reproduce the above copyright
27 * notice, this list of conditions and the following disclaimer in the
28 * documentation and/or other materials provided with the distribution.
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
31 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
34 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
35 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
36 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
37 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
38 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
40 * POSSIBILITY OF SUCH DAMAGE.
46 @brief The JPEG-2000 Codestream Reader/Writer (J2K)
48 The functions in J2K.C have for goal to read/write the several parts of the codestream: markers and data.
51 /** @defgroup J2K J2K - JPEG-2000 codestream reader/writer */
54 #define J2K_CP_CSTY_PRT 0x01
55 #define J2K_CP_CSTY_SOP 0x02
56 #define J2K_CP_CSTY_EPH 0x04
57 #define J2K_CCP_CSTY_PRT 0x01
58 #define J2K_CCP_CBLKSTY_LAZY 0x01 /**< Selective arithmetic coding bypass */
59 #define J2K_CCP_CBLKSTY_RESET 0x02 /**< Reset context probabilities on coding pass boundaries */
60 #define J2K_CCP_CBLKSTY_TERMALL 0x04 /**< Termination on each coding pass */
61 #define J2K_CCP_CBLKSTY_VSC 0x08 /**< Vertically stripe causal context */
62 #define J2K_CCP_CBLKSTY_PTERM 0x10 /**< Predictable termination */
63 #define J2K_CCP_CBLKSTY_SEGSYM 0x20 /**< Segmentation symbols are used */
64 #define J2K_CCP_QNTSTY_NOQNT 0
65 #define J2K_CCP_QNTSTY_SIQNT 1
66 #define J2K_CCP_QNTSTY_SEQNT 2
68 #define OPJ_J2K_DEFAULT_CBLK_DATA_SIZE 8192
70 /* ----------------------------------------------------------------------- */
72 #define J2K_MS_SOC 0xff4f /**< SOC marker value */
73 #define J2K_MS_SOT 0xff90 /**< SOT marker value */
74 #define J2K_MS_SOD 0xff93 /**< SOD marker value */
75 #define J2K_MS_EOC 0xffd9 /**< EOC marker value */
76 #define J2K_MS_SIZ 0xff51 /**< SIZ marker value */
77 #define J2K_MS_COD 0xff52 /**< COD marker value */
78 #define J2K_MS_COC 0xff53 /**< COC marker value */
79 #define J2K_MS_RGN 0xff5e /**< RGN marker value */
80 #define J2K_MS_QCD 0xff5c /**< QCD marker value */
81 #define J2K_MS_QCC 0xff5d /**< QCC marker value */
82 #define J2K_MS_POC 0xff5f /**< POC marker value */
83 #define J2K_MS_TLM 0xff55 /**< TLM marker value */
84 #define J2K_MS_PLM 0xff57 /**< PLM marker value */
85 #define J2K_MS_PLT 0xff58 /**< PLT marker value */
86 #define J2K_MS_PPM 0xff60 /**< PPM marker value */
87 #define J2K_MS_PPT 0xff61 /**< PPT marker value */
88 #define J2K_MS_SOP 0xff91 /**< SOP marker value */
89 #define J2K_MS_EPH 0xff92 /**< EPH marker value */
90 #define J2K_MS_CRG 0xff63 /**< CRG marker value */
91 #define J2K_MS_COM 0xff64 /**< COM marker value */
92 #define J2K_MS_CBD 0xff78 /**< CBD marker value */
93 #define J2K_MS_MCC 0xff75 /**< MCC marker value */
94 #define J2K_MS_MCT 0xff74 /**< MCT marker value */
95 #define J2K_MS_MCO 0xff77 /**< MCO marker value */
97 #define J2K_MS_UNK 0 /**< UNKNOWN marker value */
101 #define J2K_MS_EPC 0xff68 /**< EPC marker value (Part 11: JPEG 2000 for Wireless) */
102 #define J2K_MS_EPB 0xff66 /**< EPB marker value (Part 11: JPEG 2000 for Wireless) */
103 #define J2K_MS_ESD 0xff67 /**< ESD marker value (Part 11: JPEG 2000 for Wireless) */
104 #define J2K_MS_RED 0xff69 /**< RED marker value (Part 11: JPEG 2000 for Wireless) */
105 #endif /* USE_JPWL */
107 #define J2K_MS_SEC 0xff65 /**< SEC marker value (Part 8: Secure JPEG 2000) */
108 #define J2K_MS_INSEC 0xff94 /**< INSEC marker value (Part 8: Secure JPEG 2000) */
109 #endif /* USE_JPSEC */
112 /* ----------------------------------------------------------------------- */
115 * Values that specify the status of the decoding process when decoding the main header.
116 * These values may be combined with a | operator.
118 typedef enum J2K_STATUS {
119 J2K_STATE_NONE = 0x0000, /**< a SOC marker is expected */
120 J2K_STATE_MHSOC = 0x0001, /**< a SOC marker is expected */
121 J2K_STATE_MHSIZ = 0x0002, /**< a SIZ marker is expected */
122 J2K_STATE_MH = 0x0004, /**< the decoding process is in the main header */
123 J2K_STATE_TPHSOT = 0x0008, /**< the decoding process is in a tile part header and expects a SOT marker */
124 J2K_STATE_TPH = 0x0010, /**< the decoding process is in a tile part header */
125 J2K_STATE_MT = 0x0020, /**< the EOC marker has just been read */
126 J2K_STATE_NEOC = 0x0040, /**< the decoding process must not expect a EOC marker because the codestream is truncated */
128 J2K_STATE_EOC = 0x0100, /**< the decoding process has encountered the EOC marker */
129 J2K_STATE_ERR = 0x8000 /**< the decoding process has encountered an error (FIXME warning V1 = 0x0080)*/
133 * Type of elements storing in the MCT data
135 typedef enum MCT_ELEMENT_TYPE
137 MCT_TYPE_INT16 = 0, /** MCT data is stored as signed shorts*/
138 MCT_TYPE_INT32 = 1, /** MCT data is stored as signed integers*/
139 MCT_TYPE_FLOAT = 2, /** MCT data is stored as floats*/
140 MCT_TYPE_DOUBLE = 3 /** MCT data is stored as doubles*/
141 } J2K_MCT_ELEMENT_TYPE;
146 typedef enum MCT_ARRAY_TYPE
148 MCT_TYPE_DEPENDENCY = 0,
149 MCT_TYPE_DECORRELATION = 1,
151 } J2K_MCT_ARRAY_TYPE;
153 /* ----------------------------------------------------------------------- */
158 typedef enum T2_MODE {
159 THRESH_CALC = 0, /** Function called in Rate allocation process*/
160 FINAL_PASS = 1 /** Function called in Tier 2 process*/
164 * Quantization stepsize
166 typedef struct opj_stepsize {
174 Tile-component coding parameters
176 typedef struct opj_tccp
180 /** number of resolutions */
181 OPJ_UINT32 numresolutions;
182 /** code-blocks width */
184 /** code-blocks height */
186 /** code-block coding style */
188 /** discrete wavelet transform identifier */
190 /** quantisation style */
192 /** stepsizes used for quantization */
193 opj_stepsize_t stepsizes[OPJ_J2K_MAXBANDS];
194 /** number of guard bits */
196 /** Region Of Interest shift */
198 /** precinct width */
199 OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
200 /** precinct height */
201 OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
202 /** the dc_level_shift **/
203 OPJ_INT32 m_dc_level_shift;
212 typedef struct opj_mct_data
214 J2K_MCT_ELEMENT_TYPE m_element_type;
215 J2K_MCT_ARRAY_TYPE m_array_type;
218 OPJ_UINT32 m_data_size;
225 typedef struct opj_simple_mcc_decorrelation_data
228 OPJ_UINT32 m_nb_comps;
229 opj_mct_data_t * m_decorrelation_array;
230 opj_mct_data_t * m_offset_array;
231 OPJ_UINT32 m_is_irreversible : 1;
233 opj_simple_mcc_decorrelation_data_t;
236 Tile coding parameters :
237 this structure is used to store coding/decoding parameters common to all
238 tiles (information like COD, COC in main header)
240 typedef struct opj_tcp
244 /** progression order */
246 /** number of layers */
247 OPJ_UINT32 numlayers;
248 OPJ_UINT32 num_layers_to_decode;
249 /** multi-component transform identifier */
251 /** rates of layers */
252 OPJ_FLOAT32 rates[100];
253 /** number of progression order changes */
255 /** progression order changes */
257 /** packet header store there for futur use in t2_decode_packet */
259 /** used to keep a track of the allocated memory */
260 OPJ_BYTE *ppt_buffer;
261 /** Number of bytes stored inside ppt_data*/
262 OPJ_UINT32 ppt_data_size;
263 /** size of ppt_data*/
265 /** add fixed_quality */
266 OPJ_FLOAT32 distoratio[100];
267 /** tile-component coding parameters */
269 /** number of tile parts for the tile. */
270 OPJ_UINT32 m_nb_tile_parts;
271 /** data for the tile */
274 OPJ_UINT32 m_data_size;
275 /** encoding norms */
276 OPJ_FLOAT64 * mct_norms;
277 /** the mct decoding matrix */
278 OPJ_FLOAT32 * m_mct_decoding_matrix;
279 /** the mct coding matrix */
280 OPJ_FLOAT32 * m_mct_coding_matrix;
282 opj_mct_data_t * m_mct_records;
283 /** the number of mct records. */
284 OPJ_UINT32 m_nb_mct_records;
285 /** the max number of mct records. */
286 OPJ_UINT32 m_nb_max_mct_records;
288 opj_simple_mcc_decorrelation_data_t * m_mcc_records;
289 /** the number of mct records. */
290 OPJ_UINT32 m_nb_mcc_records;
291 /** the max number of mct records. */
292 OPJ_UINT32 m_nb_max_mcc_records;
295 /***** FLAGS *******/
296 /** If ppt == 1 --> there was a PPT marker for the present tile */
298 /** indicates if a POC marker has been used O:NO, 1:YES */
305 typedef struct opj_encoding_param
307 /** Digital cinema profile*/
308 OPJ_CINEMA_MODE m_cinema;
309 /** Maximum rate for each component. If == 0, component size limitation is not considered */
310 OPJ_UINT32 m_max_comp_size;
311 /** Position of tile part flag in progression order*/
314 OPJ_INT32 *m_matrice;
315 /** Flag determining tile part generation*/
317 /** allocation by rate/distortion */
318 OPJ_UINT32 m_disto_alloc : 1;
319 /** allocation by fixed layer */
320 OPJ_UINT32 m_fixed_alloc : 1;
321 /** add fixed_quality */
322 OPJ_UINT32 m_fixed_quality : 1;
323 /** Enabling Tile part generation*/
324 OPJ_UINT32 m_tp_on : 1;
326 opj_encoding_param_t;
328 typedef struct opj_decoding_param
330 /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
332 /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
335 opj_decoding_param_t;
341 typedef struct opj_cp
343 /** Size of the image in bits*/
346 OPJ_RSIZ_CAPABILITIES rsiz;
348 OPJ_UINT32 tx0; /* MSD see norm */
350 OPJ_UINT32 ty0; /* MSD see norm */
357 /** number of tiles in width */
359 /** number of tiles in heigth */
362 /** packet header store there for futur use in t2_decode_packet */
364 /** size of the ppm_data*/
366 /** size of the ppm_data*/
367 OPJ_UINT32 ppm_data_read;
369 OPJ_BYTE *ppm_data_current;
371 /** packet header storage original buffer */
372 OPJ_BYTE *ppm_buffer;
373 /** pointer remaining on the first byte of the first header if ppm is used */
374 OPJ_BYTE *ppm_data_first;
375 /** Number of bytes actually stored inside the ppm_data */
376 OPJ_UINT32 ppm_data_size;
377 /** use in case of multiple marker PPM (number of info already store) */
379 /** use in case of multiple marker PPM (case on non-finished previous info) */
380 OPJ_INT32 ppm_previous;
382 /** tile coding parameters */
387 opj_decoding_param_t m_dec;
388 opj_encoding_param_t m_enc;
395 /** enables writing of EPC in MH, thus activating JPWL */
397 /** enables writing of EPB, in case of activated JPWL */
399 /** enables writing of ESD, in case of activated JPWL */
401 /** enables writing of informative techniques of ESD, in case of activated JPWL */
403 /** enables writing of RED, in case of activated JPWL */
405 /** error protection method for MH (0,1,16,32,37-128) */
407 /** tile number of header protection specification (>=0) */
408 int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
409 /** error protection methods for TPHs (0,1,16,32,37-128) */
410 int hprot_TPH[JPWL_MAX_NO_TILESPECS];
411 /** tile number of packet protection specification (>=0) */
412 int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
413 /** packet number of packet protection specification (>=0) */
414 int pprot_packno[JPWL_MAX_NO_PACKSPECS];
415 /** error protection methods for packets (0,1,16,32,37-128) */
416 int pprot[JPWL_MAX_NO_PACKSPECS];
417 /** enables writing of ESD, (0/2/4 bytes) */
419 /** sensitivity addressing size (0=auto/2/4 bytes) */
421 /** sensitivity range (0-3) */
423 /** sensitivity method for MH (-1,0-7) */
425 /** tile number of sensitivity specification (>=0) */
426 int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
427 /** sensitivity methods for TPHs (-1,0-7) */
428 int sens_TPH[JPWL_MAX_NO_TILESPECS];
429 /** enables JPWL correction at the decoder */
431 /** expected number of components at the decoder */
433 /** maximum number of tiles at the decoder */
434 OPJ_UINT32 max_tiles;
435 #endif /* USE_JPWL */
437 /******** FLAGS *********/
438 /** if ppm == 1 --> there was a PPM marker*/
440 /** tells if the parameter is a coding or decoding one */
441 OPJ_UINT32 m_is_decoder : 1;
446 typedef struct opj_j2k_dec
448 /** locate in which part of the codestream the decoder is (main header, tile header, end) */
451 * store decoding parameters common to all tiles (information like COD, COC in main header)
453 opj_tcp_t *m_default_tcp;
454 OPJ_BYTE *m_header_data;
455 OPJ_UINT32 m_header_data_size;
456 /** to tell the tile part length */
457 OPJ_UINT32 m_sot_length;
458 /** Only tiles index in the correct range will be decoded.*/
459 OPJ_UINT32 m_start_tile_x;
460 OPJ_UINT32 m_start_tile_y;
461 OPJ_UINT32 m_end_tile_x;
462 OPJ_UINT32 m_end_tile_y;
464 * Decoded area set by the user
471 /** Index of the tile to decode (used in get_tile) */
472 OPJ_INT32 m_tile_ind_to_dec;
473 /** Position of the last SOT marker read */
474 OPJ_OFF_T m_last_sot_read_pos;
477 * Indicate that the current tile-part is assume as the last tile part of the codestream.
478 * It is useful in the case of PSot is equal to zero. The sot length will be compute in the
479 * SOD reader function. FIXME NOT USED for the moment
481 OPJ_BOOL m_last_tile_part;
482 /** to tell that a tile can be decoded. */
483 OPJ_UINT32 m_can_decode : 1;
484 OPJ_UINT32 m_discard_tiles : 1;
485 OPJ_UINT32 m_skip_data : 1;
489 typedef struct opj_j2k_enc
491 /** Tile part number, regardless of poc, for each new poc, tp is reset to 1*/
492 OPJ_UINT32 m_current_poc_tile_part_number; /* tp_num */
494 /** 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.*/
495 OPJ_UINT32 m_current_tile_part_number; /*cur_tp_num */
498 locate the start position of the TLM marker
499 after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
501 OPJ_OFF_T m_tlm_start;
503 * Stores the sizes of the tlm.
505 OPJ_BYTE * m_tlm_sot_offsets_buffer;
507 * The current offset of the tlm buffer.
509 OPJ_BYTE * m_tlm_sot_offsets_current;
511 /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
512 /** used in TLMmarker*/
513 OPJ_UINT32 m_total_tile_parts; /* totnum_tp */
515 /* encoded data for a tile */
516 OPJ_BYTE * m_encoded_tile_data;
518 /* size of the encoded_data */
519 OPJ_UINT32 m_encoded_tile_size;
521 /* encoded data for a tile */
522 OPJ_BYTE * m_header_tile_data;
524 /* size of the encoded_data */
525 OPJ_UINT32 m_header_tile_data_size;
534 JPEG-2000 codestream reader/writer
536 typedef struct opj_j2k
538 /* J2K codestream is decoded*/
539 OPJ_BOOL m_is_decoder;
544 opj_j2k_dec_t m_decoder;
545 opj_j2k_enc_t m_encoder;
549 /** pointer to the internal/private encoded / decoded image */
550 opj_image_t* m_private_image;
552 /* pointer to the output image (decoded)*/
553 opj_image_t* m_output_image;
555 /** Coding parameters */
558 /** the list of procedures to exec **/
559 opj_procedure_list_t * m_procedure_list;
561 /** the list of validation procedures to follow to make sure the code is valid **/
562 opj_procedure_list_t * m_validation_list;
564 /** helper used to write the index file */
565 opj_codestream_index_t *cstr_index;
567 /** number of the tile curently concern by coding/decoding */
568 OPJ_UINT32 m_current_tile_number;
570 /** the current tile coder/decoder **/
571 struct opj_tcd * m_tcd;
579 /** @name Exported functions */
581 /* ----------------------------------------------------------------------- */
584 Setup the decoder decoding parameters using user parameters.
585 Decoding parameters are returned in j2k->cp.
586 @param j2k J2K decompressor handle
587 @param parameters decompression parameters
589 void opj_j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
592 * Creates a J2K compression structure
594 * @return Returns a handle to a J2K compressor if successful, returns NULL otherwise
596 opj_j2k_t* opj_j2k_create_compress(void);
599 void opj_j2k_setup_encoder( opj_j2k_t *p_j2k,
600 opj_cparameters_t *parameters,
602 opj_event_mgr_t * p_manager);
605 Converts an enum type progression order to string type
607 char *opj_j2k_convert_progression_order(OPJ_PROG_ORDER prg_order);
609 /* ----------------------------------------------------------------------- */
615 * Ends the decompression procedures and possibiliy add data to be read after the
618 OPJ_BOOL opj_j2k_end_decompress(opj_j2k_t *j2k,
619 opj_stream_private_t *p_stream,
620 opj_event_mgr_t * p_manager);
623 * Reads a jpeg2000 codestream header structure.
625 * @param p_stream the stream to read data from.
626 * @param p_j2k the jpeg2000 codec.
627 * @param p_image FIXME DOC
628 * @param p_manager the user event manager.
630 * @return true if the box is valid.
632 OPJ_BOOL opj_j2k_read_header( opj_stream_private_t *p_stream,
634 opj_image_t** p_image,
635 opj_event_mgr_t* p_manager );
639 * Destroys a jpeg2000 codec.
641 * @param p_j2k the jpeg20000 structure to destroy.
643 void opj_j2k_destroy (opj_j2k_t *p_j2k);
646 * Destroys a codestream index structure.
648 * @param p_cstr_ind the codestream index parameter to destroy.
650 void j2k_destroy_cstr_index (opj_codestream_index_t *p_cstr_ind);
654 * @param p_j2k the jpeg2000 codec.
655 * @param p_tile_index
656 * @param p_data FIXME DOC
657 * @param p_data_size FIXME DOC
658 * @param p_stream the stream to write data to.
659 * @param p_manager the user event manager.
661 OPJ_BOOL opj_j2k_decode_tile ( opj_j2k_t * p_j2k,
662 OPJ_UINT32 p_tile_index,
664 OPJ_UINT32 p_data_size,
665 opj_stream_private_t *p_stream,
666 opj_event_mgr_t * p_manager );
669 * Reads a tile header.
670 * @param p_j2k the jpeg2000 codec.
671 * @param p_tile_index FIXME DOC
672 * @param p_data_size FIXME DOC
673 * @param p_tile_x0 FIXME DOC
674 * @param p_tile_y0 FIXME DOC
675 * @param p_tile_x1 FIXME DOC
676 * @param p_tile_y1 FIXME DOC
677 * @param p_nb_comps FIXME DOC
678 * @param p_go_on FIXME DOC
679 * @param p_stream the stream to write data to.
680 * @param p_manager the user event manager.
682 OPJ_BOOL opj_j2k_read_tile_header ( opj_j2k_t * p_j2k,
683 OPJ_UINT32 * p_tile_index,
684 OPJ_UINT32 * p_data_size,
685 OPJ_INT32 * p_tile_x0,
686 OPJ_INT32 * p_tile_y0,
687 OPJ_INT32 * p_tile_x1,
688 OPJ_INT32 * p_tile_y1,
689 OPJ_UINT32 * p_nb_comps,
691 opj_stream_private_t *p_stream,
692 opj_event_mgr_t * p_manager );
696 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
698 * @param p_j2k the jpeg2000 codec.
699 * @param p_image FIXME DOC
700 * @param p_start_x the left position of the rectangle to decode (in image coordinates).
701 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
702 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
703 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
704 * @param p_manager the user event manager
706 * @return true if the area could be set.
708 OPJ_BOOL opj_j2k_set_decode_area( opj_j2k_t *p_j2k,
709 opj_image_t* p_image,
710 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
711 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
712 opj_event_mgr_t * p_manager );
715 * Creates a J2K decompression structure.
717 * @return a handle to a J2K decompressor if successful, NULL otherwise.
719 opj_j2k_t* opj_j2k_create_decompress(void);
723 * Dump some elements from the J2K decompression structure .
725 *@param p_j2k the jpeg2000 codec.
726 *@param flag flag to describe what elments are dump.
727 *@param out_stream output stream where dump the elements.
730 void j2k_dump (opj_j2k_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
735 * Dump an image header structure.
737 *@param image the 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_header(opj_image_t* image, OPJ_BOOL dev_dump_flag, FILE* out_stream);
744 * Dump a component image header structure.
746 *@param comp the component image header to dump.
747 *@param dev_dump_flag flag to describe if we are in the case of this function is use outside j2k_dump function
748 *@param out_stream output stream where dump the elements.
750 void j2k_dump_image_comp_header(opj_image_comp_t* comp, OPJ_BOOL dev_dump_flag, FILE* out_stream);
753 * Get the codestream info from a JPEG2000 codec.
755 *@param p_j2k the component image header to dump.
757 *@return the codestream information extract from the jpg2000 codec
759 opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_t* p_j2k);
762 * Get the codestream index from a JPEG2000 codec.
764 *@param p_j2k the component image header to dump.
766 *@return the codestream index extract from the jpg2000 codec
768 opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_t* p_j2k);
771 * Decode an image from a JPEG-2000 codestream
772 * @param j2k J2K decompressor handle
773 * @param p_stream FIXME DOC
774 * @param p_image FIXME DOC
775 * @param p_manager FIXME DOC
778 OPJ_BOOL opj_j2k_decode(opj_j2k_t *j2k,
779 opj_stream_private_t *p_stream,
780 opj_image_t *p_image,
781 opj_event_mgr_t *p_manager);
784 OPJ_BOOL opj_j2k_get_tile( opj_j2k_t *p_j2k,
785 opj_stream_private_t *p_stream,
786 opj_image_t* p_image,
787 opj_event_mgr_t * p_manager,
788 OPJ_UINT32 tile_index );
790 OPJ_BOOL opj_j2k_set_decoded_resolution_factor(opj_j2k_t *p_j2k,
791 OPJ_UINT32 res_factor,
792 opj_event_mgr_t * p_manager);
797 * @param p_j2k the jpeg2000 codec.
798 * @param p_tile_index FIXME DOC
799 * @param p_data FIXME DOC
800 * @param p_data_size FIXME DOC
801 * @param p_stream the stream to write data to.
802 * @param p_manager the user event manager.
804 OPJ_BOOL opj_j2k_write_tile ( opj_j2k_t * p_j2k,
805 OPJ_UINT32 p_tile_index,
807 OPJ_UINT32 p_data_size,
808 opj_stream_private_t *p_stream,
809 opj_event_mgr_t * p_manager );
812 * Encodes an image into a JPEG-2000 codestream
814 OPJ_BOOL opj_j2k_encode( opj_j2k_t * p_j2k,
815 opj_stream_private_t *cio,
816 opj_event_mgr_t * p_manager );
819 * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
821 * @param p_j2k the jpeg2000 codec.
822 * @param p_stream the stream object.
823 * @param p_image FIXME DOC
824 * @param p_manager the user event manager.
826 * @return true if the codec is valid.
828 OPJ_BOOL opj_j2k_start_compress(opj_j2k_t *p_j2k,
829 opj_stream_private_t *p_stream,
830 opj_image_t * p_image,
831 opj_event_mgr_t * p_manager);
834 * Ends the compression procedures and possibiliy add data to be read after the
837 OPJ_BOOL opj_j2k_end_compress( opj_j2k_t *p_j2k,
838 opj_stream_private_t *cio,
839 opj_event_mgr_t * p_manager);
841 OPJ_BOOL opj_j2k_setup_mct_encoding (opj_tcp_t * p_tcp, opj_image_t * p_image);