Upgrade openjpeg to revision 2997.
[pdfium.git] / core / src / fxcodec / fx_libopenjpeg / libopenjpeg20 / openjpeg.h
1  /*
2  * The copyright in this software is being made available under the 2-clauses 
3  * BSD License, included below. This software may be subject to other third 
4  * party and contributor rights, including patent rights, and no such rights
5  * are granted under this license.
6  *
7  * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
8  * Copyright (c) 2002-2014, Professor Benoit Macq
9  * Copyright (c) 2001-2003, David Janssens
10  * Copyright (c) 2002-2003, Yannick Verschueren
11  * Copyright (c) 2003-2007, Francois-Olivier Devaux 
12  * Copyright (c) 2003-2014, Antonin Descampe
13  * Copyright (c) 2005, Herve Drolon, FreeImage Team
14  * Copyright (c) 2006-2007, Parvatha Elangovan
15  * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
16  * Copyright (c) 2010-2011, Kaori Hagihara
17  * Copyright (c) 2011-2012, Centre National d'Etudes Spatiales (CNES), France 
18  * Copyright (c) 2012, CS Systemes d'Information, France
19  * All rights reserved.
20  *
21  * Redistribution and use in source and binary forms, with or without
22  * modification, are permitted provided that the following conditions
23  * are met:
24  * 1. Redistributions of source code must retain the above copyright
25  *    notice, this list of conditions and the following disclaimer.
26  * 2. Redistributions in binary form must reproduce the above copyright
27  *    notice, this list of conditions and the following disclaimer in the
28  *    documentation and/or other materials provided with the distribution.
29  *
30  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
31  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
34  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
35  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
36  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
37  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
38  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
40  * POSSIBILITY OF SUCH DAMAGE.
41  */
42 #ifndef OPENJPEG_H
43 #define OPENJPEG_H
44
45
46 /* 
47 ==========================================================
48    Compiler directives
49 ==========================================================
50 */
51
52 /*
53 The inline keyword is supported by C99 but not by C90. 
54 Most compilers implement their own version of this keyword ... 
55 */
56 #ifndef INLINE
57         #if defined(_MSC_VER)
58                 #define INLINE __forceinline
59         #elif defined(__GNUC__)
60                 #define INLINE __inline__
61         #elif defined(__MWERKS__)
62                 #define INLINE inline
63         #else 
64                 /* add other compilers here ... */
65                 #define INLINE 
66         #endif /* defined(<Compiler>) */
67 #endif /* INLINE */
68
69 /* deprecated attribute */
70 #ifdef __GNUC__
71         #define OPJ_DEPRECATED(func) func __attribute__ ((deprecated))
72 #elif defined(_MSC_VER)
73         #define OPJ_DEPRECATED(func) __declspec(deprecated) func
74 #else
75         #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
76         #define OPJ_DEPRECATED(func) func
77 #endif
78
79 #if defined(OPJ_STATIC) || !defined(_WIN32)
80 /* http://gcc.gnu.org/wiki/Visibility */
81 #       if __GNUC__ >= 4
82 #               if defined(OPJ_STATIC) /* static library uses "hidden" */
83 #                       define OPJ_API    __attribute__ ((visibility ("hidden")))
84 #               else
85 #                       define OPJ_API    __attribute__ ((visibility ("default")))
86 #               endif
87 #               define OPJ_LOCAL  __attribute__ ((visibility ("hidden")))
88 #       else
89 #               define OPJ_API
90 #               define OPJ_LOCAL
91 #       endif
92 #       define OPJ_CALLCONV
93 #else
94 #       define OPJ_CALLCONV __stdcall
95 /*
96 The following ifdef block is the standard way of creating macros which make exporting 
97 from a DLL simpler. All files within this DLL are compiled with the OPJ_EXPORTS
98 symbol defined on the command line. this symbol should not be defined on any project
99 that uses this DLL. This way any other project whose source files include this file see 
100 OPJ_API functions as being imported from a DLL, wheras this DLL sees symbols
101 defined with this macro as being exported.
102 */
103 #       if defined(OPJ_EXPORTS) || defined(DLL_EXPORT)
104 #               define OPJ_API __declspec(dllexport)
105 #       else
106 #               define OPJ_API __declspec(dllimport)
107 #       endif /* OPJ_EXPORTS */
108 #endif /* !OPJ_STATIC || !_WIN32 */
109
110 typedef int OPJ_BOOL;
111 #define OPJ_TRUE 1
112 #define OPJ_FALSE 0
113
114 typedef char          OPJ_CHAR;
115 typedef float         OPJ_FLOAT32;
116 typedef double        OPJ_FLOAT64;
117 typedef unsigned char OPJ_BYTE;
118
119 #include "opj_stdint.h"
120
121 typedef int8_t   OPJ_INT8;
122 typedef uint8_t  OPJ_UINT8;
123 typedef int16_t  OPJ_INT16;
124 typedef uint16_t OPJ_UINT16;
125 typedef int32_t  OPJ_INT32;
126 typedef uint32_t OPJ_UINT32;
127 typedef int64_t  OPJ_INT64;
128 typedef uint64_t OPJ_UINT64;
129
130 typedef int64_t  OPJ_OFF_T; /* 64-bit file offset type */
131
132 #include <stdio.h>
133 typedef size_t   OPJ_SIZE_T;
134
135 /* Avoid compile-time warning because parameter is not used */
136 #define OPJ_ARG_NOT_USED(x) (void)(x)
137
138 /* 
139 ==========================================================
140    Useful constant definitions
141 ==========================================================
142 */
143
144 #define OPJ_PATH_LEN 4096 /**< Maximum allowed size for filenames */
145
146 #define OPJ_J2K_MAXRLVLS 33                                     /**< Number of maximum resolution level authorized */
147 #define OPJ_J2K_MAXBANDS (3*OPJ_J2K_MAXRLVLS-2) /**< Number of maximum sub-band linked to number of resolution level */
148
149 #define OPJ_J2K_DEFAULT_NB_SEGS                         10
150 #define OPJ_J2K_STREAM_CHUNK_SIZE                       0x100000 /** 1 mega by default */
151 #define OPJ_J2K_DEFAULT_HEADER_SIZE                     1000
152 #define OPJ_J2K_MCC_DEFAULT_NB_RECORDS          10
153 #define OPJ_J2K_MCT_DEFAULT_NB_RECORDS          10
154
155 /* UniPG>> */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */
156 #define JPWL_MAX_NO_TILESPECS   16 /**< Maximum number of tile parts expected by JPWL: increase at your will */
157 #define JPWL_MAX_NO_PACKSPECS   16 /**< Maximum number of packet parts expected by JPWL: increase at your will */
158 #define JPWL_MAX_NO_MARKERS     512 /**< Maximum number of JPWL markers: increase at your will */
159 #define JPWL_PRIVATEINDEX_NAME "jpwl_index_privatefilename" /**< index file name used when JPWL is on */
160 #define JPWL_EXPECTED_COMPONENTS 3 /**< Expect this number of components, so you'll find better the first EPB */
161 #define JPWL_MAXIMUM_TILES 8192 /**< Expect this maximum number of tiles, to avoid some crashes */
162 #define JPWL_MAXIMUM_HAMMING 2 /**< Expect this maximum number of bit errors in marker id's */
163 #define JPWL_MAXIMUM_EPB_ROOM 65450 /**< Expect this maximum number of bytes for composition of EPBs */
164 /* <<UniPG */
165
166 /**
167  * EXPERIMENTAL FOR THE MOMENT
168  * Supported options about file information used only in j2k_dump
169 */
170 #define OPJ_IMG_INFO            1       /**< Basic image information provided to the user */
171 #define OPJ_J2K_MH_INFO         2       /**< Codestream information based only on the main header */
172 #define OPJ_J2K_TH_INFO         4       /**< Tile information based on the current tile header */
173 #define OPJ_J2K_TCH_INFO        8       /**< Tile/Component information of all tiles */
174 #define OPJ_J2K_MH_IND          16      /**< Codestream index based only on the main header */
175 #define OPJ_J2K_TH_IND          32      /**< Tile index based on the current tile */
176 /*FIXME #define OPJ_J2K_CSTR_IND        48*/    /**<  */
177 #define OPJ_JP2_INFO            128     /**< JP2 file information */
178 #define OPJ_JP2_IND                     256     /**< JP2 file index */
179
180 /**
181  * JPEG 2000 Profiles, see Table A.10 from 15444-1 (updated in various AMD)
182  * These values help chosing the RSIZ value for the J2K codestream.
183  * The RSIZ value triggers various encoding options, as detailed in Table A.10.
184  * If OPJ_PROFILE_PART2 is chosen, it has to be combined with one or more extensions
185  * described hereunder.
186  *   Example: rsiz = OPJ_PROFILE_PART2 | OPJ_EXTENSION_MCT;
187  * For broadcast profiles, the OPJ_PROFILE value has to be combined with the targeted
188  * mainlevel (3-0 LSB, value between 0 and 11):
189  *   Example: rsiz = OPJ_PROFILE_BC_MULTI | 0x0005; (here mainlevel 5)
190  * For IMF profiles, the OPJ_PROFILE value has to be combined with the targeted mainlevel
191  * (3-0 LSB, value between 0 and 11) and sublevel (7-4 LSB, value between 0 and 9):
192  *   Example: rsiz = OPJ_PROFILE_IMF_2K | 0x0040 | 0x0005; (here main 5 and sublevel 4)
193  * */
194 #define OPJ_PROFILE_NONE        0x0000 /** no profile, conform to 15444-1 */
195 #define OPJ_PROFILE_0           0x0001 /** Profile 0 as described in 15444-1,Table A.45 */
196 #define OPJ_PROFILE_1           0x0002 /** Profile 1 as described in 15444-1,Table A.45 */
197 #define OPJ_PROFILE_PART2       0x8000 /** At least 1 extension defined in 15444-2 (Part-2) */
198 #define OPJ_PROFILE_CINEMA_2K   0x0003 /** 2K cinema profile defined in 15444-1 AMD1 */
199 #define OPJ_PROFILE_CINEMA_4K   0x0004 /** 4K cinema profile defined in 15444-1 AMD1 */
200 #define OPJ_PROFILE_CINEMA_S2K  0x0005 /** Scalable 2K cinema profile defined in 15444-1 AMD2 */
201 #define OPJ_PROFILE_CINEMA_S4K  0x0006 /** Scalable 4K cinema profile defined in 15444-1 AMD2 */
202 #define OPJ_PROFILE_CINEMA_LTS  0x0007 /** Long term storage cinema profile defined in 15444-1 AMD2 */
203 #define OPJ_PROFILE_BC_SINGLE   0x0100 /** Single Tile Broadcast profile defined in 15444-1 AMD3 */
204 #define OPJ_PROFILE_BC_MULTI    0x0200 /** Multi Tile Broadcast profile defined in 15444-1 AMD3 */
205 #define OPJ_PROFILE_BC_MULTI_R  0x0300 /** Multi Tile Reversible Broadcast profile defined in 15444-1 AMD3 */
206 #define OPJ_PROFILE_IMF_2K      0x0400 /** 2K Single Tile Lossy IMF profile defined in 15444-1 AMD 8 */
207 #define OPJ_PROFILE_IMF_4K      0x0401 /** 4K Single Tile Lossy IMF profile defined in 15444-1 AMD 8 */
208 #define OPJ_PROFILE_IMF_8K      0x0402 /** 8K Single Tile Lossy IMF profile defined in 15444-1 AMD 8 */
209 #define OPJ_PROFILE_IMF_2K_R    0x0403 /** 2K Single/Multi Tile Reversible IMF profile defined in 15444-1 AMD 8 */
210 #define OPJ_PROFILE_IMF_4K_R    0x0800 /** 4K Single/Multi Tile Reversible IMF profile defined in 15444-1 AMD 8 */
211 #define OPJ_PROFILE_IMF_8K_R    0x0801  /** 8K Single/Multi Tile Reversible IMF profile defined in 15444-1 AMD 8 */
212
213 /**
214  * JPEG 2000 Part-2 extensions
215  * */
216 #define OPJ_EXTENSION_NONE      0x0000 /** No Part-2 extension */
217 #define OPJ_EXTENSION_MCT       0x0100  /** Custom MCT support */
218
219 /**
220  * JPEG 2000 profile macros
221  * */
222 #define OPJ_IS_CINEMA(v)     (((v) >= OPJ_PROFILE_CINEMA_2K)&&((v) <= OPJ_PROFILE_CINEMA_S4K))
223 #define OPJ_IS_STORAGE(v)    ((v) == OPJ_PROFILE_CINEMA_LTS)
224 #define OPJ_IS_BROADCAST(v)  (((v) >= OPJ_PROFILE_BC_SINGLE)&&((v) <= ((OPJ_PROFILE_BC_MULTI_R) | (0x000b))))
225 #define OPJ_IS_IMF(v)        (((v) >= OPJ_PROFILE_IMF_2K)&&((v) <= ((OPJ_PROFILE_IMF_8K_R) | (0x009b))))
226 #define OPJ_IS_PART2(v)      ((v) & OPJ_PROFILE_PART2)
227
228 /**
229  * JPEG 2000 codestream and component size limits in cinema profiles
230  * */
231 #define OPJ_CINEMA_24_CS     1302083    /** Maximum codestream length for 24fps */
232 #define OPJ_CINEMA_48_CS     651041     /** Maximum codestream length for 48fps */
233 #define OPJ_CINEMA_24_COMP   1041666    /** Maximum size per color component for 2K & 4K @ 24fps */
234 #define OPJ_CINEMA_48_COMP   520833             /** Maximum size per color component for 2K @ 48fps */
235
236 /* 
237 ==========================================================
238    enum definitions
239 ==========================================================
240 */
241
242 /**
243  * DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead
244  * Rsiz Capabilities
245  * */
246 typedef enum RSIZ_CAPABILITIES {
247     OPJ_STD_RSIZ = 0,           /** Standard JPEG2000 profile*/
248     OPJ_CINEMA2K = 3,           /** Profile name for a 2K image*/
249     OPJ_CINEMA4K = 4,           /** Profile name for a 4K image*/
250     OPJ_MCT = 0x8100
251 } OPJ_RSIZ_CAPABILITIES;
252
253 /**
254  * DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead
255  * Digital cinema operation mode
256  * */
257 typedef enum CINEMA_MODE {
258     OPJ_OFF = 0,                        /** Not Digital Cinema*/
259     OPJ_CINEMA2K_24 = 1,        /** 2K Digital Cinema at 24 fps*/
260     OPJ_CINEMA2K_48 = 2,        /** 2K Digital Cinema at 48 fps*/
261     OPJ_CINEMA4K_24 = 3         /** 4K Digital Cinema at 24 fps*/
262 }OPJ_CINEMA_MODE;
263
264 /** 
265  * Progression order
266  * */
267 typedef enum PROG_ORDER {
268         OPJ_PROG_UNKNOWN = -1,  /**< place-holder */
269         OPJ_LRCP = 0,                   /**< layer-resolution-component-precinct order */
270         OPJ_RLCP = 1,                   /**< resolution-layer-component-precinct order */
271         OPJ_RPCL = 2,                   /**< resolution-precinct-component-layer order */
272         OPJ_PCRL = 3,                   /**< precinct-component-resolution-layer order */
273         OPJ_CPRL = 4                    /**< component-precinct-resolution-layer order */
274 } OPJ_PROG_ORDER;
275
276 /**
277  * Supported image color spaces
278 */
279 typedef enum COLOR_SPACE {
280     OPJ_CLRSPC_UNKNOWN = -1,    /**< not supported by the library */
281     OPJ_CLRSPC_UNSPECIFIED = 0, /**< not specified in the codestream */
282     OPJ_CLRSPC_SRGB = 1,                /**< sRGB */
283     OPJ_CLRSPC_GRAY = 2,                /**< grayscale */
284     OPJ_CLRSPC_SYCC = 3,                /**< YUV */
285     OPJ_CLRSPC_EYCC = 4,        /**< e-YCC */
286     OPJ_CLRSPC_CMYK = 5         /**< CMYK */
287 } OPJ_COLOR_SPACE;
288
289 /**
290  * Supported codec
291 */
292 typedef enum CODEC_FORMAT {
293         OPJ_CODEC_UNKNOWN = -1, /**< place-holder */
294         OPJ_CODEC_J2K  = 0,             /**< JPEG-2000 codestream : read/write */
295         OPJ_CODEC_JPT  = 1,             /**< JPT-stream (JPEG 2000, JPIP) : read only */
296     OPJ_CODEC_JP2  = 2,         /**< JP2 file format : read/write */
297     OPJ_CODEC_JPP  = 3,         /**< JPP-stream (JPEG 2000, JPIP) : to be coded */
298     OPJ_CODEC_JPX  = 4          /**< JPX file format (JPEG 2000 Part-2) : to be coded */
299 } OPJ_CODEC_FORMAT;
300
301
302 /* 
303 ==========================================================
304    event manager typedef definitions
305 ==========================================================
306 */
307
308 /**
309  * Callback function prototype for events
310  * @param msg               Event message
311  * @param client_data       Client object where will be return the event message 
312  * */
313 typedef void (*opj_msg_callback) (const char *msg, void *client_data);
314
315 /* 
316 ==========================================================
317    codec typedef definitions
318 ==========================================================
319 */
320
321 /**
322  * Progression order changes
323  * 
324  */
325 typedef struct opj_poc {
326         /** Resolution num start, Component num start, given by POC */
327         OPJ_UINT32 resno0, compno0;
328         /** Layer num end,Resolution num end, Component num end, given by POC */
329         OPJ_UINT32 layno1, resno1, compno1;
330         /** Layer num start,Precinct num start, Precinct num end */
331         OPJ_UINT32 layno0, precno0, precno1;
332         /** Progression order enum*/
333         OPJ_PROG_ORDER prg1,prg;
334         /** Progression order string*/
335         OPJ_CHAR progorder[5];
336         /** Tile number */
337         OPJ_UINT32 tile;
338         /** Start and end values for Tile width and height*/
339         OPJ_INT32 tx0,tx1,ty0,ty1;
340         /** Start value, initialised in pi_initialise_encode*/
341         OPJ_UINT32 layS, resS, compS, prcS;
342         /** End value, initialised in pi_initialise_encode */
343         OPJ_UINT32 layE, resE, compE, prcE;
344         /** Start and end values of Tile width and height, initialised in pi_initialise_encode*/
345         OPJ_UINT32 txS,txE,tyS,tyE,dx,dy;
346         /** Temporary values for Tile parts, initialised in pi_create_encode */
347         OPJ_UINT32 lay_t, res_t, comp_t, prc_t,tx0_t,ty0_t;
348 } opj_poc_t;
349
350 /**
351  * Compression parameters
352  * */
353 typedef struct opj_cparameters {
354         /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */
355         OPJ_BOOL tile_size_on;
356         /** XTOsiz */
357         int cp_tx0;
358         /** YTOsiz */
359         int cp_ty0;
360         /** XTsiz */
361         int cp_tdx;
362         /** YTsiz */
363         int cp_tdy;
364         /** allocation by rate/distortion */
365         int cp_disto_alloc;
366         /** allocation by fixed layer */
367         int cp_fixed_alloc;
368         /** add fixed_quality */
369         int cp_fixed_quality;
370         /** fixed layer */
371         int *cp_matrice;
372         /** comment for coding */
373         char *cp_comment;
374         /** csty : coding style */
375         int csty;
376         /** progression order (default OPJ_LRCP) */
377         OPJ_PROG_ORDER prog_order;
378         /** progression order changes */
379         opj_poc_t POC[32];
380         /** number of progression order changes (POC), default to 0 */
381         OPJ_UINT32 numpocs;
382         /** number of layers */
383         int tcp_numlayers;
384     /** rates of layers - might be subsequently limited by the max_cs_size field */
385         float tcp_rates[100];
386         /** different psnr for successive layers */
387         float tcp_distoratio[100];
388         /** number of resolutions */
389         int numresolution;
390         /** initial code block width, default to 64 */
391         int cblockw_init;
392         /** initial code block height, default to 64 */
393         int cblockh_init;
394         /** mode switch (cblk_style) */
395         int mode;
396         /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
397         int irreversible;
398         /** region of interest: affected component in [0..3], -1 means no ROI */
399         int roi_compno;
400         /** region of interest: upshift value */
401         int roi_shift;
402         /* number of precinct size specifications */
403         int res_spec;
404         /** initial precinct width */
405         int prcw_init[OPJ_J2K_MAXRLVLS];
406         /** initial precinct height */
407         int prch_init[OPJ_J2K_MAXRLVLS];
408
409         /**@name command line encoder parameters (not used inside the library) */
410         /*@{*/
411         /** input file name */
412         char infile[OPJ_PATH_LEN];
413         /** output file name */
414         char outfile[OPJ_PATH_LEN];
415         /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
416         int index_on;
417         /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
418         char index[OPJ_PATH_LEN];
419         /** subimage encoding: origin image offset in x direction */
420         int image_offset_x0;
421         /** subimage encoding: origin image offset in y direction */
422         int image_offset_y0;
423         /** subsampling value for dx */
424         int subsampling_dx;
425         /** subsampling value for dy */
426         int subsampling_dy;
427         /** input file format 0: PGX, 1: PxM, 2: BMP 3:TIF*/
428         int decod_format;
429         /** output file format 0: J2K, 1: JP2, 2: JPT */
430         int cod_format;
431         /*@}*/
432
433 /* UniPG>> */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */
434         /**@name JPWL encoding parameters */
435         /*@{*/
436         /** enables writing of EPC in MH, thus activating JPWL */
437         OPJ_BOOL jpwl_epc_on;
438         /** error protection method for MH (0,1,16,32,37-128) */
439         int jpwl_hprot_MH;
440         /** tile number of header protection specification (>=0) */
441         int jpwl_hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
442         /** error protection methods for TPHs (0,1,16,32,37-128) */
443         int jpwl_hprot_TPH[JPWL_MAX_NO_TILESPECS];
444         /** tile number of packet protection specification (>=0) */
445         int jpwl_pprot_tileno[JPWL_MAX_NO_PACKSPECS];
446         /** packet number of packet protection specification (>=0) */
447         int jpwl_pprot_packno[JPWL_MAX_NO_PACKSPECS];
448         /** error protection methods for packets (0,1,16,32,37-128) */
449         int jpwl_pprot[JPWL_MAX_NO_PACKSPECS];
450         /** enables writing of ESD, (0=no/1/2 bytes) */
451         int jpwl_sens_size;
452         /** sensitivity addressing size (0=auto/2/4 bytes) */
453         int jpwl_sens_addr;
454         /** sensitivity range (0-3) */
455         int jpwl_sens_range;
456         /** sensitivity method for MH (-1=no,0-7) */
457         int jpwl_sens_MH;
458         /** tile number of sensitivity specification (>=0) */
459         int jpwl_sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
460         /** sensitivity methods for TPHs (-1=no,0-7) */
461         int jpwl_sens_TPH[JPWL_MAX_NO_TILESPECS];
462         /*@}*/
463 /* <<UniPG */
464
465     /**
466      * DEPRECATED: use RSIZ, OPJ_PROFILE_* and MAX_COMP_SIZE instead
467      * Digital Cinema compliance 0-not compliant, 1-compliant
468      * */
469     OPJ_CINEMA_MODE cp_cinema;
470     /**
471      * Maximum size (in bytes) for each component.
472      * If == 0, component size limitation is not considered
473      * */
474         int max_comp_size;
475     /**
476      * DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead
477      * Profile name
478      * */
479     OPJ_RSIZ_CAPABILITIES cp_rsiz;
480         /** Tile part generation*/
481         char tp_on;
482         /** Flag for Tile part generation*/
483         char tp_flag;
484         /** MCT (multiple component transform) */
485         char tcp_mct;
486         /** Enable JPIP indexing*/
487         OPJ_BOOL jpip_on;
488         /** Naive implementation of MCT restricted to a single reversible array based 
489         encoding without offset concerning all the components. */
490         void * mct_data;
491     /**
492      * Maximum size (in bytes) for the whole codestream.
493      * If == 0, codestream size limitation is not considered
494      * If it does not comply with tcp_rates, max_cs_size prevails
495      * and a warning is issued.
496      * */
497     int max_cs_size;
498     /** RSIZ value
499         To be used to combine OPJ_PROFILE_*, OPJ_EXTENSION_* and (sub)levels values. */
500     OPJ_UINT16 rsiz;
501 } opj_cparameters_t;  
502
503 #define OPJ_DPARAMETERS_IGNORE_PCLR_CMAP_CDEF_FLAG      0x0001
504
505 /**
506  * Decompression parameters
507  * */
508 typedef struct opj_dparameters {
509         /** 
510         Set the number of highest resolution levels to be discarded. 
511         The image resolution is effectively divided by 2 to the power of the number of discarded levels. 
512         The reduce factor is limited by the smallest total number of decomposition levels among tiles.
513         if != 0, then original dimension divided by 2^(reduce); 
514         if == 0 or not used, image is decoded to the full resolution 
515         */
516         OPJ_UINT32 cp_reduce;
517         /** 
518         Set the maximum number of quality layers to decode. 
519         If there are less quality layers than the specified number, all the quality layers are decoded.
520         if != 0, then only the first "layer" layers are decoded; 
521         if == 0 or not used, all the quality layers are decoded 
522         */
523         OPJ_UINT32 cp_layer;
524
525         /**@name command line decoder parameters (not used inside the library) */
526         /*@{*/
527         /** input file name */
528         char infile[OPJ_PATH_LEN];
529         /** output file name */
530         char outfile[OPJ_PATH_LEN];
531         /** input file format 0: J2K, 1: JP2, 2: JPT */
532         int decod_format;
533         /** output file format 0: PGX, 1: PxM, 2: BMP */
534         int cod_format;
535
536         /** Decoding area left boundary */
537         OPJ_UINT32 DA_x0;
538         /** Decoding area right boundary */
539         OPJ_UINT32 DA_x1;
540         /** Decoding area up boundary */
541         OPJ_UINT32 DA_y0;
542         /** Decoding area bottom boundary */
543         OPJ_UINT32 DA_y1;
544         /** Verbose mode */
545         OPJ_BOOL m_verbose;
546
547         /** tile number ot the decoded tile*/
548         OPJ_UINT32 tile_index;
549         /** Nb of tile to decode */
550         OPJ_UINT32 nb_tile_to_decode;
551
552         /*@}*/
553
554 /* UniPG>> */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */
555         /**@name JPWL decoding parameters */
556         /*@{*/
557         /** activates the JPWL correction capabilities */
558         OPJ_BOOL jpwl_correct;
559         /** expected number of components */
560         int jpwl_exp_comps;
561         /** maximum number of tiles */
562         int jpwl_max_tiles;
563         /*@}*/
564 /* <<UniPG */
565
566         unsigned int flags;
567
568 } opj_dparameters_t;
569
570
571 /**
572  * JPEG2000 codec V2.
573  * */
574 typedef void * opj_codec_t;
575
576 /* 
577 ==========================================================
578    I/O stream typedef definitions
579 ==========================================================
580 */
581
582 /**
583  * Stream open flags.
584  * */
585 /** The stream was opened for reading. */
586 #define OPJ_STREAM_READ OPJ_TRUE
587 /** The stream was opened for writing. */
588 #define OPJ_STREAM_WRITE OPJ_FALSE
589
590 /*
591  * Callback function prototype for read function
592  */
593 typedef OPJ_SIZE_T (* opj_stream_read_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
594
595 /*
596  * Callback function prototype for write function
597  */
598 typedef OPJ_SIZE_T (* opj_stream_write_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
599
600 /*
601  * Callback function prototype for skip function
602  */
603 typedef OPJ_OFF_T (* opj_stream_skip_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ;
604
605 /*
606  * Callback function prototype for seek function
607  */
608 typedef OPJ_BOOL (* opj_stream_seek_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ;
609
610 /*
611  * Callback function prototype for free user data function
612  */
613 typedef void (* opj_stream_free_user_data_fn) (void * p_user_data) ;
614
615 /*
616  * JPEG2000 Stream.
617  */
618 typedef void * opj_stream_t;
619
620 /* 
621 ==========================================================
622    image typedef definitions
623 ==========================================================
624 */
625
626 /**
627  * Defines a single image component
628  * */
629 typedef struct opj_image_comp {
630         /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
631         OPJ_UINT32 dx;
632         /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
633         OPJ_UINT32 dy;
634         /** data width */
635         OPJ_UINT32 w;
636         /** data height */
637         OPJ_UINT32 h;
638         /** x component offset compared to the whole image */
639         OPJ_UINT32 x0;
640         /** y component offset compared to the whole image */
641         OPJ_UINT32 y0;
642         /** precision */
643         OPJ_UINT32 prec;
644         /** image depth in bits */
645         OPJ_UINT32 bpp;
646         /** signed (1) / unsigned (0) */
647         OPJ_UINT32 sgnd;
648         /** number of decoded resolution */
649         OPJ_UINT32 resno_decoded;
650         /** number of division by 2 of the out image compared to the original size of image */
651         OPJ_UINT32 factor;
652         /** image component data */
653         OPJ_INT32 *data;
654   /** alpha channel */
655   OPJ_UINT16 alpha;
656 } opj_image_comp_t;
657
658 /** 
659  * Defines image data and characteristics
660  * */
661 typedef struct opj_image {
662         /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
663         OPJ_UINT32 x0;
664         /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
665         OPJ_UINT32 y0;
666         /** Xsiz: width of the reference grid */
667         OPJ_UINT32 x1;
668         /** Ysiz: height of the reference grid */
669         OPJ_UINT32 y1;
670         /** number of components in the image */
671         OPJ_UINT32 numcomps;
672         /** color space: sRGB, Greyscale or YUV */
673         OPJ_COLOR_SPACE color_space;
674         /** image components */
675         opj_image_comp_t *comps;
676         /** 'restricted' ICC profile */
677         OPJ_BYTE *icc_profile_buf;
678         /** size of ICC profile */
679         OPJ_UINT32 icc_profile_len;
680 } opj_image_t;
681
682
683 /**
684  * Component parameters structure used by the opj_image_create function
685  * */
686 typedef struct opj_image_comptparm {
687         /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
688         OPJ_UINT32 dx;
689         /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
690         OPJ_UINT32 dy;
691         /** data width */
692         OPJ_UINT32 w;
693         /** data height */
694         OPJ_UINT32 h;
695         /** x component offset compared to the whole image */
696         OPJ_UINT32 x0;
697         /** y component offset compared to the whole image */
698         OPJ_UINT32 y0;
699         /** precision */
700         OPJ_UINT32 prec;
701         /** image depth in bits */
702         OPJ_UINT32 bpp;
703         /** signed (1) / unsigned (0) */
704         OPJ_UINT32 sgnd;
705 } opj_image_cmptparm_t;
706
707
708 /* 
709 ==========================================================
710    Information on the JPEG 2000 codestream
711 ==========================================================
712 */
713 /* QUITE EXPERIMENTAL FOR THE MOMENT */
714
715 /**
716  * Index structure : Information concerning a packet inside tile
717  * */
718 typedef struct opj_packet_info {
719         /** packet start position (including SOP marker if it exists) */
720         OPJ_OFF_T start_pos;
721         /** end of packet header position (including EPH marker if it exists)*/
722         OPJ_OFF_T end_ph_pos;
723         /** packet end position */
724         OPJ_OFF_T end_pos;
725         /** packet distorsion */
726         double disto;
727 } opj_packet_info_t;
728
729
730 /* UniPG>> */
731 /**
732  * Marker structure
733  * */
734 typedef struct opj_marker_info {
735         /** marker type */
736         unsigned short int type;
737         /** position in codestream */
738         OPJ_OFF_T pos;
739         /** length, marker val included */
740         int len;
741 } opj_marker_info_t;
742 /* <<UniPG */
743
744 /**
745  * Index structure : Information concerning tile-parts
746 */
747 typedef struct opj_tp_info {
748         /** start position of tile part */
749         int tp_start_pos;
750         /** end position of tile part header */
751         int tp_end_header;
752         /** end position of tile part */
753         int tp_end_pos;
754         /** start packet of tile part */
755         int tp_start_pack;
756         /** number of packets of tile part */
757         int tp_numpacks;
758 } opj_tp_info_t;
759
760 /**
761  * Index structure : information regarding tiles
762 */
763 typedef struct opj_tile_info {
764         /** value of thresh for each layer by tile cfr. Marcela   */
765         double *thresh;
766         /** number of tile */
767         int tileno;
768         /** start position */
769         int start_pos;
770         /** end position of the header */
771         int end_header;
772         /** end position */
773         int end_pos;
774         /** precinct number for each resolution level (width) */
775         int pw[33];
776         /** precinct number for each resolution level (height) */
777         int ph[33];
778         /** precinct size (in power of 2), in X for each resolution level */
779         int pdx[33];
780         /** precinct size (in power of 2), in Y for each resolution level */
781         int pdy[33];
782         /** information concerning packets inside tile */
783         opj_packet_info_t *packet;
784         /** add fixed_quality */
785         int numpix;
786         /** add fixed_quality */
787         double distotile;
788         /** number of markers */
789         int marknum;
790         /** list of markers */
791         opj_marker_info_t *marker;
792         /** actual size of markers array */
793         int maxmarknum;
794         /** number of tile parts */
795         int num_tps;
796         /** information concerning tile parts */
797         opj_tp_info_t *tp;
798 } opj_tile_info_t;
799
800 /**
801  * Index structure of the codestream
802 */
803 typedef struct opj_codestream_info {
804         /** maximum distortion reduction on the whole image (add for Marcela) */
805         double D_max;
806         /** packet number */
807         int packno;
808         /** writing the packet in the index with t2_encode_packets */
809         int index_write;
810         /** image width */
811         int image_w;
812         /** image height */
813         int image_h;
814         /** progression order */
815         OPJ_PROG_ORDER prog;
816         /** tile size in x */
817         int tile_x;
818         /** tile size in y */
819         int tile_y;
820         /** */
821         int tile_Ox;
822         /** */
823         int tile_Oy;
824         /** number of tiles in X */
825         int tw;
826         /** number of tiles in Y */
827         int th;
828         /** component numbers */
829         int numcomps;
830         /** number of layer */
831         int numlayers;
832         /** number of decomposition for each component */
833         int *numdecompos;
834 /* UniPG>> */
835         /** number of markers */
836         int marknum;
837         /** list of markers */
838         opj_marker_info_t *marker;
839         /** actual size of markers array */
840         int maxmarknum;
841 /* <<UniPG */
842         /** main header position */
843         int main_head_start;
844         /** main header position */
845         int main_head_end;
846         /** codestream's size */
847         int codestream_size;
848         /** information regarding tiles inside image */
849         opj_tile_info_t *tile;
850 } opj_codestream_info_t;
851
852 /* <----------------------------------------------------------- */
853 /* new output managment of the codestream information and index */
854
855 /**
856  * Tile-component coding parameters information
857  */
858 typedef struct opj_tccp_info
859 {
860         /** component index */
861         OPJ_UINT32 compno;
862         /** coding style */
863         OPJ_UINT32 csty;
864         /** number of resolutions */
865         OPJ_UINT32 numresolutions;
866         /** code-blocks width */
867         OPJ_UINT32 cblkw;
868         /** code-blocks height */
869         OPJ_UINT32 cblkh;
870         /** code-block coding style */
871         OPJ_UINT32 cblksty;
872         /** discrete wavelet transform identifier */
873         OPJ_UINT32 qmfbid;
874         /** quantisation style */
875         OPJ_UINT32 qntsty;
876         /** stepsizes used for quantization */
877         OPJ_UINT32 stepsizes_mant[OPJ_J2K_MAXBANDS];
878         /** stepsizes used for quantization */
879         OPJ_UINT32 stepsizes_expn[OPJ_J2K_MAXBANDS];
880         /** number of guard bits */
881         OPJ_UINT32 numgbits;
882         /** Region Of Interest shift */
883         OPJ_INT32 roishift;
884         /** precinct width */
885         OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
886         /** precinct height */
887         OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
888 }
889 opj_tccp_info_t;
890
891 /**
892  * Tile coding parameters information
893  */
894 typedef struct opj_tile_v2_info {
895
896         /** number (index) of tile */
897         int tileno;
898         /** coding style */
899         OPJ_UINT32 csty;
900         /** progression order */
901         OPJ_PROG_ORDER prg;
902         /** number of layers */
903         OPJ_UINT32 numlayers;
904         /** multi-component transform identifier */
905         OPJ_UINT32 mct;
906
907         /** information concerning tile component parameters*/
908         opj_tccp_info_t *tccp_info;
909
910 } opj_tile_info_v2_t;
911
912 /**
913  * Information structure about the codestream (FIXME should be expand and enhance)
914  */
915 typedef struct opj_codestream_info_v2 {
916         /* Tile info */
917         /** tile origin in x = XTOsiz */
918         OPJ_UINT32 tx0;
919         /** tile origin in y = YTOsiz */
920         OPJ_UINT32 ty0;
921         /** tile size in x = XTsiz */
922         OPJ_UINT32 tdx;
923         /** tile size in y = YTsiz */
924         OPJ_UINT32 tdy;
925         /** number of tiles in X */
926         OPJ_UINT32 tw;
927         /** number of tiles in Y */
928         OPJ_UINT32 th;
929
930         /** number of components*/
931         OPJ_UINT32 nbcomps;
932
933         /** Default information regarding tiles inside image */
934         opj_tile_info_v2_t m_default_tile_info;
935
936         /** information regarding tiles inside image */
937         opj_tile_info_v2_t *tile_info; /* FIXME not used for the moment */
938
939 } opj_codestream_info_v2_t;
940
941
942 /**
943  * Index structure about a tile part
944  */
945 typedef struct opj_tp_index {
946         /** start position */
947         OPJ_OFF_T start_pos;
948         /** end position of the header */
949         OPJ_OFF_T end_header;
950         /** end position */
951         OPJ_OFF_T end_pos;
952
953 } opj_tp_index_t;
954
955 /**
956  * Index structure about a tile
957  */
958 typedef struct opj_tile_index {
959         /** tile index */
960         OPJ_UINT32 tileno;
961
962         /** number of tile parts */
963         OPJ_UINT32 nb_tps;
964         /** current nb of tile part (allocated)*/
965         OPJ_UINT32 current_nb_tps;
966         /** current tile-part index */
967         OPJ_UINT32 current_tpsno;
968         /** information concerning tile parts */
969         opj_tp_index_t *tp_index;
970
971         /* UniPG>> */ /* NOT USED FOR THE MOMENT IN THE V2 VERSION */
972                 /** number of markers */
973                 OPJ_UINT32 marknum;
974                 /** list of markers */
975                 opj_marker_info_t *marker;
976                 /** actual size of markers array */
977                 OPJ_UINT32 maxmarknum;
978         /* <<UniPG */
979
980         /** packet number */
981         OPJ_UINT32 nb_packet;
982         /** information concerning packets inside tile */
983         opj_packet_info_t *packet_index;
984
985 } opj_tile_index_t;
986
987 /**
988  * Index structure of the codestream (FIXME should be expand and enhance)
989  */
990 typedef struct opj_codestream_index {
991         /** main header start position (SOC position) */
992         OPJ_OFF_T main_head_start;
993         /** main header end position (first SOT position) */
994         OPJ_OFF_T main_head_end;
995
996         /** codestream's size */
997         OPJ_UINT64 codestream_size;
998
999 /* UniPG>> */ /* NOT USED FOR THE MOMENT IN THE V2 VERSION */
1000         /** number of markers */
1001         OPJ_UINT32 marknum;
1002         /** list of markers */
1003         opj_marker_info_t *marker;
1004         /** actual size of markers array */
1005         OPJ_UINT32 maxmarknum;
1006 /* <<UniPG */
1007
1008         /** */
1009         OPJ_UINT32 nb_of_tiles;
1010         /** */
1011         opj_tile_index_t *tile_index; /* FIXME not used for the moment */
1012
1013 }opj_codestream_index_t;
1014 /* -----------------------------------------------------------> */
1015
1016 /*
1017 ==========================================================
1018    Metadata from the JP2file
1019 ==========================================================
1020 */
1021
1022 /**
1023  * Info structure of the JP2 file
1024  * EXPERIMENTAL FOR THE MOMENT
1025  */
1026 typedef struct opj_jp2_metadata {
1027         /** */
1028         OPJ_INT32       not_used;
1029
1030 } opj_jp2_metadata_t;
1031
1032 /**
1033  * Index structure of the JP2 file
1034  * EXPERIMENTAL FOR THE MOMENT
1035  */
1036 typedef struct opj_jp2_index {
1037         /** */
1038         OPJ_INT32       not_used;
1039
1040 } opj_jp2_index_t;
1041
1042
1043 #ifdef __cplusplus
1044 extern "C" {
1045 #endif
1046
1047
1048 /* 
1049 ==========================================================
1050    openjpeg version
1051 ==========================================================
1052 */
1053
1054 /* Get the version of the openjpeg library*/
1055 OPJ_API const char * OPJ_CALLCONV opj_version(void);
1056
1057 /* 
1058 ==========================================================
1059    image functions definitions
1060 ==========================================================
1061 */
1062
1063 /**
1064  * Create an image
1065  *
1066  * @param numcmpts      number of components
1067  * @param cmptparms     components parameters
1068  * @param clrspc        image color space
1069  * @return returns      a new image structure if successful, returns NULL otherwise
1070  * */
1071 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(OPJ_UINT32 numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1072
1073 /**
1074  * Deallocate any resources associated with an image
1075  *
1076  * @param image         image to be destroyed
1077  */
1078 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
1079
1080 /**
1081  * Creates an image without allocating memory for the image (used in the new version of the library).
1082  *
1083  * @param       numcmpts    the number of components
1084  * @param       cmptparms   the components parameters
1085  * @param       clrspc      the image color space
1086  *
1087  * @return      a new image structure if successful, NULL otherwise.
1088 */
1089 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_tile_create(OPJ_UINT32 numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1090
1091 /* 
1092 ==========================================================
1093    stream functions definitions
1094 ==========================================================
1095 */
1096
1097 /**
1098  * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1099  *
1100  * @param       p_is_input              if set to true then the stream will be an input stream, an output stream else.
1101  *
1102  * @return      a stream object.
1103 */
1104 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_default_create(OPJ_BOOL p_is_input);
1105
1106 /**
1107  * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1108  *
1109  * @param       p_buffer_size  FIXME DOC
1110  * @param       p_is_input              if set to true then the stream will be an input stream, an output stream else.
1111  *
1112  * @return      a stream object.
1113 */
1114 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create(OPJ_SIZE_T p_buffer_size, OPJ_BOOL p_is_input);
1115
1116 /**
1117  * Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must
1118  * close its own implementation of the stream.
1119  *
1120  * @param       p_stream        the stream to destroy.
1121  */
1122 OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream);
1123  
1124 /**
1125  * Sets the given function to be used as a read function.
1126  * @param               p_stream        the stream to modify
1127  * @param               p_function      the function to use a read function.
1128 */
1129 OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream, opj_stream_read_fn p_function);
1130
1131 /**
1132  * Sets the given function to be used as a write function.
1133  * @param               p_stream        the stream to modify
1134  * @param               p_function      the function to use a write function.
1135 */
1136 OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream, opj_stream_write_fn p_function);
1137
1138 /**
1139  * Sets the given function to be used as a skip function.
1140  * @param               p_stream        the stream to modify
1141  * @param               p_function      the function to use a skip function.
1142 */
1143 OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream, opj_stream_skip_fn p_function);
1144
1145 /**
1146  * Sets the given function to be used as a seek function, the stream is then seekable.
1147  * @param               p_stream        the stream to modify
1148  * @param               p_function      the function to use a skip function.
1149 */
1150 OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream, opj_stream_seek_fn p_function);
1151
1152 /**
1153  * Sets the given data to be used as a user data for the stream.
1154  * @param               p_stream        the stream to modify
1155  * @param               p_data          the data to set.
1156  * @param               p_function      the function to free p_data when opj_stream_destroy() is called.
1157 */
1158 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data (opj_stream_t* p_stream, void * p_data, opj_stream_free_user_data_fn p_function);
1159
1160 /**
1161  * Sets the length of the user data for the stream.
1162  *
1163  * @param p_stream    the stream to modify
1164  * @param data_length length of the user_data.
1165 */
1166 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data_length(opj_stream_t* p_stream, OPJ_UINT64 data_length);
1167
1168 /**
1169  * Create a stream from a file identified with its filename with default parameters (helper function)
1170  * @param fname             the filename of the file to stream
1171  * @param p_is_read_stream  whether the stream is a read stream (true) or not (false)
1172 */
1173 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream (const char *fname, OPJ_BOOL p_is_read_stream);
1174  
1175 /** Create a stream from a file identified with its filename with a specific buffer size
1176  * @param fname             the filename of the file to stream
1177  * @param p_buffer_size     size of the chunk used to stream
1178  * @param p_is_read_stream  whether the stream is a read stream (true) or not (false)
1179 */
1180 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream (const char *fname,
1181                                                                      OPJ_SIZE_T p_buffer_size,
1182                                                                      OPJ_BOOL p_is_read_stream);
1183  
1184 /* 
1185 ==========================================================
1186    event manager functions definitions
1187 ==========================================================
1188 */
1189 /**
1190  * Set the info handler use by openjpeg.
1191  * @param p_codec       the codec previously initialise
1192  * @param p_callback    the callback function which will be used
1193  * @param p_user_data   client object where will be returned the message
1194 */
1195 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_info_handler(opj_codec_t * p_codec, 
1196                                                    opj_msg_callback p_callback,
1197                                                    void * p_user_data);
1198 /**
1199  * Set the warning handler use by openjpeg.
1200  * @param p_codec       the codec previously initialise
1201  * @param p_callback    the callback function which will be used
1202  * @param p_user_data   client object where will be returned the message
1203 */
1204 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_warning_handler(opj_codec_t * p_codec,
1205                                                       opj_msg_callback p_callback,
1206                                                       void * p_user_data);
1207 /**
1208  * Set the error handler use by openjpeg.
1209  * @param p_codec       the codec previously initialise
1210  * @param p_callback    the callback function which will be used
1211  * @param p_user_data   client object where will be returned the message
1212 */
1213 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_error_handler(opj_codec_t * p_codec, 
1214                                                     opj_msg_callback p_callback,
1215                                                     void * p_user_data);
1216
1217 /* 
1218 ==========================================================
1219    codec functions definitions
1220 ==========================================================
1221 */
1222
1223 /**
1224  * Creates a J2K/JP2 decompression structure
1225  * @param format                Decoder to select
1226  *
1227  * @return Returns a handle to a decompressor if successful, returns NULL otherwise
1228  * */
1229 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format);
1230
1231 /**
1232  * Destroy a decompressor handle
1233  *
1234  * @param       p_codec                 decompressor handle to destroy
1235  */
1236 OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec);
1237
1238 /**
1239  * Read after the codestream if necessary
1240  * @param       p_codec                 the JPEG2000 codec to read.
1241  * @param       p_stream                the JPEG2000 stream.
1242  */
1243 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_decompress (      opj_codec_t *p_codec,
1244                                                                                                         opj_stream_t *p_stream);
1245
1246
1247 /**
1248  * Set decoding parameters to default values
1249  * @param parameters Decompression parameters
1250  */
1251 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters);
1252
1253 /**
1254  * Setup the decoder with decompression parameters provided by the user and with the message handler
1255  * provided by the user.
1256  *
1257  * @param p_codec               decompressor handler
1258  * @param parameters    decompression parameters
1259  *
1260  * @return true                 if the decoder is correctly set
1261  */
1262 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_decoder(opj_codec_t *p_codec,
1263                                                                                                 opj_dparameters_t *parameters );
1264
1265 /**
1266  * Decodes an image header.
1267  *
1268  * @param       p_stream                the jpeg2000 stream.
1269  * @param       p_codec                 the jpeg2000 codec to read.
1270  * @param       p_image                 the image structure initialized with the characteristics of encoded image.
1271  *
1272  * @return true                         if the main header of the codestream and the JP2 header is correctly read.
1273  */
1274 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_read_header ( opj_stream_t *p_stream,
1275                                                                                                 opj_codec_t *p_codec,
1276                                                                                                 opj_image_t **p_image);
1277
1278 /**
1279  * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
1280  *
1281  * @param       p_codec                 the jpeg2000 codec.
1282  * @param       p_image         the decoded image previously setted by opj_read_header
1283  * @param       p_start_x               the left position of the rectangle to decode (in image coordinates).
1284  * @param       p_end_x                 the right position of the rectangle to decode (in image coordinates).
1285  * @param       p_start_y               the up position of the rectangle to decode (in image coordinates).
1286  * @param       p_end_y                 the bottom position of the rectangle to decode (in image coordinates).
1287  *
1288  * @return      true                    if the area could be set.
1289  */
1290 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decode_area(      opj_codec_t *p_codec,
1291                                                                                                         opj_image_t* p_image,
1292                                                                                                         OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
1293                                                                                                         OPJ_INT32 p_end_x, OPJ_INT32 p_end_y );
1294
1295 /**
1296  * Decode an image from a JPEG-2000 codestream
1297  *
1298  * @param p_decompressor        decompressor handle
1299  * @param p_stream                      Input buffer stream
1300  * @param p_image                       the decoded image
1301  * @return                                      true if success, otherwise false
1302  * */
1303 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode(   opj_codec_t *p_decompressor,
1304                                             opj_stream_t *p_stream,
1305                                             opj_image_t *p_image);
1306
1307 /**
1308  * Get the decoded tile from the codec
1309  *
1310  * @param       p_codec                 the jpeg2000 codec.
1311  * @param       p_stream                input streamm
1312  * @param       p_image                 output image
1313  * @param       tile_index              index of the tile which will be decode
1314  *
1315  * @return                                      true if success, otherwise false
1316  */
1317 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_get_decoded_tile(     opj_codec_t *p_codec,
1318                                                                                                         opj_stream_t *p_stream,
1319                                                                                                         opj_image_t *p_image,
1320                                                                                                         OPJ_UINT32 tile_index);
1321
1322 /**
1323  * Set the resolution factor of the decoded image
1324  * @param       p_codec                 the jpeg2000 codec.
1325  * @param       res_factor              resolution factor to set
1326  *
1327  * @return                                      true if success, otherwise false
1328  */
1329 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decoded_resolution_factor(opj_codec_t *p_codec, OPJ_UINT32 res_factor);
1330
1331 /**
1332  * Writes a tile with the given data.
1333  *
1334  * @param       p_codec                 the jpeg2000 codec.
1335  * @param       p_tile_index            the index of the tile to write. At the moment, the tiles must be written from 0 to n-1 in sequence.
1336  * @param       p_data                          pointer to the data to write. Data is arranged in sequence, data_comp0, then data_comp1, then ... NO INTERLEAVING should be set.
1337  * @param       p_data_size                     this value os used to make sure the data being written is correct. The size must be equal to the sum for each component of 
1338  *                              tile_width * tile_height * component_size. component_size can be 1,2 or 4 bytes, depending on the precision of the given component.
1339  * @param       p_stream                        the stream to write data to.
1340  *
1341  * @return      true if the data could be written.
1342  */
1343 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_write_tile (  opj_codec_t *p_codec,
1344                                                                                                 OPJ_UINT32 p_tile_index,
1345                                                                                                 OPJ_BYTE * p_data,
1346                                                                                                 OPJ_UINT32 p_data_size,
1347                                                                                                 opj_stream_t *p_stream );
1348
1349 /**
1350  * Reads a tile header. This function is compulsory and allows one to know the size of the tile thta will be decoded.
1351  * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1352  *
1353  * @param       p_codec                 the jpeg2000 codec.
1354  * @param       p_tile_index    pointer to a value that will hold the index of the tile being decoded, in case of success.
1355  * @param       p_data_size             pointer to a value that will hold the maximum size of the decoded data, in case of success. In case
1356  *                                                      of truncated codestreams, the actual number of bytes decoded may be lower. The computation of the size is the same
1357  *                                                      as depicted in opj_write_tile.
1358  * @param       p_tile_x0               pointer to a value that will hold the x0 pos of the tile (in the image).
1359  * @param       p_tile_y0               pointer to a value that will hold the y0 pos of the tile (in the image).
1360  * @param       p_tile_x1               pointer to a value that will hold the x1 pos of the tile (in the image).
1361  * @param       p_tile_y1               pointer to a value that will hold the y1 pos of the tile (in the image).
1362  * @param       p_nb_comps              pointer to a value that will hold the number of components in the tile.
1363  * @param       p_should_go_on  pointer to a boolean that will hold the fact that the decoding should go on. In case the
1364  *                                                      codestream is over at the time of the call, the value will be set to false. The user should then stop
1365  *                                                      the decoding.
1366  * @param       p_stream                the stream to decode.
1367  * @return      true                    if the tile header could be decoded. In case the decoding should end, the returned value is still true.
1368  *                                                      returning false may be the result of a shortage of memory or an internal error.
1369  */
1370 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_read_tile_header(     opj_codec_t *p_codec,
1371                                                                                                 opj_stream_t * p_stream,
1372                                                                                                 OPJ_UINT32 * p_tile_index,
1373                                                                                                 OPJ_UINT32 * p_data_size,
1374                                                                                                 OPJ_INT32 * p_tile_x0, OPJ_INT32 * p_tile_y0,
1375                                                                                                 OPJ_INT32 * p_tile_x1, OPJ_INT32 * p_tile_y1,
1376                                                                                                 OPJ_UINT32 * p_nb_comps,
1377                                                                                                 OPJ_BOOL * p_should_go_on );
1378
1379 /**
1380  * Reads a tile data. This function is compulsory and allows one to decode tile data. opj_read_tile_header should be called before.
1381  * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1382  *
1383  * @param       p_codec                 the jpeg2000 codec.
1384  * @param       p_tile_index    the index of the tile being decoded, this should be the value set by opj_read_tile_header.
1385  * @param       p_data                  pointer to a memory block that will hold the decoded data.
1386  * @param       p_data_size             size of p_data. p_data_size should be bigger or equal to the value set by opj_read_tile_header.
1387  * @param       p_stream                the stream to decode.
1388  *
1389  * @return      true                    if the data could be decoded.
1390  */
1391 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode_tile_data(     opj_codec_t *p_codec,
1392                                                                                                         OPJ_UINT32 p_tile_index,
1393                                                                                                         OPJ_BYTE * p_data,
1394                                                                                                         OPJ_UINT32 p_data_size,
1395                                                                                                         opj_stream_t *p_stream );
1396
1397 /* COMPRESSION FUNCTIONS*/
1398
1399 /**
1400  * Creates a J2K/JP2 compression structure
1401  * @param       format          Coder to select
1402  * @return                              Returns a handle to a compressor if successful, returns NULL otherwise
1403  */
1404 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
1405
1406 /**
1407 Set encoding parameters to default values, that means : 
1408 <ul>
1409 <li>Lossless
1410 <li>1 tile
1411 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
1412 <li>Size of code-block : 64 x 64
1413 <li>Number of resolutions: 6
1414 <li>No SOP marker in the codestream
1415 <li>No EPH marker in the codestream
1416 <li>No sub-sampling in x or y direction
1417 <li>No mode switch activated
1418 <li>Progression order: LRCP
1419 <li>No index file
1420 <li>No ROI upshifted
1421 <li>No offset of the origin of the image
1422 <li>No offset of the origin of the tiles
1423 <li>Reversible DWT 5-3
1424 </ul>
1425 @param parameters Compression parameters
1426 */
1427 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(opj_cparameters_t *parameters);
1428
1429 /**
1430  * Setup the encoder parameters using the current image and using user parameters.
1431  * @param p_codec               Compressor handle
1432  * @param parameters    Compression parameters
1433  * @param image                 Input filled image
1434  */
1435 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_encoder(opj_codec_t *p_codec, 
1436                                                                                                 opj_cparameters_t *parameters, 
1437                                                                                                 opj_image_t *image);
1438
1439 /**
1440  * Start to compress the current image.
1441  * @param p_codec               Compressor handle
1442  * @param image             Input filled image
1443  * @param p_stream              Input stgream
1444  */
1445 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_start_compress (      opj_codec_t *p_codec,
1446                                                                                                         opj_image_t * p_image,
1447                                                                                                         opj_stream_t *p_stream);
1448
1449 /**
1450  * End to compress the current image.
1451  * @param p_codec               Compressor handle
1452  * @param p_stream              Input stgream
1453  */
1454 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_compress (opj_codec_t *p_codec,
1455                                                                                                 opj_stream_t *p_stream);
1456
1457 /**
1458  * Encode an image into a JPEG-2000 codestream
1459  * @param p_codec               compressor handle
1460  * @param p_stream              Output buffer stream
1461  *
1462  * @return                              Returns true if successful, returns false otherwise
1463  */
1464 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_encode(opj_codec_t *p_codec,
1465                                          opj_stream_t *p_stream);
1466 /*
1467 ==========================================================
1468    codec output functions definitions
1469 ==========================================================
1470 */
1471 /* EXPERIMENTAL FUNCTIONS FOR NOW, USED ONLY IN J2K_DUMP*/
1472
1473 /**
1474 Destroy Codestream information after compression or decompression
1475 @param cstr_info Codestream information structure
1476 */
1477 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_v2_t **cstr_info);
1478
1479
1480 /**
1481  * Dump the codec information into the output stream
1482  *
1483  * @param       p_codec                 the jpeg2000 codec.
1484  * @param       info_flag               type of information dump.
1485  * @param       output_stream   output stream where dump the informations get from the codec.
1486  *
1487  */
1488 OPJ_API void OPJ_CALLCONV opj_dump_codec(       opj_codec_t *p_codec,
1489                                                                                         OPJ_INT32 info_flag,
1490                                                                                         FILE* output_stream);
1491
1492 /**
1493  * Get the codestream information from the codec
1494  *
1495  * @param       p_codec                 the jpeg2000 codec.
1496  *
1497  * @return                                      a pointer to a codestream information structure.
1498  *
1499  */
1500 OPJ_API opj_codestream_info_v2_t* OPJ_CALLCONV opj_get_cstr_info(opj_codec_t *p_codec);
1501
1502 /**
1503  * Get the codestream index from the codec
1504  *
1505  * @param       p_codec                 the jpeg2000 codec.
1506  *
1507  * @return                                      a pointer to a codestream index structure.
1508  *
1509  */
1510 OPJ_API opj_codestream_index_t * OPJ_CALLCONV opj_get_cstr_index(opj_codec_t *p_codec);
1511
1512 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_index(opj_codestream_index_t **p_cstr_index);
1513
1514
1515 /**
1516  * Get the JP2 file information from the codec FIXME
1517  *
1518  * @param       p_codec                 the jpeg2000 codec.
1519  *
1520  * @return                                      a pointer to a JP2 metadata structure.
1521  *
1522  */
1523 OPJ_API opj_jp2_metadata_t* OPJ_CALLCONV opj_get_jp2_metadata(opj_codec_t *p_codec);
1524
1525 /**
1526  * Get the JP2 file index from the codec FIXME
1527  *
1528  * @param       p_codec                 the jpeg2000 codec.
1529  *
1530  * @return                                      a pointer to a JP2 index structure.
1531  *
1532  */
1533 OPJ_API opj_jp2_index_t* OPJ_CALLCONV opj_get_jp2_index(opj_codec_t *p_codec);
1534
1535
1536 /*
1537 ==========================================================
1538    MCT functions
1539 ==========================================================
1540 */
1541
1542 /**
1543  * Sets the MCT matrix to use.
1544  *
1545  * @param       parameters              the parameters to change.
1546  * @param       pEncodingMatrix the encoding matrix.
1547  * @param       p_dc_shift              the dc shift coefficients to use.
1548  * @param       pNbComp                 the number of components of the image.
1549  *
1550  * @return      true if the parameters could be set.
1551  */
1552 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_MCT( opj_cparameters_t *parameters,
1553                                                    OPJ_FLOAT32 * pEncodingMatrix,
1554                                                    OPJ_INT32 * p_dc_shift,
1555                                                    OPJ_UINT32 pNbComp);
1556
1557
1558
1559 #ifdef __cplusplus
1560 }
1561 #endif
1562
1563 #endif /* OPENJPEG_H */