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 */
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 /**< URL box */
49 #define JP2_DBTL 0x6474626c /**< ??? */
50 #define JP2_BPCC 0x62706363 /**< Bits per component box */
51 #define JP2_JP2 0x6a703220 /**< File type fields */
53 /* ----------------------------------------------------------------------- */
58 typedef struct opj_jp2_comps {
65 JPEG-2000 file format reader/writer
67 typedef struct opj_jp2 {
70 /** handle to the J2K codec */
74 unsigned int numcomps;
82 unsigned int precedence;
84 unsigned int minversion;
87 opj_jp2_comps_t *comps;
88 unsigned int j2k_codestream_offset;
89 unsigned int j2k_codestream_length;
95 typedef struct opj_jp2_box {
101 /** @name Exported functions */
103 /* ----------------------------------------------------------------------- */
105 Write the JP2H box - JP2 Header box (used in MJ2)
106 @param jp2 JP2 handle
107 @param cio Output buffer stream
109 void jp2_write_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
111 Read the JP2H box - JP2 Header box (used in MJ2)
112 @param jp2 JP2 handle
113 @param cio Input buffer stream
114 @return Returns true if successful, returns false otherwise
116 bool jp2_read_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
118 Creates a JP2 decompression structure
119 @param cinfo Codec context info
120 @return Returns a handle to a JP2 decompressor if successful, returns NULL otherwise
122 opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);
124 Destroy a JP2 decompressor handle
125 @param jp2 JP2 decompressor handle to destroy
127 void jp2_destroy_decompress(opj_jp2_t *jp2);
129 Setup the decoder decoding parameters using user parameters.
130 Decoding parameters are returned in jp2->j2k->cp.
131 @param jp2 JP2 decompressor handle
132 @param parameters decompression parameters
134 void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
136 Decode an image from a JPEG-2000 file stream
137 @param jp2 JP2 decompressor handle
138 @param cio Input buffer stream
139 @return Returns a decoded image if successful, returns NULL otherwise
141 opj_image_t* jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio);
143 Creates a JP2 compression structure
144 @param cinfo Codec context info
145 @return Returns a handle to a JP2 compressor if successful, returns NULL otherwise
147 opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);
149 Destroy a JP2 compressor handle
150 @param jp2 JP2 compressor handle to destroy
152 void jp2_destroy_compress(opj_jp2_t *jp2);
154 Setup the encoder parameters using the current image and using user parameters.
155 Coding parameters are returned in jp2->j2k->cp.
156 @param jp2 JP2 compressor handle
157 @param parameters compression parameters
158 @param image input filled image
160 void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);
162 Encode an image into a JPEG-2000 file stream
163 @param jp2 JP2 compressor handle
164 @param cio Output buffer stream
165 @param image Image to encode
166 @param index Name of the index file if required, NULL otherwise
167 @return Returns true if successful, returns false otherwise
169 bool jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, char *index);
170 /* ----------------------------------------------------------------------- */