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