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) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
10 * Copyright (c) 2010-2011, Kaori Hagihara
11 * Copyright (c) 2011, Mickael Savinaud, Communications & Systemes <mickael.savinaud@c-s.fr>
12 * All rights reserved.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
40 ==========================================================
42 ==========================================================
45 /* deprecated attribute */
47 #define DEPRECATED(func) func __attribute__ ((deprecated))
48 #elif defined(_MSC_VER)
49 #define DEPRECATED(func) __declspec(deprecated) func
51 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
52 #define DEPRECATED(func) func
55 #if defined(OPJ_STATIC) || !defined(_WIN32)
59 #define OPJ_CALLCONV __stdcall
61 The following ifdef block is the standard way of creating macros which make exporting
62 from a DLL simpler. All files within this DLL are compiled with the OPJ_EXPORTS
63 symbol defined on the command line. this symbol should not be defined on any project
64 that uses this DLL. This way any other project whose source files include this file see
65 OPJ_API functions as being imported from a DLL, wheras this DLL sees symbols
66 defined with this macro as being exported.
68 #if defined(OPJ_EXPORTS) || defined(DLL_EXPORT)
69 #define OPJ_API __declspec(dllexport)
71 #define OPJ_API __declspec(dllimport)
72 #endif /* OPJ_EXPORTS */
73 #endif /* !OPJ_STATIC || !_WIN32 */
75 typedef int opj_bool; /*FIXME it should be to follow the name of others OPJ_TYPE -> OPJ_BOOL*/
79 typedef unsigned int OPJ_UINT32;
80 typedef int OPJ_INT32;
81 typedef unsigned short OPJ_UINT16;
82 typedef short OPJ_INT16;
83 typedef char OPJ_CHAR;
84 typedef unsigned char OPJ_BYTE;
85 typedef unsigned int OPJ_SIZE_T;
86 typedef double OPJ_FLOAT64;
87 typedef float OPJ_FLOAT32;
89 // Avoid compile-time warning because parameter is not used
90 #define OPJ_ARG_NOT_USED(x) (void)(x)
93 ==========================================================
94 Useful constant definitions
95 ==========================================================
98 #define OPJ_PATH_LEN 4096 /**< Maximum allowed size for filenames */
100 #define J2K_MAXRLVLS 33 /**< Number of maximum resolution level authorized */
101 #define J2K_MAXBANDS (3*J2K_MAXRLVLS-2) /**< Number of maximum sub-band linked to number of resolution level */
103 #define J2K_DEFAULT_NB_SEGS 10
104 #define J2K_STREAM_CHUNK_SIZE 0x100000 /** 1 mega by default */
105 #define J2K_DEFAULT_HEADER_SIZE 1000
106 #define J2K_MCC_DEFAULT_NB_RECORDS 10
107 #define J2K_MCT_DEFAULT_NB_RECORDS 10
110 #define JPWL_MAX_NO_TILESPECS 16 /**< Maximum number of tile parts expected by JPWL: increase at your will */
111 #define JPWL_MAX_NO_PACKSPECS 16 /**< Maximum number of packet parts expected by JPWL: increase at your will */
112 #define JPWL_MAX_NO_MARKERS 512 /**< Maximum number of JPWL markers: increase at your will */
113 #define JPWL_PRIVATEINDEX_NAME "jpwl_index_privatefilename" /**< index file name used when JPWL is on */
114 #define JPWL_EXPECTED_COMPONENTS 3 /**< Expect this number of components, so you'll find better the first EPB */
115 #define JPWL_MAXIMUM_TILES 8192 /**< Expect this maximum number of tiles, to avoid some crashes */
116 #define JPWL_MAXIMUM_HAMMING 2 /**< Expect this maximum number of bit errors in marker id's */
117 #define JPWL_MAXIMUM_EPB_ROOM 65450 /**< Expect this maximum number of bytes for composition of EPBs */
121 * FIXME EXPERIMENTAL FOR THE MOMENT
122 * Supported options about file information
124 #define OPJ_IMG_INFO 1 /**< Basic image information provided to the user */
125 #define OPJ_J2K_MH_INFO 2 /**< Codestream information based only on the main header */
126 #define OPJ_J2K_TH_INFO 4 /**< Tile information based on the current tile header */
127 /*FIXME #define OPJ_J2K_CSTR_INFO 6*/ /**< */
128 #define OPJ_J2K_MH_IND 16 /**< Codestream index based only on the main header */
129 #define OPJ_J2K_TH_IND 32 /**< Tile index based on the current tile */
130 /*FIXME #define OPJ_J2K_CSTR_IND 48*/ /**< */
131 #define OPJ_JP2_INFO 128 /**< JP2 file information */
132 #define OPJ_JP2_IND 256 /**< JP2 file index */
136 ==========================================================
138 ==========================================================
143 typedef enum RSIZ_CAPABILITIES {
144 STD_RSIZ = 0, /** Standard JPEG2000 profile*/
145 CINEMA2K = 3, /** Profile name for a 2K image*/
146 CINEMA4K = 4 /** Profile name for a 4K image*/
147 } OPJ_RSIZ_CAPABILITIES;
150 * Digital cinema operation mode
152 typedef enum CINEMA_MODE {
153 OFF = 0, /** Not Digital Cinema*/
154 CINEMA2K_24 = 1, /** 2K Digital Cinema at 24 fps*/
155 CINEMA2K_48 = 2, /** 2K Digital Cinema at 48 fps*/
156 CINEMA4K_24 = 3 /** 4K Digital Cinema at 24 fps*/
162 typedef enum PROG_ORDER {
163 PROG_UNKNOWN = -1, /**< place-holder */
164 LRCP = 0, /**< layer-resolution-component-precinct order */
165 RLCP = 1, /**< resolution-layer-component-precinct order */
166 RPCL = 2, /**< resolution-precinct-component-layer order */
167 PCRL = 3, /**< precinct-component-resolution-layer order */
168 CPRL = 4 /**< component-precinct-resolution-layer order */
172 * Supported image color spaces
174 typedef enum COLOR_SPACE {
175 CLRSPC_UNKNOWN = -1, /**< not supported by the library */
176 CLRSPC_UNSPECIFIED = 0, /**< not specified in the codestream */
177 CLRSPC_SRGB = 1, /**< sRGB */
178 CLRSPC_GRAY = 2, /**< grayscale */
179 CLRSPC_SYCC = 3 /**< YUV */
185 typedef enum CODEC_FORMAT {
186 CODEC_UNKNOWN = -1, /**< place-holder */
187 CODEC_J2K = 0, /**< JPEG-2000 codestream : read/write */
188 CODEC_JPT = 1, /**< JPT-stream (JPEG 2000, JPIP) : read only */
189 CODEC_JP2 = 2, /**< JPEG-2000 file format : read/write */
193 * Limit decoding to certain portions of the codestream.
195 typedef enum LIMIT_DECODING {
196 NO_LIMITATION = 0, /**< No limitation for the decoding. The entire codestream will de decoded */
197 LIMIT_TO_MAIN_HEADER = 1, /**< The decoding is limited to the Main Header */
198 DECODE_ALL_BUT_PACKETS = 2 /**< Decode everything except the JPEG 2000 packets */
199 } OPJ_LIMIT_DECODING;
203 ==========================================================
204 event manager typedef definitions
205 ==========================================================
209 * Callback function prototype for events
210 * @param msg Event message
213 typedef void (*opj_msg_callback) (const char *msg, void *client_data);
216 * Message handler object used for
219 * <li>Warning messages
220 * <li>Debugging messages
223 typedef struct opj_event_mgr {
226 /** Error message callback if available, NULL otherwise */
227 opj_msg_callback error_handler;
228 /** Warning message callback if available, NULL otherwise */
229 opj_msg_callback warning_handler;
230 /** Debug message callback if available, NULL otherwise */
231 opj_msg_callback info_handler;
236 ==========================================================
237 codec typedef definitions
238 ==========================================================
242 * Progression order changes
244 typedef struct opj_poc {
245 /** Resolution num start, Component num start, given by POC */
246 OPJ_UINT32 resno0, compno0;
247 /** Layer num end,Resolution num end, Component num end, given by POC */
248 OPJ_UINT32 layno1, resno1, compno1;
249 /** Layer num start,Precinct num start, Precinct num end */
250 int layno0, precno0, precno1;
251 /** Progression order enum*/
252 OPJ_PROG_ORDER prg1,prg;
253 /** Progression order string*/
257 /** Start and end values for Tile width and height*/
259 /** Start value, initialised in pi_initialise_encode*/
260 int layS, resS, compS, prcS;
261 /** End value, initialised in pi_initialise_encode */
262 int layE, resE, compE, prcE;
263 /** Start and end values of Tile width and height, initialised in pi_initialise_encode*/
264 int txS,txE,tyS,tyE,dx,dy;
265 /** Temporary values for Tile parts, initialised in pi_create_encode */
266 int lay_t, res_t, comp_t, prc_t,tx0_t,ty0_t;
270 * Compression parameters
272 typedef struct opj_cparameters {
273 /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */
274 opj_bool tile_size_on;
283 /** allocation by rate/distortion */
285 /** allocation by fixed layer */
287 /** add fixed_quality */
288 int cp_fixed_quality;
291 /** comment for coding */
293 /** csty : coding style */
295 /** progression order (default LRCP) */
296 OPJ_PROG_ORDER prog_order;
297 /** progression order changes */
299 /** number of progression order changes (POC), default to 0 */
301 /** number of layers */
303 /** rates of layers */
304 float tcp_rates[100];
305 /** different psnr for successive layers */
306 float tcp_distoratio[100];
307 /** number of resolutions */
309 /** initial code block width, default to 64 */
311 /** initial code block height, default to 64 */
313 /** mode switch (cblk_style) */
315 /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
317 /** region of interest: affected component in [0..3], -1 means no ROI */
319 /** region of interest: upshift value */
321 /* number of precinct size specifications */
323 /** initial precinct width */
324 int prcw_init[J2K_MAXRLVLS];
325 /** initial precinct height */
326 int prch_init[J2K_MAXRLVLS];
328 /**@name command line encoder parameters (not used inside the library) */
330 /** input file name */
331 char infile[OPJ_PATH_LEN];
332 /** output file name */
333 char outfile[OPJ_PATH_LEN];
334 /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
336 /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
337 char index[OPJ_PATH_LEN];
338 /** subimage encoding: origin image offset in x direction */
340 /** subimage encoding: origin image offset in y direction */
342 /** subsampling value for dx */
344 /** subsampling value for dy */
346 /** input file format 0: PGX, 1: PxM, 2: BMP 3:TIF*/
348 /** output file format 0: J2K, 1: JP2, 2: JPT */
353 /**@name JPWL encoding parameters */
355 /** enables writing of EPC in MH, thus activating JPWL */
356 opj_bool jpwl_epc_on;
357 /** error protection method for MH (0,1,16,32,37-128) */
359 /** tile number of header protection specification (>=0) */
360 int jpwl_hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
361 /** error protection methods for TPHs (0,1,16,32,37-128) */
362 int jpwl_hprot_TPH[JPWL_MAX_NO_TILESPECS];
363 /** tile number of packet protection specification (>=0) */
364 int jpwl_pprot_tileno[JPWL_MAX_NO_PACKSPECS];
365 /** packet number of packet protection specification (>=0) */
366 int jpwl_pprot_packno[JPWL_MAX_NO_PACKSPECS];
367 /** error protection methods for packets (0,1,16,32,37-128) */
368 int jpwl_pprot[JPWL_MAX_NO_PACKSPECS];
369 /** enables writing of ESD, (0=no/1/2 bytes) */
371 /** sensitivity addressing size (0=auto/2/4 bytes) */
373 /** sensitivity range (0-3) */
375 /** sensitivity method for MH (-1=no,0-7) */
377 /** tile number of sensitivity specification (>=0) */
378 int jpwl_sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
379 /** sensitivity methods for TPHs (-1=no,0-7) */
380 int jpwl_sens_TPH[JPWL_MAX_NO_TILESPECS];
384 /** Digital Cinema compliance 0-not compliant, 1-compliant*/
385 OPJ_CINEMA_MODE cp_cinema;
386 /** Maximum rate for each component. If == 0, component size limitation is not considered */
389 OPJ_RSIZ_CAPABILITIES cp_rsiz;
390 /** Tile part generation*/
392 /** Flag for Tile part generation*/
394 /** MCT (multiple component transform) */
396 /** Enable JPIP indexing*/
401 * Decompression parameters
403 typedef struct opj_dparameters {
405 Set the number of highest resolution levels to be discarded.
406 The image resolution is effectively divided by 2 to the power of the number of discarded levels.
407 The reduce factor is limited by the smallest total number of decomposition levels among tiles.
408 if != 0, then original dimension divided by 2^(reduce);
409 if == 0 or not used, image is decoded to the full resolution
413 Set the maximum number of quality layers to decode.
414 If there are less quality layers than the specified number, all the quality layers are decoded.
415 if != 0, then only the first "layer" layers are decoded;
416 if == 0 or not used, all the quality layers are decoded
420 /**@name command line decoder parameters (not used inside the library) */
422 /** input file name */
423 char infile[OPJ_PATH_LEN];
424 /** output file name */
425 char outfile[OPJ_PATH_LEN];
426 /** input file format 0: J2K, 1: JP2, 2: JPT */
428 /** output file format 0: PGX, 1: PxM, 2: BMP */
431 /** Decoding area left boundary */
433 /** Decoding area right boundary */
435 /** Decoding area up boundary */
437 /** Decoding area bottom boundary */
445 /**@name JPWL decoding parameters */
447 /** activates the JPWL correction capabilities */
448 opj_bool jpwl_correct;
449 /** expected number of components */
451 /** maximum number of tiles */
457 Specify whether the decoding should be done on the entire codestream, or be limited to the main header
458 Limiting the decoding to the main header makes it possible to extract the characteristics of the codestream
459 if == NO_LIMITATION, the entire codestream is decoded;
460 if == LIMIT_TO_MAIN_HEADER, only the main header is decoded;
462 OPJ_LIMIT_DECODING cp_limit_decoding;
467 /* ---> FIXME V1 style */
468 /** Common fields between JPEG-2000 compression and decompression master structs. */
470 #define opj_common_fields \
471 opj_event_mgr_t *event_mgr; /**< pointer to the event manager */\
472 void * client_data; /**< Available for use by application */\
473 opj_bool is_decompressor; /**< So common code can tell which is which */\
474 OPJ_CODEC_FORMAT codec_format; /**< selected codec */\
475 void *j2k_handle; /**< pointer to the J2K codec */\
476 void *jp2_handle; /**< pointer to the JP2 codec */\
477 void *mj2_handle /**< pointer to the MJ2 codec */
479 /* Routines that are to be used by both halves of the library are declared
480 * to receive a pointer to this structure. There are no actual instances of
481 * opj_common_struct_t, only of opj_cinfo_t and opj_dinfo_t.
483 typedef struct opj_common_struct {
484 opj_common_fields; /* Fields common to both master struct types */
485 /* Additional fields follow in an actual opj_cinfo_t or
486 * opj_dinfo_t. All three structs must agree on these
487 * initial fields! (This would be a lot cleaner in C++.)
489 } opj_common_struct_t;
491 typedef opj_common_struct_t * opj_common_ptr;
494 * Compression context info
496 typedef struct opj_cinfo {
497 /** Fields shared with opj_dinfo_t */
499 /* other specific fields go here */
503 * Decompression context info
505 typedef struct opj_dinfo {
506 /** Fields shared with opj_cinfo_t */
508 /* other specific fields go here */
516 typedef void * opj_codec_t;
519 ==========================================================
520 I/O stream typedef definitions
521 ==========================================================
527 /** The stream was opened for reading. */
528 #define OPJ_STREAM_READ 0x0001
529 /** The stream was opened for writing. */
530 #define OPJ_STREAM_WRITE 0x0002
533 Byte input-output stream (CIO)
535 typedef struct opj_cio {
537 opj_common_ptr cinfo;
539 /** open mode (read/write) either OPJ_STREAM_READ or OPJ_STREAM_WRITE */
541 /** pointer to the start of the buffer */
542 unsigned char *buffer;
543 /** buffer size in bytes */
546 /** pointer to the start of the stream */
547 unsigned char *start;
548 /** pointer to the end of the stream */
550 /** pointer to the current position */
558 typedef OPJ_UINT32 (* opj_stream_read_fn) (void * p_buffer, OPJ_UINT32 p_nb_bytes, void * p_user_data) ;
559 typedef OPJ_UINT32 (* opj_stream_write_fn) (void * p_buffer, OPJ_UINT32 p_nb_bytes, void * p_user_data) ;
560 typedef OPJ_SIZE_T (* opj_stream_skip_fn) (OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
561 typedef opj_bool (* opj_stream_seek_fn) (OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
566 typedef void * opj_stream_t;
569 ==========================================================
570 image typedef definitions
571 ==========================================================
575 * Defines a single image component
577 typedef struct opj_image_comp {
578 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
580 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
586 /** x component offset compared to the whole image */
588 /** y component offset compared to the whole image */
592 /** image depth in bits */
594 /** signed (1) / unsigned (0) */
596 /** number of decoded resolution */
597 OPJ_UINT32 resno_decoded;
598 /** number of division by 2 of the out image compared to the original size of image */
600 /** image component data */
605 * Defines image data and characteristics
607 typedef struct opj_image {
608 /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
610 /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
612 /** Xsiz: width of the reference grid */
614 /** Ysiz: height of the reference grid */
616 /** number of components in the image */
618 /** color space: sRGB, Greyscale or YUV */
619 OPJ_COLOR_SPACE color_space;
620 /** image components */
621 opj_image_comp_t *comps;
622 /** 'restricted' ICC profile */
623 OPJ_BYTE *icc_profile_buf;
624 /** size of ICC profile */
625 OPJ_INT32 icc_profile_len;
630 * Component parameters structure used by the opj_image_create function
632 typedef struct opj_image_comptparm {
633 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
635 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
641 /** x component offset compared to the whole image */
643 /** y component offset compared to the whole image */
647 /** image depth in bits */
649 /** signed (1) / unsigned (0) */
651 } opj_image_cmptparm_t;
655 ==========================================================
656 Information on the JPEG 2000 codestream
657 ==========================================================
661 * Index structure : Information concerning a packet inside tile
663 typedef struct opj_packet_info {
664 /** packet start position (including SOP marker if it exists) */
666 /** end of packet header position (including EPH marker if it exists)*/
668 /** packet end position */
670 /** packet distorsion */
679 typedef struct opj_marker_info_t {
681 unsigned short int type;
682 /** position in codestream */
684 /** length, marker val included */
690 * Index structure : Information concerning tile-parts
692 typedef struct opj_tp_info {
693 /** start position of tile part */
695 /** end position of tile part header */
697 /** end position of tile part */
699 /** start packet of tile part */
701 /** number of packets of tile part */
706 * Index structure : information regarding tiles
708 typedef struct opj_tile_info {
709 /** value of thresh for each layer by tile cfr. Marcela */
711 /** number of tile */
713 /** start position */
715 /** end position of the header */
719 /** precinct number for each resolution level (width) */
721 /** precinct number for each resolution level (height) */
723 /** precinct size (in power of 2), in X for each resolution level */
725 /** precinct size (in power of 2), in Y for each resolution level */
727 /** information concerning packets inside tile */
728 opj_packet_info_t *packet;
729 /** add fixed_quality */
731 /** add fixed_quality */
733 /** number of markers */
735 /** list of markers */
736 opj_marker_info_t *marker;
737 /** actual size of markers array */
739 /** number of tile parts */
741 /** information concerning tile parts */
746 * Index structure of the codestream
748 typedef struct opj_codestream_info {
749 /** maximum distortion reduction on the whole image (add for Marcela) */
753 /** writing the packet in the index with t2_encode_packets */
759 /** progression order */
761 /** tile size in x */
763 /** tile size in y */
769 /** number of tiles in X */
771 /** number of tiles in Y */
773 /** component numbers */
775 /** number of layer */
777 /** number of decomposition for each component */
780 /** number of markers */
782 /** list of markers */
783 opj_marker_info_t *marker;
784 /** actual size of markers array */
787 /** main header position */
789 /** main header position */
791 /** codestream's size */
793 /** information regarding tiles inside image */
794 opj_tile_info_t *tile;
795 } opj_codestream_info_t;
797 /* <----------------------------------------------------------- */
798 /* new output managment of the codestream information and index */
801 * Tile-component coding parameters information
803 typedef struct opj_tccp_info
805 /** component index */
809 /** number of resolutions */
810 OPJ_UINT32 numresolutions;
811 /** code-blocks width */
813 /** code-blocks height */
815 /** code-block coding style */
817 /** discrete wavelet transform identifier */
819 /** quantisation style */
821 /** stepsizes used for quantization */
822 OPJ_UINT32 stepsizes_mant[J2K_MAXBANDS];
823 /** stepsizes used for quantization */
824 OPJ_UINT32 stepsizes_expn[J2K_MAXBANDS];
825 /** number of guard bits */
827 /** Region Of Interest shift */
829 /** precinct width */
830 OPJ_UINT32 prcw[J2K_MAXRLVLS];
831 /** precinct height */
832 OPJ_UINT32 prch[J2K_MAXRLVLS];
837 * Tile coding parameters information
839 typedef struct opj_tile_v2_info {
841 /** number (index) of tile */
845 /** progression order */
847 /** number of layers */
848 OPJ_UINT32 numlayers;
849 /** multi-component transform identifier */
852 /** information concerning tile component parameters*/
853 opj_tccp_info_t *tccp_info;
855 } opj_tile_info_v2_t;
858 * Information structure about the codestream (FIXME should be expand and enhance)
860 typedef struct opj_codestream_info_v2 {
862 /** tile origin in x = XTOsiz */
864 /** tile origin in y = YTOsiz */
866 /** tile size in x = XTsiz */
868 /** tile size in y = YTsiz */
870 /** number of tiles in X */
872 /** number of tiles in Y */
875 /** number of components*/
878 /** Default information regarding tiles inside image */
879 opj_tile_info_v2_t m_default_tile_info;
881 /** information regarding tiles inside image */
882 opj_tile_info_v2_t *tile_info; /* FIXME not used for the moment */
884 } opj_codestream_info_v2_t;
888 * Index structure about a tile part
890 typedef struct opj_tp_index {
891 /** start position */
892 OPJ_UINT32 start_pos;
893 /** end position of the header */
894 OPJ_UINT32 end_header;
904 * Index structure about a tile
906 typedef struct opj_tile_index {
910 /** number of tile parts */
912 /** current nb of tile part (allocated)*/
913 OPJ_UINT32 current_nb_tps;
914 /** current tile-part index */
915 OPJ_UINT32 current_tpsno;
916 /** information concerning tile parts */
917 opj_tp_index_t *tp_index;
920 /** number of markers */
922 /** list of markers */
923 opj_marker_info_t *marker;
924 /** actual size of markers array */
925 OPJ_UINT32 maxmarknum;
929 OPJ_UINT32 nb_packet;
930 /** information concerning packets inside tile */
931 opj_packet_info_t *packet_index;
936 * Index structure of the codestream (FIXME should be expand and enhance)
938 typedef struct opj_codestream_index_ {
939 /** main header start position (SOC position) */
940 OPJ_UINT32 main_head_start;
941 /** main header end position (first SOT position) */
942 OPJ_UINT32 main_head_end;
944 /** codestream's size */
945 OPJ_UINT32 codestream_size;
948 /** number of markers */
950 /** list of markers */
951 opj_marker_info_t *marker;
952 /** actual size of markers array */
953 OPJ_UINT32 maxmarknum;
957 OPJ_UINT32 nb_of_tiles;
959 opj_tile_index_t *tile_index; /* FIXME not used for the moment */
961 }opj_codestream_index_t;
962 /* -----------------------------------------------------------> */
965 ==========================================================
966 Metadata from the JP2file
967 ==========================================================
971 * Info structure of the JP2 file
974 typedef struct opj_jp2_metadata {
978 } opj_jp2_metadata_t;
981 * Index structure of the JP2 file
984 typedef struct opj_jp2_index {
997 ==========================================================
999 ==========================================================
1002 OPJ_API const char * OPJ_CALLCONV opj_version(void);
1005 ==========================================================
1006 image functions definitions
1007 ==========================================================
1012 * @param numcmpts number of components
1013 * @param cmptparms components parameters
1014 * @param clrspc image color space
1015 * @return returns a new image structure if successful, returns NULL otherwise
1017 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(int numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1020 * Deallocate any resources associated with an image
1021 * @param image image to be destroyed
1023 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
1027 ==========================================================
1028 stream functions definitions
1029 ==========================================================
1033 Open and allocate a memory stream for read / write.
1034 On reading, the user must provide a buffer containing encoded data. The buffer will be
1035 wrapped by the returned CIO handle.
1036 On writing, buffer parameters must be set to 0: a buffer will be allocated by the library
1037 to contain encoded data.
1038 @param cinfo Codec context info
1039 @param buffer Reading: buffer address. Writing: NULL
1040 @param length Reading: buffer length. Writing: 0
1041 @return Returns a CIO handle if successful, returns NULL otherwise
1043 OPJ_API opj_cio_t* OPJ_CALLCONV opj_cio_open(opj_common_ptr cinfo, unsigned char *buffer, int length);
1046 Close and free a CIO handle
1047 @param cio CIO handle to free
1049 OPJ_API void OPJ_CALLCONV opj_cio_close(opj_cio_t *cio);
1052 Get position in byte stream
1053 @param cio CIO handle
1054 @return Returns the position in bytes
1056 OPJ_API int OPJ_CALLCONV cio_tell(opj_cio_t *cio);
1058 Set position in byte stream
1059 @param cio CIO handle
1060 @param pos Position, in number of bytes, from the beginning of the stream
1062 OPJ_API void OPJ_CALLCONV cio_seek(opj_cio_t *cio, int pos);
1068 * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1070 * @param l_is_reader if set to true then the stream will be an input stream, an output stream else.
1072 * @return a stream object.
1074 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_default_create(opj_bool p_is_input);
1075 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create(OPJ_UINT32 p_size, opj_bool p_is_input);
1078 * Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must
1079 * close its own implementation of the stream.
1081 * @param p_stream the stream to destroy.
1083 OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream);
1086 * Sets the given function to be used as a read function.
1087 * @param p_stream the stream to modify
1088 * @param p_function the function to use a read function.
1090 OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream, opj_stream_read_fn p_function);
1093 * Sets the given function to be used as a write function.
1094 * @param p_stream the stream to modify
1095 * @param p_function the function to use a write function.
1097 OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream, opj_stream_write_fn p_function);
1100 * Sets the given function to be used as a skip function.
1101 * @param p_stream the stream to modify
1102 * @param p_function the function to use a skip function.
1104 OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream, opj_stream_skip_fn p_function);
1107 * Sets the given function to be used as a seek function, the stream is then seekable.
1108 * @param p_stream the stream to modify
1109 * @param p_function the function to use a skip function.
1111 OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream, opj_stream_seek_fn p_function);
1115 * Sets the given data to be used as a user data for the stream.
1116 * @param p_stream the stream to modify
1117 * @param p_data the data to set.
1119 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data (opj_stream_t* p_stream, void * p_data);
1122 * Sets the length of the user data for the stream.
1123 * @param p_stream the stream to modify
1124 * @param data_length length of the user_data.
1126 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data_length(opj_stream_t* p_stream, OPJ_UINT32 data_length);
1131 * Sets the stream to be a file stream. The FILE must have been open previously.
1132 * @param p_stream the stream to modify
1133 * @param p_file handler to an already open file.
1135 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream (FILE * p_file, opj_bool p_is_read_stream);
1136 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);
1141 ==========================================================
1142 event manager functions definitions
1143 ==========================================================
1148 DEPRECATED( OPJ_API opj_event_mgr_t* OPJ_CALLCONV opj_set_event_mgr(opj_common_ptr cinfo, opj_event_mgr_t *event_mgr, void *context));
1151 * Initialize a default event handler. This function set the output of message event to be stderr for warning and error output
1152 * and stdout for info output in the verbose mode. In the case of the non-verbose mode only the error message are displayed.
1153 * You can initialize your own event handler struct when you fill the field of the event structure. If you provide a null
1154 * structure to the opj_setup_decoder function, no output will be displayed.
1156 * @param p_manager a opj_event_mgr structure which will be pass to the codec.
1159 OPJ_API void OPJ_CALLCONV opj_initialize_default_event_handler(opj_event_mgr_t * p_manager, opj_bool verbose);
1163 ==========================================================
1164 codec functions definitions
1165 ==========================================================
1169 Creates a J2K/JPT/JP2 decompression structure
1170 @param format Decoder to select
1171 @return Returns a handle to a decompressor if successful, returns NULL otherwise
1173 DEPRECATED( OPJ_API opj_dinfo_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format) );
1176 * Creates a J2K/JP2 decompression structure
1177 * @param format Decoder to select
1179 * @return Returns a handle to a decompressor if successful, returns NULL otherwise
1181 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress_v2(OPJ_CODEC_FORMAT format);
1184 Destroy a decompressor handle
1185 @param dinfo decompressor handle to destroy
1187 DEPRECATED( OPJ_API void OPJ_CALLCONV opj_destroy_decompress(opj_dinfo_t *dinfo) );
1190 * Read after the codestream if necessary
1192 OPJ_API opj_bool OPJ_CALLCONV opj_end_decompress ( opj_codec_t *p_codec,
1193 opj_stream_t *p_cio);
1197 Set decoding parameters to default values
1198 @param parameters Decompression parameters
1200 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters);
1203 Setup the decoder decoding parameters using user parameters.
1204 Decoding parameters are returned in j2k->cp.
1205 @param dinfo decompressor handle
1206 @param parameters decompression parameters
1208 DEPRECATED( OPJ_API void OPJ_CALLCONV opj_setup_decoder(opj_dinfo_t *dinfo, opj_dparameters_t *parameters) );
1212 * Setup the decoder with decompression parameters provided by the user and with the message handler
1213 * provided by the user.
1215 * @param dinfo decompressor handlers
1216 * @param parameters decompression parameters
1217 * @param event_mgr message handler
1219 * @return true if the decoder is correctly set
1221 OPJ_API opj_bool OPJ_CALLCONV opj_setup_decoder_v2( opj_codec_t *p_info,
1222 opj_dparameters_t *parameters,
1223 opj_event_mgr_t* event_mgr);
1226 * Decodes an image header.
1228 * @param p_cio the jpeg2000 stream.
1229 * @param p_codec the jpeg2000 codec to read.
1230 * @param p_image the image structure initialized with the characteristics of encoded image.
1232 * @return true if the main header of the codestream and the JP2 header is correctly read.
1234 OPJ_API opj_bool OPJ_CALLCONV opj_read_header ( opj_stream_t *p_cio,
1235 opj_codec_t *p_codec,
1236 opj_image_t **p_image);
1239 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
1241 * @param p_codec the jpeg2000 codec.
1242 * @param p_start_x the left position of the rectangle to decode (in image coordinates).
1243 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
1244 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
1245 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
1247 * @return true if the area could be set.
1249 OPJ_API opj_bool OPJ_CALLCONV opj_set_decode_area( opj_codec_t *p_codec,
1250 opj_image_t* p_image,
1251 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
1252 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y );
1255 Decode an image from a JPEG-2000 codestream
1256 @param dinfo decompressor handle
1257 @param cio Input buffer stream
1258 @return Returns a decoded image if successful, returns NULL otherwise
1260 DEPRECATED( OPJ_API opj_image_t* OPJ_CALLCONV opj_decode(opj_dinfo_t *dinfo, opj_cio_t *cio) );
1263 * Decode an image from a JPEG-2000 codestream
1264 * @param dinfo decompressor handle
1265 * @param cio Input buffer stream
1266 * @return Returns a decoded image if successful, returns NULL otherwise
1268 OPJ_API opj_bool OPJ_CALLCONV opj_decode_v2(opj_codec_t *p_decompressor,
1270 opj_image_t *p_image);
1274 * Get the decoded tile from the codec
1275 * @param p_codec the jpeg2000 codec.
1276 * @param p_cio input streamm
1277 * @param p_image output image
1278 * @param tile_index index of the tile which will be decode
1280 * @return a pointer to a JP2 index structure.
1282 OPJ_API opj_bool OPJ_CALLCONV opj_get_decoded_tile( opj_codec_t *p_codec,
1283 opj_stream_t *p_cio,
1284 opj_image_t *p_image,
1285 OPJ_UINT32 tile_index);
1288 * Reads a tile header. This function is compulsory and allows one to know the size of the tile thta will be decoded.
1289 * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1291 * @param p_codec the jpeg2000 codec.
1292 * @param p_tile_index pointer to a value that will hold the index of the tile being decoded, in case of success.
1293 * @param p_data_size pointer to a value that will hold the maximum size of the decoded data, in case of success. In case
1294 * of truncated codestreams, the actual number of bytes decoded may be lower. The computation of the size is the same
1295 * as depicted in opj_write_tile.
1296 * @param p_tile_x0 pointer to a value that will hold the x0 pos of the tile (in the image).
1297 * @param p_tile_y0 pointer to a value that will hold the y0 pos of the tile (in the image).
1298 * @param p_tile_x1 pointer to a value that will hold the x1 pos of the tile (in the image).
1299 * @param p_tile_y1 pointer to a value that will hold the y1 pos of the tile (in the image).
1300 * @param p_nb_comps pointer to a value that will hold the number of components in the tile.
1301 * @param p_should_go_on pointer to a boolean that will hold the fact that the decoding should go on. In case the
1302 * codestream is over at the time of the call, the value will be set to false. The user should then stop
1304 * @param p_stream the stream to decode.
1305 * @return true if the tile header could be decoded. In case the decoding should end, the returned value is still true.
1306 * returning false may be the result of a shortage of memory or an internal error.
1308 OPJ_API opj_bool OPJ_CALLCONV opj_read_tile_header( opj_codec_t *p_codec,
1309 opj_stream_t * p_stream,
1310 OPJ_UINT32 * p_tile_index,
1311 OPJ_UINT32 * p_data_size,
1312 OPJ_INT32 * p_tile_x0, OPJ_INT32 * p_tile_y0,
1313 OPJ_INT32 * p_tile_x1, OPJ_INT32 * p_tile_y1,
1314 OPJ_UINT32 * p_nb_comps,
1315 opj_bool * p_should_go_on );
1319 * Reads a tile data. This function is compulsory and allows one to decode tile data. opj_read_tile_header should be called before.
1320 * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1322 * @param p_codec the jpeg2000 codec.
1323 * @param p_tile_index the index of the tile being decoded, this should be the value set by opj_read_tile_header.
1324 * @param p_data pointer to a memory block that will hold the decoded data.
1325 * @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.
1326 * @param p_stream the stream to decode.
1328 * @return true if the data could be decoded.
1330 OPJ_API opj_bool OPJ_CALLCONV opj_decode_tile_data( opj_codec_t *p_codec,
1331 OPJ_UINT32 p_tile_index,
1333 OPJ_UINT32 p_data_size,
1334 opj_stream_t *p_stream );
1338 Decode an image from a JPEG-2000 codestream and extract the codestream information
1339 @param dinfo decompressor handle
1340 @param cio Input buffer stream
1341 @param cstr_info Codestream information structure if needed afterwards, NULL otherwise
1342 @return Returns a decoded image if successful, returns NULL otherwise
1344 DEPRECATED( 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) );
1346 /* COMPRESSION FUNCTIONS*/
1349 Creates a J2K/JP2 compression structure
1350 @param format Coder to select
1351 @return Returns a handle to a compressor if successful, returns NULL otherwise
1353 OPJ_API opj_cinfo_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
1355 Destroy a compressor handle
1356 @param cinfo compressor handle to destroy
1358 OPJ_API void OPJ_CALLCONV opj_destroy_compress(opj_cinfo_t *cinfo);
1360 Set encoding parameters to default values, that means :
1364 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
1365 <li>Size of code-block : 64 x 64
1366 <li>Number of resolutions: 6
1367 <li>No SOP marker in the codestream
1368 <li>No EPH marker in the codestream
1369 <li>No sub-sampling in x or y direction
1370 <li>No mode switch activated
1371 <li>Progression order: LRCP
1373 <li>No ROI upshifted
1374 <li>No offset of the origin of the image
1375 <li>No offset of the origin of the tiles
1376 <li>Reversible DWT 5-3
1378 @param parameters Compression parameters
1380 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(opj_cparameters_t *parameters);
1382 Setup the encoder parameters using the current image and using user parameters.
1383 @param cinfo Compressor handle
1384 @param parameters Compression parameters
1385 @param image Input filled image
1387 OPJ_API void OPJ_CALLCONV opj_setup_encoder(opj_cinfo_t *cinfo, opj_cparameters_t *parameters, opj_image_t *image);
1389 Encode an image into a JPEG-2000 codestream
1390 3@param cinfo compressor handle
1391 @param cio Output buffer stream
1392 @param image Image to encode
1393 @param index Depreacted -> Set to NULL. To extract index, used opj_encode_wci()
1394 @return Returns true if successful, returns false otherwise
1396 OPJ_API opj_bool OPJ_CALLCONV opj_encode(opj_cinfo_t *cinfo, opj_cio_t *cio, opj_image_t *image, char *index);
1398 Encode an image into a JPEG-2000 codestream and extract the codestream information
1399 @param cinfo compressor handle
1400 @param cio Output buffer stream
1401 @param image Image to encode
1402 @param cstr_info Codestream information structure if needed afterwards, NULL otherwise
1403 @return Returns true if successful, returns false otherwise
1405 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);
1411 Destroy Codestream information after compression or decompression
1412 @param cstr_info Codestream information structure
1414 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_t *cstr_info);
1416 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info_v2(opj_codestream_info_v2_t **cstr_info);
1421 * Destroy a decompressor handle
1423 * @param dinfo decompressor handle to destroy
1425 OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec);
1431 ==========================================================
1432 codec output functions definitions
1433 ==========================================================
1437 * Dump the codec information into the output stream
1439 * @param p_codec the jpeg2000 codec.
1440 * @param info_flag type of information dump.
1441 * @param output_stream output stream where dump the informations get from the codec.
1444 OPJ_API void OPJ_CALLCONV opj_dump_codec( opj_codec_t *p_codec,
1445 OPJ_INT32 info_flag,
1446 FILE* output_stream);
1449 * Get the codestream information from the codec
1451 * @param p_codec the jpeg2000 codec.
1453 * @return a pointer to a codestream information structure.
1456 OPJ_API opj_codestream_info_v2_t* OPJ_CALLCONV opj_get_cstr_info(opj_codec_t *p_codec);
1459 * Get the codestream index from the codec
1461 * @param p_codec the jpeg2000 codec.
1463 * @return a pointer to a codestream index structure.
1466 OPJ_API opj_codestream_index_t * OPJ_CALLCONV opj_get_cstr_index(opj_codec_t *p_codec);
1468 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_index(opj_codestream_index_t **p_cstr_index);
1472 * Get the JP2 file information from the codec FIXME
1474 * @param p_codec the jpeg2000 codec.
1476 * @return a pointer to a JP2 metadata structure.
1479 OPJ_API opj_jp2_metadata_t* OPJ_CALLCONV opj_get_jp2_metadata(opj_codec_t *p_codec);
1482 * Get the JP2 file index from the codec FIXME
1484 * @param p_codec the jpeg2000 codec.
1486 * @return a pointer to a JP2 index structure.
1489 OPJ_API opj_jp2_index_t* OPJ_CALLCONV opj_get_jp2_index(opj_codec_t *p_codec);
1499 #endif /* OPENJPEG_H */