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.
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.
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
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.
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.
43 @brief Implementation of a tile coder/decoder (TCD)
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.
49 /** @defgroup TCD TCD - Implementation of a tile coder/decoder */
55 typedef struct opj_tcd_seg {
59 OPJ_UINT32 real_num_passes;
62 OPJ_UINT32 numnewpasses;
69 typedef struct opj_tcd_pass {
71 OPJ_FLOAT64 distortiondec;
79 typedef struct opj_tcd_layer {
80 OPJ_UINT32 numpasses; /* Number of passes in the layer */
81 OPJ_UINT32 len; /* len of information */
82 OPJ_FLOAT64 disto; /* add for index (Cfr. Marcela) */
83 OPJ_BYTE *data; /* data */
89 typedef struct opj_tcd_cblk_enc {
90 OPJ_BYTE* data; /* Data */
91 opj_tcd_layer_t* layers; /* layer information */
92 opj_tcd_pass_t* passes; /* information about the passes */
93 OPJ_INT32 x0, y0, x1, y1; /* dimension of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
95 OPJ_UINT32 numlenbits;
96 OPJ_UINT32 numpasses; /* number of pass already done for the code-blocks */
97 OPJ_UINT32 numpassesinlayers; /* number of passes in the layer */
98 OPJ_UINT32 totalpasses; /* total number of passes */
102 typedef struct opj_tcd_cblk_dec {
103 OPJ_BYTE * data; /* Data */
104 opj_tcd_seg_t* segs; /* segments information */
105 OPJ_INT32 x0, y0, x1, y1; /* position of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
107 OPJ_UINT32 numlenbits;
108 OPJ_UINT32 data_max_size; /* Size of allocated data buffer */
109 OPJ_UINT32 data_current_size; /* Size of used data buffer */
110 OPJ_UINT32 numnewpasses; /* number of pass added to the code-blocks */
111 OPJ_UINT32 numsegs; /* number of segments */
112 OPJ_UINT32 real_num_segs;
113 OPJ_UINT32 m_current_max_segs;
114 } opj_tcd_cblk_dec_t;
119 typedef struct opj_tcd_precinct {
120 OPJ_INT32 x0, y0, x1, y1; /* dimension of the precinct : left upper corner (x0, y0) right low corner (x1,y1) */
121 OPJ_UINT32 cw, ch; /* number of precinct in width and height */
122 union{ /* code-blocks information */
123 opj_tcd_cblk_enc_t* enc;
124 opj_tcd_cblk_dec_t* dec;
127 OPJ_UINT32 block_size; /* size taken by cblks (in bytes) */
128 opj_tgt_tree_t *incltree; /* inclusion tree */
129 opj_tgt_tree_t *imsbtree; /* IMSB tree */
130 } opj_tcd_precinct_t;
135 typedef struct opj_tcd_band {
136 OPJ_INT32 x0, y0, x1, y1; /* dimension of the subband : left upper corner (x0, y0) right low corner (x1,y1) */
138 opj_tcd_precinct_t *precincts; /* precinct information */
139 OPJ_UINT32 precincts_data_size; /* size of data taken by precincts */
141 OPJ_FLOAT32 stepsize;
147 typedef struct opj_tcd_resolution {
148 OPJ_INT32 x0, y0, x1, y1; /* dimension of the resolution level : left upper corner (x0, y0) right low corner (x1,y1) */
150 OPJ_UINT32 numbands; /* number sub-band for the resolution level */
151 opj_tcd_band_t bands[3]; /* subband information */
152 } opj_tcd_resolution_t;
157 typedef struct opj_tcd_tilecomp
159 OPJ_INT32 x0, y0, x1, y1; /* dimension of component : left upper corner (x0, y0) right low corner (x1,y1) */
160 OPJ_UINT32 numresolutions; /* number of resolutions level */
161 OPJ_UINT32 minimum_num_resolutions; /* number of resolutions level to decode (at max)*/
162 opj_tcd_resolution_t *resolutions; /* resolutions information */
163 OPJ_UINT32 resolutions_size; /* size of data for resolutions (in bytes) */
164 OPJ_INT32 *data; /* data of the component */
165 OPJ_BOOL ownsData; /* if true, then need to free after usage, otherwise do not free */
166 OPJ_UINT32 data_size_needed; /* we may either need to allocate this amount of data, or re-use image data and ignore this value */
167 OPJ_UINT32 data_size; /* size of the data of the component */
168 OPJ_INT32 numpix; /* add fixed_quality */
169 } opj_tcd_tilecomp_t;
175 typedef struct opj_tcd_tile {
176 OPJ_INT32 x0, y0, x1, y1; /* dimension of the tile : left upper corner (x0, y0) right low corner (x1,y1) */
177 OPJ_UINT32 numcomps; /* number of components in tile */
178 opj_tcd_tilecomp_t *comps; /* Components information */
179 OPJ_INT32 numpix; /* add fixed_quality */
180 OPJ_FLOAT64 distotile; /* add fixed_quality */
181 OPJ_FLOAT64 distolayer[100]; /* add fixed_quality */
182 OPJ_UINT32 packno; /* packet number */
188 typedef struct opj_tcd_image
190 opj_tcd_tile_t *tiles; /* Tiles information */
198 typedef struct opj_tcd
200 /** Position of the tilepart flag in Progression order*/
202 /** Tile part number*/
204 /** Current tile part number*/
205 OPJ_UINT32 cur_tp_num;
206 /** Total number of tileparts of the current tile*/
207 OPJ_UINT32 cur_totnum_tp;
208 /** Current Packet iterator number */
210 /** info on each image tile */
211 opj_tcd_image_t *tcd_image;
214 /** coding parameters */
216 /** coding/decoding parameters common to all tiles */
218 /** current encoded/decoded tile */
219 OPJ_UINT32 tcd_tileno;
220 /** tell if the tcd is a decoder. */
221 OPJ_UINT32 m_is_decoder : 1;
224 /** @name Exported functions */
226 /* ----------------------------------------------------------------------- */
229 Dump the content of a tcd structure
231 /*void tcd_dump(FILE *fd, opj_tcd_t *tcd, opj_tcd_image_t *img);*/ /* TODO MSD shoul use the new v2 structures */
234 Create a new TCD handle
235 @param p_is_decoder FIXME DOC
236 @return Returns a new TCD handle if successful returns NULL otherwise
238 opj_tcd_t* opj_tcd_create(OPJ_BOOL p_is_decoder);
241 Destroy a previously created TCD handle
242 @param tcd TCD handle to destroy
244 void opj_tcd_destroy(opj_tcd_t *tcd);
247 * Initialize the tile coder and may reuse some memory.
248 * @param p_tcd TCD handle.
249 * @param p_image raw image.
250 * @param p_cp coding parameters.
252 * @return true if the encoding values could be set (false otherwise).
254 OPJ_BOOL opj_tcd_init( opj_tcd_t *p_tcd,
255 opj_image_t * p_image,
259 * Allocates memory for decoding a specific tile.
261 * @param p_tcd the tile decoder.
262 * @param p_tile_no the index of the tile received in sequence. This not necessarily lead to the
263 * tile at index p_tile_no.
265 * @return true if the remaining data is sufficient.
267 OPJ_BOOL opj_tcd_init_decode_tile(opj_tcd_t *p_tcd, OPJ_UINT32 p_tile_no);
269 void opj_tcd_makelayer_fixed(opj_tcd_t *tcd, OPJ_UINT32 layno, OPJ_UINT32 final);
271 void opj_tcd_rateallocate_fixed(opj_tcd_t *tcd);
273 void opj_tcd_makelayer( opj_tcd_t *tcd,
278 OPJ_BOOL opj_tcd_rateallocate( opj_tcd_t *tcd,
280 OPJ_UINT32 * p_data_written,
282 opj_codestream_info_t *cstr_info);
285 * Gets the maximum tile size that will be taken by the tile once decoded.
287 OPJ_UINT32 opj_tcd_get_decoded_tile_size (opj_tcd_t *p_tcd );
290 * Encodes a tile from the raw image into the given buffer.
291 * @param p_tcd Tile Coder handle
292 * @param p_tile_no Index of the tile to encode.
293 * @param p_dest Destination buffer
294 * @param p_data_written pointer to an int that is incremented by the number of bytes really written on p_dest
295 * @param p_len Maximum length of the destination buffer
296 * @param p_cstr_info Codestream information structure
297 * @return true if the coding is successfull.
299 OPJ_BOOL opj_tcd_encode_tile( opj_tcd_t *p_tcd,
300 OPJ_UINT32 p_tile_no,
302 OPJ_UINT32 * p_data_written,
304 struct opj_codestream_info *p_cstr_info);
308 Decode a tile from a buffer into a raw image
309 @param tcd TCD handle
310 @param src Source buffer
311 @param len Length of source buffer
312 @param tileno Number that identifies one of the tiles to be decoded
313 @param cstr_info FIXME DOC
315 OPJ_BOOL opj_tcd_decode_tile( opj_tcd_t *tcd,
319 opj_codestream_index_t *cstr_info);
323 * Copies tile data from the system onto the given memory block.
325 OPJ_BOOL opj_tcd_update_tile_data ( opj_tcd_t *p_tcd,
327 OPJ_UINT32 p_dest_length );
332 OPJ_UINT32 opj_tcd_get_encoded_tile_size ( opj_tcd_t *p_tcd );
335 * Initialize the tile coder and may reuse some meory.
337 * @param p_tcd TCD handle.
338 * @param p_tile_no current tile index to encode.
340 * @return true if the encoding values could be set (false otherwise).
342 OPJ_BOOL opj_tcd_init_encode_tile ( opj_tcd_t *p_tcd,
343 OPJ_UINT32 p_tile_no );
346 * Copies tile data from the given memory block onto the system.
348 OPJ_BOOL opj_tcd_copy_tile_data (opj_tcd_t *p_tcd,
350 OPJ_UINT32 p_src_length );
353 * Allocates tile component data
357 OPJ_BOOL opj_alloc_tile_component_data(opj_tcd_tilecomp_t *l_tilec);
359 /* ----------------------------------------------------------------------- */