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