src/lib/openjp2/j2k.h

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