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