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