Add support for partial bitstream decoding (#1407) (fixes #715)
[openjpeg.git] / src / lib / openjp2 / t2.c
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
41 #include "opj_includes.h"
42 #include "opj_common.h"
43
44
45 /** @defgroup T2 T2 - Implementation of a tier-2 coding */
46 /*@{*/
47
48 /** @name Local static functions */
49 /*@{*/
50
51 static void opj_t2_putcommacode(opj_bio_t *bio, OPJ_INT32 n);
52
53 static OPJ_UINT32 opj_t2_getcommacode(opj_bio_t *bio);
54 /**
55 Variable length code for signalling delta Zil (truncation point)
56 @param bio  Bit Input/Output component
57 @param n    delta Zil
58 */
59 static void opj_t2_putnumpasses(opj_bio_t *bio, OPJ_UINT32 n);
60 static OPJ_UINT32 opj_t2_getnumpasses(opj_bio_t *bio);
61
62 /**
63 Encode a packet of a tile to a destination buffer
64 @param tileno Number of the tile encoded
65 @param tile Tile for which to write the packets
66 @param tcp Tile coding parameters
67 @param pi Packet identity
68 @param dest Destination buffer
69 @param p_data_written   FIXME DOC
70 @param len Length of the destination buffer
71 @param cstr_info Codestream information structure
72 @param p_t2_mode If == THRESH_CALC In Threshold calculation ,If == FINAL_PASS Final pass
73 @param p_manager the user event manager
74 @return
75 */
76 static OPJ_BOOL opj_t2_encode_packet(OPJ_UINT32 tileno,
77                                      opj_tcd_tile_t *tile,
78                                      opj_tcp_t *tcp,
79                                      opj_pi_iterator_t *pi,
80                                      OPJ_BYTE *dest,
81                                      OPJ_UINT32 * p_data_written,
82                                      OPJ_UINT32 len,
83                                      opj_codestream_info_t *cstr_info,
84                                      J2K_T2_MODE p_t2_mode,
85                                      opj_event_mgr_t *p_manager);
86
87 /**
88 Decode a packet of a tile from a source buffer
89 @param t2 T2 handle
90 @param tile Tile for which to write the packets
91 @param tcp Tile coding parameters
92 @param pi Packet identity
93 @param src Source buffer
94 @param data_read   FIXME DOC
95 @param max_length  FIXME DOC
96 @param pack_info Packet information
97 @param p_manager the user event manager
98
99 @return  FIXME DOC
100 */
101 static OPJ_BOOL opj_t2_decode_packet(opj_t2_t* t2,
102                                      opj_tcd_tile_t *tile,
103                                      opj_tcp_t *tcp,
104                                      opj_pi_iterator_t *pi,
105                                      OPJ_BYTE *src,
106                                      OPJ_UINT32 * data_read,
107                                      OPJ_UINT32 max_length,
108                                      opj_packet_info_t *pack_info,
109                                      opj_event_mgr_t *p_manager);
110
111 static OPJ_BOOL opj_t2_skip_packet(opj_t2_t* p_t2,
112                                    opj_tcd_tile_t *p_tile,
113                                    opj_tcp_t *p_tcp,
114                                    opj_pi_iterator_t *p_pi,
115                                    OPJ_BYTE *p_src,
116                                    OPJ_UINT32 * p_data_read,
117                                    OPJ_UINT32 p_max_length,
118                                    opj_packet_info_t *p_pack_info,
119                                    opj_event_mgr_t *p_manager);
120
121 static OPJ_BOOL opj_t2_read_packet_header(opj_t2_t* p_t2,
122         opj_tcd_tile_t *p_tile,
123         opj_tcp_t *p_tcp,
124         opj_pi_iterator_t *p_pi,
125         OPJ_BOOL * p_is_data_present,
126         OPJ_BYTE *p_src_data,
127         OPJ_UINT32 * p_data_read,
128         OPJ_UINT32 p_max_length,
129         opj_packet_info_t *p_pack_info,
130         opj_event_mgr_t *p_manager);
131
132 static OPJ_BOOL opj_t2_read_packet_data(opj_t2_t* p_t2,
133                                         opj_tcd_tile_t *p_tile,
134                                         opj_pi_iterator_t *p_pi,
135                                         OPJ_BYTE *p_src_data,
136                                         OPJ_UINT32 * p_data_read,
137                                         OPJ_UINT32 p_max_length,
138                                         opj_packet_info_t *pack_info,
139                                         opj_event_mgr_t *p_manager);
140
141 static OPJ_BOOL opj_t2_skip_packet_data(opj_t2_t* p_t2,
142                                         opj_tcd_tile_t *p_tile,
143                                         opj_pi_iterator_t *p_pi,
144                                         OPJ_UINT32 * p_data_read,
145                                         OPJ_UINT32 p_max_length,
146                                         opj_packet_info_t *pack_info,
147                                         opj_event_mgr_t *p_manager);
148
149 /**
150 @param cblk
151 @param index
152 @param cblksty
153 @param first
154 */
155 static OPJ_BOOL opj_t2_init_seg(opj_tcd_cblk_dec_t* cblk,
156                                 OPJ_UINT32 index,
157                                 OPJ_UINT32 cblksty,
158                                 OPJ_UINT32 first);
159
160 /*@}*/
161
162 /*@}*/
163
164 /* ----------------------------------------------------------------------- */
165
166 /* #define RESTART 0x04 */
167 static void opj_t2_putcommacode(opj_bio_t *bio, OPJ_INT32 n)
168 {
169     while (--n >= 0) {
170         opj_bio_write(bio, 1, 1);
171     }
172     opj_bio_write(bio, 0, 1);
173 }
174
175 static OPJ_UINT32 opj_t2_getcommacode(opj_bio_t *bio)
176 {
177     OPJ_UINT32 n = 0;
178     while (opj_bio_read(bio, 1)) {
179         ++n;
180     }
181     return n;
182 }
183
184 static void opj_t2_putnumpasses(opj_bio_t *bio, OPJ_UINT32 n)
185 {
186     if (n == 1) {
187         opj_bio_write(bio, 0, 1);
188     } else if (n == 2) {
189         opj_bio_write(bio, 2, 2);
190     } else if (n <= 5) {
191         opj_bio_write(bio, 0xc | (n - 3), 4);
192     } else if (n <= 36) {
193         opj_bio_write(bio, 0x1e0 | (n - 6), 9);
194     } else if (n <= 164) {
195         opj_bio_write(bio, 0xff80 | (n - 37), 16);
196     }
197 }
198
199 static OPJ_UINT32 opj_t2_getnumpasses(opj_bio_t *bio)
200 {
201     OPJ_UINT32 n;
202     if (!opj_bio_read(bio, 1)) {
203         return 1;
204     }
205     if (!opj_bio_read(bio, 1)) {
206         return 2;
207     }
208     if ((n = opj_bio_read(bio, 2)) != 3) {
209         return (3 + n);
210     }
211     if ((n = opj_bio_read(bio, 5)) != 31) {
212         return (6 + n);
213     }
214     return (37 + opj_bio_read(bio, 7));
215 }
216
217 /* ----------------------------------------------------------------------- */
218
219 OPJ_BOOL opj_t2_encode_packets(opj_t2_t* p_t2,
220                                OPJ_UINT32 p_tile_no,
221                                opj_tcd_tile_t *p_tile,
222                                OPJ_UINT32 p_maxlayers,
223                                OPJ_BYTE *p_dest,
224                                OPJ_UINT32 * p_data_written,
225                                OPJ_UINT32 p_max_len,
226                                opj_codestream_info_t *cstr_info,
227                                opj_tcd_marker_info_t* p_marker_info,
228                                OPJ_UINT32 p_tp_num,
229                                OPJ_INT32 p_tp_pos,
230                                OPJ_UINT32 p_pino,
231                                J2K_T2_MODE p_t2_mode,
232                                opj_event_mgr_t *p_manager)
233 {
234     OPJ_BYTE *l_current_data = p_dest;
235     OPJ_UINT32 l_nb_bytes = 0;
236     OPJ_UINT32 compno;
237     OPJ_UINT32 poc;
238     opj_pi_iterator_t *l_pi = 00;
239     opj_pi_iterator_t *l_current_pi = 00;
240     opj_image_t *l_image = p_t2->image;
241     opj_cp_t *l_cp = p_t2->cp;
242     opj_tcp_t *l_tcp = &l_cp->tcps[p_tile_no];
243     OPJ_UINT32 pocno = (l_cp->rsiz == OPJ_PROFILE_CINEMA_4K) ? 2 : 1;
244     OPJ_UINT32 l_max_comp = l_cp->m_specific_param.m_enc.m_max_comp_size > 0 ?
245                             l_image->numcomps : 1;
246     OPJ_UINT32 l_nb_pocs = l_tcp->numpocs + 1;
247
248     l_pi = opj_pi_initialise_encode(l_image, l_cp, p_tile_no, p_t2_mode, p_manager);
249     if (!l_pi) {
250         return OPJ_FALSE;
251     }
252
253     * p_data_written = 0;
254
255     if (p_t2_mode == THRESH_CALC) { /* Calculating threshold */
256         l_current_pi = l_pi;
257
258         for (compno = 0; compno < l_max_comp; ++compno) {
259             OPJ_UINT32 l_comp_len = 0;
260             l_current_pi = l_pi;
261
262             for (poc = 0; poc < pocno ; ++poc) {
263                 OPJ_UINT32 l_tp_num = compno;
264
265                 /* TODO MSD : check why this function cannot fail (cf. v1) */
266                 opj_pi_create_encode(l_pi, l_cp, p_tile_no, poc, l_tp_num, p_tp_pos, p_t2_mode);
267
268                 if (l_current_pi->poc.prg == OPJ_PROG_UNKNOWN) {
269                     /* TODO ADE : add an error */
270                     opj_pi_destroy(l_pi, l_nb_pocs);
271                     return OPJ_FALSE;
272                 }
273                 while (opj_pi_next(l_current_pi)) {
274                     if (l_current_pi->layno < p_maxlayers) {
275                         l_nb_bytes = 0;
276
277                         if (! opj_t2_encode_packet(p_tile_no, p_tile, l_tcp, l_current_pi,
278                                                    l_current_data, &l_nb_bytes,
279                                                    p_max_len, cstr_info,
280                                                    p_t2_mode,
281                                                    p_manager)) {
282                             opj_pi_destroy(l_pi, l_nb_pocs);
283                             return OPJ_FALSE;
284                         }
285
286                         l_comp_len += l_nb_bytes;
287                         l_current_data += l_nb_bytes;
288                         p_max_len -= l_nb_bytes;
289
290                         * p_data_written += l_nb_bytes;
291                     }
292                 }
293
294                 if (l_cp->m_specific_param.m_enc.m_max_comp_size) {
295                     if (l_comp_len > l_cp->m_specific_param.m_enc.m_max_comp_size) {
296                         opj_pi_destroy(l_pi, l_nb_pocs);
297                         return OPJ_FALSE;
298                     }
299                 }
300
301                 ++l_current_pi;
302             }
303         }
304     } else { /* t2_mode == FINAL_PASS  */
305         opj_pi_create_encode(l_pi, l_cp, p_tile_no, p_pino, p_tp_num, p_tp_pos,
306                              p_t2_mode);
307
308         l_current_pi = &l_pi[p_pino];
309         if (l_current_pi->poc.prg == OPJ_PROG_UNKNOWN) {
310             /* TODO ADE : add an error */
311             opj_pi_destroy(l_pi, l_nb_pocs);
312             return OPJ_FALSE;
313         }
314
315         if (p_marker_info && p_marker_info->need_PLT) {
316             /* One time use intended */
317             assert(p_marker_info->packet_count == 0);
318             assert(p_marker_info->p_packet_size == NULL);
319
320             p_marker_info->p_packet_size = (OPJ_UINT32*) opj_malloc(
321                                                opj_get_encoding_packet_count(l_image, l_cp, p_tile_no) * sizeof(OPJ_UINT32));
322             if (p_marker_info->p_packet_size == NULL) {
323                 opj_pi_destroy(l_pi, l_nb_pocs);
324                 return OPJ_FALSE;
325             }
326         }
327
328         while (opj_pi_next(l_current_pi)) {
329             if (l_current_pi->layno < p_maxlayers) {
330                 l_nb_bytes = 0;
331
332                 if (! opj_t2_encode_packet(p_tile_no, p_tile, l_tcp, l_current_pi,
333                                            l_current_data, &l_nb_bytes, p_max_len,
334                                            cstr_info, p_t2_mode, p_manager)) {
335                     opj_pi_destroy(l_pi, l_nb_pocs);
336                     return OPJ_FALSE;
337                 }
338
339                 l_current_data += l_nb_bytes;
340                 p_max_len -= l_nb_bytes;
341
342                 * p_data_written += l_nb_bytes;
343
344                 if (p_marker_info && p_marker_info->need_PLT) {
345                     p_marker_info->p_packet_size[p_marker_info->packet_count] = l_nb_bytes;
346                     p_marker_info->packet_count ++;
347                 }
348
349                 /* INDEX >> */
350                 if (cstr_info) {
351                     if (cstr_info->index_write) {
352                         opj_tile_info_t *info_TL = &cstr_info->tile[p_tile_no];
353                         opj_packet_info_t *info_PK = &info_TL->packet[cstr_info->packno];
354                         if (!cstr_info->packno) {
355                             info_PK->start_pos = info_TL->end_header + 1;
356                         } else {
357                             info_PK->start_pos = ((l_cp->m_specific_param.m_enc.m_tp_on | l_tcp->POC) &&
358                                                   info_PK->start_pos) ? info_PK->start_pos : info_TL->packet[cstr_info->packno -
359                                                                             1].end_pos + 1;
360                         }
361                         info_PK->end_pos = info_PK->start_pos + l_nb_bytes - 1;
362                         info_PK->end_ph_pos += info_PK->start_pos -
363                                                1;  /* End of packet header which now only represents the distance
364                                                                                                                                                                                                                                                    to start of packet is incremented by value of start of packet*/
365                     }
366
367                     cstr_info->packno++;
368                 }
369                 /* << INDEX */
370                 ++p_tile->packno;
371             }
372         }
373     }
374
375     opj_pi_destroy(l_pi, l_nb_pocs);
376
377     return OPJ_TRUE;
378 }
379
380 /* see issue 80 */
381 #if 0
382 #define JAS_FPRINTF fprintf
383 #else
384 /* issue 290 */
385 static void opj_null_jas_fprintf(FILE* file, const char * format, ...)
386 {
387     (void)file;
388     (void)format;
389 }
390 #define JAS_FPRINTF opj_null_jas_fprintf
391 #endif
392
393 OPJ_BOOL opj_t2_decode_packets(opj_tcd_t* tcd,
394                                opj_t2_t *p_t2,
395                                OPJ_UINT32 p_tile_no,
396                                opj_tcd_tile_t *p_tile,
397                                OPJ_BYTE *p_src,
398                                OPJ_UINT32 * p_data_read,
399                                OPJ_UINT32 p_max_len,
400                                opj_codestream_index_t *p_cstr_index,
401                                opj_event_mgr_t *p_manager)
402 {
403     OPJ_BYTE *l_current_data = p_src;
404     opj_pi_iterator_t *l_pi = 00;
405     OPJ_UINT32 pino;
406     opj_image_t *l_image = p_t2->image;
407     opj_cp_t *l_cp = p_t2->cp;
408     opj_tcp_t *l_tcp = &(p_t2->cp->tcps[p_tile_no]);
409     OPJ_UINT32 l_nb_bytes_read;
410     OPJ_UINT32 l_nb_pocs = l_tcp->numpocs + 1;
411     opj_pi_iterator_t *l_current_pi = 00;
412 #ifdef TODO_MSD
413     OPJ_UINT32 curtp = 0;
414     OPJ_UINT32 tp_start_packno;
415 #endif
416     opj_packet_info_t *l_pack_info = 00;
417     opj_image_comp_t* l_img_comp = 00;
418
419     OPJ_ARG_NOT_USED(p_cstr_index);
420
421 #ifdef TODO_MSD
422     if (p_cstr_index) {
423         l_pack_info = p_cstr_index->tile_index[p_tile_no].packet;
424     }
425 #endif
426
427     /* create a packet iterator */
428     l_pi = opj_pi_create_decode(l_image, l_cp, p_tile_no, p_manager);
429     if (!l_pi) {
430         return OPJ_FALSE;
431     }
432
433
434     l_current_pi = l_pi;
435
436     for (pino = 0; pino <= l_tcp->numpocs; ++pino) {
437
438         /* if the resolution needed is too low, one dim of the tilec could be equal to zero
439          * and no packets are used to decode this resolution and
440          * l_current_pi->resno is always >= p_tile->comps[l_current_pi->compno].minimum_num_resolutions
441          * and no l_img_comp->resno_decoded are computed
442          */
443         OPJ_BOOL* first_pass_failed = NULL;
444
445         if (l_current_pi->poc.prg == OPJ_PROG_UNKNOWN) {
446             /* TODO ADE : add an error */
447             opj_pi_destroy(l_pi, l_nb_pocs);
448             return OPJ_FALSE;
449         }
450
451         first_pass_failed = (OPJ_BOOL*)opj_malloc(l_image->numcomps * sizeof(OPJ_BOOL));
452         if (!first_pass_failed) {
453             opj_pi_destroy(l_pi, l_nb_pocs);
454             return OPJ_FALSE;
455         }
456         memset(first_pass_failed, OPJ_TRUE, l_image->numcomps * sizeof(OPJ_BOOL));
457
458         while (opj_pi_next(l_current_pi)) {
459             OPJ_BOOL skip_packet = OPJ_FALSE;
460             JAS_FPRINTF(stderr,
461                         "packet offset=00000166 prg=%d cmptno=%02d rlvlno=%02d prcno=%03d lyrno=%02d\n\n",
462                         l_current_pi->poc.prg1, l_current_pi->compno, l_current_pi->resno,
463                         l_current_pi->precno, l_current_pi->layno);
464
465             /* If the packet layer is greater or equal than the maximum */
466             /* number of layers, skip the packet */
467             if (l_current_pi->layno >= l_tcp->num_layers_to_decode) {
468                 skip_packet = OPJ_TRUE;
469             }
470             /* If the packet resolution number is greater than the minimum */
471             /* number of resolution allowed, skip the packet */
472             else if (l_current_pi->resno >=
473                      p_tile->comps[l_current_pi->compno].minimum_num_resolutions) {
474                 skip_packet = OPJ_TRUE;
475             } else {
476                 /* If no precincts of any band intersects the area of interest, */
477                 /* skip the packet */
478                 OPJ_UINT32 bandno;
479                 opj_tcd_tilecomp_t *tilec = &p_tile->comps[l_current_pi->compno];
480                 opj_tcd_resolution_t *res = &tilec->resolutions[l_current_pi->resno];
481
482                 skip_packet = OPJ_TRUE;
483                 for (bandno = 0; bandno < res->numbands; ++bandno) {
484                     opj_tcd_band_t* band = &res->bands[bandno];
485                     opj_tcd_precinct_t* prec = &band->precincts[l_current_pi->precno];
486
487                     if (opj_tcd_is_subband_area_of_interest(tcd,
488                                                             l_current_pi->compno,
489                                                             l_current_pi->resno,
490                                                             band->bandno,
491                                                             (OPJ_UINT32)prec->x0,
492                                                             (OPJ_UINT32)prec->y0,
493                                                             (OPJ_UINT32)prec->x1,
494                                                             (OPJ_UINT32)prec->y1)) {
495                         skip_packet = OPJ_FALSE;
496                         break;
497                     }
498                 }
499                 /*
500                                 printf("packet cmptno=%02d rlvlno=%02d prcno=%03d lyrno=%02d -> %s\n",
501                                     l_current_pi->compno, l_current_pi->resno,
502                                     l_current_pi->precno, l_current_pi->layno, skip_packet ? "skipped" : "kept");
503                 */
504             }
505             if (!skip_packet) {
506                 l_nb_bytes_read = 0;
507
508                 first_pass_failed[l_current_pi->compno] = OPJ_FALSE;
509
510                 if (! opj_t2_decode_packet(p_t2, p_tile, l_tcp, l_current_pi, l_current_data,
511                                            &l_nb_bytes_read, p_max_len, l_pack_info, p_manager)) {
512                     opj_pi_destroy(l_pi, l_nb_pocs);
513                     opj_free(first_pass_failed);
514                     return OPJ_FALSE;
515                 }
516
517                 l_img_comp = &(l_image->comps[l_current_pi->compno]);
518                 l_img_comp->resno_decoded = opj_uint_max(l_current_pi->resno,
519                                             l_img_comp->resno_decoded);
520             } else {
521                 l_nb_bytes_read = 0;
522                 if (! opj_t2_skip_packet(p_t2, p_tile, l_tcp, l_current_pi, l_current_data,
523                                          &l_nb_bytes_read, p_max_len, l_pack_info, p_manager)) {
524                     opj_pi_destroy(l_pi, l_nb_pocs);
525                     opj_free(first_pass_failed);
526                     return OPJ_FALSE;
527                 }
528             }
529
530             if (first_pass_failed[l_current_pi->compno]) {
531                 l_img_comp = &(l_image->comps[l_current_pi->compno]);
532                 if (l_img_comp->resno_decoded == 0) {
533                     l_img_comp->resno_decoded =
534                         p_tile->comps[l_current_pi->compno].minimum_num_resolutions - 1;
535                 }
536             }
537
538             l_current_data += l_nb_bytes_read;
539             p_max_len -= l_nb_bytes_read;
540
541             /* INDEX >> */
542 #ifdef TODO_MSD
543             if (p_cstr_info) {
544                 opj_tile_info_v2_t *info_TL = &p_cstr_info->tile[p_tile_no];
545                 opj_packet_info_t *info_PK = &info_TL->packet[p_cstr_info->packno];
546                 tp_start_packno = 0;
547                 if (!p_cstr_info->packno) {
548                     info_PK->start_pos = info_TL->end_header + 1;
549                 } else if (info_TL->packet[p_cstr_info->packno - 1].end_pos >=
550                            (OPJ_INT32)
551                            p_cstr_info->tile[p_tile_no].tp[curtp].tp_end_pos) { /* New tile part */
552                     info_TL->tp[curtp].tp_numpacks = p_cstr_info->packno -
553                                                      tp_start_packno; /* Number of packets in previous tile-part */
554                     tp_start_packno = p_cstr_info->packno;
555                     curtp++;
556                     info_PK->start_pos = p_cstr_info->tile[p_tile_no].tp[curtp].tp_end_header + 1;
557                 } else {
558                     info_PK->start_pos = (l_cp->m_specific_param.m_enc.m_tp_on &&
559                                           info_PK->start_pos) ? info_PK->start_pos : info_TL->packet[p_cstr_info->packno -
560                                                                       1].end_pos + 1;
561                 }
562                 info_PK->end_pos = info_PK->start_pos + l_nb_bytes_read - 1;
563                 info_PK->end_ph_pos += info_PK->start_pos -
564                                        1;  /* End of packet header which now only represents the distance */
565                 ++p_cstr_info->packno;
566             }
567 #endif
568             /* << INDEX */
569         }
570         ++l_current_pi;
571
572         opj_free(first_pass_failed);
573     }
574     /* INDEX >> */
575 #ifdef TODO_MSD
576     if
577     (p_cstr_info) {
578         p_cstr_info->tile[p_tile_no].tp[curtp].tp_numpacks = p_cstr_info->packno -
579                 tp_start_packno; /* Number of packets in last tile-part */
580     }
581 #endif
582     /* << INDEX */
583
584     /* don't forget to release pi */
585     opj_pi_destroy(l_pi, l_nb_pocs);
586     *p_data_read = (OPJ_UINT32)(l_current_data - p_src);
587     return OPJ_TRUE;
588 }
589
590 /* ----------------------------------------------------------------------- */
591
592 /**
593  * Creates a Tier 2 handle
594  *
595  * @param       p_image         Source or destination image
596  * @param       p_cp            Image coding parameters.
597  * @return              a new T2 handle if successful, NULL otherwise.
598 */
599 opj_t2_t* opj_t2_create(opj_image_t *p_image, opj_cp_t *p_cp)
600 {
601     /* create the t2 structure */
602     opj_t2_t *l_t2 = (opj_t2_t*)opj_calloc(1, sizeof(opj_t2_t));
603     if (!l_t2) {
604         return NULL;
605     }
606
607     l_t2->image = p_image;
608     l_t2->cp = p_cp;
609
610     return l_t2;
611 }
612
613 void opj_t2_destroy(opj_t2_t *t2)
614 {
615     if (t2) {
616         opj_free(t2);
617     }
618 }
619
620 static OPJ_BOOL opj_t2_decode_packet(opj_t2_t* p_t2,
621                                      opj_tcd_tile_t *p_tile,
622                                      opj_tcp_t *p_tcp,
623                                      opj_pi_iterator_t *p_pi,
624                                      OPJ_BYTE *p_src,
625                                      OPJ_UINT32 * p_data_read,
626                                      OPJ_UINT32 p_max_length,
627                                      opj_packet_info_t *p_pack_info,
628                                      opj_event_mgr_t *p_manager)
629 {
630     OPJ_BOOL l_read_data;
631     OPJ_UINT32 l_nb_bytes_read = 0;
632     OPJ_UINT32 l_nb_total_bytes_read = 0;
633
634     *p_data_read = 0;
635
636     if (! opj_t2_read_packet_header(p_t2, p_tile, p_tcp, p_pi, &l_read_data, p_src,
637                                     &l_nb_bytes_read, p_max_length, p_pack_info, p_manager)) {
638         return OPJ_FALSE;
639     }
640
641     p_src += l_nb_bytes_read;
642     l_nb_total_bytes_read += l_nb_bytes_read;
643     p_max_length -= l_nb_bytes_read;
644
645     /* we should read data for the packet */
646     if (l_read_data) {
647         l_nb_bytes_read = 0;
648
649         if (! opj_t2_read_packet_data(p_t2, p_tile, p_pi, p_src, &l_nb_bytes_read,
650                                       p_max_length, p_pack_info, p_manager)) {
651             return OPJ_FALSE;
652         }
653
654         l_nb_total_bytes_read += l_nb_bytes_read;
655     }
656
657     *p_data_read = l_nb_total_bytes_read;
658
659     return OPJ_TRUE;
660 }
661
662 static OPJ_BOOL opj_t2_encode_packet(OPJ_UINT32 tileno,
663                                      opj_tcd_tile_t * tile,
664                                      opj_tcp_t * tcp,
665                                      opj_pi_iterator_t *pi,
666                                      OPJ_BYTE *dest,
667                                      OPJ_UINT32 * p_data_written,
668                                      OPJ_UINT32 length,
669                                      opj_codestream_info_t *cstr_info,
670                                      J2K_T2_MODE p_t2_mode,
671                                      opj_event_mgr_t *p_manager)
672 {
673     OPJ_UINT32 bandno, cblkno;
674     OPJ_BYTE* c = dest;
675     OPJ_UINT32 l_nb_bytes;
676     OPJ_UINT32 compno = pi->compno;     /* component value */
677     OPJ_UINT32 resno  = pi->resno;      /* resolution level value */
678     OPJ_UINT32 precno = pi->precno;     /* precinct value */
679     OPJ_UINT32 layno  = pi->layno;      /* quality layer value */
680     OPJ_UINT32 l_nb_blocks;
681     opj_tcd_band_t *band = 00;
682     opj_tcd_cblk_enc_t* cblk = 00;
683     opj_tcd_pass_t *pass = 00;
684
685     opj_tcd_tilecomp_t *tilec = &tile->comps[compno];
686     opj_tcd_resolution_t *res = &tilec->resolutions[resno];
687
688     opj_bio_t *bio = 00;    /* BIO component */
689 #ifdef ENABLE_EMPTY_PACKET_OPTIMIZATION
690     OPJ_BOOL packet_empty = OPJ_TRUE;
691 #else
692     OPJ_BOOL packet_empty = OPJ_FALSE;
693 #endif
694
695 #ifdef DEBUG_VERBOSE
696     if (p_t2_mode == FINAL_PASS) {
697         fprintf(stderr,
698                 "encode packet compono=%d, resno=%d, precno=%d, layno=%d\n",
699                 compno, resno, precno, layno);
700     }
701 #endif
702
703     /* <SOP 0xff91> */
704     if (tcp->csty & J2K_CP_CSTY_SOP) {
705         if (length < 6) {
706             if (p_t2_mode == FINAL_PASS) {
707                 opj_event_msg(p_manager, EVT_ERROR,
708                               "opj_t2_encode_packet(): only %u bytes remaining in "
709                               "output buffer. %u needed.\n",
710                               length, 6);
711             }
712             return OPJ_FALSE;
713         }
714         c[0] = 255;
715         c[1] = 145;
716         c[2] = 0;
717         c[3] = 4;
718 #if 0
719         c[4] = (tile->packno % 65536) / 256;
720         c[5] = (tile->packno % 65536) % 256;
721 #else
722         c[4] = (tile->packno >> 8) & 0xff; /* packno is uint32_t */
723         c[5] = tile->packno & 0xff;
724 #endif
725         c += 6;
726         length -= 6;
727     }
728     /* </SOP> */
729
730     if (!layno) {
731         band = res->bands;
732
733         for (bandno = 0; bandno < res->numbands; ++bandno, ++band) {
734             opj_tcd_precinct_t *prc;
735
736             /* Skip empty bands */
737             if (opj_tcd_is_band_empty(band)) {
738                 continue;
739             }
740
741             /* Avoid out of bounds access of https://github.com/uclouvain/openjpeg/issues/1294 */
742             /* but likely not a proper fix. */
743             if (precno >= res->pw * res->ph) {
744                 opj_event_msg(p_manager, EVT_ERROR,
745                               "opj_t2_encode_packet(): accessing precno=%u >= %u\n",
746                               precno, res->pw * res->ph);
747                 return OPJ_FALSE;
748             }
749
750             prc = &band->precincts[precno];
751             opj_tgt_reset(prc->incltree);
752             opj_tgt_reset(prc->imsbtree);
753
754             l_nb_blocks = prc->cw * prc->ch;
755             for (cblkno = 0; cblkno < l_nb_blocks; ++cblkno) {
756                 cblk = &prc->cblks.enc[cblkno];
757
758                 cblk->numpasses = 0;
759                 opj_tgt_setvalue(prc->imsbtree, cblkno, band->numbps - (OPJ_INT32)cblk->numbps);
760             }
761         }
762     }
763
764     bio = opj_bio_create();
765     if (!bio) {
766         /* FIXME event manager error callback */
767         return OPJ_FALSE;
768     }
769     opj_bio_init_enc(bio, c, length);
770
771 #ifdef ENABLE_EMPTY_PACKET_OPTIMIZATION
772     /* WARNING: this code branch is disabled, since it has been reported that */
773     /* such packets cause decoding issues with cinema J2K hardware */
774     /* decoders: https://groups.google.com/forum/#!topic/openjpeg/M7M_fLX_Bco */
775
776     /* Check if the packet is empty */
777     /* Note: we could also skip that step and always write a packet header */
778     band = res->bands;
779     for (bandno = 0; bandno < res->numbands; ++bandno, ++band) {
780         opj_tcd_precinct_t *prc;
781         /* Skip empty bands */
782         if (opj_tcd_is_band_empty(band)) {
783             continue;
784         }
785
786         prc = &band->precincts[precno];
787         l_nb_blocks = prc->cw * prc->ch;
788         cblk = prc->cblks.enc;
789         for (cblkno = 0; cblkno < l_nb_blocks; cblkno++, ++cblk) {
790             opj_tcd_layer_t *layer = &cblk->layers[layno];
791
792             /* if cblk not included, go to the next cblk  */
793             if (!layer->numpasses) {
794                 continue;
795             }
796             packet_empty = OPJ_FALSE;
797             break;
798         }
799         if (!packet_empty) {
800             break;
801         }
802     }
803 #endif
804     opj_bio_write(bio, packet_empty ? 0 : 1, 1);           /* Empty header bit */
805
806     /* Writing Packet header */
807     band = res->bands;
808     for (bandno = 0; !packet_empty &&
809             bandno < res->numbands; ++bandno, ++band)      {
810         opj_tcd_precinct_t *prc;
811
812         /* Skip empty bands */
813         if (opj_tcd_is_band_empty(band)) {
814             continue;
815         }
816
817         /* Avoid out of bounds access of https://github.com/uclouvain/openjpeg/issues/1297 */
818         /* but likely not a proper fix. */
819         if (precno >= res->pw * res->ph) {
820             opj_event_msg(p_manager, EVT_ERROR,
821                           "opj_t2_encode_packet(): accessing precno=%u >= %u\n",
822                           precno, res->pw * res->ph);
823             return OPJ_FALSE;
824         }
825
826         prc = &band->precincts[precno];
827         l_nb_blocks = prc->cw * prc->ch;
828         cblk = prc->cblks.enc;
829
830         for (cblkno = 0; cblkno < l_nb_blocks; ++cblkno) {
831             opj_tcd_layer_t *layer = &cblk->layers[layno];
832
833             if (!cblk->numpasses && layer->numpasses) {
834                 opj_tgt_setvalue(prc->incltree, cblkno, (OPJ_INT32)layno);
835             }
836
837             ++cblk;
838         }
839
840         cblk = prc->cblks.enc;
841         for (cblkno = 0; cblkno < l_nb_blocks; cblkno++) {
842             opj_tcd_layer_t *layer = &cblk->layers[layno];
843             OPJ_UINT32 increment = 0;
844             OPJ_UINT32 nump = 0;
845             OPJ_UINT32 len = 0, passno;
846             OPJ_UINT32 l_nb_passes;
847
848             /* cblk inclusion bits */
849             if (!cblk->numpasses) {
850                 opj_tgt_encode(bio, prc->incltree, cblkno, (OPJ_INT32)(layno + 1));
851             } else {
852                 opj_bio_write(bio, layer->numpasses != 0, 1);
853             }
854
855             /* if cblk not included, go to the next cblk  */
856             if (!layer->numpasses) {
857                 ++cblk;
858                 continue;
859             }
860
861             /* if first instance of cblk --> zero bit-planes information */
862             if (!cblk->numpasses) {
863                 cblk->numlenbits = 3;
864                 opj_tgt_encode(bio, prc->imsbtree, cblkno, 999);
865             }
866
867             /* number of coding passes included */
868             opj_t2_putnumpasses(bio, layer->numpasses);
869             l_nb_passes = cblk->numpasses + layer->numpasses;
870             pass = cblk->passes +  cblk->numpasses;
871
872             /* computation of the increase of the length indicator and insertion in the header     */
873             for (passno = cblk->numpasses; passno < l_nb_passes; ++passno) {
874                 ++nump;
875                 len += pass->len;
876
877                 if (pass->term || passno == (cblk->numpasses + layer->numpasses) - 1) {
878                     increment = (OPJ_UINT32)opj_int_max((OPJ_INT32)increment,
879                                                         opj_int_floorlog2((OPJ_INT32)len) + 1
880                                                         - ((OPJ_INT32)cblk->numlenbits + opj_int_floorlog2((OPJ_INT32)nump)));
881                     len = 0;
882                     nump = 0;
883                 }
884
885                 ++pass;
886             }
887             opj_t2_putcommacode(bio, (OPJ_INT32)increment);
888
889             /* computation of the new Length indicator */
890             cblk->numlenbits += increment;
891
892             pass = cblk->passes +  cblk->numpasses;
893             /* insertion of the codeword segment length */
894             for (passno = cblk->numpasses; passno < l_nb_passes; ++passno) {
895                 nump++;
896                 len += pass->len;
897
898                 if (pass->term || passno == (cblk->numpasses + layer->numpasses) - 1) {
899                     opj_bio_write(bio, (OPJ_UINT32)len,
900                                   cblk->numlenbits + (OPJ_UINT32)opj_int_floorlog2((OPJ_INT32)nump));
901                     len = 0;
902                     nump = 0;
903                 }
904                 ++pass;
905             }
906
907             ++cblk;
908         }
909     }
910
911     if (!opj_bio_flush(bio)) {
912         opj_bio_destroy(bio);
913         return OPJ_FALSE;               /* modified to eliminate longjmp !! */
914     }
915
916     l_nb_bytes = (OPJ_UINT32)opj_bio_numbytes(bio);
917     c += l_nb_bytes;
918     length -= l_nb_bytes;
919
920     opj_bio_destroy(bio);
921
922     /* <EPH 0xff92> */
923     if (tcp->csty & J2K_CP_CSTY_EPH) {
924         if (length < 2) {
925             if (p_t2_mode == FINAL_PASS) {
926                 opj_event_msg(p_manager, EVT_ERROR,
927                               "opj_t2_encode_packet(): only %u bytes remaining in "
928                               "output buffer. %u needed.\n",
929                               length, 2);
930             }
931             return OPJ_FALSE;
932         }
933         c[0] = 255;
934         c[1] = 146;
935         c += 2;
936         length -= 2;
937     }
938     /* </EPH> */
939
940     /* << INDEX */
941     /* End of packet header position. Currently only represents the distance to start of packet
942        Will be updated later by incrementing with packet start value*/
943     if (cstr_info && cstr_info->index_write) {
944         opj_packet_info_t *info_PK = &cstr_info->tile[tileno].packet[cstr_info->packno];
945         info_PK->end_ph_pos = (OPJ_INT32)(c - dest);
946     }
947     /* INDEX >> */
948
949     /* Writing the packet body */
950     band = res->bands;
951     for (bandno = 0; !packet_empty && bandno < res->numbands; bandno++, ++band) {
952         opj_tcd_precinct_t *prc;
953
954         /* Skip empty bands */
955         if (opj_tcd_is_band_empty(band)) {
956             continue;
957         }
958
959         prc = &band->precincts[precno];
960         l_nb_blocks = prc->cw * prc->ch;
961         cblk = prc->cblks.enc;
962
963         for (cblkno = 0; cblkno < l_nb_blocks; ++cblkno) {
964             opj_tcd_layer_t *layer = &cblk->layers[layno];
965
966             if (!layer->numpasses) {
967                 ++cblk;
968                 continue;
969             }
970
971             if (layer->len > length) {
972                 if (p_t2_mode == FINAL_PASS) {
973                     opj_event_msg(p_manager, EVT_ERROR,
974                                   "opj_t2_encode_packet(): only %u bytes remaining in "
975                                   "output buffer. %u needed.\n",
976                                   length, layer->len);
977                 }
978                 return OPJ_FALSE;
979             }
980
981             memcpy(c, layer->data, layer->len);
982             cblk->numpasses += layer->numpasses;
983             c += layer->len;
984             length -= layer->len;
985
986             /* << INDEX */
987             if (cstr_info && cstr_info->index_write) {
988                 opj_packet_info_t *info_PK = &cstr_info->tile[tileno].packet[cstr_info->packno];
989                 info_PK->disto += layer->disto;
990                 if (cstr_info->D_max < info_PK->disto) {
991                     cstr_info->D_max = info_PK->disto;
992                 }
993             }
994
995             ++cblk;
996             /* INDEX >> */
997         }
998     }
999
1000     assert(c >= dest);
1001     * p_data_written += (OPJ_UINT32)(c - dest);
1002
1003     return OPJ_TRUE;
1004 }
1005
1006 static OPJ_BOOL opj_t2_skip_packet(opj_t2_t* p_t2,
1007                                    opj_tcd_tile_t *p_tile,
1008                                    opj_tcp_t *p_tcp,
1009                                    opj_pi_iterator_t *p_pi,
1010                                    OPJ_BYTE *p_src,
1011                                    OPJ_UINT32 * p_data_read,
1012                                    OPJ_UINT32 p_max_length,
1013                                    opj_packet_info_t *p_pack_info,
1014                                    opj_event_mgr_t *p_manager)
1015 {
1016     OPJ_BOOL l_read_data;
1017     OPJ_UINT32 l_nb_bytes_read = 0;
1018     OPJ_UINT32 l_nb_total_bytes_read = 0;
1019
1020     *p_data_read = 0;
1021
1022     if (! opj_t2_read_packet_header(p_t2, p_tile, p_tcp, p_pi, &l_read_data, p_src,
1023                                     &l_nb_bytes_read, p_max_length, p_pack_info, p_manager)) {
1024         return OPJ_FALSE;
1025     }
1026
1027     p_src += l_nb_bytes_read;
1028     l_nb_total_bytes_read += l_nb_bytes_read;
1029     p_max_length -= l_nb_bytes_read;
1030
1031     /* we should read data for the packet */
1032     if (l_read_data) {
1033         l_nb_bytes_read = 0;
1034
1035         if (! opj_t2_skip_packet_data(p_t2, p_tile, p_pi, &l_nb_bytes_read,
1036                                       p_max_length, p_pack_info, p_manager)) {
1037             return OPJ_FALSE;
1038         }
1039
1040         l_nb_total_bytes_read += l_nb_bytes_read;
1041     }
1042     *p_data_read = l_nb_total_bytes_read;
1043
1044     return OPJ_TRUE;
1045 }
1046
1047
1048 static OPJ_BOOL opj_t2_read_packet_header(opj_t2_t* p_t2,
1049         opj_tcd_tile_t *p_tile,
1050         opj_tcp_t *p_tcp,
1051         opj_pi_iterator_t *p_pi,
1052         OPJ_BOOL * p_is_data_present,
1053         OPJ_BYTE *p_src_data,
1054         OPJ_UINT32 * p_data_read,
1055         OPJ_UINT32 p_max_length,
1056         opj_packet_info_t *p_pack_info,
1057         opj_event_mgr_t *p_manager)
1058
1059 {
1060     /* loop */
1061     OPJ_UINT32 bandno, cblkno;
1062     OPJ_UINT32 l_nb_code_blocks;
1063     OPJ_UINT32 l_remaining_length;
1064     OPJ_UINT32 l_header_length;
1065     OPJ_UINT32 * l_modified_length_ptr = 00;
1066     OPJ_BYTE *l_current_data = p_src_data;
1067     opj_cp_t *l_cp = p_t2->cp;
1068     opj_bio_t *l_bio = 00;  /* BIO component */
1069     opj_tcd_band_t *l_band = 00;
1070     opj_tcd_cblk_dec_t* l_cblk = 00;
1071     opj_tcd_resolution_t* l_res =
1072         &p_tile->comps[p_pi->compno].resolutions[p_pi->resno];
1073
1074     OPJ_BYTE *l_header_data = 00;
1075     OPJ_BYTE **l_header_data_start = 00;
1076
1077     OPJ_UINT32 l_present;
1078
1079     if (p_pi->layno == 0) {
1080         l_band = l_res->bands;
1081
1082         /* reset tagtrees */
1083         for (bandno = 0; bandno < l_res->numbands; ++bandno) {
1084             if (!opj_tcd_is_band_empty(l_band)) {
1085                 opj_tcd_precinct_t *l_prc = &l_band->precincts[p_pi->precno];
1086                 if (!(p_pi->precno < (l_band->precincts_data_size / sizeof(
1087                                           opj_tcd_precinct_t)))) {
1088                     opj_event_msg(p_manager, EVT_ERROR, "Invalid precinct\n");
1089                     return OPJ_FALSE;
1090                 }
1091
1092
1093                 opj_tgt_reset(l_prc->incltree);
1094                 opj_tgt_reset(l_prc->imsbtree);
1095                 l_cblk = l_prc->cblks.dec;
1096
1097                 l_nb_code_blocks = l_prc->cw * l_prc->ch;
1098                 for (cblkno = 0; cblkno < l_nb_code_blocks; ++cblkno) {
1099                     l_cblk->numsegs = 0;
1100                     l_cblk->real_num_segs = 0;
1101                     ++l_cblk;
1102                 }
1103             }
1104
1105             ++l_band;
1106         }
1107     }
1108
1109     /* SOP markers */
1110
1111     if (p_tcp->csty & J2K_CP_CSTY_SOP) {
1112         if (p_max_length < 6) {
1113             opj_event_msg(p_manager, EVT_WARNING,
1114                           "Not enough space for expected SOP marker\n");
1115         } else if ((*l_current_data) != 0xff || (*(l_current_data + 1) != 0x91)) {
1116             opj_event_msg(p_manager, EVT_WARNING, "Expected SOP marker\n");
1117         } else {
1118             l_current_data += 6;
1119         }
1120
1121         /** TODO : check the Nsop value */
1122     }
1123
1124     /*
1125     When the marker PPT/PPM is used the packet header are store in PPT/PPM marker
1126     This part deal with this characteristic
1127     step 1: Read packet header in the saved structure
1128     step 2: Return to codestream for decoding
1129     */
1130
1131     l_bio = opj_bio_create();
1132     if (! l_bio) {
1133         return OPJ_FALSE;
1134     }
1135
1136     if (l_cp->ppm == 1) { /* PPM */
1137         l_header_data_start = &l_cp->ppm_data;
1138         l_header_data = *l_header_data_start;
1139         l_modified_length_ptr = &(l_cp->ppm_len);
1140
1141     } else if (p_tcp->ppt == 1) { /* PPT */
1142         l_header_data_start = &(p_tcp->ppt_data);
1143         l_header_data = *l_header_data_start;
1144         l_modified_length_ptr = &(p_tcp->ppt_len);
1145     } else { /* Normal Case */
1146         l_header_data_start = &(l_current_data);
1147         l_header_data = *l_header_data_start;
1148         l_remaining_length = (OPJ_UINT32)(p_src_data + p_max_length - l_header_data);
1149         l_modified_length_ptr = &(l_remaining_length);
1150     }
1151
1152     opj_bio_init_dec(l_bio, l_header_data, *l_modified_length_ptr);
1153
1154     l_present = opj_bio_read(l_bio, 1);
1155     JAS_FPRINTF(stderr, "present=%d \n", l_present);
1156     if (!l_present) {
1157         /* TODO MSD: no test to control the output of this function*/
1158         opj_bio_inalign(l_bio);
1159         l_header_data += opj_bio_numbytes(l_bio);
1160         opj_bio_destroy(l_bio);
1161
1162         /* EPH markers */
1163         if (p_tcp->csty & J2K_CP_CSTY_EPH) {
1164             if ((*l_modified_length_ptr - (OPJ_UINT32)(l_header_data -
1165                     *l_header_data_start)) < 2U) {
1166                 opj_event_msg(p_manager, EVT_WARNING,
1167                               "Not enough space for expected EPH marker\n");
1168             } else if ((*l_header_data) != 0xff || (*(l_header_data + 1) != 0x92)) {
1169                 opj_event_msg(p_manager, EVT_WARNING, "Expected EPH marker\n");
1170             } else {
1171                 l_header_data += 2;
1172             }
1173         }
1174
1175         l_header_length = (OPJ_UINT32)(l_header_data - *l_header_data_start);
1176         *l_modified_length_ptr -= l_header_length;
1177         *l_header_data_start += l_header_length;
1178
1179         /* << INDEX */
1180         /* End of packet header position. Currently only represents the distance to start of packet
1181            Will be updated later by incrementing with packet start value */
1182         if (p_pack_info) {
1183             p_pack_info->end_ph_pos = (OPJ_INT32)(l_current_data - p_src_data);
1184         }
1185         /* INDEX >> */
1186
1187         * p_is_data_present = OPJ_FALSE;
1188         *p_data_read = (OPJ_UINT32)(l_current_data - p_src_data);
1189         return OPJ_TRUE;
1190     }
1191
1192     l_band = l_res->bands;
1193     for (bandno = 0; bandno < l_res->numbands; ++bandno, ++l_band) {
1194         opj_tcd_precinct_t *l_prc = &(l_band->precincts[p_pi->precno]);
1195
1196         if (opj_tcd_is_band_empty(l_band)) {
1197             continue;
1198         }
1199
1200         l_nb_code_blocks = l_prc->cw * l_prc->ch;
1201         l_cblk = l_prc->cblks.dec;
1202         for (cblkno = 0; cblkno < l_nb_code_blocks; cblkno++) {
1203             OPJ_UINT32 l_included, l_increment, l_segno;
1204             OPJ_INT32 n;
1205
1206             /* if cblk not yet included before --> inclusion tagtree */
1207             if (!l_cblk->numsegs) {
1208                 l_included = opj_tgt_decode(l_bio, l_prc->incltree, cblkno,
1209                                             (OPJ_INT32)(p_pi->layno + 1));
1210                 /* else one bit */
1211             } else {
1212                 l_included = opj_bio_read(l_bio, 1);
1213             }
1214
1215             /* if cblk not included */
1216             if (!l_included) {
1217                 l_cblk->numnewpasses = 0;
1218                 ++l_cblk;
1219                 JAS_FPRINTF(stderr, "included=%d \n", l_included);
1220                 continue;
1221             }
1222
1223             /* if cblk not yet included --> zero-bitplane tagtree */
1224             if (!l_cblk->numsegs) {
1225                 OPJ_UINT32 i = 0;
1226
1227                 while (!opj_tgt_decode(l_bio, l_prc->imsbtree, cblkno, (OPJ_INT32)i)) {
1228                     ++i;
1229                 }
1230
1231                 l_cblk->Mb = (OPJ_UINT32)l_band->numbps;
1232                 l_cblk->numbps = (OPJ_UINT32)l_band->numbps + 1 - i;
1233                 l_cblk->numlenbits = 3;
1234             }
1235
1236             /* number of coding passes */
1237             l_cblk->numnewpasses = opj_t2_getnumpasses(l_bio);
1238             l_increment = opj_t2_getcommacode(l_bio);
1239
1240             /* length indicator increment */
1241             l_cblk->numlenbits += l_increment;
1242             l_segno = 0;
1243
1244             if (!l_cblk->numsegs) {
1245                 if (! opj_t2_init_seg(l_cblk, l_segno, p_tcp->tccps[p_pi->compno].cblksty, 1)) {
1246                     opj_bio_destroy(l_bio);
1247                     return OPJ_FALSE;
1248                 }
1249             } else {
1250                 l_segno = l_cblk->numsegs - 1;
1251                 if (l_cblk->segs[l_segno].numpasses == l_cblk->segs[l_segno].maxpasses) {
1252                     ++l_segno;
1253                     if (! opj_t2_init_seg(l_cblk, l_segno, p_tcp->tccps[p_pi->compno].cblksty, 0)) {
1254                         opj_bio_destroy(l_bio);
1255                         return OPJ_FALSE;
1256                     }
1257                 }
1258             }
1259             n = (OPJ_INT32)l_cblk->numnewpasses;
1260
1261             if ((p_tcp->tccps[p_pi->compno].cblksty & J2K_CCP_CBLKSTY_HT) != 0)
1262                 do {
1263                     OPJ_UINT32 bit_number;
1264                     l_cblk->segs[l_segno].numnewpasses = l_segno == 0 ? 1 : (OPJ_UINT32)n;
1265                     bit_number = l_cblk->numlenbits + opj_uint_floorlog2(
1266                                      l_cblk->segs[l_segno].numnewpasses);
1267                     if (bit_number > 32) {
1268                         opj_event_msg(p_manager, EVT_ERROR,
1269                                       "Invalid bit number %d in opj_t2_read_packet_header()\n",
1270                                       bit_number);
1271                         opj_bio_destroy(l_bio);
1272                         return OPJ_FALSE;
1273                     }
1274                     l_cblk->segs[l_segno].newlen = opj_bio_read(l_bio, bit_number);
1275                     JAS_FPRINTF(stderr, "included=%d numnewpasses=%d increment=%d len=%d \n",
1276                                 l_included, l_cblk->segs[l_segno].numnewpasses, l_increment,
1277                                 l_cblk->segs[l_segno].newlen);
1278
1279                     n -= (OPJ_INT32)l_cblk->segs[l_segno].numnewpasses;
1280                     if (n > 0) {
1281                         ++l_segno;
1282
1283                         if (! opj_t2_init_seg(l_cblk, l_segno, p_tcp->tccps[p_pi->compno].cblksty, 0)) {
1284                             opj_bio_destroy(l_bio);
1285                             return OPJ_FALSE;
1286                         }
1287                     }
1288                 } while (n > 0);
1289             else
1290                 do {
1291                     OPJ_UINT32 bit_number;
1292                     l_cblk->segs[l_segno].numnewpasses = (OPJ_UINT32)opj_int_min((OPJ_INT32)(
1293                             l_cblk->segs[l_segno].maxpasses - l_cblk->segs[l_segno].numpasses), n);
1294                     bit_number = l_cblk->numlenbits + opj_uint_floorlog2(
1295                                      l_cblk->segs[l_segno].numnewpasses);
1296                     if (bit_number > 32) {
1297                         opj_event_msg(p_manager, EVT_ERROR,
1298                                       "Invalid bit number %d in opj_t2_read_packet_header()\n",
1299                                       bit_number);
1300                         opj_bio_destroy(l_bio);
1301                         return OPJ_FALSE;
1302                     }
1303                     l_cblk->segs[l_segno].newlen = opj_bio_read(l_bio, bit_number);
1304                     JAS_FPRINTF(stderr, "included=%d numnewpasses=%d increment=%d len=%d \n",
1305                                 l_included, l_cblk->segs[l_segno].numnewpasses, l_increment,
1306                                 l_cblk->segs[l_segno].newlen);
1307
1308                     n -= (OPJ_INT32)l_cblk->segs[l_segno].numnewpasses;
1309                     if (n > 0) {
1310                         ++l_segno;
1311
1312                         if (! opj_t2_init_seg(l_cblk, l_segno, p_tcp->tccps[p_pi->compno].cblksty, 0)) {
1313                             opj_bio_destroy(l_bio);
1314                             return OPJ_FALSE;
1315                         }
1316                     }
1317                 } while (n > 0);
1318
1319             ++l_cblk;
1320         }
1321     }
1322
1323     if (!opj_bio_inalign(l_bio)) {
1324         opj_bio_destroy(l_bio);
1325         return OPJ_FALSE;
1326     }
1327
1328     l_header_data += opj_bio_numbytes(l_bio);
1329     opj_bio_destroy(l_bio);
1330
1331     /* EPH markers */
1332     if (p_tcp->csty & J2K_CP_CSTY_EPH) {
1333         if ((*l_modified_length_ptr - (OPJ_UINT32)(l_header_data -
1334                 *l_header_data_start)) < 2U) {
1335             opj_event_msg(p_manager, EVT_WARNING,
1336                           "Not enough space for expected EPH marker\n");
1337         } else if ((*l_header_data) != 0xff || (*(l_header_data + 1) != 0x92)) {
1338             opj_event_msg(p_manager, EVT_WARNING, "Expected EPH marker\n");
1339         } else {
1340             l_header_data += 2;
1341         }
1342     }
1343
1344     l_header_length = (OPJ_UINT32)(l_header_data - *l_header_data_start);
1345     JAS_FPRINTF(stderr, "hdrlen=%d \n", l_header_length);
1346     JAS_FPRINTF(stderr, "packet body\n");
1347     *l_modified_length_ptr -= l_header_length;
1348     *l_header_data_start += l_header_length;
1349
1350     /* << INDEX */
1351     /* End of packet header position. Currently only represents the distance to start of packet
1352      Will be updated later by incrementing with packet start value */
1353     if (p_pack_info) {
1354         p_pack_info->end_ph_pos = (OPJ_INT32)(l_current_data - p_src_data);
1355     }
1356     /* INDEX >> */
1357
1358     *p_is_data_present = OPJ_TRUE;
1359     *p_data_read = (OPJ_UINT32)(l_current_data - p_src_data);
1360
1361     return OPJ_TRUE;
1362 }
1363
1364 static OPJ_BOOL opj_t2_read_packet_data(opj_t2_t* p_t2,
1365                                         opj_tcd_tile_t *p_tile,
1366                                         opj_pi_iterator_t *p_pi,
1367                                         OPJ_BYTE *p_src_data,
1368                                         OPJ_UINT32 * p_data_read,
1369                                         OPJ_UINT32 p_max_length,
1370                                         opj_packet_info_t *pack_info,
1371                                         opj_event_mgr_t* p_manager)
1372 {
1373     OPJ_UINT32 bandno, cblkno;
1374     OPJ_UINT32 l_nb_code_blocks;
1375     OPJ_BYTE *l_current_data = p_src_data;
1376     opj_tcd_band_t *l_band = 00;
1377     opj_tcd_cblk_dec_t* l_cblk = 00;
1378     opj_tcd_resolution_t* l_res =
1379         &p_tile->comps[p_pi->compno].resolutions[p_pi->resno];
1380     OPJ_BOOL partial_buffer = OPJ_FALSE;
1381
1382     OPJ_ARG_NOT_USED(p_t2);
1383     OPJ_ARG_NOT_USED(pack_info);
1384
1385     l_band = l_res->bands;
1386     for (bandno = 0; bandno < l_res->numbands; ++bandno) {
1387         opj_tcd_precinct_t *l_prc = &l_band->precincts[p_pi->precno];
1388
1389         if ((l_band->x1 - l_band->x0 == 0) || (l_band->y1 - l_band->y0 == 0)) {
1390             ++l_band;
1391             continue;
1392         }
1393
1394         l_nb_code_blocks = l_prc->cw * l_prc->ch;
1395         l_cblk = l_prc->cblks.dec;
1396
1397         for (cblkno = 0; cblkno < l_nb_code_blocks; ++cblkno) {
1398             opj_tcd_seg_t *l_seg = 00;
1399
1400             // if we have a partial data stream, set numchunks to zero
1401             // since we have no data to actually decode.
1402             if (partial_buffer) {
1403                 l_cblk->numchunks = 0;
1404             }
1405
1406             if (!l_cblk->numnewpasses) {
1407                 /* nothing to do */
1408                 ++l_cblk;
1409                 continue;
1410             }
1411
1412             if (!l_cblk->numsegs) {
1413                 l_seg = l_cblk->segs;
1414                 ++l_cblk->numsegs;
1415             } else {
1416                 l_seg = &l_cblk->segs[l_cblk->numsegs - 1];
1417
1418                 if (l_seg->numpasses == l_seg->maxpasses) {
1419                     ++l_seg;
1420                     ++l_cblk->numsegs;
1421                 }
1422             }
1423
1424             do {
1425                 /* Check possible overflow (on l_current_data only, assumes input args already checked) then size */
1426                 if ((((OPJ_SIZE_T)l_current_data + (OPJ_SIZE_T)l_seg->newlen) <
1427                         (OPJ_SIZE_T)l_current_data) ||
1428                         (l_current_data + l_seg->newlen > p_src_data + p_max_length) ||
1429                         (partial_buffer)) {
1430                     if (p_t2->cp->strict) {
1431                         opj_event_msg(p_manager, EVT_ERROR,
1432                                       "read: segment too long (%d) with max (%d) for codeblock %d (p=%d, b=%d, r=%d, c=%d)\n",
1433                                       l_seg->newlen, p_max_length, cblkno, p_pi->precno, bandno, p_pi->resno,
1434                                       p_pi->compno);
1435                         return OPJ_FALSE;
1436                     } else {
1437                         opj_event_msg(p_manager, EVT_WARNING,
1438                                       "read: segment too long (%d) with max (%d) for codeblock %d (p=%d, b=%d, r=%d, c=%d)\n",
1439                                       l_seg->newlen, p_max_length, cblkno, p_pi->precno, bandno, p_pi->resno,
1440                                       p_pi->compno);
1441                         // skip this codeblock since it is a partial read
1442                         partial_buffer = OPJ_TRUE;
1443                         l_cblk->numchunks = 0;
1444
1445                         l_seg->numpasses += l_seg->numnewpasses;
1446                         l_cblk->numnewpasses -= l_seg->numnewpasses;
1447                         if (l_cblk->numnewpasses > 0) {
1448                             ++l_seg;
1449                             ++l_cblk->numsegs;
1450                             break;
1451                         }
1452                         continue;
1453                     }
1454                 }
1455
1456 #ifdef USE_JPWL
1457                 /* we need here a j2k handle to verify if making a check to
1458                 the validity of cblocks parameters is selected from user (-W) */
1459
1460                 /* let's check that we are not exceeding */
1461                 if ((l_cblk->len + l_seg->newlen) > 8192) {
1462                     opj_event_msg(p_manager, EVT_WARNING,
1463                                   "JPWL: segment too long (%d) for codeblock %d (p=%d, b=%d, r=%d, c=%d)\n",
1464                                   l_seg->newlen, cblkno, p_pi->precno, bandno, p_pi->resno, p_pi->compno);
1465                     if (!JPWL_ASSUME) {
1466                         opj_event_msg(p_manager, EVT_ERROR, "JPWL: giving up\n");
1467                         return OPJ_FALSE;
1468                     }
1469                     l_seg->newlen = 8192 - l_cblk->len;
1470                     opj_event_msg(p_manager, EVT_WARNING, "      - truncating segment to %d\n",
1471                                   l_seg->newlen);
1472                     break;
1473                 };
1474
1475 #endif /* USE_JPWL */
1476
1477                 if (l_cblk->numchunks == l_cblk->numchunksalloc) {
1478                     OPJ_UINT32 l_numchunksalloc = l_cblk->numchunksalloc * 2 + 1;
1479                     opj_tcd_seg_data_chunk_t* l_chunks =
1480                         (opj_tcd_seg_data_chunk_t*)opj_realloc(l_cblk->chunks,
1481                                 l_numchunksalloc * sizeof(opj_tcd_seg_data_chunk_t));
1482                     if (l_chunks == NULL) {
1483                         opj_event_msg(p_manager, EVT_ERROR,
1484                                       "cannot allocate opj_tcd_seg_data_chunk_t* array");
1485                         return OPJ_FALSE;
1486                     }
1487                     l_cblk->chunks = l_chunks;
1488                     l_cblk->numchunksalloc = l_numchunksalloc;
1489                 }
1490
1491                 l_cblk->chunks[l_cblk->numchunks].data = l_current_data;
1492                 l_cblk->chunks[l_cblk->numchunks].len = l_seg->newlen;
1493                 l_cblk->numchunks ++;
1494
1495                 l_current_data += l_seg->newlen;
1496                 l_seg->len += l_seg->newlen;
1497                 l_seg->numpasses += l_seg->numnewpasses;
1498                 l_cblk->numnewpasses -= l_seg->numnewpasses;
1499
1500                 l_seg->real_num_passes = l_seg->numpasses;
1501
1502                 if (l_cblk->numnewpasses > 0) {
1503                     ++l_seg;
1504                     ++l_cblk->numsegs;
1505                 }
1506             } while (l_cblk->numnewpasses > 0);
1507
1508             l_cblk->real_num_segs = l_cblk->numsegs;
1509             ++l_cblk;
1510         } /* next code_block */
1511
1512         ++l_band;
1513     }
1514
1515     // return the number of bytes read
1516     if (partial_buffer) {
1517         *(p_data_read) = p_max_length;
1518     } else {
1519         *(p_data_read) = (OPJ_UINT32)(l_current_data - p_src_data);
1520     }
1521
1522     return OPJ_TRUE;
1523 }
1524
1525 static OPJ_BOOL opj_t2_skip_packet_data(opj_t2_t* p_t2,
1526                                         opj_tcd_tile_t *p_tile,
1527                                         opj_pi_iterator_t *p_pi,
1528                                         OPJ_UINT32 * p_data_read,
1529                                         OPJ_UINT32 p_max_length,
1530                                         opj_packet_info_t *pack_info,
1531                                         opj_event_mgr_t *p_manager)
1532 {
1533     OPJ_UINT32 bandno, cblkno;
1534     OPJ_UINT32 l_nb_code_blocks;
1535     opj_tcd_band_t *l_band = 00;
1536     opj_tcd_cblk_dec_t* l_cblk = 00;
1537     opj_tcd_resolution_t* l_res =
1538         &p_tile->comps[p_pi->compno].resolutions[p_pi->resno];
1539
1540     OPJ_ARG_NOT_USED(p_t2);
1541     OPJ_ARG_NOT_USED(pack_info);
1542
1543     *p_data_read = 0;
1544     l_band = l_res->bands;
1545
1546     for (bandno = 0; bandno < l_res->numbands; ++bandno) {
1547         opj_tcd_precinct_t *l_prc = &l_band->precincts[p_pi->precno];
1548
1549         if ((l_band->x1 - l_band->x0 == 0) || (l_band->y1 - l_band->y0 == 0)) {
1550             ++l_band;
1551             continue;
1552         }
1553
1554         l_nb_code_blocks = l_prc->cw * l_prc->ch;
1555         l_cblk = l_prc->cblks.dec;
1556
1557         for (cblkno = 0; cblkno < l_nb_code_blocks; ++cblkno) {
1558             opj_tcd_seg_t *l_seg = 00;
1559
1560             if (!l_cblk->numnewpasses) {
1561                 /* nothing to do */
1562                 ++l_cblk;
1563                 continue;
1564             }
1565
1566             if (!l_cblk->numsegs) {
1567                 l_seg = l_cblk->segs;
1568                 ++l_cblk->numsegs;
1569             } else {
1570                 l_seg = &l_cblk->segs[l_cblk->numsegs - 1];
1571
1572                 if (l_seg->numpasses == l_seg->maxpasses) {
1573                     ++l_seg;
1574                     ++l_cblk->numsegs;
1575                 }
1576             }
1577
1578             do {
1579                 /* Check possible overflow then size */
1580                 if (((*p_data_read + l_seg->newlen) < (*p_data_read)) ||
1581                         ((*p_data_read + l_seg->newlen) > p_max_length)) {
1582                     if (p_t2->cp->strict) {
1583                         opj_event_msg(p_manager, EVT_ERROR,
1584                                       "skip: segment too long (%d) with max (%d) for codeblock %d (p=%d, b=%d, r=%d, c=%d)\n",
1585                                       l_seg->newlen, p_max_length, cblkno, p_pi->precno, bandno, p_pi->resno,
1586                                       p_pi->compno);
1587                         return OPJ_FALSE;
1588                     } else {
1589                         opj_event_msg(p_manager, EVT_WARNING,
1590                                       "skip: segment too long (%d) with max (%d) for codeblock %d (p=%d, b=%d, r=%d, c=%d)\n",
1591                                       l_seg->newlen, p_max_length, cblkno, p_pi->precno, bandno, p_pi->resno,
1592                                       p_pi->compno);
1593                     }
1594                 }
1595
1596 #ifdef USE_JPWL
1597                 /* we need here a j2k handle to verify if making a check to
1598                 the validity of cblocks parameters is selected from user (-W) */
1599
1600                 /* let's check that we are not exceeding */
1601                 if ((l_cblk->len + l_seg->newlen) > 8192) {
1602                     opj_event_msg(p_manager, EVT_WARNING,
1603                                   "JPWL: segment too long (%d) for codeblock %d (p=%d, b=%d, r=%d, c=%d)\n",
1604                                   l_seg->newlen, cblkno, p_pi->precno, bandno, p_pi->resno, p_pi->compno);
1605                     if (!JPWL_ASSUME) {
1606                         opj_event_msg(p_manager, EVT_ERROR, "JPWL: giving up\n");
1607                         return -999;
1608                     }
1609                     l_seg->newlen = 8192 - l_cblk->len;
1610                     opj_event_msg(p_manager, EVT_WARNING, "      - truncating segment to %d\n",
1611                                   l_seg->newlen);
1612                     break;
1613                 };
1614
1615 #endif /* USE_JPWL */
1616                 JAS_FPRINTF(stderr, "p_data_read (%d) newlen (%d) \n", *p_data_read,
1617                             l_seg->newlen);
1618                 *(p_data_read) += l_seg->newlen;
1619
1620                 l_seg->numpasses += l_seg->numnewpasses;
1621                 l_cblk->numnewpasses -= l_seg->numnewpasses;
1622                 if (l_cblk->numnewpasses > 0) {
1623                     ++l_seg;
1624                     ++l_cblk->numsegs;
1625                 }
1626             } while (l_cblk->numnewpasses > 0);
1627
1628             ++l_cblk;
1629         }
1630
1631         ++l_band;
1632     }
1633
1634     return OPJ_TRUE;
1635 }
1636
1637
1638 static OPJ_BOOL opj_t2_init_seg(opj_tcd_cblk_dec_t* cblk,
1639                                 OPJ_UINT32 index,
1640                                 OPJ_UINT32 cblksty,
1641                                 OPJ_UINT32 first)
1642 {
1643     opj_tcd_seg_t* seg = 00;
1644     OPJ_UINT32 l_nb_segs = index + 1;
1645
1646     if (l_nb_segs > cblk->m_current_max_segs) {
1647         opj_tcd_seg_t* new_segs;
1648         OPJ_UINT32 l_m_current_max_segs = cblk->m_current_max_segs +
1649                                           OPJ_J2K_DEFAULT_NB_SEGS;
1650
1651         new_segs = (opj_tcd_seg_t*) opj_realloc(cblk->segs,
1652                                                 l_m_current_max_segs * sizeof(opj_tcd_seg_t));
1653         if (! new_segs) {
1654             /* opj_event_msg(p_manager, EVT_ERROR, "Not enough memory to initialize segment %d\n", l_nb_segs); */
1655             return OPJ_FALSE;
1656         }
1657         cblk->segs = new_segs;
1658         memset(new_segs + cblk->m_current_max_segs,
1659                0, OPJ_J2K_DEFAULT_NB_SEGS * sizeof(opj_tcd_seg_t));
1660         cblk->m_current_max_segs = l_m_current_max_segs;
1661     }
1662
1663     seg = &cblk->segs[index];
1664     opj_tcd_reinit_segment(seg);
1665
1666     if (cblksty & J2K_CCP_CBLKSTY_TERMALL) {
1667         seg->maxpasses = 1;
1668     } else if (cblksty & J2K_CCP_CBLKSTY_LAZY) {
1669         if (first) {
1670             seg->maxpasses = 10;
1671         } else {
1672             seg->maxpasses = (((seg - 1)->maxpasses == 1) ||
1673                               ((seg - 1)->maxpasses == 10)) ? 2 : 1;
1674         }
1675     } else {
1676         /* See paragraph "B.10.6 Number of coding passes" of the standard.
1677          * Probably that 109 must be interpreted a (Mb-1)*3 + 1 with Mb=37,
1678          * Mb being the maximum number of bit-planes available for the
1679          * representation of coefficients in the sub-band */
1680         seg->maxpasses = 109;
1681     }
1682
1683     return OPJ_TRUE;
1684 }