Mercurial > hgrepos > Python2 > PyMuPDF

comparison mupdf-source/thirdparty/openjpeg/src/lib/openjp2/tcd.h @ 2:b50eed0cc0ef upstream

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
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 * Copyright (c) 2017, IntoPIX SA <support@intopix.com>
17 * All rights reserved.
18 *
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
21 * are met:
22 * 1. Redistributions of source code must retain the above copyright
23 * notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in the
26 * documentation and/or other materials provided with the distribution.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
29 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
32 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
39 */
40 #ifndef OPJ_TCD_H
41 #define OPJ_TCD_H
42 /**
43 @file tcd.h
44 @brief Implementation of a tile coder/decoder (TCD)
45
46 The functions in TCD.C encode or decode each tile independently from
47 each other. The functions in TCD.C are used by other functions in J2K.C.
48 */
49
50 /** @defgroup TCD TCD - Implementation of a tile coder/decoder */
51 /*@{*/
52
53
54 /**
55 FIXME DOC
56 */
57 typedef struct opj_tcd_pass {
58 OPJ_UINT32 rate;
59 OPJ_FLOAT64 distortiondec;
60 OPJ_UINT32 len;
61 OPJ_BITFIELD term : 1;
62 } opj_tcd_pass_t;
63
64 /**
65 FIXME DOC
66 */
67 typedef struct opj_tcd_layer {
68 OPJ_UINT32 numpasses; /* Number of passes in the layer */
69 OPJ_UINT32 len; /* len of information */
70 OPJ_FLOAT64 disto; /* add for index (Cfr. Marcela) */
71 OPJ_BYTE *data; /* data */
72 } opj_tcd_layer_t;
73
74 /**
75 FIXME DOC
76 */
77 typedef struct opj_tcd_cblk_enc {
78 OPJ_BYTE* data; /* Data */
79 opj_tcd_layer_t* layers; /* layer information */
80 opj_tcd_pass_t* passes; /* information about the passes */
81 OPJ_INT32 x0, y0, x1,
82 y1; /* dimension of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
83 OPJ_UINT32 numbps;
84 OPJ_UINT32 numlenbits;
85 OPJ_UINT32 data_size; /* Size of allocated data buffer */
86 OPJ_UINT32
87 numpasses; /* number of pass already done for the code-blocks */
88 OPJ_UINT32 numpassesinlayers; /* number of passes in the layer */
89 OPJ_UINT32 totalpasses; /* total number of passes */
90 } opj_tcd_cblk_enc_t;
91
92
93 /** Chunk of codestream data that is part of a code block */
94 typedef struct opj_tcd_seg_data_chunk {
95 /* Point to tilepart buffer. We don't make a copy !
96 So the tilepart buffer must be kept alive
97 as long as we need to decode the codeblocks */
98 OPJ_BYTE * data;
99 OPJ_UINT32 len; /* Usable length of data */
100 } opj_tcd_seg_data_chunk_t;
101
102 /** Segment of a code-block.
103 * A segment represent a number of consecutive coding passes, without termination
104 * of MQC or RAW between them. */
105 typedef struct opj_tcd_seg {
106 OPJ_UINT32 len; /* Size of data related to this segment */
107 /* Number of passes decoded. Including those that we skip */
108 OPJ_UINT32 numpasses;
109 /* Number of passes actually to be decoded. To be used for code-block decoding */
110 OPJ_UINT32 real_num_passes;
111 /* Maximum number of passes for this segment */
112 OPJ_UINT32 maxpasses;
113 /* Number of new passes for current packed. Transitory value */
114 OPJ_UINT32 numnewpasses;
115 /* Codestream length for this segment for current packed. Transitory value */
116 OPJ_UINT32 newlen;
117 } opj_tcd_seg_t;
118
119 /** Code-block for decoding */
120 typedef struct opj_tcd_cblk_dec {
121 opj_tcd_seg_t* segs; /* segments information */
122 opj_tcd_seg_data_chunk_t* chunks; /* Array of chunks */
123 /* position of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
124 OPJ_INT32 x0, y0, x1, y1;
125 /* Mb is The maximum number of bit-planes available for the representation of
126 coefficients in any sub-band, b, as defined in Equation (E-2). See
127 Section B.10.5 of the standard */
128 OPJ_UINT32 Mb; /* currently used only to check if HT decoding is correct */
129 /* numbps is Mb - P as defined in Section B.10.5 of the standard */
130 OPJ_UINT32 numbps;
131 /* number of bits for len, for the current packet. Transitory value */
132 OPJ_UINT32 numlenbits;
133 /* number of pass added to the code-blocks, for the current packet. Transitory value */
134 OPJ_UINT32 numnewpasses;
135 /* number of segments, including those of packet we skip */
136 OPJ_UINT32 numsegs;
137 /* number of segments, to be used for code block decoding */
138 OPJ_UINT32 real_num_segs;
139 OPJ_UINT32 m_current_max_segs; /* allocated number of segs[] items */
140 OPJ_UINT32 numchunks; /* Number of valid chunks items */
141 OPJ_UINT32 numchunksalloc; /* Number of chunks item allocated */
142 /* Decoded code-block. Only used for subtile decoding. Otherwise tilec->data is directly updated */
143 OPJ_INT32* decoded_data;
144 OPJ_BOOL corrupted; /* whether the code block data is corrupted */
145 } opj_tcd_cblk_dec_t;
146
147 /** Precinct structure */
148 typedef struct opj_tcd_precinct {
149 /* dimension of the precinct : left upper corner (x0, y0) right low corner (x1,y1) */
150 OPJ_INT32 x0, y0, x1, y1;
151 OPJ_UINT32 cw, ch; /* number of code-blocks, in width and height */
152 union { /* code-blocks information */
153 opj_tcd_cblk_enc_t* enc;
154 opj_tcd_cblk_dec_t* dec;
155 void* blocks;
156 } cblks;
157 OPJ_UINT32 block_size; /* size taken by cblks (in bytes) */
158 opj_tgt_tree_t *incltree; /* inclusion tree */
159 opj_tgt_tree_t *imsbtree; /* IMSB tree */
160 } opj_tcd_precinct_t;
161
162 /** Sub-band structure */
163 typedef struct opj_tcd_band {
164 /* dimension of the subband : left upper corner (x0, y0) right low corner (x1,y1) */
165 OPJ_INT32 x0, y0, x1, y1;
166 /* band number: for lowest resolution level (0=LL), otherwise (1=HL, 2=LH, 3=HH) */
167 OPJ_UINT32 bandno;
168 /* precinct information */
169 opj_tcd_precinct_t *precincts;
170 /* size of data taken by precincts */
171 OPJ_UINT32 precincts_data_size;
172 OPJ_INT32 numbps;
173 OPJ_FLOAT32 stepsize;
174 } opj_tcd_band_t;
175
176 /** Tile-component resolution structure */
177 typedef struct opj_tcd_resolution {
178 /* dimension of the resolution level : left upper corner (x0, y0) right low corner (x1,y1) */
179 OPJ_INT32 x0, y0, x1, y1;
180 /* number of precincts, in width and height, for this resolution level */
181 OPJ_UINT32 pw, ph;
182 /* number of sub-bands for the resolution level (1 for lowest resolution level, 3 otherwise) */
183 OPJ_UINT32 numbands;
184 /* subband information */
185 opj_tcd_band_t bands[3];
186
187 /* dimension of the resolution limited to window of interest. Only valid if tcd->whole_tile_decoding is set */
188 OPJ_UINT32 win_x0;
189 OPJ_UINT32 win_y0;
190 OPJ_UINT32 win_x1;
191 OPJ_UINT32 win_y1;
192 } opj_tcd_resolution_t;
193
194 /** Tile-component structure */
195 typedef struct opj_tcd_tilecomp {
196 /* dimension of component : left upper corner (x0, y0) right low corner (x1,y1) */
197 OPJ_INT32 x0, y0, x1, y1;
198 /* component number */
199 OPJ_UINT32 compno;
200 /* number of resolutions level */
201 OPJ_UINT32 numresolutions;
202 /* number of resolutions level to decode (at max)*/
203 OPJ_UINT32 minimum_num_resolutions;
204 /* resolutions information */
205 opj_tcd_resolution_t *resolutions;
206 /* size of data for resolutions (in bytes) */
207 OPJ_UINT32 resolutions_size;
208
209 /* data of the component. For decoding, only valid if tcd->whole_tile_decoding is set (so exclusive of data_win member) */
210 OPJ_INT32 *data;
211 /* if true, then need to free after usage, otherwise do not free */
212 OPJ_BOOL ownsData;
213 /* we may either need to allocate this amount of data, or re-use image data and ignore this value */
214 size_t data_size_needed;
215 /* size of the data of the component */
216 size_t data_size;
217
218 /** data of the component limited to window of interest. Only valid for decoding and if tcd->whole_tile_decoding is NOT set (so exclusive of data member) */
219 OPJ_INT32 *data_win;
220 /* dimension of the component limited to window of interest. Only valid for decoding and if tcd->whole_tile_decoding is NOT set */
221 OPJ_UINT32 win_x0;
222 OPJ_UINT32 win_y0;
223 OPJ_UINT32 win_x1;
224 OPJ_UINT32 win_y1;
225
226 /* number of pixels */
227 OPJ_SIZE_T numpix;
228 } opj_tcd_tilecomp_t;
229
230
231 /**
232 FIXME DOC
233 */
234 typedef struct opj_tcd_tile {
235 /* dimension of the tile : left upper corner (x0, y0) right low corner (x1,y1) */
236 OPJ_INT32 x0, y0, x1, y1;
237 OPJ_UINT32 numcomps; /* number of components in tile */
238 opj_tcd_tilecomp_t *comps; /* Components information */
239 OPJ_SIZE_T numpix; /* number of pixels */
240 OPJ_FLOAT64 distotile; /* distortion of the tile */
241 OPJ_FLOAT64 distolayer[100]; /* distortion per layer */
242 OPJ_UINT32 packno; /* packet number */
243 } opj_tcd_tile_t;
244
245 /**
246 FIXME DOC
247 */
248 typedef struct opj_tcd_image {
249 opj_tcd_tile_t *tiles; /* Tiles information */
250 }
251 opj_tcd_image_t;
252
253
254 /**
255 Tile coder/decoder
256 */
257 typedef struct opj_tcd {
258 /** Position of the tilepart flag in Progression order*/
259 OPJ_INT32 tp_pos;
260 /** Tile part number*/
261 OPJ_UINT32 tp_num;
262 /** Current tile part number*/
263 OPJ_UINT32 cur_tp_num;
264 /** Total number of tileparts of the current tile*/
265 OPJ_UINT32 cur_totnum_tp;
266 /** Current Packet iterator number */
267 OPJ_UINT32 cur_pino;
268 /** info on each image tile */
269 opj_tcd_image_t *tcd_image;
270 /** image header */
271 opj_image_t *image;
272 /** coding parameters */
273 opj_cp_t *cp;
274 /** coding/decoding parameters common to all tiles */
275 opj_tcp_t *tcp;
276 /** current encoded/decoded tile */
277 OPJ_UINT32 tcd_tileno;
278 /** tell if the tcd is a decoder. */
279 OPJ_BITFIELD m_is_decoder : 1;
280 /** Thread pool */
281 opj_thread_pool_t* thread_pool;
282 /** Coordinates of the window of interest, in grid reference space */
283 OPJ_UINT32 win_x0;
284 OPJ_UINT32 win_y0;
285 OPJ_UINT32 win_x1;
286 OPJ_UINT32 win_y1;
287 /** Only valid for decoding. Whether the whole tile is decoded, or just the region in win_x0/win_y0/win_x1/win_y1 */
288 OPJ_BOOL whole_tile_decoding;
289 /* Array of size image->numcomps indicating if a component must be decoded. NULL if all components must be decoded */
290 OPJ_BOOL* used_component;
291 } opj_tcd_t;
292
293 /**
294 * Structure to hold information needed to generate some markers.
295 * Used by encoder.
296 */
297 typedef struct opj_tcd_marker_info {
298 /** In: Whether information to generate PLT markers in needed */
299 OPJ_BOOL need_PLT;
300
301 /** OUT: Number of elements in p_packet_size[] array */
302 OPJ_UINT32 packet_count;
303
304 /** OUT: Array of size packet_count, such that p_packet_size[i] is
305 * the size in bytes of the ith packet */
306 OPJ_UINT32* p_packet_size;
307 } opj_tcd_marker_info_t;
308
309 /** @name Exported functions */
310 /*@{*/
311 /* ----------------------------------------------------------------------- */
312
313 /**
314 Dump the content of a tcd structure
315 */
316 /*void tcd_dump(FILE *fd, opj_tcd_t *tcd, opj_tcd_image_t *img);*/ /* TODO MSD should use the new v2 structures */
317
318 /**
319 Create a new TCD handle
320 @param p_is_decoder FIXME DOC
321 @return Returns a new TCD handle if successful returns NULL otherwise
322 */
323 opj_tcd_t* opj_tcd_create(OPJ_BOOL p_is_decoder);
324
325 /**
326 Destroy a previously created TCD handle
327 @param tcd TCD handle to destroy
328 */
329 void opj_tcd_destroy(opj_tcd_t *tcd);
330
331
332 /**
333 * Create a new opj_tcd_marker_info_t* structure
334 * @param need_PLT Whether information is needed to generate PLT markers.
335 */
336 opj_tcd_marker_info_t* opj_tcd_marker_info_create(OPJ_BOOL need_PLT);
337
338
339 /**
340 Destroy a previously created opj_tcd_marker_info_t* structure
341 @param p_tcd_marker_info Structure to destroy
342 */
343 void opj_tcd_marker_info_destroy(opj_tcd_marker_info_t *p_tcd_marker_info);
344
345
346 /**
347 * Initialize the tile coder and may reuse some memory.
348 * @param p_tcd TCD handle.
349 * @param p_image raw image.
350 * @param p_cp coding parameters.
351 * @param p_tp thread pool
352 *
353 * @return true if the encoding values could be set (false otherwise).
354 */
355 OPJ_BOOL opj_tcd_init(opj_tcd_t *p_tcd,
356 opj_image_t * p_image,
357 opj_cp_t * p_cp,
358 opj_thread_pool_t* p_tp);
359
360 /**
361 * Allocates memory for decoding a specific tile.
362 *
363 * @param p_tcd the tile decoder.
364 * @param p_tile_no the index of the tile received in sequence. This not necessarily lead to the
365 * tile at index p_tile_no.
366 * @param p_manager the event manager.
367 *
368 * @return true if the remaining data is sufficient.
369 */
370 OPJ_BOOL opj_tcd_init_decode_tile(opj_tcd_t *p_tcd, OPJ_UINT32 p_tile_no,
371 opj_event_mgr_t* p_manager);
372
373 /**
374 * Gets the maximum tile size that will be taken by the tile once decoded.
375 */
376 OPJ_UINT32 opj_tcd_get_decoded_tile_size(opj_tcd_t *p_tcd,
377 OPJ_BOOL take_into_account_partial_decoding);
378
379 /**
380 * Encodes a tile from the raw image into the given buffer.
381 * @param p_tcd Tile Coder handle
382 * @param p_tile_no Index of the tile to encode.
383 * @param p_dest Destination buffer
384 * @param p_data_written pointer to an int that is incremented by the number of bytes really written on p_dest
385 * @param p_len Maximum length of the destination buffer
386 * @param p_cstr_info Codestream information structure
387 * @param p_marker_info Marker information structure
388 * @param p_manager the user event manager
389 * @return true if the coding is successful.
390 */
391 OPJ_BOOL opj_tcd_encode_tile(opj_tcd_t *p_tcd,
392 OPJ_UINT32 p_tile_no,
393 OPJ_BYTE *p_dest,
394 OPJ_UINT32 * p_data_written,
395 OPJ_UINT32 p_len,
396 struct opj_codestream_info *p_cstr_info,
397 opj_tcd_marker_info_t* p_marker_info,
398 opj_event_mgr_t *p_manager);
399
400
401 /**
402 Decode a tile from a buffer into a raw image
403 @param tcd TCD handle
404 @param win_x0 Upper left x of region to decode (in grid coordinates)
405 @param win_y0 Upper left y of region to decode (in grid coordinates)
406 @param win_x1 Lower right x of region to decode (in grid coordinates)
407 @param win_y1 Lower right y of region to decode (in grid coordinates)
408 @param numcomps_to_decode Size of the comps_indices array, or 0 if decoding all components.
409 @param comps_indices Array of numcomps values representing the indices
410 of the components to decode (relative to the
411 codestream, starting at 0). Or NULL if decoding all components.
412 @param src Source buffer
413 @param len Length of source buffer
414 @param tileno Number that identifies one of the tiles to be decoded
415 @param cstr_info FIXME DOC
416 @param manager the event manager.
417 */
418 OPJ_BOOL opj_tcd_decode_tile(opj_tcd_t *tcd,
419 OPJ_UINT32 win_x0,
420 OPJ_UINT32 win_y0,
421 OPJ_UINT32 win_x1,
422 OPJ_UINT32 win_y1,
423 OPJ_UINT32 numcomps_to_decode,
424 const OPJ_UINT32 *comps_indices,
425 OPJ_BYTE *src,
426 OPJ_UINT32 len,
427 OPJ_UINT32 tileno,
428 opj_codestream_index_t *cstr_info,
429 opj_event_mgr_t *manager);
430
431
432 /**
433 * Copies tile data from the system onto the given memory block.
434 */
435 OPJ_BOOL opj_tcd_update_tile_data(opj_tcd_t *p_tcd,
436 OPJ_BYTE * p_dest,
437 OPJ_UINT32 p_dest_length);
438
439 /**
440 * Get the size in bytes of the input buffer provided before encoded.
441 * This must be the size provided to the p_src_length argument of
442 * opj_tcd_copy_tile_data()
443 */
444 OPJ_SIZE_T opj_tcd_get_encoder_input_buffer_size(opj_tcd_t *p_tcd);
445
446 /**
447 * Initialize the tile coder and may reuse some memory.
448 *
449 * @param p_tcd TCD handle.
450 * @param p_tile_no current tile index to encode.
451 * @param p_manager the event manager.
452 *
453 * @return true if the encoding values could be set (false otherwise).
454 */
455 OPJ_BOOL opj_tcd_init_encode_tile(opj_tcd_t *p_tcd,
456 OPJ_UINT32 p_tile_no, opj_event_mgr_t* p_manager);
457
458 /**
459 * Copies tile data from the given memory block onto the system.
460 *
461 * p_src_length must be equal to opj_tcd_get_encoder_input_buffer_size()
462 */
463 OPJ_BOOL opj_tcd_copy_tile_data(opj_tcd_t *p_tcd,
464 OPJ_BYTE * p_src,
465 OPJ_SIZE_T p_src_length);
466
467 /**
468 * Allocates tile component data
469 *
470 *
471 */
472 OPJ_BOOL opj_alloc_tile_component_data(opj_tcd_tilecomp_t *l_tilec);
473
474 /** Returns whether a sub-band is empty (i.e. whether it has a null area)
475 * @param band Sub-band handle.
476 * @return OPJ_TRUE whether the sub-band is empty.
477 */
478 OPJ_BOOL opj_tcd_is_band_empty(opj_tcd_band_t* band);
479
480 /** Reinitialize a segment */
481 void opj_tcd_reinit_segment(opj_tcd_seg_t* seg);
482
483
484 /** Returns whether a sub-band region contributes to the area of interest
485 * tcd->win_x0,tcd->win_y0,tcd->win_x1,tcd->win_y1.
486 *
487 * @param tcd TCD handle.
488 * @param compno Component number
489 * @param resno Resolution number
490 * @param bandno Band number (*not* band index, ie 0, 1, 2 or 3)
491 * @param x0 Upper left x in subband coordinates
492 * @param y0 Upper left y in subband coordinates
493 * @param x1 Lower right x in subband coordinates
494 * @param y1 Lower right y in subband coordinates
495 * @return OPJ_TRUE whether the sub-band region contributes to the area of
496 * interest.
497 */
498 OPJ_BOOL opj_tcd_is_subband_area_of_interest(opj_tcd_t *tcd,
499 OPJ_UINT32 compno,
500 OPJ_UINT32 resno,
501 OPJ_UINT32 bandno,
502 OPJ_UINT32 x0,
503 OPJ_UINT32 y0,
504 OPJ_UINT32 x1,
505 OPJ_UINT32 y1);
506
507 /* ----------------------------------------------------------------------- */
508 /*@}*/
509
510 /*@}*/
511
512 #endif /* OPJ_TCD_H */