struct opj_j2k: remove unused fields, and add some documentation
[openjpeg.git] / src / lib / openjp2 / jp2.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) 2010-2011, Kaori Hagihara
15  * Copyright (c) 2008, 2011-2012, Centre National d'Etudes Spatiales (CNES), FR
16  * Copyright (c) 2012, CS Systemes d'Information, France
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 #include "opj_includes.h"
41
42 /** @defgroup JP2 JP2 - JPEG-2000 file format reader/writer */
43 /*@{*/
44
45 #define OPJ_BOX_SIZE    1024
46
47 #define OPJ_UNUSED(x) (void)x
48
49 /** @name Local static functions */
50 /*@{*/
51
52 /*static void jp2_write_url(opj_cio_t *cio, char *Idx_file);*/
53
54 /**
55  * Reads a IHDR box - Image Header box
56  *
57  * @param   p_image_header_data         pointer to actual data (already read from file)
58  * @param   jp2                         the jpeg2000 file codec.
59  * @param   p_image_header_size         the size of the image header
60  * @param   p_manager                   the user event manager.
61  *
62  * @return  true if the image header is valid, false else.
63  */
64 static OPJ_BOOL opj_jp2_read_ihdr(opj_jp2_t *jp2,
65                                   OPJ_BYTE *p_image_header_data,
66                                   OPJ_UINT32 p_image_header_size,
67                                   opj_event_mgr_t * p_manager);
68
69 /**
70  * Writes the Image Header box - Image Header box.
71  *
72  * @param jp2                   jpeg2000 file codec.
73  * @param p_nb_bytes_written    pointer to store the nb of bytes written by the function.
74  *
75  * @return  the data being copied.
76 */
77 static OPJ_BYTE * opj_jp2_write_ihdr(opj_jp2_t *jp2,
78                                      OPJ_UINT32 * p_nb_bytes_written);
79
80 /**
81  * Writes the Bit per Component box.
82  *
83  * @param   jp2                     jpeg2000 file codec.
84  * @param   p_nb_bytes_written      pointer to store the nb of bytes written by the function.
85  *
86  * @return  the data being copied.
87 */
88 static OPJ_BYTE * opj_jp2_write_bpcc(opj_jp2_t *jp2,
89                                      OPJ_UINT32 * p_nb_bytes_written);
90
91 /**
92  * Reads a Bit per Component box.
93  *
94  * @param   p_bpc_header_data           pointer to actual data (already read from file)
95  * @param   jp2                         the jpeg2000 file codec.
96  * @param   p_bpc_header_size           the size of the bpc header
97  * @param   p_manager                   the user event manager.
98  *
99  * @return  true if the bpc header is valid, false else.
100  */
101 static OPJ_BOOL opj_jp2_read_bpcc(opj_jp2_t *jp2,
102                                   OPJ_BYTE * p_bpc_header_data,
103                                   OPJ_UINT32 p_bpc_header_size,
104                                   opj_event_mgr_t * p_manager);
105
106 static OPJ_BOOL opj_jp2_read_cdef(opj_jp2_t * jp2,
107                                   OPJ_BYTE * p_cdef_header_data,
108                                   OPJ_UINT32 p_cdef_header_size,
109                                   opj_event_mgr_t * p_manager);
110
111 static void opj_jp2_apply_cdef(opj_image_t *image, opj_jp2_color_t *color,
112                                opj_event_mgr_t *);
113
114 /**
115  * Writes the Channel Definition box.
116  *
117  * @param jp2                   jpeg2000 file codec.
118  * @param p_nb_bytes_written    pointer to store the nb of bytes written by the function.
119  *
120  * @return  the data being copied.
121  */
122 static OPJ_BYTE * opj_jp2_write_cdef(opj_jp2_t *jp2,
123                                      OPJ_UINT32 * p_nb_bytes_written);
124
125 /**
126  * Writes the Colour Specification box.
127  *
128  * @param jp2                   jpeg2000 file codec.
129  * @param p_nb_bytes_written    pointer to store the nb of bytes written by the function.
130  *
131  * @return  the data being copied.
132 */
133 static OPJ_BYTE * opj_jp2_write_colr(opj_jp2_t *jp2,
134                                      OPJ_UINT32 * p_nb_bytes_written);
135
136 /**
137  * Writes a FTYP box - File type box
138  *
139  * @param   cio         the stream to write data to.
140  * @param   jp2         the jpeg2000 file codec.
141  * @param   p_manager   the user event manager.
142  *
143  * @return  true if writing was successful.
144  */
145 static OPJ_BOOL opj_jp2_write_ftyp(opj_jp2_t *jp2,
146                                    opj_stream_private_t *cio,
147                                    opj_event_mgr_t * p_manager);
148
149 /**
150  * Reads a a FTYP box - File type box
151  *
152  * @param   p_header_data   the data contained in the FTYP box.
153  * @param   jp2             the jpeg2000 file codec.
154  * @param   p_header_size   the size of the data contained in the FTYP box.
155  * @param   p_manager       the user event manager.
156  *
157  * @return true if the FTYP box is valid.
158  */
159 static OPJ_BOOL opj_jp2_read_ftyp(opj_jp2_t *jp2,
160                                   OPJ_BYTE * p_header_data,
161                                   OPJ_UINT32 p_header_size,
162                                   opj_event_mgr_t * p_manager);
163
164 static OPJ_BOOL opj_jp2_skip_jp2c(opj_jp2_t *jp2,
165                                   opj_stream_private_t *stream,
166                                   opj_event_mgr_t * p_manager);
167
168 /**
169  * Reads the Jpeg2000 file Header box - JP2 Header box (warning, this is a super box).
170  *
171  * @param   p_header_data   the data contained in the file header box.
172  * @param   jp2             the jpeg2000 file codec.
173  * @param   p_header_size   the size of the data contained in the file header box.
174  * @param   p_manager       the user event manager.
175  *
176  * @return true if the JP2 Header box was successfully recognized.
177 */
178 static OPJ_BOOL opj_jp2_read_jp2h(opj_jp2_t *jp2,
179                                   OPJ_BYTE *p_header_data,
180                                   OPJ_UINT32 p_header_size,
181                                   opj_event_mgr_t * p_manager);
182
183 /**
184  * Writes the Jpeg2000 file Header box - JP2 Header box (warning, this is a super box).
185  *
186  * @param  jp2      the jpeg2000 file codec.
187  * @param  stream      the stream to write data to.
188  * @param  p_manager  user event manager.
189  *
190  * @return true if writing was successful.
191  */
192 static OPJ_BOOL opj_jp2_write_jp2h(opj_jp2_t *jp2,
193                                    opj_stream_private_t *stream,
194                                    opj_event_mgr_t * p_manager);
195
196 /**
197  * Writes the Jpeg2000 codestream Header box - JP2C Header box. This function must be called AFTER the coding has been done.
198  *
199  * @param   cio         the stream to write data to.
200  * @param   jp2         the jpeg2000 file codec.
201  * @param   p_manager   user event manager.
202  *
203  * @return true if writing was successful.
204 */
205 static OPJ_BOOL opj_jp2_write_jp2c(opj_jp2_t *jp2,
206                                    opj_stream_private_t *cio,
207                                    opj_event_mgr_t * p_manager);
208
209 #ifdef USE_JPIP
210 /**
211  * Write index Finder box
212  * @param cio     the stream to write to.
213  * @param   jp2         the jpeg2000 file codec.
214  * @param   p_manager   user event manager.
215 */
216 static OPJ_BOOL opj_jpip_write_iptr(opj_jp2_t *jp2,
217                                     opj_stream_private_t *cio,
218                                     opj_event_mgr_t * p_manager);
219
220 /**
221  * Write index Finder box
222  * @param cio     the stream to write to.
223  * @param   jp2         the jpeg2000 file codec.
224  * @param   p_manager   user event manager.
225  */
226 static OPJ_BOOL opj_jpip_write_cidx(opj_jp2_t *jp2,
227                                     opj_stream_private_t *cio,
228                                     opj_event_mgr_t * p_manager);
229
230 /**
231  * Write file Index (superbox)
232  * @param cio     the stream to write to.
233  * @param   jp2         the jpeg2000 file codec.
234  * @param   p_manager   user event manager.
235  */
236 static OPJ_BOOL opj_jpip_write_fidx(opj_jp2_t *jp2,
237                                     opj_stream_private_t *cio,
238                                     opj_event_mgr_t * p_manager);
239 #endif /* USE_JPIP */
240
241 /**
242  * Reads a jpeg2000 file signature box.
243  *
244  * @param   p_header_data   the data contained in the signature box.
245  * @param   jp2             the jpeg2000 file codec.
246  * @param   p_header_size   the size of the data contained in the signature box.
247  * @param   p_manager       the user event manager.
248  *
249  * @return true if the file signature box is valid.
250  */
251 static OPJ_BOOL opj_jp2_read_jp(opj_jp2_t *jp2,
252                                 OPJ_BYTE * p_header_data,
253                                 OPJ_UINT32 p_header_size,
254                                 opj_event_mgr_t * p_manager);
255
256 /**
257  * Writes a jpeg2000 file signature box.
258  *
259  * @param cio the stream to write data to.
260  * @param   jp2         the jpeg2000 file codec.
261  * @param p_manager the user event manager.
262  *
263  * @return true if writing was successful.
264  */
265 static OPJ_BOOL opj_jp2_write_jp(opj_jp2_t *jp2,
266                                  opj_stream_private_t *cio,
267                                  opj_event_mgr_t * p_manager);
268
269 /**
270 Apply collected palette data
271 @param image Image.
272 @param color Collector for profile, cdef and pclr data.
273 @param p_manager the user event manager.
274 @return true in case of success
275 */
276 static OPJ_BOOL opj_jp2_apply_pclr(opj_image_t *image,
277                                    opj_jp2_color_t *color,
278                                    opj_event_mgr_t * p_manager);
279
280 static void opj_jp2_free_pclr(opj_jp2_color_t *color);
281
282 /**
283  * Collect palette data
284  *
285  * @param jp2 JP2 handle
286  * @param p_pclr_header_data    FIXME DOC
287  * @param p_pclr_header_size    FIXME DOC
288  * @param p_manager
289  *
290  * @return Returns true if successful, returns false otherwise
291 */
292 static OPJ_BOOL opj_jp2_read_pclr(opj_jp2_t *jp2,
293                                   OPJ_BYTE * p_pclr_header_data,
294                                   OPJ_UINT32 p_pclr_header_size,
295                                   opj_event_mgr_t * p_manager);
296
297 /**
298  * Collect component mapping data
299  *
300  * @param jp2                 JP2 handle
301  * @param p_cmap_header_data  FIXME DOC
302  * @param p_cmap_header_size  FIXME DOC
303  * @param p_manager           FIXME DOC
304  *
305  * @return Returns true if successful, returns false otherwise
306 */
307
308 static OPJ_BOOL opj_jp2_read_cmap(opj_jp2_t * jp2,
309                                   OPJ_BYTE * p_cmap_header_data,
310                                   OPJ_UINT32 p_cmap_header_size,
311                                   opj_event_mgr_t * p_manager);
312
313 /**
314  * Reads the Color Specification box.
315  *
316  * @param   p_colr_header_data          pointer to actual data (already read from file)
317  * @param   jp2                         the jpeg2000 file codec.
318  * @param   p_colr_header_size          the size of the color header
319  * @param   p_manager                   the user event manager.
320  *
321  * @return  true if the bpc header is valid, false else.
322 */
323 static OPJ_BOOL opj_jp2_read_colr(opj_jp2_t *jp2,
324                                   OPJ_BYTE * p_colr_header_data,
325                                   OPJ_UINT32 p_colr_header_size,
326                                   opj_event_mgr_t * p_manager);
327
328 /*@}*/
329
330 /*@}*/
331
332 /**
333  * Sets up the procedures to do on writing header after the codestream.
334  * Developpers wanting to extend the library can add their own writing procedures.
335  */
336 static OPJ_BOOL opj_jp2_setup_end_header_writing(opj_jp2_t *jp2,
337         opj_event_mgr_t * p_manager);
338
339 /**
340  * Sets up the procedures to do on reading header after the codestream.
341  * Developpers wanting to extend the library can add their own writing procedures.
342  */
343 static OPJ_BOOL opj_jp2_setup_end_header_reading(opj_jp2_t *jp2,
344         opj_event_mgr_t * p_manager);
345
346 /**
347  * Reads a jpeg2000 file header structure.
348  *
349  * @param jp2 the jpeg2000 file header structure.
350  * @param stream the stream to read data from.
351  * @param p_manager the user event manager.
352  *
353  * @return true if the box is valid.
354  */
355 static OPJ_BOOL opj_jp2_read_header_procedure(opj_jp2_t *jp2,
356         opj_stream_private_t *stream,
357         opj_event_mgr_t * p_manager);
358
359 /**
360  * Executes the given procedures on the given codec.
361  *
362  * @param   p_procedure_list    the list of procedures to execute
363  * @param   jp2                 the jpeg2000 file codec to execute the procedures on.
364  * @param   stream                  the stream to execute the procedures on.
365  * @param   p_manager           the user manager.
366  *
367  * @return  true                if all the procedures were successfully executed.
368  */
369 static OPJ_BOOL opj_jp2_exec(opj_jp2_t * jp2,
370                              opj_procedure_list_t * p_procedure_list,
371                              opj_stream_private_t *stream,
372                              opj_event_mgr_t * p_manager);
373
374 /**
375  * Reads a box header. The box is the way data is packed inside a jpeg2000 file structure.
376  *
377  * @param   cio                     the input stream to read data from.
378  * @param   box                     the box structure to fill.
379  * @param   p_number_bytes_read     pointer to an int that will store the number of bytes read from the stream (shoul usually be 2).
380  * @param   p_manager               user event manager.
381  *
382  * @return  true if the box is recognized, false otherwise
383 */
384 static OPJ_BOOL opj_jp2_read_boxhdr(opj_jp2_box_t *box,
385                                     OPJ_UINT32 * p_number_bytes_read,
386                                     opj_stream_private_t *cio,
387                                     opj_event_mgr_t * p_manager);
388
389 /**
390  * Sets up the validation ,i.e. adds the procedures to launch to make sure the codec parameters
391  * are valid. Developpers wanting to extend the library can add their own validation procedures.
392  */
393 static OPJ_BOOL opj_jp2_setup_encoding_validation(opj_jp2_t *jp2,
394         opj_event_mgr_t * p_manager);
395
396 /**
397  * Sets up the procedures to do on writing header. Developpers wanting to extend the library can add their own writing procedures.
398  */
399 static OPJ_BOOL opj_jp2_setup_header_writing(opj_jp2_t *jp2,
400         opj_event_mgr_t * p_manager);
401
402 static OPJ_BOOL opj_jp2_default_validation(opj_jp2_t * jp2,
403         opj_stream_private_t *cio,
404         opj_event_mgr_t * p_manager);
405
406 /**
407  * Finds the image execution function related to the given box id.
408  *
409  * @param   p_id    the id of the handler to fetch.
410  *
411  * @return  the given handler or NULL if it could not be found.
412  */
413 static const opj_jp2_header_handler_t * opj_jp2_img_find_handler(
414     OPJ_UINT32 p_id);
415
416 /**
417  * Finds the execution function related to the given box id.
418  *
419  * @param   p_id    the id of the handler to fetch.
420  *
421  * @return  the given handler or NULL if it could not be found.
422  */
423 static const opj_jp2_header_handler_t * opj_jp2_find_handler(OPJ_UINT32 p_id);
424
425 static const opj_jp2_header_handler_t jp2_header [] = {
426     {JP2_JP, opj_jp2_read_jp},
427     {JP2_FTYP, opj_jp2_read_ftyp},
428     {JP2_JP2H, opj_jp2_read_jp2h}
429 };
430
431 static const opj_jp2_header_handler_t jp2_img_header [] = {
432     {JP2_IHDR, opj_jp2_read_ihdr},
433     {JP2_COLR, opj_jp2_read_colr},
434     {JP2_BPCC, opj_jp2_read_bpcc},
435     {JP2_PCLR, opj_jp2_read_pclr},
436     {JP2_CMAP, opj_jp2_read_cmap},
437     {JP2_CDEF, opj_jp2_read_cdef}
438
439 };
440
441 /**
442  * Reads a box header. The box is the way data is packed inside a jpeg2000 file structure. Data is read from a character string
443  *
444  * @param   box                     the box structure to fill.
445  * @param   p_data                  the character string to read data from.
446  * @param   p_number_bytes_read     pointer to an int that will store the number of bytes read from the stream (shoul usually be 2).
447  * @param   p_box_max_size          the maximum number of bytes in the box.
448  * @param   p_manager         FIXME DOC
449  *
450  * @return  true if the box is recognized, false otherwise
451 */
452 static OPJ_BOOL opj_jp2_read_boxhdr_char(opj_jp2_box_t *box,
453         OPJ_BYTE * p_data,
454         OPJ_UINT32 * p_number_bytes_read,
455         OPJ_UINT32 p_box_max_size,
456         opj_event_mgr_t * p_manager);
457
458 /**
459  * Sets up the validation ,i.e. adds the procedures to launch to make sure the codec parameters
460  * are valid. Developpers wanting to extend the library can add their own validation procedures.
461  */
462 static OPJ_BOOL opj_jp2_setup_decoding_validation(opj_jp2_t *jp2,
463         opj_event_mgr_t * p_manager);
464
465 /**
466  * Sets up the procedures to do on reading header.
467  * Developpers wanting to extend the library can add their own writing procedures.
468  */
469 static OPJ_BOOL opj_jp2_setup_header_reading(opj_jp2_t *jp2,
470         opj_event_mgr_t * p_manager);
471
472 /* ----------------------------------------------------------------------- */
473 static OPJ_BOOL opj_jp2_read_boxhdr(opj_jp2_box_t *box,
474                                     OPJ_UINT32 * p_number_bytes_read,
475                                     opj_stream_private_t *cio,
476                                     opj_event_mgr_t * p_manager)
477 {
478     /* read header from file */
479     OPJ_BYTE l_data_header [8];
480
481     /* preconditions */
482     assert(cio != 00);
483     assert(box != 00);
484     assert(p_number_bytes_read != 00);
485     assert(p_manager != 00);
486
487     *p_number_bytes_read = (OPJ_UINT32)opj_stream_read_data(cio, l_data_header, 8,
488                            p_manager);
489     if (*p_number_bytes_read != 8) {
490         return OPJ_FALSE;
491     }
492
493     /* process read data */
494     opj_read_bytes(l_data_header, &(box->length), 4);
495     opj_read_bytes(l_data_header + 4, &(box->type), 4);
496
497     if (box->length == 0) { /* last box */
498         const OPJ_OFF_T bleft = opj_stream_get_number_byte_left(cio);
499         if (bleft > (OPJ_OFF_T)(0xFFFFFFFFU - 8U)) {
500             opj_event_msg(p_manager, EVT_ERROR,
501                           "Cannot handle box sizes higher than 2^32\n");
502             return OPJ_FALSE;
503         }
504         box->length = (OPJ_UINT32)bleft + 8U;
505         assert((OPJ_OFF_T)box->length == bleft + 8);
506         return OPJ_TRUE;
507     }
508
509     /* do we have a "special very large box ?" */
510     /* read then the XLBox */
511     if (box->length == 1) {
512         OPJ_UINT32 l_xl_part_size;
513
514         OPJ_UINT32 l_nb_bytes_read = (OPJ_UINT32)opj_stream_read_data(cio,
515                                      l_data_header, 8, p_manager);
516         if (l_nb_bytes_read != 8) {
517             if (l_nb_bytes_read > 0) {
518                 *p_number_bytes_read += l_nb_bytes_read;
519             }
520
521             return OPJ_FALSE;
522         }
523
524         *p_number_bytes_read = 16;
525         opj_read_bytes(l_data_header, &l_xl_part_size, 4);
526         if (l_xl_part_size != 0) {
527             opj_event_msg(p_manager, EVT_ERROR,
528                           "Cannot handle box sizes higher than 2^32\n");
529             return OPJ_FALSE;
530         }
531         opj_read_bytes(l_data_header + 4, &(box->length), 4);
532     }
533     return OPJ_TRUE;
534 }
535
536 #if 0
537 static void jp2_write_url(opj_cio_t *cio, char *Idx_file)
538 {
539     OPJ_UINT32 i;
540     opj_jp2_box_t box;
541
542     box.init_pos = cio_tell(cio);
543     cio_skip(cio, 4);
544     cio_write(cio, JP2_URL, 4); /* DBTL */
545     cio_write(cio, 0, 1);       /* VERS */
546     cio_write(cio, 0, 3);       /* FLAG */
547
548     if (Idx_file) {
549         for (i = 0; i < strlen(Idx_file); i++) {
550             cio_write(cio, Idx_file[i], 1);
551         }
552     }
553
554     box.length = cio_tell(cio) - box.init_pos;
555     cio_seek(cio, box.init_pos);
556     cio_write(cio, box.length, 4);  /* L */
557     cio_seek(cio, box.init_pos + box.length);
558 }
559 #endif
560
561 static OPJ_BOOL opj_jp2_read_ihdr(opj_jp2_t *jp2,
562                                   OPJ_BYTE *p_image_header_data,
563                                   OPJ_UINT32 p_image_header_size,
564                                   opj_event_mgr_t * p_manager)
565 {
566     /* preconditions */
567     assert(p_image_header_data != 00);
568     assert(jp2 != 00);
569     assert(p_manager != 00);
570
571     if (jp2->comps != NULL) {
572         opj_event_msg(p_manager, EVT_WARNING,
573                       "Ignoring ihdr box. First ihdr box already read\n");
574         return OPJ_TRUE;
575     }
576
577     if (p_image_header_size != 14) {
578         opj_event_msg(p_manager, EVT_ERROR, "Bad image header box (bad size)\n");
579         return OPJ_FALSE;
580     }
581
582     opj_read_bytes(p_image_header_data, &(jp2->h), 4);          /* HEIGHT */
583     p_image_header_data += 4;
584     opj_read_bytes(p_image_header_data, &(jp2->w), 4);          /* WIDTH */
585     p_image_header_data += 4;
586     opj_read_bytes(p_image_header_data, &(jp2->numcomps), 2);   /* NC */
587     p_image_header_data += 2;
588
589     if ((jp2->numcomps - 1U) >=
590             16384U) { /* unsigned underflow is well defined: 1U <= jp2->numcomps <= 16384U */
591         opj_event_msg(p_manager, EVT_ERROR, "Invalid number of components (ihdr)\n");
592         return OPJ_FALSE;
593     }
594
595     /* allocate memory for components */
596     jp2->comps = (opj_jp2_comps_t*) opj_calloc(jp2->numcomps,
597                  sizeof(opj_jp2_comps_t));
598     if (jp2->comps == 0) {
599         opj_event_msg(p_manager, EVT_ERROR,
600                       "Not enough memory to handle image header (ihdr)\n");
601         return OPJ_FALSE;
602     }
603
604     opj_read_bytes(p_image_header_data, &(jp2->bpc), 1);        /* BPC */
605     ++ p_image_header_data;
606
607     opj_read_bytes(p_image_header_data, &(jp2->C), 1);          /* C */
608     ++ p_image_header_data;
609
610     /* Should be equal to 7 cf. chapter about image header box of the norm */
611     if (jp2->C != 7) {
612         opj_event_msg(p_manager, EVT_INFO,
613                       "JP2 IHDR box: compression type indicate that the file is not a conforming JP2 file (%d) \n",
614                       jp2->C);
615     }
616
617     opj_read_bytes(p_image_header_data, &(jp2->UnkC), 1);       /* UnkC */
618     ++ p_image_header_data;
619     opj_read_bytes(p_image_header_data, &(jp2->IPR), 1);        /* IPR */
620     ++ p_image_header_data;
621
622     jp2->j2k->m_cp.allow_different_bit_depth_sign = (jp2->bpc == 255);
623     jp2->j2k->ihdr_w = jp2->w;
624     jp2->j2k->ihdr_h = jp2->h;
625     jp2->has_ihdr = 1;
626
627     return OPJ_TRUE;
628 }
629
630 static OPJ_BYTE * opj_jp2_write_ihdr(opj_jp2_t *jp2,
631                                      OPJ_UINT32 * p_nb_bytes_written
632                                     )
633 {
634     OPJ_BYTE * l_ihdr_data, * l_current_ihdr_ptr;
635
636     /* preconditions */
637     assert(jp2 != 00);
638     assert(p_nb_bytes_written != 00);
639
640     /* default image header is 22 bytes wide */
641     l_ihdr_data = (OPJ_BYTE *) opj_calloc(1, 22);
642     if (l_ihdr_data == 00) {
643         return 00;
644     }
645
646     l_current_ihdr_ptr = l_ihdr_data;
647
648     opj_write_bytes(l_current_ihdr_ptr, 22, 4);             /* write box size */
649     l_current_ihdr_ptr += 4;
650
651     opj_write_bytes(l_current_ihdr_ptr, JP2_IHDR, 4);       /* IHDR */
652     l_current_ihdr_ptr += 4;
653
654     opj_write_bytes(l_current_ihdr_ptr, jp2->h, 4);     /* HEIGHT */
655     l_current_ihdr_ptr += 4;
656
657     opj_write_bytes(l_current_ihdr_ptr, jp2->w, 4);     /* WIDTH */
658     l_current_ihdr_ptr += 4;
659
660     opj_write_bytes(l_current_ihdr_ptr, jp2->numcomps, 2);      /* NC */
661     l_current_ihdr_ptr += 2;
662
663     opj_write_bytes(l_current_ihdr_ptr, jp2->bpc, 1);       /* BPC */
664     ++l_current_ihdr_ptr;
665
666     opj_write_bytes(l_current_ihdr_ptr, jp2->C, 1);     /* C : Always 7 */
667     ++l_current_ihdr_ptr;
668
669     opj_write_bytes(l_current_ihdr_ptr, jp2->UnkC,
670                     1);      /* UnkC, colorspace unknown */
671     ++l_current_ihdr_ptr;
672
673     opj_write_bytes(l_current_ihdr_ptr, jp2->IPR,
674                     1);       /* IPR, no intellectual property */
675     ++l_current_ihdr_ptr;
676
677     *p_nb_bytes_written = 22;
678
679     return l_ihdr_data;
680 }
681
682 static OPJ_BYTE * opj_jp2_write_bpcc(opj_jp2_t *jp2,
683                                      OPJ_UINT32 * p_nb_bytes_written
684                                     )
685 {
686     OPJ_UINT32 i;
687     /* room for 8 bytes for box and 1 byte for each component */
688     OPJ_UINT32 l_bpcc_size;
689     OPJ_BYTE * l_bpcc_data, * l_current_bpcc_ptr;
690
691     /* preconditions */
692     assert(jp2 != 00);
693     assert(p_nb_bytes_written != 00);
694     l_bpcc_size = 8 + jp2->numcomps;
695
696     l_bpcc_data = (OPJ_BYTE *) opj_calloc(1, l_bpcc_size);
697     if (l_bpcc_data == 00) {
698         return 00;
699     }
700
701     l_current_bpcc_ptr = l_bpcc_data;
702
703     opj_write_bytes(l_current_bpcc_ptr, l_bpcc_size,
704                     4);            /* write box size */
705     l_current_bpcc_ptr += 4;
706
707     opj_write_bytes(l_current_bpcc_ptr, JP2_BPCC, 4);               /* BPCC */
708     l_current_bpcc_ptr += 4;
709
710     for (i = 0; i < jp2->numcomps; ++i)  {
711         opj_write_bytes(l_current_bpcc_ptr, jp2->comps[i].bpcc,
712                         1); /* write each component information */
713         ++l_current_bpcc_ptr;
714     }
715
716     *p_nb_bytes_written = l_bpcc_size;
717
718     return l_bpcc_data;
719 }
720
721 static OPJ_BOOL opj_jp2_read_bpcc(opj_jp2_t *jp2,
722                                   OPJ_BYTE * p_bpc_header_data,
723                                   OPJ_UINT32 p_bpc_header_size,
724                                   opj_event_mgr_t * p_manager
725                                  )
726 {
727     OPJ_UINT32 i;
728
729     /* preconditions */
730     assert(p_bpc_header_data != 00);
731     assert(jp2 != 00);
732     assert(p_manager != 00);
733
734
735     if (jp2->bpc != 255) {
736         opj_event_msg(p_manager, EVT_WARNING,
737                       "A BPCC header box is available although BPC given by the IHDR box (%d) indicate components bit depth is constant\n",
738                       jp2->bpc);
739     }
740
741     /* and length is relevant */
742     if (p_bpc_header_size != jp2->numcomps) {
743         opj_event_msg(p_manager, EVT_ERROR, "Bad BPCC header box (bad size)\n");
744         return OPJ_FALSE;
745     }
746
747     /* read info for each component */
748     for (i = 0; i < jp2->numcomps; ++i) {
749         opj_read_bytes(p_bpc_header_data, &jp2->comps[i].bpcc,
750                        1);  /* read each BPCC component */
751         ++p_bpc_header_data;
752     }
753
754     return OPJ_TRUE;
755 }
756 static OPJ_BYTE * opj_jp2_write_cdef(opj_jp2_t *jp2,
757                                      OPJ_UINT32 * p_nb_bytes_written)
758 {
759     /* room for 8 bytes for box, 2 for n */
760     OPJ_UINT32 l_cdef_size = 10;
761     OPJ_BYTE * l_cdef_data, * l_current_cdef_ptr;
762     OPJ_UINT32 l_value;
763     OPJ_UINT16 i;
764
765     /* preconditions */
766     assert(jp2 != 00);
767     assert(p_nb_bytes_written != 00);
768     assert(jp2->color.jp2_cdef != 00);
769     assert(jp2->color.jp2_cdef->info != 00);
770     assert(jp2->color.jp2_cdef->n > 0U);
771
772     l_cdef_size += 6U * jp2->color.jp2_cdef->n;
773
774     l_cdef_data = (OPJ_BYTE *) opj_malloc(l_cdef_size);
775     if (l_cdef_data == 00) {
776         return 00;
777     }
778
779     l_current_cdef_ptr = l_cdef_data;
780
781     opj_write_bytes(l_current_cdef_ptr, l_cdef_size, 4);        /* write box size */
782     l_current_cdef_ptr += 4;
783
784     opj_write_bytes(l_current_cdef_ptr, JP2_CDEF, 4);               /* BPCC */
785     l_current_cdef_ptr += 4;
786
787     l_value = jp2->color.jp2_cdef->n;
788     opj_write_bytes(l_current_cdef_ptr, l_value, 2);                /* N */
789     l_current_cdef_ptr += 2;
790
791     for (i = 0U; i < jp2->color.jp2_cdef->n; ++i) {
792         l_value = jp2->color.jp2_cdef->info[i].cn;
793         opj_write_bytes(l_current_cdef_ptr, l_value, 2);                /* Cni */
794         l_current_cdef_ptr += 2;
795         l_value = jp2->color.jp2_cdef->info[i].typ;
796         opj_write_bytes(l_current_cdef_ptr, l_value, 2);                /* Typi */
797         l_current_cdef_ptr += 2;
798         l_value = jp2->color.jp2_cdef->info[i].asoc;
799         opj_write_bytes(l_current_cdef_ptr, l_value, 2);                /* Asoci */
800         l_current_cdef_ptr += 2;
801     }
802     *p_nb_bytes_written = l_cdef_size;
803
804     return l_cdef_data;
805 }
806
807 static OPJ_BYTE * opj_jp2_write_colr(opj_jp2_t *jp2,
808                                      OPJ_UINT32 * p_nb_bytes_written
809                                     )
810 {
811     /* room for 8 bytes for box 3 for common data and variable upon profile*/
812     OPJ_UINT32 l_colr_size = 11;
813     OPJ_BYTE * l_colr_data, * l_current_colr_ptr;
814
815     /* preconditions */
816     assert(jp2 != 00);
817     assert(p_nb_bytes_written != 00);
818     assert(jp2->meth == 1 || jp2->meth == 2);
819
820     switch (jp2->meth) {
821     case 1 :
822         l_colr_size += 4; /* EnumCS */
823         break;
824     case 2 :
825         assert(jp2->color.icc_profile_len); /* ICC profile */
826         l_colr_size += jp2->color.icc_profile_len;
827         break;
828     default :
829         return 00;
830     }
831
832     l_colr_data = (OPJ_BYTE *) opj_calloc(1, l_colr_size);
833     if (l_colr_data == 00) {
834         return 00;
835     }
836
837     l_current_colr_ptr = l_colr_data;
838
839     opj_write_bytes(l_current_colr_ptr, l_colr_size,
840                     4);            /* write box size */
841     l_current_colr_ptr += 4;
842
843     opj_write_bytes(l_current_colr_ptr, JP2_COLR, 4);               /* BPCC */
844     l_current_colr_ptr += 4;
845
846     opj_write_bytes(l_current_colr_ptr, jp2->meth, 1);              /* METH */
847     ++l_current_colr_ptr;
848
849     opj_write_bytes(l_current_colr_ptr, jp2->precedence, 1);        /* PRECEDENCE */
850     ++l_current_colr_ptr;
851
852     opj_write_bytes(l_current_colr_ptr, jp2->approx, 1);            /* APPROX */
853     ++l_current_colr_ptr;
854
855     if (jp2->meth ==
856             1) { /* Meth value is restricted to 1 or 2 (Table I.9 of part 1) */
857         opj_write_bytes(l_current_colr_ptr, jp2->enumcs, 4);
858     }       /* EnumCS */
859     else {
860         if (jp2->meth == 2) {                                      /* ICC profile */
861             OPJ_UINT32 i;
862             for (i = 0; i < jp2->color.icc_profile_len; ++i) {
863                 opj_write_bytes(l_current_colr_ptr, jp2->color.icc_profile_buf[i], 1);
864                 ++l_current_colr_ptr;
865             }
866         }
867     }
868
869     *p_nb_bytes_written = l_colr_size;
870
871     return l_colr_data;
872 }
873
874 static void opj_jp2_free_pclr(opj_jp2_color_t *color)
875 {
876     opj_free(color->jp2_pclr->channel_sign);
877     opj_free(color->jp2_pclr->channel_size);
878     opj_free(color->jp2_pclr->entries);
879
880     if (color->jp2_pclr->cmap) {
881         opj_free(color->jp2_pclr->cmap);
882     }
883
884     opj_free(color->jp2_pclr);
885     color->jp2_pclr = NULL;
886 }
887
888 static OPJ_BOOL opj_jp2_check_color(opj_image_t *image, opj_jp2_color_t *color,
889                                     opj_event_mgr_t *p_manager)
890 {
891     OPJ_UINT16 i;
892
893     /* testcase 4149.pdf.SIGSEGV.cf7.3501 */
894     if (color->jp2_cdef) {
895         opj_jp2_cdef_info_t *info = color->jp2_cdef->info;
896         OPJ_UINT16 n = color->jp2_cdef->n;
897         OPJ_UINT32 nr_channels =
898             image->numcomps; /* FIXME image->numcomps == jp2->numcomps before color is applied ??? */
899
900         /* cdef applies to cmap channels if any */
901         if (color->jp2_pclr && color->jp2_pclr->cmap) {
902             nr_channels = (OPJ_UINT32)color->jp2_pclr->nr_channels;
903         }
904
905         for (i = 0; i < n; i++) {
906             if (info[i].cn >= nr_channels) {
907                 opj_event_msg(p_manager, EVT_ERROR, "Invalid component index %d (>= %d).\n",
908                               info[i].cn, nr_channels);
909                 return OPJ_FALSE;
910             }
911             if (info[i].asoc == 65535U) {
912                 continue;
913             }
914
915             if (info[i].asoc > 0 && (OPJ_UINT32)(info[i].asoc - 1) >= nr_channels) {
916                 opj_event_msg(p_manager, EVT_ERROR, "Invalid component index %d (>= %d).\n",
917                               info[i].asoc - 1, nr_channels);
918                 return OPJ_FALSE;
919             }
920         }
921
922         /* issue 397 */
923         /* ISO 15444-1 states that if cdef is present, it shall contain a complete list of channel definitions. */
924         while (nr_channels > 0) {
925             for (i = 0; i < n; ++i) {
926                 if ((OPJ_UINT32)info[i].cn == (nr_channels - 1U)) {
927                     break;
928                 }
929             }
930             if (i == n) {
931                 opj_event_msg(p_manager, EVT_ERROR, "Incomplete channel definitions.\n");
932                 return OPJ_FALSE;
933             }
934             --nr_channels;
935         }
936     }
937
938     /* testcases 451.pdf.SIGSEGV.f4c.3723, 451.pdf.SIGSEGV.5b5.3723 and
939        66ea31acbb0f23a2bbc91f64d69a03f5_signal_sigsegv_13937c0_7030_5725.pdf */
940     if (color->jp2_pclr && color->jp2_pclr->cmap) {
941         OPJ_UINT16 nr_channels = color->jp2_pclr->nr_channels;
942         opj_jp2_cmap_comp_t *cmap = color->jp2_pclr->cmap;
943         OPJ_BOOL *pcol_usage, is_sane = OPJ_TRUE;
944
945         /* verify that all original components match an existing one */
946         for (i = 0; i < nr_channels; i++) {
947             if (cmap[i].cmp >= image->numcomps) {
948                 opj_event_msg(p_manager, EVT_ERROR, "Invalid component index %d (>= %d).\n",
949                               cmap[i].cmp, image->numcomps);
950                 is_sane = OPJ_FALSE;
951             }
952         }
953
954         pcol_usage = (OPJ_BOOL *) opj_calloc(nr_channels, sizeof(OPJ_BOOL));
955         if (!pcol_usage) {
956             opj_event_msg(p_manager, EVT_ERROR, "Unexpected OOM.\n");
957             return OPJ_FALSE;
958         }
959         /* verify that no component is targeted more than once */
960         for (i = 0; i < nr_channels; i++) {
961             OPJ_BYTE mtyp = cmap[i].mtyp;
962             OPJ_BYTE pcol = cmap[i].pcol;
963             /* See ISO 15444-1 Table I.14 â€“ MTYPi field values */
964             if (mtyp != 0 && mtyp != 1) {
965                 opj_event_msg(p_manager, EVT_ERROR,
966                               "Invalid value for cmap[%d].mtyp = %d.\n", i,
967                               mtyp);
968                 is_sane = OPJ_FALSE;
969             } else if (pcol >= nr_channels) {
970                 opj_event_msg(p_manager, EVT_ERROR,
971                               "Invalid component/palette index for direct mapping %d.\n", pcol);
972                 is_sane = OPJ_FALSE;
973             } else if (pcol_usage[pcol] && mtyp == 1) {
974                 opj_event_msg(p_manager, EVT_ERROR, "Component %d is mapped twice.\n", pcol);
975                 is_sane = OPJ_FALSE;
976             } else if (mtyp == 0 && pcol != 0) {
977                 /* I.5.3.5 PCOL: If the value of the MTYP field for this channel is 0, then
978                  * the value of this field shall be 0. */
979                 opj_event_msg(p_manager, EVT_ERROR, "Direct use at #%d however pcol=%d.\n", i,
980                               pcol);
981                 is_sane = OPJ_FALSE;
982             } else if (mtyp == 1 && pcol != i) {
983                 /* OpenJPEG implementation limitation. See assert(i == pcol); */
984                 /* in opj_jp2_apply_pclr() */
985                 opj_event_msg(p_manager, EVT_ERROR,
986                               "Implementation limitation: for palette mapping, "
987                               "pcol[%d] should be equal to %d, but is equal "
988                               "to %d.\n", i, i, pcol);
989                 is_sane = OPJ_FALSE;
990             } else {
991                 pcol_usage[pcol] = OPJ_TRUE;
992             }
993         }
994         /* verify that all components are targeted at least once */
995         for (i = 0; i < nr_channels; i++) {
996             if (!pcol_usage[i] && cmap[i].mtyp != 0) {
997                 opj_event_msg(p_manager, EVT_ERROR, "Component %d doesn't have a mapping.\n",
998                               i);
999                 is_sane = OPJ_FALSE;
1000             }
1001         }
1002         /* Issue 235/447 weird cmap */
1003         if (1 && is_sane && (image->numcomps == 1U)) {
1004             for (i = 0; i < nr_channels; i++) {
1005                 if (!pcol_usage[i]) {
1006                     is_sane = 0U;
1007                     opj_event_msg(p_manager, EVT_WARNING,
1008                                   "Component mapping seems wrong. Trying to correct.\n");
1009                     break;
1010                 }
1011             }
1012             if (!is_sane) {
1013                 is_sane = OPJ_TRUE;
1014                 for (i = 0; i < nr_channels; i++) {
1015                     cmap[i].mtyp = 1U;
1016                     cmap[i].pcol = (OPJ_BYTE) i;
1017                 }
1018             }
1019         }
1020         opj_free(pcol_usage);
1021         if (!is_sane) {
1022             return OPJ_FALSE;
1023         }
1024     }
1025
1026     return OPJ_TRUE;
1027 }
1028
1029 /* file9.jp2 */
1030 static OPJ_BOOL opj_jp2_apply_pclr(opj_image_t *image,
1031                                    opj_jp2_color_t *color,
1032                                    opj_event_mgr_t * p_manager)
1033 {
1034     opj_image_comp_t *old_comps, *new_comps;
1035     OPJ_BYTE *channel_size, *channel_sign;
1036     OPJ_UINT32 *entries;
1037     opj_jp2_cmap_comp_t *cmap;
1038     OPJ_INT32 *src, *dst;
1039     OPJ_UINT32 j, max;
1040     OPJ_UINT16 i, nr_channels, cmp, pcol;
1041     OPJ_INT32 k, top_k;
1042
1043     channel_size = color->jp2_pclr->channel_size;
1044     channel_sign = color->jp2_pclr->channel_sign;
1045     entries = color->jp2_pclr->entries;
1046     cmap = color->jp2_pclr->cmap;
1047     nr_channels = color->jp2_pclr->nr_channels;
1048
1049     for (i = 0; i < nr_channels; ++i) {
1050         /* Palette mapping: */
1051         cmp = cmap[i].cmp;
1052         if (image->comps[cmp].data == NULL) {
1053             opj_event_msg(p_manager, EVT_ERROR,
1054                           "image->comps[%d].data == NULL in opj_jp2_apply_pclr().\n", i);
1055             return OPJ_FALSE;
1056         }
1057     }
1058
1059     old_comps = image->comps;
1060     new_comps = (opj_image_comp_t*)
1061                 opj_malloc(nr_channels * sizeof(opj_image_comp_t));
1062     if (!new_comps) {
1063         opj_event_msg(p_manager, EVT_ERROR,
1064                       "Memory allocation failure in opj_jp2_apply_pclr().\n");
1065         return OPJ_FALSE;
1066     }
1067     for (i = 0; i < nr_channels; ++i) {
1068         pcol = cmap[i].pcol;
1069         cmp = cmap[i].cmp;
1070
1071         /* Direct use */
1072         if (cmap[i].mtyp == 0) {
1073             assert(pcol == 0);
1074             new_comps[i] = old_comps[cmp];
1075         } else {
1076             assert(i == pcol);
1077             new_comps[pcol] = old_comps[cmp];
1078         }
1079
1080         /* Palette mapping: */
1081         new_comps[i].data = (OPJ_INT32*)
1082                             opj_image_data_alloc(sizeof(OPJ_INT32) * old_comps[cmp].w * old_comps[cmp].h);
1083         if (!new_comps[i].data) {
1084             while (i > 0) {
1085                 -- i;
1086                 opj_image_data_free(new_comps[i].data);
1087             }
1088             opj_free(new_comps);
1089             opj_event_msg(p_manager, EVT_ERROR,
1090                           "Memory allocation failure in opj_jp2_apply_pclr().\n");
1091             return OPJ_FALSE;
1092         }
1093         new_comps[i].prec = channel_size[i];
1094         new_comps[i].sgnd = channel_sign[i];
1095     }
1096
1097     top_k = color->jp2_pclr->nr_entries - 1;
1098
1099     for (i = 0; i < nr_channels; ++i) {
1100         /* Palette mapping: */
1101         cmp = cmap[i].cmp;
1102         pcol = cmap[i].pcol;
1103         src = old_comps[cmp].data;
1104         assert(src); /* verified above */
1105         max = new_comps[pcol].w * new_comps[pcol].h;
1106
1107         /* Direct use: */
1108         if (cmap[i].mtyp == 0) {
1109             dst = new_comps[i].data;
1110             assert(dst);
1111             for (j = 0; j < max; ++j) {
1112                 dst[j] = src[j];
1113             }
1114         } else {
1115             assert(i == pcol);
1116             dst = new_comps[pcol].data;
1117             assert(dst);
1118             for (j = 0; j < max; ++j) {
1119                 /* The index */
1120                 if ((k = src[j]) < 0) {
1121                     k = 0;
1122                 } else if (k > top_k) {
1123                     k = top_k;
1124                 }
1125
1126                 /* The colour */
1127                 dst[j] = (OPJ_INT32)entries[k * nr_channels + pcol];
1128             }
1129         }
1130     }
1131
1132     max = image->numcomps;
1133     for (i = 0; i < max; ++i) {
1134         if (old_comps[i].data) {
1135             opj_image_data_free(old_comps[i].data);
1136         }
1137     }
1138
1139     opj_free(old_comps);
1140     image->comps = new_comps;
1141     image->numcomps = nr_channels;
1142
1143     return OPJ_TRUE;
1144 }/* apply_pclr() */
1145
1146 static OPJ_BOOL opj_jp2_read_pclr(opj_jp2_t *jp2,
1147                                   OPJ_BYTE * p_pclr_header_data,
1148                                   OPJ_UINT32 p_pclr_header_size,
1149                                   opj_event_mgr_t * p_manager
1150                                  )
1151 {
1152     opj_jp2_pclr_t *jp2_pclr;
1153     OPJ_BYTE *channel_size, *channel_sign;
1154     OPJ_UINT32 *entries;
1155     OPJ_UINT16 nr_entries, nr_channels;
1156     OPJ_UINT16 i, j;
1157     OPJ_UINT32 l_value;
1158     OPJ_BYTE *orig_header_data = p_pclr_header_data;
1159
1160     /* preconditions */
1161     assert(p_pclr_header_data != 00);
1162     assert(jp2 != 00);
1163     assert(p_manager != 00);
1164     (void)p_pclr_header_size;
1165
1166     if (jp2->color.jp2_pclr) {
1167         return OPJ_FALSE;
1168     }
1169
1170     if (p_pclr_header_size < 3) {
1171         return OPJ_FALSE;
1172     }
1173
1174     opj_read_bytes(p_pclr_header_data, &l_value, 2);    /* NE */
1175     p_pclr_header_data += 2;
1176     nr_entries = (OPJ_UINT16) l_value;
1177     if ((nr_entries == 0U) || (nr_entries > 1024U)) {
1178         opj_event_msg(p_manager, EVT_ERROR, "Invalid PCLR box. Reports %d entries\n",
1179                       (int)nr_entries);
1180         return OPJ_FALSE;
1181     }
1182
1183     opj_read_bytes(p_pclr_header_data, &l_value, 1);    /* NPC */
1184     ++p_pclr_header_data;
1185     nr_channels = (OPJ_UINT16) l_value;
1186     if (nr_channels == 0U) {
1187         opj_event_msg(p_manager, EVT_ERROR,
1188                       "Invalid PCLR box. Reports 0 palette columns\n");
1189         return OPJ_FALSE;
1190     }
1191
1192     if (p_pclr_header_size < 3 + (OPJ_UINT32)nr_channels) {
1193         return OPJ_FALSE;
1194     }
1195
1196     entries = (OPJ_UINT32*) opj_malloc(sizeof(OPJ_UINT32) * nr_channels *
1197                                        nr_entries);
1198     if (!entries) {
1199         return OPJ_FALSE;
1200     }
1201     channel_size = (OPJ_BYTE*) opj_malloc(nr_channels);
1202     if (!channel_size) {
1203         opj_free(entries);
1204         return OPJ_FALSE;
1205     }
1206     channel_sign = (OPJ_BYTE*) opj_malloc(nr_channels);
1207     if (!channel_sign) {
1208         opj_free(entries);
1209         opj_free(channel_size);
1210         return OPJ_FALSE;
1211     }
1212
1213     jp2_pclr = (opj_jp2_pclr_t*)opj_malloc(sizeof(opj_jp2_pclr_t));
1214     if (!jp2_pclr) {
1215         opj_free(entries);
1216         opj_free(channel_size);
1217         opj_free(channel_sign);
1218         return OPJ_FALSE;
1219     }
1220
1221     jp2_pclr->channel_sign = channel_sign;
1222     jp2_pclr->channel_size = channel_size;
1223     jp2_pclr->entries = entries;
1224     jp2_pclr->nr_entries = nr_entries;
1225     jp2_pclr->nr_channels = (OPJ_BYTE) l_value;
1226     jp2_pclr->cmap = NULL;
1227
1228     jp2->color.jp2_pclr = jp2_pclr;
1229
1230     for (i = 0; i < nr_channels; ++i) {
1231         opj_read_bytes(p_pclr_header_data, &l_value, 1);    /* Bi */
1232         ++p_pclr_header_data;
1233
1234         channel_size[i] = (OPJ_BYTE)((l_value & 0x7f) + 1);
1235         channel_sign[i] = (l_value & 0x80) ? 1 : 0;
1236     }
1237
1238     for (j = 0; j < nr_entries; ++j) {
1239         for (i = 0; i < nr_channels; ++i) {
1240             OPJ_UINT32 bytes_to_read = (OPJ_UINT32)((channel_size[i] + 7) >> 3);
1241
1242             if (bytes_to_read > sizeof(OPJ_UINT32)) {
1243                 bytes_to_read = sizeof(OPJ_UINT32);
1244             }
1245             if ((ptrdiff_t)p_pclr_header_size < (ptrdiff_t)(p_pclr_header_data -
1246                     orig_header_data) + (ptrdiff_t)bytes_to_read) {
1247                 return OPJ_FALSE;
1248             }
1249
1250             opj_read_bytes(p_pclr_header_data, &l_value, bytes_to_read);    /* Cji */
1251             p_pclr_header_data += bytes_to_read;
1252             *entries = (OPJ_UINT32) l_value;
1253             entries++;
1254         }
1255     }
1256
1257     return OPJ_TRUE;
1258 }
1259
1260 static OPJ_BOOL opj_jp2_read_cmap(opj_jp2_t * jp2,
1261                                   OPJ_BYTE * p_cmap_header_data,
1262                                   OPJ_UINT32 p_cmap_header_size,
1263                                   opj_event_mgr_t * p_manager
1264                                  )
1265 {
1266     opj_jp2_cmap_comp_t *cmap;
1267     OPJ_BYTE i, nr_channels;
1268     OPJ_UINT32 l_value;
1269
1270     /* preconditions */
1271     assert(jp2 != 00);
1272     assert(p_cmap_header_data != 00);
1273     assert(p_manager != 00);
1274     (void)p_cmap_header_size;
1275
1276     /* Need nr_channels: */
1277     if (jp2->color.jp2_pclr == NULL) {
1278         opj_event_msg(p_manager, EVT_ERROR,
1279                       "Need to read a PCLR box before the CMAP box.\n");
1280         return OPJ_FALSE;
1281     }
1282
1283     /* Part 1, I.5.3.5: 'There shall be at most one Component Mapping box
1284      * inside a JP2 Header box' :
1285     */
1286     if (jp2->color.jp2_pclr->cmap) {
1287         opj_event_msg(p_manager, EVT_ERROR, "Only one CMAP box is allowed.\n");
1288         return OPJ_FALSE;
1289     }
1290
1291     nr_channels = jp2->color.jp2_pclr->nr_channels;
1292     if (p_cmap_header_size < (OPJ_UINT32)nr_channels * 4) {
1293         opj_event_msg(p_manager, EVT_ERROR, "Insufficient data for CMAP box.\n");
1294         return OPJ_FALSE;
1295     }
1296
1297     cmap = (opj_jp2_cmap_comp_t*) opj_malloc(nr_channels * sizeof(
1298                 opj_jp2_cmap_comp_t));
1299     if (!cmap) {
1300         return OPJ_FALSE;
1301     }
1302
1303
1304     for (i = 0; i < nr_channels; ++i) {
1305         opj_read_bytes(p_cmap_header_data, &l_value, 2);            /* CMP^i */
1306         p_cmap_header_data += 2;
1307         cmap[i].cmp = (OPJ_UINT16) l_value;
1308
1309         opj_read_bytes(p_cmap_header_data, &l_value, 1);            /* MTYP^i */
1310         ++p_cmap_header_data;
1311         cmap[i].mtyp = (OPJ_BYTE) l_value;
1312
1313         opj_read_bytes(p_cmap_header_data, &l_value, 1);            /* PCOL^i */
1314         ++p_cmap_header_data;
1315         cmap[i].pcol = (OPJ_BYTE) l_value;
1316     }
1317
1318     jp2->color.jp2_pclr->cmap = cmap;
1319
1320     return OPJ_TRUE;
1321 }
1322
1323 static void opj_jp2_apply_cdef(opj_image_t *image, opj_jp2_color_t *color,
1324                                opj_event_mgr_t *manager)
1325 {
1326     opj_jp2_cdef_info_t *info;
1327     OPJ_UINT16 i, n, cn, asoc, acn;
1328
1329     info = color->jp2_cdef->info;
1330     n = color->jp2_cdef->n;
1331
1332     for (i = 0; i < n; ++i) {
1333         /* WATCH: acn = asoc - 1 ! */
1334         asoc = info[i].asoc;
1335         cn = info[i].cn;
1336
1337         if (cn >= image->numcomps) {
1338             opj_event_msg(manager, EVT_WARNING, "opj_jp2_apply_cdef: cn=%d, numcomps=%d\n",
1339                           cn, image->numcomps);
1340             continue;
1341         }
1342         if (asoc == 0 || asoc == 65535) {
1343             image->comps[cn].alpha = info[i].typ;
1344             continue;
1345         }
1346
1347         acn = (OPJ_UINT16)(asoc - 1);
1348         if (acn >= image->numcomps) {
1349             opj_event_msg(manager, EVT_WARNING, "opj_jp2_apply_cdef: acn=%d, numcomps=%d\n",
1350                           acn, image->numcomps);
1351             continue;
1352         }
1353
1354         /* Swap only if color channel */
1355         if ((cn != acn) && (info[i].typ == 0)) {
1356             opj_image_comp_t saved;
1357             OPJ_UINT16 j;
1358
1359             memcpy(&saved, &image->comps[cn], sizeof(opj_image_comp_t));
1360             memcpy(&image->comps[cn], &image->comps[acn], sizeof(opj_image_comp_t));
1361             memcpy(&image->comps[acn], &saved, sizeof(opj_image_comp_t));
1362
1363             /* Swap channels in following channel definitions, don't bother with j <= i that are already processed */
1364             for (j = (OPJ_UINT16)(i + 1U); j < n ; ++j) {
1365                 if (info[j].cn == cn) {
1366                     info[j].cn = acn;
1367                 } else if (info[j].cn == acn) {
1368                     info[j].cn = cn;
1369                 }
1370                 /* asoc is related to color index. Do not update. */
1371             }
1372         }
1373
1374         image->comps[cn].alpha = info[i].typ;
1375     }
1376
1377     if (color->jp2_cdef->info) {
1378         opj_free(color->jp2_cdef->info);
1379     }
1380
1381     opj_free(color->jp2_cdef);
1382     color->jp2_cdef = NULL;
1383
1384 }/* jp2_apply_cdef() */
1385
1386 static OPJ_BOOL opj_jp2_read_cdef(opj_jp2_t * jp2,
1387                                   OPJ_BYTE * p_cdef_header_data,
1388                                   OPJ_UINT32 p_cdef_header_size,
1389                                   opj_event_mgr_t * p_manager
1390                                  )
1391 {
1392     opj_jp2_cdef_info_t *cdef_info;
1393     OPJ_UINT16 i;
1394     OPJ_UINT32 l_value;
1395
1396     /* preconditions */
1397     assert(jp2 != 00);
1398     assert(p_cdef_header_data != 00);
1399     assert(p_manager != 00);
1400     (void)p_cdef_header_size;
1401
1402     /* Part 1, I.5.3.6: 'The shall be at most one Channel Definition box
1403      * inside a JP2 Header box.'*/
1404     if (jp2->color.jp2_cdef) {
1405         return OPJ_FALSE;
1406     }
1407
1408     if (p_cdef_header_size < 2) {
1409         opj_event_msg(p_manager, EVT_ERROR, "Insufficient data for CDEF box.\n");
1410         return OPJ_FALSE;
1411     }
1412
1413     opj_read_bytes(p_cdef_header_data, &l_value, 2);        /* N */
1414     p_cdef_header_data += 2;
1415
1416     if ((OPJ_UINT16)l_value == 0) { /* szukw000: FIXME */
1417         opj_event_msg(p_manager, EVT_ERROR,
1418                       "Number of channel description is equal to zero in CDEF box.\n");
1419         return OPJ_FALSE;
1420     }
1421
1422     if (p_cdef_header_size < 2 + (OPJ_UINT32)(OPJ_UINT16)l_value * 6) {
1423         opj_event_msg(p_manager, EVT_ERROR, "Insufficient data for CDEF box.\n");
1424         return OPJ_FALSE;
1425     }
1426
1427     cdef_info = (opj_jp2_cdef_info_t*) opj_malloc(l_value * sizeof(
1428                     opj_jp2_cdef_info_t));
1429     if (!cdef_info) {
1430         return OPJ_FALSE;
1431     }
1432
1433     jp2->color.jp2_cdef = (opj_jp2_cdef_t*)opj_malloc(sizeof(opj_jp2_cdef_t));
1434     if (!jp2->color.jp2_cdef) {
1435         opj_free(cdef_info);
1436         return OPJ_FALSE;
1437     }
1438     jp2->color.jp2_cdef->info = cdef_info;
1439     jp2->color.jp2_cdef->n = (OPJ_UINT16) l_value;
1440
1441     for (i = 0; i < jp2->color.jp2_cdef->n; ++i) {
1442         opj_read_bytes(p_cdef_header_data, &l_value, 2);            /* Cn^i */
1443         p_cdef_header_data += 2;
1444         cdef_info[i].cn = (OPJ_UINT16) l_value;
1445
1446         opj_read_bytes(p_cdef_header_data, &l_value, 2);            /* Typ^i */
1447         p_cdef_header_data += 2;
1448         cdef_info[i].typ = (OPJ_UINT16) l_value;
1449
1450         opj_read_bytes(p_cdef_header_data, &l_value, 2);            /* Asoc^i */
1451         p_cdef_header_data += 2;
1452         cdef_info[i].asoc = (OPJ_UINT16) l_value;
1453     }
1454
1455     return OPJ_TRUE;
1456 }
1457
1458 static OPJ_BOOL opj_jp2_read_colr(opj_jp2_t *jp2,
1459                                   OPJ_BYTE * p_colr_header_data,
1460                                   OPJ_UINT32 p_colr_header_size,
1461                                   opj_event_mgr_t * p_manager
1462                                  )
1463 {
1464     OPJ_UINT32 l_value;
1465
1466     /* preconditions */
1467     assert(jp2 != 00);
1468     assert(p_colr_header_data != 00);
1469     assert(p_manager != 00);
1470
1471     if (p_colr_header_size < 3) {
1472         opj_event_msg(p_manager, EVT_ERROR, "Bad COLR header box (bad size)\n");
1473         return OPJ_FALSE;
1474     }
1475
1476     /* Part 1, I.5.3.3 : 'A conforming JP2 reader shall ignore all Colour
1477      * Specification boxes after the first.'
1478     */
1479     if (jp2->color.jp2_has_colr) {
1480         opj_event_msg(p_manager, EVT_INFO,
1481                       "A conforming JP2 reader shall ignore all Colour Specification boxes after the first, so we ignore this one.\n");
1482         p_colr_header_data += p_colr_header_size;
1483         return OPJ_TRUE;
1484     }
1485
1486     opj_read_bytes(p_colr_header_data, &jp2->meth, 1);          /* METH */
1487     ++p_colr_header_data;
1488
1489     opj_read_bytes(p_colr_header_data, &jp2->precedence, 1);    /* PRECEDENCE */
1490     ++p_colr_header_data;
1491
1492     opj_read_bytes(p_colr_header_data, &jp2->approx, 1);        /* APPROX */
1493     ++p_colr_header_data;
1494
1495     if (jp2->meth == 1) {
1496         if (p_colr_header_size < 7) {
1497             opj_event_msg(p_manager, EVT_ERROR, "Bad COLR header box (bad size: %d)\n",
1498                           p_colr_header_size);
1499             return OPJ_FALSE;
1500         }
1501         if ((p_colr_header_size > 7) &&
1502                 (jp2->enumcs != 14)) { /* handled below for CIELab) */
1503             /* testcase Altona_Technical_v20_x4.pdf */
1504             opj_event_msg(p_manager, EVT_WARNING, "Bad COLR header box (bad size: %d)\n",
1505                           p_colr_header_size);
1506         }
1507
1508         opj_read_bytes(p_colr_header_data, &jp2->enumcs, 4);        /* EnumCS */
1509
1510         p_colr_header_data += 4;
1511
1512         if (jp2->enumcs == 14) { /* CIELab */
1513             OPJ_UINT32 *cielab;
1514             OPJ_UINT32 rl, ol, ra, oa, rb, ob, il;
1515
1516             cielab = (OPJ_UINT32*)opj_malloc(9 * sizeof(OPJ_UINT32));
1517             if (cielab == NULL) {
1518                 opj_event_msg(p_manager, EVT_ERROR, "Not enough memory for cielab\n");
1519                 return OPJ_FALSE;
1520             }
1521             cielab[0] = 14; /* enumcs */
1522
1523             /* default values */
1524             rl = ra = rb = ol = oa = ob = 0;
1525             il = 0x00443530; /* D50 */
1526             cielab[1] = 0x44454600;/* DEF */
1527
1528             if (p_colr_header_size == 35) {
1529                 opj_read_bytes(p_colr_header_data, &rl, 4);
1530                 p_colr_header_data += 4;
1531                 opj_read_bytes(p_colr_header_data, &ol, 4);
1532                 p_colr_header_data += 4;
1533                 opj_read_bytes(p_colr_header_data, &ra, 4);
1534                 p_colr_header_data += 4;
1535                 opj_read_bytes(p_colr_header_data, &oa, 4);
1536                 p_colr_header_data += 4;
1537                 opj_read_bytes(p_colr_header_data, &rb, 4);
1538                 p_colr_header_data += 4;
1539                 opj_read_bytes(p_colr_header_data, &ob, 4);
1540                 p_colr_header_data += 4;
1541                 opj_read_bytes(p_colr_header_data, &il, 4);
1542                 p_colr_header_data += 4;
1543
1544                 cielab[1] = 0;
1545             } else if (p_colr_header_size != 7) {
1546                 opj_event_msg(p_manager, EVT_WARNING,
1547                               "Bad COLR header box (CIELab, bad size: %d)\n", p_colr_header_size);
1548             }
1549             cielab[2] = rl;
1550             cielab[4] = ra;
1551             cielab[6] = rb;
1552             cielab[3] = ol;
1553             cielab[5] = oa;
1554             cielab[7] = ob;
1555             cielab[8] = il;
1556
1557             jp2->color.icc_profile_buf = (OPJ_BYTE*)cielab;
1558             jp2->color.icc_profile_len = 0;
1559         }
1560         jp2->color.jp2_has_colr = 1;
1561     } else if (jp2->meth == 2) {
1562         /* ICC profile */
1563         OPJ_INT32 it_icc_value = 0;
1564         OPJ_INT32 icc_len = (OPJ_INT32)p_colr_header_size - 3;
1565
1566         jp2->color.icc_profile_len = (OPJ_UINT32)icc_len;
1567         jp2->color.icc_profile_buf = (OPJ_BYTE*) opj_calloc(1, (size_t)icc_len);
1568         if (!jp2->color.icc_profile_buf) {
1569             jp2->color.icc_profile_len = 0;
1570             return OPJ_FALSE;
1571         }
1572
1573         for (it_icc_value = 0; it_icc_value < icc_len; ++it_icc_value) {
1574             opj_read_bytes(p_colr_header_data, &l_value, 1);    /* icc values */
1575             ++p_colr_header_data;
1576             jp2->color.icc_profile_buf[it_icc_value] = (OPJ_BYTE) l_value;
1577         }
1578
1579         jp2->color.jp2_has_colr = 1;
1580     } else if (jp2->meth > 2) {
1581         /*  ISO/IEC 15444-1:2004 (E), Table I.9 Legal METH values:
1582         conforming JP2 reader shall ignore the entire Colour Specification box.*/
1583         opj_event_msg(p_manager, EVT_INFO,
1584                       "COLR BOX meth value is not a regular value (%d), "
1585                       "so we will ignore the entire Colour Specification box. \n", jp2->meth);
1586     }
1587
1588     return OPJ_TRUE;
1589 }
1590
1591 OPJ_BOOL opj_jp2_decode(opj_jp2_t *jp2,
1592                         opj_stream_private_t *p_stream,
1593                         opj_image_t* p_image,
1594                         opj_event_mgr_t * p_manager)
1595 {
1596     if (!p_image) {
1597         return OPJ_FALSE;
1598     }
1599
1600     /* J2K decoding */
1601     if (! opj_j2k_decode(jp2->j2k, p_stream, p_image, p_manager)) {
1602         opj_event_msg(p_manager, EVT_ERROR,
1603                       "Failed to decode the codestream in the JP2 file\n");
1604         return OPJ_FALSE;
1605     }
1606
1607     if (jp2->j2k->m_specific_param.m_decoder.m_numcomps_to_decode) {
1608         /* Bypass all JP2 component transforms */
1609         return OPJ_TRUE;
1610     }
1611
1612     if (!jp2->ignore_pclr_cmap_cdef) {
1613         if (!opj_jp2_check_color(p_image, &(jp2->color), p_manager)) {
1614             return OPJ_FALSE;
1615         }
1616
1617         /* Set Image Color Space */
1618         if (jp2->enumcs == 16) {
1619             p_image->color_space = OPJ_CLRSPC_SRGB;
1620         } else if (jp2->enumcs == 17) {
1621             p_image->color_space = OPJ_CLRSPC_GRAY;
1622         } else if (jp2->enumcs == 18) {
1623             p_image->color_space = OPJ_CLRSPC_SYCC;
1624         } else if (jp2->enumcs == 24) {
1625             p_image->color_space = OPJ_CLRSPC_EYCC;
1626         } else if (jp2->enumcs == 12) {
1627             p_image->color_space = OPJ_CLRSPC_CMYK;
1628         } else {
1629             p_image->color_space = OPJ_CLRSPC_UNKNOWN;
1630         }
1631
1632         if (jp2->color.jp2_pclr) {
1633             /* Part 1, I.5.3.4: Either both or none : */
1634             if (!jp2->color.jp2_pclr->cmap) {
1635                 opj_jp2_free_pclr(&(jp2->color));
1636             } else {
1637                 if (!opj_jp2_apply_pclr(p_image, &(jp2->color), p_manager)) {
1638                     return OPJ_FALSE;
1639                 }
1640             }
1641         }
1642
1643         /* Apply the color space if needed */
1644         if (jp2->color.jp2_cdef) {
1645             opj_jp2_apply_cdef(p_image, &(jp2->color), p_manager);
1646         }
1647
1648         if (jp2->color.icc_profile_buf) {
1649             p_image->icc_profile_buf = jp2->color.icc_profile_buf;
1650             p_image->icc_profile_len = jp2->color.icc_profile_len;
1651             jp2->color.icc_profile_buf = NULL;
1652         }
1653     }
1654
1655     return OPJ_TRUE;
1656 }
1657
1658 static OPJ_BOOL opj_jp2_write_jp2h(opj_jp2_t *jp2,
1659                                    opj_stream_private_t *stream,
1660                                    opj_event_mgr_t * p_manager
1661                                   )
1662 {
1663     opj_jp2_img_header_writer_handler_t l_writers [4];
1664     opj_jp2_img_header_writer_handler_t * l_current_writer;
1665
1666     OPJ_INT32 i, l_nb_pass;
1667     /* size of data for super box*/
1668     OPJ_UINT32 l_jp2h_size = 8;
1669     OPJ_BOOL l_result = OPJ_TRUE;
1670
1671     /* to store the data of the super box */
1672     OPJ_BYTE l_jp2h_data [8];
1673
1674     /* preconditions */
1675     assert(stream != 00);
1676     assert(jp2 != 00);
1677     assert(p_manager != 00);
1678
1679     memset(l_writers, 0, sizeof(l_writers));
1680
1681     if (jp2->bpc == 255) {
1682         l_nb_pass = 3;
1683         l_writers[0].handler = opj_jp2_write_ihdr;
1684         l_writers[1].handler = opj_jp2_write_bpcc;
1685         l_writers[2].handler = opj_jp2_write_colr;
1686     } else {
1687         l_nb_pass = 2;
1688         l_writers[0].handler = opj_jp2_write_ihdr;
1689         l_writers[1].handler = opj_jp2_write_colr;
1690     }
1691
1692     if (jp2->color.jp2_cdef != NULL) {
1693         l_writers[l_nb_pass].handler = opj_jp2_write_cdef;
1694         l_nb_pass++;
1695     }
1696
1697     /* write box header */
1698     /* write JP2H type */
1699     opj_write_bytes(l_jp2h_data + 4, JP2_JP2H, 4);
1700
1701     l_current_writer = l_writers;
1702     for (i = 0; i < l_nb_pass; ++i) {
1703         l_current_writer->m_data = l_current_writer->handler(jp2,
1704                                    &(l_current_writer->m_size));
1705         if (l_current_writer->m_data == 00) {
1706             opj_event_msg(p_manager, EVT_ERROR,
1707                           "Not enough memory to hold JP2 Header data\n");
1708             l_result = OPJ_FALSE;
1709             break;
1710         }
1711
1712         l_jp2h_size += l_current_writer->m_size;
1713         ++l_current_writer;
1714     }
1715
1716     if (! l_result) {
1717         l_current_writer = l_writers;
1718         for (i = 0; i < l_nb_pass; ++i) {
1719             if (l_current_writer->m_data != 00) {
1720                 opj_free(l_current_writer->m_data);
1721             }
1722             ++l_current_writer;
1723         }
1724
1725         return OPJ_FALSE;
1726     }
1727
1728     /* write super box size */
1729     opj_write_bytes(l_jp2h_data, l_jp2h_size, 4);
1730
1731     /* write super box data on stream */
1732     if (opj_stream_write_data(stream, l_jp2h_data, 8, p_manager) != 8) {
1733         opj_event_msg(p_manager, EVT_ERROR,
1734                       "Stream error while writing JP2 Header box\n");
1735         l_result = OPJ_FALSE;
1736     }
1737
1738     if (l_result) {
1739         l_current_writer = l_writers;
1740         for (i = 0; i < l_nb_pass; ++i) {
1741             if (opj_stream_write_data(stream, l_current_writer->m_data,
1742                                       l_current_writer->m_size, p_manager) != l_current_writer->m_size) {
1743                 opj_event_msg(p_manager, EVT_ERROR,
1744                               "Stream error while writing JP2 Header box\n");
1745                 l_result = OPJ_FALSE;
1746                 break;
1747             }
1748             ++l_current_writer;
1749         }
1750     }
1751
1752     l_current_writer = l_writers;
1753
1754     /* cleanup */
1755     for (i = 0; i < l_nb_pass; ++i) {
1756         if (l_current_writer->m_data != 00) {
1757             opj_free(l_current_writer->m_data);
1758         }
1759         ++l_current_writer;
1760     }
1761
1762     return l_result;
1763 }
1764
1765 static OPJ_BOOL opj_jp2_write_ftyp(opj_jp2_t *jp2,
1766                                    opj_stream_private_t *cio,
1767                                    opj_event_mgr_t * p_manager)
1768 {
1769     OPJ_UINT32 i;
1770     OPJ_UINT32 l_ftyp_size;
1771     OPJ_BYTE * l_ftyp_data, * l_current_data_ptr;
1772     OPJ_BOOL l_result;
1773
1774     /* preconditions */
1775     assert(cio != 00);
1776     assert(jp2 != 00);
1777     assert(p_manager != 00);
1778     l_ftyp_size = 16 + 4 * jp2->numcl;
1779
1780     l_ftyp_data = (OPJ_BYTE *) opj_calloc(1, l_ftyp_size);
1781
1782     if (l_ftyp_data == 00) {
1783         opj_event_msg(p_manager, EVT_ERROR, "Not enough memory to handle ftyp data\n");
1784         return OPJ_FALSE;
1785     }
1786
1787     l_current_data_ptr = l_ftyp_data;
1788
1789     opj_write_bytes(l_current_data_ptr, l_ftyp_size, 4); /* box size */
1790     l_current_data_ptr += 4;
1791
1792     opj_write_bytes(l_current_data_ptr, JP2_FTYP, 4); /* FTYP */
1793     l_current_data_ptr += 4;
1794
1795     opj_write_bytes(l_current_data_ptr, jp2->brand, 4); /* BR */
1796     l_current_data_ptr += 4;
1797
1798     opj_write_bytes(l_current_data_ptr, jp2->minversion, 4); /* MinV */
1799     l_current_data_ptr += 4;
1800
1801     for (i = 0; i < jp2->numcl; i++)  {
1802         opj_write_bytes(l_current_data_ptr, jp2->cl[i], 4); /* CL */
1803     }
1804
1805     l_result = (opj_stream_write_data(cio, l_ftyp_data, l_ftyp_size,
1806                                       p_manager) == l_ftyp_size);
1807     if (! l_result) {
1808         opj_event_msg(p_manager, EVT_ERROR,
1809                       "Error while writing ftyp data to stream\n");
1810     }
1811
1812     opj_free(l_ftyp_data);
1813
1814     return l_result;
1815 }
1816
1817 static OPJ_BOOL opj_jp2_write_jp2c(opj_jp2_t *jp2,
1818                                    opj_stream_private_t *cio,
1819                                    opj_event_mgr_t * p_manager)
1820 {
1821     OPJ_OFF_T j2k_codestream_exit;
1822     OPJ_BYTE l_data_header [8];
1823
1824     /* preconditions */
1825     assert(jp2 != 00);
1826     assert(cio != 00);
1827     assert(p_manager != 00);
1828     assert(opj_stream_has_seek(cio));
1829
1830     j2k_codestream_exit = opj_stream_tell(cio);
1831     opj_write_bytes(l_data_header,
1832                     (OPJ_UINT32)(j2k_codestream_exit - jp2->j2k_codestream_offset),
1833                     4); /* size of codestream */
1834     opj_write_bytes(l_data_header + 4, JP2_JP2C,
1835                     4);                                     /* JP2C */
1836
1837     if (! opj_stream_seek(cio, jp2->j2k_codestream_offset, p_manager)) {
1838         opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
1839         return OPJ_FALSE;
1840     }
1841
1842     if (opj_stream_write_data(cio, l_data_header, 8, p_manager) != 8) {
1843         opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
1844         return OPJ_FALSE;
1845     }
1846
1847     if (! opj_stream_seek(cio, j2k_codestream_exit, p_manager)) {
1848         opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
1849         return OPJ_FALSE;
1850     }
1851
1852     return OPJ_TRUE;
1853 }
1854
1855 static OPJ_BOOL opj_jp2_write_jp(opj_jp2_t *jp2,
1856                                  opj_stream_private_t *cio,
1857                                  opj_event_mgr_t * p_manager)
1858 {
1859     /* 12 bytes will be read */
1860     OPJ_BYTE l_signature_data [12];
1861
1862     /* preconditions */
1863     assert(cio != 00);
1864     assert(jp2 != 00);
1865     assert(p_manager != 00);
1866
1867     OPJ_UNUSED(jp2);
1868
1869     /* write box length */
1870     opj_write_bytes(l_signature_data, 12, 4);
1871     /* writes box type */
1872     opj_write_bytes(l_signature_data + 4, JP2_JP, 4);
1873     /* writes magic number*/
1874     opj_write_bytes(l_signature_data + 8, 0x0d0a870a, 4);
1875
1876     if (opj_stream_write_data(cio, l_signature_data, 12, p_manager) != 12) {
1877         return OPJ_FALSE;
1878     }
1879
1880     return OPJ_TRUE;
1881 }
1882
1883 /* ----------------------------------------------------------------------- */
1884 /* JP2 decoder interface                                             */
1885 /* ----------------------------------------------------------------------- */
1886
1887 void opj_jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters)
1888 {
1889     /* setup the J2K codec */
1890     opj_j2k_setup_decoder(jp2->j2k, parameters);
1891
1892     /* further JP2 initializations go here */
1893     jp2->color.jp2_has_colr = 0;
1894     jp2->ignore_pclr_cmap_cdef = parameters->flags &
1895                                  OPJ_DPARAMETERS_IGNORE_PCLR_CMAP_CDEF_FLAG;
1896 }
1897
1898 OPJ_BOOL opj_jp2_set_threads(opj_jp2_t *jp2, OPJ_UINT32 num_threads)
1899 {
1900     return opj_j2k_set_threads(jp2->j2k, num_threads);
1901 }
1902
1903 /* ----------------------------------------------------------------------- */
1904 /* JP2 encoder interface                                             */
1905 /* ----------------------------------------------------------------------- */
1906
1907 OPJ_BOOL opj_jp2_setup_encoder(opj_jp2_t *jp2,
1908                                opj_cparameters_t *parameters,
1909                                opj_image_t *image,
1910                                opj_event_mgr_t * p_manager)
1911 {
1912     OPJ_UINT32 i;
1913     OPJ_UINT32 depth_0;
1914     OPJ_UINT32 sign;
1915     OPJ_UINT32 alpha_count;
1916     OPJ_UINT32 color_channels = 0U;
1917     OPJ_UINT32 alpha_channel = 0U;
1918
1919
1920     if (!jp2 || !parameters || !image) {
1921         return OPJ_FALSE;
1922     }
1923
1924     /* setup the J2K codec */
1925     /* ------------------- */
1926
1927     /* Check if number of components respects standard */
1928     if (image->numcomps < 1 || image->numcomps > 16384) {
1929         opj_event_msg(p_manager, EVT_ERROR,
1930                       "Invalid number of components specified while setting up JP2 encoder\n");
1931         return OPJ_FALSE;
1932     }
1933
1934     if (opj_j2k_setup_encoder(jp2->j2k, parameters, image,
1935                               p_manager) == OPJ_FALSE) {
1936         return OPJ_FALSE;
1937     }
1938
1939     /* setup the JP2 codec */
1940     /* ------------------- */
1941
1942     /* Profile box */
1943
1944     jp2->brand = JP2_JP2;   /* BR */
1945     jp2->minversion = 0;    /* MinV */
1946     jp2->numcl = 1;
1947     jp2->cl = (OPJ_UINT32*) opj_malloc(jp2->numcl * sizeof(OPJ_UINT32));
1948     if (!jp2->cl) {
1949         opj_event_msg(p_manager, EVT_ERROR,
1950                       "Not enough memory when setup the JP2 encoder\n");
1951         return OPJ_FALSE;
1952     }
1953     jp2->cl[0] = JP2_JP2;   /* CL0 : JP2 */
1954
1955     /* Image Header box */
1956
1957     jp2->numcomps = image->numcomps;    /* NC */
1958     jp2->comps = (opj_jp2_comps_t*) opj_malloc(jp2->numcomps * sizeof(
1959                      opj_jp2_comps_t));
1960     if (!jp2->comps) {
1961         opj_event_msg(p_manager, EVT_ERROR,
1962                       "Not enough memory when setup the JP2 encoder\n");
1963         /* Memory of jp2->cl will be freed by opj_jp2_destroy */
1964         return OPJ_FALSE;
1965     }
1966
1967     jp2->h = image->y1 - image->y0;     /* HEIGHT */
1968     jp2->w = image->x1 - image->x0;     /* WIDTH */
1969     /* BPC */
1970     depth_0 = image->comps[0].prec - 1;
1971     sign = image->comps[0].sgnd;
1972     jp2->bpc = depth_0 + (sign << 7);
1973     for (i = 1; i < image->numcomps; i++) {
1974         OPJ_UINT32 depth = image->comps[i].prec - 1;
1975         sign = image->comps[i].sgnd;
1976         if (depth_0 != depth) {
1977             jp2->bpc = 255;
1978         }
1979     }
1980     jp2->C = 7;         /* C : Always 7 */
1981     jp2->UnkC = 0;      /* UnkC, colorspace specified in colr box */
1982     jp2->IPR = 0;       /* IPR, no intellectual property */
1983
1984     /* BitsPerComponent box */
1985     for (i = 0; i < image->numcomps; i++) {
1986         jp2->comps[i].bpcc = image->comps[i].prec - 1 + (image->comps[i].sgnd << 7);
1987     }
1988
1989     /* Colour Specification box */
1990     if (image->icc_profile_len) {
1991         jp2->meth = 2;
1992         jp2->enumcs = 0;
1993     } else {
1994         jp2->meth = 1;
1995         if (image->color_space == 1) {
1996             jp2->enumcs = 16;    /* sRGB as defined by IEC 61966-2-1 */
1997         } else if (image->color_space == 2) {
1998             jp2->enumcs = 17;    /* greyscale */
1999         } else if (image->color_space == 3) {
2000             jp2->enumcs = 18;    /* YUV */
2001         }
2002     }
2003
2004     /* Channel Definition box */
2005     /* FIXME not provided by parameters */
2006     /* We try to do what we can... */
2007     alpha_count = 0U;
2008     for (i = 0; i < image->numcomps; i++) {
2009         if (image->comps[i].alpha != 0) {
2010             alpha_count++;
2011             alpha_channel = i;
2012         }
2013     }
2014     if (alpha_count == 1U) { /* no way to deal with more than 1 alpha channel */
2015         switch (jp2->enumcs) {
2016         case 16:
2017         case 18:
2018             color_channels = 3;
2019             break;
2020         case 17:
2021             color_channels = 1;
2022             break;
2023         default:
2024             alpha_count = 0U;
2025             break;
2026         }
2027         if (alpha_count == 0U) {
2028             opj_event_msg(p_manager, EVT_WARNING,
2029                           "Alpha channel specified but unknown enumcs. No cdef box will be created.\n");
2030         } else if (image->numcomps < (color_channels + 1)) {
2031             opj_event_msg(p_manager, EVT_WARNING,
2032                           "Alpha channel specified but not enough image components for an automatic cdef box creation.\n");
2033             alpha_count = 0U;
2034         } else if ((OPJ_UINT32)alpha_channel < color_channels) {
2035             opj_event_msg(p_manager, EVT_WARNING,
2036                           "Alpha channel position conflicts with color channel. No cdef box will be created.\n");
2037             alpha_count = 0U;
2038         }
2039     } else if (alpha_count > 1) {
2040         opj_event_msg(p_manager, EVT_WARNING,
2041                       "Multiple alpha channels specified. No cdef box will be created.\n");
2042     }
2043     if (alpha_count == 1U) { /* if here, we know what we can do */
2044         jp2->color.jp2_cdef = (opj_jp2_cdef_t*)opj_malloc(sizeof(opj_jp2_cdef_t));
2045         if (!jp2->color.jp2_cdef) {
2046             opj_event_msg(p_manager, EVT_ERROR,
2047                           "Not enough memory to setup the JP2 encoder\n");
2048             return OPJ_FALSE;
2049         }
2050         /* no memset needed, all values will be overwritten except if jp2->color.jp2_cdef->info allocation fails, */
2051         /* in which case jp2->color.jp2_cdef->info will be NULL => valid for destruction */
2052         jp2->color.jp2_cdef->info = (opj_jp2_cdef_info_t*) opj_malloc(
2053                                         image->numcomps * sizeof(opj_jp2_cdef_info_t));
2054         if (!jp2->color.jp2_cdef->info) {
2055             /* memory will be freed by opj_jp2_destroy */
2056             opj_event_msg(p_manager, EVT_ERROR,
2057                           "Not enough memory to setup the JP2 encoder\n");
2058             return OPJ_FALSE;
2059         }
2060         jp2->color.jp2_cdef->n = (OPJ_UINT16)
2061                                  image->numcomps; /* cast is valid : image->numcomps [1,16384] */
2062         for (i = 0U; i < color_channels; i++) {
2063             jp2->color.jp2_cdef->info[i].cn = (OPJ_UINT16)
2064                                               i; /* cast is valid : image->numcomps [1,16384] */
2065             jp2->color.jp2_cdef->info[i].typ = 0U;
2066             jp2->color.jp2_cdef->info[i].asoc = (OPJ_UINT16)(i +
2067                                                 1U); /* No overflow + cast is valid : image->numcomps [1,16384] */
2068         }
2069         for (; i < image->numcomps; i++) {
2070             if (image->comps[i].alpha != 0) { /* we'll be here exactly once */
2071                 jp2->color.jp2_cdef->info[i].cn = (OPJ_UINT16)
2072                                                   i; /* cast is valid : image->numcomps [1,16384] */
2073                 jp2->color.jp2_cdef->info[i].typ = 1U; /* Opacity channel */
2074                 jp2->color.jp2_cdef->info[i].asoc =
2075                     0U; /* Apply alpha channel to the whole image */
2076             } else {
2077                 /* Unknown channel */
2078                 jp2->color.jp2_cdef->info[i].cn = (OPJ_UINT16)
2079                                                   i; /* cast is valid : image->numcomps [1,16384] */
2080                 jp2->color.jp2_cdef->info[i].typ = 65535U;
2081                 jp2->color.jp2_cdef->info[i].asoc = 65535U;
2082             }
2083         }
2084     }
2085
2086     jp2->precedence = 0;    /* PRECEDENCE */
2087     jp2->approx = 0;        /* APPROX */
2088
2089     jp2->jpip_on = parameters->jpip_on;
2090
2091     return OPJ_TRUE;
2092 }
2093
2094 OPJ_BOOL opj_jp2_encode(opj_jp2_t *jp2,
2095                         opj_stream_private_t *stream,
2096                         opj_event_mgr_t * p_manager)
2097 {
2098     return opj_j2k_encode(jp2->j2k, stream, p_manager);
2099 }
2100
2101 OPJ_BOOL opj_jp2_end_decompress(opj_jp2_t *jp2,
2102                                 opj_stream_private_t *cio,
2103                                 opj_event_mgr_t * p_manager
2104                                )
2105 {
2106     /* preconditions */
2107     assert(jp2 != 00);
2108     assert(cio != 00);
2109     assert(p_manager != 00);
2110
2111     /* customization of the end encoding */
2112     if (! opj_jp2_setup_end_header_reading(jp2, p_manager)) {
2113         return OPJ_FALSE;
2114     }
2115
2116     /* write header */
2117     if (! opj_jp2_exec(jp2, jp2->m_procedure_list, cio, p_manager)) {
2118         return OPJ_FALSE;
2119     }
2120
2121     return opj_j2k_end_decompress(jp2->j2k, cio, p_manager);
2122 }
2123
2124 OPJ_BOOL opj_jp2_end_compress(opj_jp2_t *jp2,
2125                               opj_stream_private_t *cio,
2126                               opj_event_mgr_t * p_manager
2127                              )
2128 {
2129     /* preconditions */
2130     assert(jp2 != 00);
2131     assert(cio != 00);
2132     assert(p_manager != 00);
2133
2134     /* customization of the end encoding */
2135     if (! opj_jp2_setup_end_header_writing(jp2, p_manager)) {
2136         return OPJ_FALSE;
2137     }
2138
2139     if (! opj_j2k_end_compress(jp2->j2k, cio, p_manager)) {
2140         return OPJ_FALSE;
2141     }
2142
2143     /* write header */
2144     return opj_jp2_exec(jp2, jp2->m_procedure_list, cio, p_manager);
2145 }
2146
2147 static OPJ_BOOL opj_jp2_setup_end_header_writing(opj_jp2_t *jp2,
2148         opj_event_mgr_t * p_manager)
2149 {
2150     /* preconditions */
2151     assert(jp2 != 00);
2152     assert(p_manager != 00);
2153
2154 #ifdef USE_JPIP
2155     if (jp2->jpip_on) {
2156         if (! opj_procedure_list_add_procedure(jp2->m_procedure_list,
2157                                                (opj_procedure)opj_jpip_write_iptr, p_manager)) {
2158             return OPJ_FALSE;
2159         }
2160     }
2161 #endif
2162     if (! opj_procedure_list_add_procedure(jp2->m_procedure_list,
2163                                            (opj_procedure)opj_jp2_write_jp2c, p_manager)) {
2164         return OPJ_FALSE;
2165     }
2166     /* DEVELOPER CORNER, add your custom procedures */
2167 #ifdef USE_JPIP
2168     if (jp2->jpip_on) {
2169         if (! opj_procedure_list_add_procedure(jp2->m_procedure_list,
2170                                                (opj_procedure)opj_jpip_write_cidx, p_manager)) {
2171             return OPJ_FALSE;
2172         }
2173         if (! opj_procedure_list_add_procedure(jp2->m_procedure_list,
2174                                                (opj_procedure)opj_jpip_write_fidx, p_manager)) {
2175             return OPJ_FALSE;
2176         }
2177     }
2178 #endif
2179     return OPJ_TRUE;
2180 }
2181
2182 static OPJ_BOOL opj_jp2_setup_end_header_reading(opj_jp2_t *jp2,
2183         opj_event_mgr_t * p_manager)
2184 {
2185     /* preconditions */
2186     assert(jp2 != 00);
2187     assert(p_manager != 00);
2188
2189     if (! opj_procedure_list_add_procedure(jp2->m_procedure_list,
2190                                            (opj_procedure)opj_jp2_read_header_procedure, p_manager)) {
2191         return OPJ_FALSE;
2192     }
2193     /* DEVELOPER CORNER, add your custom procedures */
2194
2195     return OPJ_TRUE;
2196 }
2197
2198 static OPJ_BOOL opj_jp2_default_validation(opj_jp2_t * jp2,
2199         opj_stream_private_t *cio,
2200         opj_event_mgr_t * p_manager
2201                                           )
2202 {
2203     OPJ_BOOL l_is_valid = OPJ_TRUE;
2204     OPJ_UINT32 i;
2205
2206     /* preconditions */
2207     assert(jp2 != 00);
2208     assert(cio != 00);
2209     assert(p_manager != 00);
2210
2211     OPJ_UNUSED(p_manager);
2212
2213     /* JPEG2000 codec validation */
2214
2215     /* STATE checking */
2216     /* make sure the state is at 0 */
2217     l_is_valid &= (jp2->jp2_state == JP2_STATE_NONE);
2218
2219     /* make sure not reading a jp2h ???? WEIRD */
2220     l_is_valid &= (jp2->jp2_img_state == JP2_IMG_STATE_NONE);
2221
2222     /* POINTER validation */
2223     /* make sure a j2k codec is present */
2224     l_is_valid &= (jp2->j2k != 00);
2225
2226     /* make sure a procedure list is present */
2227     l_is_valid &= (jp2->m_procedure_list != 00);
2228
2229     /* make sure a validation list is present */
2230     l_is_valid &= (jp2->m_validation_list != 00);
2231
2232     /* PARAMETER VALIDATION */
2233     /* number of components */
2234     l_is_valid &= (jp2->numcl > 0);
2235     /* width */
2236     l_is_valid &= (jp2->h > 0);
2237     /* height */
2238     l_is_valid &= (jp2->w > 0);
2239     /* precision */
2240     for (i = 0; i < jp2->numcomps; ++i) {
2241         l_is_valid &= ((jp2->comps[i].bpcc & 0x7FU) <
2242                        38U); /* 0 is valid, ignore sign for check */
2243     }
2244
2245     /* METH */
2246     l_is_valid &= ((jp2->meth > 0) && (jp2->meth < 3));
2247
2248     /* stream validation */
2249     /* back and forth is needed */
2250     l_is_valid &= opj_stream_has_seek(cio);
2251
2252     return l_is_valid;
2253 }
2254
2255 static OPJ_BOOL opj_jp2_read_header_procedure(opj_jp2_t *jp2,
2256         opj_stream_private_t *stream,
2257         opj_event_mgr_t * p_manager
2258                                              )
2259 {
2260     opj_jp2_box_t box;
2261     OPJ_UINT32 l_nb_bytes_read;
2262     const opj_jp2_header_handler_t * l_current_handler;
2263     const opj_jp2_header_handler_t * l_current_handler_misplaced;
2264     OPJ_UINT32 l_last_data_size = OPJ_BOX_SIZE;
2265     OPJ_UINT32 l_current_data_size;
2266     OPJ_BYTE * l_current_data = 00;
2267
2268     /* preconditions */
2269     assert(stream != 00);
2270     assert(jp2 != 00);
2271     assert(p_manager != 00);
2272
2273     l_current_data = (OPJ_BYTE*)opj_calloc(1, l_last_data_size);
2274
2275     if (l_current_data == 00) {
2276         opj_event_msg(p_manager, EVT_ERROR,
2277                       "Not enough memory to handle jpeg2000 file header\n");
2278         return OPJ_FALSE;
2279     }
2280
2281     while (opj_jp2_read_boxhdr(&box, &l_nb_bytes_read, stream, p_manager)) {
2282         /* is it the codestream box ? */
2283         if (box.type == JP2_JP2C) {
2284             if (jp2->jp2_state & JP2_STATE_HEADER) {
2285                 jp2->jp2_state |= JP2_STATE_CODESTREAM;
2286                 opj_free(l_current_data);
2287                 return OPJ_TRUE;
2288             } else {
2289                 opj_event_msg(p_manager, EVT_ERROR, "bad placed jpeg codestream\n");
2290                 opj_free(l_current_data);
2291                 return OPJ_FALSE;
2292             }
2293         } else if (box.length == 0) {
2294             opj_event_msg(p_manager, EVT_ERROR, "Cannot handle box of undefined sizes\n");
2295             opj_free(l_current_data);
2296             return OPJ_FALSE;
2297         }
2298         /* testcase 1851.pdf.SIGSEGV.ce9.948 */
2299         else if (box.length < l_nb_bytes_read) {
2300             opj_event_msg(p_manager, EVT_ERROR, "invalid box size %d (%x)\n", box.length,
2301                           box.type);
2302             opj_free(l_current_data);
2303             return OPJ_FALSE;
2304         }
2305
2306         l_current_handler = opj_jp2_find_handler(box.type);
2307         l_current_handler_misplaced = opj_jp2_img_find_handler(box.type);
2308         l_current_data_size = box.length - l_nb_bytes_read;
2309
2310         if ((l_current_handler != 00) || (l_current_handler_misplaced != 00)) {
2311             if (l_current_handler == 00) {
2312                 opj_event_msg(p_manager, EVT_WARNING,
2313                               "Found a misplaced '%c%c%c%c' box outside jp2h box\n",
2314                               (OPJ_BYTE)(box.type >> 24), (OPJ_BYTE)(box.type >> 16),
2315                               (OPJ_BYTE)(box.type >> 8), (OPJ_BYTE)(box.type >> 0));
2316                 if (jp2->jp2_state & JP2_STATE_HEADER) {
2317                     /* read anyway, we already have jp2h */
2318                     l_current_handler = l_current_handler_misplaced;
2319                 } else {
2320                     opj_event_msg(p_manager, EVT_WARNING,
2321                                   "JPEG2000 Header box not read yet, '%c%c%c%c' box will be ignored\n",
2322                                   (OPJ_BYTE)(box.type >> 24), (OPJ_BYTE)(box.type >> 16),
2323                                   (OPJ_BYTE)(box.type >> 8), (OPJ_BYTE)(box.type >> 0));
2324                     jp2->jp2_state |= JP2_STATE_UNKNOWN;
2325                     if (opj_stream_skip(stream, l_current_data_size,
2326                                         p_manager) != l_current_data_size) {
2327                         opj_event_msg(p_manager, EVT_ERROR,
2328                                       "Problem with skipping JPEG2000 box, stream error\n");
2329                         opj_free(l_current_data);
2330                         return OPJ_FALSE;
2331                     }
2332                     continue;
2333                 }
2334             }
2335             if ((OPJ_OFF_T)l_current_data_size > opj_stream_get_number_byte_left(stream)) {
2336                 /* do not even try to malloc if we can't read */
2337                 opj_event_msg(p_manager, EVT_ERROR,
2338                               "Invalid box size %d for box '%c%c%c%c'. Need %d bytes, %d bytes remaining \n",
2339                               box.length, (OPJ_BYTE)(box.type >> 24), (OPJ_BYTE)(box.type >> 16),
2340                               (OPJ_BYTE)(box.type >> 8), (OPJ_BYTE)(box.type >> 0), l_current_data_size,
2341                               (OPJ_UINT32)opj_stream_get_number_byte_left(stream));
2342                 opj_free(l_current_data);
2343                 return OPJ_FALSE;
2344             }
2345             if (l_current_data_size > l_last_data_size) {
2346                 OPJ_BYTE* new_current_data = (OPJ_BYTE*)opj_realloc(l_current_data,
2347                                              l_current_data_size);
2348                 if (!new_current_data) {
2349                     opj_free(l_current_data);
2350                     opj_event_msg(p_manager, EVT_ERROR,
2351                                   "Not enough memory to handle jpeg2000 box\n");
2352                     return OPJ_FALSE;
2353                 }
2354                 l_current_data = new_current_data;
2355                 l_last_data_size = l_current_data_size;
2356             }
2357
2358             l_nb_bytes_read = (OPJ_UINT32)opj_stream_read_data(stream, l_current_data,
2359                               l_current_data_size, p_manager);
2360             if (l_nb_bytes_read != l_current_data_size) {
2361                 opj_event_msg(p_manager, EVT_ERROR,
2362                               "Problem with reading JPEG2000 box, stream error\n");
2363                 opj_free(l_current_data);
2364                 return OPJ_FALSE;
2365             }
2366
2367             if (! l_current_handler->handler(jp2, l_current_data, l_current_data_size,
2368                                              p_manager)) {
2369                 opj_free(l_current_data);
2370                 return OPJ_FALSE;
2371             }
2372         } else {
2373             if (!(jp2->jp2_state & JP2_STATE_SIGNATURE)) {
2374                 opj_event_msg(p_manager, EVT_ERROR,
2375                               "Malformed JP2 file format: first box must be JPEG 2000 signature box\n");
2376                 opj_free(l_current_data);
2377                 return OPJ_FALSE;
2378             }
2379             if (!(jp2->jp2_state & JP2_STATE_FILE_TYPE)) {
2380                 opj_event_msg(p_manager, EVT_ERROR,
2381                               "Malformed JP2 file format: second box must be file type box\n");
2382                 opj_free(l_current_data);
2383                 return OPJ_FALSE;
2384             }
2385             jp2->jp2_state |= JP2_STATE_UNKNOWN;
2386             if (opj_stream_skip(stream, l_current_data_size,
2387                                 p_manager) != l_current_data_size) {
2388                 if (jp2->jp2_state & JP2_STATE_CODESTREAM) {
2389                     /* If we already read the codestream, do not error out */
2390                     /* Needed for data/input/nonregression/issue254.jp2 */
2391                     opj_event_msg(p_manager, EVT_WARNING,
2392                                   "Problem with skipping JPEG2000 box, stream error\n");
2393                     opj_free(l_current_data);
2394                     return OPJ_TRUE;
2395                 } else {
2396                     opj_event_msg(p_manager, EVT_ERROR,
2397                                   "Problem with skipping JPEG2000 box, stream error\n");
2398                     opj_free(l_current_data);
2399                     return OPJ_FALSE;
2400                 }
2401             }
2402         }
2403     }
2404
2405     opj_free(l_current_data);
2406
2407     return OPJ_TRUE;
2408 }
2409
2410 /**
2411  * Executes the given procedures on the given codec.
2412  *
2413  * @param   p_procedure_list    the list of procedures to execute
2414  * @param   jp2                 the jpeg2000 file codec to execute the procedures on.
2415  * @param   stream                  the stream to execute the procedures on.
2416  * @param   p_manager           the user manager.
2417  *
2418  * @return  true                if all the procedures were successfully executed.
2419  */
2420 static OPJ_BOOL opj_jp2_exec(opj_jp2_t * jp2,
2421                              opj_procedure_list_t * p_procedure_list,
2422                              opj_stream_private_t *stream,
2423                              opj_event_mgr_t * p_manager
2424                             )
2425
2426 {
2427     OPJ_BOOL(** l_procedure)(opj_jp2_t * jp2, opj_stream_private_t *,
2428                              opj_event_mgr_t *) = 00;
2429     OPJ_BOOL l_result = OPJ_TRUE;
2430     OPJ_UINT32 l_nb_proc, i;
2431
2432     /* preconditions */
2433     assert(p_procedure_list != 00);
2434     assert(jp2 != 00);
2435     assert(stream != 00);
2436     assert(p_manager != 00);
2437
2438     l_nb_proc = opj_procedure_list_get_nb_procedures(p_procedure_list);
2439     l_procedure = (OPJ_BOOL(**)(opj_jp2_t * jp2, opj_stream_private_t *,
2440                                 opj_event_mgr_t *)) opj_procedure_list_get_first_procedure(p_procedure_list);
2441
2442     for (i = 0; i < l_nb_proc; ++i) {
2443         l_result = l_result && (*l_procedure)(jp2, stream, p_manager);
2444         ++l_procedure;
2445     }
2446
2447     /* and clear the procedure list at the end. */
2448     opj_procedure_list_clear(p_procedure_list);
2449     return l_result;
2450 }
2451
2452 OPJ_BOOL opj_jp2_start_compress(opj_jp2_t *jp2,
2453                                 opj_stream_private_t *stream,
2454                                 opj_image_t * p_image,
2455                                 opj_event_mgr_t * p_manager
2456                                )
2457 {
2458     /* preconditions */
2459     assert(jp2 != 00);
2460     assert(stream != 00);
2461     assert(p_manager != 00);
2462
2463     /* customization of the validation */
2464     if (! opj_jp2_setup_encoding_validation(jp2, p_manager)) {
2465         return OPJ_FALSE;
2466     }
2467
2468     /* validation of the parameters codec */
2469     if (! opj_jp2_exec(jp2, jp2->m_validation_list, stream, p_manager)) {
2470         return OPJ_FALSE;
2471     }
2472
2473     /* customization of the encoding */
2474     if (! opj_jp2_setup_header_writing(jp2, p_manager)) {
2475         return OPJ_FALSE;
2476     }
2477
2478     /* write header */
2479     if (! opj_jp2_exec(jp2, jp2->m_procedure_list, stream, p_manager)) {
2480         return OPJ_FALSE;
2481     }
2482
2483     return opj_j2k_start_compress(jp2->j2k, stream, p_image, p_manager);
2484 }
2485
2486 static const opj_jp2_header_handler_t * opj_jp2_find_handler(OPJ_UINT32 p_id)
2487 {
2488     OPJ_UINT32 i, l_handler_size = sizeof(jp2_header) / sizeof(
2489                                        opj_jp2_header_handler_t);
2490
2491     for (i = 0; i < l_handler_size; ++i) {
2492         if (jp2_header[i].id == p_id) {
2493             return &jp2_header[i];
2494         }
2495     }
2496     return NULL;
2497 }
2498
2499 /**
2500  * Finds the image execution function related to the given box id.
2501  *
2502  * @param   p_id    the id of the handler to fetch.
2503  *
2504  * @return  the given handler or 00 if it could not be found.
2505  */
2506 static const opj_jp2_header_handler_t * opj_jp2_img_find_handler(
2507     OPJ_UINT32 p_id)
2508 {
2509     OPJ_UINT32 i, l_handler_size = sizeof(jp2_img_header) / sizeof(
2510                                        opj_jp2_header_handler_t);
2511     for (i = 0; i < l_handler_size; ++i) {
2512         if (jp2_img_header[i].id == p_id) {
2513             return &jp2_img_header[i];
2514         }
2515     }
2516
2517     return NULL;
2518 }
2519
2520 /**
2521  * Reads a jpeg2000 file signature box.
2522  *
2523  * @param   p_header_data   the data contained in the signature box.
2524  * @param   jp2             the jpeg2000 file codec.
2525  * @param   p_header_size   the size of the data contained in the signature box.
2526  * @param   p_manager       the user event manager.
2527  *
2528  * @return true if the file signature box is valid.
2529  */
2530 static OPJ_BOOL opj_jp2_read_jp(opj_jp2_t *jp2,
2531                                 OPJ_BYTE * p_header_data,
2532                                 OPJ_UINT32 p_header_size,
2533                                 opj_event_mgr_t * p_manager
2534                                )
2535
2536 {
2537     OPJ_UINT32 l_magic_number;
2538
2539     /* preconditions */
2540     assert(p_header_data != 00);
2541     assert(jp2 != 00);
2542     assert(p_manager != 00);
2543
2544     if (jp2->jp2_state != JP2_STATE_NONE) {
2545         opj_event_msg(p_manager, EVT_ERROR,
2546                       "The signature box must be the first box in the file.\n");
2547         return OPJ_FALSE;
2548     }
2549
2550     /* assure length of data is correct (4 -> magic number) */
2551     if (p_header_size != 4) {
2552         opj_event_msg(p_manager, EVT_ERROR, "Error with JP signature Box size\n");
2553         return OPJ_FALSE;
2554     }
2555
2556     /* rearrange data */
2557     opj_read_bytes(p_header_data, &l_magic_number, 4);
2558     if (l_magic_number != 0x0d0a870a) {
2559         opj_event_msg(p_manager, EVT_ERROR,
2560                       "Error with JP Signature : bad magic number\n");
2561         return OPJ_FALSE;
2562     }
2563
2564     jp2->jp2_state |= JP2_STATE_SIGNATURE;
2565
2566     return OPJ_TRUE;
2567 }
2568
2569 /**
2570  * Reads a a FTYP box - File type box
2571  *
2572  * @param   p_header_data   the data contained in the FTYP box.
2573  * @param   jp2             the jpeg2000 file codec.
2574  * @param   p_header_size   the size of the data contained in the FTYP box.
2575  * @param   p_manager       the user event manager.
2576  *
2577  * @return true if the FTYP box is valid.
2578  */
2579 static OPJ_BOOL opj_jp2_read_ftyp(opj_jp2_t *jp2,
2580                                   OPJ_BYTE * p_header_data,
2581                                   OPJ_UINT32 p_header_size,
2582                                   opj_event_mgr_t * p_manager
2583                                  )
2584 {
2585     OPJ_UINT32 i, l_remaining_bytes;
2586
2587     /* preconditions */
2588     assert(p_header_data != 00);
2589     assert(jp2 != 00);
2590     assert(p_manager != 00);
2591
2592     if (jp2->jp2_state != JP2_STATE_SIGNATURE) {
2593         opj_event_msg(p_manager, EVT_ERROR,
2594                       "The ftyp box must be the second box in the file.\n");
2595         return OPJ_FALSE;
2596     }
2597
2598     /* assure length of data is correct */
2599     if (p_header_size < 8) {
2600         opj_event_msg(p_manager, EVT_ERROR, "Error with FTYP signature Box size\n");
2601         return OPJ_FALSE;
2602     }
2603
2604     opj_read_bytes(p_header_data, &jp2->brand, 4);      /* BR */
2605     p_header_data += 4;
2606
2607     opj_read_bytes(p_header_data, &jp2->minversion, 4);     /* MinV */
2608     p_header_data += 4;
2609
2610     l_remaining_bytes = p_header_size - 8;
2611
2612     /* the number of remaining bytes should be a multiple of 4 */
2613     if ((l_remaining_bytes & 0x3) != 0) {
2614         opj_event_msg(p_manager, EVT_ERROR, "Error with FTYP signature Box size\n");
2615         return OPJ_FALSE;
2616     }
2617
2618     /* div by 4 */
2619     jp2->numcl = l_remaining_bytes >> 2;
2620     if (jp2->numcl) {
2621         jp2->cl = (OPJ_UINT32 *) opj_calloc(jp2->numcl, sizeof(OPJ_UINT32));
2622         if (jp2->cl == 00) {
2623             opj_event_msg(p_manager, EVT_ERROR, "Not enough memory with FTYP Box\n");
2624             return OPJ_FALSE;
2625         }
2626     }
2627
2628     for (i = 0; i < jp2->numcl; ++i) {
2629         opj_read_bytes(p_header_data, &jp2->cl[i], 4);      /* CLi */
2630         p_header_data += 4;
2631     }
2632
2633     jp2->jp2_state |= JP2_STATE_FILE_TYPE;
2634
2635     return OPJ_TRUE;
2636 }
2637
2638 static OPJ_BOOL opj_jp2_skip_jp2c(opj_jp2_t *jp2,
2639                                   opj_stream_private_t *stream,
2640                                   opj_event_mgr_t * p_manager)
2641 {
2642     /* preconditions */
2643     assert(jp2 != 00);
2644     assert(stream != 00);
2645     assert(p_manager != 00);
2646
2647     jp2->j2k_codestream_offset = opj_stream_tell(stream);
2648
2649     if (opj_stream_skip(stream, 8, p_manager) != 8) {
2650         return OPJ_FALSE;
2651     }
2652
2653     return OPJ_TRUE;
2654 }
2655
2656 static OPJ_BOOL opj_jpip_skip_iptr(opj_jp2_t *jp2,
2657                                    opj_stream_private_t *stream,
2658                                    opj_event_mgr_t * p_manager)
2659 {
2660     /* preconditions */
2661     assert(jp2 != 00);
2662     assert(stream != 00);
2663     assert(p_manager != 00);
2664
2665     jp2->jpip_iptr_offset = opj_stream_tell(stream);
2666
2667     if (opj_stream_skip(stream, 24, p_manager) != 24) {
2668         return OPJ_FALSE;
2669     }
2670
2671     return OPJ_TRUE;
2672 }
2673
2674 /**
2675  * Reads the Jpeg2000 file Header box - JP2 Header box (warning, this is a super box).
2676  *
2677  * @param   p_header_data   the data contained in the file header box.
2678  * @param   jp2             the jpeg2000 file codec.
2679  * @param   p_header_size   the size of the data contained in the file header box.
2680  * @param   p_manager       the user event manager.
2681  *
2682  * @return true if the JP2 Header box was successfully recognized.
2683 */
2684 static OPJ_BOOL opj_jp2_read_jp2h(opj_jp2_t *jp2,
2685                                   OPJ_BYTE *p_header_data,
2686                                   OPJ_UINT32 p_header_size,
2687                                   opj_event_mgr_t * p_manager
2688                                  )
2689 {
2690     OPJ_UINT32 l_box_size = 0, l_current_data_size = 0;
2691     opj_jp2_box_t box;
2692     const opj_jp2_header_handler_t * l_current_handler;
2693     OPJ_BOOL l_has_ihdr = 0;
2694
2695     /* preconditions */
2696     assert(p_header_data != 00);
2697     assert(jp2 != 00);
2698     assert(p_manager != 00);
2699
2700     /* make sure the box is well placed */
2701     if ((jp2->jp2_state & JP2_STATE_FILE_TYPE) != JP2_STATE_FILE_TYPE) {
2702         opj_event_msg(p_manager, EVT_ERROR,
2703                       "The  box must be the first box in the file.\n");
2704         return OPJ_FALSE;
2705     }
2706
2707     jp2->jp2_img_state = JP2_IMG_STATE_NONE;
2708
2709     /* iterate while remaining data */
2710     while (p_header_size > 0) {
2711
2712         if (! opj_jp2_read_boxhdr_char(&box, p_header_data, &l_box_size, p_header_size,
2713                                        p_manager)) {
2714             opj_event_msg(p_manager, EVT_ERROR,
2715                           "Stream error while reading JP2 Header box\n");
2716             return OPJ_FALSE;
2717         }
2718
2719         if (box.length > p_header_size) {
2720             opj_event_msg(p_manager, EVT_ERROR,
2721                           "Stream error while reading JP2 Header box: box length is inconsistent.\n");
2722             return OPJ_FALSE;
2723         }
2724
2725         l_current_handler = opj_jp2_img_find_handler(box.type);
2726         l_current_data_size = box.length - l_box_size;
2727         p_header_data += l_box_size;
2728
2729         if (l_current_handler != 00) {
2730             if (! l_current_handler->handler(jp2, p_header_data, l_current_data_size,
2731                                              p_manager)) {
2732                 return OPJ_FALSE;
2733             }
2734         } else {
2735             jp2->jp2_img_state |= JP2_IMG_STATE_UNKNOWN;
2736         }
2737
2738         if (box.type == JP2_IHDR) {
2739             l_has_ihdr = 1;
2740         }
2741
2742         p_header_data += l_current_data_size;
2743         p_header_size -= box.length;
2744     }
2745
2746     if (l_has_ihdr == 0) {
2747         opj_event_msg(p_manager, EVT_ERROR,
2748                       "Stream error while reading JP2 Header box: no 'ihdr' box.\n");
2749         return OPJ_FALSE;
2750     }
2751
2752     jp2->jp2_state |= JP2_STATE_HEADER;
2753     jp2->has_jp2h = 1;
2754
2755     return OPJ_TRUE;
2756 }
2757
2758 static OPJ_BOOL opj_jp2_read_boxhdr_char(opj_jp2_box_t *box,
2759         OPJ_BYTE * p_data,
2760         OPJ_UINT32 * p_number_bytes_read,
2761         OPJ_UINT32 p_box_max_size,
2762         opj_event_mgr_t * p_manager
2763                                         )
2764 {
2765     OPJ_UINT32 l_value;
2766
2767     /* preconditions */
2768     assert(p_data != 00);
2769     assert(box != 00);
2770     assert(p_number_bytes_read != 00);
2771     assert(p_manager != 00);
2772
2773     if (p_box_max_size < 8) {
2774         opj_event_msg(p_manager, EVT_ERROR, "Cannot handle box of less than 8 bytes\n");
2775         return OPJ_FALSE;
2776     }
2777
2778     /* process read data */
2779     opj_read_bytes(p_data, &l_value, 4);
2780     p_data += 4;
2781     box->length = (OPJ_UINT32)(l_value);
2782
2783     opj_read_bytes(p_data, &l_value, 4);
2784     p_data += 4;
2785     box->type = (OPJ_UINT32)(l_value);
2786
2787     *p_number_bytes_read = 8;
2788
2789     /* do we have a "special very large box ?" */
2790     /* read then the XLBox */
2791     if (box->length == 1) {
2792         OPJ_UINT32 l_xl_part_size;
2793
2794         if (p_box_max_size < 16) {
2795             opj_event_msg(p_manager, EVT_ERROR,
2796                           "Cannot handle XL box of less than 16 bytes\n");
2797             return OPJ_FALSE;
2798         }
2799
2800         opj_read_bytes(p_data, &l_xl_part_size, 4);
2801         p_data += 4;
2802         *p_number_bytes_read += 4;
2803
2804         if (l_xl_part_size != 0) {
2805             opj_event_msg(p_manager, EVT_ERROR,
2806                           "Cannot handle box sizes higher than 2^32\n");
2807             return OPJ_FALSE;
2808         }
2809
2810         opj_read_bytes(p_data, &l_value, 4);
2811         *p_number_bytes_read += 4;
2812         box->length = (OPJ_UINT32)(l_value);
2813
2814         if (box->length == 0) {
2815             opj_event_msg(p_manager, EVT_ERROR, "Cannot handle box of undefined sizes\n");
2816             return OPJ_FALSE;
2817         }
2818     } else if (box->length == 0) {
2819         opj_event_msg(p_manager, EVT_ERROR, "Cannot handle box of undefined sizes\n");
2820         return OPJ_FALSE;
2821     }
2822     if (box->length < *p_number_bytes_read) {
2823         opj_event_msg(p_manager, EVT_ERROR, "Box length is inconsistent.\n");
2824         return OPJ_FALSE;
2825     }
2826     return OPJ_TRUE;
2827 }
2828
2829 OPJ_BOOL opj_jp2_read_header(opj_stream_private_t *p_stream,
2830                              opj_jp2_t *jp2,
2831                              opj_image_t ** p_image,
2832                              opj_event_mgr_t * p_manager
2833                             )
2834 {
2835     /* preconditions */
2836     assert(jp2 != 00);
2837     assert(p_stream != 00);
2838     assert(p_manager != 00);
2839
2840     /* customization of the validation */
2841     if (! opj_jp2_setup_decoding_validation(jp2, p_manager)) {
2842         return OPJ_FALSE;
2843     }
2844
2845     /* customization of the encoding */
2846     if (! opj_jp2_setup_header_reading(jp2, p_manager)) {
2847         return OPJ_FALSE;
2848     }
2849
2850     /* validation of the parameters codec */
2851     if (! opj_jp2_exec(jp2, jp2->m_validation_list, p_stream, p_manager)) {
2852         return OPJ_FALSE;
2853     }
2854
2855     /* read header */
2856     if (! opj_jp2_exec(jp2, jp2->m_procedure_list, p_stream, p_manager)) {
2857         return OPJ_FALSE;
2858     }
2859     if (jp2->has_jp2h == 0) {
2860         opj_event_msg(p_manager, EVT_ERROR, "JP2H box missing. Required.\n");
2861         return OPJ_FALSE;
2862     }
2863     if (jp2->has_ihdr == 0) {
2864         opj_event_msg(p_manager, EVT_ERROR, "IHDR box_missing. Required.\n");
2865         return OPJ_FALSE;
2866     }
2867
2868     return opj_j2k_read_header(p_stream,
2869                                jp2->j2k,
2870                                p_image,
2871                                p_manager);
2872 }
2873
2874 static OPJ_BOOL opj_jp2_setup_encoding_validation(opj_jp2_t *jp2,
2875         opj_event_mgr_t * p_manager)
2876 {
2877     /* preconditions */
2878     assert(jp2 != 00);
2879     assert(p_manager != 00);
2880
2881     if (! opj_procedure_list_add_procedure(jp2->m_validation_list,
2882                                            (opj_procedure)opj_jp2_default_validation, p_manager)) {
2883         return OPJ_FALSE;
2884     }
2885     /* DEVELOPER CORNER, add your custom validation procedure */
2886
2887     return OPJ_TRUE;
2888 }
2889
2890 static OPJ_BOOL opj_jp2_setup_decoding_validation(opj_jp2_t *jp2,
2891         opj_event_mgr_t * p_manager)
2892 {
2893     /* preconditions */
2894     assert(jp2 != 00);
2895     assert(p_manager != 00);
2896
2897     OPJ_UNUSED(jp2);
2898     OPJ_UNUSED(p_manager);
2899
2900     /* DEVELOPER CORNER, add your custom validation procedure */
2901
2902     return OPJ_TRUE;
2903 }
2904
2905 static OPJ_BOOL opj_jp2_setup_header_writing(opj_jp2_t *jp2,
2906         opj_event_mgr_t * p_manager)
2907 {
2908     /* preconditions */
2909     assert(jp2 != 00);
2910     assert(p_manager != 00);
2911
2912     if (! opj_procedure_list_add_procedure(jp2->m_procedure_list,
2913                                            (opj_procedure)opj_jp2_write_jp, p_manager)) {
2914         return OPJ_FALSE;
2915     }
2916     if (! opj_procedure_list_add_procedure(jp2->m_procedure_list,
2917                                            (opj_procedure)opj_jp2_write_ftyp, p_manager)) {
2918         return OPJ_FALSE;
2919     }
2920     if (! opj_procedure_list_add_procedure(jp2->m_procedure_list,
2921                                            (opj_procedure)opj_jp2_write_jp2h, p_manager)) {
2922         return OPJ_FALSE;
2923     }
2924     if (jp2->jpip_on) {
2925         if (! opj_procedure_list_add_procedure(jp2->m_procedure_list,
2926                                                (opj_procedure)opj_jpip_skip_iptr, p_manager)) {
2927             return OPJ_FALSE;
2928         }
2929     }
2930     if (! opj_procedure_list_add_procedure(jp2->m_procedure_list,
2931                                            (opj_procedure)opj_jp2_skip_jp2c, p_manager)) {
2932         return OPJ_FALSE;
2933     }
2934
2935     /* DEVELOPER CORNER, insert your custom procedures */
2936
2937     return OPJ_TRUE;
2938 }
2939
2940 static OPJ_BOOL opj_jp2_setup_header_reading(opj_jp2_t *jp2,
2941         opj_event_mgr_t * p_manager)
2942 {
2943     /* preconditions */
2944     assert(jp2 != 00);
2945     assert(p_manager != 00);
2946
2947     if (! opj_procedure_list_add_procedure(jp2->m_procedure_list,
2948                                            (opj_procedure)opj_jp2_read_header_procedure, p_manager)) {
2949         return OPJ_FALSE;
2950     }
2951
2952     /* DEVELOPER CORNER, add your custom procedures */
2953
2954     return OPJ_TRUE;
2955 }
2956
2957 OPJ_BOOL opj_jp2_read_tile_header(opj_jp2_t * p_jp2,
2958                                   OPJ_UINT32 * p_tile_index,
2959                                   OPJ_UINT32 * p_data_size,
2960                                   OPJ_INT32 * p_tile_x0,
2961                                   OPJ_INT32 * p_tile_y0,
2962                                   OPJ_INT32 * p_tile_x1,
2963                                   OPJ_INT32 * p_tile_y1,
2964                                   OPJ_UINT32 * p_nb_comps,
2965                                   OPJ_BOOL * p_go_on,
2966                                   opj_stream_private_t *p_stream,
2967                                   opj_event_mgr_t * p_manager
2968                                  )
2969 {
2970     return opj_j2k_read_tile_header(p_jp2->j2k,
2971                                     p_tile_index,
2972                                     p_data_size,
2973                                     p_tile_x0, p_tile_y0,
2974                                     p_tile_x1, p_tile_y1,
2975                                     p_nb_comps,
2976                                     p_go_on,
2977                                     p_stream,
2978                                     p_manager);
2979 }
2980
2981 OPJ_BOOL opj_jp2_write_tile(opj_jp2_t *p_jp2,
2982                             OPJ_UINT32 p_tile_index,
2983                             OPJ_BYTE * p_data,
2984                             OPJ_UINT32 p_data_size,
2985                             opj_stream_private_t *p_stream,
2986                             opj_event_mgr_t * p_manager
2987                            )
2988
2989 {
2990     return opj_j2k_write_tile(p_jp2->j2k, p_tile_index, p_data, p_data_size,
2991                               p_stream, p_manager);
2992 }
2993
2994 OPJ_BOOL opj_jp2_decode_tile(opj_jp2_t * p_jp2,
2995                              OPJ_UINT32 p_tile_index,
2996                              OPJ_BYTE * p_data,
2997                              OPJ_UINT32 p_data_size,
2998                              opj_stream_private_t *p_stream,
2999                              opj_event_mgr_t * p_manager
3000                             )
3001 {
3002     return opj_j2k_decode_tile(p_jp2->j2k, p_tile_index, p_data, p_data_size,
3003                                p_stream, p_manager);
3004 }
3005
3006 void opj_jp2_destroy(opj_jp2_t *jp2)
3007 {
3008     if (jp2) {
3009         /* destroy the J2K codec */
3010         opj_j2k_destroy(jp2->j2k);
3011         jp2->j2k = 00;
3012
3013         if (jp2->comps) {
3014             opj_free(jp2->comps);
3015             jp2->comps = 00;
3016         }
3017
3018         if (jp2->cl) {
3019             opj_free(jp2->cl);
3020             jp2->cl = 00;
3021         }
3022
3023         if (jp2->color.icc_profile_buf) {
3024             opj_free(jp2->color.icc_profile_buf);
3025             jp2->color.icc_profile_buf = 00;
3026         }
3027
3028         if (jp2->color.jp2_cdef) {
3029             if (jp2->color.jp2_cdef->info) {
3030                 opj_free(jp2->color.jp2_cdef->info);
3031                 jp2->color.jp2_cdef->info = NULL;
3032             }
3033
3034             opj_free(jp2->color.jp2_cdef);
3035             jp2->color.jp2_cdef = 00;
3036         }
3037
3038         if (jp2->color.jp2_pclr) {
3039             if (jp2->color.jp2_pclr->cmap) {
3040                 opj_free(jp2->color.jp2_pclr->cmap);
3041                 jp2->color.jp2_pclr->cmap = NULL;
3042             }
3043             if (jp2->color.jp2_pclr->channel_sign) {
3044                 opj_free(jp2->color.jp2_pclr->channel_sign);
3045                 jp2->color.jp2_pclr->channel_sign = NULL;
3046             }
3047             if (jp2->color.jp2_pclr->channel_size) {
3048                 opj_free(jp2->color.jp2_pclr->channel_size);
3049                 jp2->color.jp2_pclr->channel_size = NULL;
3050             }
3051             if (jp2->color.jp2_pclr->entries) {
3052                 opj_free(jp2->color.jp2_pclr->entries);
3053                 jp2->color.jp2_pclr->entries = NULL;
3054             }
3055
3056             opj_free(jp2->color.jp2_pclr);
3057             jp2->color.jp2_pclr = 00;
3058         }
3059
3060         if (jp2->m_validation_list) {
3061             opj_procedure_list_destroy(jp2->m_validation_list);
3062             jp2->m_validation_list = 00;
3063         }
3064
3065         if (jp2->m_procedure_list) {
3066             opj_procedure_list_destroy(jp2->m_procedure_list);
3067             jp2->m_procedure_list = 00;
3068         }
3069
3070         opj_free(jp2);
3071     }
3072 }
3073
3074 OPJ_BOOL opj_jp2_set_decoded_components(opj_jp2_t *p_jp2,
3075                                         OPJ_UINT32 numcomps,
3076                                         const OPJ_UINT32* comps_indices,
3077                                         opj_event_mgr_t * p_manager)
3078 {
3079     return opj_j2k_set_decoded_components(p_jp2->j2k,
3080                                           numcomps, comps_indices,
3081                                           p_manager);
3082 }
3083
3084 OPJ_BOOL opj_jp2_set_decode_area(opj_jp2_t *p_jp2,
3085                                  opj_image_t* p_image,
3086                                  OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
3087                                  OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
3088                                  opj_event_mgr_t * p_manager
3089                                 )
3090 {
3091     return opj_j2k_set_decode_area(p_jp2->j2k, p_image, p_start_x, p_start_y,
3092                                    p_end_x, p_end_y, p_manager);
3093 }
3094
3095 OPJ_BOOL opj_jp2_get_tile(opj_jp2_t *p_jp2,
3096                           opj_stream_private_t *p_stream,
3097                           opj_image_t* p_image,
3098                           opj_event_mgr_t * p_manager,
3099                           OPJ_UINT32 tile_index
3100                          )
3101 {
3102     if (!p_image) {
3103         return OPJ_FALSE;
3104     }
3105
3106     opj_event_msg(p_manager, EVT_WARNING,
3107                   "JP2 box which are after the codestream will not be read by this function.\n");
3108
3109     if (! opj_j2k_get_tile(p_jp2->j2k, p_stream, p_image, p_manager, tile_index)) {
3110         opj_event_msg(p_manager, EVT_ERROR,
3111                       "Failed to decode the codestream in the JP2 file\n");
3112         return OPJ_FALSE;
3113     }
3114
3115     if (p_jp2->j2k->m_specific_param.m_decoder.m_numcomps_to_decode) {
3116         /* Bypass all JP2 component transforms */
3117         return OPJ_TRUE;
3118     }
3119
3120     if (!opj_jp2_check_color(p_image, &(p_jp2->color), p_manager)) {
3121         return OPJ_FALSE;
3122     }
3123
3124     /* Set Image Color Space */
3125     if (p_jp2->enumcs == 16) {
3126         p_image->color_space = OPJ_CLRSPC_SRGB;
3127     } else if (p_jp2->enumcs == 17) {
3128         p_image->color_space = OPJ_CLRSPC_GRAY;
3129     } else if (p_jp2->enumcs == 18) {
3130         p_image->color_space = OPJ_CLRSPC_SYCC;
3131     } else if (p_jp2->enumcs == 24) {
3132         p_image->color_space = OPJ_CLRSPC_EYCC;
3133     } else if (p_jp2->enumcs == 12) {
3134         p_image->color_space = OPJ_CLRSPC_CMYK;
3135     } else {
3136         p_image->color_space = OPJ_CLRSPC_UNKNOWN;
3137     }
3138
3139     if (p_jp2->color.jp2_pclr) {
3140         /* Part 1, I.5.3.4: Either both or none : */
3141         if (!p_jp2->color.jp2_pclr->cmap) {
3142             opj_jp2_free_pclr(&(p_jp2->color));
3143         } else {
3144             if (!opj_jp2_apply_pclr(p_image, &(p_jp2->color), p_manager)) {
3145                 return OPJ_FALSE;
3146             }
3147         }
3148     }
3149
3150     /* Apply the color space if needed */
3151     if (p_jp2->color.jp2_cdef) {
3152         opj_jp2_apply_cdef(p_image, &(p_jp2->color), p_manager);
3153     }
3154
3155     if (p_jp2->color.icc_profile_buf) {
3156         p_image->icc_profile_buf = p_jp2->color.icc_profile_buf;
3157         p_image->icc_profile_len = p_jp2->color.icc_profile_len;
3158         p_jp2->color.icc_profile_buf = NULL;
3159     }
3160
3161     return OPJ_TRUE;
3162 }
3163
3164 /* ----------------------------------------------------------------------- */
3165 /* JP2 encoder interface                                             */
3166 /* ----------------------------------------------------------------------- */
3167
3168 opj_jp2_t* opj_jp2_create(OPJ_BOOL p_is_decoder)
3169 {
3170     opj_jp2_t *jp2 = (opj_jp2_t*)opj_calloc(1, sizeof(opj_jp2_t));
3171     if (jp2) {
3172
3173         /* create the J2K codec */
3174         if (! p_is_decoder) {
3175             jp2->j2k = opj_j2k_create_compress();
3176         } else {
3177             jp2->j2k = opj_j2k_create_decompress();
3178         }
3179
3180         if (jp2->j2k == 00) {
3181             opj_jp2_destroy(jp2);
3182             return 00;
3183         }
3184
3185         /* Color structure */
3186         jp2->color.icc_profile_buf = NULL;
3187         jp2->color.icc_profile_len = 0;
3188         jp2->color.jp2_cdef = NULL;
3189         jp2->color.jp2_pclr = NULL;
3190         jp2->color.jp2_has_colr = 0;
3191
3192         /* validation list creation */
3193         jp2->m_validation_list = opj_procedure_list_create();
3194         if (! jp2->m_validation_list) {
3195             opj_jp2_destroy(jp2);
3196             return 00;
3197         }
3198
3199         /* execution list creation */
3200         jp2->m_procedure_list = opj_procedure_list_create();
3201         if (! jp2->m_procedure_list) {
3202             opj_jp2_destroy(jp2);
3203             return 00;
3204         }
3205     }
3206
3207     return jp2;
3208 }
3209
3210 void jp2_dump(opj_jp2_t* p_jp2, OPJ_INT32 flag, FILE* out_stream)
3211 {
3212     /* preconditions */
3213     assert(p_jp2 != 00);
3214
3215     j2k_dump(p_jp2->j2k,
3216              flag,
3217              out_stream);
3218 }
3219
3220 opj_codestream_index_t* jp2_get_cstr_index(opj_jp2_t* p_jp2)
3221 {
3222     return j2k_get_cstr_index(p_jp2->j2k);
3223 }
3224
3225 opj_codestream_info_v2_t* jp2_get_cstr_info(opj_jp2_t* p_jp2)
3226 {
3227     return j2k_get_cstr_info(p_jp2->j2k);
3228 }
3229
3230 OPJ_BOOL opj_jp2_set_decoded_resolution_factor(opj_jp2_t *p_jp2,
3231         OPJ_UINT32 res_factor,
3232         opj_event_mgr_t * p_manager)
3233 {
3234     return opj_j2k_set_decoded_resolution_factor(p_jp2->j2k, res_factor, p_manager);
3235 }
3236
3237 /* JPIP specific */
3238
3239 #ifdef USE_JPIP
3240 static OPJ_BOOL opj_jpip_write_iptr(opj_jp2_t *jp2,
3241                                     opj_stream_private_t *cio,
3242                                     opj_event_mgr_t * p_manager)
3243 {
3244     OPJ_OFF_T j2k_codestream_exit;
3245     OPJ_BYTE l_data_header [24];
3246
3247     /* preconditions */
3248     assert(jp2 != 00);
3249     assert(cio != 00);
3250     assert(p_manager != 00);
3251     assert(opj_stream_has_seek(cio));
3252
3253     j2k_codestream_exit = opj_stream_tell(cio);
3254     opj_write_bytes(l_data_header, 24, 4); /* size of iptr */
3255     opj_write_bytes(l_data_header + 4, JPIP_IPTR,
3256                     4);                                      /* IPTR */
3257 #if 0
3258     opj_write_bytes(l_data_header + 4 + 4, 0, 8); /* offset */
3259     opj_write_bytes(l_data_header + 8 + 8, 0, 8); /* length */
3260 #else
3261     opj_write_double(l_data_header + 4 + 4, 0); /* offset */
3262     opj_write_double(l_data_header + 8 + 8, 0); /* length */
3263 #endif
3264
3265     if (! opj_stream_seek(cio, jp2->jpip_iptr_offset, p_manager)) {
3266         opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
3267         return OPJ_FALSE;
3268     }
3269
3270     if (opj_stream_write_data(cio, l_data_header, 24, p_manager) != 24) {
3271         opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
3272         return OPJ_FALSE;
3273     }
3274
3275     if (! opj_stream_seek(cio, j2k_codestream_exit, p_manager)) {
3276         opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
3277         return OPJ_FALSE;
3278     }
3279
3280     return OPJ_TRUE;
3281 }
3282
3283 static OPJ_BOOL opj_jpip_write_fidx(opj_jp2_t *jp2,
3284                                     opj_stream_private_t *cio,
3285                                     opj_event_mgr_t * p_manager)
3286 {
3287     OPJ_OFF_T j2k_codestream_exit;
3288     OPJ_BYTE l_data_header [24];
3289
3290     OPJ_UNUSED(jp2);
3291
3292     /* preconditions */
3293     assert(jp2 != 00);
3294     assert(cio != 00);
3295     assert(p_manager != 00);
3296     assert(opj_stream_has_seek(cio));
3297
3298     opj_write_bytes(l_data_header, 24, 4); /* size of iptr */
3299     opj_write_bytes(l_data_header + 4, JPIP_FIDX,
3300                     4);                                      /* IPTR */
3301     opj_write_double(l_data_header + 4 + 4, 0); /* offset */
3302     opj_write_double(l_data_header + 8 + 8, 0); /* length */
3303
3304     if (opj_stream_write_data(cio, l_data_header, 24, p_manager) != 24) {
3305         opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
3306         return OPJ_FALSE;
3307     }
3308
3309     j2k_codestream_exit = opj_stream_tell(cio);
3310     if (! opj_stream_seek(cio, j2k_codestream_exit, p_manager)) {
3311         opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
3312         return OPJ_FALSE;
3313     }
3314
3315     return OPJ_TRUE;
3316 }
3317
3318 static OPJ_BOOL opj_jpip_write_cidx(opj_jp2_t *jp2,
3319                                     opj_stream_private_t *cio,
3320                                     opj_event_mgr_t * p_manager)
3321 {
3322     OPJ_OFF_T j2k_codestream_exit;
3323     OPJ_BYTE l_data_header [24];
3324
3325     OPJ_UNUSED(jp2);
3326
3327     /* preconditions */
3328     assert(jp2 != 00);
3329     assert(cio != 00);
3330     assert(p_manager != 00);
3331     assert(opj_stream_has_seek(cio));
3332
3333     j2k_codestream_exit = opj_stream_tell(cio);
3334     opj_write_bytes(l_data_header, 24, 4); /* size of iptr */
3335     opj_write_bytes(l_data_header + 4, JPIP_CIDX,
3336                     4);                                      /* IPTR */
3337 #if 0
3338     opj_write_bytes(l_data_header + 4 + 4, 0, 8); /* offset */
3339     opj_write_bytes(l_data_header + 8 + 8, 0, 8); /* length */
3340 #else
3341     opj_write_double(l_data_header + 4 + 4, 0); /* offset */
3342     opj_write_double(l_data_header + 8 + 8, 0); /* length */
3343 #endif
3344
3345     if (! opj_stream_seek(cio, j2k_codestream_exit, p_manager)) {
3346         opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
3347         return OPJ_FALSE;
3348     }
3349
3350     if (opj_stream_write_data(cio, l_data_header, 24, p_manager) != 24) {
3351         opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
3352         return OPJ_FALSE;
3353     }
3354
3355     j2k_codestream_exit = opj_stream_tell(cio);
3356     if (! opj_stream_seek(cio, j2k_codestream_exit, p_manager)) {
3357         opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
3358         return OPJ_FALSE;
3359     }
3360
3361     return OPJ_TRUE;
3362 }
3363
3364 #if 0
3365 static void write_prxy(int offset_jp2c, int length_jp2c, int offset_idx,
3366                        int length_idx, opj_stream_private_t *cio,
3367                        opj_event_mgr_t * p_manager)
3368 {
3369     OPJ_BYTE l_data_header [8];
3370     OPJ_OFF_T len, lenp;
3371
3372     lenp = opj_stream_tell(cio);
3373     opj_stream_skip(cio, 4, p_manager);         /* L [at the end] */
3374     opj_write_bytes(l_data_header, JPIP_PRXY, 4); /* IPTR           */
3375     opj_stream_write_data(cio, l_data_header, 4, p_manager);
3376
3377     opj_write_bytes(l_data_header, offset_jp2c, 8);  /* OOFF           */
3378     opj_stream_write_data(cio, l_data_header, 8, p_manager);
3379     opj_write_bytes(l_data_header, length_jp2c, 4);  /* OBH part 1     */
3380     opj_write_bytes(l_data_header + 4, JP2_JP2C, 4); /* OBH part 2     */
3381     opj_stream_write_data(cio, l_data_header, 8, p_manager);
3382
3383     opj_write_bytes(l_data_header, 1, 1); /* NI             */
3384     opj_stream_write_data(cio, l_data_header, 1, p_manager);
3385
3386     opj_write_bytes(l_data_header, offset_idx, 8);   /* IOFF           */
3387     opj_stream_write_data(cio, l_data_header, 8, p_manager);
3388     opj_write_bytes(l_data_header, length_idx, 4);   /* IBH part 1     */
3389     opj_write_bytes(l_data_header + 4, JPIP_CIDX, 4);  /* IBH part 2     */
3390     opj_stream_write_data(cio, l_data_header, 8, p_manager);
3391
3392     len = opj_stream_tell(cio) - lenp;
3393     opj_stream_skip(cio, lenp, p_manager);
3394     opj_write_bytes(l_data_header, len, 4); /* L              */
3395     opj_stream_write_data(cio, l_data_header, 4, p_manager);
3396     opj_stream_seek(cio, lenp + len, p_manager);
3397 }
3398 #endif
3399
3400
3401 #if 0
3402 static int write_fidx(int offset_jp2c, int length_jp2c, int offset_idx,
3403                       int length_idx, opj_stream_private_t *cio,
3404                       opj_event_mgr_t * p_manager)
3405 {
3406     OPJ_BYTE l_data_header [4];
3407     OPJ_OFF_T len, lenp;
3408
3409     lenp = opj_stream_tell(cio);
3410     opj_stream_skip(cio, 4, p_manager);
3411     opj_write_bytes(l_data_header, JPIP_FIDX, 4); /* FIDX */
3412     opj_stream_write_data(cio, l_data_header, 4, p_manager);
3413
3414     write_prxy(offset_jp2c, length_jp2c, offset_idx, length_idx, cio, p_manager);
3415
3416     len = opj_stream_tell(cio) - lenp;
3417     opj_stream_skip(cio, lenp, p_manager);
3418     opj_write_bytes(l_data_header, len, 4); /* L              */
3419     opj_stream_write_data(cio, l_data_header, 4, p_manager);
3420     opj_stream_seek(cio, lenp + len, p_manager);
3421
3422     return len;
3423 }
3424 #endif
3425 #endif /* USE_JPIP */