libopenjpeg/openjpeg.h

   1  /*
   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.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions
  16  * are met:
  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.
  22  *
  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.
  34  */
  35 #ifndef OPENJPEG_H
  36 #define OPENJPEG_H
  37
  38
  39 /*
  40 ==========================================================
  41    Compiler directives
  42 ==========================================================
  43 */
  44
  45 /* deprecated attribute */
  46 #ifdef __GNUC__
  47         #define DEPRECATED(func) func __attribute__ ((deprecated))
  48 #elif defined(_MSC_VER)
  49         #define DEPRECATED(func) __declspec(deprecated) func
  50 #else
  51         #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
  52         #define DEPRECATED(func) func
  53 #endif
  54
  55 #if defined(OPJ_STATIC) || !defined(_WIN32)
  56 #define OPJ_API
  57 #define OPJ_CALLCONV
  58 #else
  59 #define OPJ_CALLCONV __stdcall
  60 /*
  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.
  67 */
  68 #if defined(OPJ_EXPORTS) || defined(DLL_EXPORT)
  69 #define OPJ_API __declspec(dllexport)
  70 #else
  71 #define OPJ_API __declspec(dllimport)
  72 #endif /* OPJ_EXPORTS */
  73 #endif /* !OPJ_STATIC || !_WIN32 */
  74
  75 typedef int opj_bool; /*FIXME it should be to follow the name of others OPJ_TYPE -> OPJ_BOOL*/
  76 #define OPJ_TRUE 1
  77 #define OPJ_FALSE 0
  78
  79 /* FIXME : should be better defined by configure/CMake test */
  80 typedef unsigned int    OPJ_UINT32;
  81 typedef int                             OPJ_INT32;
  82 typedef unsigned short  OPJ_UINT16;
  83 typedef short                   OPJ_INT16;
  84 typedef char                    OPJ_CHAR;
  85 typedef unsigned char   OPJ_BYTE;
  86 typedef unsigned int    OPJ_SIZE_T;
  87 typedef double                  OPJ_FLOAT64;
  88 typedef float                   OPJ_FLOAT32;
  89
  90 #if (defined(WIN32) || defined(WIN64)) && !defined(__MINGW32__)
  91
  92 typedef signed __int64     OPJ_INT64;
  93 #define OPJ_INT64_F "I64"
  94 typedef unsigned __int64   OPJ_UINT64;
  95 #define OPJ_UINT64_F "I64"
  96
  97 #else
  98
  99 typedef long long          OPJ_INT64;
 100 #define OPJ_INT64_F "ll"
 101
 102 typedef unsigned long long OPJ_UINT64;
 103 #define OPJ_UINT64_F "ll"
 104
 105 #endif
 106
 107 /* 64-bit file offset type */
 108 typedef OPJ_INT64 OPJ_OFF_T;
 109 #define OPJ_OFF_F OPJ_INT64_F
 110
 111 /* Avoid compile-time warning because parameter is not used */
 112 #define OPJ_ARG_NOT_USED(x) (void)(x)
 113
 114 /*
 115 ==========================================================
 116    Useful constant definitions
 117 ==========================================================
 118 */
 119
 120 #define OPJ_PATH_LEN 4096 /**< Maximum allowed size for filenames */
 121
 122 #define J2K_MAXRLVLS 33                                 /**< Number of maximum resolution level authorized */
 123 #define J2K_MAXBANDS (3*J2K_MAXRLVLS-2) /**< Number of maximum sub-band linked to number of resolution level */
 124
 125 #define J2K_DEFAULT_NB_SEGS                             10
 126 #define J2K_STREAM_CHUNK_SIZE                   0x100000 /** 1 mega by default */
 127 #define J2K_DEFAULT_HEADER_SIZE                 1000
 128 #define J2K_MCC_DEFAULT_NB_RECORDS              10
 129 #define J2K_MCT_DEFAULT_NB_RECORDS              10
 130
 131 /* UniPG>> */
 132 #define JPWL_MAX_NO_TILESPECS   16 /**< Maximum number of tile parts expected by JPWL: increase at your will */
 133 #define JPWL_MAX_NO_PACKSPECS   16 /**< Maximum number of packet parts expected by JPWL: increase at your will */
 134 #define JPWL_MAX_NO_MARKERS     512 /**< Maximum number of JPWL markers: increase at your will */
 135 #define JPWL_PRIVATEINDEX_NAME "jpwl_index_privatefilename" /**< index file name used when JPWL is on */
 136 #define JPWL_EXPECTED_COMPONENTS 3 /**< Expect this number of components, so you'll find better the first EPB */
 137 #define JPWL_MAXIMUM_TILES 8192 /**< Expect this maximum number of tiles, to avoid some crashes */
 138 #define JPWL_MAXIMUM_HAMMING 2 /**< Expect this maximum number of bit errors in marker id's */
 139 #define JPWL_MAXIMUM_EPB_ROOM 65450 /**< Expect this maximum number of bytes for composition of EPBs */
 140 /* <<UniPG */
 141
 142 /**
 143  * FIXME EXPERIMENTAL FOR THE MOMENT
 144  * Supported options about file information
 145 */
 146 #define OPJ_IMG_INFO            1       /**< Basic image information provided to the user */
 147 #define OPJ_J2K_MH_INFO         2       /**< Codestream information based only on the main header */
 148 #define OPJ_J2K_TH_INFO         4       /**< Tile information based on the current tile header */
 149 /*FIXME #define OPJ_J2K_CSTR_INFO       6*/     /**<  */
 150 #define OPJ_J2K_MH_IND          16      /**< Codestream index based only on the main header */
 151 #define OPJ_J2K_TH_IND          32      /**< Tile index based on the current tile */
 152 /*FIXME #define OPJ_J2K_CSTR_IND        48*/    /**<  */
 153 #define OPJ_JP2_INFO            128     /**< JP2 file information */
 154 #define OPJ_JP2_IND                     256     /**< JP2 file index */
 155
 156
 157 /*
 158 ==========================================================
 159    enum definitions
 160 ==========================================================
 161 */
 162 /**
 163  * Rsiz Capabilities
 164  * */
 165 typedef enum RSIZ_CAPABILITIES {
 166         STD_RSIZ = 0,           /** Standard JPEG2000 profile*/
 167         CINEMA2K = 3,           /** Profile name for a 2K image*/
 168         CINEMA4K = 4            /** Profile name for a 4K image*/
 169 } OPJ_RSIZ_CAPABILITIES;
 170
 171 /**
 172  * Digital cinema operation mode
 173  * */
 174 typedef enum CINEMA_MODE {
 175         OFF = 0,                        /** Not Digital Cinema*/
 176         CINEMA2K_24 = 1,        /** 2K Digital Cinema at 24 fps*/
 177         CINEMA2K_48 = 2,        /** 2K Digital Cinema at 48 fps*/
 178         CINEMA4K_24 = 3         /** 4K Digital Cinema at 24 fps*/
 179 }OPJ_CINEMA_MODE;
 180
 181 /**
 182  * Progression order
 183  * */
 184 typedef enum PROG_ORDER {
 185         PROG_UNKNOWN = -1,      /**< place-holder */
 186         LRCP = 0,                       /**< layer-resolution-component-precinct order */
 187         RLCP = 1,                       /**< resolution-layer-component-precinct order */
 188         RPCL = 2,                       /**< resolution-precinct-component-layer order */
 189         PCRL = 3,                       /**< precinct-component-resolution-layer order */
 190         CPRL = 4                        /**< component-precinct-resolution-layer order */
 191 } OPJ_PROG_ORDER;
 192
 193 /**
 194  * Supported image color spaces
 195 */
 196 typedef enum COLOR_SPACE {
 197         CLRSPC_UNKNOWN = -1,    /**< not supported by the library */
 198         CLRSPC_UNSPECIFIED = 0, /**< not specified in the codestream */
 199         CLRSPC_SRGB = 1,                /**< sRGB */
 200         CLRSPC_GRAY = 2,                /**< grayscale */
 201         CLRSPC_SYCC = 3                 /**< YUV */
 202 } OPJ_COLOR_SPACE;
 203
 204 /**
 205  * Supported codec
 206 */
 207 typedef enum CODEC_FORMAT {
 208         CODEC_UNKNOWN = -1,     /**< place-holder */
 209         CODEC_J2K  = 0,         /**< JPEG-2000 codestream : read/write */
 210         CODEC_JPT  = 1,         /**< JPT-stream (JPEG 2000, JPIP) : read only */
 211         CODEC_JP2  = 2,         /**< JPEG-2000 file format : read/write */
 212 } OPJ_CODEC_FORMAT;
 213
 214 /**
 215  * Limit decoding to certain portions of the codestream.
 216 */
 217 typedef enum LIMIT_DECODING {
 218         NO_LIMITATION = 0,                              /**< No limitation for the decoding. The entire codestream will de decoded */
 219         LIMIT_TO_MAIN_HEADER = 1,               /**< The decoding is limited to the Main Header */
 220         DECODE_ALL_BUT_PACKETS = 2              /**< Decode everything except the JPEG 2000 packets */
 221 } OPJ_LIMIT_DECODING;
 222
 223
 224 /*
 225 ==========================================================
 226    event manager typedef definitions
 227 ==========================================================
 228 */
 229
 230 /**
 231  * Callback function prototype for events
 232  * @param msg Event message
 233  * @param client_data
 234  * */
 235 typedef void (*opj_msg_callback) (const char *msg, void *client_data);
 236
 237 /**
 238  * Message handler object used for
 239  * <ul>
 240  * <li>Error messages
 241  * <li>Warning messages
 242  * <li>Debugging messages
 243  * </ul>
 244  * */
 245 typedef struct opj_event_mgr {
 246         /** FIXME DOC */
 247         void* client_data;
 248         /** Error message callback if available, NULL otherwise */
 249         opj_msg_callback error_handler;
 250         /** Warning message callback if available, NULL otherwise */
 251         opj_msg_callback warning_handler;
 252         /** Debug message callback if available, NULL otherwise */
 253         opj_msg_callback info_handler;
 254 } opj_event_mgr_t;
 255
 256
 257 /*
 258 ==========================================================
 259    codec typedef definitions
 260 ==========================================================
 261 */
 262
 263 /**
 264  * Progression order changes
 265  * */
 266 typedef struct opj_poc {
 267         /** Resolution num start, Component num start, given by POC */
 268         OPJ_UINT32 resno0, compno0;
 269         /** Layer num end,Resolution num end, Component num end, given by POC */
 270         OPJ_UINT32 layno1, resno1, compno1;
 271         /** Layer num start,Precinct num start, Precinct num end */
 272         int layno0, precno0, precno1;
 273         /** Progression order enum*/
 274         OPJ_PROG_ORDER prg1,prg;
 275         /** Progression order string*/
 276         char progorder[5];
 277         /** Tile number */
 278         int tile;
 279         /** Start and end values for Tile width and height*/
 280         int tx0,tx1,ty0,ty1;
 281         /** Start value, initialised in pi_initialise_encode*/
 282         int layS, resS, compS, prcS;
 283         /** End value, initialised in pi_initialise_encode */
 284         int layE, resE, compE, prcE;
 285         /** Start and end values of Tile width and height, initialised in pi_initialise_encode*/
 286         int txS,txE,tyS,tyE,dx,dy;
 287         /** Temporary values for Tile parts, initialised in pi_create_encode */
 288         int lay_t, res_t, comp_t, prc_t,tx0_t,ty0_t;
 289 } opj_poc_t;
 290
 291 /**
 292  * Compression parameters
 293  * */
 294 typedef struct opj_cparameters {
 295         /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */
 296         opj_bool tile_size_on;
 297         /** XTOsiz */
 298         int cp_tx0;
 299         /** YTOsiz */
 300         int cp_ty0;
 301         /** XTsiz */
 302         int cp_tdx;
 303         /** YTsiz */
 304         int cp_tdy;
 305         /** allocation by rate/distortion */
 306         int cp_disto_alloc;
 307         /** allocation by fixed layer */
 308         int cp_fixed_alloc;
 309         /** add fixed_quality */
 310         int cp_fixed_quality;
 311         /** fixed layer */
 312         int *cp_matrice;
 313         /** comment for coding */
 314         char *cp_comment;
 315         /** csty : coding style */
 316         int csty;
 317         /** progression order (default LRCP) */
 318         OPJ_PROG_ORDER prog_order;
 319         /** progression order changes */
 320         opj_poc_t POC[32];
 321         /** number of progression order changes (POC), default to 0 */
 322         int numpocs;
 323         /** number of layers */
 324         int tcp_numlayers;
 325         /** rates of layers */
 326         float tcp_rates[100];
 327         /** different psnr for successive layers */
 328         float tcp_distoratio[100];
 329         /** number of resolutions */
 330         int numresolution;
 331         /** initial code block width, default to 64 */
 332         int cblockw_init;
 333         /** initial code block height, default to 64 */
 334         int cblockh_init;
 335         /** mode switch (cblk_style) */
 336         int mode;
 337         /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
 338         int irreversible;
 339         /** region of interest: affected component in [0..3], -1 means no ROI */
 340         int roi_compno;
 341         /** region of interest: upshift value */
 342         int roi_shift;
 343         /* number of precinct size specifications */
 344         int res_spec;
 345         /** initial precinct width */
 346         int prcw_init[J2K_MAXRLVLS];
 347         /** initial precinct height */
 348         int prch_init[J2K_MAXRLVLS];
 349
 350         /**@name command line encoder parameters (not used inside the library) */
 351         /*@{*/
 352         /** input file name */
 353         char infile[OPJ_PATH_LEN];
 354         /** output file name */
 355         char outfile[OPJ_PATH_LEN];
 356         /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
 357         int index_on;
 358         /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
 359         char index[OPJ_PATH_LEN];
 360         /** subimage encoding: origin image offset in x direction */
 361         int image_offset_x0;
 362         /** subimage encoding: origin image offset in y direction */
 363         int image_offset_y0;
 364         /** subsampling value for dx */
 365         int subsampling_dx;
 366         /** subsampling value for dy */
 367         int subsampling_dy;
 368         /** input file format 0: PGX, 1: PxM, 2: BMP 3:TIF*/
 369         int decod_format;
 370         /** output file format 0: J2K, 1: JP2, 2: JPT */
 371         int cod_format;
 372         /*@}*/
 373
 374 /* UniPG>> */
 375         /**@name JPWL encoding parameters */
 376         /*@{*/
 377         /** enables writing of EPC in MH, thus activating JPWL */
 378         opj_bool jpwl_epc_on;
 379         /** error protection method for MH (0,1,16,32,37-128) */
 380         int jpwl_hprot_MH;
 381         /** tile number of header protection specification (>=0) */
 382         int jpwl_hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 383         /** error protection methods for TPHs (0,1,16,32,37-128) */
 384         int jpwl_hprot_TPH[JPWL_MAX_NO_TILESPECS];
 385         /** tile number of packet protection specification (>=0) */
 386         int jpwl_pprot_tileno[JPWL_MAX_NO_PACKSPECS];
 387         /** packet number of packet protection specification (>=0) */
 388         int jpwl_pprot_packno[JPWL_MAX_NO_PACKSPECS];
 389         /** error protection methods for packets (0,1,16,32,37-128) */
 390         int jpwl_pprot[JPWL_MAX_NO_PACKSPECS];
 391         /** enables writing of ESD, (0=no/1/2 bytes) */
 392         int jpwl_sens_size;
 393         /** sensitivity addressing size (0=auto/2/4 bytes) */
 394         int jpwl_sens_addr;
 395         /** sensitivity range (0-3) */
 396         int jpwl_sens_range;
 397         /** sensitivity method for MH (-1=no,0-7) */
 398         int jpwl_sens_MH;
 399         /** tile number of sensitivity specification (>=0) */
 400         int jpwl_sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 401         /** sensitivity methods for TPHs (-1=no,0-7) */
 402         int jpwl_sens_TPH[JPWL_MAX_NO_TILESPECS];
 403         /*@}*/
 404 /* <<UniPG */
 405
 406         /** Digital Cinema compliance 0-not compliant, 1-compliant*/
 407         OPJ_CINEMA_MODE cp_cinema;
 408         /** Maximum rate for each component. If == 0, component size limitation is not considered */
 409         int max_comp_size;
 410         /** Profile name*/
 411         OPJ_RSIZ_CAPABILITIES cp_rsiz;
 412         /** Tile part generation*/
 413         char tp_on;
 414         /** Flag for Tile part generation*/
 415         char tp_flag;
 416         /** MCT (multiple component transform) */
 417         char tcp_mct;
 418         /** Enable JPIP indexing*/
 419         opj_bool jpip_on;
 420 } opj_cparameters_t;
 421
 422 /**
 423  * Decompression parameters
 424  * */
 425 typedef struct opj_dparameters {
 426         /**
 427         Set the number of highest resolution levels to be discarded.
 428         The image resolution is effectively divided by 2 to the power of the number of discarded levels.
 429         The reduce factor is limited by the smallest total number of decomposition levels among tiles.
 430         if != 0, then original dimension divided by 2^(reduce);
 431         if == 0 or not used, image is decoded to the full resolution
 432         */
 433         int cp_reduce;
 434         /**
 435         Set the maximum number of quality layers to decode.
 436         If there are less quality layers than the specified number, all the quality layers are decoded.
 437         if != 0, then only the first "layer" layers are decoded;
 438         if == 0 or not used, all the quality layers are decoded
 439         */
 440         int cp_layer;
 441
 442         /**@name command line decoder parameters (not used inside the library) */
 443         /*@{*/
 444         /** input file name */
 445         char infile[OPJ_PATH_LEN];
 446         /** output file name */
 447         char outfile[OPJ_PATH_LEN];
 448         /** input file format 0: J2K, 1: JP2, 2: JPT */
 449         int decod_format;
 450         /** output file format 0: PGX, 1: PxM, 2: BMP */
 451         int cod_format;
 452
 453         /** Decoding area left boundary */
 454         OPJ_UINT32 DA_x0;
 455         /** Decoding area right boundary */
 456         OPJ_UINT32 DA_x1;
 457         /** Decoding area up boundary */
 458         OPJ_UINT32 DA_y0;
 459         /** Decoding area bottom boundary */
 460         OPJ_UINT32 DA_y1;
 461         /** Verbose mode */
 462         opj_bool m_verbose;
 463
 464         /** tile number ot the decoded tile*/
 465         OPJ_UINT32 tile_index;
 466         /** Nb of tile to decode */
 467         OPJ_UINT32 nb_tile_to_decode;
 468
 469         /*@}*/
 470
 471 /* UniPG>> */
 472         /**@name JPWL decoding parameters */
 473         /*@{*/
 474         /** activates the JPWL correction capabilities */
 475         opj_bool jpwl_correct;
 476         /** expected number of components */
 477         int jpwl_exp_comps;
 478         /** maximum number of tiles */
 479         int jpwl_max_tiles;
 480         /*@}*/
 481 /* <<UniPG */
 482
 483         /**
 484         Specify whether the decoding should be done on the entire codestream, or be limited to the main header
 485         Limiting the decoding to the main header makes it possible to extract the characteristics of the codestream
 486         if == NO_LIMITATION, the entire codestream is decoded;
 487         if == LIMIT_TO_MAIN_HEADER, only the main header is decoded;
 488         */
 489         OPJ_LIMIT_DECODING cp_limit_decoding;
 490
 491 } opj_dparameters_t;
 492
 493
 494 /* ---> FIXME V1 style */
 495 /** Common fields between JPEG-2000 compression and decompression master structs. */
 496
 497 #define opj_common_fields \
 498         opj_event_mgr_t *event_mgr;     /**< pointer to the event manager */\
 499         void * client_data;                     /**< Available for use by application */\
 500         opj_bool is_decompressor;       /**< So common code can tell which is which */\
 501         OPJ_CODEC_FORMAT codec_format;  /**< selected codec */\
 502         void *j2k_handle;                       /**< pointer to the J2K codec */\
 503         void *jp2_handle;                       /**< pointer to the JP2 codec */\
 504         void *mj2_handle                        /**< pointer to the MJ2 codec */
 505
 506 /* Routines that are to be used by both halves of the library are declared
 507  * to receive a pointer to this structure.  There are no actual instances of
 508  * opj_common_struct_t, only of opj_cinfo_t and opj_dinfo_t.
 509  */
 510 typedef struct opj_common_struct {
 511   opj_common_fields;            /* Fields common to both master struct types */
 512   /* Additional fields follow in an actual opj_cinfo_t or
 513    * opj_dinfo_t.  All three structs must agree on these
 514    * initial fields!  (This would be a lot cleaner in C++.)
 515    */
 516 } opj_common_struct_t;
 517
 518 typedef opj_common_struct_t * opj_common_ptr;
 519
 520 /**
 521  * Compression context info
 522  * */
 523 typedef struct opj_cinfo {
 524         /** Fields shared with opj_dinfo_t */
 525         opj_common_fields;
 526         /* other specific fields go here */
 527 } opj_cinfo_t;
 528
 529 /**
 530  * Decompression context info
 531  * */
 532 typedef struct opj_dinfo {
 533         /** Fields shared with opj_cinfo_t */
 534         opj_common_fields;
 535         /* other specific fields go here */
 536 } opj_dinfo_t;
 537
 538 /* <--- V1 style */
 539
 540 /**
 541  * JPEG2000 codec V2.
 542  * */
 543 typedef void * opj_codec_t;
 544
 545 /*
 546 ==========================================================
 547    I/O stream typedef definitions
 548 ==========================================================
 549 */
 550
 551 /*
 552  * Stream open flags.
 553  */
 554 /** The stream was opened for reading. */
 555 #define OPJ_STREAM_READ 0x0001
 556 /** The stream was opened for writing. */
 557 #define OPJ_STREAM_WRITE 0x0002
 558
 559 /**
 560 Byte input-output stream (CIO)
 561 */
 562 typedef struct opj_cio {
 563         /** codec context */
 564         opj_common_ptr cinfo;
 565
 566         /** open mode (read/write) either OPJ_STREAM_READ or OPJ_STREAM_WRITE */
 567         int openmode;
 568         /** pointer to the start of the buffer */
 569         unsigned char *buffer;
 570         /** buffer size in bytes */
 571         int length;
 572
 573         /** pointer to the start of the stream */
 574         unsigned char *start;
 575         /** pointer to the end of the stream */
 576         unsigned char *end;
 577         /** pointer to the current position */
 578         unsigned char *bp;
 579 } opj_cio_t;
 580
 581
 582 /*
 583  * FIXME DOC
 584  */
 585 typedef OPJ_SIZE_T (* opj_stream_read_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
 586 typedef OPJ_SIZE_T (* opj_stream_write_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
 587 typedef OPJ_OFF_T (* opj_stream_skip_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ;
 588 typedef opj_bool (* opj_stream_seek_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ;
 589
 590 /*
 591  * JPEG2000 Stream.
 592  */
 593 typedef void * opj_stream_t;
 594
 595 /*
 596 ==========================================================
 597    image typedef definitions
 598 ==========================================================
 599 */
 600
 601 /**
 602  * Defines a single image component
 603  * */
 604 typedef struct opj_image_comp {
 605         /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
 606         OPJ_UINT32 dx;
 607         /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
 608         OPJ_UINT32 dy;
 609         /** data width */
 610         OPJ_UINT32 w;
 611         /** data height */
 612         OPJ_UINT32 h;
 613         /** x component offset compared to the whole image */
 614         OPJ_UINT32 x0;
 615         /** y component offset compared to the whole image */
 616         OPJ_UINT32 y0;
 617         /** precision */
 618         OPJ_UINT32 prec;
 619         /** image depth in bits */
 620         OPJ_UINT32 bpp;
 621         /** signed (1) / unsigned (0) */
 622         OPJ_UINT32 sgnd;
 623         /** number of decoded resolution */
 624         OPJ_UINT32 resno_decoded;
 625         /** number of division by 2 of the out image compared to the original size of image */
 626         OPJ_UINT32 factor;
 627         /** image component data */
 628         OPJ_INT32 *data;
 629 } opj_image_comp_t;
 630
 631 /**
 632  * Defines image data and characteristics
 633  * */
 634 typedef struct opj_image {
 635         /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
 636         OPJ_UINT32 x0;
 637         /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
 638         OPJ_UINT32 y0;
 639         /** Xsiz: width of the reference grid */
 640         OPJ_UINT32 x1;
 641         /** Ysiz: height of the reference grid */
 642         OPJ_UINT32 y1;
 643         /** number of components in the image */
 644         OPJ_UINT32 numcomps;
 645         /** color space: sRGB, Greyscale or YUV */
 646         OPJ_COLOR_SPACE color_space;
 647         /** image components */
 648         opj_image_comp_t *comps;
 649         /** 'restricted' ICC profile */
 650         OPJ_BYTE *icc_profile_buf;
 651         /** size of ICC profile */
 652         OPJ_INT32 icc_profile_len;
 653 } opj_image_t;
 654
 655
 656 /**
 657  * Component parameters structure used by the opj_image_create function
 658  * */
 659 typedef struct opj_image_comptparm {
 660         /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
 661         int dx;
 662         /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
 663         int dy;
 664         /** data width */
 665         int w;
 666         /** data height */
 667         int h;
 668         /** x component offset compared to the whole image */
 669         int x0;
 670         /** y component offset compared to the whole image */
 671         int y0;
 672         /** precision */
 673         int prec;
 674         /** image depth in bits */
 675         int bpp;
 676         /** signed (1) / unsigned (0) */
 677         int sgnd;
 678 } opj_image_cmptparm_t;
 679
 680
 681 /*
 682 ==========================================================
 683    Information on the JPEG 2000 codestream
 684 ==========================================================
 685 */
 686
 687 /**
 688  * Index structure : Information concerning a packet inside tile
 689  * */
 690 typedef struct opj_packet_info {
 691         /** packet start position (including SOP marker if it exists) */
 692         OPJ_OFF_T start_pos;
 693         /** end of packet header position (including EPH marker if it exists)*/
 694         OPJ_OFF_T end_ph_pos;
 695         /** packet end position */
 696         OPJ_OFF_T end_pos;
 697         /** packet distorsion */
 698         double disto;
 699 } opj_packet_info_t;
 700
 701
 702 /* UniPG>> */
 703 /**
 704  * Marker structure
 705  * */
 706 typedef struct opj_marker_info_t {
 707         /** marker type */
 708         unsigned short int type;
 709         /** position in codestream */
 710         OPJ_OFF_T pos;
 711         /** length, marker val included */
 712         int len;
 713 } opj_marker_info_t;
 714 /* <<UniPG */
 715
 716 /**
 717  * Index structure : Information concerning tile-parts
 718 */
 719 typedef struct opj_tp_info {
 720         /** start position of tile part */
 721         int tp_start_pos;
 722         /** end position of tile part header */
 723         int tp_end_header;
 724         /** end position of tile part */
 725         int tp_end_pos;
 726         /** start packet of tile part */
 727         int tp_start_pack;
 728         /** number of packets of tile part */
 729         int tp_numpacks;
 730 } opj_tp_info_t;
 731
 732 /**
 733  * Index structure : information regarding tiles
 734 */
 735 typedef struct opj_tile_info {
 736         /** value of thresh for each layer by tile cfr. Marcela   */
 737         double *thresh;
 738         /** number of tile */
 739         int tileno;
 740         /** start position */
 741         int start_pos;
 742         /** end position of the header */
 743         int end_header;
 744         /** end position */
 745         int end_pos;
 746         /** precinct number for each resolution level (width) */
 747         int pw[33];
 748         /** precinct number for each resolution level (height) */
 749         int ph[33];
 750         /** precinct size (in power of 2), in X for each resolution level */
 751         int pdx[33];
 752         /** precinct size (in power of 2), in Y for each resolution level */
 753         int pdy[33];
 754         /** information concerning packets inside tile */
 755         opj_packet_info_t *packet;
 756         /** add fixed_quality */
 757         int numpix;
 758         /** add fixed_quality */
 759         double distotile;
 760         /** number of markers */
 761         int marknum;
 762         /** list of markers */
 763         opj_marker_info_t *marker;
 764         /** actual size of markers array */
 765         int maxmarknum;
 766         /** number of tile parts */
 767         int num_tps;
 768         /** information concerning tile parts */
 769         opj_tp_info_t *tp;
 770 } opj_tile_info_t;
 771
 772 /**
 773  * Index structure of the codestream
 774 */
 775 typedef struct opj_codestream_info {
 776         /** maximum distortion reduction on the whole image (add for Marcela) */
 777         double D_max;
 778         /** packet number */
 779         int packno;
 780         /** writing the packet in the index with t2_encode_packets */
 781         int index_write;
 782         /** image width */
 783         int image_w;
 784         /** image height */
 785         int image_h;
 786         /** progression order */
 787         OPJ_PROG_ORDER prog;
 788         /** tile size in x */
 789         int tile_x;
 790         /** tile size in y */
 791         int tile_y;
 792         /** */
 793         int tile_Ox;
 794         /** */
 795         int tile_Oy;
 796         /** number of tiles in X */
 797         int tw;
 798         /** number of tiles in Y */
 799         int th;
 800         /** component numbers */
 801         int numcomps;
 802         /** number of layer */
 803         int numlayers;
 804         /** number of decomposition for each component */
 805         int *numdecompos;
 806 /* UniPG>> */
 807         /** number of markers */
 808         int marknum;
 809         /** list of markers */
 810         opj_marker_info_t *marker;
 811         /** actual size of markers array */
 812         int maxmarknum;
 813 /* <<UniPG */
 814         /** main header position */
 815         int main_head_start;
 816         /** main header position */
 817         int main_head_end;
 818         /** codestream's size */
 819         int codestream_size;
 820         /** information regarding tiles inside image */
 821         opj_tile_info_t *tile;
 822 } opj_codestream_info_t;
 823
 824 /* <----------------------------------------------------------- */
 825 /* new output managment of the codestream information and index */
 826
 827 /**
 828  * Tile-component coding parameters information
 829  */
 830 typedef struct opj_tccp_info
 831 {
 832         /** component index */
 833         OPJ_UINT32 compno;
 834         /** coding style */
 835         OPJ_UINT32 csty;
 836         /** number of resolutions */
 837         OPJ_UINT32 numresolutions;
 838         /** code-blocks width */
 839         OPJ_UINT32 cblkw;
 840         /** code-blocks height */
 841         OPJ_UINT32 cblkh;
 842         /** code-block coding style */
 843         OPJ_UINT32 cblksty;
 844         /** discrete wavelet transform identifier */
 845         OPJ_UINT32 qmfbid;
 846         /** quantisation style */
 847         OPJ_UINT32 qntsty;
 848         /** stepsizes used for quantization */
 849         OPJ_UINT32 stepsizes_mant[J2K_MAXBANDS];
 850         /** stepsizes used for quantization */
 851         OPJ_UINT32 stepsizes_expn[J2K_MAXBANDS];
 852         /** number of guard bits */
 853         OPJ_UINT32 numgbits;
 854         /** Region Of Interest shift */
 855         OPJ_INT32 roishift;
 856         /** precinct width */
 857         OPJ_UINT32 prcw[J2K_MAXRLVLS];
 858         /** precinct height */
 859         OPJ_UINT32 prch[J2K_MAXRLVLS];
 860 }
 861 opj_tccp_info_t;
 862
 863 /**
 864  * Tile coding parameters information
 865  */
 866 typedef struct opj_tile_v2_info {
 867
 868         /** number (index) of tile */
 869         int tileno;
 870         /** coding style */
 871         OPJ_UINT32 csty;
 872         /** progression order */
 873         OPJ_PROG_ORDER prg;
 874         /** number of layers */
 875         OPJ_UINT32 numlayers;
 876         /** multi-component transform identifier */
 877         OPJ_UINT32 mct;
 878
 879         /** information concerning tile component parameters*/
 880         opj_tccp_info_t *tccp_info;
 881
 882 } opj_tile_info_v2_t;
 883
 884 /**
 885  * Information structure about the codestream (FIXME should be expand and enhance)
 886  */
 887 typedef struct opj_codestream_info_v2 {
 888         /* Tile info */
 889         /** tile origin in x = XTOsiz */
 890         OPJ_UINT32 tx0;
 891         /** tile origin in y = YTOsiz */
 892         OPJ_UINT32 ty0;
 893         /** tile size in x = XTsiz */
 894         OPJ_UINT32 tdx;
 895         /** tile size in y = YTsiz */
 896         OPJ_UINT32 tdy;
 897         /** number of tiles in X */
 898         OPJ_UINT32 tw;
 899         /** number of tiles in Y */
 900         OPJ_UINT32 th;
 901
 902         /** number of components*/
 903         OPJ_UINT32 nbcomps;
 904
 905         /** Default information regarding tiles inside image */
 906         opj_tile_info_v2_t m_default_tile_info;
 907
 908         /** information regarding tiles inside image */
 909         opj_tile_info_v2_t *tile_info; /* FIXME not used for the moment */
 910
 911 } opj_codestream_info_v2_t;
 912
 913
 914 /**
 915  * Index structure about a tile part
 916  */
 917 typedef struct opj_tp_index {
 918         /** start position */
 919         OPJ_OFF_T start_pos;
 920         /** end position of the header */
 921         OPJ_OFF_T end_header;
 922         /** end position */
 923         OPJ_OFF_T end_pos;
 924
 925 } opj_tp_index_t;
 926
 927 /**
 928  * Index structure about a tile
 929  */
 930 typedef struct opj_tile_index {
 931         /** tile index */
 932         OPJ_UINT32 tileno;
 933
 934         /** number of tile parts */
 935         OPJ_UINT32 nb_tps;
 936         /** current nb of tile part (allocated)*/
 937         OPJ_UINT32 current_nb_tps;
 938         /** current tile-part index */
 939         OPJ_UINT32 current_tpsno;
 940         /** information concerning tile parts */
 941         opj_tp_index_t *tp_index;
 942
 943         /* UniPG>> */
 944                 /** number of markers */
 945                 OPJ_UINT32 marknum;
 946                 /** list of markers */
 947                 opj_marker_info_t *marker;
 948                 /** actual size of markers array */
 949                 OPJ_UINT32 maxmarknum;
 950         /* <<UniPG */
 951
 952         /** packet number */
 953         OPJ_UINT32 nb_packet;
 954         /** information concerning packets inside tile */
 955         opj_packet_info_t *packet_index;
 956
 957 } opj_tile_index_t;
 958
 959 /**
 960  * Index structure of the codestream (FIXME should be expand and enhance)
 961  */
 962 typedef struct opj_codestream_index_ {
 963         /** main header start position (SOC position) */
 964         OPJ_OFF_T main_head_start;
 965         /** main header end position (first SOT position) */
 966         OPJ_OFF_T main_head_end;
 967
 968         /** codestream's size */
 969         OPJ_UINT64 codestream_size;
 970
 971 /* UniPG>> */
 972         /** number of markers */
 973         OPJ_UINT32 marknum;
 974         /** list of markers */
 975         opj_marker_info_t *marker;
 976         /** actual size of markers array */
 977         OPJ_UINT32 maxmarknum;
 978 /* <<UniPG */
 979
 980         /** */
 981         OPJ_UINT32 nb_of_tiles;
 982         /** */
 983         opj_tile_index_t *tile_index; /* FIXME not used for the moment */
 984
 985 }opj_codestream_index_t;
 986 /* -----------------------------------------------------------> */
 987
 988 /*
 989 ==========================================================
 990    Metadata from the JP2file
 991 ==========================================================
 992 */
 993
 994 /**
 995  * Info structure of the JP2 file
 996  * FIXME
 997  */
 998 typedef struct opj_jp2_metadata {
 999         /** */
1000         OPJ_INT32       not_used;
1001
1002 } opj_jp2_metadata_t;
1003
1004 /**
1005  * Index structure of the JP2 file
1006  * FIXME
1007  */
1008 typedef struct opj_jp2_index {
1009         /** */
1010         OPJ_INT32       not_used;
1011
1012 } opj_jp2_index_t;
1013
1014
1015 #ifdef __cplusplus
1016 extern "C" {
1017 #endif
1018
1019
1020 /*
1021 ==========================================================
1022    openjpeg version
1023 ==========================================================
1024 */
1025
1026 OPJ_API const char * OPJ_CALLCONV opj_version(void);
1027
1028 /*
1029 ==========================================================
1030    image functions definitions
1031 ==========================================================
1032 */
1033
1034 /**
1035  * Create an image
1036  * @param numcmpts number of components
1037  * @param cmptparms components parameters
1038  * @param clrspc image color space
1039  * @return returns a new image structure if successful, returns NULL otherwise
1040  * */
1041 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(int numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1042
1043 /**
1044  * Deallocate any resources associated with an image
1045  * @param image image to be destroyed
1046  */
1047 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
1048
1049
1050 /*
1051 ==========================================================
1052    stream functions definitions
1053 ==========================================================
1054 */
1055
1056 /**
1057 Open and allocate a memory stream for read / write.
1058 On reading, the user must provide a buffer containing encoded data. The buffer will be
1059 wrapped by the returned CIO handle.
1060 On writing, buffer parameters must be set to 0: a buffer will be allocated by the library
1061 to contain encoded data.
1062 @param cinfo Codec context info
1063 @param buffer Reading: buffer address. Writing: NULL
1064 @param length Reading: buffer length. Writing: 0
1065 @return Returns a CIO handle if successful, returns NULL otherwise
1066 */
1067 OPJ_API opj_cio_t* OPJ_CALLCONV opj_cio_open(opj_common_ptr cinfo, unsigned char *buffer, int length);
1068
1069 /**
1070 Close and free a CIO handle
1071 @param cio CIO handle to free
1072 */
1073 OPJ_API void OPJ_CALLCONV opj_cio_close(opj_cio_t *cio);
1074
1075 /**
1076 Get position in byte stream
1077 @param cio CIO handle
1078 @return Returns the position in bytes
1079 */
1080 OPJ_API int OPJ_CALLCONV cio_tell(opj_cio_t *cio);
1081 /**
1082 Set position in byte stream
1083 @param cio CIO handle
1084 @param pos Position, in number of bytes, from the beginning of the stream
1085 */
1086 OPJ_API void OPJ_CALLCONV cio_seek(opj_cio_t *cio, int pos);
1087
1088 /* <----------- */
1089 /* V2 framework */
1090
1091 /**
1092  * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1093  *
1094  * @param       l_is_reader             if set to true then the stream will be an input stream, an output stream else.
1095  *
1096  * @return      a stream object.
1097 */
1098 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_default_create(opj_bool p_is_input);
1099 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create(OPJ_SIZE_T p_buffer_size, opj_bool p_is_input);
1100
1101 /**
1102  * Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must
1103  * close its own implementation of the stream.
1104  *
1105  * @param       p_stream        the stream to destroy.
1106  */
1107 OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream);
1108
1109 /**
1110  * Sets the given function to be used as a read function.
1111  * @param               p_stream        the stream to modify
1112  * @param               p_function      the function to use a read function.
1113 */
1114 OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream, opj_stream_read_fn p_function);
1115
1116 /**
1117  * Sets the given function to be used as a write function.
1118  * @param               p_stream        the stream to modify
1119  * @param               p_function      the function to use a write function.
1120 */
1121 OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream, opj_stream_write_fn p_function);
1122
1123 /**
1124  * Sets the given function to be used as a skip function.
1125  * @param               p_stream        the stream to modify
1126  * @param               p_function      the function to use a skip function.
1127 */
1128 OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream, opj_stream_skip_fn p_function);
1129
1130 /**
1131  * Sets the given function to be used as a seek function, the stream is then seekable.
1132  * @param               p_stream        the stream to modify
1133  * @param               p_function      the function to use a skip function.
1134 */
1135 OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream, opj_stream_seek_fn p_function);
1136
1137
1138 /**
1139  * Sets the given data to be used as a user data for the stream.
1140  * @param               p_stream        the stream to modify
1141  * @param               p_data          the data to set.
1142 */
1143 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data (opj_stream_t* p_stream, void * p_data);
1144
1145 /**
1146  * Sets the length of the user data for the stream.
1147  * @param               p_stream                the stream to modify
1148  * @param               data_length             length of the user_data.
1149 */
1150 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data_length(opj_stream_t* p_stream, OPJ_UINT64 data_length);
1151
1152
1153 /**
1154  * Helper function.
1155  * Sets the stream to be a file stream. The FILE must have been open previously.
1156  * @param p_file the file stream to operate on
1157  * @param p_is_read_stream whether the stream is a read stream (true) or not (false)
1158 */
1159 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream (FILE * p_file, opj_bool p_is_read_stream);
1160 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);
1161
1162 /* -----------> */
1163
1164 /*
1165 ==========================================================
1166    event manager functions definitions
1167 ==========================================================
1168 */
1169
1170 /**
1171  */
1172 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));
1173
1174 /**
1175  * Initialize a default event handler. This function set the output of message event to be stderr for warning and error output
1176  * and stdout for info output in the verbose mode. In the case of the non-verbose mode only the error message are displayed.
1177  * You can initialize your own event handler struct when you fill the field of the event structure. If you provide a null
1178  * structure to the opj_setup_decoder function, no output will be displayed.
1179  *
1180  * @param       p_manager               a opj_event_mgr structure which will be pass to the codec.
1181  *
1182  */
1183 OPJ_API void OPJ_CALLCONV opj_initialize_default_event_handler(opj_event_mgr_t * p_manager, opj_bool verbose);
1184
1185
1186 /*
1187 ==========================================================
1188    codec functions definitions
1189 ==========================================================
1190 */
1191
1192 /**
1193 Creates a J2K/JPT/JP2 decompression structure
1194 @param format Decoder to select
1195 @return Returns a handle to a decompressor if successful, returns NULL otherwise
1196 */
1197 DEPRECATED( OPJ_API opj_dinfo_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format) );
1198
1199 /**
1200  * Creates a J2K/JP2 decompression structure
1201  * @param format                Decoder to select
1202  *
1203  * @return Returns a handle to a decompressor if successful, returns NULL otherwise
1204  * */
1205 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress_v2(OPJ_CODEC_FORMAT format);
1206
1207 /**
1208 Destroy a decompressor handle
1209 @param dinfo decompressor handle to destroy
1210 */
1211 DEPRECATED( OPJ_API void OPJ_CALLCONV opj_destroy_decompress(opj_dinfo_t *dinfo) );
1212
1213 /**
1214  * Read after the codestream if necessary
1215  */
1216 OPJ_API opj_bool OPJ_CALLCONV opj_end_decompress (      opj_codec_t *p_codec,
1217                                                                                                         opj_stream_t *p_cio);
1218
1219
1220 /**
1221 Set decoding parameters to default values
1222 @param parameters Decompression parameters
1223 */
1224 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters);
1225
1226 /**
1227 Setup the decoder decoding parameters using user parameters.
1228 Decoding parameters are returned in j2k->cp.
1229 @param dinfo decompressor handle
1230 @param parameters decompression parameters
1231 */
1232 DEPRECATED( OPJ_API void OPJ_CALLCONV opj_setup_decoder(opj_dinfo_t *dinfo, opj_dparameters_t *parameters) );
1233
1234
1235 /**
1236  * Setup the decoder with decompression parameters provided by the user and with the message handler
1237  * provided by the user.
1238  *
1239  * @param dinfo                 decompressor handlers
1240  * @param parameters    decompression parameters
1241  * @param event_mgr             message handler
1242  *
1243  * @return true                 if the decoder is correctly set
1244  */
1245 OPJ_API opj_bool OPJ_CALLCONV opj_setup_decoder_v2(     opj_codec_t *p_info,
1246                                                                                                         opj_dparameters_t *parameters,
1247                                                                                                         opj_event_mgr_t* event_mgr);
1248
1249 /**
1250  * Decodes an image header.
1251  *
1252  * @param       p_cio                   the jpeg2000 stream.
1253  * @param       p_codec                 the jpeg2000 codec to read.
1254  * @param       p_image                 the image structure initialized with the characteristics of encoded image.
1255  *
1256  * @return true                         if the main header of the codestream and the JP2 header is correctly read.
1257  */
1258 OPJ_API opj_bool OPJ_CALLCONV opj_read_header ( opj_stream_t *p_cio,
1259                                                                                                 opj_codec_t *p_codec,
1260                                                                                                 opj_image_t **p_image);
1261
1262 /**
1263  * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
1264  *
1265  * @param       p_codec                 the jpeg2000 codec.
1266  * @param       p_start_x               the left position of the rectangle to decode (in image coordinates).
1267  * @param       p_end_x                 the right position of the rectangle to decode (in image coordinates).
1268  * @param       p_start_y               the up position of the rectangle to decode (in image coordinates).
1269  * @param       p_end_y                 the bottom position of the rectangle to decode (in image coordinates).
1270  *
1271  * @return      true                    if the area could be set.
1272  */
1273 OPJ_API opj_bool OPJ_CALLCONV opj_set_decode_area(      opj_codec_t *p_codec,
1274                                                                                                         opj_image_t* p_image,
1275                                                                                                         OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
1276                                                                                                         OPJ_INT32 p_end_x, OPJ_INT32 p_end_y );
1277
1278 /**
1279 Decode an image from a JPEG-2000 codestream
1280 @param dinfo decompressor handle
1281 @param cio Input buffer stream
1282 @return Returns a decoded image if successful, returns NULL otherwise
1283 */
1284 DEPRECATED( OPJ_API opj_image_t* OPJ_CALLCONV opj_decode(opj_dinfo_t *dinfo, opj_cio_t *cio) );
1285
1286 /**
1287  * Decode an image from a JPEG-2000 codestream
1288  * @param p_decompressor decompressor handle
1289  * @param cio Input buffer stream
1290  * @param p_image the decoded image
1291  * @return Returns a true on success, otherwise false
1292  * */
1293 OPJ_API opj_bool OPJ_CALLCONV opj_decode_v2(opj_codec_t *p_decompressor,
1294                                                                                         opj_stream_t * cio,
1295                                                                                         opj_image_t *p_image);
1296
1297
1298 /**
1299  * Get the decoded tile from the codec
1300  * @param       p_codec                 the jpeg2000 codec.
1301  * @param       p_cio                   input streamm
1302  * @param       p_image                 output image
1303  * @param       tile_index              index of the tile which will be decode
1304  *
1305  * @return                                      opj_true if all is ok.
1306  */
1307 OPJ_API opj_bool OPJ_CALLCONV opj_get_decoded_tile(     opj_codec_t *p_codec,
1308                                                                                                         opj_stream_t *p_cio,
1309                                                                                                         opj_image_t *p_image,
1310                                                                                                         OPJ_UINT32 tile_index);
1311
1312
1313 /**
1314  * Set the resolution factor of the decoded image
1315  * @param       p_codec                 the jpeg2000 codec.
1316  * @param       res_factor              resolution factor to set
1317  *
1318  * @return                                      opj_true if all is ok.
1319  */
1320 OPJ_API opj_bool OPJ_CALLCONV opj_set_decoded_resolution_factor(opj_codec_t *p_codec, OPJ_UINT32 res_factor);
1321
1322
1323
1324 /**
1325  * Reads a tile header. This function is compulsory and allows one to know the size of the tile thta will be decoded.
1326  * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1327  *
1328  * @param       p_codec                 the jpeg2000 codec.
1329  * @param       p_tile_index    pointer to a value that will hold the index of the tile being decoded, in case of success.
1330  * @param       p_data_size             pointer to a value that will hold the maximum size of the decoded data, in case of success. In case
1331  *                                                      of truncated codestreams, the actual number of bytes decoded may be lower. The computation of the size is the same
1332  *                                                      as depicted in opj_write_tile.
1333  * @param       p_tile_x0               pointer to a value that will hold the x0 pos of the tile (in the image).
1334  * @param       p_tile_y0               pointer to a value that will hold the y0 pos of the tile (in the image).
1335  * @param       p_tile_x1               pointer to a value that will hold the x1 pos of the tile (in the image).
1336  * @param       p_tile_y1               pointer to a value that will hold the y1 pos of the tile (in the image).
1337  * @param       p_nb_comps              pointer to a value that will hold the number of components in the tile.
1338  * @param       p_should_go_on  pointer to a boolean that will hold the fact that the decoding should go on. In case the
1339  *                                                      codestream is over at the time of the call, the value will be set to false. The user should then stop
1340  *                                                      the decoding.
1341  * @param       p_stream                the stream to decode.
1342  * @return      true                    if the tile header could be decoded. In case the decoding should end, the returned value is still true.
1343  *                                                      returning false may be the result of a shortage of memory or an internal error.
1344  */
1345 OPJ_API opj_bool OPJ_CALLCONV opj_read_tile_header(     opj_codec_t *p_codec,
1346                                                                                                 opj_stream_t * p_stream,
1347                                                                                                 OPJ_UINT32 * p_tile_index,
1348                                                                                                 OPJ_UINT32 * p_data_size,
1349                                                                                                 OPJ_INT32 * p_tile_x0, OPJ_INT32 * p_tile_y0,
1350                                                                                                 OPJ_INT32 * p_tile_x1, OPJ_INT32 * p_tile_y1,
1351                                                                                                 OPJ_UINT32 * p_nb_comps,
1352                                                                                                 opj_bool * p_should_go_on );
1353
1354
1355 /**
1356  * Reads a tile data. This function is compulsory and allows one to decode tile data. opj_read_tile_header should be called before.
1357  * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1358  *
1359  * @param       p_codec                 the jpeg2000 codec.
1360  * @param       p_tile_index    the index of the tile being decoded, this should be the value set by opj_read_tile_header.
1361  * @param       p_data                  pointer to a memory block that will hold the decoded data.
1362  * @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.
1363  * @param       p_stream                the stream to decode.
1364  *
1365  * @return      true                    if the data could be decoded.
1366  */
1367 OPJ_API opj_bool OPJ_CALLCONV opj_decode_tile_data(     opj_codec_t *p_codec,
1368                                                                                                         OPJ_UINT32 p_tile_index,
1369                                                                                                         OPJ_BYTE * p_data,
1370                                                                                                         OPJ_UINT32 p_data_size,
1371                                                                                                         opj_stream_t *p_stream );
1372
1373
1374 /**
1375 Decode an image from a JPEG-2000 codestream and extract the codestream information
1376 @param dinfo decompressor handle
1377 @param cio Input buffer stream
1378 @param cstr_info Codestream information structure if needed afterwards, NULL otherwise
1379 @return Returns a decoded image if successful, returns NULL otherwise
1380 */
1381 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) );
1382
1383 /* COMPRESSION FUNCTIONS*/
1384
1385 /**
1386 Creates a J2K/JP2 compression structure
1387 @param format Coder to select
1388 @return Returns a handle to a compressor if successful, returns NULL otherwise
1389 */
1390 OPJ_API opj_cinfo_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
1391 /**
1392 Destroy a compressor handle
1393 @param cinfo compressor handle to destroy
1394 */
1395 OPJ_API void OPJ_CALLCONV opj_destroy_compress(opj_cinfo_t *cinfo);
1396 /**
1397 Set encoding parameters to default values, that means :
1398 <ul>
1399 <li>Lossless
1400 <li>1 tile
1401 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
1402 <li>Size of code-block : 64 x 64
1403 <li>Number of resolutions: 6
1404 <li>No SOP marker in the codestream
1405 <li>No EPH marker in the codestream
1406 <li>No sub-sampling in x or y direction
1407 <li>No mode switch activated
1408 <li>Progression order: LRCP
1409 <li>No index file
1410 <li>No ROI upshifted
1411 <li>No offset of the origin of the image
1412 <li>No offset of the origin of the tiles
1413 <li>Reversible DWT 5-3
1414 </ul>
1415 @param parameters Compression parameters
1416 */
1417 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(opj_cparameters_t *parameters);
1418 /**
1419 Setup the encoder parameters using the current image and using user parameters.
1420 @param cinfo Compressor handle
1421 @param parameters Compression parameters
1422 @param image Input filled image
1423 */
1424 OPJ_API void OPJ_CALLCONV opj_setup_encoder(opj_cinfo_t *cinfo, opj_cparameters_t *parameters, opj_image_t *image);
1425 /**
1426 Encode an image into a JPEG-2000 codestream
1427 3@param cinfo compressor handle
1428 @param cio Output buffer stream
1429 @param image Image to encode
1430 @param index Depreacted -> Set to NULL. To extract index, used opj_encode_wci()
1431 @return Returns true if successful, returns false otherwise
1432 */
1433 OPJ_API opj_bool OPJ_CALLCONV opj_encode(opj_cinfo_t *cinfo, opj_cio_t *cio, opj_image_t *image, char *index);
1434 /**
1435 Encode an image into a JPEG-2000 codestream and extract the codestream information
1436 @param cinfo compressor handle
1437 @param cio Output buffer stream
1438 @param image Image to encode
1439 @param cstr_info Codestream information structure if needed afterwards, NULL otherwise
1440 @return Returns true if successful, returns false otherwise
1441 */
1442 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);
1443
1444
1445
1446
1447 /**
1448 Destroy Codestream information after compression or decompression
1449 @param cstr_info Codestream information structure
1450 */
1451 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_t *cstr_info);
1452
1453 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info_v2(opj_codestream_info_v2_t **cstr_info);
1454
1455
1456
1457 /**
1458  * Destroy a decompressor handle
1459  *
1460  * @param       p_codec                 decompressor handle to destroy
1461  */
1462 OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec);
1463
1464
1465
1466
1467 /*
1468 ==========================================================
1469    codec output functions definitions
1470 ==========================================================
1471 */
1472
1473 /**
1474  * Dump the codec information into the output stream
1475  *
1476  * @param       p_codec                 the jpeg2000 codec.
1477  * @param       info_flag               type of information dump.
1478  * @param       output_stream   output stream where dump the informations get from the codec.
1479  *
1480  */
1481 OPJ_API void OPJ_CALLCONV opj_dump_codec(       opj_codec_t *p_codec,
1482                                                                                         OPJ_INT32 info_flag,
1483                                                                                         FILE* output_stream);
1484
1485 /**
1486  * Get the codestream information from the codec
1487  *
1488  * @param       p_codec                 the jpeg2000 codec.
1489  *
1490  * @return                                      a pointer to a codestream information structure.
1491  *
1492  */
1493 OPJ_API opj_codestream_info_v2_t* OPJ_CALLCONV opj_get_cstr_info(opj_codec_t *p_codec);
1494
1495 /**
1496  * Get the codestream index from the codec
1497  *
1498  * @param       p_codec                 the jpeg2000 codec.
1499  *
1500  * @return                                      a pointer to a codestream index structure.
1501  *
1502  */
1503 OPJ_API opj_codestream_index_t * OPJ_CALLCONV opj_get_cstr_index(opj_codec_t *p_codec);
1504
1505 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_index(opj_codestream_index_t **p_cstr_index);
1506
1507
1508 /**
1509  * Get the JP2 file information from the codec FIXME
1510  *
1511  * @param       p_codec                 the jpeg2000 codec.
1512  *
1513  * @return                                      a pointer to a JP2 metadata structure.
1514  *
1515  */
1516 OPJ_API opj_jp2_metadata_t* OPJ_CALLCONV opj_get_jp2_metadata(opj_codec_t *p_codec);
1517
1518 /**
1519  * Get the JP2 file index from the codec FIXME
1520  *
1521  * @param       p_codec                 the jpeg2000 codec.
1522  *
1523  * @return                                      a pointer to a JP2 index structure.
1524  *
1525  */
1526 OPJ_API opj_jp2_index_t* OPJ_CALLCONV opj_get_jp2_index(opj_codec_t *p_codec);
1527
1528
1529
1530
1531
1532 #ifdef __cplusplus
1533 }
1534 #endif
1535
1536 #endif /* OPENJPEG_H */
1537
1538