src/lib/openjp2/j2k.h

   1 /*
   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.
   6  *
   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
  18  *
  19  * All rights reserved.
  20  *
  21  * Redistribution and use in source and binary forms, with or without
  22  * modification, are permitted provided that the following conditions
  23  * are met:
  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.
  29  *
  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.
  41  */
  42 #ifndef __J2K_H
  43 #define __J2K_H
  44 /**
  45 @file j2k.h
  46 @brief The JPEG-2000 Codestream Reader/Writer (J2K)
  47
  48 The functions in J2K.C have for goal to read/write the several parts of the codestream: markers and data.
  49 */
  50
  51 /** @defgroup J2K J2K - JPEG-2000 codestream reader/writer */
  52 /*@{*/
  53
  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
  67
  68 #define OPJ_J2K_DEFAULT_CBLK_DATA_SIZE 8192
  69
  70 /* ----------------------------------------------------------------------- */
  71
  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 */
  96
  97 #define J2K_MS_UNK 0        /**< UNKNOWN marker value */
  98
  99 /* UniPG>> */
 100 #ifdef USE_JPWL
 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 */
 106 #ifdef USE_JPSEC
 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 */
 110 /* <<UniPG */
 111
 112 /* ----------------------------------------------------------------------- */
 113
 114 /**
 115  * Values that specify the status of the decoding process when decoding the main header.
 116  * These values may be combined with a | operator.
 117  * */
 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 */
 127
 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)*/
 130 } J2K_STATUS;
 131
 132 /**
 133  * Type of elements storing in the MCT data
 134  */
 135 typedef enum MCT_ELEMENT_TYPE {
 136     MCT_TYPE_INT16 = 0,     /** MCT data is stored as signed shorts*/
 137     MCT_TYPE_INT32 = 1,     /** MCT data is stored as signed integers*/
 138     MCT_TYPE_FLOAT = 2,     /** MCT data is stored as floats*/
 139     MCT_TYPE_DOUBLE = 3     /** MCT data is stored as doubles*/
 140 } J2K_MCT_ELEMENT_TYPE;
 141
 142 /**
 143  * Type of MCT array
 144  */
 145 typedef enum MCT_ARRAY_TYPE {
 146     MCT_TYPE_DEPENDENCY = 0,
 147     MCT_TYPE_DECORRELATION = 1,
 148     MCT_TYPE_OFFSET = 2
 149 } J2K_MCT_ARRAY_TYPE;
 150
 151 /* ----------------------------------------------------------------------- */
 152
 153 /**
 154 T2 encoding mode
 155 */
 156 typedef enum T2_MODE {
 157     THRESH_CALC = 0,    /** Function called in Rate allocation process*/
 158     FINAL_PASS = 1      /** Function called in Tier 2 process*/
 159 } J2K_T2_MODE;
 160
 161 /**
 162  * Quantization stepsize
 163  */
 164 typedef struct opj_stepsize {
 165     /** exponent */
 166     OPJ_INT32 expn;
 167     /** mantissa */
 168     OPJ_INT32 mant;
 169 } opj_stepsize_t;
 170
 171 /**
 172 Tile-component coding parameters
 173 */
 174 typedef struct opj_tccp {
 175     /** coding style */
 176     OPJ_UINT32 csty;
 177     /** number of resolutions */
 178     OPJ_UINT32 numresolutions;
 179     /** code-blocks width */
 180     OPJ_UINT32 cblkw;
 181     /** code-blocks height */
 182     OPJ_UINT32 cblkh;
 183     /** code-block coding style */
 184     OPJ_UINT32 cblksty;
 185     /** discrete wavelet transform identifier */
 186     OPJ_UINT32 qmfbid;
 187     /** quantisation style */
 188     OPJ_UINT32 qntsty;
 189     /** stepsizes used for quantization */
 190     opj_stepsize_t stepsizes[OPJ_J2K_MAXBANDS];
 191     /** number of guard bits */
 192     OPJ_UINT32 numgbits;
 193     /** Region Of Interest shift */
 194     OPJ_INT32 roishift;
 195     /** precinct width */
 196     OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
 197     /** precinct height */
 198     OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
 199     /** the dc_level_shift **/
 200     OPJ_INT32 m_dc_level_shift;
 201 }
 202 opj_tccp_t;
 203
 204
 205
 206 /**
 207  * FIXME DOC
 208  */
 209 typedef struct opj_mct_data {
 210     J2K_MCT_ELEMENT_TYPE m_element_type;
 211     J2K_MCT_ARRAY_TYPE   m_array_type;
 212     OPJ_UINT32           m_index;
 213     OPJ_BYTE *           m_data;
 214     OPJ_UINT32           m_data_size;
 215 }
 216 opj_mct_data_t;
 217
 218 /**
 219  * FIXME DOC
 220  */
 221 typedef struct opj_simple_mcc_decorrelation_data {
 222     OPJ_UINT32           m_index;
 223     OPJ_UINT32           m_nb_comps;
 224     opj_mct_data_t *     m_decorrelation_array;
 225     opj_mct_data_t *     m_offset_array;
 226     OPJ_BITFIELD         m_is_irreversible : 1;
 227 }
 228 opj_simple_mcc_decorrelation_data_t;
 229
 230 typedef struct opj_ppx_struct {
 231     OPJ_BYTE*   m_data; /* m_data == NULL => Zppx not read yet */
 232     OPJ_UINT32  m_data_size;
 233 } opj_ppx;
 234
 235 /**
 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)
 239 */
 240 typedef struct opj_tcp {
 241     /** coding style */
 242     OPJ_UINT32 csty;
 243     /** progression order */
 244     OPJ_PROG_ORDER prg;
 245     /** number of layers */
 246     OPJ_UINT32 numlayers;
 247     OPJ_UINT32 num_layers_to_decode;
 248     /** multi-component transform identifier */
 249     OPJ_UINT32 mct;
 250     /** rates of layers */
 251     OPJ_FLOAT32 rates[100];
 252     /** number of progression order changes */
 253     OPJ_UINT32 numpocs;
 254     /** progression order changes */
 255     opj_poc_t pocs[32];
 256
 257     /** number of ppt markers (reserved size) */
 258     OPJ_UINT32 ppt_markers_count;
 259     /** ppt markers data (table indexed by Zppt) */
 260     opj_ppx* ppt_markers;
 261
 262     /** packet header store there for future use in t2_decode_packet */
 263     OPJ_BYTE *ppt_data;
 264     /** used to keep a track of the allocated memory */
 265     OPJ_BYTE *ppt_buffer;
 266     /** Number of bytes stored inside ppt_data*/
 267     OPJ_UINT32 ppt_data_size;
 268     /** size of ppt_data*/
 269     OPJ_UINT32 ppt_len;
 270     /** add fixed_quality */
 271     OPJ_FLOAT32 distoratio[100];
 272     /** tile-component coding parameters */
 273     opj_tccp_t *tccps;
 274     /** number of tile parts for the tile. */
 275     OPJ_UINT32 m_nb_tile_parts;
 276     /** data for the tile */
 277     OPJ_BYTE *      m_data;
 278     /** size of data */
 279     OPJ_UINT32      m_data_size;
 280     /** encoding norms */
 281     OPJ_FLOAT64 *   mct_norms;
 282     /** the mct decoding matrix */
 283     OPJ_FLOAT32 *   m_mct_decoding_matrix;
 284     /** the mct coding matrix */
 285     OPJ_FLOAT32 *   m_mct_coding_matrix;
 286     /** mct records */
 287     opj_mct_data_t * m_mct_records;
 288     /** the number of mct records. */
 289     OPJ_UINT32 m_nb_mct_records;
 290     /** the max number of mct records. */
 291     OPJ_UINT32 m_nb_max_mct_records;
 292     /** mcc records */
 293     opj_simple_mcc_decorrelation_data_t * m_mcc_records;
 294     /** the number of mct records. */
 295     OPJ_UINT32 m_nb_mcc_records;
 296     /** the max number of mct records. */
 297     OPJ_UINT32 m_nb_max_mcc_records;
 298
 299
 300     /***** FLAGS *******/
 301     /** If cod == 1 --> there was a COD marker for the present tile */
 302     OPJ_BITFIELD cod : 1;
 303     /** If ppt == 1 --> there was a PPT marker for the present tile */
 304     OPJ_BITFIELD ppt : 1;
 305     /** indicates if a POC marker has been used O:NO, 1:YES */
 306     OPJ_BITFIELD POC : 1;
 307 } opj_tcp_t;
 308
 309
 310
 311
 312 typedef struct opj_encoding_param {
 313     /** Maximum rate for each component. If == 0, component size limitation is not considered */
 314     OPJ_UINT32 m_max_comp_size;
 315     /** Position of tile part flag in progression order*/
 316     OPJ_INT32 m_tp_pos;
 317     /** fixed layer */
 318     OPJ_INT32 *m_matrice;
 319     /** Flag determining tile part generation*/
 320     OPJ_BYTE m_tp_flag;
 321     /** allocation by rate/distortion */
 322     OPJ_BITFIELD m_disto_alloc : 1;
 323     /** allocation by fixed layer */
 324     OPJ_BITFIELD m_fixed_alloc : 1;
 325     /** add fixed_quality */
 326     OPJ_BITFIELD m_fixed_quality : 1;
 327     /** Enabling Tile part generation*/
 328     OPJ_BITFIELD m_tp_on : 1;
 329 }
 330 opj_encoding_param_t;
 331
 332 typedef struct opj_decoding_param {
 333     /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
 334     OPJ_UINT32 m_reduce;
 335     /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
 336     OPJ_UINT32 m_layer;
 337 }
 338 opj_decoding_param_t;
 339
 340
 341 /**
 342  * Coding parameters
 343  */
 344 typedef struct opj_cp {
 345     /** Size of the image in bits*/
 346     /*int img_size;*/
 347     /** Rsiz*/
 348     OPJ_UINT16 rsiz;
 349     /** XTOsiz */
 350     OPJ_UINT32 tx0; /* MSD see norm */
 351     /** YTOsiz */
 352     OPJ_UINT32 ty0; /* MSD see norm */
 353     /** XTsiz */
 354     OPJ_UINT32 tdx;
 355     /** YTsiz */
 356     OPJ_UINT32 tdy;
 357     /** comment */
 358     OPJ_CHAR *comment;
 359     /** number of tiles in width */
 360     OPJ_UINT32 tw;
 361     /** number of tiles in heigth */
 362     OPJ_UINT32 th;
 363
 364     /** number of ppm markers (reserved size) */
 365     OPJ_UINT32 ppm_markers_count;
 366     /** ppm markers data (table indexed by Zppm) */
 367     opj_ppx* ppm_markers;
 368
 369     /** packet header store there for future use in t2_decode_packet */
 370     OPJ_BYTE *ppm_data;
 371     /** size of the ppm_data*/
 372     OPJ_UINT32 ppm_len;
 373     /** size of the ppm_data*/
 374     OPJ_UINT32 ppm_data_read;
 375
 376     OPJ_BYTE *ppm_data_current;
 377
 378     /** packet header storage original buffer */
 379     OPJ_BYTE *ppm_buffer;
 380     /** pointer remaining on the first byte of the first header if ppm is used */
 381     OPJ_BYTE *ppm_data_first;
 382     /** Number of bytes actually stored inside the ppm_data */
 383     OPJ_UINT32 ppm_data_size;
 384     /** use in case of multiple marker PPM (number of info already store) */
 385     OPJ_INT32 ppm_store;
 386     /** use in case of multiple marker PPM (case on non-finished previous info) */
 387     OPJ_INT32 ppm_previous;
 388
 389     /** tile coding parameters */
 390     opj_tcp_t *tcps;
 391
 392     union {
 393         opj_decoding_param_t m_dec;
 394         opj_encoding_param_t m_enc;
 395     }
 396     m_specific_param;
 397
 398
 399     /* UniPG>> */
 400 #ifdef USE_JPWL
 401     /** enables writing of EPC in MH, thus activating JPWL */
 402     OPJ_BOOL epc_on;
 403     /** enables writing of EPB, in case of activated JPWL */
 404     OPJ_BOOL epb_on;
 405     /** enables writing of ESD, in case of activated JPWL */
 406     OPJ_BOOL esd_on;
 407     /** enables writing of informative techniques of ESD, in case of activated JPWL */
 408     OPJ_BOOL info_on;
 409     /** enables writing of RED, in case of activated JPWL */
 410     OPJ_BOOL red_on;
 411     /** error protection method for MH (0,1,16,32,37-128) */
 412     int hprot_MH;
 413     /** tile number of header protection specification (>=0) */
 414     int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 415     /** error protection methods for TPHs (0,1,16,32,37-128) */
 416     int hprot_TPH[JPWL_MAX_NO_TILESPECS];
 417     /** tile number of packet protection specification (>=0) */
 418     int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
 419     /** packet number of packet protection specification (>=0) */
 420     int pprot_packno[JPWL_MAX_NO_PACKSPECS];
 421     /** error protection methods for packets (0,1,16,32,37-128) */
 422     int pprot[JPWL_MAX_NO_PACKSPECS];
 423     /** enables writing of ESD, (0/2/4 bytes) */
 424     int sens_size;
 425     /** sensitivity addressing size (0=auto/2/4 bytes) */
 426     int sens_addr;
 427     /** sensitivity range (0-3) */
 428     int sens_range;
 429     /** sensitivity method for MH (-1,0-7) */
 430     int sens_MH;
 431     /** tile number of sensitivity specification (>=0) */
 432     int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 433     /** sensitivity methods for TPHs (-1,0-7) */
 434     int sens_TPH[JPWL_MAX_NO_TILESPECS];
 435     /** enables JPWL correction at the decoder */
 436     OPJ_BOOL correct;
 437     /** expected number of components at the decoder */
 438     int exp_comps;
 439     /** maximum number of tiles at the decoder */
 440     OPJ_UINT32 max_tiles;
 441 #endif /* USE_JPWL */
 442
 443     /******** FLAGS *********/
 444     /** if ppm == 1 --> there was a PPM marker*/
 445     OPJ_BITFIELD ppm : 1;
 446     /** tells if the parameter is a coding or decoding one */
 447     OPJ_BITFIELD m_is_decoder : 1;
 448     /* <<UniPG */
 449 } opj_cp_t;
 450
 451
 452 typedef struct opj_j2k_dec {
 453     /** locate in which part of the codestream the decoder is (main header, tile header, end) */
 454     OPJ_UINT32 m_state;
 455     /**
 456      * store decoding parameters common to all tiles (information like COD, COC in main header)
 457      */
 458     opj_tcp_t *m_default_tcp;
 459     OPJ_BYTE  *m_header_data;
 460     OPJ_UINT32 m_header_data_size;
 461     /** to tell the tile part length */
 462     OPJ_UINT32 m_sot_length;
 463     /** Only tiles index in the correct range will be decoded.*/
 464     OPJ_UINT32 m_start_tile_x;
 465     OPJ_UINT32 m_start_tile_y;
 466     OPJ_UINT32 m_end_tile_x;
 467     OPJ_UINT32 m_end_tile_y;
 468     /**
 469      * Decoded area set by the user
 470      */
 471     OPJ_UINT32 m_DA_x0;
 472     OPJ_UINT32 m_DA_y0;
 473     OPJ_UINT32 m_DA_x1;
 474     OPJ_UINT32 m_DA_y1;
 475
 476     /** Index of the tile to decode (used in get_tile) */
 477     OPJ_INT32 m_tile_ind_to_dec;
 478     /** Position of the last SOT marker read */
 479     OPJ_OFF_T m_last_sot_read_pos;
 480
 481     /**
 482      * Indicate that the current tile-part is assume as the last tile part of the codestream.
 483      * It is useful in the case of PSot is equal to zero. The sot length will be compute in the
 484      * SOD reader function. FIXME NOT USED for the moment
 485      */
 486     OPJ_BOOL   m_last_tile_part;
 487     /** to tell that a tile can be decoded. */
 488     OPJ_BITFIELD m_can_decode : 1;
 489     OPJ_BITFIELD m_discard_tiles : 1;
 490     OPJ_BITFIELD m_skip_data : 1;
 491     /** TNsot correction : see issue 254 **/
 492     OPJ_BITFIELD m_nb_tile_parts_correction_checked : 1;
 493     OPJ_BITFIELD m_nb_tile_parts_correction : 1;
 494
 495 } opj_j2k_dec_t;
 496
 497 typedef struct opj_j2k_enc {
 498     /** Tile part number, regardless of poc, for each new poc, tp is reset to 1*/
 499     OPJ_UINT32 m_current_poc_tile_part_number; /* tp_num */
 500
 501     /** 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.*/
 502     OPJ_UINT32 m_current_tile_part_number; /*cur_tp_num */
 503
 504     /**
 505     locate the start position of the TLM marker
 506     after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
 507     */
 508     OPJ_OFF_T m_tlm_start;
 509     /**
 510      * Stores the sizes of the tlm.
 511      */
 512     OPJ_BYTE * m_tlm_sot_offsets_buffer;
 513     /**
 514      * The current offset of the tlm buffer.
 515      */
 516     OPJ_BYTE * m_tlm_sot_offsets_current;
 517
 518     /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
 519     /** used in TLMmarker*/
 520     OPJ_UINT32 m_total_tile_parts;   /* totnum_tp */
 521
 522     /* encoded data for a tile */
 523     OPJ_BYTE * m_encoded_tile_data;
 524
 525     /* size of the encoded_data */
 526     OPJ_UINT32 m_encoded_tile_size;
 527
 528     /* encoded data for a tile */
 529     OPJ_BYTE * m_header_tile_data;
 530
 531     /* size of the encoded_data */
 532     OPJ_UINT32 m_header_tile_data_size;
 533
 534
 535 } opj_j2k_enc_t;
 536
 537
 538
 539 struct opj_tcd;
 540 /**
 541 JPEG-2000 codestream reader/writer
 542 */
 543 typedef struct opj_j2k {
 544     /* J2K codestream is decoded*/
 545     OPJ_BOOL m_is_decoder;
 546
 547     /* FIXME DOC*/
 548     union {
 549         opj_j2k_dec_t m_decoder;
 550         opj_j2k_enc_t m_encoder;
 551     }
 552     m_specific_param;
 553
 554     /** pointer to the internal/private encoded / decoded image */
 555     opj_image_t* m_private_image;
 556
 557     /* pointer to the output image (decoded)*/
 558     opj_image_t* m_output_image;
 559
 560     /** Coding parameters */
 561     opj_cp_t m_cp;
 562
 563     /** the list of procedures to exec **/
 564     opj_procedure_list_t *  m_procedure_list;
 565
 566     /** the list of validation procedures to follow to make sure the code is valid **/
 567     opj_procedure_list_t *  m_validation_list;
 568
 569     /** helper used to write the index file */
 570     opj_codestream_index_t *cstr_index;
 571
 572     /** number of the tile curently concern by coding/decoding */
 573     OPJ_UINT32 m_current_tile_number;
 574
 575     /** the current tile coder/decoder **/
 576     struct opj_tcd *    m_tcd;
 577
 578     /** Number of threads to use */
 579     int m_num_threads;
 580
 581     /** Thread pool */
 582     opj_thread_pool_t* m_tp;
 583 }
 584 opj_j2k_t;
 585
 586
 587
 588
 589 /** @name Exported functions */
 590 /*@{*/
 591 /* ----------------------------------------------------------------------- */
 592
 593 /**
 594 Setup the decoder decoding parameters using user parameters.
 595 Decoding parameters are returned in j2k->cp.
 596 @param j2k J2K decompressor handle
 597 @param parameters decompression parameters
 598 */
 599 void opj_j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
 600
 601 OPJ_BOOL opj_j2k_set_threads(opj_j2k_t *j2k, OPJ_UINT32 num_threads);
 602
 603 /**
 604  * Creates a J2K compression structure
 605  *
 606  * @return Returns a handle to a J2K compressor if successful, returns NULL otherwise
 607 */
 608 opj_j2k_t* opj_j2k_create_compress(void);
 609
 610
 611 OPJ_BOOL opj_j2k_setup_encoder(opj_j2k_t *p_j2k,
 612                                opj_cparameters_t *parameters,
 613                                opj_image_t *image,
 614                                opj_event_mgr_t * p_manager);
 615
 616 /**
 617 Converts an enum type progression order to string type
 618 */
 619 char *opj_j2k_convert_progression_order(OPJ_PROG_ORDER prg_order);
 620
 621 /* ----------------------------------------------------------------------- */
 622 /*@}*/
 623
 624 /*@}*/
 625
 626 /**
 627  * Ends the decompression procedures and possibiliy add data to be read after the
 628  * codestream.
 629  */
 630 OPJ_BOOL opj_j2k_end_decompress(opj_j2k_t *j2k,
 631                                 opj_stream_private_t *p_stream,
 632                                 opj_event_mgr_t * p_manager);
 633
 634 /**
 635  * Reads a jpeg2000 codestream header structure.
 636  *
 637  * @param p_stream the stream to read data from.
 638  * @param p_j2k the jpeg2000 codec.
 639  * @param p_image FIXME DOC
 640  * @param p_manager the user event manager.
 641  *
 642  * @return true if the box is valid.
 643  */
 644 OPJ_BOOL opj_j2k_read_header(opj_stream_private_t *p_stream,
 645                              opj_j2k_t* p_j2k,
 646                              opj_image_t** p_image,
 647                              opj_event_mgr_t* p_manager);
 648
 649
 650 /**
 651  * Destroys a jpeg2000 codec.
 652  *
 653  * @param   p_j2k   the jpeg20000 structure to destroy.
 654  */
 655 void opj_j2k_destroy(opj_j2k_t *p_j2k);
 656
 657 /**
 658  * Destroys a codestream index structure.
 659  *
 660  * @param   p_cstr_ind  the codestream index parameter to destroy.
 661  */
 662 void j2k_destroy_cstr_index(opj_codestream_index_t *p_cstr_ind);
 663
 664 /**
 665  * Decode tile data.
 666  * @param   p_j2k       the jpeg2000 codec.
 667  * @param   p_tile_index
 668  * @param p_data       FIXME DOC
 669  * @param p_data_size  FIXME DOC
 670  * @param   p_stream            the stream to write data to.
 671  * @param   p_manager   the user event manager.
 672  */
 673 OPJ_BOOL opj_j2k_decode_tile(opj_j2k_t * p_j2k,
 674                              OPJ_UINT32 p_tile_index,
 675                              OPJ_BYTE * p_data,
 676                              OPJ_UINT32 p_data_size,
 677                              opj_stream_private_t *p_stream,
 678                              opj_event_mgr_t * p_manager);
 679
 680 /**
 681  * Reads a tile header.
 682  * @param   p_j2k       the jpeg2000 codec.
 683  * @param   p_tile_index FIXME DOC
 684  * @param   p_data_size FIXME DOC
 685  * @param   p_tile_x0 FIXME DOC
 686  * @param   p_tile_y0 FIXME DOC
 687  * @param   p_tile_x1 FIXME DOC
 688  * @param   p_tile_y1 FIXME DOC
 689  * @param   p_nb_comps FIXME DOC
 690  * @param   p_go_on FIXME DOC
 691  * @param   p_stream            the stream to write data to.
 692  * @param   p_manager   the user event manager.
 693  */
 694 OPJ_BOOL opj_j2k_read_tile_header(opj_j2k_t * p_j2k,
 695                                   OPJ_UINT32 * p_tile_index,
 696                                   OPJ_UINT32 * p_data_size,
 697                                   OPJ_INT32 * p_tile_x0,
 698                                   OPJ_INT32 * p_tile_y0,
 699                                   OPJ_INT32 * p_tile_x1,
 700                                   OPJ_INT32 * p_tile_y1,
 701                                   OPJ_UINT32 * p_nb_comps,
 702                                   OPJ_BOOL * p_go_on,
 703                                   opj_stream_private_t *p_stream,
 704                                   opj_event_mgr_t * p_manager);
 705
 706
 707 /**
 708  * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
 709  *
 710  * @param   p_j2k           the jpeg2000 codec.
 711  * @param   p_image     FIXME DOC
 712  * @param   p_start_x       the left position of the rectangle to decode (in image coordinates).
 713  * @param   p_start_y       the up position of the rectangle to decode (in image coordinates).
 714  * @param   p_end_x         the right position of the rectangle to decode (in image coordinates).
 715  * @param   p_end_y         the bottom position of the rectangle to decode (in image coordinates).
 716  * @param   p_manager       the user event manager
 717  *
 718  * @return  true            if the area could be set.
 719  */
 720 OPJ_BOOL opj_j2k_set_decode_area(opj_j2k_t *p_j2k,
 721                                  opj_image_t* p_image,
 722                                  OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
 723                                  OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
 724                                  opj_event_mgr_t * p_manager);
 725
 726 /**
 727  * Creates a J2K decompression structure.
 728  *
 729  * @return a handle to a J2K decompressor if successful, NULL otherwise.
 730  */
 731 opj_j2k_t* opj_j2k_create_decompress(void);
 732
 733
 734 /**
 735  * Dump some elements from the J2K decompression structure .
 736  *
 737  *@param p_j2k              the jpeg2000 codec.
 738  *@param flag               flag to describe what elments are dump.
 739  *@param out_stream         output stream where dump the elements.
 740  *
 741 */
 742 void j2k_dump(opj_j2k_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
 743
 744
 745
 746 /**
 747  * Dump an image header structure.
 748  *
 749  *@param image          the image header to dump.
 750  *@param dev_dump_flag      flag to describe if we are in the case of this function is use outside j2k_dump function
 751  *@param out_stream         output stream where dump the elements.
 752  */
 753 void j2k_dump_image_header(opj_image_t* image, OPJ_BOOL dev_dump_flag,
 754                            FILE* out_stream);
 755
 756 /**
 757  * Dump a component image header structure.
 758  *
 759  *@param comp       the component image header to dump.
 760  *@param dev_dump_flag      flag to describe if we are in the case of this function is use outside j2k_dump function
 761  *@param out_stream         output stream where dump the elements.
 762  */
 763 void j2k_dump_image_comp_header(opj_image_comp_t* comp, OPJ_BOOL dev_dump_flag,
 764                                 FILE* out_stream);
 765
 766 /**
 767  * Get the codestream info from a JPEG2000 codec.
 768  *
 769  *@param    p_j2k               the component image header to dump.
 770  *
 771  *@return   the codestream information extract from the jpg2000 codec
 772  */
 773 opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_t* p_j2k);
 774
 775 /**
 776  * Get the codestream index from a JPEG2000 codec.
 777  *
 778  *@param    p_j2k               the component image header to dump.
 779  *
 780  *@return   the codestream index extract from the jpg2000 codec
 781  */
 782 opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_t* p_j2k);
 783
 784 /**
 785  * Decode an image from a JPEG-2000 codestream
 786  * @param j2k J2K decompressor handle
 787  * @param p_stream  FIXME DOC
 788  * @param p_image   FIXME DOC
 789  * @param p_manager FIXME DOC
 790  * @return FIXME DOC
 791 */
 792 OPJ_BOOL opj_j2k_decode(opj_j2k_t *j2k,
 793                         opj_stream_private_t *p_stream,
 794                         opj_image_t *p_image,
 795                         opj_event_mgr_t *p_manager);
 796
 797
 798 OPJ_BOOL opj_j2k_get_tile(opj_j2k_t *p_j2k,
 799                           opj_stream_private_t *p_stream,
 800                           opj_image_t* p_image,
 801                           opj_event_mgr_t * p_manager,
 802                           OPJ_UINT32 tile_index);
 803
 804 OPJ_BOOL opj_j2k_set_decoded_resolution_factor(opj_j2k_t *p_j2k,
 805         OPJ_UINT32 res_factor,
 806         opj_event_mgr_t * p_manager);
 807
 808
 809 /**
 810  * Writes a tile.
 811  * @param   p_j2k       the jpeg2000 codec.
 812  * @param p_tile_index FIXME DOC
 813  * @param p_data FIXME DOC
 814  * @param p_data_size FIXME DOC
 815  * @param   p_stream            the stream to write data to.
 816  * @param   p_manager   the user event manager.
 817  */
 818 OPJ_BOOL opj_j2k_write_tile(opj_j2k_t * p_j2k,
 819                             OPJ_UINT32 p_tile_index,
 820                             OPJ_BYTE * p_data,
 821                             OPJ_UINT32 p_data_size,
 822                             opj_stream_private_t *p_stream,
 823                             opj_event_mgr_t * p_manager);
 824
 825 /**
 826  * Encodes an image into a JPEG-2000 codestream
 827  */
 828 OPJ_BOOL opj_j2k_encode(opj_j2k_t * p_j2k,
 829                         opj_stream_private_t *cio,
 830                         opj_event_mgr_t * p_manager);
 831
 832 /**
 833  * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
 834  *
 835  * @param   p_j2k       the jpeg2000 codec.
 836  * @param   p_stream            the stream object.
 837  * @param   p_image FIXME DOC
 838  * @param   p_manager   the user event manager.
 839  *
 840  * @return true if the codec is valid.
 841  */
 842 OPJ_BOOL opj_j2k_start_compress(opj_j2k_t *p_j2k,
 843                                 opj_stream_private_t *p_stream,
 844                                 opj_image_t * p_image,
 845                                 opj_event_mgr_t * p_manager);
 846
 847 /**
 848  * Ends the compression procedures and possibiliy add data to be read after the
 849  * codestream.
 850  */
 851 OPJ_BOOL opj_j2k_end_compress(opj_j2k_t *p_j2k,
 852                               opj_stream_private_t *cio,
 853                               opj_event_mgr_t * p_manager);
 854
 855 OPJ_BOOL opj_j2k_setup_mct_encoding(opj_tcp_t * p_tcp, opj_image_t * p_image);
 856
 857
 858 #endif /* __J2K_H */