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 */
45 #define JP2_JP2H 0x6a703268 /**< JP2 header box (super-box) */
46 #define JP2_IHDR 0x69686472 /**< Image header box */
47 #define JP2_BPCC 0x62706363 /**< Bits per component box */
48 #define JP2_COLR 0x636f6c72 /**< Colour specification box */
49 #define JP2_PCLR 0x70636c72 /**< Palette box */
50 #define JP2_CMAP 0x636d6170 /**< Component Mapping box */
51 #define JP2_CDEF 0x63646566 /**< Channel Definition box */
53 // #define JP2_RES 0x72657320 /**< Resolution box (super-box) */
55 #define JP2_JP2C 0x6a703263 /**< Contiguous codestream 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 */
63 #define JP2_URL 0x75726c20 /**< Data entry URL box */
65 #define JP2_DTBL 0x6474626c /**< Data Reference box */
67 #define JP2_JP2 0x6a703220 /**< File type fields */
70 /* ----------------------------------------------------------------------- */
75 JP2_STATE_SIGNATURE = 0x1,
76 JP2_STATE_FILE_TYPE = 0x2,
77 JP2_STATE_HEADER = 0x4,
78 JP2_STATE_CODESTREAM = 0x8,
79 JP2_STATE_END_CODESTREAM = 0x10,
80 JP2_STATE_UNKNOWN = 0x80000000
86 JP2_IMG_STATE_NONE = 0x0,
87 JP2_IMG_STATE_UNKNOWN = 0x80000000
92 Channel description: channel index, type, assocation
94 typedef struct opj_jp2_cdef_info
96 unsigned short cn, typ, asoc;
97 } opj_jp2_cdef_info_t;
100 Channel descriptions and number of descriptions
102 typedef struct opj_jp2_cdef
104 opj_jp2_cdef_info_t *info;
109 Component mappings: channel index, mapping type, palette index
111 typedef struct opj_jp2_cmap_comp
114 unsigned char mtyp, pcol;
115 } opj_jp2_cmap_comp_t;
118 Palette data: table entries, palette columns
120 typedef struct opj_jp2_pclr
122 unsigned int *entries;
123 unsigned char *channel_sign;
124 unsigned char *channel_size;
125 opj_jp2_cmap_comp_t *cmap;
126 unsigned short nr_entries, nr_channels;
130 Collector for ICC profile, palette, component mapping, channel description
132 typedef struct opj_jp2_color
134 unsigned char *icc_profile_buf;
137 opj_jp2_cdef_t *jp2_cdef;
138 opj_jp2_pclr_t *jp2_pclr;
139 unsigned char jp2_has_colr;
145 typedef struct opj_jp2_comps {
152 JPEG-2000 file format reader/writer
154 typedef struct opj_jp2 {
156 opj_common_ptr cinfo;
157 /** handle to the J2K codec */
161 unsigned int numcomps;
169 unsigned int precedence;
171 unsigned int minversion;
174 opj_jp2_comps_t *comps;
175 unsigned int j2k_codestream_offset;
176 unsigned int j2k_codestream_length;
181 JPEG-2000 file format reader/writer
183 typedef struct opj_jp2_v2
185 /** handle to the J2K codec */
186 struct opj_j2k_v2 *j2k;
187 /** list of validation procedures */
188 struct opj_procedure_list * m_validation_list;
189 /** list of execution procedures */
190 struct opj_procedure_list * m_procedure_list;
194 /* height of image */
196 /* number of components in the image */
205 OPJ_UINT32 precedence;
207 OPJ_UINT32 minversion;
210 opj_jp2_comps_t *comps;
211 OPJ_UINT32 j2k_codestream_offset;
212 OPJ_UINT32 jp2_state;
213 OPJ_UINT32 jp2_img_state;
215 opj_jp2_color_t color;
223 typedef struct opj_jp2_box {
229 typedef struct opj_jp2_header_handler
233 /* action linked to the marker */
234 opj_bool (*handler) (opj_jp2_v2_t *jp2, unsigned char * p_header_data, OPJ_UINT32 p_header_size, struct opj_event_mgr * p_manager);
236 opj_jp2_header_handler_t;
238 /** @name Exported functions */
240 /* ----------------------------------------------------------------------- */
242 Write the JP2H box - JP2 Header box (used in MJ2)
243 @param jp2 JP2 handle
244 @param cio Output buffer stream
246 void jp2_write_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
248 Read the JP2H box - JP2 Header box (used in MJ2)
249 @param jp2 JP2 handle
250 @param cio Input buffer stream
251 @param ext Collector for profile, cdef and pclr data
252 @return Returns true if successful, returns false otherwise
254 opj_bool jp2_read_jp2h(opj_jp2_t *jp2, opj_cio_t *cio, opj_jp2_color_t *color);
256 Creates a JP2 decompression structure
257 @param cinfo Codec context info
258 @return Returns a handle to a JP2 decompressor if successful, returns NULL otherwise
260 opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);
262 Destroy a JP2 decompressor handle
263 @param jp2 JP2 decompressor handle to destroy
265 void jp2_destroy_decompress(opj_jp2_t *jp2);
267 Setup the decoder decoding parameters using user parameters.
268 Decoding parameters are returned in jp2->j2k->cp.
269 @param jp2 JP2 decompressor handle
270 @param parameters decompression parameters
272 void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
274 Setup the decoder decoding parameters using user parameters.
275 Decoding parameters are returned in jp2->j2k->cp.
276 @param jp2 JP2 decompressor handle
277 @param parameters decompression parameters
279 void jp2_setup_decoder_v2(opj_jp2_v2_t *jp2, opj_dparameters_t *parameters);
281 Decode an image from a JPEG-2000 file stream
282 @param jp2 JP2 decompressor handle
283 @param cio Input buffer stream
284 @param cstr_info Codestream information structure if required, NULL otherwise
285 @return Returns a decoded image if successful, returns NULL otherwise
287 opj_image_t* opj_jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
289 Creates a JP2 compression structure
290 @param cinfo Codec context info
291 @return Returns a handle to a JP2 compressor if successful, returns NULL otherwise
293 opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);
295 Destroy a JP2 compressor handle
296 @param jp2 JP2 compressor handle to destroy
298 void jp2_destroy_compress(opj_jp2_t *jp2);
300 Setup the encoder parameters using the current image and using user parameters.
301 Coding parameters are returned in jp2->j2k->cp.
302 @param jp2 JP2 compressor handle
303 @param parameters compression parameters
304 @param image input filled image
306 void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);
308 Encode an image into a JPEG-2000 file stream
309 @param jp2 JP2 compressor handle
310 @param cio Output buffer stream
311 @param image Image to encode
312 @param cstr_info Codestream information structure if required, NULL otherwise
313 @return Returns true if successful, returns false otherwise
315 opj_bool opj_jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, opj_codestream_info_t *cstr_info);
318 /* ----------------------------------------------------------------------- */
321 * Ends the decompression procedures and possibiliy add data to be read after the
324 opj_bool jp2_end_decompress(opj_jp2_v2_t *jp2, struct opj_stream_private *cio, struct opj_event_mgr * p_manager);
327 * Reads a jpeg2000 file header structure.
329 * @param cio the stream to read data from.
330 * @param jp2 the jpeg2000 file header structure.
331 * @param p_manager the user event manager.
333 * @return true if the box is valid.
335 opj_bool jp2_read_header( struct opj_stream_private *p_stream,
337 opj_file_info_t * p_file_info,
338 struct opj_event_mgr * p_manager
342 * Reads a tile header.
343 * @param p_j2k the jpeg2000 codec.
344 * @param p_stream the stream to write data to.
345 * @param p_manager the user event manager.
347 opj_bool jp2_read_tile_header (
348 opj_jp2_v2_t * p_j2k,
349 OPJ_UINT32 * p_tile_index,
350 OPJ_UINT32 * p_data_size,
351 OPJ_INT32 * p_tile_x0,
352 OPJ_INT32 * p_tile_y0,
353 OPJ_INT32 * p_tile_x1,
354 OPJ_INT32 * p_tile_y1,
355 OPJ_UINT32 * p_nb_comps,
357 struct opj_stream_private *p_stream,
358 struct opj_event_mgr * p_manager
363 * @param p_j2k the jpeg2000 codec.
364 * @param p_stream the stream to write data to.
365 * @param p_manager the user event manager.
367 opj_bool opj_jp2_decode_tile (
368 opj_jp2_v2_t * p_jp2,
369 OPJ_UINT32 p_tile_index,
371 OPJ_UINT32 p_data_size,
372 struct opj_stream_private *p_stream,
373 struct opj_event_mgr * p_manager
377 * Creates a jpeg2000 file decompressor.
379 * @return an empty jpeg2000 file codec.
381 opj_jp2_v2_t* jp2_create (opj_bool p_is_decoder);
384 Destroy a JP2 decompressor handle
385 @param jp2 JP2 decompressor handle to destroy
387 void jp2_destroy(opj_jp2_v2_t *jp2);
391 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
393 * @param p_jp2 the jpeg2000 codec.
394 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
395 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
396 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
397 * @param p_manager the user event manager
399 * @return true if the area could be set.
401 opj_bool jp2_set_decode_area(
407 struct opj_event_mgr * p_manager