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 char OPJ_CHAR;
80 typedef float OPJ_FLOAT32;
81 typedef double OPJ_FLOAT64;
82 typedef unsigned char OPJ_BYTE;
84 #include "opj_stdint.h"
86 typedef int8_t OPJ_INT8;
87 typedef uint8_t OPJ_UINT8;
88 typedef int16_t OPJ_INT16;
89 typedef uint16_t OPJ_UINT16;
90 typedef int32_t OPJ_INT32;
91 typedef uint32_t OPJ_UINT32;
92 typedef int64_t OPJ_INT64;
93 typedef uint64_t OPJ_UINT64;
95 /* Avoid compile-time warning because parameter is not used */
96 #define OPJ_ARG_NOT_USED(x) (void)(x)
99 ==========================================================
100 Useful constant definitions
101 ==========================================================
104 #define OPJ_PATH_LEN 4096 /**< Maximum allowed size for filenames */
106 #define J2K_MAXRLVLS 33 /**< Number of maximum resolution level authorized */
107 #define J2K_MAXBANDS (3*J2K_MAXRLVLS-2) /**< Number of maximum sub-band linked to number of resolution level */
109 #define J2K_DEFAULT_NB_SEGS 10
110 #define J2K_STREAM_CHUNK_SIZE 0x100000 /** 1 mega by default */
111 #define J2K_DEFAULT_HEADER_SIZE 1000
112 #define J2K_MCC_DEFAULT_NB_RECORDS 10
113 #define J2K_MCT_DEFAULT_NB_RECORDS 10
116 #define JPWL_MAX_NO_TILESPECS 16 /**< Maximum number of tile parts expected by JPWL: increase at your will */
117 #define JPWL_MAX_NO_PACKSPECS 16 /**< Maximum number of packet parts expected by JPWL: increase at your will */
118 #define JPWL_MAX_NO_MARKERS 512 /**< Maximum number of JPWL markers: increase at your will */
119 #define JPWL_PRIVATEINDEX_NAME "jpwl_index_privatefilename" /**< index file name used when JPWL is on */
120 #define JPWL_EXPECTED_COMPONENTS 3 /**< Expect this number of components, so you'll find better the first EPB */
121 #define JPWL_MAXIMUM_TILES 8192 /**< Expect this maximum number of tiles, to avoid some crashes */
122 #define JPWL_MAXIMUM_HAMMING 2 /**< Expect this maximum number of bit errors in marker id's */
123 #define JPWL_MAXIMUM_EPB_ROOM 65450 /**< Expect this maximum number of bytes for composition of EPBs */
127 * FIXME EXPERIMENTAL FOR THE MOMENT
128 * Supported options about file information
130 #define OPJ_IMG_INFO 1 /**< Basic image information provided to the user */
131 #define OPJ_J2K_MH_INFO 2 /**< Codestream information based only on the main header */
132 #define OPJ_J2K_TH_INFO 4 /**< Tile information based on the current tile header */
133 /*FIXME #define OPJ_J2K_CSTR_INFO 6*/ /**< */
134 #define OPJ_J2K_MH_IND 16 /**< Codestream index based only on the main header */
135 #define OPJ_J2K_TH_IND 32 /**< Tile index based on the current tile */
136 /*FIXME #define OPJ_J2K_CSTR_IND 48*/ /**< */
137 #define OPJ_JP2_INFO 128 /**< JP2 file information */
138 #define OPJ_JP2_IND 256 /**< JP2 file index */
142 ==========================================================
144 ==========================================================
149 typedef enum RSIZ_CAPABILITIES {
150 STD_RSIZ = 0, /** Standard JPEG2000 profile*/
151 CINEMA2K = 3, /** Profile name for a 2K image*/
152 CINEMA4K = 4, /** Profile name for a 4K image*/
154 } OPJ_RSIZ_CAPABILITIES;
157 * Digital cinema operation mode
159 typedef enum CINEMA_MODE {
160 OFF = 0, /** Not Digital Cinema*/
161 CINEMA2K_24 = 1, /** 2K Digital Cinema at 24 fps*/
162 CINEMA2K_48 = 2, /** 2K Digital Cinema at 48 fps*/
163 CINEMA4K_24 = 3 /** 4K Digital Cinema at 24 fps*/
169 typedef enum PROG_ORDER {
170 PROG_UNKNOWN = -1, /**< place-holder */
171 LRCP = 0, /**< layer-resolution-component-precinct order */
172 RLCP = 1, /**< resolution-layer-component-precinct order */
173 RPCL = 2, /**< resolution-precinct-component-layer order */
174 PCRL = 3, /**< precinct-component-resolution-layer order */
175 CPRL = 4 /**< component-precinct-resolution-layer order */
179 * Supported image color spaces
181 typedef enum COLOR_SPACE {
182 CLRSPC_UNKNOWN = -1, /**< not supported by the library */
183 CLRSPC_UNSPECIFIED = 0, /**< not specified in the codestream */
184 CLRSPC_SRGB = 1, /**< sRGB */
185 CLRSPC_GRAY = 2, /**< grayscale */
186 CLRSPC_SYCC = 3 /**< YUV */
192 typedef enum CODEC_FORMAT {
193 CODEC_UNKNOWN = -1, /**< place-holder */
194 CODEC_J2K = 0, /**< JPEG-2000 codestream : read/write */
195 CODEC_JPT = 1, /**< JPT-stream (JPEG 2000, JPIP) : read only */
196 CODEC_JP2 = 2 /**< JPEG-2000 file format : read/write */
200 * Limit decoding to certain portions of the codestream.
202 typedef enum LIMIT_DECODING {
203 NO_LIMITATION = 0, /**< No limitation for the decoding. The entire codestream will de decoded */
204 LIMIT_TO_MAIN_HEADER = 1, /**< The decoding is limited to the Main Header */
205 DECODE_ALL_BUT_PACKETS = 2 /**< Decode everything except the JPEG 2000 packets */
206 } OPJ_LIMIT_DECODING;
210 ==========================================================
211 event manager typedef definitions
212 ==========================================================
216 * Callback function prototype for events
217 * @param msg Event message
220 typedef void (*opj_msg_callback) (const char *msg, void *client_data);
224 /** SHOULD BE MOVE IN EVET.H when we remove old functions TODO MSD
225 Message handler object
230 <li>Debugging messages
233 typedef struct opj_event_mgr
235 /** Data to call the event manager upon */
237 /** Data to call the event manager upon */
238 void * m_warning_data;
239 /** Data to call the event manager upon */
241 /** Error message callback if available, NULL otherwise */
242 opj_msg_callback error_handler;
243 /** Warning message callback if available, NULL otherwise */
244 opj_msg_callback warning_handler;
245 /** Debug message callback if available, NULL otherwise */
246 opj_msg_callback info_handler;
250 ==========================================================
251 codec typedef definitions
252 ==========================================================
256 * Progression order changes
259 typedef struct opj_poc {
260 /** Resolution num start, Component num start, given by POC */
261 OPJ_UINT32 resno0, compno0;
262 /** Layer num end,Resolution num end, Component num end, given by POC */
263 OPJ_UINT32 layno1, resno1, compno1;
264 /** Layer num start,Precinct num start, Precinct num end */
265 int layno0, precno0, precno1;
266 /** Progression order enum*/
267 OPJ_PROG_ORDER prg1,prg;
268 /** Progression order string*/
272 /** Start and end values for Tile width and height*/
274 /** Start value, initialised in pi_initialise_encode*/
275 int layS, resS, compS, prcS;
276 /** End value, initialised in pi_initialise_encode */
277 int layE, resE, compE, prcE;
278 /** Start and end values of Tile width and height, initialised in pi_initialise_encode*/
279 int txS,txE,tyS,tyE,dx,dy;
280 /** Temporary values for Tile parts, initialised in pi_create_encode */
281 int lay_t, res_t, comp_t, prc_t,tx0_t,ty0_t;
285 * Compression parameters
287 typedef struct opj_cparameters {
288 /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */
289 opj_bool tile_size_on;
298 /** allocation by rate/distortion */
300 /** allocation by fixed layer */
302 /** add fixed_quality */
303 int cp_fixed_quality;
306 /** comment for coding */
308 /** csty : coding style */
310 /** progression order (default LRCP) */
311 OPJ_PROG_ORDER prog_order;
312 /** progression order changes */
314 /** number of progression order changes (POC), default to 0 */
316 /** number of layers */
318 /** rates of layers */
319 float tcp_rates[100];
320 /** different psnr for successive layers */
321 float tcp_distoratio[100];
322 /** number of resolutions */
324 /** initial code block width, default to 64 */
326 /** initial code block height, default to 64 */
328 /** mode switch (cblk_style) */
330 /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
332 /** region of interest: affected component in [0..3], -1 means no ROI */
334 /** region of interest: upshift value */
336 /* number of precinct size specifications */
338 /** initial precinct width */
339 int prcw_init[J2K_MAXRLVLS];
340 /** initial precinct height */
341 int prch_init[J2K_MAXRLVLS];
343 /**@name command line encoder parameters (not used inside the library) */
345 /** input file name */
346 char infile[OPJ_PATH_LEN];
347 /** output file name */
348 char outfile[OPJ_PATH_LEN];
349 /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
351 /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
352 char index[OPJ_PATH_LEN];
353 /** subimage encoding: origin image offset in x direction */
355 /** subimage encoding: origin image offset in y direction */
357 /** subsampling value for dx */
359 /** subsampling value for dy */
361 /** input file format 0: PGX, 1: PxM, 2: BMP 3:TIF*/
363 /** output file format 0: J2K, 1: JP2, 2: JPT */
368 /**@name JPWL encoding parameters */
370 /** enables writing of EPC in MH, thus activating JPWL */
371 opj_bool jpwl_epc_on;
372 /** error protection method for MH (0,1,16,32,37-128) */
374 /** tile number of header protection specification (>=0) */
375 int jpwl_hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
376 /** error protection methods for TPHs (0,1,16,32,37-128) */
377 int jpwl_hprot_TPH[JPWL_MAX_NO_TILESPECS];
378 /** tile number of packet protection specification (>=0) */
379 int jpwl_pprot_tileno[JPWL_MAX_NO_PACKSPECS];
380 /** packet number of packet protection specification (>=0) */
381 int jpwl_pprot_packno[JPWL_MAX_NO_PACKSPECS];
382 /** error protection methods for packets (0,1,16,32,37-128) */
383 int jpwl_pprot[JPWL_MAX_NO_PACKSPECS];
384 /** enables writing of ESD, (0=no/1/2 bytes) */
386 /** sensitivity addressing size (0=auto/2/4 bytes) */
388 /** sensitivity range (0-3) */
390 /** sensitivity method for MH (-1=no,0-7) */
392 /** tile number of sensitivity specification (>=0) */
393 int jpwl_sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
394 /** sensitivity methods for TPHs (-1=no,0-7) */
395 int jpwl_sens_TPH[JPWL_MAX_NO_TILESPECS];
399 /** Digital Cinema compliance 0-not compliant, 1-compliant*/
400 OPJ_CINEMA_MODE cp_cinema;
401 /** Maximum rate for each component. If == 0, component size limitation is not considered */
404 OPJ_RSIZ_CAPABILITIES cp_rsiz;
405 /** Tile part generation*/
407 /** Flag for Tile part generation*/
409 /** MCT (multiple component transform) */
411 /** Enable JPIP indexing*/
413 /** Naive implementation of MCT restricted to a single reversible array based encoding without offset concerning all the components. */
418 #define OPJ_DPARAMETERS_IGNORE_PCLR_CMAP_CDEF_FLAG 0x0001
421 * Decompression parameters
423 typedef struct opj_dparameters {
425 Set the number of highest resolution levels to be discarded.
426 The image resolution is effectively divided by 2 to the power of the number of discarded levels.
427 The reduce factor is limited by the smallest total number of decomposition levels among tiles.
428 if != 0, then original dimension divided by 2^(reduce);
429 if == 0 or not used, image is decoded to the full resolution
433 Set the maximum number of quality layers to decode.
434 If there are less quality layers than the specified number, all the quality layers are decoded.
435 if != 0, then only the first "layer" layers are decoded;
436 if == 0 or not used, all the quality layers are decoded
440 /**@name command line decoder parameters (not used inside the library) */
442 /** input file name */
443 char infile[OPJ_PATH_LEN];
444 /** output file name */
445 char outfile[OPJ_PATH_LEN];
446 /** input file format 0: J2K, 1: JP2, 2: JPT */
448 /** output file format 0: PGX, 1: PxM, 2: BMP */
451 /** Decoding area left boundary */
453 /** Decoding area right boundary */
455 /** Decoding area up boundary */
457 /** Decoding area bottom boundary */
462 /** tile number ot the decoded tile*/
463 OPJ_UINT32 tile_index;
464 /** Nb of tile to decode */
465 OPJ_UINT32 nb_tile_to_decode;
470 /**@name JPWL decoding parameters */
472 /** activates the JPWL correction capabilities */
473 opj_bool jpwl_correct;
474 /** expected number of components */
476 /** maximum number of tiles */
482 Specify whether the decoding should be done on the entire codestream, or be limited to the main header
483 Limiting the decoding to the main header makes it possible to extract the characteristics of the codestream
484 if == NO_LIMITATION, the entire codestream is decoded;
485 if == LIMIT_TO_MAIN_HEADER, only the main header is decoded;
487 OPJ_LIMIT_DECODING cp_limit_decoding;
493 /* ---> FIXME V1 style */
494 /** Common fields between JPEG-2000 compression and decompression master structs. */
496 #define opj_common_fields \
497 opj_event_mgr_t *event_mgr; /**< pointer to the event manager */\
498 void * client_data; /**< Available for use by application */\
499 opj_bool is_decompressor; /**< So common code can tell which is which */\
500 OPJ_CODEC_FORMAT codec_format; /**< selected codec */\
501 void *j2k_handle; /**< pointer to the J2K codec */\
502 void *jp2_handle; /**< pointer to the JP2 codec */\
503 void *mj2_handle /**< pointer to the MJ2 codec */
505 /* Routines that are to be used by both halves of the library are declared
506 * to receive a pointer to this structure. There are no actual instances of
507 * opj_common_struct_t, only of opj_cinfo_t and opj_dinfo_t.
509 typedef struct opj_common_struct {
510 opj_common_fields; /* Fields common to both master struct types */
511 /* Additional fields follow in an actual opj_cinfo_t or
512 * opj_dinfo_t. All three structs must agree on these
513 * initial fields! (This would be a lot cleaner in C++.)
515 } opj_common_struct_t;
517 typedef opj_common_struct_t * opj_common_ptr;
520 * Compression context info
522 typedef struct opj_cinfo {
523 /** Fields shared with opj_dinfo_t */
525 /* other specific fields go here */
529 * Decompression context info
531 typedef struct opj_dinfo {
532 /** Fields shared with opj_cinfo_t */
534 /* other specific fields go here */
542 typedef void * opj_codec_t;
545 ==========================================================
546 I/O stream typedef definitions
547 ==========================================================
553 /** The stream was opened for reading. */
554 #define OPJ_STREAM_READ 0x0001
555 /** The stream was opened for writing. */
556 #define OPJ_STREAM_WRITE 0x0002
559 Byte input-output stream (CIO)
562 typedef struct opj_cio {
564 opj_common_ptr cinfo;
566 /** open mode (read/write) either OPJ_STREAM_READ or OPJ_STREAM_WRITE */
568 /** pointer to the start of the buffer */
569 unsigned char *buffer;
570 /** buffer size in bytes */
571 /* FIXME: MM length is 'int' ?? */
574 /** pointer to the start of the stream */
575 unsigned char *start;
576 /** pointer to the end of the stream */
578 /** pointer to the current position */
586 typedef OPJ_SIZE_T (* opj_stream_read_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
587 typedef OPJ_SIZE_T (* opj_stream_write_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
588 typedef OPJ_OFF_T (* opj_stream_skip_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ;
589 typedef opj_bool (* opj_stream_seek_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ;
594 typedef void * opj_stream_t;
597 ==========================================================
598 image typedef definitions
599 ==========================================================
603 * Defines a single image component
605 typedef struct opj_image_comp {
606 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
608 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
614 /** x component offset compared to the whole image */
616 /** y component offset compared to the whole image */
620 /** image depth in bits */
622 /** signed (1) / unsigned (0) */
624 /** number of decoded resolution */
625 OPJ_UINT32 resno_decoded;
626 /** number of division by 2 of the out image compared to the original size of image */
628 /** image component data */
633 * Defines image data and characteristics
635 typedef struct opj_image {
636 /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
638 /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
640 /** Xsiz: width of the reference grid */
642 /** Ysiz: height of the reference grid */
644 /** number of components in the image */
646 /** color space: sRGB, Greyscale or YUV */
647 OPJ_COLOR_SPACE color_space;
648 /** image components */
649 opj_image_comp_t *comps;
650 /** 'restricted' ICC profile */
651 OPJ_BYTE *icc_profile_buf;
652 /** size of ICC profile */
653 OPJ_UINT32 icc_profile_len;
658 * Component parameters structure used by the opj_image_create function
660 typedef struct opj_image_comptparm {
661 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
663 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
669 /** x component offset compared to the whole image */
671 /** y component offset compared to the whole image */
675 /** image depth in bits */
677 /** signed (1) / unsigned (0) */
679 } opj_image_cmptparm_t;
683 ==========================================================
684 Information on the JPEG 2000 codestream
685 ==========================================================
689 * Index structure : Information concerning a packet inside tile
691 typedef struct opj_packet_info {
692 /** packet start position (including SOP marker if it exists) */
694 /** end of packet header position (including EPH marker if it exists)*/
695 OPJ_OFF_T end_ph_pos;
696 /** packet end position */
698 /** packet distorsion */
707 typedef struct opj_marker_info_t {
709 unsigned short int type;
710 /** position in codestream */
712 /** length, marker val included */
718 * Index structure : Information concerning tile-parts
720 typedef struct opj_tp_info {
721 /** start position of tile part */
723 /** end position of tile part header */
725 /** end position of tile part */
727 /** start packet of tile part */
729 /** number of packets of tile part */
734 * Index structure : information regarding tiles
736 typedef struct opj_tile_info {
737 /** value of thresh for each layer by tile cfr. Marcela */
739 /** number of tile */
741 /** start position */
743 /** end position of the header */
747 /** precinct number for each resolution level (width) */
749 /** precinct number for each resolution level (height) */
751 /** precinct size (in power of 2), in X for each resolution level */
753 /** precinct size (in power of 2), in Y for each resolution level */
755 /** information concerning packets inside tile */
756 opj_packet_info_t *packet;
757 /** add fixed_quality */
759 /** add fixed_quality */
761 /** number of markers */
763 /** list of markers */
764 opj_marker_info_t *marker;
765 /** actual size of markers array */
767 /** number of tile parts */
769 /** information concerning tile parts */
774 * Index structure of the codestream
776 typedef struct opj_codestream_info {
777 /** maximum distortion reduction on the whole image (add for Marcela) */
781 /** writing the packet in the index with t2_encode_packets */
787 /** progression order */
789 /** tile size in x */
791 /** tile size in y */
797 /** number of tiles in X */
799 /** number of tiles in Y */
801 /** component numbers */
803 /** number of layer */
805 /** number of decomposition for each component */
808 /** number of markers */
810 /** list of markers */
811 opj_marker_info_t *marker;
812 /** actual size of markers array */
815 /** main header position */
817 /** main header position */
819 /** codestream's size */
821 /** information regarding tiles inside image */
822 opj_tile_info_t *tile;
823 } opj_codestream_info_t;
825 /* <----------------------------------------------------------- */
826 /* new output managment of the codestream information and index */
829 * Tile-component coding parameters information
831 typedef struct opj_tccp_info
833 /** component index */
837 /** number of resolutions */
838 OPJ_UINT32 numresolutions;
839 /** code-blocks width */
841 /** code-blocks height */
843 /** code-block coding style */
845 /** discrete wavelet transform identifier */
847 /** quantisation style */
849 /** stepsizes used for quantization */
850 OPJ_UINT32 stepsizes_mant[J2K_MAXBANDS];
851 /** stepsizes used for quantization */
852 OPJ_UINT32 stepsizes_expn[J2K_MAXBANDS];
853 /** number of guard bits */
855 /** Region Of Interest shift */
857 /** precinct width */
858 OPJ_UINT32 prcw[J2K_MAXRLVLS];
859 /** precinct height */
860 OPJ_UINT32 prch[J2K_MAXRLVLS];
865 * Tile coding parameters information
867 typedef struct opj_tile_v2_info {
869 /** number (index) of tile */
873 /** progression order */
875 /** number of layers */
876 OPJ_UINT32 numlayers;
877 /** multi-component transform identifier */
880 /** information concerning tile component parameters*/
881 opj_tccp_info_t *tccp_info;
883 } opj_tile_info_v2_t;
886 * Information structure about the codestream (FIXME should be expand and enhance)
888 typedef struct opj_codestream_info_v2 {
890 /** tile origin in x = XTOsiz */
892 /** tile origin in y = YTOsiz */
894 /** tile size in x = XTsiz */
896 /** tile size in y = YTsiz */
898 /** number of tiles in X */
900 /** number of tiles in Y */
903 /** number of components*/
906 /** Default information regarding tiles inside image */
907 opj_tile_info_v2_t m_default_tile_info;
909 /** information regarding tiles inside image */
910 opj_tile_info_v2_t *tile_info; /* FIXME not used for the moment */
912 } opj_codestream_info_v2_t;
916 * Index structure about a tile part
918 typedef struct opj_tp_index {
919 /** start position */
921 /** end position of the header */
922 OPJ_OFF_T end_header;
929 * Index structure about a tile
931 typedef struct opj_tile_index {
935 /** number of tile parts */
937 /** current nb of tile part (allocated)*/
938 OPJ_UINT32 current_nb_tps;
939 /** current tile-part index */
940 OPJ_UINT32 current_tpsno;
941 /** information concerning tile parts */
942 opj_tp_index_t *tp_index;
945 /** number of markers */
947 /** list of markers */
948 opj_marker_info_t *marker;
949 /** actual size of markers array */
950 OPJ_UINT32 maxmarknum;
954 OPJ_UINT32 nb_packet;
955 /** information concerning packets inside tile */
956 opj_packet_info_t *packet_index;
961 * Index structure of the codestream (FIXME should be expand and enhance)
963 typedef struct opj_codestream_index {
964 /** main header start position (SOC position) */
965 OPJ_OFF_T main_head_start;
966 /** main header end position (first SOT position) */
967 OPJ_OFF_T main_head_end;
969 /** codestream's size */
970 OPJ_UINT64 codestream_size;
973 /** number of markers */
975 /** list of markers */
976 opj_marker_info_t *marker;
977 /** actual size of markers array */
978 OPJ_UINT32 maxmarknum;
982 OPJ_UINT32 nb_of_tiles;
984 opj_tile_index_t *tile_index; /* FIXME not used for the moment */
986 }opj_codestream_index_t;
987 /* -----------------------------------------------------------> */
990 ==========================================================
991 Metadata from the JP2file
992 ==========================================================
996 * Info structure of the JP2 file
999 typedef struct opj_jp2_metadata {
1003 } opj_jp2_metadata_t;
1006 * Index structure of the JP2 file
1009 typedef struct opj_jp2_index {
1022 ==========================================================
1024 ==========================================================
1027 OPJ_API const char * OPJ_CALLCONV opj_version(void);
1030 ==========================================================
1031 image functions definitions
1032 ==========================================================
1037 * @param numcmpts number of components
1038 * @param cmptparms components parameters
1039 * @param clrspc image color space
1040 * @return returns a new image structure if successful, returns NULL otherwise
1042 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(OPJ_UINT32 numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1045 * Deallocate any resources associated with an image
1046 * @param image image to be destroyed
1048 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
1052 * Creates an image without allocating memory for the image (used in the new version of the library).
1054 * @param p_num_cmpts the number of components
1055 * @param p_cmpt_parms the components parameters
1056 * @param p_clr_spc the image color space
1058 * @return a new image structure if successful, NULL otherwise.
1060 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_tile_create(OPJ_UINT32 numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1064 ==========================================================
1065 stream functions definitions
1066 ==========================================================
1068 /* CIO functions are DEPRECATED see following stream functions */
1070 Open and allocate a memory stream for read / write.
1071 On reading, the user must provide a buffer containing encoded data. The buffer will be
1072 wrapped by the returned CIO handle.
1073 On writing, buffer parameters must be set to 0: a buffer will be allocated by the library
1074 to contain encoded data.
1075 @param cinfo Codec context info
1076 @param buffer Reading: buffer address. Writing: NULL
1077 @param length Reading: buffer length. Writing: 0
1078 @return Returns a CIO handle if successful, returns NULL otherwise
1080 OPJ_API opj_cio_t* OPJ_CALLCONV opj_cio_open(opj_common_ptr cinfo, unsigned char *buffer, int length);
1083 Close and free a CIO handle
1084 @param cio CIO handle to free
1086 OPJ_API void OPJ_CALLCONV opj_cio_close(opj_cio_t *cio);
1089 Get position in byte stream
1090 @param cio CIO handle
1091 @return Returns the position in bytes
1093 OPJ_API OPJ_OFF_T OPJ_CALLCONV cio_tell(opj_cio_t *cio);
1095 Set position in byte stream
1096 @param cio CIO handle
1097 @param pos Position, in number of bytes, from the beginning of the stream
1099 OPJ_API void OPJ_CALLCONV cio_seek(opj_cio_t *cio, int pos);
1105 * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1107 * @param l_is_reader if set to true then the stream will be an input stream, an output stream else.
1109 * @return a stream object.
1111 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_default_create(opj_bool p_is_input);
1112 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create(OPJ_SIZE_T p_buffer_size, opj_bool p_is_input);
1115 * Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must
1116 * close its own implementation of the stream.
1118 * @param p_stream the stream to destroy.
1120 OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream);
1123 * Sets the given function to be used as a read function.
1124 * @param p_stream the stream to modify
1125 * @param p_function the function to use a read function.
1127 OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream, opj_stream_read_fn p_function);
1130 * Sets the given function to be used as a write function.
1131 * @param p_stream the stream to modify
1132 * @param p_function the function to use a write function.
1134 OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream, opj_stream_write_fn p_function);
1137 * Sets the given function to be used as a skip function.
1138 * @param p_stream the stream to modify
1139 * @param p_function the function to use a skip function.
1141 OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream, opj_stream_skip_fn p_function);
1144 * Sets the given function to be used as a seek function, the stream is then seekable.
1145 * @param p_stream the stream to modify
1146 * @param p_function the function to use a skip function.
1148 OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream, opj_stream_seek_fn p_function);
1151 * Sets the given data to be used as a user data for the stream.
1152 * @param p_stream the stream to modify
1153 * @param p_data the data to set.
1155 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data (opj_stream_t* p_stream, void * p_data);
1158 * Sets the length of the user data for the stream.
1159 * @param p_stream the stream to modify
1160 * @param data_length length of the user_data.
1162 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data_length(opj_stream_t* p_stream, OPJ_UINT64 data_length);
1166 * Sets the stream to be a file stream. The FILE must have been open previously.
1167 * @param p_file the file stream to operate on
1168 * @param p_is_read_stream whether the stream is a read stream (true) or not (false)
1170 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream (FILE * p_file, opj_bool p_is_read_stream);
1171 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);
1176 ==========================================================
1177 event manager functions definitions
1178 ==========================================================
1180 OPJ_API opj_bool OPJ_CALLCONV opj_set_info_handler(opj_codec_t * p_codec, opj_msg_callback p_callback,void * p_user_data);
1181 OPJ_API opj_bool OPJ_CALLCONV opj_set_warning_handler(opj_codec_t * p_codec, opj_msg_callback p_callback,void * p_user_data);
1182 OPJ_API opj_bool OPJ_CALLCONV opj_set_error_handler(opj_codec_t * p_codec, opj_msg_callback p_callback,void * p_user_data);
1185 ==========================================================
1186 codec functions definitions
1187 ==========================================================
1191 * Creates a J2K/JP2 decompression structure
1192 * @param format Decoder to select
1194 * @return Returns a handle to a decompressor if successful, returns NULL otherwise
1196 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format);
1199 * Destroy a decompressor handle
1201 * @param p_codec decompressor handle to destroy
1203 OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec);
1206 * Read after the codestream if necessary
1207 * @param p_codec the JPEG2000 codec to read.
1208 * @param p_stream the JPEG2000 stream.
1210 OPJ_API opj_bool OPJ_CALLCONV opj_end_decompress ( opj_codec_t *p_codec,
1211 opj_stream_t *p_stream);
1215 * Set decoding parameters to default values
1216 * @param parameters Decompression parameters
1218 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters);
1221 * Setup the decoder with decompression parameters provided by the user and with the message handler
1222 * provided by the user.
1224 * @param p_codec decompressor handler
1225 * @param parameters decompression parameters
1227 * @return true if the decoder is correctly set
1229 OPJ_API opj_bool OPJ_CALLCONV opj_setup_decoder(opj_codec_t *p_codec,
1230 opj_dparameters_t *parameters );
1233 * Decodes an image header.
1235 * @param p_stream the jpeg2000 stream.
1236 * @param p_codec the jpeg2000 codec to read.
1237 * @param p_image the image structure initialized with the characteristics of encoded image.
1239 * @return true if the main header of the codestream and the JP2 header is correctly read.
1241 OPJ_API opj_bool OPJ_CALLCONV opj_read_header ( opj_stream_t *p_stream,
1242 opj_codec_t *p_codec,
1243 opj_image_t **p_image);
1246 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
1248 * @param p_codec the jpeg2000 codec.
1249 * @param p_start_x the left position of the rectangle to decode (in image coordinates).
1250 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
1251 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
1252 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
1254 * @return true if the area could be set.
1256 OPJ_API opj_bool OPJ_CALLCONV opj_set_decode_area( opj_codec_t *p_codec,
1257 opj_image_t* p_image,
1258 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
1259 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y );
1262 * Decode an image from a JPEG-2000 codestream
1263 * @param p_decompressor decompressor handle
1264 * @param p_stream Input buffer stream
1265 * @param p_image the decoded image
1266 * @return true if success, otherwise false
1268 OPJ_API opj_bool OPJ_CALLCONV opj_decode( opj_codec_t *p_decompressor,
1269 opj_stream_t *p_stream,
1270 opj_image_t *p_image);
1273 * Get the decoded tile from the codec
1274 * @param p_codec the jpeg2000 codec.
1275 * @param p_stream input streamm
1276 * @param p_image output image
1277 * @param tile_index index of the tile which will be decode
1279 * @return true if success, otherwise false
1281 OPJ_API opj_bool OPJ_CALLCONV opj_get_decoded_tile( opj_codec_t *p_codec,
1282 opj_stream_t *p_stream,
1283 opj_image_t *p_image,
1284 OPJ_UINT32 tile_index);
1287 * Set the resolution factor of the decoded image
1288 * @param p_codec the jpeg2000 codec.
1289 * @param res_factor resolution factor to set
1291 * @return true if success, otherwise false
1293 OPJ_API opj_bool OPJ_CALLCONV opj_set_decoded_resolution_factor(opj_codec_t *p_codec, OPJ_UINT32 res_factor);
1296 * Writes a tile with the given data.
1298 * @param p_compressor the jpeg2000 codec.
1299 * @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.
1300 * @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.
1301 * @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,
1302 * depending on the precision of the given component.
1303 * @param p_stream the stream to write data to.
1305 * @return true if the data could be written.
1307 OPJ_API opj_bool OPJ_CALLCONV opj_write_tile ( opj_codec_t *p_codec,
1308 OPJ_UINT32 p_tile_index,
1310 OPJ_UINT32 p_data_size,
1311 opj_stream_t *p_stream );
1314 * Reads a tile header. This function is compulsory and allows one to know the size of the tile thta will be decoded.
1315 * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1317 * @param p_codec the jpeg2000 codec.
1318 * @param p_tile_index pointer to a value that will hold the index of the tile being decoded, in case of success.
1319 * @param p_data_size pointer to a value that will hold the maximum size of the decoded data, in case of success. In case
1320 * of truncated codestreams, the actual number of bytes decoded may be lower. The computation of the size is the same
1321 * as depicted in opj_write_tile.
1322 * @param p_tile_x0 pointer to a value that will hold the x0 pos of the tile (in the image).
1323 * @param p_tile_y0 pointer to a value that will hold the y0 pos of the tile (in the image).
1324 * @param p_tile_x1 pointer to a value that will hold the x1 pos of the tile (in the image).
1325 * @param p_tile_y1 pointer to a value that will hold the y1 pos of the tile (in the image).
1326 * @param p_nb_comps pointer to a value that will hold the number of components in the tile.
1327 * @param p_should_go_on pointer to a boolean that will hold the fact that the decoding should go on. In case the
1328 * codestream is over at the time of the call, the value will be set to false. The user should then stop
1330 * @param p_stream the stream to decode.
1331 * @return true if the tile header could be decoded. In case the decoding should end, the returned value is still true.
1332 * returning false may be the result of a shortage of memory or an internal error.
1334 OPJ_API opj_bool OPJ_CALLCONV opj_read_tile_header( opj_codec_t *p_codec,
1335 opj_stream_t * p_stream,
1336 OPJ_UINT32 * p_tile_index,
1337 OPJ_UINT32 * p_data_size,
1338 OPJ_INT32 * p_tile_x0, OPJ_INT32 * p_tile_y0,
1339 OPJ_INT32 * p_tile_x1, OPJ_INT32 * p_tile_y1,
1340 OPJ_UINT32 * p_nb_comps,
1341 opj_bool * p_should_go_on );
1344 * Reads a tile data. This function is compulsory and allows one to decode tile data. opj_read_tile_header should be called before.
1345 * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1347 * @param p_codec the jpeg2000 codec.
1348 * @param p_tile_index the index of the tile being decoded, this should be the value set by opj_read_tile_header.
1349 * @param p_data pointer to a memory block that will hold the decoded data.
1350 * @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.
1351 * @param p_stream the stream to decode.
1353 * @return true if the data could be decoded.
1355 OPJ_API opj_bool OPJ_CALLCONV opj_decode_tile_data( opj_codec_t *p_codec,
1356 OPJ_UINT32 p_tile_index,
1358 OPJ_UINT32 p_data_size,
1359 opj_stream_t *p_stream );
1361 /* COMPRESSION FUNCTIONS*/
1364 * Creates a J2K/JP2 compression structure
1365 * @param format Coder to select
1366 * @return Returns a handle to a compressor if successful, returns NULL otherwise
1368 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
1371 Set encoding parameters to default values, that means :
1375 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
1376 <li>Size of code-block : 64 x 64
1377 <li>Number of resolutions: 6
1378 <li>No SOP marker in the codestream
1379 <li>No EPH marker in the codestream
1380 <li>No sub-sampling in x or y direction
1381 <li>No mode switch activated
1382 <li>Progression order: LRCP
1384 <li>No ROI upshifted
1385 <li>No offset of the origin of the image
1386 <li>No offset of the origin of the tiles
1387 <li>Reversible DWT 5-3
1389 @param parameters Compression parameters
1391 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(opj_cparameters_t *parameters);
1394 * Setup the encoder parameters using the current image and using user parameters.
1395 * @param p_codec Compressor handle
1396 * @param parameters Compression parameters
1397 * @param image Input filled image
1399 OPJ_API opj_bool OPJ_CALLCONV opj_setup_encoder(opj_codec_t *p_codec,
1400 opj_cparameters_t *parameters,
1401 opj_image_t *image);
1405 OPJ_API opj_bool OPJ_CALLCONV opj_start_compress ( opj_codec_t *p_codec,
1406 opj_image_t * p_image,
1407 opj_stream_t *p_cio);
1411 OPJ_API opj_bool OPJ_CALLCONV opj_end_compress (opj_codec_t *p_codec,
1412 opj_stream_t *p_stream);
1415 * Encode an image into a JPEG-2000 codestream
1416 * @param p_codec compressor handle
1417 * @param p_stream Output buffer stream
1418 * @param image Image to encode
1420 * @return Returns true if successful, returns false otherwise
1422 OPJ_API opj_bool OPJ_CALLCONV opj_encode(opj_codec_t *p_codec,
1423 opj_stream_t *p_stream);
1427 Destroy Codestream information after compression or decompression
1428 @param cstr_info Codestream information structure
1430 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_v2_t **cstr_info);
1435 ==========================================================
1436 codec output functions definitions
1437 ==========================================================
1441 * Dump the codec information into the output stream
1443 * @param p_codec the jpeg2000 codec.
1444 * @param info_flag type of information dump.
1445 * @param output_stream output stream where dump the informations get from the codec.
1448 OPJ_API void OPJ_CALLCONV opj_dump_codec( opj_codec_t *p_codec,
1449 OPJ_INT32 info_flag,
1450 FILE* output_stream);
1453 * Get the codestream information from the codec
1455 * @param p_codec the jpeg2000 codec.
1457 * @return a pointer to a codestream information structure.
1460 OPJ_API opj_codestream_info_v2_t* OPJ_CALLCONV opj_get_cstr_info(opj_codec_t *p_codec);
1463 * Get the codestream index from the codec
1465 * @param p_codec the jpeg2000 codec.
1467 * @return a pointer to a codestream index structure.
1470 OPJ_API opj_codestream_index_t * OPJ_CALLCONV opj_get_cstr_index(opj_codec_t *p_codec);
1472 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_index(opj_codestream_index_t **p_cstr_index);
1476 * Get the JP2 file information from the codec FIXME
1478 * @param p_codec the jpeg2000 codec.
1480 * @return a pointer to a JP2 metadata structure.
1483 OPJ_API opj_jp2_metadata_t* OPJ_CALLCONV opj_get_jp2_metadata(opj_codec_t *p_codec);
1486 * Get the JP2 file index from the codec FIXME
1488 * @param p_codec the jpeg2000 codec.
1490 * @return a pointer to a JP2 index structure.
1493 OPJ_API opj_jp2_index_t* OPJ_CALLCONV opj_get_jp2_index(opj_codec_t *p_codec);
1497 ==========================================================
1499 ==========================================================
1503 * Sets the MCT matrix to use.
1505 * @param parameters the parameters to change.
1506 * @param pEncodingMatrix the encoding matrix.
1507 * @param p_dc_shift the dc shift coefficients to use.
1508 * @param pNbComp the number of components of the image.
1510 * @return true if the parameters could be set.
1512 OPJ_API opj_bool OPJ_CALLCONV opj_set_MCT( opj_cparameters_t *parameters,
1513 OPJ_FLOAT32 * pEncodingMatrix,
1514 OPJ_INT32 * p_dc_shift,
1515 OPJ_UINT32 pNbComp);
1523 #endif /* OPENJPEG_H */