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