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