2 * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
3 * Copyright (c) 2002-2007, Professor Benoit Macq
4 * Copyright (c) 2002-2003, Yannick Verschueren
5 * Copyright (c) 2005, Herve Drolon, FreeImage Team
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
33 @brief The JPEG-2000 file format Reader/Writer (JP2)
37 /** @defgroup JP2 JP2 - JPEG-2000 file format reader/writer */
40 #define JPIP_JPIP 0x6a706970
42 #define JP2_JP 0x6a502020 /**< JPEG 2000 signature box */
43 #define JP2_FTYP 0x66747970 /**< File type box */
44 #define JP2_JP2H 0x6a703268 /**< JP2 header box (super-box) */
45 #define JP2_IHDR 0x69686472 /**< Image header box */
46 #define JP2_COLR 0x636f6c72 /**< Colour specification box */
47 #define JP2_JP2C 0x6a703263 /**< Contiguous codestream box */
48 #define JP2_URL 0x75726c20 /**< Data entry URL box */
49 #define JP2_PCLR 0x70636c72 /**< Palette box */
50 #define JP2_CMAP 0x636d6170 /**< Component Mapping box */
51 #define JP2_CDEF 0x63646566 /**< Channel Definition box */
52 #define JP2_DTBL 0x6474626c /**< Data Reference box */
53 #define JP2_BPCC 0x62706363 /**< Bits per component box */
54 #define JP2_JP2 0x6a703220 /**< File type fields */
57 /* #define JP2_RES 0x72657320 */ /**< Resolution box (super-box) */
58 /* #define JP2_JP2I 0x6a703269 */ /**< Intellectual property box */
59 /* #define JP2_XML 0x786d6c20 */ /**< XML box */
60 /* #define JP2_UUID 0x75756994 */ /**< UUID box */
61 /* #define JP2_UINF 0x75696e66 */ /**< UUID info box (super-box) */
62 /* #define JP2_ULST 0x756c7374 */ /**< UUID list box */
64 /* ----------------------------------------------------------------------- */
69 JP2_STATE_SIGNATURE = 0x1,
70 JP2_STATE_FILE_TYPE = 0x2,
71 JP2_STATE_HEADER = 0x4,
72 JP2_STATE_CODESTREAM = 0x8,
73 JP2_STATE_END_CODESTREAM = 0x10,
74 JP2_STATE_UNKNOWN = 0x7fffffff /* ISO C restricts enumerator values to range of 'int' */
80 JP2_IMG_STATE_NONE = 0x0,
81 JP2_IMG_STATE_UNKNOWN = 0x7fffffff
86 Channel description: channel index, type, assocation
88 typedef struct opj_jp2_cdef_info
90 OPJ_UINT16 cn, typ, asoc;
91 } opj_jp2_cdef_info_t;
94 Channel descriptions and number of descriptions
96 typedef struct opj_jp2_cdef
98 opj_jp2_cdef_info_t *info;
103 Component mappings: channel index, mapping type, palette index
105 typedef struct opj_jp2_cmap_comp
109 } opj_jp2_cmap_comp_t;
112 Palette data: table entries, palette columns
114 typedef struct opj_jp2_pclr
117 OPJ_BYTE *channel_sign;
118 OPJ_BYTE *channel_size;
119 opj_jp2_cmap_comp_t *cmap;
120 OPJ_UINT16 nr_entries;
121 OPJ_BYTE nr_channels;
125 Collector for ICC profile, palette, component mapping, channel description
127 typedef struct opj_jp2_color
129 OPJ_BYTE *icc_profile_buf;
130 OPJ_UINT32 icc_profile_len;
132 opj_jp2_cdef_t *jp2_cdef;
133 opj_jp2_pclr_t *jp2_pclr;
134 OPJ_BYTE jp2_has_colr;
140 typedef struct opj_jp2_comps {
147 JPEG-2000 file format reader/writer
149 typedef struct opj_jp2 {
151 opj_common_ptr cinfo;
152 /** handle to the J2K codec */
156 unsigned int numcomps;
164 unsigned int precedence;
166 unsigned int minversion;
169 opj_jp2_comps_t *comps;
170 unsigned int j2k_codestream_offset;
171 unsigned int j2k_codestream_length;
173 opj_bool ignore_pclr_cmap_cdef;
177 JPEG-2000 file format reader/writer
179 typedef struct opj_jp2_v2
181 /** handle to the J2K codec */
182 struct opj_j2k_v2 *j2k;
183 /** list of validation procedures */
184 struct opj_procedure_list * m_validation_list;
185 /** list of execution procedures */
186 struct opj_procedure_list * m_procedure_list;
190 /* height of image */
192 /* number of components in the image */
201 OPJ_UINT32 precedence;
203 OPJ_UINT32 minversion;
206 opj_jp2_comps_t *comps;
207 OPJ_OFF_T j2k_codestream_offset;
208 OPJ_UINT32 jp2_state;
209 OPJ_UINT32 jp2_img_state;
211 opj_jp2_color_t color;
213 opj_bool ignore_pclr_cmap_cdef;
220 typedef struct opj_jp2_box {
226 typedef struct opj_jp2_header_handler
230 /* action linked to the marker */
231 opj_bool (*handler) ( opj_jp2_v2_t *jp2,
232 OPJ_BYTE *p_header_data,
233 OPJ_UINT32 p_header_size,
234 opj_event_mgr_t * p_manager);
236 opj_jp2_header_handler_t;
239 typedef struct opj_jp2_img_header_writer_handler
241 /* action to perform */
242 OPJ_BYTE* (*handler) (opj_jp2_v2_t *jp2, OPJ_UINT32 * p_data_size);
243 /* result of the action : data */
248 opj_jp2_img_header_writer_handler_t;
250 /** @name Exported functions */
252 /* ----------------------------------------------------------------------- */
255 * Writes the Jpeg2000 file Header box - JP2 Header box (warning, this is a super box).
257 * @param jp2 the jpeg2000 file codec.
258 * @param stream the stream to write data to.
259 * @param p_manager user event manager.
261 * @return true if writting was successful.
263 opj_bool opj_jp2_write_jp2h(opj_jp2_v2_t *jp2,
264 opj_stream_private_t *stream,
265 opj_event_mgr_t * p_manager );
268 Setup the decoder decoding parameters using user parameters.
269 Decoding parameters are returned in jp2->j2k->cp.
270 @param jp2 JP2 decompressor handle
271 @param parameters decompression parameters
273 void opj_jp2_setup_decoder(opj_jp2_v2_t *jp2, opj_dparameters_t *parameters);
276 * Decode an image from a JPEG-2000 file stream
277 * @param jp2 JP2 decompressor handle
278 * @param p_stream FIXME DOC
279 * @param p_image FIXME DOC
280 * @param p_manager FIXME DOC
282 * @return Returns a decoded image if successful, returns NULL otherwise
284 opj_bool opj_jp2_decode(opj_jp2_v2_t *jp2,
285 opj_stream_private_t *p_stream,
286 opj_image_t* p_image,
287 opj_event_mgr_t * p_manager);
290 * Setup the encoder parameters using the current image and using user parameters.
291 * Coding parameters are returned in jp2->j2k->cp.
293 * @param jp2 JP2 compressor handle
294 * @param parameters compression parameters
295 * @param image input filled image
296 * @param p_manager FIXME DOC
298 void opj_jp2_setup_encoder( opj_jp2_v2_t *jp2,
299 opj_cparameters_t *parameters,
301 opj_event_mgr_t * p_manager);
304 Encode an image into a JPEG-2000 file stream
305 @param jp2 JP2 compressor handle
306 @param stream Output buffer stream
307 @param p_manager event manager
308 @return Returns true if successful, returns false otherwise
310 opj_bool opj_jp2_encode( opj_jp2_v2_t *jp2,
311 opj_stream_private_t *stream,
312 opj_event_mgr_t * p_manager);
316 * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
318 * @param jp2 the jpeg2000 file codec.
319 * @param stream the stream object.
320 * @param p_image FIXME DOC
321 * @param p_manager FIXME DOC
323 * @return true if the codec is valid.
325 opj_bool opj_jp2_start_compress(opj_jp2_v2_t *jp2,
326 opj_stream_private_t *stream,
327 opj_image_t * p_image,
328 opj_event_mgr_t * p_manager);
332 * Ends the compression procedures and possibiliy add data to be read after the
335 opj_bool opj_jp2_end_compress( opj_jp2_v2_t *jp2,
336 opj_stream_private_t *cio,
337 opj_event_mgr_t * p_manager);
339 /* ----------------------------------------------------------------------- */
342 * Ends the decompression procedures and possibiliy add data to be read after the
345 opj_bool opj_jp2_end_decompress(opj_jp2_v2_t *jp2,
346 opj_stream_private_t *cio,
347 opj_event_mgr_t * p_manager);
350 * Reads a jpeg2000 file header structure.
352 * @param p_stream the stream to read data from.
353 * @param jp2 the jpeg2000 file header structure.
354 * @param p_image FIXME DOC
355 * @param p_manager the user event manager.
357 * @return true if the box is valid.
359 opj_bool opj_jp2_read_header( opj_stream_private_t *p_stream,
361 opj_image_t ** p_image,
362 opj_event_mgr_t * p_manager );
365 * Reads a tile header.
366 * @param p_jp2 the jpeg2000 codec.
367 * @param p_tile_index FIXME DOC
368 * @param p_data_size FIXME DOC
369 * @param p_tile_x0 FIXME DOC
370 * @param p_tile_y0 FIXME DOC
371 * @param p_tile_x1 FIXME DOC
372 * @param p_tile_y1 FIXME DOC
373 * @param p_nb_comps FIXME DOC
374 * @param p_go_on FIXME DOC
375 * @param p_stream the stream to write data to.
376 * @param p_manager the user event manager.
378 opj_bool opj_jp2_read_tile_header ( opj_jp2_v2_t * p_jp2,
379 OPJ_UINT32 * p_tile_index,
380 OPJ_UINT32 * p_data_size,
381 OPJ_INT32 * p_tile_x0,
382 OPJ_INT32 * p_tile_y0,
383 OPJ_INT32 * p_tile_x1,
384 OPJ_INT32 * p_tile_y1,
385 OPJ_UINT32 * p_nb_comps,
387 opj_stream_private_t *p_stream,
388 opj_event_mgr_t * p_manager );
393 * @param p_jp2 the jpeg2000 codec.
394 * @param p_tile_index FIXME DOC
395 * @param p_data FIXME DOC
396 * @param p_data_size FIXME DOC
397 * @param p_stream the stream to write data to.
398 * @param p_manager the user event manager.
400 opj_bool opj_jp2_write_tile ( opj_jp2_v2_t *p_jp2,
401 OPJ_UINT32 p_tile_index,
403 OPJ_UINT32 p_data_size,
404 opj_stream_private_t *p_stream,
405 opj_event_mgr_t * p_manager );
409 * @param p_jp2 the jpeg2000 codec.
410 * @param p_tile_index FIXME DOC
411 * @param p_data FIXME DOC
412 * @param p_data_size FIXME DOC
413 * @param p_stream the stream to write data to.
414 * @param p_manager the user event manager.
418 opj_bool opj_jp2_decode_tile ( opj_jp2_v2_t * p_jp2,
419 OPJ_UINT32 p_tile_index,
421 OPJ_UINT32 p_data_size,
422 opj_stream_private_t *p_stream,
423 opj_event_mgr_t * p_manager );
426 * Creates a jpeg2000 file decompressor.
428 * @return an empty jpeg2000 file codec.
430 opj_jp2_v2_t* opj_jp2_create (opj_bool p_is_decoder);
433 Destroy a JP2 decompressor handle
434 @param jp2 JP2 decompressor handle to destroy
436 void opj_jp2_destroy(opj_jp2_v2_t *jp2);
440 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
442 * @param p_jp2 the jpeg2000 codec.
443 * @param p_image FIXME DOC
444 * @param p_start_x the left position of the rectangle to decode (in image coordinates).
445 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
446 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
447 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
448 * @param p_manager the user event manager
450 * @return true if the area could be set.
452 opj_bool opj_jp2_set_decode_area( opj_jp2_v2_t *p_jp2,
453 opj_image_t* p_image,
454 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
455 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
456 opj_event_mgr_t * p_manager );
461 opj_bool opj_jp2_get_tile( opj_jp2_v2_t *p_jp2,
462 opj_stream_private_t *p_stream,
463 opj_image_t* p_image,
464 opj_event_mgr_t * p_manager,
465 OPJ_UINT32 tile_index );
471 opj_bool opj_jp2_set_decoded_resolution_factor(opj_jp2_v2_t *p_jp2,
472 OPJ_UINT32 res_factor,
473 opj_event_mgr_t * p_manager);
476 /* TODO MSD: clean these 3 functions */
478 * Dump some elements from the JP2 decompression structure .
480 *@param p_jp2 the jp2 codec.
481 *@param flag flag to describe what elments are dump.
482 *@param out_stream output stream where dump the elements.
485 void jp2_dump (opj_jp2_v2_t* p_jp2, OPJ_INT32 flag, FILE* out_stream);
488 * Get the codestream info from a JPEG2000 codec.
490 *@param p_jp2 jp2 codec.
492 *@return the codestream information extract from the jpg2000 codec
494 opj_codestream_info_v2_t* jp2_get_cstr_info(opj_jp2_v2_t* p_jp2);
497 * Get the codestream index from a JPEG2000 codec.
499 *@param p_jp2 jp2 codec.
501 *@return the codestream index extract from the jpg2000 codec
503 opj_codestream_index_t* jp2_get_cstr_index(opj_jp2_v2_t* p_jp2);