Fixed j2k_prog_order_list[]. Modifications in j2k.c.
[openjpeg.git] / libopenjpeg / jp2.h
1 /*
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
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
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.
16  *
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.
28  */
29 #ifndef __JP2_H
30 #define __JP2_H
31 /**
32 @file jp2.h
33 @brief The JPEG-2000 file format Reader/Writer (JP2)
34
35 */
36
37 /** @defgroup JP2 JP2 - JPEG-2000 file format reader/writer */
38 /*@{*/
39
40 #define JPIP_JPIP 0x6a706970
41
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 */
52
53 /* ----------------------------------------------------------------------- */
54
55 /** 
56 JP2 component
57 */
58 typedef struct opj_jp2_comps {
59   int depth;              
60   int sgnd;                
61   int bpcc;
62 } opj_jp2_comps_t;
63
64 /**
65 JPEG-2000 file format reader/writer
66 */
67 typedef struct opj_jp2 {
68         /** codec context */
69         opj_common_ptr cinfo;
70         /** handle to the J2K codec  */
71         opj_j2k_t *j2k;
72         unsigned int w;
73         unsigned int h;
74         unsigned int numcomps;
75         unsigned int bpc;
76         unsigned int C;
77         unsigned int UnkC;
78         unsigned int IPR;
79         unsigned int meth;
80         unsigned int approx;
81         unsigned int enumcs;
82         unsigned int precedence;
83         unsigned int brand;
84         unsigned int minversion;
85         unsigned int numcl;
86         unsigned int *cl;
87         opj_jp2_comps_t *comps;
88         unsigned int j2k_codestream_offset;
89         unsigned int j2k_codestream_length;
90 } opj_jp2_t;
91
92 /**
93 JP2 Box
94 */
95 typedef struct opj_jp2_box {
96   int length;
97   int type;
98   int init_pos;
99 } opj_jp2_box_t;
100
101 /** @name Exported functions */
102 /*@{*/
103 /* ----------------------------------------------------------------------- */
104 /**
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
108 */
109 opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);
110 /**
111 Destroy a JP2 decompressor handle
112 @param jp2 JP2 decompressor handle to destroy
113 */
114 void jp2_destroy_decompress(opj_jp2_t *jp2);
115 /**
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
120 */
121 void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
122 /**
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
127 */
128 opj_image_t* jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio);
129 /**
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
133 */
134 opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);
135 /**
136 Destroy a JP2 compressor handle
137 @param jp2 JP2 compressor handle to destroy
138 */
139 void jp2_destroy_compress(opj_jp2_t *jp2);
140 /**
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
146 */
147 void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);
148 /**
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
155 */
156 bool jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, char *index);
157 /* ----------------------------------------------------------------------- */
158 /*@}*/
159
160 /*@}*/
161
162 #endif /* __JP2_H */
163