2 * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
3 * Copyright (c) 2002-2007, Professor Benoit Macq
4 * Copyright (c) 2001-2003, David Janssens
5 * Copyright (c) 2002-2003, Yannick Verschueren
6 * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
7 * Copyright (c) 2005, Herve Drolon, FreeImage Team
8 * Copyright (c) 2006-2007, Parvatha Elangovan
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
35 #define OPENJPEG_VERSION "1.2.0"
38 ==========================================================
40 ==========================================================
43 #if defined(OPJ_STATIC) || !(defined(WIN32) || defined(__WIN32__))
47 #define OPJ_CALLCONV __stdcall
49 The following ifdef block is the standard way of creating macros which make exporting
50 from a DLL simpler. All files within this DLL are compiled with the OPJ_EXPORTS
51 symbol defined on the command line. this symbol should not be defined on any project
52 that uses this DLL. This way any other project whose source files include this file see
53 OPJ_API functions as being imported from a DLL, wheras this DLL sees symbols
54 defined with this macro as being exported.
57 #define OPJ_API __declspec(dllexport)
59 #define OPJ_API __declspec(dllimport)
60 #endif /* OPJ_EXPORTS */
61 #endif /* !OPJ_STATIC || !WIN32 */
64 #if defined(HAVE_STDBOOL_H)
66 The C language implementation does correctly provide the standard header
72 The C language implementation does not provide the standard header file
73 "stdbool.h" as required by ISO/IEC 9899:1999. Try to compensate for this
86 #endif /* __cplusplus */
89 ==========================================================
90 Useful constant definitions
91 ==========================================================
94 #define OPJ_PATH_LEN 4096 /**< Maximum allowed size for filenames */
96 #define J2K_MAXRLVLS 33 /**< Number of maximum resolution level authorized */
97 #define J2K_MAXBANDS (3*J2K_MAXRLVLS-2) /**< Number of maximum sub-band linked to number of resolution level */
100 #define JPWL_MAX_NO_TILESPECS 16 /**< Maximum number of tile parts expected by JPWL: increase at your will */
101 #define JPWL_MAX_NO_PACKSPECS 16 /**< Maximum number of packet parts expected by JPWL: increase at your will */
102 #define JPWL_MAX_NO_MARKERS 512 /**< Maximum number of JPWL markers: increase at your will */
103 #define JPWL_PRIVATEINDEX_NAME "jpwl_index_privatefilename" /**< index file name used when JPWL is on */
104 #define JPWL_EXPECTED_COMPONENTS 3 /**< Expect this number of components, so you'll find better the first EPB */
105 #define JPWL_MAXIMUM_TILES 8192 /**< Expect this maximum number of tiles, to avoid some crashes */
106 #define JPWL_MAXIMUM_HAMMING 2 /**< Expect this maximum number of bit errors in marker id's */
107 #define JPWL_MAXIMUM_EPB_ROOM 65450 /**< Expect this maximum number of bytes for composition of EPBs */
111 ==========================================================
113 ==========================================================
118 typedef enum RSIZ_CAPABILITIES {
119 STD_RSIZ = 0, /** Standard JPEG2000 profile*/
120 CINEMA2K = 3, /** Profile name for a 2K image*/
121 CINEMA4K = 4 /** Profile name for a 4K image*/
122 } OPJ_RSIZ_CAPABILITIES;
125 Digital cinema operation mode
127 typedef enum CINEMA_MODE {
128 OFF = 0, /** Not Digital Cinema*/
129 CINEMA2K_24 = 1, /** 2K Digital Cinema at 24 fps*/
130 CINEMA2K_48 = 2, /** 2K Digital Cinema at 48 fps*/
131 CINEMA4K_24 = 3 /** 4K Digital Cinema at 24 fps*/
137 typedef enum PROG_ORDER {
138 PROG_UNKNOWN = -1, /**< place-holder */
139 LRCP = 0, /**< layer-resolution-component-precinct order */
140 RLCP = 1, /**< resolution-layer-component-precinct order */
141 RPCL = 2, /**< resolution-precinct-component-layer order */
142 PCRL = 3, /**< precinct-component-resolution-layer order */
143 CPRL = 4 /**< component-precinct-resolution-layer order */
147 Supported image color spaces
149 typedef enum COLOR_SPACE {
150 CLRSPC_UNKNOWN = -1, /**< place-holder */
151 CLRSPC_SRGB = 1, /**< sRGB */
152 CLRSPC_GRAY = 2, /**< grayscale */
153 CLRSPC_SYCC = 3 /**< YUV */
159 typedef enum CODEC_FORMAT {
160 CODEC_UNKNOWN = -1, /**< place-holder */
161 CODEC_J2K = 0, /**< JPEG-2000 codestream : read/write */
162 CODEC_JPT = 1, /**< JPT-stream (JPEG 2000, JPIP) : read only */
163 CODEC_JP2 = 2 /**< JPEG-2000 file format : read/write */
167 Limit decoding to certain portions of the codestream.
169 typedef enum LIMIT_DECODING {
170 NO_LIMITATION = 0, /**< No limitation for the decoding. The entire codestream will de decoded */
171 LIMIT_TO_MAIN_HEADER = 1, /**< The decoding is limited to the Main Header */
172 DECODE_ALL_BUT_PACKETS = 2 /**< Decode everything except the JPEG 2000 packets */
173 } OPJ_LIMIT_DECODING;
176 ==========================================================
177 event manager typedef definitions
178 ==========================================================
182 Callback function prototype for events
183 @param msg Event message
186 typedef void (*opj_msg_callback) (const char *msg, void *client_data);
189 Message handler object
194 <li>Debugging messages
197 typedef struct opj_event_mgr {
198 /** Error message callback if available, NULL otherwise */
199 opj_msg_callback error_handler;
200 /** Warning message callback if available, NULL otherwise */
201 opj_msg_callback warning_handler;
202 /** Debug message callback if available, NULL otherwise */
203 opj_msg_callback info_handler;
208 ==========================================================
209 codec typedef definitions
210 ==========================================================
214 Progression order changes
216 typedef struct opj_poc {
217 /** Resolution num start, Component num start, given by POC */
219 /** Layer num end,Resolution num end, Component num end, given by POC */
220 int layno1, resno1, compno1;
221 /** Layer num start,Precinct num start, Precinct num end */
222 int layno0, precno0, precno1;
223 /** Progression order enum*/
224 OPJ_PROG_ORDER prg1,prg;
225 /** Progression order string*/
229 /** Start and end values for Tile width and height*/
231 /** Start value, initialised in pi_initialise_encode*/
232 int layS, resS, compS, prcS;
233 /** End value, initialised in pi_initialise_encode */
234 int layE, resE, compE, prcE;
235 /** Start and end values of Tile width and height, initialised in pi_initialise_encode*/
236 int txS,txE,tyS,tyE,dx,dy;
237 /** Temporary values for Tile parts, initialised in pi_create_encode */
238 int lay_t, res_t, comp_t, prc_t,tx0_t,ty0_t;
242 Compression parameters
244 typedef struct opj_cparameters {
245 /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */
255 /** allocation by rate/distortion */
257 /** allocation by fixed layer */
259 /** add fixed_quality */
260 int cp_fixed_quality;
263 /** comment for coding */
265 /** csty : coding style */
267 /** progression order (default LRCP) */
268 OPJ_PROG_ORDER prog_order;
269 /** progression order changes */
271 /** number of progression order changes (POC), default to 0 */
273 /** number of layers */
275 /** rates of layers */
276 float tcp_rates[100];
277 /** different psnr for successive layers */
278 float tcp_distoratio[100];
279 /** number of resolutions */
281 /** initial code block width, default to 64 */
283 /** initial code block height, default to 64 */
285 /** mode switch (cblk_style) */
287 /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
289 /** region of interest: affected component in [0..3], -1 means no ROI */
291 /** region of interest: upshift value */
293 /* number of precinct size specifications */
295 /** initial precinct width */
296 int prcw_init[J2K_MAXRLVLS];
297 /** initial precinct height */
298 int prch_init[J2K_MAXRLVLS];
300 /**@name command line encoder parameters (not used inside the library) */
302 /** input file name */
303 char infile[OPJ_PATH_LEN];
304 /** output file name */
305 char outfile[OPJ_PATH_LEN];
306 /** creation of an index file, default to 0 (false) */
308 /** index file name */
309 char index[OPJ_PATH_LEN];
310 /** subimage encoding: origin image offset in x direction */
312 /** subimage encoding: origin image offset in y direction */
314 /** subsampling value for dx */
316 /** subsampling value for dy */
318 /** input file format 0: PGX, 1: PxM, 2: BMP 3:TIF*/
320 /** output file format 0: J2K, 1: JP2, 2: JPT */
325 /**@name JPWL encoding parameters */
327 /** enables writing of EPC in MH, thus activating JPWL */
329 /** error protection method for MH (0,1,16,32,37-128) */
331 /** tile number of header protection specification (>=0) */
332 int jpwl_hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
333 /** error protection methods for TPHs (0,1,16,32,37-128) */
334 int jpwl_hprot_TPH[JPWL_MAX_NO_TILESPECS];
335 /** tile number of packet protection specification (>=0) */
336 int jpwl_pprot_tileno[JPWL_MAX_NO_PACKSPECS];
337 /** packet number of packet protection specification (>=0) */
338 int jpwl_pprot_packno[JPWL_MAX_NO_PACKSPECS];
339 /** error protection methods for packets (0,1,16,32,37-128) */
340 int jpwl_pprot[JPWL_MAX_NO_PACKSPECS];
341 /** enables writing of ESD, (0=no/1/2 bytes) */
343 /** sensitivity addressing size (0=auto/2/4 bytes) */
345 /** sensitivity range (0-3) */
347 /** sensitivity method for MH (-1=no,0-7) */
349 /** tile number of sensitivity specification (>=0) */
350 int jpwl_sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
351 /** sensitivity methods for TPHs (-1=no,0-7) */
352 int jpwl_sens_TPH[JPWL_MAX_NO_TILESPECS];
356 /** Digital Cinema compliance 0-not compliant, 1-compliant*/
357 OPJ_CINEMA_MODE cp_cinema;
358 /** Maximum rate for each component. If == 0, component size limitation is not considered */
361 OPJ_RSIZ_CAPABILITIES cp_rsiz;
362 /** Tile part generation*/
364 /** Flag for Tile part generation*/
366 /** MCT (multiple component transform) */
371 Decompression parameters
373 typedef struct opj_dparameters {
375 Set the number of highest resolution levels to be discarded.
376 The image resolution is effectively divided by 2 to the power of the number of discarded levels.
377 The reduce factor is limited by the smallest total number of decomposition levels among tiles.
378 if != 0, then original dimension divided by 2^(reduce);
379 if == 0 or not used, image is decoded to the full resolution
383 Set the maximum number of quality layers to decode.
384 If there are less quality layers than the specified number, all the quality layers are decoded.
385 if != 0, then only the first "layer" layers are decoded;
386 if == 0 or not used, all the quality layers are decoded
390 /**@name command line encoder parameters (not used inside the library) */
392 /** input file name */
393 char infile[OPJ_PATH_LEN];
394 /** output file name */
395 char outfile[OPJ_PATH_LEN];
396 /** input file format 0: J2K, 1: JP2, 2: JPT */
398 /** output file format 0: PGX, 1: PxM, 2: BMP */
403 /**@name JPWL decoding parameters */
405 /** activates the JPWL correction capabilities */
407 /** expected number of components */
409 /** maximum number of tiles */
415 Specify whether the decoding should be done on the entire codestream, or be limited to the main header
416 Limiting the decoding to the main header makes it possible to extract the characteristics of the codestream
417 if == NO_LIMITATION, the entire codestream is decoded;
418 if == LIMIT_TO_MAIN_HEADER, only the main header is decoded;
420 OPJ_LIMIT_DECODING cp_limit_decoding;
424 /** Common fields between JPEG-2000 compression and decompression master structs. */
426 #define opj_common_fields \
427 opj_event_mgr_t *event_mgr; /**< pointer to the event manager */\
428 void * client_data; /**< Available for use by application */\
429 bool is_decompressor; /**< So common code can tell which is which */\
430 OPJ_CODEC_FORMAT codec_format; /**< selected codec */\
431 void *j2k_handle; /**< pointer to the J2K codec */\
432 void *jp2_handle; /**< pointer to the JP2 codec */\
433 void *mj2_handle /**< pointer to the MJ2 codec */
435 /* Routines that are to be used by both halves of the library are declared
436 * to receive a pointer to this structure. There are no actual instances of
437 * opj_common_struct_t, only of opj_cinfo_t and opj_dinfo_t.
439 typedef struct opj_common_struct {
440 opj_common_fields; /* Fields common to both master struct types */
441 /* Additional fields follow in an actual opj_cinfo_t or
442 * opj_dinfo_t. All three structs must agree on these
443 * initial fields! (This would be a lot cleaner in C++.)
445 } opj_common_struct_t;
447 typedef opj_common_struct_t * opj_common_ptr;
450 Compression context info
452 typedef struct opj_cinfo {
453 /** Fields shared with opj_dinfo_t */
455 /* other specific fields go here */
459 Decompression context info
461 typedef struct opj_dinfo {
462 /** Fields shared with opj_cinfo_t */
464 /* other specific fields go here */
468 ==========================================================
469 I/O stream typedef definitions
470 ==========================================================
476 /** The stream was opened for reading. */
477 #define OPJ_STREAM_READ 0x0001
478 /** The stream was opened for writing. */
479 #define OPJ_STREAM_WRITE 0x0002
482 Byte input-output stream (CIO)
484 typedef struct opj_cio {
486 opj_common_ptr cinfo;
488 /** open mode (read/write) either OPJ_STREAM_READ or OPJ_STREAM_WRITE */
490 /** pointer to the start of the buffer */
491 unsigned char *buffer;
492 /** buffer size in bytes */
495 /** pointer to the start of the stream */
496 unsigned char *start;
497 /** pointer to the end of the stream */
499 /** pointer to the current position */
504 ==========================================================
505 image typedef definitions
506 ==========================================================
510 Defines a single image component
512 typedef struct opj_image_comp {
513 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
515 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
521 /** x component offset compared to the whole image */
523 /** y component offset compared to the whole image */
527 /** image depth in bits */
529 /** signed (1) / unsigned (0) */
531 /** number of decoded resolution */
533 /** number of division by 2 of the out image compared to the original size of image */
535 /** image component data */
540 Defines image data and characteristics
542 typedef struct opj_image {
543 /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
545 /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
547 /** Xsiz: width of the reference grid */
549 /** Ysiz: height of the reference grid */
551 /** number of components in the image */
553 /** color space: sRGB, Greyscale or YUV */
554 OPJ_COLOR_SPACE color_space;
555 /** image components */
556 opj_image_comp_t *comps;
560 Component parameters structure used by the opj_image_create function
562 typedef struct opj_image_comptparm {
563 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
565 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
571 /** x component offset compared to the whole image */
573 /** y component offset compared to the whole image */
577 /** image depth in bits */
579 /** signed (1) / unsigned (0) */
581 } opj_image_cmptparm_t;
589 ==========================================================
591 ==========================================================
594 OPJ_API const char * OPJ_CALLCONV opj_version();
597 ==========================================================
598 image functions definitions
599 ==========================================================
604 @param numcmpts number of components
605 @param cmptparms components parameters
606 @param clrspc image color space
607 @return returns a new image structure if successful, returns NULL otherwise
609 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(int numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
612 Deallocate any resources associated with an image
613 @param image image to be destroyed
615 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
618 ==========================================================
619 stream functions definitions
620 ==========================================================
624 Open and allocate a memory stream for read / write.
625 On reading, the user must provide a buffer containing encoded data. The buffer will be
626 wrapped by the returned CIO handle.
627 On writing, buffer parameters must be set to 0: a buffer will be allocated by the library
628 to contain encoded data.
629 @param cinfo Codec context info
630 @param buffer Reading: buffer address. Writing: NULL
631 @param length Reading: buffer length. Writing: 0
632 @return Returns a CIO handle if successful, returns NULL otherwise
634 OPJ_API opj_cio_t* OPJ_CALLCONV opj_cio_open(opj_common_ptr cinfo, unsigned char *buffer, int length);
637 Close and free a CIO handle
638 @param cio CIO handle to free
640 OPJ_API void OPJ_CALLCONV opj_cio_close(opj_cio_t *cio);
643 Get position in byte stream
644 @param cio CIO handle
645 @return Returns the position in bytes
647 OPJ_API int OPJ_CALLCONV cio_tell(opj_cio_t *cio);
649 Set position in byte stream
650 @param cio CIO handle
651 @param pos Position, in number of bytes, from the beginning of the stream
653 OPJ_API void OPJ_CALLCONV cio_seek(opj_cio_t *cio, int pos);
656 ==========================================================
657 event manager functions definitions
658 ==========================================================
661 OPJ_API opj_event_mgr_t* OPJ_CALLCONV opj_set_event_mgr(opj_common_ptr cinfo, opj_event_mgr_t *event_mgr, void *context);
664 ==========================================================
665 codec functions definitions
666 ==========================================================
669 Creates a J2K/JPT/JP2 decompression structure
670 @param format Decoder to select
671 @return Returns a handle to a decompressor if successful, returns NULL otherwise
673 OPJ_API opj_dinfo_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format);
675 Destroy a decompressor handle
676 @param dinfo decompressor handle to destroy
678 OPJ_API void OPJ_CALLCONV opj_destroy_decompress(opj_dinfo_t *dinfo);
680 Set decoding parameters to default values
681 @param parameters Decompression parameters
683 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters);
685 Setup the decoder decoding parameters using user parameters.
686 Decoding parameters are returned in j2k->cp.
687 @param dinfo decompressor handle
688 @param parameters decompression parameters
690 OPJ_API void OPJ_CALLCONV opj_setup_decoder(opj_dinfo_t *dinfo, opj_dparameters_t *parameters);
692 Decode an image from a JPEG-2000 codestream
693 @param dinfo decompressor handle
694 @param cio Input buffer stream
695 @return Returns a decoded image if successful, returns NULL otherwise
697 OPJ_API opj_image_t* OPJ_CALLCONV opj_decode(opj_dinfo_t *dinfo, opj_cio_t *cio);
699 Creates a J2K/JP2 compression structure
700 @param format Coder to select
701 @return Returns a handle to a compressor if successful, returns NULL otherwise
703 OPJ_API opj_cinfo_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
705 Destroy a compressor handle
706 @param cinfo compressor handle to destroy
708 OPJ_API void OPJ_CALLCONV opj_destroy_compress(opj_cinfo_t *cinfo);
710 Set encoding parameters to default values, that means :
714 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
715 <li>Size of code-block : 64 x 64
716 <li>Number of resolutions: 6
717 <li>No SOP marker in the codestream
718 <li>No EPH marker in the codestream
719 <li>No sub-sampling in x or y direction
720 <li>No mode switch activated
721 <li>Progression order: LRCP
724 <li>No offset of the origin of the image
725 <li>No offset of the origin of the tiles
726 <li>Reversible DWT 5-3
728 @param parameters Compression parameters
730 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(opj_cparameters_t *parameters);
732 Setup the encoder parameters using the current image and using user parameters.
733 @param cinfo compressor handle
734 @param parameters compression parameters
735 @param image input filled image
737 OPJ_API void OPJ_CALLCONV opj_setup_encoder(opj_cinfo_t *cinfo, opj_cparameters_t *parameters, opj_image_t *image);
739 Encode an image into a JPEG-2000 codestream
740 @param cinfo compressor handle
741 @param cio Output buffer stream
742 @param image Image to encode
743 @param index Name of the index file if required, NULL otherwise
744 @return Returns true if successful, returns false otherwise
746 OPJ_API bool OPJ_CALLCONV opj_encode(opj_cinfo_t *cinfo, opj_cio_t *cio, opj_image_t *image, char *index);
752 #endif /* OPENJPEG_H */