2 * The copyright in this software is being made available under the 2-clauses
3 * BSD License, included below. This software may be subject to other third
4 * party and contributor rights, including patent rights, and no such rights
5 * are granted under this license.
7 * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
8 * Copyright (c) 2002-2014, Professor Benoit Macq
9 * Copyright (c) 2001-2003, David Janssens
10 * Copyright (c) 2002-2003, Yannick Verschueren
11 * Copyright (c) 2003-2007, Francois-Olivier Devaux
12 * Copyright (c) 2003-2014, Antonin Descampe
13 * Copyright (c) 2005, Herve Drolon, FreeImage Team
14 * Copyright (c) 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.
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
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.
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.
40 #include "opj_includes.h"
42 /** @defgroup JP2 JP2 - JPEG-2000 file format reader/writer */
45 #define OPJ_BOX_SIZE 1024
47 /** @name Local static functions */
50 /*static void jp2_write_url(opj_cio_t *cio, char *Idx_file);*/
53 * Reads a IHDR box - Image Header box
55 * @param p_image_header_data pointer to actual data (already read from file)
56 * @param jp2 the jpeg2000 file codec.
57 * @param p_image_header_size the size of the image header
58 * @param p_manager the user event manager.
60 * @return true if the image header is valid, false else.
62 static OPJ_BOOL opj_jp2_read_ihdr( opj_jp2_t *jp2,
63 OPJ_BYTE *p_image_header_data,
64 OPJ_UINT32 p_image_header_size,
65 opj_event_mgr_t * p_manager );
68 * Writes the Image Header box - Image Header box.
70 * @param jp2 jpeg2000 file codec.
71 * @param p_nb_bytes_written pointer to store the nb of bytes written by the function.
73 * @return the data being copied.
75 static OPJ_BYTE * opj_jp2_write_ihdr(opj_jp2_t *jp2,
76 OPJ_UINT32 * p_nb_bytes_written );
79 * Writes the Bit per Component box.
81 * @param jp2 jpeg2000 file codec.
82 * @param p_nb_bytes_written pointer to store the nb of bytes written by the function.
84 * @return the data being copied.
86 static OPJ_BYTE * opj_jp2_write_bpcc( opj_jp2_t *jp2,
87 OPJ_UINT32 * p_nb_bytes_written );
90 * Reads a Bit per Component box.
92 * @param p_bpc_header_data pointer to actual data (already read from file)
93 * @param jp2 the jpeg2000 file codec.
94 * @param p_bpc_header_size the size of the bpc header
95 * @param p_manager the user event manager.
97 * @return true if the bpc header is valid, fale else.
99 static OPJ_BOOL opj_jp2_read_bpcc( opj_jp2_t *jp2,
100 OPJ_BYTE * p_bpc_header_data,
101 OPJ_UINT32 p_bpc_header_size,
102 opj_event_mgr_t * p_manager );
104 static OPJ_BOOL opj_jp2_read_cdef( opj_jp2_t * jp2,
105 OPJ_BYTE * p_cdef_header_data,
106 OPJ_UINT32 p_cdef_header_size,
107 opj_event_mgr_t * p_manager );
109 static void opj_jp2_apply_cdef(opj_image_t *image, opj_jp2_color_t *color);
112 * Writes the Colour Specification box.
114 * @param jp2 jpeg2000 file codec.
115 * @param p_nb_bytes_written pointer to store the nb of bytes written by the function.
117 * @return the data being copied.
119 static OPJ_BYTE * opj_jp2_write_colr( opj_jp2_t *jp2,
120 OPJ_UINT32 * p_nb_bytes_written );
123 * Writes a FTYP box - File type box
125 * @param cio the stream to write data to.
126 * @param jp2 the jpeg2000 file codec.
127 * @param p_manager the user event manager.
129 * @return true if writing was successful.
131 static OPJ_BOOL opj_jp2_write_ftyp( opj_jp2_t *jp2,
132 opj_stream_private_t *cio,
133 opj_event_mgr_t * p_manager );
136 * Reads a a FTYP box - File type box
138 * @param p_header_data the data contained in the FTYP box.
139 * @param jp2 the jpeg2000 file codec.
140 * @param p_header_size the size of the data contained in the FTYP box.
141 * @param p_manager the user event manager.
143 * @return true if the FTYP box is valid.
145 static OPJ_BOOL opj_jp2_read_ftyp( opj_jp2_t *jp2,
146 OPJ_BYTE * p_header_data,
147 OPJ_UINT32 p_header_size,
148 opj_event_mgr_t * p_manager );
150 OPJ_BOOL opj_jp2_skip_jp2c( opj_jp2_t *jp2,
151 opj_stream_private_t *cio,
152 opj_event_mgr_t * p_manager );
155 * Reads the Jpeg2000 file Header box - JP2 Header box (warning, this is a super box).
157 * @param p_header_data the data contained in the file header box.
158 * @param jp2 the jpeg2000 file codec.
159 * @param p_header_size the size of the data contained in the file header box.
160 * @param p_manager the user event manager.
162 * @return true if the JP2 Header box was successfully reconized.
164 static OPJ_BOOL opj_jp2_read_jp2h( opj_jp2_t *jp2,
165 OPJ_BYTE *p_header_data,
166 OPJ_UINT32 p_header_size,
167 opj_event_mgr_t * p_manager );
170 * Writes the Jpeg2000 codestream Header box - JP2C Header box. This function must be called AFTER the coding has been done.
172 * @param cio the stream to write data to.
173 * @param jp2 the jpeg2000 file codec.
174 * @param p_manager user event manager.
176 * @return true if writing was successful.
178 static OPJ_BOOL opj_jp2_write_jp2c( opj_jp2_t *jp2,
179 opj_stream_private_t *cio,
180 opj_event_mgr_t * p_manager );
184 * Write index Finder box
185 * @param cio the stream to write to.
186 * @param jp2 the jpeg2000 file codec.
187 * @param p_manager user event manager.
189 static OPJ_BOOL opj_jpip_write_iptr( opj_jp2_t *jp2,
190 opj_stream_private_t *cio,
191 opj_event_mgr_t * p_manager );
194 * Write index Finder box
195 * @param cio the stream to write to.
196 * @param jp2 the jpeg2000 file codec.
197 * @param p_manager user event manager.
199 static OPJ_BOOL opj_jpip_write_cidx(opj_jp2_t *jp2,
200 opj_stream_private_t *cio,
201 opj_event_mgr_t * p_manager );
204 * Write file Index (superbox)
205 * @param cio the stream to write to.
206 * @param jp2 the jpeg2000 file codec.
207 * @param p_manager user event manager.
209 static OPJ_BOOL opj_jpip_write_fidx(opj_jp2_t *jp2,
210 opj_stream_private_t *cio,
211 opj_event_mgr_t * p_manager );
212 #endif /* USE_JPIP */
215 * Reads a jpeg2000 file signature box.
217 * @param p_header_data the data contained in the signature box.
218 * @param jp2 the jpeg2000 file codec.
219 * @param p_header_size the size of the data contained in the signature box.
220 * @param p_manager the user event manager.
222 * @return true if the file signature box is valid.
224 static OPJ_BOOL opj_jp2_read_jp(opj_jp2_t *jp2,
225 OPJ_BYTE * p_header_data,
226 OPJ_UINT32 p_header_size,
227 opj_event_mgr_t * p_manager);
230 * Writes a jpeg2000 file signature box.
232 * @param cio the stream to write data to.
233 * @param jp2 the jpeg2000 file codec.
234 * @param p_manager the user event manager.
236 * @return true if writing was successful.
238 static OPJ_BOOL opj_jp2_write_jp( opj_jp2_t *jp2,
239 opj_stream_private_t *cio,
240 opj_event_mgr_t * p_manager );
243 Apply collected palette data
244 @param color Collector for profile, cdef and pclr data
247 static void opj_jp2_apply_pclr(opj_image_t *image, opj_jp2_color_t *color);
249 static void opj_jp2_free_pclr(opj_jp2_color_t *color);
252 * Collect palette data
254 * @param jp2 JP2 handle
255 * @param p_pclr_header_data FIXME DOC
256 * @param p_pclr_header_size FIXME DOC
259 * @return Returns true if successful, returns false otherwise
261 static OPJ_BOOL opj_jp2_read_pclr( opj_jp2_t *jp2,
262 OPJ_BYTE * p_pclr_header_data,
263 OPJ_UINT32 p_pclr_header_size,
264 opj_event_mgr_t * p_manager );
267 * Collect component mapping data
269 * @param jp2 JP2 handle
270 * @param p_cmap_header_data FIXME DOC
271 * @param p_cmap_header_size FIXME DOC
272 * @param p_manager FIXME DOC
274 * @return Returns true if successful, returns false otherwise
277 static OPJ_BOOL opj_jp2_read_cmap( opj_jp2_t * jp2,
278 OPJ_BYTE * p_cmap_header_data,
279 OPJ_UINT32 p_cmap_header_size,
280 opj_event_mgr_t * p_manager );
283 * Reads the Color Specification box.
285 * @param p_colr_header_data pointer to actual data (already read from file)
286 * @param jp2 the jpeg2000 file codec.
287 * @param p_colr_header_size the size of the color header
288 * @param p_manager the user event manager.
290 * @return true if the bpc header is valid, fale else.
292 static OPJ_BOOL opj_jp2_read_colr( opj_jp2_t *jp2,
293 OPJ_BYTE * p_colr_header_data,
294 OPJ_UINT32 p_colr_header_size,
295 opj_event_mgr_t * p_manager );
302 * Sets up the procedures to do on writing header after the codestream.
303 * Developpers wanting to extend the library can add their own writing procedures.
305 static void opj_jp2_setup_end_header_writing (opj_jp2_t *jp2);
308 * Sets up the procedures to do on reading header after the codestream.
309 * Developpers wanting to extend the library can add their own writing procedures.
311 static void opj_jp2_setup_end_header_reading (opj_jp2_t *jp2);
314 * Reads a jpeg2000 file header structure.
316 * @param jp2 the jpeg2000 file header structure.
317 * @param stream the stream to read data from.
318 * @param p_manager the user event manager.
320 * @return true if the box is valid.
322 static OPJ_BOOL opj_jp2_read_header_procedure( opj_jp2_t *jp2,
323 opj_stream_private_t *stream,
324 opj_event_mgr_t * p_manager );
327 * Excutes the given procedures on the given codec.
329 * @param p_procedure_list the list of procedures to execute
330 * @param jp2 the jpeg2000 file codec to execute the procedures on.
331 * @param stream the stream to execute the procedures on.
332 * @param p_manager the user manager.
334 * @return true if all the procedures were successfully executed.
336 static OPJ_BOOL opj_jp2_exec ( opj_jp2_t * jp2,
337 opj_procedure_list_t * p_procedure_list,
338 opj_stream_private_t *stream,
339 opj_event_mgr_t * p_manager );
342 * Reads a box header. The box is the way data is packed inside a jpeg2000 file structure.
344 * @param cio the input stream to read data from.
345 * @param box the box structure to fill.
346 * @param p_number_bytes_read pointer to an int that will store the number of bytes read from the stream (shoul usually be 2).
347 * @param p_manager user event manager.
349 * @return true if the box is reconized, false otherwise
351 static OPJ_BOOL opj_jp2_read_boxhdr(opj_jp2_box_t *box,
352 OPJ_UINT32 * p_number_bytes_read,
353 opj_stream_private_t *cio,
354 opj_event_mgr_t * p_manager);
357 * Sets up the validation ,i.e. adds the procedures to lauch to make sure the codec parameters
358 * are valid. Developpers wanting to extend the library can add their own validation procedures.
360 static void opj_jp2_setup_encoding_validation (opj_jp2_t *jp2);
363 * Sets up the procedures to do on writing header. Developpers wanting to extend the library can add their own writing procedures.
365 static void opj_jp2_setup_header_writing (opj_jp2_t *jp2);
367 OPJ_BOOL opj_jp2_default_validation ( opj_jp2_t * jp2,
368 opj_stream_private_t *cio,
369 opj_event_mgr_t * p_manager );
372 * Finds the image execution function related to the given box id.
374 * @param p_id the id of the handler to fetch.
376 * @return the given handler or NULL if it could not be found.
378 static const opj_jp2_header_handler_t * opj_jp2_img_find_handler (OPJ_UINT32 p_id);
381 * Finds the execution function related to the given box id.
383 * @param p_id the id of the handler to fetch.
385 * @return the given handler or NULL if it could not be found.
387 static const opj_jp2_header_handler_t * opj_jp2_find_handler (OPJ_UINT32 p_id );
389 const opj_jp2_header_handler_t jp2_header [] =
391 {JP2_JP,opj_jp2_read_jp},
392 {JP2_FTYP,opj_jp2_read_ftyp},
393 {JP2_JP2H,opj_jp2_read_jp2h}
396 const opj_jp2_header_handler_t jp2_img_header [] =
398 {JP2_IHDR,opj_jp2_read_ihdr},
399 {JP2_COLR,opj_jp2_read_colr},
400 {JP2_BPCC,opj_jp2_read_bpcc},
401 {JP2_PCLR,opj_jp2_read_pclr},
402 {JP2_CMAP,opj_jp2_read_cmap},
403 {JP2_CDEF,opj_jp2_read_cdef}
408 * Reads a box header. The box is the way data is packed inside a jpeg2000 file structure. Data is read from a character string
410 * @param box the box structure to fill.
411 * @param p_data the character string to read data from.
412 * @param p_number_bytes_read pointer to an int that will store the number of bytes read from the stream (shoul usually be 2).
413 * @param p_box_max_size the maximum number of bytes in the box.
414 * @param p_manager FIXME DOC
416 * @return true if the box is reconized, false otherwise
418 static OPJ_BOOL opj_jp2_read_boxhdr_char( opj_jp2_box_t *box,
420 OPJ_UINT32 * p_number_bytes_read,
421 OPJ_UINT32 p_box_max_size,
422 opj_event_mgr_t * p_manager );
425 * Sets up the validation ,i.e. adds the procedures to lauch to make sure the codec parameters
426 * are valid. Developpers wanting to extend the library can add their own validation procedures.
428 static void opj_jp2_setup_decoding_validation (opj_jp2_t *jp2);
431 * Sets up the procedures to do on reading header.
432 * Developpers wanting to extend the library can add their own writing procedures.
434 static void opj_jp2_setup_header_reading (opj_jp2_t *jp2);
436 /* ----------------------------------------------------------------------- */
437 OPJ_BOOL opj_jp2_read_boxhdr(opj_jp2_box_t *box,
438 OPJ_UINT32 * p_number_bytes_read,
439 opj_stream_private_t *cio,
440 opj_event_mgr_t * p_manager )
442 /* read header from file */
443 OPJ_BYTE l_data_header [8];
448 assert(p_number_bytes_read != 00);
449 assert(p_manager != 00);
451 *p_number_bytes_read = (OPJ_UINT32)opj_stream_read_data(cio,l_data_header,8,p_manager);
452 if (*p_number_bytes_read != 8) {
456 /* process read data */
457 opj_read_bytes(l_data_header,&(box->length), 4);
458 opj_read_bytes(l_data_header+4,&(box->type), 4);
460 if(box->length == 0)/* last box */
462 const OPJ_OFF_T bleft = opj_stream_get_number_byte_left(cio);
463 box->length = (OPJ_UINT32)bleft;
464 assert( (OPJ_OFF_T)box->length == bleft );
468 /* do we have a "special very large box ?" */
469 /* read then the XLBox */
470 if (box->length == 1) {
471 OPJ_UINT32 l_xl_part_size;
473 OPJ_UINT32 l_nb_bytes_read = (OPJ_UINT32)opj_stream_read_data(cio,l_data_header,8,p_manager);
474 if (l_nb_bytes_read != 8) {
475 if (l_nb_bytes_read > 0) {
476 *p_number_bytes_read += l_nb_bytes_read;
482 *p_number_bytes_read = 16;
483 opj_read_bytes(l_data_header,&l_xl_part_size, 4);
484 if (l_xl_part_size != 0) {
485 opj_event_msg(p_manager, EVT_ERROR, "Cannot handle box sizes higher than 2^32\n");
488 opj_read_bytes(l_data_header+4,&(box->length), 4);
494 static void jp2_write_url(opj_cio_t *cio, char *Idx_file) {
498 box.init_pos = cio_tell(cio);
500 cio_write(cio, JP2_URL, 4); /* DBTL */
501 cio_write(cio, 0, 1); /* VERS */
502 cio_write(cio, 0, 3); /* FLAG */
505 for (i = 0; i < strlen(Idx_file); i++) {
506 cio_write(cio, Idx_file[i], 1);
510 box.length = cio_tell(cio) - box.init_pos;
511 cio_seek(cio, box.init_pos);
512 cio_write(cio, box.length, 4); /* L */
513 cio_seek(cio, box.init_pos + box.length);
517 OPJ_BOOL opj_jp2_read_ihdr( opj_jp2_t *jp2,
518 OPJ_BYTE *p_image_header_data,
519 OPJ_UINT32 p_image_header_size,
520 opj_event_mgr_t * p_manager )
523 assert(p_image_header_data != 00);
525 assert(p_manager != 00);
527 if (p_image_header_size != 14) {
528 opj_event_msg(p_manager, EVT_ERROR, "Bad image header box (bad size)\n");
532 opj_read_bytes(p_image_header_data,&(jp2->h),4); /* HEIGHT */
533 p_image_header_data += 4;
534 opj_read_bytes(p_image_header_data,&(jp2->w),4); /* WIDTH */
535 p_image_header_data += 4;
536 opj_read_bytes(p_image_header_data,&(jp2->numcomps),2); /* NC */
537 p_image_header_data += 2;
539 /* allocate memory for components */
540 jp2->comps = (opj_jp2_comps_t*) opj_calloc(jp2->numcomps, sizeof(opj_jp2_comps_t));
541 if (jp2->comps == 0) {
542 opj_event_msg(p_manager, EVT_ERROR, "Not enough memory to handle image header (ihdr)\n");
546 opj_read_bytes(p_image_header_data,&(jp2->bpc),1); /* BPC */
547 ++ p_image_header_data;
549 opj_read_bytes(p_image_header_data,&(jp2->C),1); /* C */
550 ++ p_image_header_data;
552 /* Should be equal to 7 cf. chapter about image header box of the norm */
554 opj_event_msg(p_manager, EVT_INFO, "JP2 IHDR box: compression type indicate that the file is not a conforming JP2 file (%d) \n", jp2->C);
557 opj_read_bytes(p_image_header_data,&(jp2->UnkC),1); /* UnkC */
558 ++ p_image_header_data;
559 opj_read_bytes(p_image_header_data,&(jp2->IPR),1); /* IPR */
560 ++ p_image_header_data;
565 OPJ_BYTE * opj_jp2_write_ihdr(opj_jp2_t *jp2,
566 OPJ_UINT32 * p_nb_bytes_written
569 OPJ_BYTE * l_ihdr_data,* l_current_ihdr_ptr;
573 assert(p_nb_bytes_written != 00);
575 /* default image header is 22 bytes wide */
576 l_ihdr_data = (OPJ_BYTE *) opj_calloc(1,22);
577 if (l_ihdr_data == 00) {
581 l_current_ihdr_ptr = l_ihdr_data;
583 opj_write_bytes(l_current_ihdr_ptr,22,4); /* write box size */
584 l_current_ihdr_ptr+=4;
586 opj_write_bytes(l_current_ihdr_ptr,JP2_IHDR, 4); /* IHDR */
587 l_current_ihdr_ptr+=4;
589 opj_write_bytes(l_current_ihdr_ptr,jp2->h, 4); /* HEIGHT */
590 l_current_ihdr_ptr+=4;
592 opj_write_bytes(l_current_ihdr_ptr, jp2->w, 4); /* WIDTH */
593 l_current_ihdr_ptr+=4;
595 opj_write_bytes(l_current_ihdr_ptr, jp2->numcomps, 2); /* NC */
596 l_current_ihdr_ptr+=2;
598 opj_write_bytes(l_current_ihdr_ptr, jp2->bpc, 1); /* BPC */
599 ++l_current_ihdr_ptr;
601 opj_write_bytes(l_current_ihdr_ptr, jp2->C, 1); /* C : Always 7 */
602 ++l_current_ihdr_ptr;
604 opj_write_bytes(l_current_ihdr_ptr, jp2->UnkC, 1); /* UnkC, colorspace unknown */
605 ++l_current_ihdr_ptr;
607 opj_write_bytes(l_current_ihdr_ptr, jp2->IPR, 1); /* IPR, no intellectual property */
608 ++l_current_ihdr_ptr;
610 *p_nb_bytes_written = 22;
615 OPJ_BYTE * opj_jp2_write_bpcc( opj_jp2_t *jp2,
616 OPJ_UINT32 * p_nb_bytes_written
620 /* room for 8 bytes for box and 1 byte for each component */
621 OPJ_UINT32 l_bpcc_size = 8 + jp2->numcomps;
622 OPJ_BYTE * l_bpcc_data,* l_current_bpcc_ptr;
626 assert(p_nb_bytes_written != 00);
628 l_bpcc_data = (OPJ_BYTE *) opj_calloc(1,l_bpcc_size);
629 if (l_bpcc_data == 00) {
633 l_current_bpcc_ptr = l_bpcc_data;
635 opj_write_bytes(l_current_bpcc_ptr,l_bpcc_size,4); /* write box size */
636 l_current_bpcc_ptr += 4;
638 opj_write_bytes(l_current_bpcc_ptr,JP2_BPCC,4); /* BPCC */
639 l_current_bpcc_ptr += 4;
641 for (i = 0; i < jp2->numcomps; ++i) {
642 opj_write_bytes(l_current_bpcc_ptr, jp2->comps[i].bpcc, 1); /* write each component information */
643 ++l_current_bpcc_ptr;
646 *p_nb_bytes_written = l_bpcc_size;
651 OPJ_BOOL opj_jp2_read_bpcc( opj_jp2_t *jp2,
652 OPJ_BYTE * p_bpc_header_data,
653 OPJ_UINT32 p_bpc_header_size,
654 opj_event_mgr_t * p_manager
660 assert(p_bpc_header_data != 00);
662 assert(p_manager != 00);
665 if (jp2->bpc != 255 ){
666 opj_event_msg(p_manager, EVT_WARNING, "A BPCC header box is available although BPC given by the IHDR box (%d) indicate components bit depth is constant\n",jp2->bpc);
669 /* and length is relevant */
670 if (p_bpc_header_size != jp2->numcomps) {
671 opj_event_msg(p_manager, EVT_ERROR, "Bad BPCC header box (bad size)\n");
675 /* read info for each component */
676 for (i = 0; i < jp2->numcomps; ++i) {
677 opj_read_bytes(p_bpc_header_data,&jp2->comps[i].bpcc ,1); /* read each BPCC component */
684 OPJ_BYTE * opj_jp2_write_colr( opj_jp2_t *jp2,
685 OPJ_UINT32 * p_nb_bytes_written
688 /* room for 8 bytes for box 3 for common data and variable upon profile*/
689 OPJ_UINT32 l_colr_size = 11;
690 OPJ_BYTE * l_colr_data,* l_current_colr_ptr;
694 assert(p_nb_bytes_written != 00);
695 assert(jp2->meth == 1 || jp2->meth == 2);
699 l_colr_size += 4; /* EnumCS */
702 assert(jp2->color.icc_profile_len); /* ICC profile */
703 l_colr_size += jp2->color.icc_profile_len;
709 l_colr_data = (OPJ_BYTE *) opj_calloc(1,l_colr_size);
710 if (l_colr_data == 00) {
714 l_current_colr_ptr = l_colr_data;
716 opj_write_bytes(l_current_colr_ptr,l_colr_size,4); /* write box size */
717 l_current_colr_ptr += 4;
719 opj_write_bytes(l_current_colr_ptr,JP2_COLR,4); /* BPCC */
720 l_current_colr_ptr += 4;
722 opj_write_bytes(l_current_colr_ptr, jp2->meth,1); /* METH */
723 ++l_current_colr_ptr;
725 opj_write_bytes(l_current_colr_ptr, jp2->precedence,1); /* PRECEDENCE */
726 ++l_current_colr_ptr;
728 opj_write_bytes(l_current_colr_ptr, jp2->approx,1); /* APPROX */
729 ++l_current_colr_ptr;
731 if (jp2->meth == 1) { /* Meth value is restricted to 1 or 2 (Table I.9 of part 1) */
732 opj_write_bytes(l_current_colr_ptr, jp2->enumcs,4); } /* EnumCS */
734 if (jp2->meth == 2) { /* ICC profile */
736 for(i = 0; i < jp2->color.icc_profile_len; ++i) {
737 opj_write_bytes(l_current_colr_ptr, jp2->color.icc_profile_buf[i], 1);
738 ++l_current_colr_ptr;
743 *p_nb_bytes_written = l_colr_size;
748 void opj_jp2_free_pclr(opj_jp2_color_t *color)
750 opj_free(color->jp2_pclr->channel_sign);
751 opj_free(color->jp2_pclr->channel_size);
752 opj_free(color->jp2_pclr->entries);
754 if(color->jp2_pclr->cmap) opj_free(color->jp2_pclr->cmap);
756 opj_free(color->jp2_pclr); color->jp2_pclr = NULL;
759 static OPJ_BOOL opj_jp2_check_color(opj_image_t *image, opj_jp2_color_t *color, opj_event_mgr_t *p_manager)
763 /* testcase 4149.pdf.SIGSEGV.cf7.3501 */
764 if (color->jp2_cdef) {
765 opj_jp2_cdef_info_t *info = color->jp2_cdef->info;
766 OPJ_UINT16 n = color->jp2_cdef->n;
767 OPJ_UINT32 nr_channels = image->numcomps; /* FIXME image->numcomps == jp2->numcomps before color is applied ??? */
769 /* cdef applies to cmap channels if any */
770 if (color->jp2_pclr && color->jp2_pclr->cmap) {
771 nr_channels = (OPJ_UINT32)color->jp2_pclr->nr_channels;
774 for (i = 0; i < n; i++) {
775 if (info[i].cn >= image->numcomps) {
776 opj_event_msg(p_manager, EVT_ERROR, "Invalid component index %d (>= %d).\n", info[i].cn, image->numcomps);
779 if (info[i].asoc > 0 && (OPJ_UINT32)(info[i].asoc - 1) >= image->numcomps) {
780 opj_event_msg(p_manager, EVT_ERROR, "Invalid component index %d (>= %d).\n", info[i].asoc - 1, image->numcomps);
786 /* ISO 15444-1 states that if cdef is present, it shall contain a complete list of channel definitions. */
787 while (nr_channels > 0)
789 for(i = 0; i < n; ++i) {
790 if ((OPJ_UINT32)info[i].cn == (nr_channels - 1U)) {
795 opj_event_msg(p_manager, EVT_ERROR, "Incomplete channel definitions.\n");
802 /* testcases 451.pdf.SIGSEGV.f4c.3723, 451.pdf.SIGSEGV.5b5.3723 and
803 66ea31acbb0f23a2bbc91f64d69a03f5_signal_sigsegv_13937c0_7030_5725.pdf */
804 if (color->jp2_pclr && color->jp2_pclr->cmap) {
805 OPJ_UINT16 nr_channels = color->jp2_pclr->nr_channels;
806 opj_jp2_cmap_comp_t *cmap = color->jp2_pclr->cmap;
807 OPJ_BOOL *pcol_usage, is_sane = OPJ_TRUE;
809 /* verify that all original components match an existing one */
810 for (i = 0; i < nr_channels; i++) {
811 if (cmap[i].cmp >= image->numcomps) {
812 opj_event_msg(p_manager, EVT_ERROR, "Invalid component index %d (>= %d).\n", cmap[i].cmp, image->numcomps);
817 pcol_usage = opj_calloc(nr_channels, sizeof(OPJ_BOOL));
819 opj_event_msg(p_manager, EVT_ERROR, "Unexpected OOM.\n");
822 /* verify that no component is targeted more than once */
823 for (i = 0; i < nr_channels; i++) {
824 OPJ_UINT16 pcol = cmap[i].pcol;
825 assert(cmap[i].mtyp == 0 || cmap[i].mtyp == 1);
826 if (pcol >= nr_channels) {
827 opj_event_msg(p_manager, EVT_ERROR, "Invalid component/palette index for direct mapping %d.\n", pcol);
830 else if (pcol_usage[pcol] && cmap[i].mtyp == 1) {
831 opj_event_msg(p_manager, EVT_ERROR, "Component %d is mapped twice.\n", pcol);
834 else if (cmap[i].mtyp == 0 && cmap[i].pcol != 0) {
835 /* I.5.3.5 PCOL: If the value of the MTYP field for this channel is 0, then
836 * the value of this field shall be 0. */
837 opj_event_msg(p_manager, EVT_ERROR, "Direct use at #%d however pcol=%d.\n", i, pcol);
841 pcol_usage[pcol] = OPJ_TRUE;
843 /* verify that all components are targeted at least once */
844 for (i = 0; i < nr_channels; i++) {
845 if (!pcol_usage[i] && cmap[i].mtyp != 0) {
846 opj_event_msg(p_manager, EVT_ERROR, "Component %d doesn't have a mapping.\n", i);
850 opj_free(pcol_usage);
860 void opj_jp2_apply_pclr(opj_image_t *image, opj_jp2_color_t *color)
862 opj_image_comp_t *old_comps, *new_comps;
863 OPJ_BYTE *channel_size, *channel_sign;
865 opj_jp2_cmap_comp_t *cmap;
866 OPJ_INT32 *src, *dst;
868 OPJ_UINT16 i, nr_channels, cmp, pcol;
871 channel_size = color->jp2_pclr->channel_size;
872 channel_sign = color->jp2_pclr->channel_sign;
873 entries = color->jp2_pclr->entries;
874 cmap = color->jp2_pclr->cmap;
875 nr_channels = color->jp2_pclr->nr_channels;
877 old_comps = image->comps;
878 new_comps = (opj_image_comp_t*)
879 opj_malloc(nr_channels * sizeof(opj_image_comp_t));
881 /* FIXME no error code for opj_jp2_apply_pclr */
882 /* FIXME event manager error callback */
885 for(i = 0; i < nr_channels; ++i) {
886 pcol = cmap[i].pcol; cmp = cmap[i].cmp;
889 if(cmap[i].mtyp == 0){
891 new_comps[i] = old_comps[cmp];
894 new_comps[pcol] = old_comps[cmp];
897 /* Palette mapping: */
898 new_comps[i].data = (OPJ_INT32*)
899 opj_malloc(old_comps[cmp].w * old_comps[cmp].h * sizeof(OPJ_INT32));
900 if (!new_comps[i].data) {
903 /* FIXME no error code for opj_jp2_apply_pclr */
904 /* FIXME event manager error callback */
907 new_comps[i].prec = channel_size[i];
908 new_comps[i].sgnd = channel_sign[i];
911 top_k = color->jp2_pclr->nr_entries - 1;
913 for(i = 0; i < nr_channels; ++i) {
914 /* Palette mapping: */
915 cmp = cmap[i].cmp; pcol = cmap[i].pcol;
916 src = old_comps[cmp].data;
918 max = new_comps[pcol].w * new_comps[pcol].h;
921 if(cmap[i].mtyp == 0) {
923 dst = new_comps[i].data;
925 for(j = 0; j < max; ++j) {
931 dst = new_comps[pcol].data;
933 for(j = 0; j < max; ++j) {
935 if((k = src[j]) < 0) k = 0; else if(k > top_k) k = top_k;
938 dst[j] = (OPJ_INT32)entries[k * nr_channels + pcol];
943 max = image->numcomps;
944 for(i = 0; i < max; ++i) {
945 if(old_comps[i].data) opj_free(old_comps[i].data);
949 image->comps = new_comps;
950 image->numcomps = nr_channels;
952 opj_jp2_free_pclr(color);
956 OPJ_BOOL opj_jp2_read_pclr( opj_jp2_t *jp2,
957 OPJ_BYTE * p_pclr_header_data,
958 OPJ_UINT32 p_pclr_header_size,
959 opj_event_mgr_t * p_manager
962 opj_jp2_pclr_t *jp2_pclr;
963 OPJ_BYTE *channel_size, *channel_sign;
965 OPJ_UINT16 nr_entries,nr_channels;
968 OPJ_BYTE *orig_header_data = p_pclr_header_data;
971 assert(p_pclr_header_data != 00);
973 assert(p_manager != 00);
974 (void)p_pclr_header_size;
976 if(jp2->color.jp2_pclr)
979 if (p_pclr_header_size < 3)
982 opj_read_bytes(p_pclr_header_data, &l_value , 2); /* NE */
983 p_pclr_header_data += 2;
984 nr_entries = (OPJ_UINT16) l_value;
986 opj_read_bytes(p_pclr_header_data, &l_value , 1); /* NPC */
987 ++p_pclr_header_data;
988 nr_channels = (OPJ_UINT16) l_value;
990 if (p_pclr_header_size < 3 + (OPJ_UINT32)nr_channels || nr_channels == 0 || nr_entries >= (OPJ_UINT32)-1 / nr_channels)
993 entries = (OPJ_UINT32*) opj_malloc((size_t)nr_channels * nr_entries * sizeof(OPJ_UINT32));
996 channel_size = (OPJ_BYTE*) opj_malloc(nr_channels);
1002 channel_sign = (OPJ_BYTE*) opj_malloc(nr_channels);
1006 opj_free(channel_size);
1010 jp2_pclr = (opj_jp2_pclr_t*)opj_malloc(sizeof(opj_jp2_pclr_t));
1014 opj_free(channel_size);
1015 opj_free(channel_sign);
1019 jp2_pclr->channel_sign = channel_sign;
1020 jp2_pclr->channel_size = channel_size;
1021 jp2_pclr->entries = entries;
1022 jp2_pclr->nr_entries = nr_entries;
1023 jp2_pclr->nr_channels = (OPJ_BYTE) l_value;
1024 jp2_pclr->cmap = NULL;
1026 jp2->color.jp2_pclr = jp2_pclr;
1028 for(i = 0; i < nr_channels; ++i) {
1029 opj_read_bytes(p_pclr_header_data, &l_value , 1); /* Bi */
1030 ++p_pclr_header_data;
1032 channel_size[i] = (OPJ_BYTE)((l_value & 0x7f) + 1);
1033 channel_sign[i] = (l_value & 0x80) ? 1 : 0;
1036 for(j = 0; j < nr_entries; ++j) {
1037 for(i = 0; i < nr_channels; ++i) {
1038 OPJ_UINT32 bytes_to_read = (OPJ_UINT32)((channel_size[i]+7)>>3);
1040 if (bytes_to_read > sizeof(OPJ_UINT32))
1041 bytes_to_read = sizeof(OPJ_UINT32);
1042 if ((ptrdiff_t)p_pclr_header_size < (ptrdiff_t)(p_pclr_header_data - orig_header_data) + (ptrdiff_t)bytes_to_read)
1045 opj_read_bytes(p_pclr_header_data, &l_value , bytes_to_read); /* Cji */
1046 p_pclr_header_data += bytes_to_read;
1047 *entries = (OPJ_UINT32) l_value;
1055 OPJ_BOOL opj_jp2_read_cmap( opj_jp2_t * jp2,
1056 OPJ_BYTE * p_cmap_header_data,
1057 OPJ_UINT32 p_cmap_header_size,
1058 opj_event_mgr_t * p_manager
1061 opj_jp2_cmap_comp_t *cmap;
1062 OPJ_BYTE i, nr_channels;
1067 assert(p_cmap_header_data != 00);
1068 assert(p_manager != 00);
1069 (void)p_cmap_header_size;
1071 /* Need nr_channels: */
1072 if(jp2->color.jp2_pclr == NULL) {
1073 opj_event_msg(p_manager, EVT_ERROR, "Need to read a PCLR box before the CMAP box.\n");
1077 /* Part 1, I.5.3.5: 'There shall be at most one Component Mapping box
1078 * inside a JP2 Header box' :
1080 if(jp2->color.jp2_pclr->cmap) {
1081 opj_event_msg(p_manager, EVT_ERROR, "Only one CMAP box is allowed.\n");
1085 nr_channels = jp2->color.jp2_pclr->nr_channels;
1086 if (p_cmap_header_size < (OPJ_UINT32)nr_channels * 4) {
1087 opj_event_msg(p_manager, EVT_ERROR, "Insufficient data for CMAP box.\n");
1091 cmap = (opj_jp2_cmap_comp_t*) opj_malloc(nr_channels * sizeof(opj_jp2_cmap_comp_t));
1096 for(i = 0; i < nr_channels; ++i) {
1097 opj_read_bytes(p_cmap_header_data, &l_value, 2); /* CMP^i */
1098 p_cmap_header_data +=2;
1099 cmap[i].cmp = (OPJ_UINT16) l_value;
1101 opj_read_bytes(p_cmap_header_data, &l_value, 1); /* MTYP^i */
1102 ++p_cmap_header_data;
1103 cmap[i].mtyp = (OPJ_BYTE) l_value;
1105 opj_read_bytes(p_cmap_header_data, &l_value, 1); /* PCOL^i */
1106 ++p_cmap_header_data;
1107 cmap[i].pcol = (OPJ_BYTE) l_value;
1110 jp2->color.jp2_pclr->cmap = cmap;
1115 void opj_jp2_apply_cdef(opj_image_t *image, opj_jp2_color_t *color)
1117 opj_jp2_cdef_info_t *info;
1118 OPJ_UINT16 i, n, cn, asoc, acn;
1120 info = color->jp2_cdef->info;
1121 n = color->jp2_cdef->n;
1123 for(i = 0; i < n; ++i)
1125 /* WATCH: acn = asoc - 1 ! */
1126 asoc = info[i].asoc;
1127 if(asoc == 0 || asoc == 65535)
1129 if (i < image->numcomps)
1130 image->comps[i].alpha = info[i].typ;
1135 acn = (OPJ_UINT16)(asoc - 1);
1136 if( cn >= image->numcomps || acn >= image->numcomps )
1138 fprintf(stderr, "cn=%d, acn=%d, numcomps=%d\n", cn, acn, image->numcomps);
1144 opj_image_comp_t saved;
1146 memcpy(&saved, &image->comps[cn], sizeof(opj_image_comp_t));
1147 memcpy(&image->comps[cn], &image->comps[acn], sizeof(opj_image_comp_t));
1148 memcpy(&image->comps[acn], &saved, sizeof(opj_image_comp_t));
1150 info[i].asoc = (OPJ_UINT16)(cn + 1);
1151 info[acn].asoc = (OPJ_UINT16)(info[acn].cn + 1);
1154 image->comps[cn].alpha = info[i].typ;
1157 if(color->jp2_cdef->info) opj_free(color->jp2_cdef->info);
1159 opj_free(color->jp2_cdef); color->jp2_cdef = NULL;
1161 }/* jp2_apply_cdef() */
1163 OPJ_BOOL opj_jp2_read_cdef( opj_jp2_t * jp2,
1164 OPJ_BYTE * p_cdef_header_data,
1165 OPJ_UINT32 p_cdef_header_size,
1166 opj_event_mgr_t * p_manager
1169 opj_jp2_cdef_info_t *cdef_info;
1175 assert(p_cdef_header_data != 00);
1176 assert(p_manager != 00);
1177 (void)p_cdef_header_size;
1179 /* Part 1, I.5.3.6: 'The shall be at most one Channel Definition box
1180 * inside a JP2 Header box.'*/
1181 if(jp2->color.jp2_cdef) return OPJ_FALSE;
1183 if (p_cdef_header_size < 2) {
1184 opj_event_msg(p_manager, EVT_ERROR, "Insufficient data for CDEF box.\n");
1188 opj_read_bytes(p_cdef_header_data,&l_value ,2); /* N */
1189 p_cdef_header_data+= 2;
1191 if ( (OPJ_UINT16)l_value == 0){ /* szukw000: FIXME */
1192 opj_event_msg(p_manager, EVT_ERROR, "Number of channel description is equal to zero in CDEF box.\n");
1196 if (p_cdef_header_size < 2 + (OPJ_UINT32)(OPJ_UINT16)l_value * 6) {
1197 opj_event_msg(p_manager, EVT_ERROR, "Insufficient data for CDEF box.\n");
1201 cdef_info = (opj_jp2_cdef_info_t*) opj_malloc(l_value * sizeof(opj_jp2_cdef_info_t));
1205 jp2->color.jp2_cdef = (opj_jp2_cdef_t*)opj_malloc(sizeof(opj_jp2_cdef_t));
1206 if(!jp2->color.jp2_cdef)
1208 opj_free(cdef_info);
1211 jp2->color.jp2_cdef->info = cdef_info;
1212 jp2->color.jp2_cdef->n = (OPJ_UINT16) l_value;
1214 for(i = 0; i < jp2->color.jp2_cdef->n; ++i) {
1215 opj_read_bytes(p_cdef_header_data, &l_value, 2); /* Cn^i */
1216 p_cdef_header_data +=2;
1217 cdef_info[i].cn = (OPJ_UINT16) l_value;
1219 opj_read_bytes(p_cdef_header_data, &l_value, 2); /* Typ^i */
1220 p_cdef_header_data +=2;
1221 cdef_info[i].typ = (OPJ_UINT16) l_value;
1223 opj_read_bytes(p_cdef_header_data, &l_value, 2); /* Asoc^i */
1224 p_cdef_header_data +=2;
1225 cdef_info[i].asoc = (OPJ_UINT16) l_value;
1231 OPJ_BOOL opj_jp2_read_colr( opj_jp2_t *jp2,
1232 OPJ_BYTE * p_colr_header_data,
1233 OPJ_UINT32 p_colr_header_size,
1234 opj_event_mgr_t * p_manager
1241 assert(p_colr_header_data != 00);
1242 assert(p_manager != 00);
1244 if (p_colr_header_size < 3) {
1245 opj_event_msg(p_manager, EVT_ERROR, "Bad COLR header box (bad size)\n");
1249 /* Part 1, I.5.3.3 : 'A conforming JP2 reader shall ignore all Colour
1250 * Specification boxes after the first.'
1252 if(jp2->color.jp2_has_colr) {
1253 opj_event_msg(p_manager, EVT_INFO, "A conforming JP2 reader shall ignore all Colour Specification boxes after the first, so we ignore this one.\n");
1254 p_colr_header_data += p_colr_header_size;
1258 opj_read_bytes(p_colr_header_data,&jp2->meth ,1); /* METH */
1259 ++p_colr_header_data;
1261 opj_read_bytes(p_colr_header_data,&jp2->precedence ,1); /* PRECEDENCE */
1262 ++p_colr_header_data;
1264 opj_read_bytes(p_colr_header_data,&jp2->approx ,1); /* APPROX */
1265 ++p_colr_header_data;
1267 if (jp2->meth == 1) {
1268 if (p_colr_header_size < 7) {
1269 opj_event_msg(p_manager, EVT_ERROR, "Bad COLR header box (bad size: %d)\n", p_colr_header_size);
1272 if (p_colr_header_size > 7) {
1273 /* testcase Altona_Technical_v20_x4.pdf */
1274 opj_event_msg(p_manager, EVT_WARNING, "Bad COLR header box (bad size: %d)\n", p_colr_header_size);
1277 opj_read_bytes(p_colr_header_data,&jp2->enumcs ,4); /* EnumCS */
1279 jp2->color.jp2_has_colr = 1;
1281 else if (jp2->meth == 2) {
1283 OPJ_INT32 it_icc_value = 0;
1284 OPJ_INT32 icc_len = (OPJ_INT32)p_colr_header_size - 3;
1286 jp2->color.icc_profile_len = (OPJ_UINT32)icc_len;
1287 jp2->color.icc_profile_buf = (OPJ_BYTE*) opj_calloc(1,(size_t)icc_len);
1288 if (!jp2->color.icc_profile_buf)
1290 jp2->color.icc_profile_len = 0;
1294 for (it_icc_value = 0; it_icc_value < icc_len; ++it_icc_value)
1296 opj_read_bytes(p_colr_header_data,&l_value,1); /* icc values */
1297 ++p_colr_header_data;
1298 jp2->color.icc_profile_buf[it_icc_value] = (OPJ_BYTE) l_value;
1301 jp2->color.jp2_has_colr = 1;
1303 else if (jp2->meth > 2)
1305 /* ISO/IEC 15444-1:2004 (E), Table I.9 Legal METH values:
1306 conforming JP2 reader shall ignore the entire Colour Specification box.*/
1307 opj_event_msg(p_manager, EVT_INFO, "COLR BOX meth value is not a regular value (%d), "
1308 "so we will ignore the entire Colour Specification box. \n", jp2->meth);
1313 OPJ_BOOL opj_jp2_decode(opj_jp2_t *jp2,
1314 opj_stream_private_t *p_stream,
1315 opj_image_t* p_image,
1316 opj_event_mgr_t * p_manager)
1322 if( ! opj_j2k_decode(jp2->j2k, p_stream, p_image, p_manager) ) {
1323 opj_event_msg(p_manager, EVT_ERROR, "Failed to decode the codestream in the JP2 file\n");
1327 if (!jp2->ignore_pclr_cmap_cdef){
1328 if (!opj_jp2_check_color(p_image, &(jp2->color), p_manager)) {
1332 /* Set Image Color Space */
1333 if (jp2->enumcs == 16)
1334 p_image->color_space = OPJ_CLRSPC_SRGB;
1335 else if (jp2->enumcs == 17)
1336 p_image->color_space = OPJ_CLRSPC_GRAY;
1337 else if (jp2->enumcs == 18)
1338 p_image->color_space = OPJ_CLRSPC_SYCC;
1339 else if (jp2->enumcs == 24)
1340 p_image->color_space = OPJ_CLRSPC_EYCC;
1342 p_image->color_space = OPJ_CLRSPC_UNKNOWN;
1344 /* Apply the color space if needed */
1345 if(jp2->color.jp2_cdef) {
1346 opj_jp2_apply_cdef(p_image, &(jp2->color));
1349 if(jp2->color.jp2_pclr) {
1350 /* Part 1, I.5.3.4: Either both or none : */
1351 if( !jp2->color.jp2_pclr->cmap)
1352 opj_jp2_free_pclr(&(jp2->color));
1354 opj_jp2_apply_pclr(p_image, &(jp2->color));
1357 if(jp2->color.icc_profile_buf) {
1358 p_image->icc_profile_buf = jp2->color.icc_profile_buf;
1359 p_image->icc_profile_len = jp2->color.icc_profile_len;
1360 jp2->color.icc_profile_buf = NULL;
1367 OPJ_BOOL opj_jp2_write_jp2h(opj_jp2_t *jp2,
1368 opj_stream_private_t *stream,
1369 opj_event_mgr_t * p_manager
1372 opj_jp2_img_header_writer_handler_t l_writers [3];
1373 opj_jp2_img_header_writer_handler_t * l_current_writer;
1375 OPJ_INT32 i, l_nb_pass;
1376 /* size of data for super box*/
1377 OPJ_UINT32 l_jp2h_size = 8;
1378 OPJ_BOOL l_result = OPJ_TRUE;
1380 /* to store the data of the super box */
1381 OPJ_BYTE l_jp2h_data [8];
1384 assert(stream != 00);
1386 assert(p_manager != 00);
1388 memset(l_writers,0,sizeof(l_writers));
1390 if (jp2->bpc == 255) {
1392 l_writers[0].handler = opj_jp2_write_ihdr;
1393 l_writers[1].handler = opj_jp2_write_bpcc;
1394 l_writers[2].handler = opj_jp2_write_colr;
1398 l_writers[0].handler = opj_jp2_write_ihdr;
1399 l_writers[1].handler = opj_jp2_write_colr;
1402 /* write box header */
1403 /* write JP2H type */
1404 opj_write_bytes(l_jp2h_data+4,JP2_JP2H,4);
1406 l_current_writer = l_writers;
1407 for (i=0;i<l_nb_pass;++i) {
1408 l_current_writer->m_data = l_current_writer->handler(jp2,&(l_current_writer->m_size));
1409 if (l_current_writer->m_data == 00) {
1410 opj_event_msg(p_manager, EVT_ERROR, "Not enough memory to hold JP2 Header data\n");
1411 l_result = OPJ_FALSE;
1415 l_jp2h_size += l_current_writer->m_size;
1420 l_current_writer = l_writers;
1421 for (i=0;i<l_nb_pass;++i) {
1422 if (l_current_writer->m_data != 00) {
1423 opj_free(l_current_writer->m_data );
1431 /* write super box size */
1432 opj_write_bytes(l_jp2h_data,l_jp2h_size,4);
1434 /* write super box data on stream */
1435 if (opj_stream_write_data(stream,l_jp2h_data,8,p_manager) != 8) {
1436 opj_event_msg(p_manager, EVT_ERROR, "Stream error while writing JP2 Header box\n");
1437 l_result = OPJ_FALSE;
1441 l_current_writer = l_writers;
1442 for (i=0;i<l_nb_pass;++i) {
1443 if (opj_stream_write_data(stream,l_current_writer->m_data,l_current_writer->m_size,p_manager) != l_current_writer->m_size) {
1444 opj_event_msg(p_manager, EVT_ERROR, "Stream error while writing JP2 Header box\n");
1445 l_result = OPJ_FALSE;
1452 l_current_writer = l_writers;
1455 for (i=0;i<l_nb_pass;++i) {
1456 if (l_current_writer->m_data != 00) {
1457 opj_free(l_current_writer->m_data );
1465 OPJ_BOOL opj_jp2_write_ftyp(opj_jp2_t *jp2,
1466 opj_stream_private_t *cio,
1467 opj_event_mgr_t * p_manager )
1470 OPJ_UINT32 l_ftyp_size = 16 + 4 * jp2->numcl;
1471 OPJ_BYTE * l_ftyp_data, * l_current_data_ptr;
1477 assert(p_manager != 00);
1479 l_ftyp_data = (OPJ_BYTE *) opj_calloc(1,l_ftyp_size);
1481 if (l_ftyp_data == 00) {
1482 opj_event_msg(p_manager, EVT_ERROR, "Not enough memory to handle ftyp data\n");
1486 l_current_data_ptr = l_ftyp_data;
1488 opj_write_bytes(l_current_data_ptr, l_ftyp_size,4); /* box size */
1489 l_current_data_ptr += 4;
1491 opj_write_bytes(l_current_data_ptr, JP2_FTYP,4); /* FTYP */
1492 l_current_data_ptr += 4;
1494 opj_write_bytes(l_current_data_ptr, jp2->brand,4); /* BR */
1495 l_current_data_ptr += 4;
1497 opj_write_bytes(l_current_data_ptr, jp2->minversion,4); /* MinV */
1498 l_current_data_ptr += 4;
1500 for (i = 0; i < jp2->numcl; i++) {
1501 opj_write_bytes(l_current_data_ptr, jp2->cl[i],4); /* CL */
1504 l_result = (opj_stream_write_data(cio,l_ftyp_data,l_ftyp_size,p_manager) == l_ftyp_size);
1507 opj_event_msg(p_manager, EVT_ERROR, "Error while writing ftyp data to stream\n");
1510 opj_free(l_ftyp_data);
1515 OPJ_BOOL opj_jp2_write_jp2c(opj_jp2_t *jp2,
1516 opj_stream_private_t *cio,
1517 opj_event_mgr_t * p_manager )
1519 OPJ_OFF_T j2k_codestream_exit;
1520 OPJ_BYTE l_data_header [8];
1525 assert(p_manager != 00);
1526 assert(opj_stream_has_seek(cio));
1528 j2k_codestream_exit = opj_stream_tell(cio);
1529 opj_write_bytes(l_data_header,
1530 (OPJ_UINT32) (j2k_codestream_exit - jp2->j2k_codestream_offset),
1531 4); /* size of codestream */
1532 opj_write_bytes(l_data_header + 4,JP2_JP2C,4); /* JP2C */
1534 if (! opj_stream_seek(cio,jp2->j2k_codestream_offset,p_manager)) {
1535 opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
1539 if (opj_stream_write_data(cio,l_data_header,8,p_manager) != 8) {
1540 opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
1544 if (! opj_stream_seek(cio,j2k_codestream_exit,p_manager)) {
1545 opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
1552 OPJ_BOOL opj_jp2_write_jp( opj_jp2_t *jp2,
1553 opj_stream_private_t *cio,
1554 opj_event_mgr_t * p_manager )
1556 /* 12 bytes will be read */
1557 OPJ_BYTE l_signature_data [12];
1562 assert(p_manager != 00);
1564 /* write box length */
1565 opj_write_bytes(l_signature_data,12,4);
1566 /* writes box type */
1567 opj_write_bytes(l_signature_data+4,JP2_JP,4);
1568 /* writes magic number*/
1569 opj_write_bytes(l_signature_data+8,0x0d0a870a,4);
1571 if (opj_stream_write_data(cio,l_signature_data,12,p_manager) != 12) {
1578 /* ----------------------------------------------------------------------- */
1579 /* JP2 decoder interface */
1580 /* ----------------------------------------------------------------------- */
1582 void opj_jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters)
1584 /* setup the J2K codec */
1585 opj_j2k_setup_decoder(jp2->j2k, parameters);
1587 /* further JP2 initializations go here */
1588 jp2->color.jp2_has_colr = 0;
1589 jp2->ignore_pclr_cmap_cdef = parameters->flags & OPJ_DPARAMETERS_IGNORE_PCLR_CMAP_CDEF_FLAG;
1592 /* ----------------------------------------------------------------------- */
1593 /* JP2 encoder interface */
1594 /* ----------------------------------------------------------------------- */
1596 OPJ_BOOL opj_jp2_setup_encoder( opj_jp2_t *jp2,
1597 opj_cparameters_t *parameters,
1599 opj_event_mgr_t * p_manager)
1605 if(!jp2 || !parameters || !image)
1608 /* setup the J2K codec */
1609 /* ------------------- */
1611 /* Check if number of components respects standard */
1612 if (image->numcomps < 1 || image->numcomps > 16384) {
1613 opj_event_msg(p_manager, EVT_ERROR, "Invalid number of components specified while setting up JP2 encoder\n");
1617 if (opj_j2k_setup_encoder(jp2->j2k, parameters, image, p_manager ) == OPJ_FALSE) {
1621 /* setup the JP2 codec */
1622 /* ------------------- */
1626 jp2->brand = JP2_JP2; /* BR */
1627 jp2->minversion = 0; /* MinV */
1629 jp2->cl = (OPJ_UINT32*) opj_malloc(jp2->numcl * sizeof(OPJ_UINT32));
1632 opj_event_msg(p_manager, EVT_ERROR, "Not enough memory when setup the JP2 encoder\n");
1635 jp2->cl[0] = JP2_JP2; /* CL0 : JP2 */
1637 /* Image Header box */
1639 jp2->numcomps = image->numcomps; /* NC */
1640 jp2->comps = (opj_jp2_comps_t*) opj_malloc(jp2->numcomps * sizeof(opj_jp2_comps_t));
1643 opj_event_msg(p_manager, EVT_ERROR, "Not enough memory when setup the JP2 encoder\n");
1644 /* Memory of jp2->cl will be freed by opj_jp2_destroy */
1648 jp2->h = image->y1 - image->y0; /* HEIGHT */
1649 jp2->w = image->x1 - image->x0; /* WIDTH */
1651 depth_0 = image->comps[0].prec - 1;
1652 sign = image->comps[0].sgnd;
1653 jp2->bpc = depth_0 + (sign << 7);
1654 for (i = 1; i < image->numcomps; i++) {
1655 OPJ_UINT32 depth = image->comps[i].prec - 1;
1656 sign = image->comps[i].sgnd;
1657 if (depth_0 != depth)
1660 jp2->C = 7; /* C : Always 7 */
1661 jp2->UnkC = 0; /* UnkC, colorspace specified in colr box */
1662 jp2->IPR = 0; /* IPR, no intellectual property */
1664 /* BitsPerComponent box */
1665 for (i = 0; i < image->numcomps; i++) {
1666 jp2->comps[i].bpcc = image->comps[i].prec - 1 + (image->comps[i].sgnd << 7);
1669 /* Colour Specification box */
1670 if(image->icc_profile_len) {
1676 if (image->color_space == 1)
1677 jp2->enumcs = 16; /* sRGB as defined by IEC 61966-2-1 */
1678 else if (image->color_space == 2)
1679 jp2->enumcs = 17; /* greyscale */
1680 else if (image->color_space == 3)
1681 jp2->enumcs = 18; /* YUV */
1685 jp2->precedence = 0; /* PRECEDENCE */
1686 jp2->approx = 0; /* APPROX */
1688 jp2->jpip_on = parameters->jpip_on;
1693 OPJ_BOOL opj_jp2_encode(opj_jp2_t *jp2,
1694 opj_stream_private_t *stream,
1695 opj_event_mgr_t * p_manager)
1697 return opj_j2k_encode(jp2->j2k, stream, p_manager);
1700 OPJ_BOOL opj_jp2_end_decompress(opj_jp2_t *jp2,
1701 opj_stream_private_t *cio,
1702 opj_event_mgr_t * p_manager
1708 assert(p_manager != 00);
1710 /* customization of the end encoding */
1711 opj_jp2_setup_end_header_reading(jp2);
1714 if (! opj_jp2_exec (jp2,jp2->m_procedure_list,cio,p_manager)) {
1718 return opj_j2k_end_decompress(jp2->j2k, cio, p_manager);
1721 OPJ_BOOL opj_jp2_end_compress( opj_jp2_t *jp2,
1722 opj_stream_private_t *cio,
1723 opj_event_mgr_t * p_manager
1729 assert(p_manager != 00);
1731 /* customization of the end encoding */
1732 opj_jp2_setup_end_header_writing(jp2);
1734 if (! opj_j2k_end_compress(jp2->j2k,cio,p_manager)) {
1739 return opj_jp2_exec(jp2,jp2->m_procedure_list,cio,p_manager);
1742 void opj_jp2_setup_end_header_writing (opj_jp2_t *jp2)
1749 opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)opj_jpip_write_iptr );
1751 opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)opj_jp2_write_jp2c );
1752 /* DEVELOPER CORNER, add your custom procedures */
1756 opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)opj_jpip_write_cidx );
1757 opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)opj_jpip_write_fidx );
1762 void opj_jp2_setup_end_header_reading (opj_jp2_t *jp2)
1766 opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)opj_jp2_read_header_procedure );
1767 /* DEVELOPER CORNER, add your custom procedures */
1770 OPJ_BOOL opj_jp2_default_validation ( opj_jp2_t * jp2,
1771 opj_stream_private_t *cio,
1772 opj_event_mgr_t * p_manager
1775 OPJ_BOOL l_is_valid = OPJ_TRUE;
1781 assert(p_manager != 00);
1783 /* JPEG2000 codec validation */
1785 /* STATE checking */
1786 /* make sure the state is at 0 */
1787 l_is_valid &= (jp2->jp2_state == JP2_STATE_NONE);
1789 /* make sure not reading a jp2h ???? WEIRD */
1790 l_is_valid &= (jp2->jp2_img_state == JP2_IMG_STATE_NONE);
1792 /* POINTER validation */
1793 /* make sure a j2k codec is present */
1794 l_is_valid &= (jp2->j2k != 00);
1796 /* make sure a procedure list is present */
1797 l_is_valid &= (jp2->m_procedure_list != 00);
1799 /* make sure a validation list is present */
1800 l_is_valid &= (jp2->m_validation_list != 00);
1802 /* PARAMETER VALIDATION */
1803 /* number of components */
1804 l_is_valid &= (jp2->numcl > 0);
1806 l_is_valid &= (jp2->h > 0);
1808 l_is_valid &= (jp2->w > 0);
1810 for (i = 0; i < jp2->numcomps; ++i) {
1811 l_is_valid &= (jp2->comps[i].bpcc > 0);
1815 l_is_valid &= ((jp2->meth > 0) && (jp2->meth < 3));
1817 /* stream validation */
1818 /* back and forth is needed */
1819 l_is_valid &= opj_stream_has_seek(cio);
1824 OPJ_BOOL opj_jp2_read_header_procedure( opj_jp2_t *jp2,
1825 opj_stream_private_t *stream,
1826 opj_event_mgr_t * p_manager
1830 OPJ_UINT32 l_nb_bytes_read;
1831 const opj_jp2_header_handler_t * l_current_handler;
1832 OPJ_UINT32 l_last_data_size = OPJ_BOX_SIZE;
1833 OPJ_UINT32 l_current_data_size;
1834 OPJ_BYTE * l_current_data = 00;
1837 assert(stream != 00);
1839 assert(p_manager != 00);
1841 l_current_data = (OPJ_BYTE*)opj_calloc(1,l_last_data_size);
1843 if (l_current_data == 00) {
1844 opj_event_msg(p_manager, EVT_ERROR, "Not enough memory to handle jpeg2000 file header\n");
1848 while (opj_jp2_read_boxhdr(&box,&l_nb_bytes_read,stream,p_manager)) {
1849 /* is it the codestream box ? */
1850 if (box.type == JP2_JP2C) {
1851 if (jp2->jp2_state & JP2_STATE_HEADER) {
1852 jp2->jp2_state |= JP2_STATE_CODESTREAM;
1853 opj_free(l_current_data);
1857 opj_event_msg(p_manager, EVT_ERROR, "bad placed jpeg codestream\n");
1858 opj_free(l_current_data);
1862 else if (box.length == 0) {
1863 opj_event_msg(p_manager, EVT_ERROR, "Cannot handle box of undefined sizes\n");
1864 opj_free(l_current_data);
1867 /* testcase 1851.pdf.SIGSEGV.ce9.948 */
1868 else if (box.length < l_nb_bytes_read) {
1869 opj_event_msg(p_manager, EVT_ERROR, "invalid box size %d (%x)\n", box.length, box.type);
1870 opj_free(l_current_data);
1874 l_current_handler = opj_jp2_find_handler(box.type);
1875 l_current_data_size = box.length - l_nb_bytes_read;
1877 if (l_current_handler != 00) {
1878 if ((OPJ_OFF_T)l_current_data_size > opj_stream_get_number_byte_left(stream)) {
1879 /* do not even try to malloc if we can't read */
1880 opj_event_msg(p_manager, EVT_ERROR, "Invalid box size %d for box '%c%c%c%c'. Need %d bytes, %d bytes remaining \n", box.length, (OPJ_BYTE)(box.type>>24), (OPJ_BYTE)(box.type>>16), (OPJ_BYTE)(box.type>>8), (OPJ_BYTE)(box.type>>0), l_current_data_size, (OPJ_UINT32)opj_stream_get_number_byte_left(stream));
1881 opj_free(l_current_data);
1884 if (l_current_data_size > l_last_data_size) {
1885 OPJ_BYTE* new_current_data = (OPJ_BYTE*)opj_realloc(l_current_data,l_current_data_size);
1886 if (!new_current_data) {
1887 opj_free(l_current_data);
1888 opj_event_msg(p_manager, EVT_ERROR, "Not enough memory to handle jpeg2000 box\n");
1891 l_current_data = new_current_data;
1892 l_last_data_size = l_current_data_size;
1895 l_nb_bytes_read = (OPJ_UINT32)opj_stream_read_data(stream,l_current_data,l_current_data_size,p_manager);
1896 if (l_nb_bytes_read != l_current_data_size) {
1897 opj_event_msg(p_manager, EVT_ERROR, "Problem with reading JPEG2000 box, stream error\n");
1898 opj_free(l_current_data);
1902 if (! l_current_handler->handler(jp2,l_current_data,l_current_data_size,p_manager)) {
1903 opj_free(l_current_data);
1908 jp2->jp2_state |= JP2_STATE_UNKNOWN;
1909 if (opj_stream_skip(stream,l_current_data_size,p_manager) != l_current_data_size) {
1910 opj_event_msg(p_manager, EVT_ERROR, "Problem with skipping JPEG2000 box, stream error\n");
1911 opj_free(l_current_data);
1917 opj_free(l_current_data);
1923 * Excutes the given procedures on the given codec.
1925 * @param p_procedure_list the list of procedures to execute
1926 * @param jp2 the jpeg2000 file codec to execute the procedures on.
1927 * @param stream the stream to execute the procedures on.
1928 * @param p_manager the user manager.
1930 * @return true if all the procedures were successfully executed.
1932 static OPJ_BOOL opj_jp2_exec ( opj_jp2_t * jp2,
1933 opj_procedure_list_t * p_procedure_list,
1934 opj_stream_private_t *stream,
1935 opj_event_mgr_t * p_manager
1939 OPJ_BOOL (** l_procedure) (opj_jp2_t * jp2, opj_stream_private_t *, opj_event_mgr_t *) = 00;
1940 OPJ_BOOL l_result = OPJ_TRUE;
1941 OPJ_UINT32 l_nb_proc, i;
1944 assert(p_procedure_list != 00);
1946 assert(stream != 00);
1947 assert(p_manager != 00);
1949 l_nb_proc = opj_procedure_list_get_nb_procedures(p_procedure_list);
1950 l_procedure = (OPJ_BOOL (**) (opj_jp2_t * jp2, opj_stream_private_t *, opj_event_mgr_t *)) opj_procedure_list_get_first_procedure(p_procedure_list);
1952 for (i=0;i<l_nb_proc;++i) {
1953 l_result = l_result && (*l_procedure) (jp2,stream,p_manager);
1957 /* and clear the procedure list at the end. */
1958 opj_procedure_list_clear(p_procedure_list);
1962 OPJ_BOOL opj_jp2_start_compress(opj_jp2_t *jp2,
1963 opj_stream_private_t *stream,
1964 opj_image_t * p_image,
1965 opj_event_mgr_t * p_manager
1970 assert(stream != 00);
1971 assert(p_manager != 00);
1973 /* customization of the validation */
1974 opj_jp2_setup_encoding_validation (jp2);
1976 /* validation of the parameters codec */
1977 if (! opj_jp2_exec(jp2,jp2->m_validation_list,stream,p_manager)) {
1981 /* customization of the encoding */
1982 opj_jp2_setup_header_writing(jp2);
1985 if (! opj_jp2_exec (jp2,jp2->m_procedure_list,stream,p_manager)) {
1989 return opj_j2k_start_compress(jp2->j2k,stream,p_image,p_manager);
1992 const opj_jp2_header_handler_t * opj_jp2_find_handler (OPJ_UINT32 p_id)
1994 OPJ_UINT32 i, l_handler_size = sizeof(jp2_header) / sizeof(opj_jp2_header_handler_t);
1996 for (i=0;i<l_handler_size;++i) {
1997 if (jp2_header[i].id == p_id) {
1998 return &jp2_header[i];
2005 * Finds the image execution function related to the given box id.
2007 * @param p_id the id of the handler to fetch.
2009 * @return the given handler or 00 if it could not be found.
2011 static const opj_jp2_header_handler_t * opj_jp2_img_find_handler (OPJ_UINT32 p_id)
2013 OPJ_UINT32 i, l_handler_size = sizeof(jp2_img_header) / sizeof(opj_jp2_header_handler_t);
2014 for (i=0;i<l_handler_size;++i)
2016 if (jp2_img_header[i].id == p_id) {
2017 return &jp2_img_header[i];
2025 * Reads a jpeg2000 file signature box.
2027 * @param p_header_data the data contained in the signature box.
2028 * @param jp2 the jpeg2000 file codec.
2029 * @param p_header_size the size of the data contained in the signature box.
2030 * @param p_manager the user event manager.
2032 * @return true if the file signature box is valid.
2034 static OPJ_BOOL opj_jp2_read_jp(opj_jp2_t *jp2,
2035 OPJ_BYTE * p_header_data,
2036 OPJ_UINT32 p_header_size,
2037 opj_event_mgr_t * p_manager
2041 OPJ_UINT32 l_magic_number;
2044 assert(p_header_data != 00);
2046 assert(p_manager != 00);
2048 if (jp2->jp2_state != JP2_STATE_NONE) {
2049 opj_event_msg(p_manager, EVT_ERROR, "The signature box must be the first box in the file.\n");
2053 /* assure length of data is correct (4 -> magic number) */
2054 if (p_header_size != 4) {
2055 opj_event_msg(p_manager, EVT_ERROR, "Error with JP signature Box size\n");
2059 /* rearrange data */
2060 opj_read_bytes(p_header_data,&l_magic_number,4);
2061 if (l_magic_number != 0x0d0a870a ) {
2062 opj_event_msg(p_manager, EVT_ERROR, "Error with JP Signature : bad magic number\n");
2066 jp2->jp2_state |= JP2_STATE_SIGNATURE;
2072 * Reads a a FTYP box - File type box
2074 * @param p_header_data the data contained in the FTYP box.
2075 * @param jp2 the jpeg2000 file codec.
2076 * @param p_header_size the size of the data contained in the FTYP box.
2077 * @param p_manager the user event manager.
2079 * @return true if the FTYP box is valid.
2081 static OPJ_BOOL opj_jp2_read_ftyp( opj_jp2_t *jp2,
2082 OPJ_BYTE * p_header_data,
2083 OPJ_UINT32 p_header_size,
2084 opj_event_mgr_t * p_manager
2087 OPJ_UINT32 i, l_remaining_bytes;
2090 assert(p_header_data != 00);
2092 assert(p_manager != 00);
2094 if (jp2->jp2_state != JP2_STATE_SIGNATURE) {
2095 opj_event_msg(p_manager, EVT_ERROR, "The ftyp box must be the second box in the file.\n");
2099 /* assure length of data is correct */
2100 if (p_header_size < 8) {
2101 opj_event_msg(p_manager, EVT_ERROR, "Error with FTYP signature Box size\n");
2105 opj_read_bytes(p_header_data,&jp2->brand,4); /* BR */
2108 opj_read_bytes(p_header_data,&jp2->minversion,4); /* MinV */
2111 l_remaining_bytes = p_header_size - 8;
2113 /* the number of remaining bytes should be a multiple of 4 */
2114 if ((l_remaining_bytes & 0x3) != 0) {
2115 opj_event_msg(p_manager, EVT_ERROR, "Error with FTYP signature Box size\n");
2120 jp2->numcl = l_remaining_bytes >> 2;
2122 jp2->cl = (OPJ_UINT32 *) opj_calloc(jp2->numcl, sizeof(OPJ_UINT32));
2123 if (jp2->cl == 00) {
2124 opj_event_msg(p_manager, EVT_ERROR, "Not enough memory with FTYP Box\n");
2129 for (i = 0; i < jp2->numcl; ++i)
2131 opj_read_bytes(p_header_data,&jp2->cl[i],4); /* CLi */
2135 jp2->jp2_state |= JP2_STATE_FILE_TYPE;
2140 OPJ_BOOL opj_jp2_skip_jp2c( opj_jp2_t *jp2,
2141 opj_stream_private_t *stream,
2142 opj_event_mgr_t * p_manager )
2146 assert(stream != 00);
2147 assert(p_manager != 00);
2149 jp2->j2k_codestream_offset = opj_stream_tell(stream);
2151 if (opj_stream_skip(stream,8,p_manager) != 8) {
2158 static OPJ_BOOL opj_jpip_skip_iptr( opj_jp2_t *jp2,
2159 opj_stream_private_t *stream,
2160 opj_event_mgr_t * p_manager )
2164 assert(stream != 00);
2165 assert(p_manager != 00);
2167 jp2->jpip_iptr_offset = opj_stream_tell(stream);
2169 if (opj_stream_skip(stream,24,p_manager) != 24) {
2177 * Reads the Jpeg2000 file Header box - JP2 Header box (warning, this is a super box).
2179 * @param p_header_data the data contained in the file header box.
2180 * @param jp2 the jpeg2000 file codec.
2181 * @param p_header_size the size of the data contained in the file header box.
2182 * @param p_manager the user event manager.
2184 * @return true if the JP2 Header box was successfully reconized.
2186 static OPJ_BOOL opj_jp2_read_jp2h( opj_jp2_t *jp2,
2187 OPJ_BYTE *p_header_data,
2188 OPJ_UINT32 p_header_size,
2189 opj_event_mgr_t * p_manager
2192 OPJ_UINT32 l_box_size=0, l_current_data_size = 0;
2194 const opj_jp2_header_handler_t * l_current_handler;
2195 OPJ_BOOL l_has_ihdr = 0;
2198 assert(p_header_data != 00);
2200 assert(p_manager != 00);
2202 /* make sure the box is well placed */
2203 if ((jp2->jp2_state & JP2_STATE_FILE_TYPE) != JP2_STATE_FILE_TYPE ) {
2204 opj_event_msg(p_manager, EVT_ERROR, "The box must be the first box in the file.\n");
2208 jp2->jp2_img_state = JP2_IMG_STATE_NONE;
2210 /* iterate while remaining data */
2211 while (p_header_size > 0) {
2213 if (! opj_jp2_read_boxhdr_char(&box,p_header_data,&l_box_size,p_header_size, p_manager)) {
2214 opj_event_msg(p_manager, EVT_ERROR, "Stream error while reading JP2 Header box\n");
2218 if (box.length > p_header_size) {
2219 opj_event_msg(p_manager, EVT_ERROR, "Stream error while reading JP2 Header box: box length is inconsistent.\n");
2223 l_current_handler = opj_jp2_img_find_handler(box.type);
2224 l_current_data_size = box.length - l_box_size;
2225 p_header_data += l_box_size;
2227 if (l_current_handler != 00) {
2228 if (! l_current_handler->handler(jp2,p_header_data,l_current_data_size,p_manager)) {
2233 jp2->jp2_img_state |= JP2_IMG_STATE_UNKNOWN;
2236 if (box.type == JP2_IHDR) {
2240 p_header_data += l_current_data_size;
2241 p_header_size -= box.length;
2244 if (l_has_ihdr == 0) {
2245 opj_event_msg(p_manager, EVT_ERROR, "Stream error while reading JP2 Header box: no 'ihdr' box.\n");
2249 jp2->jp2_state |= JP2_STATE_HEADER;
2254 OPJ_BOOL opj_jp2_read_boxhdr_char( opj_jp2_box_t *box,
2256 OPJ_UINT32 * p_number_bytes_read,
2257 OPJ_UINT32 p_box_max_size,
2258 opj_event_mgr_t * p_manager
2264 assert(p_data != 00);
2266 assert(p_number_bytes_read != 00);
2267 assert(p_manager != 00);
2269 if (p_box_max_size < 8) {
2270 opj_event_msg(p_manager, EVT_ERROR, "Cannot handle box of less than 8 bytes\n");
2274 /* process read data */
2275 opj_read_bytes(p_data, &l_value, 4);
2277 box->length = (OPJ_UINT32)(l_value);
2279 opj_read_bytes(p_data, &l_value, 4);
2281 box->type = (OPJ_UINT32)(l_value);
2283 *p_number_bytes_read = 8;
2285 /* do we have a "special very large box ?" */
2286 /* read then the XLBox */
2287 if (box->length == 1) {
2288 OPJ_UINT32 l_xl_part_size;
2290 if (p_box_max_size < 16) {
2291 opj_event_msg(p_manager, EVT_ERROR, "Cannot handle XL box of less than 16 bytes\n");
2295 opj_read_bytes(p_data,&l_xl_part_size, 4);
2297 *p_number_bytes_read += 4;
2299 if (l_xl_part_size != 0) {
2300 opj_event_msg(p_manager, EVT_ERROR, "Cannot handle box sizes higher than 2^32\n");
2304 opj_read_bytes(p_data, &l_value, 4);
2305 *p_number_bytes_read += 4;
2306 box->length = (OPJ_UINT32)(l_value);
2308 if (box->length == 0) {
2309 opj_event_msg(p_manager, EVT_ERROR, "Cannot handle box of undefined sizes\n");
2313 else if (box->length == 0) {
2314 opj_event_msg(p_manager, EVT_ERROR, "Cannot handle box of undefined sizes\n");
2317 if (box->length < *p_number_bytes_read) {
2318 opj_event_msg(p_manager, EVT_ERROR, "Box length is inconsistent.\n");
2324 OPJ_BOOL opj_jp2_read_header( opj_stream_private_t *p_stream,
2326 opj_image_t ** p_image,
2327 opj_event_mgr_t * p_manager
2332 assert(p_stream != 00);
2333 assert(p_manager != 00);
2335 /* customization of the validation */
2336 opj_jp2_setup_decoding_validation (jp2);
2338 /* customization of the encoding */
2339 opj_jp2_setup_header_reading(jp2);
2341 /* validation of the parameters codec */
2342 if (! opj_jp2_exec(jp2,jp2->m_validation_list,p_stream,p_manager)) {
2347 if (! opj_jp2_exec (jp2,jp2->m_procedure_list,p_stream,p_manager)) {
2351 return opj_j2k_read_header( p_stream,
2357 void opj_jp2_setup_encoding_validation (opj_jp2_t *jp2)
2362 opj_procedure_list_add_procedure(jp2->m_validation_list, (opj_procedure)opj_jp2_default_validation);
2363 /* DEVELOPER CORNER, add your custom validation procedure */
2366 void opj_jp2_setup_decoding_validation (opj_jp2_t *jp2)
2370 /* DEVELOPER CORNER, add your custom validation procedure */
2373 void opj_jp2_setup_header_writing (opj_jp2_t *jp2)
2378 opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)opj_jp2_write_jp );
2379 opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)opj_jp2_write_ftyp );
2380 opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)opj_jp2_write_jp2h );
2382 opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)opj_jpip_skip_iptr );
2383 opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)opj_jp2_skip_jp2c );
2385 /* DEVELOPER CORNER, insert your custom procedures */
2389 void opj_jp2_setup_header_reading (opj_jp2_t *jp2)
2394 opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)opj_jp2_read_header_procedure );
2395 /* DEVELOPER CORNER, add your custom procedures */
2398 OPJ_BOOL opj_jp2_read_tile_header ( opj_jp2_t * p_jp2,
2399 OPJ_UINT32 * p_tile_index,
2400 OPJ_UINT32 * p_data_size,
2401 OPJ_INT32 * p_tile_x0,
2402 OPJ_INT32 * p_tile_y0,
2403 OPJ_INT32 * p_tile_x1,
2404 OPJ_INT32 * p_tile_y1,
2405 OPJ_UINT32 * p_nb_comps,
2407 opj_stream_private_t *p_stream,
2408 opj_event_mgr_t * p_manager
2411 return opj_j2k_read_tile_header(p_jp2->j2k,
2414 p_tile_x0, p_tile_y0,
2415 p_tile_x1, p_tile_y1,
2422 OPJ_BOOL opj_jp2_write_tile ( opj_jp2_t *p_jp2,
2423 OPJ_UINT32 p_tile_index,
2425 OPJ_UINT32 p_data_size,
2426 opj_stream_private_t *p_stream,
2427 opj_event_mgr_t * p_manager
2431 return opj_j2k_write_tile (p_jp2->j2k,p_tile_index,p_data,p_data_size,p_stream,p_manager);
2434 OPJ_BOOL opj_jp2_decode_tile ( opj_jp2_t * p_jp2,
2435 OPJ_UINT32 p_tile_index,
2437 OPJ_UINT32 p_data_size,
2438 opj_stream_private_t *p_stream,
2439 opj_event_mgr_t * p_manager
2442 return opj_j2k_decode_tile (p_jp2->j2k,p_tile_index,p_data,p_data_size,p_stream,p_manager);
2445 void opj_jp2_destroy(opj_jp2_t *jp2)
2448 /* destroy the J2K codec */
2449 opj_j2k_destroy(jp2->j2k);
2453 opj_free(jp2->comps);
2462 if (jp2->color.icc_profile_buf) {
2463 opj_free(jp2->color.icc_profile_buf);
2464 jp2->color.icc_profile_buf = 00;
2467 if (jp2->color.jp2_cdef) {
2468 if (jp2->color.jp2_cdef->info) {
2469 opj_free(jp2->color.jp2_cdef->info);
2470 jp2->color.jp2_cdef->info = NULL;
2473 opj_free(jp2->color.jp2_cdef);
2474 jp2->color.jp2_cdef = 00;
2477 if (jp2->color.jp2_pclr) {
2478 if (jp2->color.jp2_pclr->cmap) {
2479 opj_free(jp2->color.jp2_pclr->cmap);
2480 jp2->color.jp2_pclr->cmap = NULL;
2482 if (jp2->color.jp2_pclr->channel_sign) {
2483 opj_free(jp2->color.jp2_pclr->channel_sign);
2484 jp2->color.jp2_pclr->channel_sign = NULL;
2486 if (jp2->color.jp2_pclr->channel_size) {
2487 opj_free(jp2->color.jp2_pclr->channel_size);
2488 jp2->color.jp2_pclr->channel_size = NULL;
2490 if (jp2->color.jp2_pclr->entries) {
2491 opj_free(jp2->color.jp2_pclr->entries);
2492 jp2->color.jp2_pclr->entries = NULL;
2495 opj_free(jp2->color.jp2_pclr);
2496 jp2->color.jp2_pclr = 00;
2499 if (jp2->m_validation_list) {
2500 opj_procedure_list_destroy(jp2->m_validation_list);
2501 jp2->m_validation_list = 00;
2504 if (jp2->m_procedure_list) {
2505 opj_procedure_list_destroy(jp2->m_procedure_list);
2506 jp2->m_procedure_list = 00;
2513 OPJ_BOOL opj_jp2_set_decode_area( opj_jp2_t *p_jp2,
2514 opj_image_t* p_image,
2515 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
2516 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
2517 opj_event_mgr_t * p_manager
2520 return opj_j2k_set_decode_area(p_jp2->j2k, p_image, p_start_x, p_start_y, p_end_x, p_end_y, p_manager);
2523 OPJ_BOOL opj_jp2_get_tile( opj_jp2_t *p_jp2,
2524 opj_stream_private_t *p_stream,
2525 opj_image_t* p_image,
2526 opj_event_mgr_t * p_manager,
2527 OPJ_UINT32 tile_index
2533 opj_event_msg(p_manager, EVT_WARNING, "JP2 box which are after the codestream will not be read by this function.\n");
2535 if (! opj_j2k_get_tile(p_jp2->j2k, p_stream, p_image, p_manager, tile_index) ){
2536 opj_event_msg(p_manager, EVT_ERROR, "Failed to decode the codestream in the JP2 file\n");
2540 if (!opj_jp2_check_color(p_image, &(p_jp2->color), p_manager)) {
2544 /* Set Image Color Space */
2545 if (p_jp2->enumcs == 16)
2546 p_image->color_space = OPJ_CLRSPC_SRGB;
2547 else if (p_jp2->enumcs == 17)
2548 p_image->color_space = OPJ_CLRSPC_GRAY;
2549 else if (p_jp2->enumcs == 18)
2550 p_image->color_space = OPJ_CLRSPC_SYCC;
2552 p_image->color_space = OPJ_CLRSPC_UNKNOWN;
2554 /* Apply the color space if needed */
2555 if(p_jp2->color.jp2_cdef) {
2556 opj_jp2_apply_cdef(p_image, &(p_jp2->color));
2559 if(p_jp2->color.jp2_pclr) {
2560 /* Part 1, I.5.3.4: Either both or none : */
2561 if( !p_jp2->color.jp2_pclr->cmap)
2562 opj_jp2_free_pclr(&(p_jp2->color));
2564 opj_jp2_apply_pclr(p_image, &(p_jp2->color));
2567 if(p_jp2->color.icc_profile_buf) {
2568 p_image->icc_profile_buf = p_jp2->color.icc_profile_buf;
2569 p_image->icc_profile_len = p_jp2->color.icc_profile_len;
2570 p_jp2->color.icc_profile_buf = NULL;
2576 /* ----------------------------------------------------------------------- */
2577 /* JP2 encoder interface */
2578 /* ----------------------------------------------------------------------- */
2580 opj_jp2_t* opj_jp2_create(OPJ_BOOL p_is_decoder)
2582 opj_jp2_t *jp2 = (opj_jp2_t*)opj_calloc(1,sizeof(opj_jp2_t));
2585 /* create the J2K codec */
2586 if (! p_is_decoder) {
2587 jp2->j2k = opj_j2k_create_compress();
2590 jp2->j2k = opj_j2k_create_decompress();
2593 if (jp2->j2k == 00) {
2594 opj_jp2_destroy(jp2);
2598 /* Color structure */
2599 jp2->color.icc_profile_buf = NULL;
2600 jp2->color.icc_profile_len = 0;
2601 jp2->color.jp2_cdef = NULL;
2602 jp2->color.jp2_pclr = NULL;
2603 jp2->color.jp2_has_colr = 0;
2605 /* validation list creation */
2606 jp2->m_validation_list = opj_procedure_list_create();
2607 if (! jp2->m_validation_list) {
2608 opj_jp2_destroy(jp2);
2612 /* execution list creation */
2613 jp2->m_procedure_list = opj_procedure_list_create();
2614 if (! jp2->m_procedure_list) {
2615 opj_jp2_destroy(jp2);
2623 void jp2_dump(opj_jp2_t* p_jp2, OPJ_INT32 flag, FILE* out_stream)
2626 assert(p_jp2 != 00);
2628 j2k_dump(p_jp2->j2k,
2633 opj_codestream_index_t* jp2_get_cstr_index(opj_jp2_t* p_jp2)
2635 return j2k_get_cstr_index(p_jp2->j2k);
2638 opj_codestream_info_v2_t* jp2_get_cstr_info(opj_jp2_t* p_jp2)
2640 return j2k_get_cstr_info(p_jp2->j2k);
2643 OPJ_BOOL opj_jp2_set_decoded_resolution_factor(opj_jp2_t *p_jp2,
2644 OPJ_UINT32 res_factor,
2645 opj_event_mgr_t * p_manager)
2647 return opj_j2k_set_decoded_resolution_factor(p_jp2->j2k, res_factor, p_manager);
2653 static OPJ_BOOL opj_jpip_write_iptr(opj_jp2_t *jp2,
2654 opj_stream_private_t *cio,
2655 opj_event_mgr_t * p_manager )
2657 OPJ_OFF_T j2k_codestream_exit;
2658 OPJ_BYTE l_data_header [24];
2663 assert(p_manager != 00);
2664 assert(opj_stream_has_seek(cio));
2666 j2k_codestream_exit = opj_stream_tell(cio);
2667 opj_write_bytes(l_data_header, 24, 4); /* size of iptr */
2668 opj_write_bytes(l_data_header + 4,JPIP_IPTR,4); /* IPTR */
2670 opj_write_bytes(l_data_header + 4 + 4, 0, 8); /* offset */
2671 opj_write_bytes(l_data_header + 8 + 8, 0, 8); /* length */
2673 opj_write_double(l_data_header + 4 + 4, 0); /* offset */
2674 opj_write_double(l_data_header + 8 + 8, 0); /* length */
2677 if (! opj_stream_seek(cio,jp2->jpip_iptr_offset,p_manager)) {
2678 opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
2682 if (opj_stream_write_data(cio,l_data_header,24,p_manager) != 24) {
2683 opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
2687 if (! opj_stream_seek(cio,j2k_codestream_exit,p_manager)) {
2688 opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
2695 static OPJ_BOOL opj_jpip_write_fidx(opj_jp2_t *jp2,
2696 opj_stream_private_t *cio,
2697 opj_event_mgr_t * p_manager )
2699 OPJ_OFF_T j2k_codestream_exit;
2700 OPJ_BYTE l_data_header [24];
2705 assert(p_manager != 00);
2706 assert(opj_stream_has_seek(cio));
2708 opj_write_bytes(l_data_header, 24, 4); /* size of iptr */
2709 opj_write_bytes(l_data_header + 4,JPIP_FIDX,4); /* IPTR */
2710 opj_write_double(l_data_header + 4 + 4, 0); /* offset */
2711 opj_write_double(l_data_header + 8 + 8, 0); /* length */
2713 if (opj_stream_write_data(cio,l_data_header,24,p_manager) != 24) {
2714 opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
2718 j2k_codestream_exit = opj_stream_tell(cio);
2719 if (! opj_stream_seek(cio,j2k_codestream_exit,p_manager)) {
2720 opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
2727 static OPJ_BOOL opj_jpip_write_cidx(opj_jp2_t *jp2,
2728 opj_stream_private_t *cio,
2729 opj_event_mgr_t * p_manager )
2731 OPJ_OFF_T j2k_codestream_exit;
2732 OPJ_BYTE l_data_header [24];
2737 assert(p_manager != 00);
2738 assert(opj_stream_has_seek(cio));
2740 j2k_codestream_exit = opj_stream_tell(cio);
2741 opj_write_bytes(l_data_header, 24, 4); /* size of iptr */
2742 opj_write_bytes(l_data_header + 4,JPIP_CIDX,4); /* IPTR */
2744 opj_write_bytes(l_data_header + 4 + 4, 0, 8); /* offset */
2745 opj_write_bytes(l_data_header + 8 + 8, 0, 8); /* length */
2747 opj_write_double(l_data_header + 4 + 4, 0); /* offset */
2748 opj_write_double(l_data_header + 8 + 8, 0); /* length */
2751 if (! opj_stream_seek(cio,j2k_codestream_exit,p_manager)) {
2752 opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
2756 if (opj_stream_write_data(cio,l_data_header,24,p_manager) != 24) {
2757 opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
2761 j2k_codestream_exit = opj_stream_tell(cio);
2762 if (! opj_stream_seek(cio,j2k_codestream_exit,p_manager)) {
2763 opj_event_msg(p_manager, EVT_ERROR, "Failed to seek in the stream.\n");
2771 static void write_prxy( int offset_jp2c, int length_jp2c, int offset_idx, int length_idx, opj_stream_private_t *cio,
2772 opj_event_mgr_t * p_manager )
2774 OPJ_BYTE l_data_header [8];
2775 OPJ_OFF_T len, lenp;
2777 lenp = opj_stream_tell(cio);
2778 opj_stream_skip(cio, 4, p_manager); /* L [at the end] */
2779 opj_write_bytes(l_data_header,JPIP_PRXY,4); /* IPTR */
2780 opj_stream_write_data(cio,l_data_header,4,p_manager);
2782 opj_write_bytes( l_data_header, offset_jp2c, 8); /* OOFF */
2783 opj_stream_write_data(cio,l_data_header,8,p_manager);
2784 opj_write_bytes( l_data_header, length_jp2c, 4); /* OBH part 1 */
2785 opj_write_bytes( l_data_header+4, JP2_JP2C, 4); /* OBH part 2 */
2786 opj_stream_write_data(cio,l_data_header,8,p_manager);
2788 opj_write_bytes( l_data_header, 1, 1);/* NI */
2789 opj_stream_write_data(cio,l_data_header,1,p_manager);
2791 opj_write_bytes( l_data_header, offset_idx, 8); /* IOFF */
2792 opj_stream_write_data(cio,l_data_header,8,p_manager);
2793 opj_write_bytes( l_data_header, length_idx, 4); /* IBH part 1 */
2794 opj_write_bytes( l_data_header+4, JPIP_CIDX, 4); /* IBH part 2 */
2795 opj_stream_write_data(cio,l_data_header,8,p_manager);
2797 len = opj_stream_tell(cio)-lenp;
2798 opj_stream_skip(cio, lenp, p_manager);
2799 opj_write_bytes(l_data_header,len,4);/* L */
2800 opj_stream_write_data(cio,l_data_header,4,p_manager);
2801 opj_stream_seek(cio, lenp+len,p_manager);
2807 static int write_fidx( int offset_jp2c, int length_jp2c, int offset_idx, int length_idx, opj_stream_private_t *cio,
2808 opj_event_mgr_t * p_manager )
2810 OPJ_BYTE l_data_header [4];
2811 OPJ_OFF_T len, lenp;
2813 lenp = opj_stream_tell(cio);
2814 opj_stream_skip(cio, 4, p_manager);
2815 opj_write_bytes(l_data_header,JPIP_FIDX,4); /* FIDX */
2816 opj_stream_write_data(cio,l_data_header,4,p_manager);
2818 write_prxy( offset_jp2c, length_jp2c, offset_idx, length_idx, cio,p_manager);
2820 len = opj_stream_tell(cio)-lenp;
2821 opj_stream_skip(cio, lenp, p_manager);
2822 opj_write_bytes(l_data_header,len,4);/* L */
2823 opj_stream_write_data(cio,l_data_header,4,p_manager);
2824 opj_stream_seek(cio, lenp+len,p_manager);
2829 #endif /* USE_JPIP */