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