src/lib/openjp2/tcd.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) 2008, 2011-2012, Centre National d'Etudes Spatiales (CNES), FR
  15  * Copyright (c) 2012, CS Systemes d'Information, France
  16  * All rights reserved.
  17  *
  18  * Redistribution and use in source and binary forms, with or without
  19  * modification, are permitted provided that the following conditions
  20  * are met:
  21  * 1. Redistributions of source code must retain the above copyright
  22  *    notice, this list of conditions and the following disclaimer.
  23  * 2. Redistributions in binary form must reproduce the above copyright
  24  *    notice, this list of conditions and the following disclaimer in the
  25  *    documentation and/or other materials provided with the distribution.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  28  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  31  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  37  * POSSIBILITY OF SUCH DAMAGE.
  38  */
  39 #ifndef OPJ_TCD_H
  40 #define OPJ_TCD_H
  41 /**
  42 @file tcd.h
  43 @brief Implementation of a tile coder/decoder (TCD)
  44
  45 The functions in TCD.C encode or decode each tile independently from
  46 each other. The functions in TCD.C are used by other functions in J2K.C.
  47 */
  48
  49 /** @defgroup TCD TCD - Implementation of a tile coder/decoder */
  50 /*@{*/
  51
  52
  53 /**
  54 FIXME DOC
  55 */
  56 typedef struct opj_tcd_pass {
  57     OPJ_UINT32 rate;
  58     OPJ_FLOAT64 distortiondec;
  59     OPJ_UINT32 len;
  60     OPJ_BITFIELD term : 1;
  61 } opj_tcd_pass_t;
  62
  63 /**
  64 FIXME DOC
  65 */
  66 typedef struct opj_tcd_layer {
  67     OPJ_UINT32 numpasses;       /* Number of passes in the layer */
  68     OPJ_UINT32 len;             /* len of information */
  69     OPJ_FLOAT64 disto;          /* add for index (Cfr. Marcela) */
  70     OPJ_BYTE *data;             /* data */
  71 } opj_tcd_layer_t;
  72
  73 /**
  74 FIXME DOC
  75 */
  76 typedef struct opj_tcd_cblk_enc {
  77     OPJ_BYTE* data;               /* Data */
  78     opj_tcd_layer_t* layers;      /* layer information */
  79     opj_tcd_pass_t* passes;       /* information about the passes */
  80     OPJ_INT32 x0, y0, x1,
  81               y1;     /* dimension of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
  82     OPJ_UINT32 numbps;
  83     OPJ_UINT32 numlenbits;
  84     OPJ_UINT32 data_size;         /* Size of allocated data buffer */
  85     OPJ_UINT32
  86     numpasses;         /* number of pass already done for the code-blocks */
  87     OPJ_UINT32 numpassesinlayers; /* number of passes in the layer */
  88     OPJ_UINT32 totalpasses;       /* total number of passes */
  89 } opj_tcd_cblk_enc_t;
  90
  91
  92 /** Chunk of codestream data that is part of a code block */
  93 typedef struct opj_tcd_seg_data_chunk {
  94     /* Point to tilepart buffer. We don't make a copy !
  95        So the tilepart buffer must be kept alive
  96        as long as we need to decode the codeblocks */
  97     OPJ_BYTE * data;
  98     OPJ_UINT32 len;                 /* Usable length of data */
  99 } opj_tcd_seg_data_chunk_t;
 100
 101 /** Segment of a code-block.
 102  * A segment represent a number of consecutive coding passes, without termination
 103  * of MQC or RAW between them. */
 104 typedef struct opj_tcd_seg {
 105     OPJ_UINT32 len;      /* Size of data related to this segment */
 106     /* Number of passes decoded. Including those that we skip */
 107     OPJ_UINT32 numpasses;
 108     /* Number of passes actually to be decoded. To be used for code-block decoding */
 109     OPJ_UINT32 real_num_passes;
 110     /* Maximum number of passes for this segment */
 111     OPJ_UINT32 maxpasses;
 112     /* Number of new passes for current packed. Transitory value */
 113     OPJ_UINT32 numnewpasses;
 114     /* Codestream length for this segment for current packed. Transitory value */
 115     OPJ_UINT32 newlen;
 116 } opj_tcd_seg_t;
 117
 118 /* Code-block for decoding */
 119 typedef struct opj_tcd_cblk_dec {
 120     opj_tcd_seg_t* segs;            /* segments information */
 121     opj_tcd_seg_data_chunk_t* chunks; /* Array of chunks */
 122     /* position of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
 123     OPJ_INT32 x0, y0, x1, y1;
 124     OPJ_UINT32 numbps;
 125     /* number of bits for len, for the current packet. Transitory value */
 126     OPJ_UINT32 numlenbits;
 127     /* number of pass added to the code-blocks, for the current packet. Transitory value */
 128     OPJ_UINT32 numnewpasses;
 129     /* number of segments, including those of packet we skip */
 130     OPJ_UINT32 numsegs;
 131     /* number of segments, to be used for code block decoding */
 132     OPJ_UINT32 real_num_segs;
 133     OPJ_UINT32 m_current_max_segs;  /* allocated number of segs[] items */
 134     OPJ_UINT32 numchunks;           /* Number of valid chunks items */
 135     OPJ_UINT32 numchunksalloc;      /* Number of chunks item allocated */
 136 } opj_tcd_cblk_dec_t;
 137
 138 /**
 139 FIXME DOC
 140 */
 141 typedef struct opj_tcd_precinct {
 142     OPJ_INT32 x0, y0, x1,
 143               y1;       /* dimension of the precinct : left upper corner (x0, y0) right low corner (x1,y1) */
 144     OPJ_UINT32 cw, ch;              /* number of precinct in width and height */
 145     union {                         /* code-blocks information */
 146         opj_tcd_cblk_enc_t* enc;
 147         opj_tcd_cblk_dec_t* dec;
 148         void*               blocks;
 149     } cblks;
 150     OPJ_UINT32 block_size;          /* size taken by cblks (in bytes) */
 151     opj_tgt_tree_t *incltree;       /* inclusion tree */
 152     opj_tgt_tree_t *imsbtree;       /* IMSB tree */
 153 } opj_tcd_precinct_t;
 154
 155 /**
 156 FIXME DOC
 157 */
 158 typedef struct opj_tcd_band {
 159     OPJ_INT32 x0, y0, x1,
 160               y1;       /* dimension of the subband : left upper corner (x0, y0) right low corner (x1,y1) */
 161     OPJ_UINT32 bandno;
 162     opj_tcd_precinct_t *precincts;  /* precinct information */
 163     OPJ_UINT32 precincts_data_size; /* size of data taken by precincts */
 164     OPJ_INT32 numbps;
 165     OPJ_FLOAT32 stepsize;
 166 } opj_tcd_band_t;
 167
 168 /**
 169 FIXME DOC
 170 */
 171 typedef struct opj_tcd_resolution {
 172     OPJ_INT32 x0, y0, x1,
 173               y1;       /* dimension of the resolution level : left upper corner (x0, y0) right low corner (x1,y1) */
 174     OPJ_UINT32 pw, ph;
 175     OPJ_UINT32 numbands;            /* number sub-band for the resolution level */
 176     opj_tcd_band_t bands[3];        /* subband information */
 177 } opj_tcd_resolution_t;
 178
 179 /**
 180 FIXME DOC
 181 */
 182 typedef struct opj_tcd_tilecomp {
 183     OPJ_INT32 x0, y0, x1,
 184               y1;           /* dimension of component : left upper corner (x0, y0) right low corner (x1,y1) */
 185     OPJ_UINT32 numresolutions;          /* number of resolutions level */
 186     OPJ_UINT32
 187     minimum_num_resolutions; /* number of resolutions level to decode (at max)*/
 188     opj_tcd_resolution_t *resolutions;  /* resolutions information */
 189     OPJ_UINT32
 190     resolutions_size;        /* size of data for resolutions (in bytes) */
 191     OPJ_INT32 *data;                    /* data of the component */
 192     OPJ_BOOL  ownsData;                 /* if true, then need to free after usage, otherwise do not free */
 193     OPJ_UINT32
 194     data_size_needed;        /* we may either need to allocate this amount of data, or re-use image data and ignore this value */
 195     OPJ_UINT32 data_size;               /* size of the data of the component */
 196     OPJ_INT32 numpix;                   /* add fixed_quality */
 197 } opj_tcd_tilecomp_t;
 198
 199
 200 /**
 201 FIXME DOC
 202 */
 203 typedef struct opj_tcd_tile {
 204     OPJ_INT32 x0, y0, x1,
 205               y1;       /* dimension of the tile : left upper corner (x0, y0) right low corner (x1,y1) */
 206     OPJ_UINT32 numcomps;            /* number of components in tile */
 207     opj_tcd_tilecomp_t *comps;  /* Components information */
 208     OPJ_INT32 numpix;               /* add fixed_quality */
 209     OPJ_FLOAT64 distotile;          /* add fixed_quality */
 210     OPJ_FLOAT64 distolayer[100];    /* add fixed_quality */
 211     OPJ_UINT32 packno;              /* packet number */
 212 } opj_tcd_tile_t;
 213
 214 /**
 215 FIXME DOC
 216 */
 217 typedef struct opj_tcd_image {
 218     opj_tcd_tile_t *tiles;      /* Tiles information */
 219 }
 220 opj_tcd_image_t;
 221
 222
 223 /**
 224 Tile coder/decoder
 225 */
 226 typedef struct opj_tcd {
 227     /** Position of the tilepart flag in Progression order*/
 228     OPJ_INT32 tp_pos;
 229     /** Tile part number*/
 230     OPJ_UINT32 tp_num;
 231     /** Current tile part number*/
 232     OPJ_UINT32 cur_tp_num;
 233     /** Total number of tileparts of the current tile*/
 234     OPJ_UINT32 cur_totnum_tp;
 235     /** Current Packet iterator number */
 236     OPJ_UINT32 cur_pino;
 237     /** info on each image tile */
 238     opj_tcd_image_t *tcd_image;
 239     /** image header */
 240     opj_image_t *image;
 241     /** coding parameters */
 242     opj_cp_t *cp;
 243     /** coding/decoding parameters common to all tiles */
 244     opj_tcp_t *tcp;
 245     /** current encoded/decoded tile */
 246     OPJ_UINT32 tcd_tileno;
 247     /** tell if the tcd is a decoder. */
 248     OPJ_BITFIELD m_is_decoder : 1;
 249     /** Thread pool */
 250     opj_thread_pool_t* thread_pool;
 251 } opj_tcd_t;
 252
 253 /** @name Exported functions */
 254 /*@{*/
 255 /* ----------------------------------------------------------------------- */
 256
 257 /**
 258 Dump the content of a tcd structure
 259 */
 260 /*void tcd_dump(FILE *fd, opj_tcd_t *tcd, opj_tcd_image_t *img);*/ /* TODO MSD shoul use the new v2 structures */
 261
 262 /**
 263 Create a new TCD handle
 264 @param p_is_decoder FIXME DOC
 265 @return Returns a new TCD handle if successful returns NULL otherwise
 266 */
 267 opj_tcd_t* opj_tcd_create(OPJ_BOOL p_is_decoder);
 268
 269 /**
 270 Destroy a previously created TCD handle
 271 @param tcd TCD handle to destroy
 272 */
 273 void opj_tcd_destroy(opj_tcd_t *tcd);
 274
 275 /**
 276  * Initialize the tile coder and may reuse some memory.
 277  * @param   p_tcd       TCD handle.
 278  * @param   p_image     raw image.
 279  * @param   p_cp        coding parameters.
 280  * @param   p_tp        thread pool
 281  *
 282  * @return true if the encoding values could be set (false otherwise).
 283 */
 284 OPJ_BOOL opj_tcd_init(opj_tcd_t *p_tcd,
 285                       opj_image_t * p_image,
 286                       opj_cp_t * p_cp,
 287                       opj_thread_pool_t* p_tp);
 288
 289 /**
 290  * Allocates memory for decoding a specific tile.
 291  *
 292  * @param   p_tcd       the tile decoder.
 293  * @param   p_tile_no   the index of the tile received in sequence. This not necessarily lead to the
 294  * tile at index p_tile_no.
 295  * @param p_manager the event manager.
 296  *
 297  * @return  true if the remaining data is sufficient.
 298  */
 299 OPJ_BOOL opj_tcd_init_decode_tile(opj_tcd_t *p_tcd, OPJ_UINT32 p_tile_no,
 300                                   opj_event_mgr_t* p_manager);
 301
 302 void opj_tcd_makelayer_fixed(opj_tcd_t *tcd, OPJ_UINT32 layno,
 303                              OPJ_UINT32 final);
 304
 305 void opj_tcd_rateallocate_fixed(opj_tcd_t *tcd);
 306
 307 void opj_tcd_makelayer(opj_tcd_t *tcd,
 308                        OPJ_UINT32 layno,
 309                        OPJ_FLOAT64 thresh,
 310                        OPJ_UINT32 final);
 311
 312 OPJ_BOOL opj_tcd_rateallocate(opj_tcd_t *tcd,
 313                               OPJ_BYTE *dest,
 314                               OPJ_UINT32 * p_data_written,
 315                               OPJ_UINT32 len,
 316                               opj_codestream_info_t *cstr_info);
 317
 318 /**
 319  * Gets the maximum tile size that will be taken by the tile once decoded.
 320  */
 321 OPJ_UINT32 opj_tcd_get_decoded_tile_size(opj_tcd_t *p_tcd);
 322
 323 /**
 324  * Encodes a tile from the raw image into the given buffer.
 325  * @param   p_tcd           Tile Coder handle
 326  * @param   p_tile_no       Index of the tile to encode.
 327  * @param   p_dest          Destination buffer
 328  * @param   p_data_written  pointer to an int that is incremented by the number of bytes really written on p_dest
 329  * @param   p_len           Maximum length of the destination buffer
 330  * @param   p_cstr_info     Codestream information structure
 331  * @return  true if the coding is successful.
 332 */
 333 OPJ_BOOL opj_tcd_encode_tile(opj_tcd_t *p_tcd,
 334                              OPJ_UINT32 p_tile_no,
 335                              OPJ_BYTE *p_dest,
 336                              OPJ_UINT32 * p_data_written,
 337                              OPJ_UINT32 p_len,
 338                              struct opj_codestream_info *p_cstr_info);
 339
 340
 341 /**
 342 Decode a tile from a buffer into a raw image
 343 @param tcd TCD handle
 344 @param src Source buffer
 345 @param len Length of source buffer
 346 @param tileno Number that identifies one of the tiles to be decoded
 347 @param cstr_info  FIXME DOC
 348 @param manager the event manager.
 349 */
 350 OPJ_BOOL opj_tcd_decode_tile(opj_tcd_t *tcd,
 351                              OPJ_BYTE *src,
 352                              OPJ_UINT32 len,
 353                              OPJ_UINT32 tileno,
 354                              opj_codestream_index_t *cstr_info,
 355                              opj_event_mgr_t *manager);
 356
 357
 358 /**
 359  * Copies tile data from the system onto the given memory block.
 360  */
 361 OPJ_BOOL opj_tcd_update_tile_data(opj_tcd_t *p_tcd,
 362                                   OPJ_BYTE * p_dest,
 363                                   OPJ_UINT32 p_dest_length);
 364
 365 /**
 366  *
 367  */
 368 OPJ_UINT32 opj_tcd_get_encoded_tile_size(opj_tcd_t *p_tcd);
 369
 370 /**
 371  * Initialize the tile coder and may reuse some meory.
 372  *
 373  * @param   p_tcd       TCD handle.
 374  * @param   p_tile_no   current tile index to encode.
 375  * @param p_manager the event manager.
 376  *
 377  * @return true if the encoding values could be set (false otherwise).
 378 */
 379 OPJ_BOOL opj_tcd_init_encode_tile(opj_tcd_t *p_tcd,
 380                                   OPJ_UINT32 p_tile_no, opj_event_mgr_t* p_manager);
 381
 382 /**
 383  * Copies tile data from the given memory block onto the system.
 384  */
 385 OPJ_BOOL opj_tcd_copy_tile_data(opj_tcd_t *p_tcd,
 386                                 OPJ_BYTE * p_src,
 387                                 OPJ_UINT32 p_src_length);
 388
 389 /**
 390  * Allocates tile component data
 391  *
 392  *
 393  */
 394 OPJ_BOOL opj_alloc_tile_component_data(opj_tcd_tilecomp_t *l_tilec);
 395
 396 /** Returns whether a sub-band is empty (i.e. whether it has a null area)
 397  * @param band Sub-band handle.
 398  * @return OPJ_TRUE whether the sub-band is empty.
 399  */
 400 OPJ_BOOL opj_tcd_is_band_empty(opj_tcd_band_t* band);
 401
 402 /** Reinitialize a segment */
 403 void opj_tcd_reinit_segment(opj_tcd_seg_t* seg);
 404
 405 /* ----------------------------------------------------------------------- */
 406 /*@}*/
 407
 408 /*@}*/
 409
 410 #endif /* OPJ_TCD_H */