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)
56 /* http://gcc.gnu.org/wiki/Visibility */
58 #define OPJ_API __attribute__ ((visibility ("default")))
59 #define OPJ_LOCAL __attribute__ ((visibility ("hidden")))
66 #define OPJ_CALLCONV __stdcall
68 The following ifdef block is the standard way of creating macros which make exporting
69 from a DLL simpler. All files within this DLL are compiled with the OPJ_EXPORTS
70 symbol defined on the command line. this symbol should not be defined on any project
71 that uses this DLL. This way any other project whose source files include this file see
72 OPJ_API functions as being imported from a DLL, wheras this DLL sees symbols
73 defined with this macro as being exported.
75 #if defined(OPJ_EXPORTS) || defined(DLL_EXPORT)
76 #define OPJ_API __declspec(dllexport)
78 #define OPJ_API __declspec(dllimport)
79 #endif /* OPJ_EXPORTS */
80 #endif /* !OPJ_STATIC || !_WIN32 */
82 typedef int opj_bool; /*FIXME it should be to follow the name of others OPJ_TYPE -> OPJ_BOOL*/
86 typedef char OPJ_CHAR;
87 typedef float OPJ_FLOAT32;
88 typedef double OPJ_FLOAT64;
89 typedef unsigned char OPJ_BYTE;
91 #include "opj_stdint.h"
93 typedef int8_t OPJ_INT8;
94 typedef uint8_t OPJ_UINT8;
95 typedef int16_t OPJ_INT16;
96 typedef uint16_t OPJ_UINT16;
97 typedef int32_t OPJ_INT32;
98 typedef uint32_t OPJ_UINT32;
99 typedef int64_t OPJ_INT64;
100 typedef uint64_t OPJ_UINT64;
102 /* Avoid compile-time warning because parameter is not used */
103 #define OPJ_ARG_NOT_USED(x) (void)(x)
106 ==========================================================
107 Useful constant definitions
108 ==========================================================
111 #define OPJ_PATH_LEN 4096 /**< Maximum allowed size for filenames */
113 #define OPJ_J2K_MAXRLVLS 33 /**< Number of maximum resolution level authorized */
114 #define OPJ_J2K_MAXBANDS (3*OPJ_J2K_MAXRLVLS-2) /**< Number of maximum sub-band linked to number of resolution level */
116 #define OPJ_J2K_DEFAULT_NB_SEGS 10
117 #define OPJ_J2K_STREAM_CHUNK_SIZE 0x100000 /** 1 mega by default */
118 #define OPJ_J2K_DEFAULT_HEADER_SIZE 1000
119 #define OPJ_J2K_MCC_DEFAULT_NB_RECORDS 10
120 #define OPJ_J2K_MCT_DEFAULT_NB_RECORDS 10
123 #define JPWL_MAX_NO_TILESPECS 16 /**< Maximum number of tile parts expected by JPWL: increase at your will */
124 #define JPWL_MAX_NO_PACKSPECS 16 /**< Maximum number of packet parts expected by JPWL: increase at your will */
125 #define JPWL_MAX_NO_MARKERS 512 /**< Maximum number of JPWL markers: increase at your will */
126 #define JPWL_PRIVATEINDEX_NAME "jpwl_index_privatefilename" /**< index file name used when JPWL is on */
127 #define JPWL_EXPECTED_COMPONENTS 3 /**< Expect this number of components, so you'll find better the first EPB */
128 #define JPWL_MAXIMUM_TILES 8192 /**< Expect this maximum number of tiles, to avoid some crashes */
129 #define JPWL_MAXIMUM_HAMMING 2 /**< Expect this maximum number of bit errors in marker id's */
130 #define JPWL_MAXIMUM_EPB_ROOM 65450 /**< Expect this maximum number of bytes for composition of EPBs */
134 * FIXME EXPERIMENTAL FOR THE MOMENT
135 * Supported options about file information
137 #define OPJ_IMG_INFO 1 /**< Basic image information provided to the user */
138 #define OPJ_J2K_MH_INFO 2 /**< Codestream information based only on the main header */
139 #define OPJ_J2K_TH_INFO 4 /**< Tile information based on the current tile header */
140 /*FIXME #define OPJ_J2K_CSTR_INFO 6*/ /**< */
141 #define OPJ_J2K_MH_IND 16 /**< Codestream index based only on the main header */
142 #define OPJ_J2K_TH_IND 32 /**< Tile index based on the current tile */
143 /*FIXME #define OPJ_J2K_CSTR_IND 48*/ /**< */
144 #define OPJ_JP2_INFO 128 /**< JP2 file information */
145 #define OPJ_JP2_IND 256 /**< JP2 file index */
149 ==========================================================
151 ==========================================================
156 typedef enum RSIZ_CAPABILITIES {
157 OPJ_STD_RSIZ = 0, /** Standard JPEG2000 profile*/
158 OPJ_CINEMA2K = 3, /** Profile name for a 2K image*/
159 OPJ_CINEMA4K = 4, /** Profile name for a 4K image*/
161 } OPJ_RSIZ_CAPABILITIES;
164 * Digital cinema operation mode
166 typedef enum CINEMA_MODE {
167 OPJ_OFF = 0, /** Not Digital Cinema*/
168 OPJ_CINEMA2K_24 = 1, /** 2K Digital Cinema at 24 fps*/
169 OPJ_CINEMA2K_48 = 2, /** 2K Digital Cinema at 48 fps*/
170 OPJ_CINEMA4K_24 = 3 /** 4K Digital Cinema at 24 fps*/
176 typedef enum PROG_ORDER {
177 OPJ_PROG_UNKNOWN = -1, /**< place-holder */
178 OPJ_LRCP = 0, /**< layer-resolution-component-precinct order */
179 OPJ_RLCP = 1, /**< resolution-layer-component-precinct order */
180 OPJ_RPCL = 2, /**< resolution-precinct-component-layer order */
181 OPJ_PCRL = 3, /**< precinct-component-resolution-layer order */
182 OPJ_CPRL = 4 /**< component-precinct-resolution-layer order */
186 * Supported image color spaces
188 typedef enum COLOR_SPACE {
189 OPJ_CLRSPC_UNKNOWN = -1, /**< not supported by the library */
190 OPJ_CLRSPC_UNSPECIFIED = 0, /**< not specified in the codestream */
191 OPJ_CLRSPC_SRGB = 1, /**< sRGB */
192 OPJ_CLRSPC_GRAY = 2, /**< grayscale */
193 OPJ_CLRSPC_SYCC = 3 /**< YUV */
199 typedef enum CODEC_FORMAT {
200 OPJ_CODEC_UNKNOWN = -1, /**< place-holder */
201 OPJ_CODEC_J2K = 0, /**< JPEG-2000 codestream : read/write */
202 OPJ_CODEC_JPT = 1, /**< JPT-stream (JPEG 2000, JPIP) : read only */
203 OPJ_CODEC_JP2 = 2 /**< JPEG-2000 file format : read/write */
208 ==========================================================
209 event manager typedef definitions
210 ==========================================================
214 * Callback function prototype for events
215 * @param msg Event message
216 * @param client_data FIXME DOC
218 typedef void (*opj_msg_callback) (const char *msg, void *client_data);
221 ==========================================================
222 codec typedef definitions
223 ==========================================================
227 * Progression order changes
230 typedef struct opj_poc {
231 /** Resolution num start, Component num start, given by POC */
232 OPJ_UINT32 resno0, compno0;
233 /** Layer num end,Resolution num end, Component num end, given by POC */
234 OPJ_UINT32 layno1, resno1, compno1;
235 /** Layer num start,Precinct num start, Precinct num end */
236 OPJ_UINT32 layno0, precno0, precno1;
237 /** Progression order enum*/
238 OPJ_PROG_ORDER prg1,prg;
239 /** Progression order string*/
240 OPJ_CHAR progorder[5];
243 /** Start and end values for Tile width and height*/
244 OPJ_INT32 tx0,tx1,ty0,ty1;
245 /** Start value, initialised in pi_initialise_encode*/
246 OPJ_UINT32 layS, resS, compS, prcS;
247 /** End value, initialised in pi_initialise_encode */
248 OPJ_UINT32 layE, resE, compE, prcE;
249 /** Start and end values of Tile width and height, initialised in pi_initialise_encode*/
250 OPJ_UINT32 txS,txE,tyS,tyE,dx,dy;
251 /** Temporary values for Tile parts, initialised in pi_create_encode */
252 OPJ_UINT32 lay_t, res_t, comp_t, prc_t,tx0_t,ty0_t;
256 * Compression parameters
258 typedef struct opj_cparameters {
259 /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */
260 opj_bool tile_size_on;
269 /** allocation by rate/distortion */
271 /** allocation by fixed layer */
273 /** add fixed_quality */
274 int cp_fixed_quality;
277 /** comment for coding */
279 /** csty : coding style */
281 /** progression order (default OPJ_LRCP) */
282 OPJ_PROG_ORDER prog_order;
283 /** progression order changes */
285 /** number of progression order changes (POC), default to 0 */
287 /** number of layers */
289 /** rates of layers */
290 float tcp_rates[100];
291 /** different psnr for successive layers */
292 float tcp_distoratio[100];
293 /** number of resolutions */
295 /** initial code block width, default to 64 */
297 /** initial code block height, default to 64 */
299 /** mode switch (cblk_style) */
301 /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
303 /** region of interest: affected component in [0..3], -1 means no ROI */
305 /** region of interest: upshift value */
307 /* number of precinct size specifications */
309 /** initial precinct width */
310 int prcw_init[OPJ_J2K_MAXRLVLS];
311 /** initial precinct height */
312 int prch_init[OPJ_J2K_MAXRLVLS];
314 /**@name command line encoder parameters (not used inside the library) */
316 /** input file name */
317 char infile[OPJ_PATH_LEN];
318 /** output file name */
319 char outfile[OPJ_PATH_LEN];
320 /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
322 /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
323 char index[OPJ_PATH_LEN];
324 /** subimage encoding: origin image offset in x direction */
326 /** subimage encoding: origin image offset in y direction */
328 /** subsampling value for dx */
330 /** subsampling value for dy */
332 /** input file format 0: PGX, 1: PxM, 2: BMP 3:TIF*/
334 /** output file format 0: J2K, 1: JP2, 2: JPT */
339 /**@name JPWL encoding parameters */
341 /** enables writing of EPC in MH, thus activating JPWL */
342 opj_bool jpwl_epc_on;
343 /** error protection method for MH (0,1,16,32,37-128) */
345 /** tile number of header protection specification (>=0) */
346 int jpwl_hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
347 /** error protection methods for TPHs (0,1,16,32,37-128) */
348 int jpwl_hprot_TPH[JPWL_MAX_NO_TILESPECS];
349 /** tile number of packet protection specification (>=0) */
350 int jpwl_pprot_tileno[JPWL_MAX_NO_PACKSPECS];
351 /** packet number of packet protection specification (>=0) */
352 int jpwl_pprot_packno[JPWL_MAX_NO_PACKSPECS];
353 /** error protection methods for packets (0,1,16,32,37-128) */
354 int jpwl_pprot[JPWL_MAX_NO_PACKSPECS];
355 /** enables writing of ESD, (0=no/1/2 bytes) */
357 /** sensitivity addressing size (0=auto/2/4 bytes) */
359 /** sensitivity range (0-3) */
361 /** sensitivity method for MH (-1=no,0-7) */
363 /** tile number of sensitivity specification (>=0) */
364 int jpwl_sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
365 /** sensitivity methods for TPHs (-1=no,0-7) */
366 int jpwl_sens_TPH[JPWL_MAX_NO_TILESPECS];
370 /** Digital Cinema compliance 0-not compliant, 1-compliant*/
371 OPJ_CINEMA_MODE cp_cinema;
372 /** Maximum rate for each component. If == 0, component size limitation is not considered */
375 OPJ_RSIZ_CAPABILITIES cp_rsiz;
376 /** Tile part generation*/
378 /** Flag for Tile part generation*/
380 /** MCT (multiple component transform) */
382 /** Enable JPIP indexing*/
384 /** Naive implementation of MCT restricted to a single reversible array based encoding without offset concerning all the components. */
388 #define OPJ_DPARAMETERS_IGNORE_PCLR_CMAP_CDEF_FLAG 0x0001
391 * Decompression parameters
393 typedef struct opj_dparameters {
395 Set the number of highest resolution levels to be discarded.
396 The image resolution is effectively divided by 2 to the power of the number of discarded levels.
397 The reduce factor is limited by the smallest total number of decomposition levels among tiles.
398 if != 0, then original dimension divided by 2^(reduce);
399 if == 0 or not used, image is decoded to the full resolution
401 OPJ_UINT32 cp_reduce;
403 Set the maximum number of quality layers to decode.
404 If there are less quality layers than the specified number, all the quality layers are decoded.
405 if != 0, then only the first "layer" layers are decoded;
406 if == 0 or not used, all the quality layers are decoded
410 /**@name command line decoder parameters (not used inside the library) */
412 /** input file name */
413 char infile[OPJ_PATH_LEN];
414 /** output file name */
415 char outfile[OPJ_PATH_LEN];
416 /** input file format 0: J2K, 1: JP2, 2: JPT */
418 /** output file format 0: PGX, 1: PxM, 2: BMP */
421 /** Decoding area left boundary */
423 /** Decoding area right boundary */
425 /** Decoding area up boundary */
427 /** Decoding area bottom boundary */
432 /** tile number ot the decoded tile*/
433 OPJ_UINT32 tile_index;
434 /** Nb of tile to decode */
435 OPJ_UINT32 nb_tile_to_decode;
440 /**@name JPWL decoding parameters */
442 /** activates the JPWL correction capabilities */
443 opj_bool jpwl_correct;
444 /** expected number of components */
446 /** maximum number of tiles */
461 typedef void * opj_codec_t;
464 ==========================================================
465 I/O stream typedef definitions
466 ==========================================================
472 /** The stream was opened for reading. */
473 #define OPJ_STREAM_READ OPJ_TRUE
474 /** The stream was opened for writing. */
475 #define OPJ_STREAM_WRITE OPJ_FALSE
478 * Callback function prototype for read function
481 typedef OPJ_SIZE_T (* opj_stream_read_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
484 * Callback function prototype for write function
487 typedef OPJ_SIZE_T (* opj_stream_write_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
490 * Callback function prototype for skip function
493 typedef OPJ_OFF_T (* opj_stream_skip_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ;
496 * Callback function prototype for seek function
499 typedef opj_bool (* opj_stream_seek_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ;
504 typedef void * opj_stream_t;
507 ==========================================================
508 image typedef definitions
509 ==========================================================
513 * Defines a single image component
515 typedef struct opj_image_comp {
516 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
518 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
524 /** x component offset compared to the whole image */
526 /** y component offset compared to the whole image */
530 /** image depth in bits */
532 /** signed (1) / unsigned (0) */
534 /** number of decoded resolution */
535 OPJ_UINT32 resno_decoded;
536 /** number of division by 2 of the out image compared to the original size of image */
538 /** image component data */
543 * Defines image data and characteristics
545 typedef struct opj_image {
546 /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
548 /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
550 /** Xsiz: width of the reference grid */
552 /** Ysiz: height of the reference grid */
554 /** number of components in the image */
556 /** color space: sRGB, Greyscale or YUV */
557 OPJ_COLOR_SPACE color_space;
558 /** image components */
559 opj_image_comp_t *comps;
560 /** 'restricted' ICC profile */
561 OPJ_BYTE *icc_profile_buf;
562 /** size of ICC profile */
563 OPJ_UINT32 icc_profile_len;
568 * Component parameters structure used by the opj_image_create function
570 typedef struct opj_image_comptparm {
571 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
573 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
579 /** x component offset compared to the whole image */
581 /** y component offset compared to the whole image */
585 /** image depth in bits */
587 /** signed (1) / unsigned (0) */
589 } opj_image_cmptparm_t;
593 ==========================================================
594 Information on the JPEG 2000 codestream
595 ==========================================================
599 * Index structure : Information concerning a packet inside tile
601 typedef struct opj_packet_info {
602 /** packet start position (including SOP marker if it exists) */
604 /** end of packet header position (including EPH marker if it exists)*/
605 OPJ_OFF_T end_ph_pos;
606 /** packet end position */
608 /** packet distorsion */
617 typedef struct opj_marker_info {
619 unsigned short int type;
620 /** position in codestream */
622 /** length, marker val included */
628 * Index structure : Information concerning tile-parts
630 typedef struct opj_tp_info {
631 /** start position of tile part */
633 /** end position of tile part header */
635 /** end position of tile part */
637 /** start packet of tile part */
639 /** number of packets of tile part */
644 * Index structure : information regarding tiles
646 typedef struct opj_tile_info {
647 /** value of thresh for each layer by tile cfr. Marcela */
649 /** number of tile */
651 /** start position */
653 /** end position of the header */
657 /** precinct number for each resolution level (width) */
659 /** precinct number for each resolution level (height) */
661 /** precinct size (in power of 2), in X for each resolution level */
663 /** precinct size (in power of 2), in Y for each resolution level */
665 /** information concerning packets inside tile */
666 opj_packet_info_t *packet;
667 /** add fixed_quality */
669 /** add fixed_quality */
671 /** number of markers */
673 /** list of markers */
674 opj_marker_info_t *marker;
675 /** actual size of markers array */
677 /** number of tile parts */
679 /** information concerning tile parts */
684 * Index structure of the codestream
686 typedef struct opj_codestream_info {
687 /** maximum distortion reduction on the whole image (add for Marcela) */
691 /** writing the packet in the index with t2_encode_packets */
697 /** progression order */
699 /** tile size in x */
701 /** tile size in y */
707 /** number of tiles in X */
709 /** number of tiles in Y */
711 /** component numbers */
713 /** number of layer */
715 /** number of decomposition for each component */
718 /** number of markers */
720 /** list of markers */
721 opj_marker_info_t *marker;
722 /** actual size of markers array */
725 /** main header position */
727 /** main header position */
729 /** codestream's size */
731 /** information regarding tiles inside image */
732 opj_tile_info_t *tile;
733 } opj_codestream_info_t;
735 /* <----------------------------------------------------------- */
736 /* new output managment of the codestream information and index */
739 * Tile-component coding parameters information
741 typedef struct opj_tccp_info
743 /** component index */
747 /** number of resolutions */
748 OPJ_UINT32 numresolutions;
749 /** code-blocks width */
751 /** code-blocks height */
753 /** code-block coding style */
755 /** discrete wavelet transform identifier */
757 /** quantisation style */
759 /** stepsizes used for quantization */
760 OPJ_UINT32 stepsizes_mant[OPJ_J2K_MAXBANDS];
761 /** stepsizes used for quantization */
762 OPJ_UINT32 stepsizes_expn[OPJ_J2K_MAXBANDS];
763 /** number of guard bits */
765 /** Region Of Interest shift */
767 /** precinct width */
768 OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
769 /** precinct height */
770 OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
775 * Tile coding parameters information
777 typedef struct opj_tile_v2_info {
779 /** number (index) of tile */
783 /** progression order */
785 /** number of layers */
786 OPJ_UINT32 numlayers;
787 /** multi-component transform identifier */
790 /** information concerning tile component parameters*/
791 opj_tccp_info_t *tccp_info;
793 } opj_tile_info_v2_t;
796 * Information structure about the codestream (FIXME should be expand and enhance)
798 typedef struct opj_codestream_info_v2 {
800 /** tile origin in x = XTOsiz */
802 /** tile origin in y = YTOsiz */
804 /** tile size in x = XTsiz */
806 /** tile size in y = YTsiz */
808 /** number of tiles in X */
810 /** number of tiles in Y */
813 /** number of components*/
816 /** Default information regarding tiles inside image */
817 opj_tile_info_v2_t m_default_tile_info;
819 /** information regarding tiles inside image */
820 opj_tile_info_v2_t *tile_info; /* FIXME not used for the moment */
822 } opj_codestream_info_v2_t;
826 * Index structure about a tile part
828 typedef struct opj_tp_index {
829 /** start position */
831 /** end position of the header */
832 OPJ_OFF_T end_header;
839 * Index structure about a tile
841 typedef struct opj_tile_index {
845 /** number of tile parts */
847 /** current nb of tile part (allocated)*/
848 OPJ_UINT32 current_nb_tps;
849 /** current tile-part index */
850 OPJ_UINT32 current_tpsno;
851 /** information concerning tile parts */
852 opj_tp_index_t *tp_index;
855 /** number of markers */
857 /** list of markers */
858 opj_marker_info_t *marker;
859 /** actual size of markers array */
860 OPJ_UINT32 maxmarknum;
864 OPJ_UINT32 nb_packet;
865 /** information concerning packets inside tile */
866 opj_packet_info_t *packet_index;
871 * Index structure of the codestream (FIXME should be expand and enhance)
873 typedef struct opj_codestream_index {
874 /** main header start position (SOC position) */
875 OPJ_OFF_T main_head_start;
876 /** main header end position (first SOT position) */
877 OPJ_OFF_T main_head_end;
879 /** codestream's size */
880 OPJ_UINT64 codestream_size;
883 /** number of markers */
885 /** list of markers */
886 opj_marker_info_t *marker;
887 /** actual size of markers array */
888 OPJ_UINT32 maxmarknum;
892 OPJ_UINT32 nb_of_tiles;
894 opj_tile_index_t *tile_index; /* FIXME not used for the moment */
896 }opj_codestream_index_t;
897 /* -----------------------------------------------------------> */
900 ==========================================================
901 Metadata from the JP2file
902 ==========================================================
906 * Info structure of the JP2 file
909 typedef struct opj_jp2_metadata {
913 } opj_jp2_metadata_t;
916 * Index structure of the JP2 file
919 typedef struct opj_jp2_index {
932 ==========================================================
934 ==========================================================
937 OPJ_API const char * OPJ_CALLCONV opj_version(void);
940 ==========================================================
941 image functions definitions
942 ==========================================================
947 * @param numcmpts number of components
948 * @param cmptparms components parameters
949 * @param clrspc image color space
950 * @return returns a new image structure if successful, returns NULL otherwise
952 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(OPJ_UINT32 numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
955 * Deallocate any resources associated with an image
956 * @param image image to be destroyed
958 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
962 * Creates an image without allocating memory for the image (used in the new version of the library).
964 * @param numcmpts the number of components
965 * @param cmptparms the components parameters
966 * @param clrspc the image color space
968 * @return a new image structure if successful, NULL otherwise.
970 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_tile_create(OPJ_UINT32 numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
974 ==========================================================
975 stream functions definitions
976 ==========================================================
980 * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
982 * @param p_is_input if set to true then the stream will be an input stream, an output stream else.
984 * @return a stream object.
986 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_default_create(opj_bool p_is_input);
989 * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
991 * @param p_buffer_size FIXME DOC
992 * @param p_is_input if set to true then the stream will be an input stream, an output stream else.
994 * @return a stream object.
996 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create(OPJ_SIZE_T p_buffer_size, opj_bool p_is_input);
999 * Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must
1000 * close its own implementation of the stream.
1002 * @param p_stream the stream to destroy.
1004 OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream);
1007 * Sets the given function to be used as a read function.
1008 * @param p_stream the stream to modify
1009 * @param p_function the function to use a read function.
1011 OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream, opj_stream_read_fn p_function);
1014 * Sets the given function to be used as a write function.
1015 * @param p_stream the stream to modify
1016 * @param p_function the function to use a write function.
1018 OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream, opj_stream_write_fn p_function);
1021 * Sets the given function to be used as a skip function.
1022 * @param p_stream the stream to modify
1023 * @param p_function the function to use a skip function.
1025 OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream, opj_stream_skip_fn p_function);
1028 * Sets the given function to be used as a seek function, the stream is then seekable.
1029 * @param p_stream the stream to modify
1030 * @param p_function the function to use a skip function.
1032 OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream, opj_stream_seek_fn p_function);
1035 * Sets the given data to be used as a user data for the stream.
1036 * @param p_stream the stream to modify
1037 * @param p_data the data to set.
1039 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data (opj_stream_t* p_stream, void * p_data);
1042 * Sets the length of the user data for the stream.
1044 * @param p_stream the stream to modify
1045 * @param data_length length of the user_data.
1047 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data_length(opj_stream_t* p_stream, OPJ_UINT64 data_length);
1051 * Sets the stream to be a file stream. The FILE must have been open previously.
1052 * @param p_file the file stream to operate on
1053 * @param p_is_read_stream whether the stream is a read stream (true) or not (false)
1055 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream (FILE * p_file, opj_bool p_is_read_stream);
1059 * @param p_file the file stream to operate on
1060 * @param p_buffer_size FIXME DOC
1061 * @param p_is_read_stream FIXME DOC
1063 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream (FILE * p_file, OPJ_SIZE_T p_buffer_size, opj_bool p_is_read_stream);
1066 ==========================================================
1067 event manager functions definitions
1068 ==========================================================
1071 * Set the info handler use by openjpeg.
1072 * @param p_codec the codec previously initialise
1073 * @param p_callback the callback function which will be used
1074 * @param p_user_data FIXME DOC
1076 OPJ_API opj_bool OPJ_CALLCONV opj_set_info_handler(opj_codec_t * p_codec,
1077 opj_msg_callback p_callback,
1078 void * p_user_data);
1080 * Set the warning handler use by openjpeg.
1081 * @param p_codec the codec previously initialise
1082 * @param p_callback the callback function which will be used
1083 * @param p_user_data FIXME DOC
1085 OPJ_API opj_bool OPJ_CALLCONV opj_set_warning_handler(opj_codec_t * p_codec,
1086 opj_msg_callback p_callback,
1087 void * p_user_data);
1089 * Set the error handler use by openjpeg.
1090 * @param p_codec the codec previously initialise
1091 * @param p_callback the callback function which will be used
1092 * @param p_user_data FIXME DOC
1094 OPJ_API opj_bool OPJ_CALLCONV opj_set_error_handler(opj_codec_t * p_codec,
1095 opj_msg_callback p_callback,
1096 void * p_user_data);
1099 ==========================================================
1100 codec functions definitions
1101 ==========================================================
1105 * Creates a J2K/JP2 decompression structure
1106 * @param format Decoder to select
1108 * @return Returns a handle to a decompressor if successful, returns NULL otherwise
1110 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format);
1113 * Destroy a decompressor handle
1115 * @param p_codec decompressor handle to destroy
1117 OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec);
1120 * Read after the codestream if necessary
1121 * @param p_codec the JPEG2000 codec to read.
1122 * @param p_stream the JPEG2000 stream.
1124 OPJ_API opj_bool OPJ_CALLCONV opj_end_decompress ( opj_codec_t *p_codec,
1125 opj_stream_t *p_stream);
1129 * Set decoding parameters to default values
1130 * @param parameters Decompression parameters
1132 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters);
1135 * Setup the decoder with decompression parameters provided by the user and with the message handler
1136 * provided by the user.
1138 * @param p_codec decompressor handler
1139 * @param parameters decompression parameters
1141 * @return true if the decoder is correctly set
1143 OPJ_API opj_bool OPJ_CALLCONV opj_setup_decoder(opj_codec_t *p_codec,
1144 opj_dparameters_t *parameters );
1147 * Decodes an image header.
1149 * @param p_stream the jpeg2000 stream.
1150 * @param p_codec the jpeg2000 codec to read.
1151 * @param p_image the image structure initialized with the characteristics of encoded image.
1153 * @return true if the main header of the codestream and the JP2 header is correctly read.
1155 OPJ_API opj_bool OPJ_CALLCONV opj_read_header ( opj_stream_t *p_stream,
1156 opj_codec_t *p_codec,
1157 opj_image_t **p_image);
1160 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
1162 * @param p_codec the jpeg2000 codec.
1163 * @param p_image FIXME DOC
1164 * @param p_start_x the left position of the rectangle to decode (in image coordinates).
1165 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
1166 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
1167 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
1169 * @return true if the area could be set.
1171 OPJ_API opj_bool OPJ_CALLCONV opj_set_decode_area( opj_codec_t *p_codec,
1172 opj_image_t* p_image,
1173 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
1174 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y );
1177 * Decode an image from a JPEG-2000 codestream
1178 * @param p_decompressor decompressor handle
1179 * @param p_stream Input buffer stream
1180 * @param p_image the decoded image
1181 * @return true if success, otherwise false
1183 OPJ_API opj_bool OPJ_CALLCONV opj_decode( opj_codec_t *p_decompressor,
1184 opj_stream_t *p_stream,
1185 opj_image_t *p_image);
1188 * Get the decoded tile from the codec
1189 * @param p_codec the jpeg2000 codec.
1190 * @param p_stream input streamm
1191 * @param p_image output image
1192 * @param tile_index index of the tile which will be decode
1194 * @return true if success, otherwise false
1196 OPJ_API opj_bool OPJ_CALLCONV opj_get_decoded_tile( opj_codec_t *p_codec,
1197 opj_stream_t *p_stream,
1198 opj_image_t *p_image,
1199 OPJ_UINT32 tile_index);
1202 * Set the resolution factor of the decoded image
1203 * @param p_codec the jpeg2000 codec.
1204 * @param res_factor resolution factor to set
1206 * @return true if success, otherwise false
1208 OPJ_API opj_bool OPJ_CALLCONV opj_set_decoded_resolution_factor(opj_codec_t *p_codec, OPJ_UINT32 res_factor);
1211 * Writes a tile with the given data.
1213 * @param p_codec the jpeg2000 codec.
1214 * @param p_tile_index the index of the tile to write. At the moment, the tiles must be written from 0 to n-1 in sequence.
1215 * @param p_data pointer to the data to write. Data is arranged in sequence, data_comp0, then data_comp1, then ... NO INTERLEAVING should be set.
1216 * @param p_data_size this value os used to make sure the data being written is correct. The size must be equal to the sum for each component of tile_width * tile_height * component_size. component_size can be 1,2 or 4 bytes, depending on the precision of the given component.
1217 * @param p_stream the stream to write data to.
1219 * @return true if the data could be written.
1221 OPJ_API opj_bool OPJ_CALLCONV opj_write_tile ( opj_codec_t *p_codec,
1222 OPJ_UINT32 p_tile_index,
1224 OPJ_UINT32 p_data_size,
1225 opj_stream_t *p_stream );
1228 * Reads a tile header. This function is compulsory and allows one to know the size of the tile thta will be decoded.
1229 * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1231 * @param p_codec the jpeg2000 codec.
1232 * @param p_tile_index pointer to a value that will hold the index of the tile being decoded, in case of success.
1233 * @param p_data_size pointer to a value that will hold the maximum size of the decoded data, in case of success. In case
1234 * of truncated codestreams, the actual number of bytes decoded may be lower. The computation of the size is the same
1235 * as depicted in opj_write_tile.
1236 * @param p_tile_x0 pointer to a value that will hold the x0 pos of the tile (in the image).
1237 * @param p_tile_y0 pointer to a value that will hold the y0 pos of the tile (in the image).
1238 * @param p_tile_x1 pointer to a value that will hold the x1 pos of the tile (in the image).
1239 * @param p_tile_y1 pointer to a value that will hold the y1 pos of the tile (in the image).
1240 * @param p_nb_comps pointer to a value that will hold the number of components in the tile.
1241 * @param p_should_go_on pointer to a boolean that will hold the fact that the decoding should go on. In case the
1242 * codestream is over at the time of the call, the value will be set to false. The user should then stop
1244 * @param p_stream the stream to decode.
1245 * @return true if the tile header could be decoded. In case the decoding should end, the returned value is still true.
1246 * returning false may be the result of a shortage of memory or an internal error.
1248 OPJ_API opj_bool OPJ_CALLCONV opj_read_tile_header( opj_codec_t *p_codec,
1249 opj_stream_t * p_stream,
1250 OPJ_UINT32 * p_tile_index,
1251 OPJ_UINT32 * p_data_size,
1252 OPJ_INT32 * p_tile_x0, OPJ_INT32 * p_tile_y0,
1253 OPJ_INT32 * p_tile_x1, OPJ_INT32 * p_tile_y1,
1254 OPJ_UINT32 * p_nb_comps,
1255 opj_bool * p_should_go_on );
1258 * Reads a tile data. This function is compulsory and allows one to decode tile data. opj_read_tile_header should be called before.
1259 * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1261 * @param p_codec the jpeg2000 codec.
1262 * @param p_tile_index the index of the tile being decoded, this should be the value set by opj_read_tile_header.
1263 * @param p_data pointer to a memory block that will hold the decoded data.
1264 * @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.
1265 * @param p_stream the stream to decode.
1267 * @return true if the data could be decoded.
1269 OPJ_API opj_bool OPJ_CALLCONV opj_decode_tile_data( opj_codec_t *p_codec,
1270 OPJ_UINT32 p_tile_index,
1272 OPJ_UINT32 p_data_size,
1273 opj_stream_t *p_stream );
1275 /* COMPRESSION FUNCTIONS*/
1278 * Creates a J2K/JP2 compression structure
1279 * @param format Coder to select
1280 * @return Returns a handle to a compressor if successful, returns NULL otherwise
1282 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
1285 Set encoding parameters to default values, that means :
1289 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
1290 <li>Size of code-block : 64 x 64
1291 <li>Number of resolutions: 6
1292 <li>No SOP marker in the codestream
1293 <li>No EPH marker in the codestream
1294 <li>No sub-sampling in x or y direction
1295 <li>No mode switch activated
1296 <li>Progression order: LRCP
1298 <li>No ROI upshifted
1299 <li>No offset of the origin of the image
1300 <li>No offset of the origin of the tiles
1301 <li>Reversible DWT 5-3
1303 @param parameters Compression parameters
1305 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(opj_cparameters_t *parameters);
1308 * Setup the encoder parameters using the current image and using user parameters.
1309 * @param p_codec Compressor handle
1310 * @param parameters Compression parameters
1311 * @param image Input filled image
1313 OPJ_API opj_bool OPJ_CALLCONV opj_setup_encoder(opj_codec_t *p_codec,
1314 opj_cparameters_t *parameters,
1315 opj_image_t *image);
1319 OPJ_API opj_bool OPJ_CALLCONV opj_start_compress ( opj_codec_t *p_codec,
1320 opj_image_t * p_image,
1321 opj_stream_t *p_cio);
1325 OPJ_API opj_bool OPJ_CALLCONV opj_end_compress (opj_codec_t *p_codec,
1326 opj_stream_t *p_stream);
1329 * Encode an image into a JPEG-2000 codestream
1330 * @param p_codec compressor handle
1331 * @param p_stream Output buffer stream
1333 * @return Returns true if successful, returns false otherwise
1335 OPJ_API opj_bool OPJ_CALLCONV opj_encode(opj_codec_t *p_codec,
1336 opj_stream_t *p_stream);
1340 Destroy Codestream information after compression or decompression
1341 @param cstr_info Codestream information structure
1343 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_v2_t **cstr_info);
1348 ==========================================================
1349 codec output functions definitions
1350 ==========================================================
1354 * Dump the codec information into the output stream
1356 * @param p_codec the jpeg2000 codec.
1357 * @param info_flag type of information dump.
1358 * @param output_stream output stream where dump the informations get from the codec.
1361 OPJ_API void OPJ_CALLCONV opj_dump_codec( opj_codec_t *p_codec,
1362 OPJ_INT32 info_flag,
1363 FILE* output_stream);
1366 * Get the codestream information from the codec
1368 * @param p_codec the jpeg2000 codec.
1370 * @return a pointer to a codestream information structure.
1373 OPJ_API opj_codestream_info_v2_t* OPJ_CALLCONV opj_get_cstr_info(opj_codec_t *p_codec);
1376 * Get the codestream index from the codec
1378 * @param p_codec the jpeg2000 codec.
1380 * @return a pointer to a codestream index structure.
1383 OPJ_API opj_codestream_index_t * OPJ_CALLCONV opj_get_cstr_index(opj_codec_t *p_codec);
1385 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_index(opj_codestream_index_t **p_cstr_index);
1389 * Get the JP2 file information from the codec FIXME
1391 * @param p_codec the jpeg2000 codec.
1393 * @return a pointer to a JP2 metadata structure.
1396 OPJ_API opj_jp2_metadata_t* OPJ_CALLCONV opj_get_jp2_metadata(opj_codec_t *p_codec);
1399 * Get the JP2 file index from the codec FIXME
1401 * @param p_codec the jpeg2000 codec.
1403 * @return a pointer to a JP2 index structure.
1406 OPJ_API opj_jp2_index_t* OPJ_CALLCONV opj_get_jp2_index(opj_codec_t *p_codec);
1410 ==========================================================
1412 ==========================================================
1416 * Sets the MCT matrix to use.
1418 * @param parameters the parameters to change.
1419 * @param pEncodingMatrix the encoding matrix.
1420 * @param p_dc_shift the dc shift coefficients to use.
1421 * @param pNbComp the number of components of the image.
1423 * @return true if the parameters could be set.
1425 OPJ_API opj_bool OPJ_CALLCONV opj_set_MCT( opj_cparameters_t *parameters,
1426 OPJ_FLOAT32 * pEncodingMatrix,
1427 OPJ_INT32 * p_dc_shift,
1428 OPJ_UINT32 pNbComp);
1436 #endif /* OPENJPEG_H */