src/lib/openjp2/openjpeg.h

   1 /*
   2 * The copyright in this software is being made available under the 2-clauses
   3 * BSD License, included below. This software may be subject to other third
   4 * party and contributor rights, including patent rights, and no such rights
   5 * are granted under this license.
   6 *
   7 * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
   8 * Copyright (c) 2002-2014, Professor Benoit Macq
   9 * Copyright (c) 2001-2003, David Janssens
  10 * Copyright (c) 2002-2003, Yannick Verschueren
  11 * Copyright (c) 2003-2007, Francois-Olivier Devaux
  12 * Copyright (c) 2003-2014, Antonin Descampe
  13 * Copyright (c) 2005, Herve Drolon, FreeImage Team
  14 * Copyright (c) 2006-2007, Parvatha Elangovan
  15 * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
  16 * Copyright (c) 2010-2011, Kaori Hagihara
  17 * Copyright (c) 2011-2012, Centre National d'Etudes Spatiales (CNES), France
  18 * Copyright (c) 2012, CS Systemes d'Information, France
  19 * All rights reserved.
  20 *
  21 * Redistribution and use in source and binary forms, with or without
  22 * modification, are permitted provided that the following conditions
  23 * are met:
  24 * 1. Redistributions of source code must retain the above copyright
  25 *    notice, this list of conditions and the following disclaimer.
  26 * 2. Redistributions in binary form must reproduce the above copyright
  27 *    notice, this list of conditions and the following disclaimer in the
  28 *    documentation and/or other materials provided with the distribution.
  29 *
  30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  31 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  32 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  33 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  34 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  35 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  36 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  37 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  38 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  39 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  40 * POSSIBILITY OF SUCH DAMAGE.
  41 */
  42 #ifndef OPENJPEG_H
  43 #define OPENJPEG_H
  44
  45
  46 /*
  47 ==========================================================
  48    Compiler directives
  49 ==========================================================
  50 */
  51
  52 /*
  53 The inline keyword is supported by C99 but not by C90.
  54 Most compilers implement their own version of this keyword ...
  55 */
  56 #ifndef INLINE
  57 #if defined(_MSC_VER)
  58 #define INLINE __forceinline
  59 #elif defined(__GNUC__)
  60 #define INLINE __inline__
  61 #elif defined(__MWERKS__)
  62 #define INLINE inline
  63 #else
  64 /* add other compilers here ... */
  65 #define INLINE
  66 #endif /* defined(<Compiler>) */
  67 #endif /* INLINE */
  68
  69 /* deprecated attribute */
  70 #ifdef __GNUC__
  71 #define OPJ_DEPRECATED(func) func __attribute__ ((deprecated))
  72 #elif defined(_MSC_VER)
  73 #define OPJ_DEPRECATED(func) __declspec(deprecated) func
  74 #else
  75 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
  76 #define OPJ_DEPRECATED(func) func
  77 #endif
  78
  79 #if defined(OPJ_STATIC) || !defined(_WIN32)
  80 /* http://gcc.gnu.org/wiki/Visibility */
  81 #   if __GNUC__ >= 4
  82 #       if defined(OPJ_STATIC) /* static library uses "hidden" */
  83 #           define OPJ_API    __attribute__ ((visibility ("hidden")))
  84 #       else
  85 #           define OPJ_API    __attribute__ ((visibility ("default")))
  86 #       endif
  87 #       define OPJ_LOCAL  __attribute__ ((visibility ("hidden")))
  88 #   else
  89 #       define OPJ_API
  90 #       define OPJ_LOCAL
  91 #   endif
  92 #   define OPJ_CALLCONV
  93 #else
  94 #   define OPJ_CALLCONV __stdcall
  95 /*
  96 The following ifdef block is the standard way of creating macros which make exporting
  97 from a DLL simpler. All files within this DLL are compiled with the OPJ_EXPORTS
  98 symbol defined on the command line. this symbol should not be defined on any project
  99 that uses this DLL. This way any other project whose source files include this file see
 100 OPJ_API functions as being imported from a DLL, whereas this DLL sees symbols
 101 defined with this macro as being exported.
 102 */
 103 #   if defined(OPJ_EXPORTS) || defined(DLL_EXPORT)
 104 #       define OPJ_API __declspec(dllexport)
 105 #   else
 106 #       define OPJ_API __declspec(dllimport)
 107 #   endif /* OPJ_EXPORTS */
 108 #endif /* !OPJ_STATIC || !_WIN32 */
 109
 110 typedef int OPJ_BOOL;
 111 #define OPJ_TRUE 1
 112 #define OPJ_FALSE 0
 113
 114 typedef char          OPJ_CHAR;
 115 typedef float         OPJ_FLOAT32;
 116 typedef double        OPJ_FLOAT64;
 117 typedef unsigned char OPJ_BYTE;
 118
 119 #include "opj_stdint.h"
 120
 121 typedef int8_t   OPJ_INT8;
 122 typedef uint8_t  OPJ_UINT8;
 123 typedef int16_t  OPJ_INT16;
 124 typedef uint16_t OPJ_UINT16;
 125 typedef int32_t  OPJ_INT32;
 126 typedef uint32_t OPJ_UINT32;
 127 typedef int64_t  OPJ_INT64;
 128 typedef uint64_t OPJ_UINT64;
 129
 130 typedef int64_t  OPJ_OFF_T; /* 64-bit file offset type */
 131
 132 #include <stdio.h>
 133 typedef size_t   OPJ_SIZE_T;
 134
 135 /* Avoid compile-time warning because parameter is not used */
 136 #define OPJ_ARG_NOT_USED(x) (void)(x)
 137
 138 /*
 139 ==========================================================
 140    Useful constant definitions
 141 ==========================================================
 142 */
 143
 144 #define OPJ_PATH_LEN 4096 /**< Maximum allowed size for filenames */
 145
 146 #define OPJ_J2K_MAXRLVLS 33                 /**< Number of maximum resolution level authorized */
 147 #define OPJ_J2K_MAXBANDS (3*OPJ_J2K_MAXRLVLS-2) /**< Number of maximum sub-band linked to number of resolution level */
 148
 149 #define OPJ_J2K_DEFAULT_NB_SEGS             10
 150 #define OPJ_J2K_STREAM_CHUNK_SIZE           0x100000 /** 1 mega by default */
 151 #define OPJ_J2K_DEFAULT_HEADER_SIZE         1000
 152 #define OPJ_J2K_MCC_DEFAULT_NB_RECORDS      10
 153 #define OPJ_J2K_MCT_DEFAULT_NB_RECORDS      10
 154
 155 /* UniPG>> */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */
 156 #define JPWL_MAX_NO_TILESPECS   16 /**< Maximum number of tile parts expected by JPWL: increase at your will */
 157 #define JPWL_MAX_NO_PACKSPECS   16 /**< Maximum number of packet parts expected by JPWL: increase at your will */
 158 #define JPWL_MAX_NO_MARKERS 512 /**< Maximum number of JPWL markers: increase at your will */
 159 #define JPWL_PRIVATEINDEX_NAME "jpwl_index_privatefilename" /**< index file name used when JPWL is on */
 160 #define JPWL_EXPECTED_COMPONENTS 3 /**< Expect this number of components, so you'll find better the first EPB */
 161 #define JPWL_MAXIMUM_TILES 8192 /**< Expect this maximum number of tiles, to avoid some crashes */
 162 #define JPWL_MAXIMUM_HAMMING 2 /**< Expect this maximum number of bit errors in marker id's */
 163 #define JPWL_MAXIMUM_EPB_ROOM 65450 /**< Expect this maximum number of bytes for composition of EPBs */
 164 /* <<UniPG */
 165
 166 /**
 167  * EXPERIMENTAL FOR THE MOMENT
 168  * Supported options about file information used only in j2k_dump
 169 */
 170 #define OPJ_IMG_INFO        1   /**< Basic image information provided to the user */
 171 #define OPJ_J2K_MH_INFO     2   /**< Codestream information based only on the main header */
 172 #define OPJ_J2K_TH_INFO     4   /**< Tile information based on the current tile header */
 173 #define OPJ_J2K_TCH_INFO    8   /**< Tile/Component information of all tiles */
 174 #define OPJ_J2K_MH_IND      16  /**< Codestream index based only on the main header */
 175 #define OPJ_J2K_TH_IND      32  /**< Tile index based on the current tile */
 176 /*FIXME #define OPJ_J2K_CSTR_IND    48*/    /**<  */
 177 #define OPJ_JP2_INFO        128 /**< JP2 file information */
 178 #define OPJ_JP2_IND         256 /**< JP2 file index */
 179
 180 /**
 181  * JPEG 2000 Profiles, see Table A.10 from 15444-1 (updated in various AMD)
 182  * These values help choosing the RSIZ value for the J2K codestream.
 183  * The RSIZ value triggers various encoding options, as detailed in Table A.10.
 184  * If OPJ_PROFILE_PART2 is chosen, it has to be combined with one or more extensions
 185  * described hereunder.
 186  *   Example: rsiz = OPJ_PROFILE_PART2 | OPJ_EXTENSION_MCT;
 187  * For broadcast profiles, the OPJ_PROFILE value has to be combined with the targeted
 188  * mainlevel (3-0 LSB, value between 0 and 11):
 189  *   Example: rsiz = OPJ_PROFILE_BC_MULTI | 0x0005; (here mainlevel 5)
 190  * For IMF profiles, the OPJ_PROFILE value has to be combined with the targeted mainlevel
 191  * (3-0 LSB, value between 0 and 11) and sublevel (7-4 LSB, value between 0 and 9):
 192  *   Example: rsiz = OPJ_PROFILE_IMF_2K | 0x0040 | 0x0005; (here main 5 and sublevel 4)
 193  * */
 194 #define OPJ_PROFILE_NONE        0x0000 /** no profile, conform to 15444-1 */
 195 #define OPJ_PROFILE_0           0x0001 /** Profile 0 as described in 15444-1,Table A.45 */
 196 #define OPJ_PROFILE_1           0x0002 /** Profile 1 as described in 15444-1,Table A.45 */
 197 #define OPJ_PROFILE_PART2       0x8000 /** At least 1 extension defined in 15444-2 (Part-2) */
 198 #define OPJ_PROFILE_CINEMA_2K   0x0003 /** 2K cinema profile defined in 15444-1 AMD1 */
 199 #define OPJ_PROFILE_CINEMA_4K   0x0004 /** 4K cinema profile defined in 15444-1 AMD1 */
 200 #define OPJ_PROFILE_CINEMA_S2K  0x0005 /** Scalable 2K cinema profile defined in 15444-1 AMD2 */
 201 #define OPJ_PROFILE_CINEMA_S4K  0x0006 /** Scalable 4K cinema profile defined in 15444-1 AMD2 */
 202 #define OPJ_PROFILE_CINEMA_LTS  0x0007 /** Long term storage cinema profile defined in 15444-1 AMD2 */
 203 #define OPJ_PROFILE_BC_SINGLE   0x0100 /** Single Tile Broadcast profile defined in 15444-1 AMD3 */
 204 #define OPJ_PROFILE_BC_MULTI    0x0200 /** Multi Tile Broadcast profile defined in 15444-1 AMD3 */
 205 #define OPJ_PROFILE_BC_MULTI_R  0x0300 /** Multi Tile Reversible Broadcast profile defined in 15444-1 AMD3 */
 206 #define OPJ_PROFILE_IMF_2K      0x0400 /** 2K Single Tile Lossy IMF profile defined in 15444-1 AMD 8 */
 207 #define OPJ_PROFILE_IMF_4K      0x0401 /** 4K Single Tile Lossy IMF profile defined in 15444-1 AMD 8 */
 208 #define OPJ_PROFILE_IMF_8K      0x0402 /** 8K Single Tile Lossy IMF profile defined in 15444-1 AMD 8 */
 209 #define OPJ_PROFILE_IMF_2K_R    0x0403 /** 2K Single/Multi Tile Reversible IMF profile defined in 15444-1 AMD 8 */
 210 #define OPJ_PROFILE_IMF_4K_R    0x0800 /** 4K Single/Multi Tile Reversible IMF profile defined in 15444-1 AMD 8 */
 211 #define OPJ_PROFILE_IMF_8K_R    0x0801  /** 8K Single/Multi Tile Reversible IMF profile defined in 15444-1 AMD 8 */
 212
 213 /**
 214  * JPEG 2000 Part-2 extensions
 215  * */
 216 #define OPJ_EXTENSION_NONE      0x0000 /** No Part-2 extension */
 217 #define OPJ_EXTENSION_MCT       0x0100  /** Custom MCT support */
 218
 219 /**
 220  * JPEG 2000 profile macros
 221  * */
 222 #define OPJ_IS_CINEMA(v)     (((v) >= OPJ_PROFILE_CINEMA_2K)&&((v) <= OPJ_PROFILE_CINEMA_S4K))
 223 #define OPJ_IS_STORAGE(v)    ((v) == OPJ_PROFILE_CINEMA_LTS)
 224 #define OPJ_IS_BROADCAST(v)  (((v) >= OPJ_PROFILE_BC_SINGLE)&&((v) <= ((OPJ_PROFILE_BC_MULTI_R) | (0x000b))))
 225 #define OPJ_IS_IMF(v)        (((v) >= OPJ_PROFILE_IMF_2K)&&((v) <= ((OPJ_PROFILE_IMF_8K_R) | (0x009b))))
 226 #define OPJ_IS_PART2(v)      ((v) & OPJ_PROFILE_PART2)
 227
 228 /**
 229  * JPEG 2000 codestream and component size limits in cinema profiles
 230  * */
 231 #define OPJ_CINEMA_24_CS     1302083    /** Maximum codestream length for 24fps */
 232 #define OPJ_CINEMA_48_CS     651041     /** Maximum codestream length for 48fps */
 233 #define OPJ_CINEMA_24_COMP   1041666    /** Maximum size per color component for 2K & 4K @ 24fps */
 234 #define OPJ_CINEMA_48_COMP   520833     /** Maximum size per color component for 2K @ 48fps */
 235
 236 /*
 237 ==========================================================
 238    enum definitions
 239 ==========================================================
 240 */
 241
 242 /**
 243  * DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead
 244  * Rsiz Capabilities
 245  * */
 246 typedef enum RSIZ_CAPABILITIES {
 247     OPJ_STD_RSIZ = 0,       /** Standard JPEG2000 profile*/
 248     OPJ_CINEMA2K = 3,       /** Profile name for a 2K image*/
 249     OPJ_CINEMA4K = 4,       /** Profile name for a 4K image*/
 250     OPJ_MCT = 0x8100
 251 } OPJ_RSIZ_CAPABILITIES;
 252
 253 /**
 254  * DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead
 255  * Digital cinema operation mode
 256  * */
 257 typedef enum CINEMA_MODE {
 258     OPJ_OFF = 0,            /** Not Digital Cinema*/
 259     OPJ_CINEMA2K_24 = 1,    /** 2K Digital Cinema at 24 fps*/
 260     OPJ_CINEMA2K_48 = 2,    /** 2K Digital Cinema at 48 fps*/
 261     OPJ_CINEMA4K_24 = 3     /** 4K Digital Cinema at 24 fps*/
 262 } OPJ_CINEMA_MODE;
 263
 264 /**
 265  * Progression order
 266  * */
 267 typedef enum PROG_ORDER {
 268     OPJ_PROG_UNKNOWN = -1,  /**< place-holder */
 269     OPJ_LRCP = 0,           /**< layer-resolution-component-precinct order */
 270     OPJ_RLCP = 1,           /**< resolution-layer-component-precinct order */
 271     OPJ_RPCL = 2,           /**< resolution-precinct-component-layer order */
 272     OPJ_PCRL = 3,           /**< precinct-component-resolution-layer order */
 273     OPJ_CPRL = 4            /**< component-precinct-resolution-layer order */
 274 } OPJ_PROG_ORDER;
 275
 276 /**
 277  * Supported image color spaces
 278 */
 279 typedef enum COLOR_SPACE {
 280     OPJ_CLRSPC_UNKNOWN = -1,    /**< not supported by the library */
 281     OPJ_CLRSPC_UNSPECIFIED = 0, /**< not specified in the codestream */
 282     OPJ_CLRSPC_SRGB = 1,        /**< sRGB */
 283     OPJ_CLRSPC_GRAY = 2,        /**< grayscale */
 284     OPJ_CLRSPC_SYCC = 3,        /**< YUV */
 285     OPJ_CLRSPC_EYCC = 4,        /**< e-YCC */
 286     OPJ_CLRSPC_CMYK = 5         /**< CMYK */
 287 } OPJ_COLOR_SPACE;
 288
 289 /**
 290  * Supported codec
 291 */
 292 typedef enum CODEC_FORMAT {
 293     OPJ_CODEC_UNKNOWN = -1, /**< place-holder */
 294     OPJ_CODEC_J2K  = 0,     /**< JPEG-2000 codestream : read/write */
 295     OPJ_CODEC_JPT  = 1,     /**< JPT-stream (JPEG 2000, JPIP) : read only */
 296     OPJ_CODEC_JP2  = 2,     /**< JP2 file format : read/write */
 297     OPJ_CODEC_JPP  = 3,     /**< JPP-stream (JPEG 2000, JPIP) : to be coded */
 298     OPJ_CODEC_JPX  = 4      /**< JPX file format (JPEG 2000 Part-2) : to be coded */
 299 } OPJ_CODEC_FORMAT;
 300
 301
 302 /*
 303 ==========================================================
 304    event manager typedef definitions
 305 ==========================================================
 306 */
 307
 308 /**
 309  * Callback function prototype for events
 310  * @param msg               Event message
 311  * @param client_data       Client object where will be return the event message
 312  * */
 313 typedef void (*opj_msg_callback)(const char *msg, void *client_data);
 314
 315 /*
 316 ==========================================================
 317    codec typedef definitions
 318 ==========================================================
 319 */
 320
 321 /**
 322  * Progression order changes
 323  *
 324  */
 325 typedef struct opj_poc {
 326     /** Resolution num start, Component num start, given by POC */
 327     OPJ_UINT32 resno0, compno0;
 328     /** Layer num end,Resolution num end, Component num end, given by POC */
 329     OPJ_UINT32 layno1, resno1, compno1;
 330     /** Layer num start,Precinct num start, Precinct num end */
 331     OPJ_UINT32 layno0, precno0, precno1;
 332     /** Progression order enum*/
 333     OPJ_PROG_ORDER prg1, prg;
 334     /** Progression order string*/
 335     OPJ_CHAR progorder[5];
 336     /** Tile number */
 337     OPJ_UINT32 tile;
 338     /** Start and end values for Tile width and height*/
 339     OPJ_INT32 tx0, tx1, ty0, ty1;
 340     /** Start value, initialised in pi_initialise_encode*/
 341     OPJ_UINT32 layS, resS, compS, prcS;
 342     /** End value, initialised in pi_initialise_encode */
 343     OPJ_UINT32 layE, resE, compE, prcE;
 344     /** Start and end values of Tile width and height, initialised in pi_initialise_encode*/
 345     OPJ_UINT32 txS, txE, tyS, tyE, dx, dy;
 346     /** Temporary values for Tile parts, initialised in pi_create_encode */
 347     OPJ_UINT32 lay_t, res_t, comp_t, prc_t, tx0_t, ty0_t;
 348 } opj_poc_t;
 349
 350 /**
 351  * Compression parameters
 352  * */
 353 typedef struct opj_cparameters {
 354     /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */
 355     OPJ_BOOL tile_size_on;
 356     /** XTOsiz */
 357     int cp_tx0;
 358     /** YTOsiz */
 359     int cp_ty0;
 360     /** XTsiz */
 361     int cp_tdx;
 362     /** YTsiz */
 363     int cp_tdy;
 364     /** allocation by rate/distortion */
 365     int cp_disto_alloc;
 366     /** allocation by fixed layer */
 367     int cp_fixed_alloc;
 368     /** add fixed_quality */
 369     int cp_fixed_quality;
 370     /** fixed layer */
 371     int *cp_matrice;
 372     /** comment for coding */
 373     char *cp_comment;
 374     /** csty : coding style */
 375     int csty;
 376     /** progression order (default OPJ_LRCP) */
 377     OPJ_PROG_ORDER prog_order;
 378     /** progression order changes */
 379     opj_poc_t POC[32];
 380     /** number of progression order changes (POC), default to 0 */
 381     OPJ_UINT32 numpocs;
 382     /** number of layers */
 383     int tcp_numlayers;
 384     /** rates of layers - might be subsequently limited by the max_cs_size field */
 385     float tcp_rates[100];
 386     /** different psnr for successive layers */
 387     float tcp_distoratio[100];
 388     /** number of resolutions */
 389     int numresolution;
 390     /** initial code block width, default to 64 */
 391     int cblockw_init;
 392     /** initial code block height, default to 64 */
 393     int cblockh_init;
 394     /** mode switch (cblk_style) */
 395     int mode;
 396     /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
 397     int irreversible;
 398     /** region of interest: affected component in [0..3], -1 means no ROI */
 399     int roi_compno;
 400     /** region of interest: upshift value */
 401     int roi_shift;
 402     /* number of precinct size specifications */
 403     int res_spec;
 404     /** initial precinct width */
 405     int prcw_init[OPJ_J2K_MAXRLVLS];
 406     /** initial precinct height */
 407     int prch_init[OPJ_J2K_MAXRLVLS];
 408
 409     /**@name command line encoder parameters (not used inside the library) */
 410     /*@{*/
 411     /** input file name */
 412     char infile[OPJ_PATH_LEN];
 413     /** output file name */
 414     char outfile[OPJ_PATH_LEN];
 415     /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
 416     int index_on;
 417     /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
 418     char index[OPJ_PATH_LEN];
 419     /** subimage encoding: origin image offset in x direction */
 420     int image_offset_x0;
 421     /** subimage encoding: origin image offset in y direction */
 422     int image_offset_y0;
 423     /** subsampling value for dx */
 424     int subsampling_dx;
 425     /** subsampling value for dy */
 426     int subsampling_dy;
 427     /** input file format 0: PGX, 1: PxM, 2: BMP 3:TIF*/
 428     int decod_format;
 429     /** output file format 0: J2K, 1: JP2, 2: JPT */
 430     int cod_format;
 431     /*@}*/
 432
 433     /* UniPG>> */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */
 434     /**@name JPWL encoding parameters */
 435     /*@{*/
 436     /** enables writing of EPC in MH, thus activating JPWL */
 437     OPJ_BOOL jpwl_epc_on;
 438     /** error protection method for MH (0,1,16,32,37-128) */
 439     int jpwl_hprot_MH;
 440     /** tile number of header protection specification (>=0) */
 441     int jpwl_hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 442     /** error protection methods for TPHs (0,1,16,32,37-128) */
 443     int jpwl_hprot_TPH[JPWL_MAX_NO_TILESPECS];
 444     /** tile number of packet protection specification (>=0) */
 445     int jpwl_pprot_tileno[JPWL_MAX_NO_PACKSPECS];
 446     /** packet number of packet protection specification (>=0) */
 447     int jpwl_pprot_packno[JPWL_MAX_NO_PACKSPECS];
 448     /** error protection methods for packets (0,1,16,32,37-128) */
 449     int jpwl_pprot[JPWL_MAX_NO_PACKSPECS];
 450     /** enables writing of ESD, (0=no/1/2 bytes) */
 451     int jpwl_sens_size;
 452     /** sensitivity addressing size (0=auto/2/4 bytes) */
 453     int jpwl_sens_addr;
 454     /** sensitivity range (0-3) */
 455     int jpwl_sens_range;
 456     /** sensitivity method for MH (-1=no,0-7) */
 457     int jpwl_sens_MH;
 458     /** tile number of sensitivity specification (>=0) */
 459     int jpwl_sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 460     /** sensitivity methods for TPHs (-1=no,0-7) */
 461     int jpwl_sens_TPH[JPWL_MAX_NO_TILESPECS];
 462     /*@}*/
 463     /* <<UniPG */
 464
 465     /**
 466      * DEPRECATED: use RSIZ, OPJ_PROFILE_* and MAX_COMP_SIZE instead
 467      * Digital Cinema compliance 0-not compliant, 1-compliant
 468      * */
 469     OPJ_CINEMA_MODE cp_cinema;
 470     /**
 471      * Maximum size (in bytes) for each component.
 472      * If == 0, component size limitation is not considered
 473      * */
 474     int max_comp_size;
 475     /**
 476      * DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead
 477      * Profile name
 478      * */
 479     OPJ_RSIZ_CAPABILITIES cp_rsiz;
 480     /** Tile part generation*/
 481     char tp_on;
 482     /** Flag for Tile part generation*/
 483     char tp_flag;
 484     /** MCT (multiple component transform) */
 485     char tcp_mct;
 486     /** Enable JPIP indexing*/
 487     OPJ_BOOL jpip_on;
 488     /** Naive implementation of MCT restricted to a single reversible array based
 489         encoding without offset concerning all the components. */
 490     void * mct_data;
 491     /**
 492      * Maximum size (in bytes) for the whole codestream.
 493      * If == 0, codestream size limitation is not considered
 494      * If it does not comply with tcp_rates, max_cs_size prevails
 495      * and a warning is issued.
 496      * */
 497     int max_cs_size;
 498     /** RSIZ value
 499         To be used to combine OPJ_PROFILE_*, OPJ_EXTENSION_* and (sub)levels values. */
 500     OPJ_UINT16 rsiz;
 501 } opj_cparameters_t;
 502
 503 #define OPJ_DPARAMETERS_IGNORE_PCLR_CMAP_CDEF_FLAG  0x0001
 504
 505 /**
 506  * Decompression parameters
 507  * */
 508 typedef struct opj_dparameters {
 509     /**
 510     Set the number of highest resolution levels to be discarded.
 511     The image resolution is effectively divided by 2 to the power of the number of discarded levels.
 512     The reduce factor is limited by the smallest total number of decomposition levels among tiles.
 513     if != 0, then original dimension divided by 2^(reduce);
 514     if == 0 or not used, image is decoded to the full resolution
 515     */
 516     OPJ_UINT32 cp_reduce;
 517     /**
 518     Set the maximum number of quality layers to decode.
 519     If there are less quality layers than the specified number, all the quality layers are decoded.
 520     if != 0, then only the first "layer" layers are decoded;
 521     if == 0 or not used, all the quality layers are decoded
 522     */
 523     OPJ_UINT32 cp_layer;
 524
 525     /**@name command line decoder parameters (not used inside the library) */
 526     /*@{*/
 527     /** input file name */
 528     char infile[OPJ_PATH_LEN];
 529     /** output file name */
 530     char outfile[OPJ_PATH_LEN];
 531     /** input file format 0: J2K, 1: JP2, 2: JPT */
 532     int decod_format;
 533     /** output file format 0: PGX, 1: PxM, 2: BMP */
 534     int cod_format;
 535
 536     /** Decoding area left boundary */
 537     OPJ_UINT32 DA_x0;
 538     /** Decoding area right boundary */
 539     OPJ_UINT32 DA_x1;
 540     /** Decoding area up boundary */
 541     OPJ_UINT32 DA_y0;
 542     /** Decoding area bottom boundary */
 543     OPJ_UINT32 DA_y1;
 544     /** Verbose mode */
 545     OPJ_BOOL m_verbose;
 546
 547     /** tile number ot the decoded tile*/
 548     OPJ_UINT32 tile_index;
 549     /** Nb of tile to decode */
 550     OPJ_UINT32 nb_tile_to_decode;
 551
 552     /*@}*/
 553
 554     /* UniPG>> */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */
 555     /**@name JPWL decoding parameters */
 556     /*@{*/
 557     /** activates the JPWL correction capabilities */
 558     OPJ_BOOL jpwl_correct;
 559     /** expected number of components */
 560     int jpwl_exp_comps;
 561     /** maximum number of tiles */
 562     int jpwl_max_tiles;
 563     /*@}*/
 564     /* <<UniPG */
 565
 566     unsigned int flags;
 567     unsigned int dump_state; /* AFL test */
 568
 569 } opj_dparameters_t;
 570
 571
 572 /**
 573  * JPEG2000 codec V2.
 574  * */
 575 typedef void * opj_codec_t;
 576
 577 /*
 578 ==========================================================
 579    I/O stream typedef definitions
 580 ==========================================================
 581 */
 582
 583 /**
 584  * Stream open flags.
 585  * */
 586 /** The stream was opened for reading. */
 587 #define OPJ_STREAM_READ OPJ_TRUE
 588 /** The stream was opened for writing. */
 589 #define OPJ_STREAM_WRITE OPJ_FALSE
 590
 591 /*
 592  * Callback function prototype for read function
 593  */
 594 typedef OPJ_SIZE_T(* opj_stream_read_fn)(void * p_buffer, OPJ_SIZE_T p_nb_bytes,
 595         void * p_user_data) ;
 596
 597 /*
 598  * Callback function prototype for write function
 599  */
 600 typedef OPJ_SIZE_T(* opj_stream_write_fn)(void * p_buffer,
 601         OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
 602
 603 /*
 604  * Callback function prototype for skip function
 605  */
 606 typedef OPJ_OFF_T(* opj_stream_skip_fn)(OPJ_OFF_T p_nb_bytes,
 607                                         void * p_user_data) ;
 608
 609 /*
 610  * Callback function prototype for seek function
 611  */
 612 typedef OPJ_BOOL(* opj_stream_seek_fn)(OPJ_OFF_T p_nb_bytes,
 613                                        void * p_user_data) ;
 614
 615 /*
 616  * Callback function prototype for free user data function
 617  */
 618 typedef void (* opj_stream_free_user_data_fn)(void * p_user_data) ;
 619
 620 /*
 621  * JPEG2000 Stream.
 622  */
 623 typedef void * opj_stream_t;
 624
 625 /*
 626 ==========================================================
 627    image typedef definitions
 628 ==========================================================
 629 */
 630
 631 /**
 632  * Defines a single image component
 633  * */
 634 typedef struct opj_image_comp {
 635     /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
 636     OPJ_UINT32 dx;
 637     /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
 638     OPJ_UINT32 dy;
 639     /** data width */
 640     OPJ_UINT32 w;
 641     /** data height */
 642     OPJ_UINT32 h;
 643     /** x component offset compared to the whole image */
 644     OPJ_UINT32 x0;
 645     /** y component offset compared to the whole image */
 646     OPJ_UINT32 y0;
 647     /** precision */
 648     OPJ_UINT32 prec;
 649     /** image depth in bits */
 650     OPJ_UINT32 bpp;
 651     /** signed (1) / unsigned (0) */
 652     OPJ_UINT32 sgnd;
 653     /** number of decoded resolution */
 654     OPJ_UINT32 resno_decoded;
 655     /** number of division by 2 of the out image compared to the original size of image */
 656     OPJ_UINT32 factor;
 657     /** image component data */
 658     OPJ_INT32 *data;
 659     /** alpha channel */
 660     OPJ_UINT16 alpha;
 661 } opj_image_comp_t;
 662
 663 /**
 664  * Defines image data and characteristics
 665  * */
 666 typedef struct opj_image {
 667     /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
 668     OPJ_UINT32 x0;
 669     /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
 670     OPJ_UINT32 y0;
 671     /** Xsiz: width of the reference grid */
 672     OPJ_UINT32 x1;
 673     /** Ysiz: height of the reference grid */
 674     OPJ_UINT32 y1;
 675     /** number of components in the image */
 676     OPJ_UINT32 numcomps;
 677     /** color space: sRGB, Greyscale or YUV */
 678     OPJ_COLOR_SPACE color_space;
 679     /** image components */
 680     opj_image_comp_t *comps;
 681     /** 'restricted' ICC profile */
 682     OPJ_BYTE *icc_profile_buf;
 683     /** size of ICC profile */
 684     OPJ_UINT32 icc_profile_len;
 685 } opj_image_t;
 686
 687
 688 /**
 689  * Component parameters structure used by the opj_image_create function
 690  * */
 691 typedef struct opj_image_comptparm {
 692     /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
 693     OPJ_UINT32 dx;
 694     /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
 695     OPJ_UINT32 dy;
 696     /** data width */
 697     OPJ_UINT32 w;
 698     /** data height */
 699     OPJ_UINT32 h;
 700     /** x component offset compared to the whole image */
 701     OPJ_UINT32 x0;
 702     /** y component offset compared to the whole image */
 703     OPJ_UINT32 y0;
 704     /** precision */
 705     OPJ_UINT32 prec;
 706     /** image depth in bits */
 707     OPJ_UINT32 bpp;
 708     /** signed (1) / unsigned (0) */
 709     OPJ_UINT32 sgnd;
 710 } opj_image_cmptparm_t;
 711
 712
 713 /*
 714 ==========================================================
 715    Information on the JPEG 2000 codestream
 716 ==========================================================
 717 */
 718 /* QUITE EXPERIMENTAL FOR THE MOMENT */
 719
 720 /**
 721  * Index structure : Information concerning a packet inside tile
 722  * */
 723 typedef struct opj_packet_info {
 724     /** packet start position (including SOP marker if it exists) */
 725     OPJ_OFF_T start_pos;
 726     /** end of packet header position (including EPH marker if it exists)*/
 727     OPJ_OFF_T end_ph_pos;
 728     /** packet end position */
 729     OPJ_OFF_T end_pos;
 730     /** packet distorsion */
 731     double disto;
 732 } opj_packet_info_t;
 733
 734
 735 /* UniPG>> */
 736 /**
 737  * Marker structure
 738  * */
 739 typedef struct opj_marker_info {
 740     /** marker type */
 741     unsigned short int type;
 742     /** position in codestream */
 743     OPJ_OFF_T pos;
 744     /** length, marker val included */
 745     int len;
 746 } opj_marker_info_t;
 747 /* <<UniPG */
 748
 749 /**
 750  * Index structure : Information concerning tile-parts
 751 */
 752 typedef struct opj_tp_info {
 753     /** start position of tile part */
 754     int tp_start_pos;
 755     /** end position of tile part header */
 756     int tp_end_header;
 757     /** end position of tile part */
 758     int tp_end_pos;
 759     /** start packet of tile part */
 760     int tp_start_pack;
 761     /** number of packets of tile part */
 762     int tp_numpacks;
 763 } opj_tp_info_t;
 764
 765 /**
 766  * Index structure : information regarding tiles
 767 */
 768 typedef struct opj_tile_info {
 769     /** value of thresh for each layer by tile cfr. Marcela   */
 770     double *thresh;
 771     /** number of tile */
 772     int tileno;
 773     /** start position */
 774     int start_pos;
 775     /** end position of the header */
 776     int end_header;
 777     /** end position */
 778     int end_pos;
 779     /** precinct number for each resolution level (width) */
 780     int pw[33];
 781     /** precinct number for each resolution level (height) */
 782     int ph[33];
 783     /** precinct size (in power of 2), in X for each resolution level */
 784     int pdx[33];
 785     /** precinct size (in power of 2), in Y for each resolution level */
 786     int pdy[33];
 787     /** information concerning packets inside tile */
 788     opj_packet_info_t *packet;
 789     /** add fixed_quality */
 790     int numpix;
 791     /** add fixed_quality */
 792     double distotile;
 793     /** number of markers */
 794     int marknum;
 795     /** list of markers */
 796     opj_marker_info_t *marker;
 797     /** actual size of markers array */
 798     int maxmarknum;
 799     /** number of tile parts */
 800     int num_tps;
 801     /** information concerning tile parts */
 802     opj_tp_info_t *tp;
 803 } opj_tile_info_t;
 804
 805 /**
 806  * Index structure of the codestream
 807 */
 808 typedef struct opj_codestream_info {
 809     /** maximum distortion reduction on the whole image (add for Marcela) */
 810     double D_max;
 811     /** packet number */
 812     int packno;
 813     /** writing the packet in the index with t2_encode_packets */
 814     int index_write;
 815     /** image width */
 816     int image_w;
 817     /** image height */
 818     int image_h;
 819     /** progression order */
 820     OPJ_PROG_ORDER prog;
 821     /** tile size in x */
 822     int tile_x;
 823     /** tile size in y */
 824     int tile_y;
 825     /** */
 826     int tile_Ox;
 827     /** */
 828     int tile_Oy;
 829     /** number of tiles in X */
 830     int tw;
 831     /** number of tiles in Y */
 832     int th;
 833     /** component numbers */
 834     int numcomps;
 835     /** number of layer */
 836     int numlayers;
 837     /** number of decomposition for each component */
 838     int *numdecompos;
 839     /* UniPG>> */
 840     /** number of markers */
 841     int marknum;
 842     /** list of markers */
 843     opj_marker_info_t *marker;
 844     /** actual size of markers array */
 845     int maxmarknum;
 846     /* <<UniPG */
 847     /** main header position */
 848     int main_head_start;
 849     /** main header position */
 850     int main_head_end;
 851     /** codestream's size */
 852     int codestream_size;
 853     /** information regarding tiles inside image */
 854     opj_tile_info_t *tile;
 855 } opj_codestream_info_t;
 856
 857 /* <----------------------------------------------------------- */
 858 /* new output management of the codestream information and index */
 859
 860 /**
 861  * Tile-component coding parameters information
 862  */
 863 typedef struct opj_tccp_info {
 864     /** component index */
 865     OPJ_UINT32 compno;
 866     /** coding style */
 867     OPJ_UINT32 csty;
 868     /** number of resolutions */
 869     OPJ_UINT32 numresolutions;
 870     /** code-blocks width */
 871     OPJ_UINT32 cblkw;
 872     /** code-blocks height */
 873     OPJ_UINT32 cblkh;
 874     /** code-block coding style */
 875     OPJ_UINT32 cblksty;
 876     /** discrete wavelet transform identifier */
 877     OPJ_UINT32 qmfbid;
 878     /** quantisation style */
 879     OPJ_UINT32 qntsty;
 880     /** stepsizes used for quantization */
 881     OPJ_UINT32 stepsizes_mant[OPJ_J2K_MAXBANDS];
 882     /** stepsizes used for quantization */
 883     OPJ_UINT32 stepsizes_expn[OPJ_J2K_MAXBANDS];
 884     /** number of guard bits */
 885     OPJ_UINT32 numgbits;
 886     /** Region Of Interest shift */
 887     OPJ_INT32 roishift;
 888     /** precinct width */
 889     OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
 890     /** precinct height */
 891     OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
 892 }
 893 opj_tccp_info_t;
 894
 895 /**
 896  * Tile coding parameters information
 897  */
 898 typedef struct opj_tile_v2_info {
 899
 900     /** number (index) of tile */
 901     int tileno;
 902     /** coding style */
 903     OPJ_UINT32 csty;
 904     /** progression order */
 905     OPJ_PROG_ORDER prg;
 906     /** number of layers */
 907     OPJ_UINT32 numlayers;
 908     /** multi-component transform identifier */
 909     OPJ_UINT32 mct;
 910
 911     /** information concerning tile component parameters*/
 912     opj_tccp_info_t *tccp_info;
 913
 914 } opj_tile_info_v2_t;
 915
 916 /**
 917  * Information structure about the codestream (FIXME should be expand and enhance)
 918  */
 919 typedef struct opj_codestream_info_v2 {
 920     /* Tile info */
 921     /** tile origin in x = XTOsiz */
 922     OPJ_UINT32 tx0;
 923     /** tile origin in y = YTOsiz */
 924     OPJ_UINT32 ty0;
 925     /** tile size in x = XTsiz */
 926     OPJ_UINT32 tdx;
 927     /** tile size in y = YTsiz */
 928     OPJ_UINT32 tdy;
 929     /** number of tiles in X */
 930     OPJ_UINT32 tw;
 931     /** number of tiles in Y */
 932     OPJ_UINT32 th;
 933
 934     /** number of components*/
 935     OPJ_UINT32 nbcomps;
 936
 937     /** Default information regarding tiles inside image */
 938     opj_tile_info_v2_t m_default_tile_info;
 939
 940     /** information regarding tiles inside image */
 941     opj_tile_info_v2_t *tile_info; /* FIXME not used for the moment */
 942
 943 } opj_codestream_info_v2_t;
 944
 945
 946 /**
 947  * Index structure about a tile part
 948  */
 949 typedef struct opj_tp_index {
 950     /** start position */
 951     OPJ_OFF_T start_pos;
 952     /** end position of the header */
 953     OPJ_OFF_T end_header;
 954     /** end position */
 955     OPJ_OFF_T end_pos;
 956
 957 } opj_tp_index_t;
 958
 959 /**
 960  * Index structure about a tile
 961  */
 962 typedef struct opj_tile_index {
 963     /** tile index */
 964     OPJ_UINT32 tileno;
 965
 966     /** number of tile parts */
 967     OPJ_UINT32 nb_tps;
 968     /** current nb of tile part (allocated)*/
 969     OPJ_UINT32 current_nb_tps;
 970     /** current tile-part index */
 971     OPJ_UINT32 current_tpsno;
 972     /** information concerning tile parts */
 973     opj_tp_index_t *tp_index;
 974
 975     /* UniPG>> */ /* NOT USED FOR THE MOMENT IN THE V2 VERSION */
 976     /** number of markers */
 977     OPJ_UINT32 marknum;
 978     /** list of markers */
 979     opj_marker_info_t *marker;
 980     /** actual size of markers array */
 981     OPJ_UINT32 maxmarknum;
 982     /* <<UniPG */
 983
 984     /** packet number */
 985     OPJ_UINT32 nb_packet;
 986     /** information concerning packets inside tile */
 987     opj_packet_info_t *packet_index;
 988
 989 } opj_tile_index_t;
 990
 991 /**
 992  * Index structure of the codestream (FIXME should be expand and enhance)
 993  */
 994 typedef struct opj_codestream_index {
 995     /** main header start position (SOC position) */
 996     OPJ_OFF_T main_head_start;
 997     /** main header end position (first SOT position) */
 998     OPJ_OFF_T main_head_end;
 999
1000     /** codestream's size */
1001     OPJ_UINT64 codestream_size;
1002
1003     /* UniPG>> */ /* NOT USED FOR THE MOMENT IN THE V2 VERSION */
1004     /** number of markers */
1005     OPJ_UINT32 marknum;
1006     /** list of markers */
1007     opj_marker_info_t *marker;
1008     /** actual size of markers array */
1009     OPJ_UINT32 maxmarknum;
1010     /* <<UniPG */
1011
1012     /** */
1013     OPJ_UINT32 nb_of_tiles;
1014     /** */
1015     opj_tile_index_t *tile_index; /* FIXME not used for the moment */
1016
1017 } opj_codestream_index_t;
1018 /* -----------------------------------------------------------> */
1019
1020 /*
1021 ==========================================================
1022    Metadata from the JP2file
1023 ==========================================================
1024 */
1025
1026 /**
1027  * Info structure of the JP2 file
1028  * EXPERIMENTAL FOR THE MOMENT
1029  */
1030 typedef struct opj_jp2_metadata {
1031     /** */
1032     OPJ_INT32   not_used;
1033
1034 } opj_jp2_metadata_t;
1035
1036 /**
1037  * Index structure of the JP2 file
1038  * EXPERIMENTAL FOR THE MOMENT
1039  */
1040 typedef struct opj_jp2_index {
1041     /** */
1042     OPJ_INT32   not_used;
1043
1044 } opj_jp2_index_t;
1045
1046
1047 #ifdef __cplusplus
1048 extern "C" {
1049 #endif
1050
1051
1052 /*
1053 ==========================================================
1054    openjpeg version
1055 ==========================================================
1056 */
1057
1058 /* Get the version of the openjpeg library*/
1059 OPJ_API const char * OPJ_CALLCONV opj_version(void);
1060
1061 /*
1062 ==========================================================
1063    image functions definitions
1064 ==========================================================
1065 */
1066
1067 /**
1068  * Create an image
1069  *
1070  * @param numcmpts      number of components
1071  * @param cmptparms     components parameters
1072  * @param clrspc        image color space
1073  * @return returns      a new image structure if successful, returns NULL otherwise
1074  * */
1075 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(OPJ_UINT32 numcmpts,
1076         opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1077
1078 /**
1079  * Deallocate any resources associated with an image
1080  *
1081  * @param image         image to be destroyed
1082  */
1083 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
1084
1085 /**
1086  * Creates an image without allocating memory for the image (used in the new version of the library).
1087  *
1088  * @param   numcmpts    the number of components
1089  * @param   cmptparms   the components parameters
1090  * @param   clrspc      the image color space
1091  *
1092  * @return  a new image structure if successful, NULL otherwise.
1093 */
1094 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_tile_create(OPJ_UINT32 numcmpts,
1095         opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1096
1097 /*
1098 ==========================================================
1099    stream functions definitions
1100 ==========================================================
1101 */
1102
1103 /**
1104  * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1105  *
1106  * @param   p_is_input      if set to true then the stream will be an input stream, an output stream else.
1107  *
1108  * @return  a stream object.
1109 */
1110 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_default_create(
1111     OPJ_BOOL p_is_input);
1112
1113 /**
1114  * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1115  *
1116  * @param   p_buffer_size  FIXME DOC
1117  * @param   p_is_input      if set to true then the stream will be an input stream, an output stream else.
1118  *
1119  * @return  a stream object.
1120 */
1121 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create(OPJ_SIZE_T p_buffer_size,
1122         OPJ_BOOL p_is_input);
1123
1124 /**
1125  * Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must
1126  * close its own implementation of the stream.
1127  *
1128  * @param   p_stream    the stream to destroy.
1129  */
1130 OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream);
1131
1132 /**
1133  * Sets the given function to be used as a read function.
1134  * @param       p_stream    the stream to modify
1135  * @param       p_function  the function to use a read function.
1136 */
1137 OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream,
1138         opj_stream_read_fn p_function);
1139
1140 /**
1141  * Sets the given function to be used as a write function.
1142  * @param       p_stream    the stream to modify
1143  * @param       p_function  the function to use a write function.
1144 */
1145 OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream,
1146         opj_stream_write_fn p_function);
1147
1148 /**
1149  * Sets the given function to be used as a skip function.
1150  * @param       p_stream    the stream to modify
1151  * @param       p_function  the function to use a skip function.
1152 */
1153 OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream,
1154         opj_stream_skip_fn p_function);
1155
1156 /**
1157  * Sets the given function to be used as a seek function, the stream is then seekable.
1158  * @param       p_stream    the stream to modify
1159  * @param       p_function  the function to use a skip function.
1160 */
1161 OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream,
1162         opj_stream_seek_fn p_function);
1163
1164 /**
1165  * Sets the given data to be used as a user data for the stream.
1166  * @param       p_stream    the stream to modify
1167  * @param       p_data      the data to set.
1168  * @param       p_function  the function to free p_data when opj_stream_destroy() is called.
1169 */
1170 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data(opj_stream_t* p_stream,
1171         void * p_data, opj_stream_free_user_data_fn p_function);
1172
1173 /**
1174  * Sets the length of the user data for the stream.
1175  *
1176  * @param p_stream    the stream to modify
1177  * @param data_length length of the user_data.
1178 */
1179 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data_length(
1180     opj_stream_t* p_stream, OPJ_UINT64 data_length);
1181
1182 /**
1183  * Create a stream from a file identified with its filename with default parameters (helper function)
1184  * @param fname             the filename of the file to stream
1185  * @param p_is_read_stream  whether the stream is a read stream (true) or not (false)
1186 */
1187 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream(
1188     const char *fname, OPJ_BOOL p_is_read_stream);
1189
1190 /** Create a stream from a file identified with its filename with a specific buffer size
1191  * @param fname             the filename of the file to stream
1192  * @param p_buffer_size     size of the chunk used to stream
1193  * @param p_is_read_stream  whether the stream is a read stream (true) or not (false)
1194 */
1195 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream(
1196     const char *fname,
1197     OPJ_SIZE_T p_buffer_size,
1198     OPJ_BOOL p_is_read_stream);
1199
1200 /*
1201 ==========================================================
1202    event manager functions definitions
1203 ==========================================================
1204 */
1205 /**
1206  * Set the info handler use by openjpeg.
1207  * @param p_codec       the codec previously initialise
1208  * @param p_callback    the callback function which will be used
1209  * @param p_user_data   client object where will be returned the message
1210 */
1211 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_info_handler(opj_codec_t * p_codec,
1212         opj_msg_callback p_callback,
1213         void * p_user_data);
1214 /**
1215  * Set the warning handler use by openjpeg.
1216  * @param p_codec       the codec previously initialise
1217  * @param p_callback    the callback function which will be used
1218  * @param p_user_data   client object where will be returned the message
1219 */
1220 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_warning_handler(opj_codec_t * p_codec,
1221         opj_msg_callback p_callback,
1222         void * p_user_data);
1223 /**
1224  * Set the error handler use by openjpeg.
1225  * @param p_codec       the codec previously initialise
1226  * @param p_callback    the callback function which will be used
1227  * @param p_user_data   client object where will be returned the message
1228 */
1229 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_error_handler(opj_codec_t * p_codec,
1230         opj_msg_callback p_callback,
1231         void * p_user_data);
1232
1233 /*
1234 ==========================================================
1235    codec functions definitions
1236 ==========================================================
1237 */
1238
1239 /**
1240  * Creates a J2K/JP2 decompression structure
1241  * @param format        Decoder to select
1242  *
1243  * @return Returns a handle to a decompressor if successful, returns NULL otherwise
1244  * */
1245 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress(
1246     OPJ_CODEC_FORMAT format);
1247
1248 /**
1249  * Destroy a decompressor handle
1250  *
1251  * @param   p_codec         decompressor handle to destroy
1252  */
1253 OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec);
1254
1255 /**
1256  * Read after the codestream if necessary
1257  * @param   p_codec         the JPEG2000 codec to read.
1258  * @param   p_stream        the JPEG2000 stream.
1259  */
1260 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_decompress(opj_codec_t *p_codec,
1261         opj_stream_t *p_stream);
1262
1263
1264 /**
1265  * Set decoding parameters to default values
1266  * @param parameters Decompression parameters
1267  */
1268 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(
1269     opj_dparameters_t *parameters);
1270
1271 /**
1272  * Setup the decoder with decompression parameters provided by the user and with the message handler
1273  * provided by the user.
1274  *
1275  * @param p_codec       decompressor handler
1276  * @param parameters    decompression parameters
1277  *
1278  * @return true         if the decoder is correctly set
1279  */
1280 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_decoder(opj_codec_t *p_codec,
1281         opj_dparameters_t *parameters);
1282
1283 /**
1284  * Allocates worker threads for the compressor/decompressor.
1285  *
1286  * By default, only the main thread is used. If this function is not used,
1287  * but the OPJ_NUM_THREADS environment variable is set, its value will be
1288  * used to initialize the number of threads. The value can be either an integer
1289  * number, or "ALL_CPUS". If OPJ_NUM_THREADS is set and this function is called,
1290  * this function will override the behaviour of the environment variable.
1291  *
1292  * Note: currently only has effect on the decompressor.
1293  *
1294  * @param p_codec       decompressor handler
1295  * @param num_threads   number of threads.
1296  *
1297  * @return OPJ_TRUE     if the decoder is correctly set
1298  */
1299 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_codec_set_threads(opj_codec_t *p_codec,
1300         int num_threads);
1301
1302 /**
1303  * Decodes an image header.
1304  *
1305  * @param   p_stream        the jpeg2000 stream.
1306  * @param   p_codec         the jpeg2000 codec to read.
1307  * @param   p_image         the image structure initialized with the characteristics of encoded image.
1308  *
1309  * @return true             if the main header of the codestream and the JP2 header is correctly read.
1310  */
1311 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_read_header(opj_stream_t *p_stream,
1312         opj_codec_t *p_codec,
1313         opj_image_t **p_image);
1314
1315 /**
1316  * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
1317  *
1318  * @param   p_codec         the jpeg2000 codec.
1319  * @param   p_image         the decoded image previously setted by opj_read_header
1320  * @param   p_start_x       the left position of the rectangle to decode (in image coordinates).
1321  * @param   p_end_x         the right position of the rectangle to decode (in image coordinates).
1322  * @param   p_start_y       the up position of the rectangle to decode (in image coordinates).
1323  * @param   p_end_y         the bottom position of the rectangle to decode (in image coordinates).
1324  *
1325  * @return  true            if the area could be set.
1326  */
1327 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decode_area(opj_codec_t *p_codec,
1328         opj_image_t* p_image,
1329         OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
1330         OPJ_INT32 p_end_x, OPJ_INT32 p_end_y);
1331
1332 /**
1333  * Decode an image from a JPEG-2000 codestream
1334  *
1335  * @param p_decompressor    decompressor handle
1336  * @param p_stream          Input buffer stream
1337  * @param p_image           the decoded image
1338  * @return                  true if success, otherwise false
1339  * */
1340 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode(opj_codec_t *p_decompressor,
1341         opj_stream_t *p_stream,
1342         opj_image_t *p_image);
1343
1344 /**
1345  * Get the decoded tile from the codec
1346  *
1347  * @param   p_codec         the jpeg2000 codec.
1348  * @param   p_stream        input streamm
1349  * @param   p_image         output image
1350  * @param   tile_index      index of the tile which will be decode
1351  *
1352  * @return                  true if success, otherwise false
1353  */
1354 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_get_decoded_tile(opj_codec_t *p_codec,
1355         opj_stream_t *p_stream,
1356         opj_image_t *p_image,
1357         OPJ_UINT32 tile_index);
1358
1359 /**
1360  * Set the resolution factor of the decoded image
1361  * @param   p_codec         the jpeg2000 codec.
1362  * @param   res_factor      resolution factor to set
1363  *
1364  * @return                  true if success, otherwise false
1365  */
1366 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decoded_resolution_factor(
1367     opj_codec_t *p_codec, OPJ_UINT32 res_factor);
1368
1369 /**
1370  * Writes a tile with the given data.
1371  *
1372  * @param   p_codec             the jpeg2000 codec.
1373  * @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.
1374  * @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.
1375  * @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
1376  *                              tile_width * tile_height * component_size. component_size can be 1,2 or 4 bytes, depending on the precision of the given component.
1377  * @param   p_stream            the stream to write data to.
1378  *
1379  * @return  true if the data could be written.
1380  */
1381 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_write_tile(opj_codec_t *p_codec,
1382         OPJ_UINT32 p_tile_index,
1383         OPJ_BYTE * p_data,
1384         OPJ_UINT32 p_data_size,
1385         opj_stream_t *p_stream);
1386
1387 /**
1388  * Reads a tile header. This function is compulsory and allows one to know the size of the tile that will be decoded.
1389  * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1390  *
1391  * @param   p_codec         the jpeg2000 codec.
1392  * @param   p_tile_index    pointer to a value that will hold the index of the tile being decoded, in case of success.
1393  * @param   p_data_size     pointer to a value that will hold the maximum size of the decoded data, in case of success. In case
1394  *                          of truncated codestreams, the actual number of bytes decoded may be lower. The computation of the size is the same
1395  *                          as depicted in opj_write_tile.
1396  * @param   p_tile_x0       pointer to a value that will hold the x0 pos of the tile (in the image).
1397  * @param   p_tile_y0       pointer to a value that will hold the y0 pos of the tile (in the image).
1398  * @param   p_tile_x1       pointer to a value that will hold the x1 pos of the tile (in the image).
1399  * @param   p_tile_y1       pointer to a value that will hold the y1 pos of the tile (in the image).
1400  * @param   p_nb_comps      pointer to a value that will hold the number of components in the tile.
1401  * @param   p_should_go_on  pointer to a boolean that will hold the fact that the decoding should go on. In case the
1402  *                          codestream is over at the time of the call, the value will be set to false. The user should then stop
1403  *                          the decoding.
1404  * @param   p_stream        the stream to decode.
1405  * @return  true            if the tile header could be decoded. In case the decoding should end, the returned value is still true.
1406  *                          returning false may be the result of a shortage of memory or an internal error.
1407  */
1408 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_read_tile_header(opj_codec_t *p_codec,
1409         opj_stream_t * p_stream,
1410         OPJ_UINT32 * p_tile_index,
1411         OPJ_UINT32 * p_data_size,
1412         OPJ_INT32 * p_tile_x0, OPJ_INT32 * p_tile_y0,
1413         OPJ_INT32 * p_tile_x1, OPJ_INT32 * p_tile_y1,
1414         OPJ_UINT32 * p_nb_comps,
1415         OPJ_BOOL * p_should_go_on);
1416
1417 /**
1418  * Reads a tile data. This function is compulsory and allows one to decode tile data. opj_read_tile_header should be called before.
1419  * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1420  *
1421  * @param   p_codec         the jpeg2000 codec.
1422  * @param   p_tile_index    the index of the tile being decoded, this should be the value set by opj_read_tile_header.
1423  * @param   p_data          pointer to a memory block that will hold the decoded data.
1424  * @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.
1425  * @param   p_stream        the stream to decode.
1426  *
1427  * @return  true            if the data could be decoded.
1428  */
1429 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode_tile_data(opj_codec_t *p_codec,
1430         OPJ_UINT32 p_tile_index,
1431         OPJ_BYTE * p_data,
1432         OPJ_UINT32 p_data_size,
1433         opj_stream_t *p_stream);
1434
1435 /* COMPRESSION FUNCTIONS*/
1436
1437 /**
1438  * Creates a J2K/JP2 compression structure
1439  * @param   format      Coder to select
1440  * @return              Returns a handle to a compressor if successful, returns NULL otherwise
1441  */
1442 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
1443
1444 /**
1445 Set encoding parameters to default values, that means :
1446 <ul>
1447 <li>Lossless
1448 <li>1 tile
1449 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
1450 <li>Size of code-block : 64 x 64
1451 <li>Number of resolutions: 6
1452 <li>No SOP marker in the codestream
1453 <li>No EPH marker in the codestream
1454 <li>No sub-sampling in x or y direction
1455 <li>No mode switch activated
1456 <li>Progression order: LRCP
1457 <li>No index file
1458 <li>No ROI upshifted
1459 <li>No offset of the origin of the image
1460 <li>No offset of the origin of the tiles
1461 <li>Reversible DWT 5-3
1462 </ul>
1463 @param parameters Compression parameters
1464 */
1465 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(
1466     opj_cparameters_t *parameters);
1467
1468 /**
1469  * Setup the encoder parameters using the current image and using user parameters.
1470  * @param p_codec       Compressor handle
1471  * @param parameters    Compression parameters
1472  * @param image         Input filled image
1473  */
1474 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_encoder(opj_codec_t *p_codec,
1475         opj_cparameters_t *parameters,
1476         opj_image_t *image);
1477
1478 /**
1479  * Start to compress the current image.
1480  * @param p_codec       Compressor handle
1481  * @param p_image       Input filled image
1482  * @param p_stream      Input stgream
1483  */
1484 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_start_compress(opj_codec_t *p_codec,
1485         opj_image_t * p_image,
1486         opj_stream_t *p_stream);
1487
1488 /**
1489  * End to compress the current image.
1490  * @param p_codec       Compressor handle
1491  * @param p_stream      Input stgream
1492  */
1493 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_compress(opj_codec_t *p_codec,
1494         opj_stream_t *p_stream);
1495
1496 /**
1497  * Encode an image into a JPEG-2000 codestream
1498  * @param p_codec       compressor handle
1499  * @param p_stream      Output buffer stream
1500  *
1501  * @return              Returns true if successful, returns false otherwise
1502  */
1503 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_encode(opj_codec_t *p_codec,
1504         opj_stream_t *p_stream);
1505 /*
1506 ==========================================================
1507    codec output functions definitions
1508 ==========================================================
1509 */
1510 /* EXPERIMENTAL FUNCTIONS FOR NOW, USED ONLY IN J2K_DUMP*/
1511
1512 /**
1513 Destroy Codestream information after compression or decompression
1514 @param cstr_info Codestream information structure
1515 */
1516 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_v2_t
1517         **cstr_info);
1518
1519
1520 /**
1521  * Dump the codec information into the output stream
1522  *
1523  * @param   p_codec         the jpeg2000 codec.
1524  * @param   info_flag       type of information dump.
1525  * @param   output_stream   output stream where dump the information gotten from the codec.
1526  *
1527  */
1528 OPJ_API void OPJ_CALLCONV opj_dump_codec(opj_codec_t *p_codec,
1529         OPJ_INT32 info_flag,
1530         FILE* output_stream);
1531
1532 /**
1533  * Get the codestream information from the codec
1534  *
1535  * @param   p_codec         the jpeg2000 codec.
1536  *
1537  * @return                  a pointer to a codestream information structure.
1538  *
1539  */
1540 OPJ_API opj_codestream_info_v2_t* OPJ_CALLCONV opj_get_cstr_info(
1541     opj_codec_t *p_codec);
1542
1543 /**
1544  * Get the codestream index from the codec
1545  *
1546  * @param   p_codec         the jpeg2000 codec.
1547  *
1548  * @return                  a pointer to a codestream index structure.
1549  *
1550  */
1551 OPJ_API opj_codestream_index_t * OPJ_CALLCONV opj_get_cstr_index(
1552     opj_codec_t *p_codec);
1553
1554 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_index(opj_codestream_index_t
1555         **p_cstr_index);
1556
1557
1558 /**
1559  * Get the JP2 file information from the codec FIXME
1560  *
1561  * @param   p_codec         the jpeg2000 codec.
1562  *
1563  * @return                  a pointer to a JP2 metadata structure.
1564  *
1565  */
1566 OPJ_API opj_jp2_metadata_t* OPJ_CALLCONV opj_get_jp2_metadata(
1567     opj_codec_t *p_codec);
1568
1569 /**
1570  * Get the JP2 file index from the codec FIXME
1571  *
1572  * @param   p_codec         the jpeg2000 codec.
1573  *
1574  * @return                  a pointer to a JP2 index structure.
1575  *
1576  */
1577 OPJ_API opj_jp2_index_t* OPJ_CALLCONV opj_get_jp2_index(opj_codec_t *p_codec);
1578
1579
1580 /*
1581 ==========================================================
1582    MCT functions
1583 ==========================================================
1584 */
1585
1586 /**
1587  * Sets the MCT matrix to use.
1588  *
1589  * @param   parameters      the parameters to change.
1590  * @param   pEncodingMatrix the encoding matrix.
1591  * @param   p_dc_shift      the dc shift coefficients to use.
1592  * @param   pNbComp         the number of components of the image.
1593  *
1594  * @return  true if the parameters could be set.
1595  */
1596 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_MCT(opj_cparameters_t *parameters,
1597         OPJ_FLOAT32 * pEncodingMatrix,
1598         OPJ_INT32 * p_dc_shift,
1599         OPJ_UINT32 pNbComp);
1600
1601 /*
1602 ==========================================================
1603    Thread functions
1604 ==========================================================
1605 */
1606
1607 /** Returns if the library is built with thread support.
1608  * OPJ_TRUE if mutex, condition, thread, thread pool are available.
1609  */
1610 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_has_thread_support(void);
1611
1612 /** Return the number of virtual CPUs */
1613 OPJ_API int OPJ_CALLCONV opj_get_num_cpus(void);
1614
1615
1616 #ifdef __cplusplus
1617 }
1618 #endif
1619
1620 #endif /* OPENJPEG_H */