2 * Copyright (c) 2004, Yannick Verschueren
3 * Copyright (c) 2005, Hervé Drolon, FreeImage Team
4 * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
32 @brief The JPEG-2000 file format Reader/Writer (JP2)
36 /** @defgroup JP2 JP2 - JPEG-2000 file format reader/writer */
39 #define JPIP_JPIP 0x6a706970
41 #define JP2_JP 0x6a502020 /**< JPEG 2000 signature box */
42 #define JP2_FTYP 0x66747970 /**< File type box */
43 #define JP2_JP2H 0x6a703268 /**< JP2 header box */
44 #define JP2_IHDR 0x69686472 /**< Image header box */
45 #define JP2_COLR 0x636f6c72 /**< Colour specification box */
46 #define JP2_JP2C 0x6a703263 /**< Contiguous codestream box */
47 #define JP2_URL 0x75726c20 /**< URL box */
48 #define JP2_DBTL 0x6474626c /**< ??? */
49 #define JP2_BPCC 0x62706363 /**< Bits per component box */
50 #define JP2_JP2 0x6a703220 /**< File type fields */
52 /* ----------------------------------------------------------------------- */
57 typedef struct opj_jp2_comps {
64 JPEG-2000 file format reader/writer
66 typedef struct opj_jp2 {
69 /** handle to the J2K codec */
73 unsigned int numcomps;
81 unsigned int precedence;
83 unsigned int minversion;
86 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 Creates a JP2 decompression structure
106 @param cinfo Codec context info
107 @return Returns a handle to a JP2 decompressor if successful, returns NULL otherwise
109 opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);
111 Destroy a JP2 decompressor handle
112 @param jp2 JP2 decompressor handle to destroy
114 void jp2_destroy_decompress(opj_jp2_t *jp2);
116 Setup the decoder decoding parameters using user parameters.
117 Decoding parameters are returned in jp2->j2k->cp.
118 @param jp2 JP2 decompressor handle
119 @param parameters decompression parameters
121 void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
123 Decode an image from a JPEG-2000 file stream
124 @param jp2 JP2 decompressor handle
125 @param cio Input buffer stream
126 @return Returns a decoded image if successful, returns NULL otherwise
128 opj_image_t* jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio);
130 Creates a JP2 compression structure
131 @param cinfo Codec context info
132 @return Returns a handle to a JP2 compressor if successful, returns NULL otherwise
134 opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);
136 Destroy a JP2 compressor handle
137 @param jp2 JP2 compressor handle to destroy
139 void jp2_destroy_compress(opj_jp2_t *jp2);
141 Setup the encoder parameters using the current image and using user parameters.
142 Coding parameters are returned in jp2->j2k->cp.
143 @param jp2 JP2 compressor handle
144 @param parameters compression parameters
145 @param image input filled image
147 void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);
149 Encode an image into a JPEG-2000 file stream
150 @param jp2 JP2 compressor handle
151 @param cio Output buffer stream
152 @param image Image to encode
153 @param index Name of the index file if required, NULL otherwise
154 @return Returns true if successful, returns false otherwise
156 bool jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, char *index);
157 /* ----------------------------------------------------------------------- */