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;
73 OPJ_BITFIELD term : 1;
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 */
94 y1; /* dimension of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
96 OPJ_UINT32 numlenbits;
97 OPJ_UINT32 data_size; /* Size of allocated data buffer */
99 numpasses; /* number of pass already done for the code-blocks */
100 OPJ_UINT32 numpassesinlayers; /* number of passes in the layer */
101 OPJ_UINT32 totalpasses; /* total number of passes */
102 } opj_tcd_cblk_enc_t;
105 typedef struct opj_tcd_cblk_dec {
106 OPJ_BYTE * data; /* Data */
107 opj_tcd_seg_t* segs; /* segments information */
108 OPJ_INT32 x0, y0, x1,
109 y1; /* position of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
111 OPJ_UINT32 numlenbits;
112 OPJ_UINT32 data_max_size; /* Size of allocated data buffer */
113 OPJ_UINT32 data_current_size; /* Size of used data buffer */
114 OPJ_UINT32 numnewpasses; /* number of pass added to the code-blocks */
115 OPJ_UINT32 numsegs; /* number of segments */
116 OPJ_UINT32 real_num_segs;
117 OPJ_UINT32 m_current_max_segs;
118 } opj_tcd_cblk_dec_t;
123 typedef struct opj_tcd_precinct {
124 OPJ_INT32 x0, y0, x1,
125 y1; /* dimension of the precinct : left upper corner (x0, y0) right low corner (x1,y1) */
126 OPJ_UINT32 cw, ch; /* number of precinct in width and height */
127 union { /* code-blocks information */
128 opj_tcd_cblk_enc_t* enc;
129 opj_tcd_cblk_dec_t* dec;
132 OPJ_UINT32 block_size; /* size taken by cblks (in bytes) */
133 opj_tgt_tree_t *incltree; /* inclusion tree */
134 opj_tgt_tree_t *imsbtree; /* IMSB tree */
135 } opj_tcd_precinct_t;
140 typedef struct opj_tcd_band {
141 OPJ_INT32 x0, y0, x1,
142 y1; /* dimension of the subband : left upper corner (x0, y0) right low corner (x1,y1) */
144 opj_tcd_precinct_t *precincts; /* precinct information */
145 OPJ_UINT32 precincts_data_size; /* size of data taken by precincts */
147 OPJ_FLOAT32 stepsize;
153 typedef struct opj_tcd_resolution {
154 OPJ_INT32 x0, y0, x1,
155 y1; /* dimension of the resolution level : left upper corner (x0, y0) right low corner (x1,y1) */
157 OPJ_UINT32 numbands; /* number sub-band for the resolution level */
158 opj_tcd_band_t bands[3]; /* subband information */
159 } opj_tcd_resolution_t;
164 typedef struct opj_tcd_tilecomp {
165 OPJ_INT32 x0, y0, x1,
166 y1; /* dimension of component : left upper corner (x0, y0) right low corner (x1,y1) */
167 OPJ_UINT32 numresolutions; /* number of resolutions level */
169 minimum_num_resolutions; /* number of resolutions level to decode (at max)*/
170 opj_tcd_resolution_t *resolutions; /* resolutions information */
172 resolutions_size; /* size of data for resolutions (in bytes) */
173 OPJ_INT32 *data; /* data of the component */
174 OPJ_BOOL ownsData; /* if true, then need to free after usage, otherwise do not free */
176 data_size_needed; /* we may either need to allocate this amount of data, or re-use image data and ignore this value */
177 OPJ_UINT32 data_size; /* size of the data of the component */
178 OPJ_INT32 numpix; /* add fixed_quality */
179 } opj_tcd_tilecomp_t;
185 typedef struct opj_tcd_tile {
186 OPJ_INT32 x0, y0, x1,
187 y1; /* dimension of the tile : left upper corner (x0, y0) right low corner (x1,y1) */
188 OPJ_UINT32 numcomps; /* number of components in tile */
189 opj_tcd_tilecomp_t *comps; /* Components information */
190 OPJ_INT32 numpix; /* add fixed_quality */
191 OPJ_FLOAT64 distotile; /* add fixed_quality */
192 OPJ_FLOAT64 distolayer[100]; /* add fixed_quality */
193 OPJ_UINT32 packno; /* packet number */
199 typedef struct opj_tcd_image {
200 opj_tcd_tile_t *tiles; /* Tiles information */
208 typedef struct opj_tcd {
209 /** Position of the tilepart flag in Progression order*/
211 /** Tile part number*/
213 /** Current tile part number*/
214 OPJ_UINT32 cur_tp_num;
215 /** Total number of tileparts of the current tile*/
216 OPJ_UINT32 cur_totnum_tp;
217 /** Current Packet iterator number */
219 /** info on each image tile */
220 opj_tcd_image_t *tcd_image;
223 /** coding parameters */
225 /** coding/decoding parameters common to all tiles */
227 /** current encoded/decoded tile */
228 OPJ_UINT32 tcd_tileno;
229 /** tell if the tcd is a decoder. */
230 OPJ_BITFIELD m_is_decoder : 1;
232 opj_thread_pool_t* thread_pool;
235 /** @name Exported functions */
237 /* ----------------------------------------------------------------------- */
240 Dump the content of a tcd structure
242 /*void tcd_dump(FILE *fd, opj_tcd_t *tcd, opj_tcd_image_t *img);*/ /* TODO MSD shoul use the new v2 structures */
245 Create a new TCD handle
246 @param p_is_decoder FIXME DOC
247 @return Returns a new TCD handle if successful returns NULL otherwise
249 opj_tcd_t* opj_tcd_create(OPJ_BOOL p_is_decoder);
252 Destroy a previously created TCD handle
253 @param tcd TCD handle to destroy
255 void opj_tcd_destroy(opj_tcd_t *tcd);
258 * Initialize the tile coder and may reuse some memory.
259 * @param p_tcd TCD handle.
260 * @param p_image raw image.
261 * @param p_cp coding parameters.
262 * @param p_tp thread pool
264 * @return true if the encoding values could be set (false otherwise).
266 OPJ_BOOL opj_tcd_init(opj_tcd_t *p_tcd,
267 opj_image_t * p_image,
269 opj_thread_pool_t* p_tp);
272 * Allocates memory for decoding a specific tile.
274 * @param p_tcd the tile decoder.
275 * @param p_tile_no the index of the tile received in sequence. This not necessarily lead to the
276 * tile at index p_tile_no.
277 * @param p_manager the event manager.
279 * @return true if the remaining data is sufficient.
281 OPJ_BOOL opj_tcd_init_decode_tile(opj_tcd_t *p_tcd, OPJ_UINT32 p_tile_no,
282 opj_event_mgr_t* p_manager);
284 void opj_tcd_makelayer_fixed(opj_tcd_t *tcd, OPJ_UINT32 layno,
287 void opj_tcd_rateallocate_fixed(opj_tcd_t *tcd);
289 void opj_tcd_makelayer(opj_tcd_t *tcd,
294 OPJ_BOOL opj_tcd_rateallocate(opj_tcd_t *tcd,
296 OPJ_UINT32 * p_data_written,
298 opj_codestream_info_t *cstr_info);
301 * Gets the maximum tile size that will be taken by the tile once decoded.
303 OPJ_UINT32 opj_tcd_get_decoded_tile_size(opj_tcd_t *p_tcd);
306 * Encodes a tile from the raw image into the given buffer.
307 * @param p_tcd Tile Coder handle
308 * @param p_tile_no Index of the tile to encode.
309 * @param p_dest Destination buffer
310 * @param p_data_written pointer to an int that is incremented by the number of bytes really written on p_dest
311 * @param p_len Maximum length of the destination buffer
312 * @param p_cstr_info Codestream information structure
313 * @return true if the coding is successful.
315 OPJ_BOOL opj_tcd_encode_tile(opj_tcd_t *p_tcd,
316 OPJ_UINT32 p_tile_no,
318 OPJ_UINT32 * p_data_written,
320 struct opj_codestream_info *p_cstr_info);
324 Decode a tile from a buffer into a raw image
325 @param tcd TCD handle
326 @param src Source buffer
327 @param len Length of source buffer
328 @param tileno Number that identifies one of the tiles to be decoded
329 @param cstr_info FIXME DOC
330 @param manager the event manager.
332 OPJ_BOOL opj_tcd_decode_tile(opj_tcd_t *tcd,
336 opj_codestream_index_t *cstr_info,
337 opj_event_mgr_t *manager);
341 * Copies tile data from the system onto the given memory block.
343 OPJ_BOOL opj_tcd_update_tile_data(opj_tcd_t *p_tcd,
345 OPJ_UINT32 p_dest_length);
350 OPJ_UINT32 opj_tcd_get_encoded_tile_size(opj_tcd_t *p_tcd);
353 * Initialize the tile coder and may reuse some meory.
355 * @param p_tcd TCD handle.
356 * @param p_tile_no current tile index to encode.
357 * @param p_manager the event manager.
359 * @return true if the encoding values could be set (false otherwise).
361 OPJ_BOOL opj_tcd_init_encode_tile(opj_tcd_t *p_tcd,
362 OPJ_UINT32 p_tile_no, opj_event_mgr_t* p_manager);
365 * Copies tile data from the given memory block onto the system.
367 OPJ_BOOL opj_tcd_copy_tile_data(opj_tcd_t *p_tcd,
369 OPJ_UINT32 p_src_length);
372 * Allocates tile component data
376 OPJ_BOOL opj_alloc_tile_component_data(opj_tcd_tilecomp_t *l_tilec);
378 /** Returns whether a sub-band is empty (i.e. whether it has a null area)
379 * @param band Sub-band handle.
380 * @return OPJ_TRUE whether the sub-band is empty.
382 OPJ_BOOL opj_tcd_is_band_empty(opj_tcd_band_t* band);
384 /* ----------------------------------------------------------------------- */