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
9 * Copyright (c) 2010-2011, Kaori Hagihara
10 * Copyright (c) 2011, Mickael Savinaud, Communications & Systemes <mickael.savinaud@c-s.fr>
11 * All rights reserved.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
39 ==========================================================
41 ==========================================================
44 #if defined(OPJ_STATIC) || !defined(_WIN32)
48 #define OPJ_CALLCONV __stdcall
50 The following ifdef block is the standard way of creating macros which make exporting
51 from a DLL simpler. All files within this DLL are compiled with the OPJ_EXPORTS
52 symbol defined on the command line. this symbol should not be defined on any project
53 that uses this DLL. This way any other project whose source files include this file see
54 OPJ_API functions as being imported from a DLL, wheras this DLL sees symbols
55 defined with this macro as being exported.
57 #if defined(OPJ_EXPORTS) || defined(DLL_EXPORT)
58 #define OPJ_API __declspec(dllexport)
60 #define OPJ_API __declspec(dllimport)
61 #endif /* OPJ_EXPORTS */
62 #endif /* !OPJ_STATIC || !_WIN32 */
64 typedef int opj_bool; /*FIXME -> OPJ_BOOL*/
68 typedef unsigned int OPJ_UINT32;
69 typedef int OPJ_INT32;
70 typedef unsigned short OPJ_UINT16;
71 typedef short OPJ_INT16;
72 typedef char OPJ_CHAR;
73 typedef unsigned char OPJ_BYTE;
74 typedef unsigned int OPJ_SIZE_T;
75 typedef double OPJ_FLOAT64;
76 typedef float OPJ_FLOAT32;
78 // Avoid compile-time warning because parameter is not used
79 #define OPJ_ARG_NOT_USED(x) (void)(x)
82 ==========================================================
83 Useful constant definitions
84 ==========================================================
87 #define OPJ_PATH_LEN 4096 /**< Maximum allowed size for filenames */
89 #define J2K_MAXRLVLS 33 /**< Number of maximum resolution level authorized */
90 #define J2K_MAXBANDS (3*J2K_MAXRLVLS-2) /**< Number of maximum sub-band linked to number of resolution level */
92 #define J2K_DEFAULT_NB_SEGS 10
93 #define J2K_STREAM_CHUNK_SIZE 0x100000 /** 1 mega by default */
94 #define J2K_DEFAULT_HEADER_SIZE 1000
95 #define J2K_MCC_DEFAULT_NB_RECORDS 10
96 #define J2K_MCT_DEFAULT_NB_RECORDS 10
99 #define JPWL_MAX_NO_TILESPECS 16 /**< Maximum number of tile parts expected by JPWL: increase at your will */
100 #define JPWL_MAX_NO_PACKSPECS 16 /**< Maximum number of packet parts expected by JPWL: increase at your will */
101 #define JPWL_MAX_NO_MARKERS 512 /**< Maximum number of JPWL markers: increase at your will */
102 #define JPWL_PRIVATEINDEX_NAME "jpwl_index_privatefilename" /**< index file name used when JPWL is on */
103 #define JPWL_EXPECTED_COMPONENTS 3 /**< Expect this number of components, so you'll find better the first EPB */
104 #define JPWL_MAXIMUM_TILES 8192 /**< Expect this maximum number of tiles, to avoid some crashes */
105 #define JPWL_MAXIMUM_HAMMING 2 /**< Expect this maximum number of bit errors in marker id's */
106 #define JPWL_MAXIMUM_EPB_ROOM 65450 /**< Expect this maximum number of bytes for composition of EPBs */
110 Supported options about file information
112 #define OPJ_IMG_INFO 1 /**< Basic image information provided to the user */
113 #define OPJ_J2K_MH_INFO 2 /**< Codestream information based only on the main header */
114 #define OPJ_J2K_TH_INFO 4 /**< Tile information based on the current tile header */
115 /*FIXME #define OPJ_J2K_CSTR_INFO 6*/ /**< */
116 #define OPJ_J2K_MH_IND 16 /**< Codestream index based only on the main header */
117 #define OPJ_J2K_TH_IND 32 /**< Tile index based on the current tile */
118 /*FIXME #define OPJ_J2K_CSTR_IND 48*/ /**< */
119 #define OPJ_JP2_INFO 128 /**< JP2 file information */
120 #define OPJ_JP2_IND 256 /**< JP2 file index */
124 ==========================================================
126 ==========================================================
131 typedef enum RSIZ_CAPABILITIES {
132 STD_RSIZ = 0, /** Standard JPEG2000 profile*/
133 CINEMA2K = 3, /** Profile name for a 2K image*/
134 CINEMA4K = 4 /** Profile name for a 4K image*/
135 } OPJ_RSIZ_CAPABILITIES;
138 Digital cinema operation mode
140 typedef enum CINEMA_MODE {
141 OFF = 0, /** Not Digital Cinema*/
142 CINEMA2K_24 = 1, /** 2K Digital Cinema at 24 fps*/
143 CINEMA2K_48 = 2, /** 2K Digital Cinema at 48 fps*/
144 CINEMA4K_24 = 3 /** 4K Digital Cinema at 24 fps*/
150 typedef enum PROG_ORDER {
151 PROG_UNKNOWN = -1, /**< place-holder */
152 LRCP = 0, /**< layer-resolution-component-precinct order */
153 RLCP = 1, /**< resolution-layer-component-precinct order */
154 RPCL = 2, /**< resolution-precinct-component-layer order */
155 PCRL = 3, /**< precinct-component-resolution-layer order */
156 CPRL = 4 /**< component-precinct-resolution-layer order */
160 Supported image color spaces
162 typedef enum COLOR_SPACE {
163 CLRSPC_UNKNOWN = -1, /**< not supported by the library */
164 CLRSPC_UNSPECIFIED = 0, /**< not specified in the codestream */
165 CLRSPC_SRGB = 1, /**< sRGB */
166 CLRSPC_GRAY = 2, /**< grayscale */
167 CLRSPC_SYCC = 3 /**< YUV */
173 typedef enum CODEC_FORMAT {
174 CODEC_UNKNOWN = -1, /**< place-holder */
175 CODEC_J2K = 0, /**< JPEG-2000 codestream : read/write */
176 CODEC_JPT = 1, /**< JPT-stream (JPEG 2000, JPIP) : read only */
177 CODEC_JP2 = 2, /**< JPEG-2000 file format : read/write */
181 Limit decoding to certain portions of the codestream.
183 typedef enum LIMIT_DECODING {
184 NO_LIMITATION = 0, /**< No limitation for the decoding. The entire codestream will de decoded */
185 LIMIT_TO_MAIN_HEADER = 1, /**< The decoding is limited to the Main Header */
186 DECODE_ALL_BUT_PACKETS = 2 /**< Decode everything except the JPEG 2000 packets */
187 } OPJ_LIMIT_DECODING;
193 ==========================================================
194 event manager typedef definitions
195 ==========================================================
199 Callback function prototype for events
200 @param msg Event message
201 @param client_data FIXME DOC
203 typedef void (*opj_msg_callback) (const char *msg, void *client_data);
206 Message handler object
211 <li>Debugging messages
214 typedef struct opj_event_mgr {
217 /** Error message callback if available, NULL otherwise */
218 opj_msg_callback error_handler;
219 /** Warning message callback if available, NULL otherwise */
220 opj_msg_callback warning_handler;
221 /** Debug message callback if available, NULL otherwise */
222 opj_msg_callback info_handler;
227 ==========================================================
228 codec typedef definitions
229 ==========================================================
233 Progression order changes
235 typedef struct opj_poc {
236 /** Resolution num start, Component num start, given by POC */
237 OPJ_UINT32 resno0, compno0;
238 /** Layer num end,Resolution num end, Component num end, given by POC */
239 OPJ_UINT32 layno1, resno1, compno1;
240 /** Layer num start,Precinct num start, Precinct num end */
241 int layno0, precno0, precno1;
242 /** Progression order enum*/
243 OPJ_PROG_ORDER prg1,prg;
244 /** Progression order string*/
248 /** Start and end values for Tile width and height*/
250 /** Start value, initialised in pi_initialise_encode*/
251 int layS, resS, compS, prcS;
252 /** End value, initialised in pi_initialise_encode */
253 int layE, resE, compE, prcE;
254 /** Start and end values of Tile width and height, initialised in pi_initialise_encode*/
255 int txS,txE,tyS,tyE,dx,dy;
256 /** Temporary values for Tile parts, initialised in pi_create_encode */
257 int lay_t, res_t, comp_t, prc_t,tx0_t,ty0_t;
261 Compression parameters
263 typedef struct opj_cparameters {
264 /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */
265 opj_bool tile_size_on;
274 /** allocation by rate/distortion */
276 /** allocation by fixed layer */
278 /** add fixed_quality */
279 int cp_fixed_quality;
282 /** comment for coding */
284 /** csty : coding style */
286 /** progression order (default LRCP) */
287 OPJ_PROG_ORDER prog_order;
288 /** progression order changes */
290 /** number of progression order changes (POC), default to 0 */
292 /** number of layers */
294 /** rates of layers */
295 float tcp_rates[100];
296 /** different psnr for successive layers */
297 float tcp_distoratio[100];
298 /** number of resolutions */
300 /** initial code block width, default to 64 */
302 /** initial code block height, default to 64 */
304 /** mode switch (cblk_style) */
306 /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
308 /** region of interest: affected component in [0..3], -1 means no ROI */
310 /** region of interest: upshift value */
312 /* number of precinct size specifications */
314 /** initial precinct width */
315 int prcw_init[J2K_MAXRLVLS];
316 /** initial precinct height */
317 int prch_init[J2K_MAXRLVLS];
319 /**@name command line encoder parameters (not used inside the library) */
321 /** input file name */
322 char infile[OPJ_PATH_LEN];
323 /** output file name */
324 char outfile[OPJ_PATH_LEN];
325 /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
327 /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
328 char index[OPJ_PATH_LEN];
329 /** subimage encoding: origin image offset in x direction */
331 /** subimage encoding: origin image offset in y direction */
333 /** subsampling value for dx */
335 /** subsampling value for dy */
337 /** input file format 0: PGX, 1: PxM, 2: BMP 3:TIF*/
339 /** output file format 0: J2K, 1: JP2, 2: JPT */
344 /**@name JPWL encoding parameters */
346 /** enables writing of EPC in MH, thus activating JPWL */
347 opj_bool jpwl_epc_on;
348 /** error protection method for MH (0,1,16,32,37-128) */
350 /** tile number of header protection specification (>=0) */
351 int jpwl_hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
352 /** error protection methods for TPHs (0,1,16,32,37-128) */
353 int jpwl_hprot_TPH[JPWL_MAX_NO_TILESPECS];
354 /** tile number of packet protection specification (>=0) */
355 int jpwl_pprot_tileno[JPWL_MAX_NO_PACKSPECS];
356 /** packet number of packet protection specification (>=0) */
357 int jpwl_pprot_packno[JPWL_MAX_NO_PACKSPECS];
358 /** error protection methods for packets (0,1,16,32,37-128) */
359 int jpwl_pprot[JPWL_MAX_NO_PACKSPECS];
360 /** enables writing of ESD, (0=no/1/2 bytes) */
362 /** sensitivity addressing size (0=auto/2/4 bytes) */
364 /** sensitivity range (0-3) */
366 /** sensitivity method for MH (-1=no,0-7) */
368 /** tile number of sensitivity specification (>=0) */
369 int jpwl_sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
370 /** sensitivity methods for TPHs (-1=no,0-7) */
371 int jpwl_sens_TPH[JPWL_MAX_NO_TILESPECS];
375 /** Digital Cinema compliance 0-not compliant, 1-compliant*/
376 OPJ_CINEMA_MODE cp_cinema;
377 /** Maximum rate for each component. If == 0, component size limitation is not considered */
380 OPJ_RSIZ_CAPABILITIES cp_rsiz;
381 /** Tile part generation*/
383 /** Flag for Tile part generation*/
385 /** MCT (multiple component transform) */
387 /** Enable JPIP indexing*/
392 Decompression parameters
394 typedef struct opj_dparameters {
396 Set the number of highest resolution levels to be discarded.
397 The image resolution is effectively divided by 2 to the power of the number of discarded levels.
398 The reduce factor is limited by the smallest total number of decomposition levels among tiles.
399 if != 0, then original dimension divided by 2^(reduce);
400 if == 0 or not used, image is decoded to the full resolution
404 Set the maximum number of quality layers to decode.
405 If there are less quality layers than the specified number, all the quality layers are decoded.
406 if != 0, then only the first "layer" layers are decoded;
407 if == 0 or not used, all the quality layers are decoded
411 /**@name command line decoder parameters (not used inside the library) */
413 /** input file name */
414 char infile[OPJ_PATH_LEN];
415 /** output file name */
416 char outfile[OPJ_PATH_LEN];
417 /** input file format 0: J2K, 1: JP2, 2: JPT */
419 /** output file format 0: PGX, 1: PxM, 2: BMP */
422 /** Decoding area left boundary */
424 /** Decoding area right boundary */
426 /** Decoding area up boundary */
428 /** Decoding area bottom boundary */
436 /**@name JPWL decoding parameters */
438 /** activates the JPWL correction capabilities */
439 opj_bool jpwl_correct;
440 /** expected number of components */
442 /** maximum number of tiles */
448 Specify whether the decoding should be done on the entire codestream, or be limited to the main header
449 Limiting the decoding to the main header makes it possible to extract the characteristics of the codestream
450 if == NO_LIMITATION, the entire codestream is decoded;
451 if == LIMIT_TO_MAIN_HEADER, only the main header is decoded;
453 OPJ_LIMIT_DECODING cp_limit_decoding;
457 /** Common fields between JPEG-2000 compression and decompression master structs. */
459 #define opj_common_fields \
460 opj_event_mgr_t *event_mgr; /**< pointer to the event manager */\
461 void * client_data; /**< Available for use by application */\
462 opj_bool is_decompressor; /**< So common code can tell which is which */\
463 OPJ_CODEC_FORMAT codec_format; /**< selected codec */\
464 void *j2k_handle; /**< pointer to the J2K codec */\
465 void *jp2_handle; /**< pointer to the JP2 codec */\
466 void *mj2_handle /**< pointer to the MJ2 codec */
468 /* Routines that are to be used by both halves of the library are declared
469 * to receive a pointer to this structure. There are no actual instances of
470 * opj_common_struct_t, only of opj_cinfo_t and opj_dinfo_t.
472 typedef struct opj_common_struct {
473 opj_common_fields; /* Fields common to both master struct types */
474 /* Additional fields follow in an actual opj_cinfo_t or
475 * opj_dinfo_t. All three structs must agree on these
476 * initial fields! (This would be a lot cleaner in C++.)
478 } opj_common_struct_t;
480 typedef opj_common_struct_t * opj_common_ptr;
483 Compression context info
485 typedef struct opj_cinfo {
486 /** Fields shared with opj_dinfo_t */
488 /* other specific fields go here */
492 Decompression context info
494 typedef struct opj_dinfo {
495 /** Fields shared with opj_cinfo_t */
497 /* other specific fields go here */
503 typedef void * opj_codec_t;
506 ==========================================================
507 I/O stream typedef definitions
508 ==========================================================
514 /** The stream was opened for reading. */
515 #define OPJ_STREAM_READ 0x0001
516 /** The stream was opened for writing. */
517 #define OPJ_STREAM_WRITE 0x0002
520 Byte input-output stream (CIO)
522 typedef struct opj_cio {
524 opj_common_ptr cinfo;
526 /** open mode (read/write) either OPJ_STREAM_READ or OPJ_STREAM_WRITE */
528 /** pointer to the start of the buffer */
529 unsigned char *buffer;
530 /** buffer size in bytes */
533 /** pointer to the start of the stream */
534 unsigned char *start;
535 /** pointer to the end of the stream */
537 /** pointer to the current position */
545 typedef OPJ_UINT32 (* opj_stream_read_fn) (void * p_buffer, OPJ_UINT32 p_nb_bytes, void * p_user_data) ;
546 typedef OPJ_UINT32 (* opj_stream_write_fn) (void * p_buffer, OPJ_UINT32 p_nb_bytes, void * p_user_data) ;
547 typedef OPJ_SIZE_T (* opj_stream_skip_fn) (OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
548 typedef opj_bool (* opj_stream_seek_fn) (OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
553 typedef void * opj_stream_t;
556 ==========================================================
557 image typedef definitions
558 ==========================================================
562 Defines a single image component
564 typedef struct opj_image_comp {
565 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
567 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
573 /** x component offset compared to the whole image */
575 /** y component offset compared to the whole image */
579 /** image depth in bits */
581 /** signed (1) / unsigned (0) */
583 /** number of decoded resolution */
584 OPJ_UINT32 resno_decoded;
585 /** number of division by 2 of the out image compared to the original size of image */
587 /** image component data */
592 Defines image data and characteristics
594 typedef struct opj_image {
595 /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
597 /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
599 /** Xsiz: width of the reference grid */
601 /** Ysiz: height of the reference grid */
603 /** number of components in the image */
605 /** color space: sRGB, Greyscale or YUV */
606 OPJ_COLOR_SPACE color_space;
607 /** image components */
608 opj_image_comp_t *comps;
609 /** 'restricted' ICC profile */
610 OPJ_BYTE *icc_profile_buf;
611 /** size of ICC profile */
612 OPJ_INT32 icc_profile_len;
617 Component parameters structure used by the opj_image_create function
619 typedef struct opj_image_comptparm {
620 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
622 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
628 /** x component offset compared to the whole image */
630 /** y component offset compared to the whole image */
634 /** image depth in bits */
636 /** signed (1) / unsigned (0) */
638 } opj_image_cmptparm_t;
645 ==========================================================
646 Information on the JPEG 2000 codestream
647 ==========================================================
651 Index structure : Information concerning a packet inside tile
653 typedef struct opj_packet_info {
654 /** packet start position (including SOP marker if it exists) */
656 /** end of packet header position (including EPH marker if it exists)*/
658 /** packet end position */
660 /** packet distorsion */
669 typedef struct opj_marker_info_t {
671 unsigned short int type;
672 /** position in codestream */
674 /** length, marker val included */
680 Index structure : Information concerning tile-parts
682 typedef struct opj_tp_info {
683 /** start position of tile part */
685 /** end position of tile part header */
687 /** end position of tile part */
689 /** start packet of tile part */
691 /** number of packets of tile part */
696 Index structure : information regarding tiles
698 typedef struct opj_tile_info {
699 /** value of thresh for each layer by tile cfr. Marcela */
701 /** number of tile */
703 /** start position */
705 /** end position of the header */
709 /** precinct number for each resolution level (width) */
711 /** precinct number for each resolution level (height) */
713 /** precinct size (in power of 2), in X for each resolution level */
715 /** precinct size (in power of 2), in Y for each resolution level */
717 /** information concerning packets inside tile */
718 opj_packet_info_t *packet;
719 /** add fixed_quality */
721 /** add fixed_quality */
723 /** number of markers */
725 /** list of markers */
726 opj_marker_info_t *marker;
727 /** actual size of markers array */
729 /** number of tile parts */
731 /** information concerning tile parts */
736 Index structure of the codestream
738 typedef struct opj_codestream_info {
739 /** maximum distortion reduction on the whole image (add for Marcela) */
743 /** writing the packet in the index with t2_encode_packets */
749 /** progression order */
751 /** tile size in x */
753 /** tile size in y */
759 /** number of tiles in X */
761 /** number of tiles in Y */
763 /** component numbers */
765 /** number of layer */
767 /** number of decomposition for each component */
770 /** number of markers */
772 /** list of markers */
773 opj_marker_info_t *marker;
774 /** actual size of markers array */
777 /** main header position */
779 /** main header position */
781 /** codestream's size */
783 /** information regarding tiles inside image */
784 opj_tile_info_t *tile;
785 } opj_codestream_info_t;
787 /* <----------------------------------------------------------- */
788 /* new output managment of the codestream information and index */
791 * Tile-component coding parameters information
793 typedef struct opj_tccp_info
795 /** component index */
799 /** number of resolutions */
800 OPJ_UINT32 numresolutions;
801 /** code-blocks width */
803 /** code-blocks height */
805 /** code-block coding style */
807 /** discrete wavelet transform identifier */
809 /** quantisation style */
811 /** stepsizes used for quantization */
812 OPJ_UINT32 stepsizes_mant[J2K_MAXBANDS];
813 /** stepsizes used for quantization */
814 OPJ_UINT32 stepsizes_expn[J2K_MAXBANDS];
815 /** number of guard bits */
817 /** Region Of Interest shift */
819 /** precinct width */
820 OPJ_UINT32 prcw[J2K_MAXRLVLS];
821 /** precinct height */
822 OPJ_UINT32 prch[J2K_MAXRLVLS];
827 * Tile coding parameters information
829 typedef struct opj_tile_v2_info {
831 /** number (index) of tile */
835 /** progression order */
837 /** number of layers */
838 OPJ_UINT32 numlayers;
839 /** multi-component transform identifier */
842 /** information concerning tile component parameters*/
843 opj_tccp_info_t *tccp_info;
845 } opj_tile_info_v2_t;
848 * Information structure about the codestream (FIXME should be expand and enhance)
850 typedef struct opj_codestream_info_v2 {
852 /** tile origin in x = XTOsiz */
854 /** tile origin in y = YTOsiz */
856 /** tile size in x = XTsiz */
858 /** tile size in y = YTsiz */
860 /** number of tiles in X */
862 /** number of tiles in Y */
865 /** number of components*/
868 /** Default information regarding tiles inside image */
869 opj_tile_info_v2_t m_default_tile_info;
871 /** information regarding tiles inside image */
872 opj_tile_info_v2_t *tile_info; /* FIXME not used for the moment */
874 } opj_codestream_info_v2_t;
877 * Index structure about a tile
879 typedef struct opj_tile_index {
880 /** number (index) of tile */
882 /** start position */
884 /** end position of the header */
889 /** number of tile parts */
891 /** information concerning tile parts */
892 opj_tp_info_t *tp_index;
894 /** information concerning packets inside tile */
895 opj_packet_info_t *packet_index;
900 * Index structure of the codestream (FIXME should be expand and enhance)
902 typedef struct opj_codestream_index_ {
903 /** main header start position (SOC position) */
905 /** main header end position (first SOT position) */
908 /** codestream's size */
912 /** number of markers */
914 /** list of markers */
915 opj_marker_info_t *marker;
916 /** actual size of markers array */
926 opj_tile_index_t *tile_index; /* FIXME not used for the moment */
928 }opj_codestream_index_t;
929 /* -----------------------------------------------------------> */
932 ==========================================================
933 Metadata from the JP2file
934 ==========================================================
938 * Info structure of the JP2 file
941 typedef struct opj_jp2_metadata {
945 } opj_jp2_metadata_t;
948 * Index structure of the JP2 file
951 typedef struct opj_jp2_index {
964 ==========================================================
966 ==========================================================
969 OPJ_API const char * OPJ_CALLCONV opj_version(void);
972 ==========================================================
973 image functions definitions
974 ==========================================================
979 @param numcmpts number of components
980 @param cmptparms components parameters
981 @param clrspc image color space
982 @return returns a new image structure if successful, returns NULL otherwise
984 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(int numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
987 * Deallocate any resources associated with an image
988 * @param image image to be destroyed
990 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
994 ==========================================================
995 stream functions definitions
996 ==========================================================
1000 Open and allocate a memory stream for read / write.
1001 On reading, the user must provide a buffer containing encoded data. The buffer will be
1002 wrapped by the returned CIO handle.
1003 On writing, buffer parameters must be set to 0: a buffer will be allocated by the library
1004 to contain encoded data.
1005 @param cinfo Codec context info
1006 @param buffer Reading: buffer address. Writing: NULL
1007 @param length Reading: buffer length. Writing: 0
1008 @return Returns a CIO handle if successful, returns NULL otherwise
1010 OPJ_API opj_cio_t* OPJ_CALLCONV opj_cio_open(opj_common_ptr cinfo, unsigned char *buffer, int length);
1013 Close and free a CIO handle
1014 @param cio CIO handle to free
1016 OPJ_API void OPJ_CALLCONV opj_cio_close(opj_cio_t *cio);
1019 Get position in byte stream
1020 @param cio CIO handle
1021 @return Returns the position in bytes
1023 OPJ_API int OPJ_CALLCONV cio_tell(opj_cio_t *cio);
1025 Set position in byte stream
1026 @param cio CIO handle
1027 @param pos Position, in number of bytes, from the beginning of the stream
1029 OPJ_API void OPJ_CALLCONV cio_seek(opj_cio_t *cio, int pos);
1035 * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1037 * @param l_is_reader if set to true then the stream will be an input stream, an output stream else.
1039 * @return a stream object.
1041 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_default_create(opj_bool p_is_input);
1042 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create(OPJ_UINT32 p_size, opj_bool p_is_input);
1045 * Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must
1046 * close its own implementation of the stream.
1048 * @param p_stream the stream to destroy.
1050 OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream);
1053 * Sets the given function to be used as a read function.
1054 * @param p_stream the stream to modify
1055 * @param p_function the function to use a read function.
1057 OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream, opj_stream_read_fn p_function);
1060 * Sets the given function to be used as a write function.
1061 * @param p_stream the stream to modify
1062 * @param p_function the function to use a write function.
1064 OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream, opj_stream_write_fn p_function);
1067 * Sets the given function to be used as a skip function.
1068 * @param p_stream the stream to modify
1069 * @param p_function the function to use a skip function.
1071 OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream, opj_stream_skip_fn p_function);
1074 * Sets the given function to be used as a seek function, the stream is then seekable.
1075 * @param p_stream the stream to modify
1076 * @param p_function the function to use a skip function.
1078 OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream, opj_stream_seek_fn p_function);
1082 * Sets the given data to be used as a user data for the stream.
1083 * @param p_stream the stream to modify
1084 * @param p_data the data to set.
1086 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data (opj_stream_t* p_stream, void * p_data);
1091 * Sets the stream to be a file stream. The FILE must have been open previously.
1092 * @param p_stream the stream to modify
1093 * @param p_file handler to an already open file.
1095 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream (FILE * p_file, opj_bool p_is_read_stream);
1096 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream (FILE * p_file, OPJ_UINT32 p_buffer_size, opj_bool p_is_read_stream);
1101 ==========================================================
1102 event manager functions definitions
1103 ==========================================================
1110 OPJ_API opj_event_mgr_t* OPJ_CALLCONV opj_set_event_mgr(opj_common_ptr cinfo, opj_event_mgr_t *event_mgr, void *context);
1113 * Initialize a default event handler. This function set the output of message event to be stderr for warning and error output
1114 * and stdout for info output in the verbose mode. In the case of the non-verbose mode only the error message are displayed.
1115 * You can initialize your own event handler struct when you fill the field of the event structure. If you provide a null
1116 * structure to the opj_setup_decoder function, no output will be displayed.
1118 * @param p_manager a opj_event_mgr structure which will be pass to the codec.
1121 OPJ_API void OPJ_CALLCONV opj_initialize_default_event_handler(opj_event_mgr_t * p_manager, opj_bool verbose);
1125 ==========================================================
1126 codec functions definitions
1127 ==========================================================
1131 * Creates a J2K/JP2 decompression structure
1132 * @param format Decoder to select
1134 * @return Returns a handle to a decompressor if successful, returns NULL otherwise
1136 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress_v2(OPJ_CODEC_FORMAT format);
1140 Creates a J2K/JPT/JP2 decompression structure
1141 @param format Decoder to select
1142 @return Returns a handle to a decompressor if successful, returns NULL otherwise
1144 OPJ_API opj_dinfo_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format);
1146 Destroy a decompressor handle
1147 @param dinfo decompressor handle to destroy
1149 OPJ_API void OPJ_CALLCONV opj_destroy_decompress(opj_dinfo_t *dinfo);
1151 Set decoding parameters to default values
1152 @param parameters Decompression parameters
1154 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters);
1156 Setup the decoder decoding parameters using user parameters.
1157 Decoding parameters are returned in j2k->cp.
1158 @param dinfo decompressor handle
1159 @param parameters decompression parameters
1161 OPJ_API void OPJ_CALLCONV opj_setup_decoder(opj_dinfo_t *dinfo, opj_dparameters_t *parameters);
1165 * Setup the decoder with decompression parameters provided by the user and with the message handler
1166 * provided by the user.
1168 * @param dinfo decompressor handlers
1169 * @param parameters decompression parameters
1170 * @param event_mgr message handler
1172 * @return true if the decoder is correctly set
1174 OPJ_API opj_bool OPJ_CALLCONV opj_setup_decoder_v2( opj_codec_t *p_info,
1175 opj_dparameters_t *parameters,
1176 opj_event_mgr_t* event_mgr);
1179 Decode an image from a JPEG-2000 codestream
1180 @param dinfo decompressor handle
1181 @param cio Input buffer stream
1182 @return Returns a decoded image if successful, returns NULL otherwise
1184 OPJ_API opj_image_t* OPJ_CALLCONV opj_decode(opj_dinfo_t *dinfo, opj_cio_t *cio);
1187 Decode an image from a JPEG-2000 codestream and extract the codestream information
1188 @param dinfo decompressor handle
1189 @param cio Input buffer stream
1190 @param cstr_info Codestream information structure if needed afterwards, NULL otherwise
1191 @return Returns a decoded image if successful, returns NULL otherwise
1193 OPJ_API opj_image_t* OPJ_CALLCONV opj_decode_with_info(opj_dinfo_t *dinfo, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
1195 Creates a J2K/JP2 compression structure
1196 @param format Coder to select
1197 @return Returns a handle to a compressor if successful, returns NULL otherwise
1199 OPJ_API opj_cinfo_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
1201 Destroy a compressor handle
1202 @param cinfo compressor handle to destroy
1204 OPJ_API void OPJ_CALLCONV opj_destroy_compress(opj_cinfo_t *cinfo);
1206 Set encoding parameters to default values, that means :
1210 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
1211 <li>Size of code-block : 64 x 64
1212 <li>Number of resolutions: 6
1213 <li>No SOP marker in the codestream
1214 <li>No EPH marker in the codestream
1215 <li>No sub-sampling in x or y direction
1216 <li>No mode switch activated
1217 <li>Progression order: LRCP
1219 <li>No ROI upshifted
1220 <li>No offset of the origin of the image
1221 <li>No offset of the origin of the tiles
1222 <li>Reversible DWT 5-3
1224 @param parameters Compression parameters
1226 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(opj_cparameters_t *parameters);
1228 Setup the encoder parameters using the current image and using user parameters.
1229 @param cinfo Compressor handle
1230 @param parameters Compression parameters
1231 @param image Input filled image
1233 OPJ_API void OPJ_CALLCONV opj_setup_encoder(opj_cinfo_t *cinfo, opj_cparameters_t *parameters, opj_image_t *image);
1235 Encode an image into a JPEG-2000 codestream
1236 3@param cinfo compressor handle
1237 @param cio Output buffer stream
1238 @param image Image to encode
1239 @param index Depreacted -> Set to NULL. To extract index, used opj_encode_wci()
1240 @return Returns true if successful, returns false otherwise
1242 OPJ_API opj_bool OPJ_CALLCONV opj_encode(opj_cinfo_t *cinfo, opj_cio_t *cio, opj_image_t *image, char *index);
1244 Encode an image into a JPEG-2000 codestream and extract the codestream information
1245 @param cinfo compressor handle
1246 @param cio Output buffer stream
1247 @param image Image to encode
1248 @param cstr_info Codestream information structure if needed afterwards, NULL otherwise
1249 @return Returns true if successful, returns false otherwise
1251 OPJ_API opj_bool OPJ_CALLCONV opj_encode_with_info(opj_cinfo_t *cinfo, opj_cio_t *cio, opj_image_t *image, opj_codestream_info_t *cstr_info);
1253 Destroy Codestream information after compression or decompression
1254 @param cstr_info Codestream information structure
1256 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_t *cstr_info);
1260 * Decodes an image header.
1262 * @param p_cio the jpeg2000 stream.
1263 * @param p_codec the jpeg2000 codec to read.
1264 * @param p_image the image structure initialized with the characteristics of encoded image.
1266 * @return true if the main header of the codestream and the JP2 header is correctly read.
1268 OPJ_API opj_bool OPJ_CALLCONV opj_read_header ( opj_stream_t *p_cio,
1269 opj_codec_t *p_codec,
1270 opj_image_t *p_image);
1273 * Destroy a decompressor handle
1275 * @param dinfo decompressor handle to destroy
1277 OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec);
1280 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
1282 * @param p_codec the jpeg2000 codec.
1283 * @param p_start_x the left position of the rectangle to decode (in image coordinates).
1284 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
1285 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
1286 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
1288 * @return true if the area could be set.
1290 OPJ_API opj_bool OPJ_CALLCONV opj_set_decode_area( opj_codec_t *p_codec,
1291 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
1292 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y );
1295 * Reads a tile header. This function is compulsory and allows one to know the size of the tile thta will be decoded.
1296 * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1298 * @param p_codec the jpeg2000 codec.
1299 * @param p_tile_index pointer to a value that will hold the index of the tile being decoded, in case of success.
1300 * @param p_data_size pointer to a value that will hold the maximum size of the decoded data, in case of success. In case
1301 * of truncated codestreams, the actual number of bytes decoded may be lower. The computation of the size is the same
1302 * as depicted in opj_write_tile.
1303 * @param p_tile_x0 pointer to a value that will hold the x0 pos of the tile (in the image).
1304 * @param p_tile_y0 pointer to a value that will hold the y0 pos of the tile (in the image).
1305 * @param p_tile_x1 pointer to a value that will hold the x1 pos of the tile (in the image).
1306 * @param p_tile_y1 pointer to a value that will hold the y1 pos of the tile (in the image).
1307 * @param p_nb_comps pointer to a value that will hold the number of components in the tile.
1308 * @param p_should_go_on pointer to a boolean that will hold the fact that the decoding should go on. In case the
1309 * codestream is over at the time of the call, the value will be set to false. The user should then stop
1311 * @param p_stream the stream to decode.
1312 * @return true if the tile header could be decoded. In case the decoding should end, the returned value is still true.
1313 * returning false may be the result of a shortage of memory or an internal error.
1315 OPJ_API opj_bool OPJ_CALLCONV opj_read_tile_header( opj_codec_t *p_codec,
1316 opj_stream_t * p_stream,
1317 OPJ_UINT32 * p_tile_index,
1318 OPJ_UINT32 * p_data_size,
1319 OPJ_INT32 * p_tile_x0, OPJ_INT32 * p_tile_y0,
1320 OPJ_INT32 * p_tile_x1, OPJ_INT32 * p_tile_y1,
1321 OPJ_UINT32 * p_nb_comps,
1322 opj_bool * p_should_go_on );
1326 * Reads a tile data. This function is compulsory and allows one to decode tile data. opj_read_tile_header should be called before.
1327 * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1329 * @param p_codec the jpeg2000 codec.
1330 * @param p_tile_index the index of the tile being decoded, this should be the value set by opj_read_tile_header.
1331 * @param p_data pointer to a memory block that will hold the decoded data.
1332 * @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.
1333 * @param p_stream the stream to decode.
1335 * @return true if the data could be decoded.
1337 OPJ_API opj_bool OPJ_CALLCONV opj_decode_tile_data( opj_codec_t *p_codec,
1338 OPJ_UINT32 p_tile_index,
1340 OPJ_UINT32 p_data_size,
1341 opj_stream_t *p_stream );
1345 ==========================================================
1346 codec output functions definitions
1347 ==========================================================
1351 * Dump the codec information into the output stream
1353 * @param p_codec the jpeg2000 codec.
1354 * @param info_flag type of information dump.
1355 * @param output_stream output stream where dump the informations get from the codec.
1358 OPJ_API void OPJ_CALLCONV opj_dump_codec( opj_codec_t *p_codec,
1359 OPJ_INT32 info_flag,
1360 FILE* output_stream);
1363 * Get the codestream information from the codec
1365 * @param p_codec the jpeg2000 codec.
1367 * @return a pointer to a codestream information structure.
1370 OPJ_API opj_codestream_info_v2_t* OPJ_CALLCONV opj_get_cstr_info(opj_codec_t *p_codec);
1373 * Get the codestream index from the codec
1375 * @param p_codec the jpeg2000 codec.
1377 * @return a pointer to a codestream index structure.
1380 OPJ_API opj_codestream_index_t * OPJ_CALLCONV opj_get_cstr_index(opj_codec_t *p_codec);
1383 * Get the JP2 file information from the codec FIXME
1385 * @param p_codec the jpeg2000 codec.
1387 * @return a pointer to a JP2 metadata structure.
1390 OPJ_API opj_jp2_metadata_t* OPJ_CALLCONV opj_get_jp2_metadata(opj_codec_t *p_codec);
1393 * Get the JP2 file index from the codec FIXME
1395 * @param p_codec the jpeg2000 codec.
1397 * @return a pointer to a JP2 index structure.
1400 OPJ_API opj_jp2_index_t* OPJ_CALLCONV opj_get_jp2_index(opj_codec_t *p_codec);
1403 Decode an image from a JPEG-2000 codestream
1404 @param dinfo decompressor handle
1405 @param cio Input buffer stream
1406 @return Returns a decoded image if successful, returns NULL otherwise
1408 OPJ_API opj_bool OPJ_CALLCONV opj_decode_v2(opj_codec_t *p_decompressor,
1410 opj_image_t *p_image);
1412 OPJ_API opj_bool OPJ_CALLCONV opj_end_decompress ( opj_codec_t *p_codec,
1413 opj_stream_t *p_cio);
1420 #endif /* OPENJPEG_H */