• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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, whereas 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 
681 	/** Whether to apply PCLR or not */
682 	OPJ_BOOL pdfium_use_colorspace;
683 } opj_image_t;
684 
685 
686 /**
687  * Component parameters structure used by the opj_image_create function
688  * */
689 typedef struct opj_image_comptparm {
690 	/** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
691 	OPJ_UINT32 dx;
692 	/** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
693 	OPJ_UINT32 dy;
694 	/** data width */
695 	OPJ_UINT32 w;
696 	/** data height */
697 	OPJ_UINT32 h;
698 	/** x component offset compared to the whole image */
699 	OPJ_UINT32 x0;
700 	/** y component offset compared to the whole image */
701 	OPJ_UINT32 y0;
702 	/** precision */
703 	OPJ_UINT32 prec;
704 	/** image depth in bits */
705 	OPJ_UINT32 bpp;
706 	/** signed (1) / unsigned (0) */
707 	OPJ_UINT32 sgnd;
708 } opj_image_cmptparm_t;
709 
710 
711 /*
712 ==========================================================
713    Information on the JPEG 2000 codestream
714 ==========================================================
715 */
716 /* QUITE EXPERIMENTAL FOR THE MOMENT */
717 
718 /**
719  * Index structure : Information concerning a packet inside tile
720  * */
721 typedef struct opj_packet_info {
722 	/** packet start position (including SOP marker if it exists) */
723 	OPJ_OFF_T start_pos;
724 	/** end of packet header position (including EPH marker if it exists)*/
725 	OPJ_OFF_T end_ph_pos;
726 	/** packet end position */
727 	OPJ_OFF_T end_pos;
728 	/** packet distorsion */
729 	double disto;
730 } opj_packet_info_t;
731 
732 
733 /* UniPG>> */
734 /**
735  * Marker structure
736  * */
737 typedef struct opj_marker_info {
738 	/** marker type */
739 	unsigned short int type;
740 	/** position in codestream */
741 	OPJ_OFF_T pos;
742 	/** length, marker val included */
743 	int len;
744 } opj_marker_info_t;
745 /* <<UniPG */
746 
747 /**
748  * Index structure : Information concerning tile-parts
749 */
750 typedef struct opj_tp_info {
751 	/** start position of tile part */
752 	int tp_start_pos;
753 	/** end position of tile part header */
754 	int tp_end_header;
755 	/** end position of tile part */
756 	int tp_end_pos;
757 	/** start packet of tile part */
758 	int tp_start_pack;
759 	/** number of packets of tile part */
760 	int tp_numpacks;
761 } opj_tp_info_t;
762 
763 /**
764  * Index structure : information regarding tiles
765 */
766 typedef struct opj_tile_info {
767 	/** value of thresh for each layer by tile cfr. Marcela   */
768 	double *thresh;
769 	/** number of tile */
770 	int tileno;
771 	/** start position */
772 	int start_pos;
773 	/** end position of the header */
774 	int end_header;
775 	/** end position */
776 	int end_pos;
777 	/** precinct number for each resolution level (width) */
778 	int pw[33];
779 	/** precinct number for each resolution level (height) */
780 	int ph[33];
781 	/** precinct size (in power of 2), in X for each resolution level */
782 	int pdx[33];
783 	/** precinct size (in power of 2), in Y for each resolution level */
784 	int pdy[33];
785 	/** information concerning packets inside tile */
786 	opj_packet_info_t *packet;
787 	/** add fixed_quality */
788 	int numpix;
789 	/** add fixed_quality */
790 	double distotile;
791   	/** number of markers */
792 	int marknum;
793 	/** list of markers */
794 	opj_marker_info_t *marker;
795 	/** actual size of markers array */
796 	int maxmarknum;
797 	/** number of tile parts */
798 	int num_tps;
799 	/** information concerning tile parts */
800 	opj_tp_info_t *tp;
801 } opj_tile_info_t;
802 
803 /**
804  * Index structure of the codestream
805 */
806 typedef struct opj_codestream_info {
807 	/** maximum distortion reduction on the whole image (add for Marcela) */
808 	double D_max;
809 	/** packet number */
810 	int packno;
811 	/** writing the packet in the index with t2_encode_packets */
812 	int index_write;
813 	/** image width */
814 	int image_w;
815 	/** image height */
816 	int image_h;
817 	/** progression order */
818 	OPJ_PROG_ORDER prog;
819 	/** tile size in x */
820 	int tile_x;
821 	/** tile size in y */
822 	int tile_y;
823 	/** */
824 	int tile_Ox;
825 	/** */
826 	int tile_Oy;
827 	/** number of tiles in X */
828 	int tw;
829 	/** number of tiles in Y */
830 	int th;
831 	/** component numbers */
832 	int numcomps;
833 	/** number of layer */
834 	int numlayers;
835 	/** number of decomposition for each component */
836 	int *numdecompos;
837 /* UniPG>> */
838 	/** number of markers */
839 	int marknum;
840 	/** list of markers */
841 	opj_marker_info_t *marker;
842 	/** actual size of markers array */
843 	int maxmarknum;
844 /* <<UniPG */
845 	/** main header position */
846 	int main_head_start;
847 	/** main header position */
848 	int main_head_end;
849 	/** codestream's size */
850 	int codestream_size;
851 	/** information regarding tiles inside image */
852 	opj_tile_info_t *tile;
853 } opj_codestream_info_t;
854 
855 /* <----------------------------------------------------------- */
856 /* new output management of the codestream information and index */
857 
858 /**
859  * Tile-component coding parameters information
860  */
861 typedef struct opj_tccp_info
862 {
863 	/** component index */
864 	OPJ_UINT32 compno;
865 	/** coding style */
866 	OPJ_UINT32 csty;
867 	/** number of resolutions */
868 	OPJ_UINT32 numresolutions;
869 	/** code-blocks width */
870 	OPJ_UINT32 cblkw;
871 	/** code-blocks height */
872 	OPJ_UINT32 cblkh;
873 	/** code-block coding style */
874 	OPJ_UINT32 cblksty;
875 	/** discrete wavelet transform identifier */
876 	OPJ_UINT32 qmfbid;
877 	/** quantisation style */
878 	OPJ_UINT32 qntsty;
879 	/** stepsizes used for quantization */
880 	OPJ_UINT32 stepsizes_mant[OPJ_J2K_MAXBANDS];
881 	/** stepsizes used for quantization */
882 	OPJ_UINT32 stepsizes_expn[OPJ_J2K_MAXBANDS];
883 	/** number of guard bits */
884 	OPJ_UINT32 numgbits;
885 	/** Region Of Interest shift */
886 	OPJ_INT32 roishift;
887 	/** precinct width */
888 	OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
889 	/** precinct height */
890 	OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
891 }
892 opj_tccp_info_t;
893 
894 /**
895  * Tile coding parameters information
896  */
897 typedef struct opj_tile_v2_info {
898 
899 	/** number (index) of tile */
900 	int tileno;
901 	/** coding style */
902 	OPJ_UINT32 csty;
903 	/** progression order */
904 	OPJ_PROG_ORDER prg;
905 	/** number of layers */
906 	OPJ_UINT32 numlayers;
907 	/** multi-component transform identifier */
908 	OPJ_UINT32 mct;
909 
910 	/** information concerning tile component parameters*/
911 	opj_tccp_info_t *tccp_info;
912 
913 } opj_tile_info_v2_t;
914 
915 /**
916  * Information structure about the codestream (FIXME should be expand and enhance)
917  */
918 typedef struct opj_codestream_info_v2 {
919 	/* Tile info */
920 	/** tile origin in x = XTOsiz */
921 	OPJ_UINT32 tx0;
922 	/** tile origin in y = YTOsiz */
923 	OPJ_UINT32 ty0;
924 	/** tile size in x = XTsiz */
925 	OPJ_UINT32 tdx;
926 	/** tile size in y = YTsiz */
927 	OPJ_UINT32 tdy;
928 	/** number of tiles in X */
929 	OPJ_UINT32 tw;
930 	/** number of tiles in Y */
931 	OPJ_UINT32 th;
932 
933 	/** number of components*/
934 	OPJ_UINT32 nbcomps;
935 
936 	/** Default information regarding tiles inside image */
937 	opj_tile_info_v2_t m_default_tile_info;
938 
939 	/** information regarding tiles inside image */
940 	opj_tile_info_v2_t *tile_info; /* FIXME not used for the moment */
941 
942 } opj_codestream_info_v2_t;
943 
944 
945 /**
946  * Index structure about a tile part
947  */
948 typedef struct opj_tp_index {
949 	/** start position */
950 	OPJ_OFF_T start_pos;
951 	/** end position of the header */
952 	OPJ_OFF_T end_header;
953 	/** end position */
954 	OPJ_OFF_T end_pos;
955 
956 } opj_tp_index_t;
957 
958 /**
959  * Index structure about a tile
960  */
961 typedef struct opj_tile_index {
962 	/** tile index */
963 	OPJ_UINT32 tileno;
964 
965 	/** number of tile parts */
966 	OPJ_UINT32 nb_tps;
967 	/** current nb of tile part (allocated)*/
968 	OPJ_UINT32 current_nb_tps;
969 	/** current tile-part index */
970 	OPJ_UINT32 current_tpsno;
971 	/** information concerning tile parts */
972 	opj_tp_index_t *tp_index;
973 
974 	/* UniPG>> */ /* NOT USED FOR THE MOMENT IN THE V2 VERSION */
975 		/** number of markers */
976 		OPJ_UINT32 marknum;
977 		/** list of markers */
978 		opj_marker_info_t *marker;
979 		/** actual size of markers array */
980 		OPJ_UINT32 maxmarknum;
981 	/* <<UniPG */
982 
983 	/** packet number */
984 	OPJ_UINT32 nb_packet;
985 	/** information concerning packets inside tile */
986 	opj_packet_info_t *packet_index;
987 
988 } opj_tile_index_t;
989 
990 /**
991  * Index structure of the codestream (FIXME should be expand and enhance)
992  */
993 typedef struct opj_codestream_index {
994 	/** main header start position (SOC position) */
995 	OPJ_OFF_T main_head_start;
996 	/** main header end position (first SOT position) */
997 	OPJ_OFF_T main_head_end;
998 
999 	/** codestream's size */
1000 	OPJ_UINT64 codestream_size;
1001 
1002 /* UniPG>> */ /* NOT USED FOR THE MOMENT IN THE V2 VERSION */
1003 	/** number of markers */
1004 	OPJ_UINT32 marknum;
1005 	/** list of markers */
1006 	opj_marker_info_t *marker;
1007 	/** actual size of markers array */
1008 	OPJ_UINT32 maxmarknum;
1009 /* <<UniPG */
1010 
1011 	/** */
1012 	OPJ_UINT32 nb_of_tiles;
1013 	/** */
1014 	opj_tile_index_t *tile_index; /* FIXME not used for the moment */
1015 
1016 }opj_codestream_index_t;
1017 /* -----------------------------------------------------------> */
1018 
1019 /*
1020 ==========================================================
1021    Metadata from the JP2file
1022 ==========================================================
1023 */
1024 
1025 /**
1026  * Info structure of the JP2 file
1027  * EXPERIMENTAL FOR THE MOMENT
1028  */
1029 typedef struct opj_jp2_metadata {
1030 	/** */
1031 	OPJ_INT32	not_used;
1032 
1033 } opj_jp2_metadata_t;
1034 
1035 /**
1036  * Index structure of the JP2 file
1037  * EXPERIMENTAL FOR THE MOMENT
1038  */
1039 typedef struct opj_jp2_index {
1040 	/** */
1041 	OPJ_INT32	not_used;
1042 
1043 } opj_jp2_index_t;
1044 
1045 
1046 #ifdef __cplusplus
1047 extern "C" {
1048 #endif
1049 
1050 
1051 /*
1052 ==========================================================
1053    openjpeg version
1054 ==========================================================
1055 */
1056 
1057 /* Get the version of the openjpeg library*/
1058 OPJ_API const char * OPJ_CALLCONV opj_version(void);
1059 
1060 /*
1061 ==========================================================
1062    image functions definitions
1063 ==========================================================
1064 */
1065 
1066 /**
1067  * Create an image
1068  *
1069  * @param numcmpts      number of components
1070  * @param cmptparms     components parameters
1071  * @param clrspc        image color space
1072  * @return returns      a new image structure if successful, returns NULL otherwise
1073  * */
1074 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(OPJ_UINT32 numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1075 
1076 /**
1077  * Deallocate any resources associated with an image
1078  *
1079  * @param image         image to be destroyed
1080  */
1081 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
1082 
1083 /**
1084  * Creates an image without allocating memory for the image (used in the new version of the library).
1085  *
1086  * @param	numcmpts    the number of components
1087  * @param	cmptparms   the components parameters
1088  * @param	clrspc      the image color space
1089  *
1090  * @return	a new image structure if successful, NULL otherwise.
1091 */
1092 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_tile_create(OPJ_UINT32 numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1093 
1094 /*
1095 ==========================================================
1096    stream functions definitions
1097 ==========================================================
1098 */
1099 
1100 /**
1101  * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1102  *
1103  * @param	p_is_input		if set to true then the stream will be an input stream, an output stream else.
1104  *
1105  * @return	a stream object.
1106 */
1107 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_default_create(OPJ_BOOL p_is_input);
1108 
1109 /**
1110  * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1111  *
1112  * @param	p_buffer_size  FIXME DOC
1113  * @param	p_is_input		if set to true then the stream will be an input stream, an output stream else.
1114  *
1115  * @return	a stream object.
1116 */
1117 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create(OPJ_SIZE_T p_buffer_size, OPJ_BOOL p_is_input);
1118 
1119 /**
1120  * Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must
1121  * close its own implementation of the stream.
1122  *
1123  * @param	p_stream	the stream to destroy.
1124  */
1125 OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream);
1126 
1127 /**
1128  * Sets the given function to be used as a read function.
1129  * @param		p_stream	the stream to modify
1130  * @param		p_function	the function to use a read function.
1131 */
1132 OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream, opj_stream_read_fn p_function);
1133 
1134 /**
1135  * Sets the given function to be used as a write function.
1136  * @param		p_stream	the stream to modify
1137  * @param		p_function	the function to use a write function.
1138 */
1139 OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream, opj_stream_write_fn p_function);
1140 
1141 /**
1142  * Sets the given function to be used as a skip function.
1143  * @param		p_stream	the stream to modify
1144  * @param		p_function	the function to use a skip function.
1145 */
1146 OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream, opj_stream_skip_fn p_function);
1147 
1148 /**
1149  * Sets the given function to be used as a seek function, the stream is then seekable.
1150  * @param		p_stream	the stream to modify
1151  * @param		p_function	the function to use a skip function.
1152 */
1153 OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream, opj_stream_seek_fn p_function);
1154 
1155 /**
1156  * Sets the given data to be used as a user data for the stream.
1157  * @param		p_stream	the stream to modify
1158  * @param		p_data		the data to set.
1159  * @param		p_function	the function to free p_data when opj_stream_destroy() is called.
1160 */
1161 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);
1162 
1163 /**
1164  * Sets the length of the user data for the stream.
1165  *
1166  * @param p_stream    the stream to modify
1167  * @param data_length length of the user_data.
1168 */
1169 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data_length(opj_stream_t* p_stream, OPJ_UINT64 data_length);
1170 
1171 /**
1172  * Create a stream from a file identified with its filename with default parameters (helper function)
1173  * @param fname             the filename of the file to stream
1174  * @param p_is_read_stream  whether the stream is a read stream (true) or not (false)
1175 */
1176 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream (const char *fname, OPJ_BOOL p_is_read_stream);
1177 
1178 /** Create a stream from a file identified with its filename with a specific buffer size
1179  * @param fname             the filename of the file to stream
1180  * @param p_buffer_size     size of the chunk used to stream
1181  * @param p_is_read_stream  whether the stream is a read stream (true) or not (false)
1182 */
1183 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream (const char *fname,
1184                                                                      OPJ_SIZE_T p_buffer_size,
1185                                                                      OPJ_BOOL p_is_read_stream);
1186 
1187 /*
1188 ==========================================================
1189    event manager functions definitions
1190 ==========================================================
1191 */
1192 /**
1193  * Set the info handler use by openjpeg.
1194  * @param p_codec       the codec previously initialise
1195  * @param p_callback    the callback function which will be used
1196  * @param p_user_data   client object where will be returned the message
1197 */
1198 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_info_handler(opj_codec_t * p_codec,
1199                                                    opj_msg_callback p_callback,
1200                                                    void * p_user_data);
1201 /**
1202  * Set the warning handler use by openjpeg.
1203  * @param p_codec       the codec previously initialise
1204  * @param p_callback    the callback function which will be used
1205  * @param p_user_data   client object where will be returned the message
1206 */
1207 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_warning_handler(opj_codec_t * p_codec,
1208                                                       opj_msg_callback p_callback,
1209                                                       void * p_user_data);
1210 /**
1211  * Set the error handler use by openjpeg.
1212  * @param p_codec       the codec previously initialise
1213  * @param p_callback    the callback function which will be used
1214  * @param p_user_data   client object where will be returned the message
1215 */
1216 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_error_handler(opj_codec_t * p_codec,
1217                                                     opj_msg_callback p_callback,
1218                                                     void * p_user_data);
1219 
1220 /*
1221 ==========================================================
1222    codec functions definitions
1223 ==========================================================
1224 */
1225 
1226 /**
1227  * Creates a J2K/JP2 decompression structure
1228  * @param format 		Decoder to select
1229  *
1230  * @return Returns a handle to a decompressor if successful, returns NULL otherwise
1231  * */
1232 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format);
1233 
1234 /**
1235  * Destroy a decompressor handle
1236  *
1237  * @param	p_codec			decompressor handle to destroy
1238  */
1239 OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec);
1240 
1241 /**
1242  * Read after the codestream if necessary
1243  * @param	p_codec			the JPEG2000 codec to read.
1244  * @param	p_stream		the JPEG2000 stream.
1245  */
1246 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_decompress (	opj_codec_t *p_codec,
1247 													opj_stream_t *p_stream);
1248 
1249 
1250 /**
1251  * Set decoding parameters to default values
1252  * @param parameters Decompression parameters
1253  */
1254 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters);
1255 
1256 /**
1257  * Setup the decoder with decompression parameters provided by the user and with the message handler
1258  * provided by the user.
1259  *
1260  * @param p_codec 		decompressor handler
1261  * @param parameters 	decompression parameters
1262  *
1263  * @return true			if the decoder is correctly set
1264  */
1265 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_decoder(opj_codec_t *p_codec,
1266 												opj_dparameters_t *parameters );
1267 
1268 /**
1269  * Decodes an image header.
1270  *
1271  * @param	p_stream		the jpeg2000 stream.
1272  * @param	p_codec			the jpeg2000 codec to read.
1273  * @param	p_image			the image structure initialized with the characteristics of encoded image.
1274  *
1275  * @return true				if the main header of the codestream and the JP2 header is correctly read.
1276  */
1277 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_read_header (	opj_stream_t *p_stream,
1278 												opj_codec_t *p_codec,
1279 												opj_image_t **p_image);
1280 
1281 /**
1282  * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
1283  *
1284  * @param	p_codec			the jpeg2000 codec.
1285  * @param	p_image         the decoded image previously setted by opj_read_header
1286  * @param	p_start_x		the left position of the rectangle to decode (in image coordinates).
1287  * @param	p_end_x			the right position of the rectangle to decode (in image coordinates).
1288  * @param	p_start_y		the up position of the rectangle to decode (in image coordinates).
1289  * @param	p_end_y			the bottom position of the rectangle to decode (in image coordinates).
1290  *
1291  * @return	true			if the area could be set.
1292  */
1293 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decode_area(	opj_codec_t *p_codec,
1294 													opj_image_t* p_image,
1295 													OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
1296 													OPJ_INT32 p_end_x, OPJ_INT32 p_end_y );
1297 
1298 /**
1299  * Decode an image from a JPEG-2000 codestream
1300  *
1301  * @param p_decompressor 	decompressor handle
1302  * @param p_stream			Input buffer stream
1303  * @param p_image 			the decoded image
1304  * @return 					true if success, otherwise false
1305  * */
1306 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode(   opj_codec_t *p_decompressor,
1307                                             opj_stream_t *p_stream,
1308                                             opj_image_t *p_image);
1309 
1310 /**
1311  * Get the decoded tile from the codec
1312  *
1313  * @param	p_codec			the jpeg2000 codec.
1314  * @param	p_stream		input streamm
1315  * @param	p_image			output image
1316  * @param	tile_index		index of the tile which will be decode
1317  *
1318  * @return					true if success, otherwise false
1319  */
1320 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_get_decoded_tile(	opj_codec_t *p_codec,
1321 													opj_stream_t *p_stream,
1322 													opj_image_t *p_image,
1323 													OPJ_UINT32 tile_index);
1324 
1325 /**
1326  * Set the resolution factor of the decoded image
1327  * @param	p_codec			the jpeg2000 codec.
1328  * @param	res_factor		resolution factor to set
1329  *
1330  * @return					true if success, otherwise false
1331  */
1332 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decoded_resolution_factor(opj_codec_t *p_codec, OPJ_UINT32 res_factor);
1333 
1334 /**
1335  * Writes a tile with the given data.
1336  *
1337  * @param	p_codec		        the jpeg2000 codec.
1338  * @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.
1339  * @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.
1340  * @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
1341  *                              tile_width * tile_height * component_size. component_size can be 1,2 or 4 bytes, depending on the precision of the given component.
1342  * @param	p_stream			the stream to write data to.
1343  *
1344  * @return	true if the data could be written.
1345  */
1346 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_write_tile (	opj_codec_t *p_codec,
1347 												OPJ_UINT32 p_tile_index,
1348 												OPJ_BYTE * p_data,
1349 												OPJ_UINT32 p_data_size,
1350 												opj_stream_t *p_stream );
1351 
1352 /**
1353  * Reads a tile header. This function is compulsory and allows one to know the size of the tile that will be decoded.
1354  * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1355  *
1356  * @param	p_codec			the jpeg2000 codec.
1357  * @param	p_tile_index	pointer to a value that will hold the index of the tile being decoded, in case of success.
1358  * @param	p_data_size		pointer to a value that will hold the maximum size of the decoded data, in case of success. In case
1359  *							of truncated codestreams, the actual number of bytes decoded may be lower. The computation of the size is the same
1360  *							as depicted in opj_write_tile.
1361  * @param	p_tile_x0		pointer to a value that will hold the x0 pos of the tile (in the image).
1362  * @param	p_tile_y0		pointer to a value that will hold the y0 pos of the tile (in the image).
1363  * @param	p_tile_x1		pointer to a value that will hold the x1 pos of the tile (in the image).
1364  * @param	p_tile_y1		pointer to a value that will hold the y1 pos of the tile (in the image).
1365  * @param	p_nb_comps		pointer to a value that will hold the number of components in the tile.
1366  * @param	p_should_go_on	pointer to a boolean that will hold the fact that the decoding should go on. In case the
1367  *							codestream is over at the time of the call, the value will be set to false. The user should then stop
1368  *							the decoding.
1369  * @param	p_stream		the stream to decode.
1370  * @return	true			if the tile header could be decoded. In case the decoding should end, the returned value is still true.
1371  *							returning false may be the result of a shortage of memory or an internal error.
1372  */
1373 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_read_tile_header(	opj_codec_t *p_codec,
1374 												opj_stream_t * p_stream,
1375 												OPJ_UINT32 * p_tile_index,
1376 												OPJ_UINT32 * p_data_size,
1377 												OPJ_INT32 * p_tile_x0, OPJ_INT32 * p_tile_y0,
1378 												OPJ_INT32 * p_tile_x1, OPJ_INT32 * p_tile_y1,
1379 												OPJ_UINT32 * p_nb_comps,
1380 												OPJ_BOOL * p_should_go_on );
1381 
1382 /**
1383  * Reads a tile data. This function is compulsory and allows one to decode tile data. opj_read_tile_header should be called before.
1384  * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1385  *
1386  * @param	p_codec			the jpeg2000 codec.
1387  * @param	p_tile_index	the index of the tile being decoded, this should be the value set by opj_read_tile_header.
1388  * @param	p_data			pointer to a memory block that will hold the decoded data.
1389  * @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.
1390  * @param	p_stream		the stream to decode.
1391  *
1392  * @return	true			if the data could be decoded.
1393  */
1394 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode_tile_data(	opj_codec_t *p_codec,
1395 													OPJ_UINT32 p_tile_index,
1396 													OPJ_BYTE * p_data,
1397 													OPJ_UINT32 p_data_size,
1398 													opj_stream_t *p_stream );
1399 
1400 /* COMPRESSION FUNCTIONS*/
1401 
1402 /**
1403  * Creates a J2K/JP2 compression structure
1404  * @param 	format 		Coder to select
1405  * @return 				Returns a handle to a compressor if successful, returns NULL otherwise
1406  */
1407 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
1408 
1409 /**
1410 Set encoding parameters to default values, that means :
1411 <ul>
1412 <li>Lossless
1413 <li>1 tile
1414 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
1415 <li>Size of code-block : 64 x 64
1416 <li>Number of resolutions: 6
1417 <li>No SOP marker in the codestream
1418 <li>No EPH marker in the codestream
1419 <li>No sub-sampling in x or y direction
1420 <li>No mode switch activated
1421 <li>Progression order: LRCP
1422 <li>No index file
1423 <li>No ROI upshifted
1424 <li>No offset of the origin of the image
1425 <li>No offset of the origin of the tiles
1426 <li>Reversible DWT 5-3
1427 </ul>
1428 @param parameters Compression parameters
1429 */
1430 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(opj_cparameters_t *parameters);
1431 
1432 /**
1433  * Setup the encoder parameters using the current image and using user parameters.
1434  * @param p_codec 		Compressor handle
1435  * @param parameters 	Compression parameters
1436  * @param image 		Input filled image
1437  */
1438 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_encoder(opj_codec_t *p_codec,
1439 												opj_cparameters_t *parameters,
1440 												opj_image_t *image);
1441 
1442 /**
1443  * Start to compress the current image.
1444  * @param p_codec 		Compressor handle
1445  * @param image 	    Input filled image
1446  * @param p_stream 		Input stgream
1447  */
1448 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_start_compress (	opj_codec_t *p_codec,
1449 													opj_image_t * p_image,
1450 													opj_stream_t *p_stream);
1451 
1452 /**
1453  * End to compress the current image.
1454  * @param p_codec 		Compressor handle
1455  * @param p_stream 		Input stgream
1456  */
1457 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_compress (opj_codec_t *p_codec,
1458 												opj_stream_t *p_stream);
1459 
1460 /**
1461  * Encode an image into a JPEG-2000 codestream
1462  * @param p_codec 		compressor handle
1463  * @param p_stream 		Output buffer stream
1464  *
1465  * @return 				Returns true if successful, returns false otherwise
1466  */
1467 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_encode(opj_codec_t *p_codec,
1468                                          opj_stream_t *p_stream);
1469 /*
1470 ==========================================================
1471    codec output functions definitions
1472 ==========================================================
1473 */
1474 /* EXPERIMENTAL FUNCTIONS FOR NOW, USED ONLY IN J2K_DUMP*/
1475 
1476 /**
1477 Destroy Codestream information after compression or decompression
1478 @param cstr_info Codestream information structure
1479 */
1480 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_v2_t **cstr_info);
1481 
1482 
1483 /**
1484  * Dump the codec information into the output stream
1485  *
1486  * @param	p_codec			the jpeg2000 codec.
1487  * @param	info_flag		type of information dump.
1488  * @param	output_stream	output stream where dump the informations get from the codec.
1489  *
1490  */
1491 OPJ_API void OPJ_CALLCONV opj_dump_codec(	opj_codec_t *p_codec,
1492 											OPJ_INT32 info_flag,
1493 											FILE* output_stream);
1494 
1495 /**
1496  * Get the codestream information from the codec
1497  *
1498  * @param	p_codec			the jpeg2000 codec.
1499  *
1500  * @return					a pointer to a codestream information structure.
1501  *
1502  */
1503 OPJ_API opj_codestream_info_v2_t* OPJ_CALLCONV opj_get_cstr_info(opj_codec_t *p_codec);
1504 
1505 /**
1506  * Get the codestream index from the codec
1507  *
1508  * @param	p_codec			the jpeg2000 codec.
1509  *
1510  * @return					a pointer to a codestream index structure.
1511  *
1512  */
1513 OPJ_API opj_codestream_index_t * OPJ_CALLCONV opj_get_cstr_index(opj_codec_t *p_codec);
1514 
1515 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_index(opj_codestream_index_t **p_cstr_index);
1516 
1517 
1518 /**
1519  * Get the JP2 file information from the codec FIXME
1520  *
1521  * @param	p_codec			the jpeg2000 codec.
1522  *
1523  * @return					a pointer to a JP2 metadata structure.
1524  *
1525  */
1526 OPJ_API opj_jp2_metadata_t* OPJ_CALLCONV opj_get_jp2_metadata(opj_codec_t *p_codec);
1527 
1528 /**
1529  * Get the JP2 file index from the codec FIXME
1530  *
1531  * @param	p_codec			the jpeg2000 codec.
1532  *
1533  * @return					a pointer to a JP2 index structure.
1534  *
1535  */
1536 OPJ_API opj_jp2_index_t* OPJ_CALLCONV opj_get_jp2_index(opj_codec_t *p_codec);
1537 
1538 
1539 /*
1540 ==========================================================
1541    MCT functions
1542 ==========================================================
1543 */
1544 
1545 /**
1546  * Sets the MCT matrix to use.
1547  *
1548  * @param	parameters		the parameters to change.
1549  * @param	pEncodingMatrix	the encoding matrix.
1550  * @param	p_dc_shift		the dc shift coefficients to use.
1551  * @param	pNbComp			the number of components of the image.
1552  *
1553  * @return	true if the parameters could be set.
1554  */
1555 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_MCT( opj_cparameters_t *parameters,
1556 		                               	   OPJ_FLOAT32 * pEncodingMatrix,
1557 		                               	   OPJ_INT32 * p_dc_shift,
1558 		                               	   OPJ_UINT32 pNbComp);
1559 
1560 
1561 
1562 #ifdef __cplusplus
1563 }
1564 #endif
1565 
1566 #endif /* OPENJPEG_H */
1567