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.
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.
21 * Redistribution and use in source and binary forms, with or without
22 * modification, are permitted provided that the following conditions
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.
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.
47 ==========================================================
49 ==========================================================
53 The inline keyword is supported by C99 but not by C90.
54 Most compilers implement their own version of this keyword ...
58 #define INLINE __forceinline
59 #elif defined(__GNUC__)
60 #define INLINE __inline__
61 #elif defined(__MWERKS__)
64 /* add other compilers here ... */
66 #endif /* defined(<Compiler>) */
69 /* deprecated attribute */
71 #define OPJ_DEPRECATED(func) func __attribute__ ((deprecated))
72 #elif defined(_MSC_VER)
73 #define OPJ_DEPRECATED(func) __declspec(deprecated) func
75 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
76 #define OPJ_DEPRECATED(func) func
79 #if defined(OPJ_STATIC) || !defined(_WIN32)
80 /* http://gcc.gnu.org/wiki/Visibility */
82 # if defined(OPJ_STATIC) /* static library uses "hidden" */
83 # define OPJ_API __attribute__ ((visibility ("hidden")))
85 # define OPJ_API __attribute__ ((visibility ("default")))
87 # define OPJ_LOCAL __attribute__ ((visibility ("hidden")))
94 # define OPJ_CALLCONV __stdcall
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.
103 # if defined(OPJ_EXPORTS) || defined(DLL_EXPORT)
104 # define OPJ_API __declspec(dllexport)
106 # define OPJ_API __declspec(dllimport)
107 # endif /* OPJ_EXPORTS */
108 #endif /* !OPJ_STATIC || !_WIN32 */
110 typedef int OPJ_BOOL;
114 typedef char OPJ_CHAR;
115 typedef float OPJ_FLOAT32;
116 typedef double OPJ_FLOAT64;
117 typedef unsigned char OPJ_BYTE;
119 #include "opj_stdint.h"
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;
130 typedef int64_t OPJ_OFF_T; /* 64-bit file offset type */
133 typedef size_t OPJ_SIZE_T;
135 /* Avoid compile-time warning because parameter is not used */
136 #define OPJ_ARG_NOT_USED(x) (void)(x)
139 ==========================================================
140 Useful constant definitions
141 ==========================================================
144 #define OPJ_PATH_LEN 4096 /**< Maximum allowed size for filenames */
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 */
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
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 */
167 * EXPERIMENTAL FOR THE MOMENT
168 * Supported options about file information used only in j2k_dump
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 */
181 * JPEG 2000 Profiles, see Table A.10 from 15444-1 (updated in various AMD)
182 * These values help choosing 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)
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 */
214 * JPEG 2000 Part-2 extensions
216 #define OPJ_EXTENSION_NONE 0x0000 /** No Part-2 extension */
217 #define OPJ_EXTENSION_MCT 0x0100 /** Custom MCT support */
220 * JPEG 2000 profile macros
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)
229 * JPEG 2000 codestream and component size limits in cinema profiles
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 */
237 ==========================================================
239 ==========================================================
243 * DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead
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*/
251 } OPJ_RSIZ_CAPABILITIES;
254 * DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead
255 * Digital cinema operation mode
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*/
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 */
277 * Supported image color spaces
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 */
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 */
303 ==========================================================
304 event manager typedef definitions
305 ==========================================================
309 * Callback function prototype for events
310 * @param msg Event message
311 * @param client_data Client object where will be return the event message
313 typedef void (*opj_msg_callback)(const char *msg, void *client_data);
316 ==========================================================
317 codec typedef definitions
318 ==========================================================
322 * Progression order changes
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];
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;
351 * Compression parameters
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;
364 /** allocation by rate/distortion */
366 /** allocation by fixed layer */
368 /** add fixed_quality */
369 int cp_fixed_quality;
372 /** comment for coding */
374 /** csty : coding style */
376 /** progression order (default OPJ_LRCP) */
377 OPJ_PROG_ORDER prog_order;
378 /** progression order changes */
380 /** number of progression order changes (POC), default to 0 */
382 /** number of layers */
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 */
390 /** initial code block width, default to 64 */
392 /** initial code block height, default to 64 */
394 /** mode switch (cblk_style) */
396 /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
398 /** region of interest: affected component in [0..3], -1 means no ROI */
400 /** region of interest: upshift value */
402 /* number of precinct size specifications */
404 /** initial precinct width */
405 int prcw_init[OPJ_J2K_MAXRLVLS];
406 /** initial precinct height */
407 int prch_init[OPJ_J2K_MAXRLVLS];
409 /**@name command line encoder parameters (not used inside the library) */
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 */
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 */
421 /** subimage encoding: origin image offset in y direction */
423 /** subsampling value for dx */
425 /** subsampling value for dy */
427 /** input file format 0: PGX, 1: PxM, 2: BMP 3:TIF*/
429 /** output file format 0: J2K, 1: JP2, 2: JPT */
433 /* UniPG>> */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */
434 /**@name JPWL encoding parameters */
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) */
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) */
452 /** sensitivity addressing size (0=auto/2/4 bytes) */
454 /** sensitivity range (0-3) */
456 /** sensitivity method for MH (-1=no,0-7) */
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];
466 * DEPRECATED: use RSIZ, OPJ_PROFILE_* and MAX_COMP_SIZE instead
467 * Digital Cinema compliance 0-not compliant, 1-compliant
469 OPJ_CINEMA_MODE cp_cinema;
471 * Maximum size (in bytes) for each component.
472 * If == 0, component size limitation is not considered
476 * DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead
479 OPJ_RSIZ_CAPABILITIES cp_rsiz;
480 /** Tile part generation*/
482 /** Flag for Tile part generation*/
484 /** MCT (multiple component transform) */
486 /** Enable JPIP indexing*/
488 /** Naive implementation of MCT restricted to a single reversible array based
489 encoding without offset concerning all the components. */
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.
499 To be used to combine OPJ_PROFILE_*, OPJ_EXTENSION_* and (sub)levels values. */
503 #define OPJ_DPARAMETERS_IGNORE_PCLR_CMAP_CDEF_FLAG 0x0001
506 * Decompression parameters
508 typedef struct opj_dparameters {
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
516 OPJ_UINT32 cp_reduce;
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
525 /**@name command line decoder parameters (not used inside the library) */
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 */
533 /** output file format 0: PGX, 1: PxM, 2: BMP */
536 /** Decoding area left boundary */
538 /** Decoding area right boundary */
540 /** Decoding area up boundary */
542 /** Decoding area bottom boundary */
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;
554 /* UniPG>> */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */
555 /**@name JPWL decoding parameters */
557 /** activates the JPWL correction capabilities */
558 OPJ_BOOL jpwl_correct;
559 /** expected number of components */
561 /** maximum number of tiles */
574 typedef void * opj_codec_t;
577 ==========================================================
578 I/O stream typedef definitions
579 ==========================================================
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
591 * Callback function prototype for read function
593 typedef OPJ_SIZE_T(* opj_stream_read_fn)(void * p_buffer, OPJ_SIZE_T p_nb_bytes,
594 void * p_user_data) ;
597 * Callback function prototype for write function
599 typedef OPJ_SIZE_T(* opj_stream_write_fn)(void * p_buffer,
600 OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
603 * Callback function prototype for skip function
605 typedef OPJ_OFF_T(* opj_stream_skip_fn)(OPJ_OFF_T p_nb_bytes,
606 void * p_user_data) ;
609 * Callback function prototype for seek function
611 typedef OPJ_BOOL(* opj_stream_seek_fn)(OPJ_OFF_T p_nb_bytes,
612 void * p_user_data) ;
615 * Callback function prototype for free user data function
617 typedef void (* opj_stream_free_user_data_fn)(void * p_user_data) ;
622 typedef void * opj_stream_t;
625 ==========================================================
626 image typedef definitions
627 ==========================================================
631 * Defines a single image component
633 typedef struct opj_image_comp {
634 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
636 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
642 /** x component offset compared to the whole image */
644 /** y component offset compared to the whole image */
648 /** image depth in bits */
650 /** signed (1) / unsigned (0) */
652 /** number of decoded resolution */
653 OPJ_UINT32 resno_decoded;
654 /** number of division by 2 of the out image compared to the original size of image */
656 /** image component data */
663 * Defines image data and characteristics
665 typedef struct opj_image {
666 /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
668 /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
670 /** Xsiz: width of the reference grid */
672 /** Ysiz: height of the reference grid */
674 /** number of components in the image */
676 /** color space: sRGB, Greyscale or YUV */
677 OPJ_COLOR_SPACE color_space;
678 /** image components */
679 opj_image_comp_t *comps;
680 /** 'restricted' ICC profile */
681 OPJ_BYTE *icc_profile_buf;
682 /** size of ICC profile */
683 OPJ_UINT32 icc_profile_len;
688 * Component parameters structure used by the opj_image_create function
690 typedef struct opj_image_comptparm {
691 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
693 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
699 /** x component offset compared to the whole image */
701 /** y component offset compared to the whole image */
705 /** image depth in bits */
707 /** signed (1) / unsigned (0) */
709 } opj_image_cmptparm_t;
713 ==========================================================
714 Information on the JPEG 2000 codestream
715 ==========================================================
717 /* QUITE EXPERIMENTAL FOR THE MOMENT */
720 * Index structure : Information concerning a packet inside tile
722 typedef struct opj_packet_info {
723 /** packet start position (including SOP marker if it exists) */
725 /** end of packet header position (including EPH marker if it exists)*/
726 OPJ_OFF_T end_ph_pos;
727 /** packet end position */
729 /** packet distorsion */
738 typedef struct opj_marker_info {
740 unsigned short int type;
741 /** position in codestream */
743 /** length, marker val included */
749 * Index structure : Information concerning tile-parts
751 typedef struct opj_tp_info {
752 /** start position of tile part */
754 /** end position of tile part header */
756 /** end position of tile part */
758 /** start packet of tile part */
760 /** number of packets of tile part */
765 * Index structure : information regarding tiles
767 typedef struct opj_tile_info {
768 /** value of thresh for each layer by tile cfr. Marcela */
770 /** number of tile */
772 /** start position */
774 /** end position of the header */
778 /** precinct number for each resolution level (width) */
780 /** precinct number for each resolution level (height) */
782 /** precinct size (in power of 2), in X for each resolution level */
784 /** precinct size (in power of 2), in Y for each resolution level */
786 /** information concerning packets inside tile */
787 opj_packet_info_t *packet;
788 /** add fixed_quality */
790 /** add fixed_quality */
792 /** number of markers */
794 /** list of markers */
795 opj_marker_info_t *marker;
796 /** actual size of markers array */
798 /** number of tile parts */
800 /** information concerning tile parts */
805 * Index structure of the codestream
807 typedef struct opj_codestream_info {
808 /** maximum distortion reduction on the whole image (add for Marcela) */
812 /** writing the packet in the index with t2_encode_packets */
818 /** progression order */
820 /** tile size in x */
822 /** tile size in y */
828 /** number of tiles in X */
830 /** number of tiles in Y */
832 /** component numbers */
834 /** number of layer */
836 /** number of decomposition for each component */
839 /** number of markers */
841 /** list of markers */
842 opj_marker_info_t *marker;
843 /** actual size of markers array */
846 /** main header position */
848 /** main header position */
850 /** codestream's size */
852 /** information regarding tiles inside image */
853 opj_tile_info_t *tile;
854 } opj_codestream_info_t;
856 /* <----------------------------------------------------------- */
857 /* new output management of the codestream information and index */
860 * Tile-component coding parameters information
862 typedef struct opj_tccp_info {
863 /** component index */
867 /** number of resolutions */
868 OPJ_UINT32 numresolutions;
869 /** code-blocks width */
871 /** code-blocks height */
873 /** code-block coding style */
875 /** discrete wavelet transform identifier */
877 /** quantisation style */
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 */
885 /** Region Of Interest shift */
887 /** precinct width */
888 OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
889 /** precinct height */
890 OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
895 * Tile coding parameters information
897 typedef struct opj_tile_v2_info {
899 /** number (index) of tile */
903 /** progression order */
905 /** number of layers */
906 OPJ_UINT32 numlayers;
907 /** multi-component transform identifier */
910 /** information concerning tile component parameters*/
911 opj_tccp_info_t *tccp_info;
913 } opj_tile_info_v2_t;
916 * Information structure about the codestream (FIXME should be expand and enhance)
918 typedef struct opj_codestream_info_v2 {
920 /** tile origin in x = XTOsiz */
922 /** tile origin in y = YTOsiz */
924 /** tile size in x = XTsiz */
926 /** tile size in y = YTsiz */
928 /** number of tiles in X */
930 /** number of tiles in Y */
933 /** number of components*/
936 /** Default information regarding tiles inside image */
937 opj_tile_info_v2_t m_default_tile_info;
939 /** information regarding tiles inside image */
940 opj_tile_info_v2_t *tile_info; /* FIXME not used for the moment */
942 } opj_codestream_info_v2_t;
946 * Index structure about a tile part
948 typedef struct opj_tp_index {
949 /** start position */
951 /** end position of the header */
952 OPJ_OFF_T end_header;
959 * Index structure about a tile
961 typedef struct opj_tile_index {
965 /** number of tile parts */
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;
974 /* UniPG>> */ /* NOT USED FOR THE MOMENT IN THE V2 VERSION */
975 /** number of markers */
977 /** list of markers */
978 opj_marker_info_t *marker;
979 /** actual size of markers array */
980 OPJ_UINT32 maxmarknum;
984 OPJ_UINT32 nb_packet;
985 /** information concerning packets inside tile */
986 opj_packet_info_t *packet_index;
991 * Index structure of the codestream (FIXME should be expand and enhance)
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;
999 /** codestream's size */
1000 OPJ_UINT64 codestream_size;
1002 /* UniPG>> */ /* NOT USED FOR THE MOMENT IN THE V2 VERSION */
1003 /** number of markers */
1005 /** list of markers */
1006 opj_marker_info_t *marker;
1007 /** actual size of markers array */
1008 OPJ_UINT32 maxmarknum;
1012 OPJ_UINT32 nb_of_tiles;
1014 opj_tile_index_t *tile_index; /* FIXME not used for the moment */
1016 } opj_codestream_index_t;
1017 /* -----------------------------------------------------------> */
1020 ==========================================================
1021 Metadata from the JP2file
1022 ==========================================================
1026 * Info structure of the JP2 file
1027 * EXPERIMENTAL FOR THE MOMENT
1029 typedef struct opj_jp2_metadata {
1033 } opj_jp2_metadata_t;
1036 * Index structure of the JP2 file
1037 * EXPERIMENTAL FOR THE MOMENT
1039 typedef struct opj_jp2_index {
1052 ==========================================================
1054 ==========================================================
1057 /* Get the version of the openjpeg library*/
1058 OPJ_API const char * OPJ_CALLCONV opj_version(void);
1061 ==========================================================
1062 image functions definitions
1063 ==========================================================
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
1074 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(OPJ_UINT32 numcmpts,
1075 opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1078 * Deallocate any resources associated with an image
1080 * @param image image to be destroyed
1082 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
1085 * Creates an image without allocating memory for the image (used in the new version of the library).
1087 * @param numcmpts the number of components
1088 * @param cmptparms the components parameters
1089 * @param clrspc the image color space
1091 * @return a new image structure if successful, NULL otherwise.
1093 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_tile_create(OPJ_UINT32 numcmpts,
1094 opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1097 ==========================================================
1098 stream functions definitions
1099 ==========================================================
1103 * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1105 * @param p_is_input if set to true then the stream will be an input stream, an output stream else.
1107 * @return a stream object.
1109 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_default_create(
1110 OPJ_BOOL p_is_input);
1113 * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1115 * @param p_buffer_size FIXME DOC
1116 * @param p_is_input if set to true then the stream will be an input stream, an output stream else.
1118 * @return a stream object.
1120 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create(OPJ_SIZE_T p_buffer_size,
1121 OPJ_BOOL p_is_input);
1124 * Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must
1125 * close its own implementation of the stream.
1127 * @param p_stream the stream to destroy.
1129 OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream);
1132 * Sets the given function to be used as a read function.
1133 * @param p_stream the stream to modify
1134 * @param p_function the function to use a read function.
1136 OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream,
1137 opj_stream_read_fn p_function);
1140 * Sets the given function to be used as a write function.
1141 * @param p_stream the stream to modify
1142 * @param p_function the function to use a write function.
1144 OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream,
1145 opj_stream_write_fn p_function);
1148 * Sets the given function to be used as a skip function.
1149 * @param p_stream the stream to modify
1150 * @param p_function the function to use a skip function.
1152 OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream,
1153 opj_stream_skip_fn p_function);
1156 * Sets the given function to be used as a seek function, the stream is then seekable.
1157 * @param p_stream the stream to modify
1158 * @param p_function the function to use a skip function.
1160 OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream,
1161 opj_stream_seek_fn p_function);
1164 * Sets the given data to be used as a user data for the stream.
1165 * @param p_stream the stream to modify
1166 * @param p_data the data to set.
1167 * @param p_function the function to free p_data when opj_stream_destroy() is called.
1169 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data(opj_stream_t* p_stream,
1170 void * p_data, opj_stream_free_user_data_fn p_function);
1173 * Sets the length of the user data for the stream.
1175 * @param p_stream the stream to modify
1176 * @param data_length length of the user_data.
1178 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data_length(
1179 opj_stream_t* p_stream, OPJ_UINT64 data_length);
1182 * Create a stream from a file identified with its filename with default parameters (helper function)
1183 * @param fname the filename of the file to stream
1184 * @param p_is_read_stream whether the stream is a read stream (true) or not (false)
1186 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream(
1187 const char *fname, OPJ_BOOL p_is_read_stream);
1189 /** Create a stream from a file identified with its filename with a specific buffer size
1190 * @param fname the filename of the file to stream
1191 * @param p_buffer_size size of the chunk used to stream
1192 * @param p_is_read_stream whether the stream is a read stream (true) or not (false)
1194 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream(
1196 OPJ_SIZE_T p_buffer_size,
1197 OPJ_BOOL p_is_read_stream);
1200 ==========================================================
1201 event manager functions definitions
1202 ==========================================================
1205 * Set the info handler use by openjpeg.
1206 * @param p_codec the codec previously initialise
1207 * @param p_callback the callback function which will be used
1208 * @param p_user_data client object where will be returned the message
1210 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_info_handler(opj_codec_t * p_codec,
1211 opj_msg_callback p_callback,
1212 void * p_user_data);
1214 * Set the warning handler use by openjpeg.
1215 * @param p_codec the codec previously initialise
1216 * @param p_callback the callback function which will be used
1217 * @param p_user_data client object where will be returned the message
1219 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_warning_handler(opj_codec_t * p_codec,
1220 opj_msg_callback p_callback,
1221 void * p_user_data);
1223 * Set the error handler use by openjpeg.
1224 * @param p_codec the codec previously initialise
1225 * @param p_callback the callback function which will be used
1226 * @param p_user_data client object where will be returned the message
1228 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_error_handler(opj_codec_t * p_codec,
1229 opj_msg_callback p_callback,
1230 void * p_user_data);
1233 ==========================================================
1234 codec functions definitions
1235 ==========================================================
1239 * Creates a J2K/JP2 decompression structure
1240 * @param format Decoder to select
1242 * @return Returns a handle to a decompressor if successful, returns NULL otherwise
1244 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress(
1245 OPJ_CODEC_FORMAT format);
1248 * Destroy a decompressor handle
1250 * @param p_codec decompressor handle to destroy
1252 OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec);
1255 * Read after the codestream if necessary
1256 * @param p_codec the JPEG2000 codec to read.
1257 * @param p_stream the JPEG2000 stream.
1259 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_decompress(opj_codec_t *p_codec,
1260 opj_stream_t *p_stream);
1264 * Set decoding parameters to default values
1265 * @param parameters Decompression parameters
1267 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(
1268 opj_dparameters_t *parameters);
1271 * Setup the decoder with decompression parameters provided by the user and with the message handler
1272 * provided by the user.
1274 * @param p_codec decompressor handler
1275 * @param parameters decompression parameters
1277 * @return true if the decoder is correctly set
1279 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_decoder(opj_codec_t *p_codec,
1280 opj_dparameters_t *parameters);
1283 * Allocates worker threads for the compressor/decompressor.
1285 * By default, only the main thread is used. If this function is not used,
1286 * but the OPJ_NUM_THREADS environment variable is set, its value will be
1287 * used to initialize the number of threads. The value can be either an integer
1288 * number, or "ALL_CPUS". If OPJ_NUM_THREADS is set and this function is called,
1289 * this function will override the behaviour of the environment variable.
1291 * Note: currently only has effect on the decompressor.
1293 * @param p_codec decompressor handler
1294 * @param num_threads number of threads.
1296 * @return OPJ_TRUE if the decoder is correctly set
1298 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_codec_set_threads(opj_codec_t *p_codec,
1302 * Decodes an image header.
1304 * @param p_stream the jpeg2000 stream.
1305 * @param p_codec the jpeg2000 codec to read.
1306 * @param p_image the image structure initialized with the characteristics of encoded image.
1308 * @return true if the main header of the codestream and the JP2 header is correctly read.
1310 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_read_header(opj_stream_t *p_stream,
1311 opj_codec_t *p_codec,
1312 opj_image_t **p_image);
1315 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
1317 * @param p_codec the jpeg2000 codec.
1318 * @param p_image the decoded image previously setted by opj_read_header
1319 * @param p_start_x the left position of the rectangle to decode (in image coordinates).
1320 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
1321 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
1322 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
1324 * @return true if the area could be set.
1326 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decode_area(opj_codec_t *p_codec,
1327 opj_image_t* p_image,
1328 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
1329 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y);
1332 * Decode an image from a JPEG-2000 codestream
1334 * @param p_decompressor decompressor handle
1335 * @param p_stream Input buffer stream
1336 * @param p_image the decoded image
1337 * @return true if success, otherwise false
1339 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode(opj_codec_t *p_decompressor,
1340 opj_stream_t *p_stream,
1341 opj_image_t *p_image);
1344 * Get the decoded tile from the codec
1346 * @param p_codec the jpeg2000 codec.
1347 * @param p_stream input streamm
1348 * @param p_image output image
1349 * @param tile_index index of the tile which will be decode
1351 * @return true if success, otherwise false
1353 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_get_decoded_tile(opj_codec_t *p_codec,
1354 opj_stream_t *p_stream,
1355 opj_image_t *p_image,
1356 OPJ_UINT32 tile_index);
1359 * Set the resolution factor of the decoded image
1360 * @param p_codec the jpeg2000 codec.
1361 * @param res_factor resolution factor to set
1363 * @return true if success, otherwise false
1365 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decoded_resolution_factor(
1366 opj_codec_t *p_codec, OPJ_UINT32 res_factor);
1369 * Writes a tile with the given data.
1371 * @param p_codec the jpeg2000 codec.
1372 * @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.
1373 * @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.
1374 * @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
1375 * tile_width * tile_height * component_size. component_size can be 1,2 or 4 bytes, depending on the precision of the given component.
1376 * @param p_stream the stream to write data to.
1378 * @return true if the data could be written.
1380 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_write_tile(opj_codec_t *p_codec,
1381 OPJ_UINT32 p_tile_index,
1383 OPJ_UINT32 p_data_size,
1384 opj_stream_t *p_stream);
1387 * Reads a tile header. This function is compulsory and allows one to know the size of the tile that will be decoded.
1388 * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1390 * @param p_codec the jpeg2000 codec.
1391 * @param p_tile_index pointer to a value that will hold the index of the tile being decoded, in case of success.
1392 * @param p_data_size pointer to a value that will hold the maximum size of the decoded data, in case of success. In case
1393 * of truncated codestreams, the actual number of bytes decoded may be lower. The computation of the size is the same
1394 * as depicted in opj_write_tile.
1395 * @param p_tile_x0 pointer to a value that will hold the x0 pos of the tile (in the image).
1396 * @param p_tile_y0 pointer to a value that will hold the y0 pos of the tile (in the image).
1397 * @param p_tile_x1 pointer to a value that will hold the x1 pos of the tile (in the image).
1398 * @param p_tile_y1 pointer to a value that will hold the y1 pos of the tile (in the image).
1399 * @param p_nb_comps pointer to a value that will hold the number of components in the tile.
1400 * @param p_should_go_on pointer to a boolean that will hold the fact that the decoding should go on. In case the
1401 * codestream is over at the time of the call, the value will be set to false. The user should then stop
1403 * @param p_stream the stream to decode.
1404 * @return true if the tile header could be decoded. In case the decoding should end, the returned value is still true.
1405 * returning false may be the result of a shortage of memory or an internal error.
1407 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_read_tile_header(opj_codec_t *p_codec,
1408 opj_stream_t * p_stream,
1409 OPJ_UINT32 * p_tile_index,
1410 OPJ_UINT32 * p_data_size,
1411 OPJ_INT32 * p_tile_x0, OPJ_INT32 * p_tile_y0,
1412 OPJ_INT32 * p_tile_x1, OPJ_INT32 * p_tile_y1,
1413 OPJ_UINT32 * p_nb_comps,
1414 OPJ_BOOL * p_should_go_on);
1417 * Reads a tile data. This function is compulsory and allows one to decode tile data. opj_read_tile_header should be called before.
1418 * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1420 * @param p_codec the jpeg2000 codec.
1421 * @param p_tile_index the index of the tile being decoded, this should be the value set by opj_read_tile_header.
1422 * @param p_data pointer to a memory block that will hold the decoded data.
1423 * @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.
1424 * @param p_stream the stream to decode.
1426 * @return true if the data could be decoded.
1428 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode_tile_data(opj_codec_t *p_codec,
1429 OPJ_UINT32 p_tile_index,
1431 OPJ_UINT32 p_data_size,
1432 opj_stream_t *p_stream);
1434 /* COMPRESSION FUNCTIONS*/
1437 * Creates a J2K/JP2 compression structure
1438 * @param format Coder to select
1439 * @return Returns a handle to a compressor if successful, returns NULL otherwise
1441 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
1444 Set encoding parameters to default values, that means :
1448 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
1449 <li>Size of code-block : 64 x 64
1450 <li>Number of resolutions: 6
1451 <li>No SOP marker in the codestream
1452 <li>No EPH marker in the codestream
1453 <li>No sub-sampling in x or y direction
1454 <li>No mode switch activated
1455 <li>Progression order: LRCP
1457 <li>No ROI upshifted
1458 <li>No offset of the origin of the image
1459 <li>No offset of the origin of the tiles
1460 <li>Reversible DWT 5-3
1462 @param parameters Compression parameters
1464 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(
1465 opj_cparameters_t *parameters);
1468 * Setup the encoder parameters using the current image and using user parameters.
1469 * @param p_codec Compressor handle
1470 * @param parameters Compression parameters
1471 * @param image Input filled image
1473 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_encoder(opj_codec_t *p_codec,
1474 opj_cparameters_t *parameters,
1475 opj_image_t *image);
1478 * Start to compress the current image.
1479 * @param p_codec Compressor handle
1480 * @param image Input filled image
1481 * @param p_stream Input stgream
1483 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_start_compress(opj_codec_t *p_codec,
1484 opj_image_t * p_image,
1485 opj_stream_t *p_stream);
1488 * End to compress the current image.
1489 * @param p_codec Compressor handle
1490 * @param p_stream Input stgream
1492 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_compress(opj_codec_t *p_codec,
1493 opj_stream_t *p_stream);
1496 * Encode an image into a JPEG-2000 codestream
1497 * @param p_codec compressor handle
1498 * @param p_stream Output buffer stream
1500 * @return Returns true if successful, returns false otherwise
1502 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_encode(opj_codec_t *p_codec,
1503 opj_stream_t *p_stream);
1505 ==========================================================
1506 codec output functions definitions
1507 ==========================================================
1509 /* EXPERIMENTAL FUNCTIONS FOR NOW, USED ONLY IN J2K_DUMP*/
1512 Destroy Codestream information after compression or decompression
1513 @param cstr_info Codestream information structure
1515 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_v2_t
1520 * Dump the codec information into the output stream
1522 * @param p_codec the jpeg2000 codec.
1523 * @param info_flag type of information dump.
1524 * @param output_stream output stream where dump the information gotten from the codec.
1527 OPJ_API void OPJ_CALLCONV opj_dump_codec(opj_codec_t *p_codec,
1528 OPJ_INT32 info_flag,
1529 FILE* output_stream);
1532 * Get the codestream information from the codec
1534 * @param p_codec the jpeg2000 codec.
1536 * @return a pointer to a codestream information structure.
1539 OPJ_API opj_codestream_info_v2_t* OPJ_CALLCONV opj_get_cstr_info(
1540 opj_codec_t *p_codec);
1543 * Get the codestream index from the codec
1545 * @param p_codec the jpeg2000 codec.
1547 * @return a pointer to a codestream index structure.
1550 OPJ_API opj_codestream_index_t * OPJ_CALLCONV opj_get_cstr_index(
1551 opj_codec_t *p_codec);
1553 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_index(opj_codestream_index_t
1558 * Get the JP2 file information from the codec FIXME
1560 * @param p_codec the jpeg2000 codec.
1562 * @return a pointer to a JP2 metadata structure.
1565 OPJ_API opj_jp2_metadata_t* OPJ_CALLCONV opj_get_jp2_metadata(
1566 opj_codec_t *p_codec);
1569 * Get the JP2 file index from the codec FIXME
1571 * @param p_codec the jpeg2000 codec.
1573 * @return a pointer to a JP2 index structure.
1576 OPJ_API opj_jp2_index_t* OPJ_CALLCONV opj_get_jp2_index(opj_codec_t *p_codec);
1580 ==========================================================
1582 ==========================================================
1586 * Sets the MCT matrix to use.
1588 * @param parameters the parameters to change.
1589 * @param pEncodingMatrix the encoding matrix.
1590 * @param p_dc_shift the dc shift coefficients to use.
1591 * @param pNbComp the number of components of the image.
1593 * @return true if the parameters could be set.
1595 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_MCT(opj_cparameters_t *parameters,
1596 OPJ_FLOAT32 * pEncodingMatrix,
1597 OPJ_INT32 * p_dc_shift,
1598 OPJ_UINT32 pNbComp);
1601 ==========================================================
1603 ==========================================================
1606 /** Returns if the library is built with thread support.
1607 * OPJ_TRUE if mutex, condition, thread, thread pool are available.
1609 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_has_thread_support(void);
1611 /** Return the number of virtual CPUs */
1612 OPJ_API int OPJ_CALLCONV opj_get_num_cpus(void);
1619 #endif /* OPENJPEG_H */