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_DTBL 0x6474626c /**< Data Reference box */
50
#define JP2_BPCC 0x62706363 /**< Bits per component box */
51
#define JP2_JP2 0x6a703220 /**< File type fields */
52
#define JP2_PCLR 0x70636c72 /**< Palette box */
53
#define JP2_CMAP 0x636d6170 /**< Component Mapping box */
54
#define JP2_CDEF 0x63646566 /**< Channel Definition box */
56
/* ----------------------------------------------------------------------- */
58
Channel description: channel index, type, assocation
60
typedef struct opj_jp2_cdef_info
62
unsigned short cn, typ, asoc;
63
} opj_jp2_cdef_info_t;
66
Channel descriptions and number of descriptions
68
typedef struct opj_jp2_cdef
70
opj_jp2_cdef_info_t *info;
75
Component mappings: channel index, mapping type, palette index
77
typedef struct opj_jp2_cmap_comp
80
unsigned char mtyp, pcol;
81
} opj_jp2_cmap_comp_t;
84
Palette data: table entries, palette columns
86
typedef struct opj_jp2_pclr
88
unsigned int *entries;
89
unsigned char *channel_sign;
90
unsigned char *channel_size;
91
opj_jp2_cmap_comp_t *cmap;
92
unsigned short nr_entries, nr_channels;
96
Collector for ICC profile, palette, component mapping, channel description
98
typedef struct opj_jp2_color
100
unsigned char *icc_profile_buf;
103
opj_jp2_cdef_t *jp2_cdef;
104
opj_jp2_pclr_t *jp2_pclr;
105
unsigned char jp2_has_colr;
111
typedef struct opj_jp2_comps {
118
JPEG-2000 file format reader/writer
120
typedef struct opj_jp2 {
122
opj_common_ptr cinfo;
123
/** handle to the J2K codec */
127
unsigned int numcomps;
135
unsigned int precedence;
137
unsigned int minversion;
140
opj_jp2_comps_t *comps;
141
unsigned int j2k_codestream_offset;
142
unsigned int j2k_codestream_length;
144
opj_bool ignore_pclr_cmap_cdef;
150
typedef struct opj_jp2_box {
156
/** @name Exported functions */
158
/* ----------------------------------------------------------------------- */
160
Write the JP2H box - JP2 Header box (used in MJ2)
161
@param jp2 JP2 handle
162
@param cio Output buffer stream
164
void jp2_write_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
166
Read the JP2H box - JP2 Header box (used in MJ2)
167
@param jp2 JP2 handle
168
@param cio Input buffer stream
169
@param ext Collector for profile, cdef and pclr data
170
@return Returns true if successful, returns false otherwise
172
opj_bool jp2_read_jp2h(opj_jp2_t *jp2, opj_cio_t *cio, opj_jp2_color_t *color);
174
Creates a JP2 decompression structure
175
@param cinfo Codec context info
176
@return Returns a handle to a JP2 decompressor if successful, returns NULL otherwise
178
opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);
180
Destroy a JP2 decompressor handle
181
@param jp2 JP2 decompressor handle to destroy
183
void jp2_destroy_decompress(opj_jp2_t *jp2);
185
Setup the decoder decoding parameters using user parameters.
186
Decoding parameters are returned in jp2->j2k->cp.
187
@param jp2 JP2 decompressor handle
188
@param parameters decompression parameters
190
void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
192
Decode an image from a JPEG-2000 file stream
193
@param jp2 JP2 decompressor handle
194
@param cio Input buffer stream
195
@param cstr_info Codestream information structure if required, NULL otherwise
196
@return Returns a decoded image if successful, returns NULL otherwise
198
opj_image_t* opj_jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio, opj_codestream_info_t *cstr_info, opj_bool return_indexed);
200
Creates a JP2 compression structure
201
@param cinfo Codec context info
202
@return Returns a handle to a JP2 compressor if successful, returns NULL otherwise
204
opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);
206
Destroy a JP2 compressor handle
207
@param jp2 JP2 compressor handle to destroy
209
void jp2_destroy_compress(opj_jp2_t *jp2);
211
Setup the encoder parameters using the current image and using user parameters.
212
Coding parameters are returned in jp2->j2k->cp.
213
@param jp2 JP2 compressor handle
214
@param parameters compression parameters
215
@param image input filled image
217
void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);
219
Encode an image into a JPEG-2000 file stream
220
@param jp2 JP2 compressor handle
221
@param cio Output buffer stream
222
@param image Image to encode
223
@param cstr_info Codestream information structure if required, NULL otherwise
224
@return Returns true if successful, returns false otherwise
226
opj_bool opj_jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, opj_codestream_info_t *cstr_info);
228
/* ----------------------------------------------------------------------- */
added
removed
openjpeg/libopenjpeg/jp2.h
