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
 568 } opj_dparameters_t;
 569
 570
 571 /**
 572  * JPEG2000 codec V2.
 573  * */
 574 typedef void * opj_codec_t;
 575
 576 /*
 577 ==========================================================
 578    I/O stream typedef definitions
 579 ==========================================================
 580 */
 581
 582 /**
 583  * Stream open flags.
 584  * */
 585 /** The stream was opened for reading. */
 586 #define OPJ_STREAM_READ OPJ_TRUE
 587 /** The stream was opened for writing. */
 588 #define OPJ_STREAM_WRITE OPJ_FALSE
 589
 590 /*
 591  * Callback function prototype for read function
 592  */
 593 typedef OPJ_SIZE_T(* opj_stream_read_fn)(void * p_buffer, OPJ_SIZE_T p_nb_bytes,
 594         void * p_user_data) ;
 595
 596 /*
 597  * Callback function prototype for write function
 598  */
 599 typedef OPJ_SIZE_T(* opj_stream_write_fn)(void * p_buffer,
 600         OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;
 601
 602 /*
 603  * Callback function prototype for skip function
 604  */
 605 typedef OPJ_OFF_T(* opj_stream_skip_fn)(OPJ_OFF_T p_nb_bytes,
 606                                         void * p_user_data) ;
 607
 608 /*
 609  * Callback function prototype for seek function
 610  */
 611 typedef OPJ_BOOL(* opj_stream_seek_fn)(OPJ_OFF_T p_nb_bytes,
 612                                        void * p_user_data) ;
 613
 614 /*
 615  * Callback function prototype for free user data function
 616  */
 617 typedef void (* opj_stream_free_user_data_fn)(void * p_user_data) ;
 618
 619 /*
 620  * JPEG2000 Stream.
 621  */
 622 typedef void * opj_stream_t;
 623
 624 /*
 625 ==========================================================
 626    image typedef definitions
 627 ==========================================================
 628 */
 629
 630 /**
 631  * Defines a single image component
 632  * */
 633 typedef struct opj_image_comp {
 634     /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
 635     OPJ_UINT32 dx;
 636     /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
 637     OPJ_UINT32 dy;
 638     /** data width */
 639     OPJ_UINT32 w;
 640     /** data height */
 641     OPJ_UINT32 h;
 642     /** x component offset compared to the whole image */
 643     OPJ_UINT32 x0;
 644     /** y component offset compared to the whole image */
 645     OPJ_UINT32 y0;
 646     /** precision */
 647     OPJ_UINT32 prec;
 648     /** image depth in bits */
 649     OPJ_UINT32 bpp;
 650     /** signed (1) / unsigned (0) */
 651     OPJ_UINT32 sgnd;
 652     /** number of decoded resolution */
 653     OPJ_UINT32 resno_decoded;
 654     /** number of division by 2 of the out image compared to the original size of image */
 655     OPJ_UINT32 factor;
 656     /** image component data */
 657     OPJ_INT32 *data;
 658     /** alpha channel */
 659     OPJ_UINT16 alpha;
 660 } opj_image_comp_t;
 661
 662 /**
 663  * Defines image data and characteristics
 664  * */
 665 typedef struct opj_image {
 666     /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
 667     OPJ_UINT32 x0;
 668     /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
 669     OPJ_UINT32 y0;
 670     /** Xsiz: width of the reference grid */
 671     OPJ_UINT32 x1;
 672     /** Ysiz: height of the reference grid */
 673     OPJ_UINT32 y1;
 674     /** number of components in the image */
 675     OPJ_UINT32 numcomps;
 676     /** color space: sRGB, Greyscale or YUV */
 677     OPJ_COLOR_SPACE color_space;
 678     /** image components */
 679     opj_image_comp_t *comps;
 680     /** 'restricted' ICC profile */
 681     OPJ_BYTE *icc_profile_buf;
 682     /** size of ICC profile */
 683     OPJ_UINT32 icc_profile_len;
 684 } opj_image_t;
 685
 686
 687 /**
 688  * Component parameters structure used by the opj_image_create function
 689  * */
 690 typedef struct opj_image_comptparm {
 691     /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
 692     OPJ_UINT32 dx;
 693     /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
 694     OPJ_UINT32 dy;
 695     /** data width */
 696     OPJ_UINT32 w;
 697     /** data height */
 698     OPJ_UINT32 h;
 699     /** x component offset compared to the whole image */
 700     OPJ_UINT32 x0;
 701     /** y component offset compared to the whole image */
 702     OPJ_UINT32 y0;
 703     /** precision */
 704     OPJ_UINT32 prec;
 705     /** image depth in bits */
 706     OPJ_UINT32 bpp;
 707     /** signed (1) / unsigned (0) */
 708     OPJ_UINT32 sgnd;
 709 } opj_image_cmptparm_t;
 710
 711
 712 /*
 713 ==========================================================
 714    Information on the JPEG 2000 codestream
 715 ==========================================================
 716 */
 717 /* QUITE EXPERIMENTAL FOR THE MOMENT */
 718
 719 /**
 720  * Index structure : Information concerning a packet inside tile
 721  * */
 722 typedef struct opj_packet_info {
 723     /** packet start position (including SOP marker if it exists) */
 724     OPJ_OFF_T start_pos;
 725     /** end of packet header position (including EPH marker if it exists)*/
 726     OPJ_OFF_T end_ph_pos;
 727     /** packet end position */
 728     OPJ_OFF_T end_pos;
 729     /** packet distorsion */
 730     double disto;
 731 } opj_packet_info_t;
 732
 733
 734 /* UniPG>> */
 735 /**
 736  * Marker structure
 737  * */
 738 typedef struct opj_marker_info {
 739     /** marker type */
 740     unsigned short int type;
 741     /** position in codestream */
 742     OPJ_OFF_T pos;
 743     /** length, marker val included */
 744     int len;
 745 } opj_marker_info_t;
 746 /* <<UniPG */
 747
 748 /**
 749  * Index structure : Information concerning tile-parts
 750 */
 751 typedef struct opj_tp_info {
 752     /** start position of tile part */
 753     int tp_start_pos;
 754     /** end position of tile part header */
 755     int tp_end_header;
 756     /** end position of tile part */
 757     int tp_end_pos;
 758     /** start packet of tile part */
 759     int tp_start_pack;
 760     /** number of packets of tile part */
 761     int tp_numpacks;
 762 } opj_tp_info_t;
 763
 764 /**
 765  * Index structure : information regarding tiles
 766 */
 767 typedef struct opj_tile_info {
 768     /** value of thresh for each layer by tile cfr. Marcela   */
 769     double *thresh;
 770     /** number of tile */
 771     int tileno;
 772     /** start position */
 773     int start_pos;
 774     /** end position of the header */
 775     int end_header;
 776     /** end position */
 777     int end_pos;
 778     /** precinct number for each resolution level (width) */
 779     int pw[33];
 780     /** precinct number for each resolution level (height) */
 781     int ph[33];
 782     /** precinct size (in power of 2), in X for each resolution level */
 783     int pdx[33];
 784     /** precinct size (in power of 2), in Y for each resolution level */
 785     int pdy[33];
 786     /** information concerning packets inside tile */
 787     opj_packet_info_t *packet;
 788     /** add fixed_quality */
 789     int numpix;
 790     /** add fixed_quality */
 791     double distotile;
 792     /** number of markers */
 793     int marknum;
 794     /** list of markers */
 795     opj_marker_info_t *marker;
 796     /** actual size of markers array */
 797     int maxmarknum;
 798     /** number of tile parts */
 799     int num_tps;
 800     /** information concerning tile parts */
 801     opj_tp_info_t *tp;
 802 } opj_tile_info_t;
 803
 804 /**
 805  * Index structure of the codestream
 806 */
 807 typedef struct opj_codestream_info {
 808     /** maximum distortion reduction on the whole image (add for Marcela) */
 809     double D_max;
 810     /** packet number */
 811     int packno;
 812     /** writing the packet in the index with t2_encode_packets */
 813     int index_write;
 814     /** image width */
 815     int image_w;
 816     /** image height */
 817     int image_h;
 818     /** progression order */
 819     OPJ_PROG_ORDER prog;
 820     /** tile size in x */
 821     int tile_x;
 822     /** tile size in y */
 823     int tile_y;
 824     /** */
 825     int tile_Ox;
 826     /** */
 827     int tile_Oy;
 828     /** number of tiles in X */
 829     int tw;
 830     /** number of tiles in Y */
 831     int th;
 832     /** component numbers */
 833     int numcomps;
 834     /** number of layer */
 835     int numlayers;
 836     /** number of decomposition for each component */
 837     int *numdecompos;
 838     /* UniPG>> */
 839     /** number of markers */
 840     int marknum;
 841     /** list of markers */
 842     opj_marker_info_t *marker;
 843     /** actual size of markers array */
 844     int maxmarknum;
 845     /* <<UniPG */
 846     /** main header position */
 847     int main_head_start;
 848     /** main header position */
 849     int main_head_end;
 850     /** codestream's size */
 851     int codestream_size;
 852     /** information regarding tiles inside image */
 853     opj_tile_info_t *tile;
 854 } opj_codestream_info_t;
 855
 856 /* <----------------------------------------------------------- */
 857 /* new output management of the codestream information and index */
 858
 859 /**
 860  * Tile-component coding parameters information
 861  */
 862 typedef struct opj_tccp_info {
 863     /** component index */
 864     OPJ_UINT32 compno;
 865     /** coding style */
 866     OPJ_UINT32 csty;
 867     /** number of resolutions */
 868     OPJ_UINT32 numresolutions;
 869     /** code-blocks width */
 870     OPJ_UINT32 cblkw;
 871     /** code-blocks height */
 872     OPJ_UINT32 cblkh;
 873     /** code-block coding style */
 874     OPJ_UINT32 cblksty;
 875     /** discrete wavelet transform identifier */
 876     OPJ_UINT32 qmfbid;
 877     /** quantisation style */
 878     OPJ_UINT32 qntsty;
 879     /** stepsizes used for quantization */
 880     OPJ_UINT32 stepsizes_mant[OPJ_J2K_MAXBANDS];
 881     /** stepsizes used for quantization */
 882     OPJ_UINT32 stepsizes_expn[OPJ_J2K_MAXBANDS];
 883     /** number of guard bits */
 884     OPJ_UINT32 numgbits;
 885     /** Region Of Interest shift */
 886     OPJ_INT32 roishift;
 887     /** precinct width */
 888     OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
 889     /** precinct height */
 890     OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
 891 }
 892 opj_tccp_info_t;
 893
 894 /**
 895  * Tile coding parameters information
 896  */
 897 typedef struct opj_tile_v2_info {
 898
 899     /** number (index) of tile */
 900     int tileno;
 901     /** coding style */
 902     OPJ_UINT32 csty;
 903     /** progression order */
 904     OPJ_PROG_ORDER prg;
 905     /** number of layers */
 906     OPJ_UINT32 numlayers;
 907     /** multi-component transform identifier */
 908     OPJ_UINT32 mct;
 909
 910     /** information concerning tile component parameters*/
 911     opj_tccp_info_t *tccp_info;
 912
 913 } opj_tile_info_v2_t;
 914
 915 /**
 916  * Information structure about the codestream (FIXME should be expand and enhance)
 917  */
 918 typedef struct opj_codestream_info_v2 {
 919     /* Tile info */
 920     /** tile origin in x = XTOsiz */
 921     OPJ_UINT32 tx0;
 922     /** tile origin in y = YTOsiz */
 923     OPJ_UINT32 ty0;
 924     /** tile size in x = XTsiz */
 925     OPJ_UINT32 tdx;
 926     /** tile size in y = YTsiz */
 927     OPJ_UINT32 tdy;
 928     /** number of tiles in X */
 929     OPJ_UINT32 tw;
 930     /** number of tiles in Y */
 931     OPJ_UINT32 th;
 932
 933     /** number of components*/
 934     OPJ_UINT32 nbcomps;
 935
 936     /** Default information regarding tiles inside image */
 937     opj_tile_info_v2_t m_default_tile_info;
 938
 939     /** information regarding tiles inside image */
 940     opj_tile_info_v2_t *tile_info; /* FIXME not used for the moment */
 941
 942 } opj_codestream_info_v2_t;
 943
 944
 945 /**
 946  * Index structure about a tile part
 947  */
 948 typedef struct opj_tp_index {
 949     /** start position */
 950     OPJ_OFF_T start_pos;
 951     /** end position of the header */
 952     OPJ_OFF_T end_header;
 953     /** end position */
 954     OPJ_OFF_T end_pos;
 955
 956 } opj_tp_index_t;
 957
 958 /**
 959  * Index structure about a tile
 960  */
 961 typedef struct opj_tile_index {
 962     /** tile index */
 963     OPJ_UINT32 tileno;
 964
 965     /** number of tile parts */
 966     OPJ_UINT32 nb_tps;
 967     /** current nb of tile part (allocated)*/
 968     OPJ_UINT32 current_nb_tps;
 969     /** current tile-part index */
 970     OPJ_UINT32 current_tpsno;
 971     /** information concerning tile parts */
 972     opj_tp_index_t *tp_index;
 973
 974     /* UniPG>> */ /* NOT USED FOR THE MOMENT IN THE V2 VERSION */
 975     /** number of markers */
 976     OPJ_UINT32 marknum;
 977     /** list of markers */
 978     opj_marker_info_t *marker;
 979     /** actual size of markers array */
 980     OPJ_UINT32 maxmarknum;
 981     /* <<UniPG */
 982
 983     /** packet number */
 984     OPJ_UINT32 nb_packet;
 985     /** information concerning packets inside tile */
 986     opj_packet_info_t *packet_index;
 987
 988 } opj_tile_index_t;
 989
 990 /**
 991  * Index structure of the codestream (FIXME should be expand and enhance)
 992  */
 993 typedef struct opj_codestream_index {
 994     /** main header start position (SOC position) */
 995     OPJ_OFF_T main_head_start;
 996     /** main header end position (first SOT position) */
 997     OPJ_OFF_T main_head_end;
 998
 999     /** codestream's size */
1000     OPJ_UINT64 codestream_size;
1001
1002     /* UniPG>> */ /* NOT USED FOR THE MOMENT IN THE V2 VERSION */
1003     /** number of markers */
1004     OPJ_UINT32 marknum;
1005     /** list of markers */
1006     opj_marker_info_t *marker;
1007     /** actual size of markers array */
1008     OPJ_UINT32 maxmarknum;
1009     /* <<UniPG */
1010
1011     /** */
1012     OPJ_UINT32 nb_of_tiles;
1013     /** */
1014     opj_tile_index_t *tile_index; /* FIXME not used for the moment */
1015
1016 } opj_codestream_index_t;
1017 /* -----------------------------------------------------------> */
1018
1019 /*
1020 ==========================================================
1021    Metadata from the JP2file
1022 ==========================================================
1023 */
1024
1025 /**
1026  * Info structure of the JP2 file
1027  * EXPERIMENTAL FOR THE MOMENT
1028  */
1029 typedef struct opj_jp2_metadata {
1030     /** */
1031     OPJ_INT32   not_used;
1032
1033 } opj_jp2_metadata_t;
1034
1035 /**
1036  * Index structure of the JP2 file
1037  * EXPERIMENTAL FOR THE MOMENT
1038  */
1039 typedef struct opj_jp2_index {
1040     /** */
1041     OPJ_INT32   not_used;
1042
1043 } opj_jp2_index_t;
1044
1045
1046 #ifdef __cplusplus
1047 extern "C" {
1048 #endif
1049
1050
1051 /*
1052 ==========================================================
1053    openjpeg version
1054 ==========================================================
1055 */
1056
1057 /* Get the version of the openjpeg library*/
1058 OPJ_API const char * OPJ_CALLCONV opj_version(void);
1059
1060 /*
1061 ==========================================================
1062    image functions definitions
1063 ==========================================================
1064 */
1065
1066 /**
1067  * Create an image
1068  *
1069  * @param numcmpts      number of components
1070  * @param cmptparms     components parameters
1071  * @param clrspc        image color space
1072  * @return returns      a new image structure if successful, returns NULL otherwise
1073  * */
1074 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(OPJ_UINT32 numcmpts,
1075         opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1076
1077 /**
1078  * Deallocate any resources associated with an image
1079  *
1080  * @param image         image to be destroyed
1081  */
1082 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
1083
1084 /**
1085  * Creates an image without allocating memory for the image (used in the new version of the library).
1086  *
1087  * @param   numcmpts    the number of components
1088  * @param   cmptparms   the components parameters
1089  * @param   clrspc      the image color space
1090  *
1091  * @return  a new image structure if successful, NULL otherwise.
1092 */
1093 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_tile_create(OPJ_UINT32 numcmpts,
1094         opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
1095
1096 /*
1097 ==========================================================
1098    stream functions definitions
1099 ==========================================================
1100 */
1101
1102 /**
1103  * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1104  *
1105  * @param   p_is_input      if set to true then the stream will be an input stream, an output stream else.
1106  *
1107  * @return  a stream object.
1108 */
1109 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_default_create(
1110     OPJ_BOOL p_is_input);
1111
1112 /**
1113  * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
1114  *
1115  * @param   p_buffer_size  FIXME DOC
1116  * @param   p_is_input      if set to true then the stream will be an input stream, an output stream else.
1117  *
1118  * @return  a stream object.
1119 */
1120 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create(OPJ_SIZE_T p_buffer_size,
1121         OPJ_BOOL p_is_input);
1122
1123 /**
1124  * Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must
1125  * close its own implementation of the stream.
1126  *
1127  * @param   p_stream    the stream to destroy.
1128  */
1129 OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream);
1130
1131 /**
1132  * Sets the given function to be used as a read function.
1133  * @param       p_stream    the stream to modify
1134  * @param       p_function  the function to use a read function.
1135 */
1136 OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream,
1137         opj_stream_read_fn p_function);
1138
1139 /**
1140  * Sets the given function to be used as a write function.
1141  * @param       p_stream    the stream to modify
1142  * @param       p_function  the function to use a write function.
1143 */
1144 OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream,
1145         opj_stream_write_fn p_function);
1146
1147 /**
1148  * Sets the given function to be used as a skip function.
1149  * @param       p_stream    the stream to modify
1150  * @param       p_function  the function to use a skip function.
1151 */
1152 OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream,
1153         opj_stream_skip_fn p_function);
1154
1155 /**
1156  * Sets the given function to be used as a seek function, the stream is then seekable.
1157  * @param       p_stream    the stream to modify
1158  * @param       p_function  the function to use a skip function.
1159 */
1160 OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream,
1161         opj_stream_seek_fn p_function);
1162
1163 /**
1164  * Sets the given data to be used as a user data for the stream.
1165  * @param       p_stream    the stream to modify
1166  * @param       p_data      the data to set.
1167  * @param       p_function  the function to free p_data when opj_stream_destroy() is called.
1168 */
1169 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data(opj_stream_t* p_stream,
1170         void * p_data, opj_stream_free_user_data_fn p_function);
1171
1172 /**
1173  * Sets the length of the user data for the stream.
1174  *
1175  * @param p_stream    the stream to modify
1176  * @param data_length length of the user_data.
1177 */
1178 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data_length(
1179     opj_stream_t* p_stream, OPJ_UINT64 data_length);
1180
1181 /**
1182  * Create a stream from a file identified with its filename with default parameters (helper function)
1183  * @param fname             the filename of the file to stream
1184  * @param p_is_read_stream  whether the stream is a read stream (true) or not (false)
1185 */
1186 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream(
1187     const char *fname, OPJ_BOOL p_is_read_stream);
1188
1189 /** Create a stream from a file identified with its filename with a specific buffer size
1190  * @param fname             the filename of the file to stream
1191  * @param p_buffer_size     size of the chunk used to stream
1192  * @param p_is_read_stream  whether the stream is a read stream (true) or not (false)
1193 */
1194 OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream(
1195     const char *fname,
1196     OPJ_SIZE_T p_buffer_size,
1197     OPJ_BOOL p_is_read_stream);
1198
1199 /*
1200 ==========================================================
1201    event manager functions definitions
1202 ==========================================================
1203 */
1204 /**
1205  * Set the info handler use by openjpeg.
1206  * @param p_codec       the codec previously initialise
1207  * @param p_callback    the callback function which will be used
1208  * @param p_user_data   client object where will be returned the message
1209 */
1210 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_info_handler(opj_codec_t * p_codec,
1211         opj_msg_callback p_callback,
1212         void * p_user_data);
1213 /**
1214  * Set the warning handler use by openjpeg.
1215  * @param p_codec       the codec previously initialise
1216  * @param p_callback    the callback function which will be used
1217  * @param p_user_data   client object where will be returned the message
1218 */
1219 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_warning_handler(opj_codec_t * p_codec,
1220         opj_msg_callback p_callback,
1221         void * p_user_data);
1222 /**
1223  * Set the error handler use by openjpeg.
1224  * @param p_codec       the codec previously initialise
1225  * @param p_callback    the callback function which will be used
1226  * @param p_user_data   client object where will be returned the message
1227 */
1228 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_error_handler(opj_codec_t * p_codec,
1229         opj_msg_callback p_callback,
1230         void * p_user_data);
1231
1232 /*
1233 ==========================================================
1234    codec functions definitions
1235 ==========================================================
1236 */
1237
1238 /**
1239  * Creates a J2K/JP2 decompression structure
1240  * @param format        Decoder to select
1241  *
1242  * @return Returns a handle to a decompressor if successful, returns NULL otherwise
1243  * */
1244 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress(
1245     OPJ_CODEC_FORMAT format);
1246
1247 /**
1248  * Destroy a decompressor handle
1249  *
1250  * @param   p_codec         decompressor handle to destroy
1251  */
1252 OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec);
1253
1254 /**
1255  * Read after the codestream if necessary
1256  * @param   p_codec         the JPEG2000 codec to read.
1257  * @param   p_stream        the JPEG2000 stream.
1258  */
1259 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_decompress(opj_codec_t *p_codec,
1260         opj_stream_t *p_stream);
1261
1262
1263 /**
1264  * Set decoding parameters to default values
1265  * @param parameters Decompression parameters
1266  */
1267 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(
1268     opj_dparameters_t *parameters);
1269
1270 /**
1271  * Setup the decoder with decompression parameters provided by the user and with the message handler
1272  * provided by the user.
1273  *
1274  * @param p_codec       decompressor handler
1275  * @param parameters    decompression parameters
1276  *
1277  * @return true         if the decoder is correctly set
1278  */
1279 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_decoder(opj_codec_t *p_codec,
1280         opj_dparameters_t *parameters);
1281
1282 /**
1283  * Allocates worker threads for the compressor/decompressor.
1284  *
1285  * By default, only the main thread is used. If this function is not used,
1286  * but the OPJ_NUM_THREADS environment variable is set, its value will be
1287  * used to initialize the number of threads. The value can be either an integer
1288  * number, or "ALL_CPUS". If OPJ_NUM_THREADS is set and this function is called,
1289  * this function will override the behaviour of the environment variable.
1290  *
1291  * Note: currently only has effect on the decompressor.
1292  *
1293  * @param p_codec       decompressor handler
1294  * @param num_threads   number of threads.
1295  *
1296  * @return OPJ_TRUE     if the decoder is correctly set
1297  */
1298 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_codec_set_threads(opj_codec_t *p_codec,
1299         int num_threads);
1300
1301 /**
1302  * Decodes an image header.
1303  *
1304  * @param   p_stream        the jpeg2000 stream.
1305  * @param   p_codec         the jpeg2000 codec to read.
1306  * @param   p_image         the image structure initialized with the characteristics of encoded image.
1307  *
1308  * @return true             if the main header of the codestream and the JP2 header is correctly read.
1309  */
1310 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_read_header(opj_stream_t *p_stream,
1311         opj_codec_t *p_codec,
1312         opj_image_t **p_image);
1313
1314 /**
1315  * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
1316  *
1317  * @param   p_codec         the jpeg2000 codec.
1318  * @param   p_image         the decoded image previously setted by opj_read_header
1319  * @param   p_start_x       the left position of the rectangle to decode (in image coordinates).
1320  * @param   p_end_x         the right position of the rectangle to decode (in image coordinates).
1321  * @param   p_start_y       the up position of the rectangle to decode (in image coordinates).
1322  * @param   p_end_y         the bottom position of the rectangle to decode (in image coordinates).
1323  *
1324  * @return  true            if the area could be set.
1325  */
1326 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decode_area(opj_codec_t *p_codec,
1327         opj_image_t* p_image,
1328         OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
1329         OPJ_INT32 p_end_x, OPJ_INT32 p_end_y);
1330
1331 /**
1332  * Decode an image from a JPEG-2000 codestream
1333  *
1334  * @param p_decompressor    decompressor handle
1335  * @param p_stream          Input buffer stream
1336  * @param p_image           the decoded image
1337  * @return                  true if success, otherwise false
1338  * */
1339 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode(opj_codec_t *p_decompressor,
1340         opj_stream_t *p_stream,
1341         opj_image_t *p_image);
1342
1343 /**
1344  * Get the decoded tile from the codec
1345  *
1346  * @param   p_codec         the jpeg2000 codec.
1347  * @param   p_stream        input streamm
1348  * @param   p_image         output image
1349  * @param   tile_index      index of the tile which will be decode
1350  *
1351  * @return                  true if success, otherwise false
1352  */
1353 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_get_decoded_tile(opj_codec_t *p_codec,
1354         opj_stream_t *p_stream,
1355         opj_image_t *p_image,
1356         OPJ_UINT32 tile_index);
1357
1358 /**
1359  * Set the resolution factor of the decoded image
1360  * @param   p_codec         the jpeg2000 codec.
1361  * @param   res_factor      resolution factor to set
1362  *
1363  * @return                  true if success, otherwise false
1364  */
1365 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decoded_resolution_factor(
1366     opj_codec_t *p_codec, OPJ_UINT32 res_factor);
1367
1368 /**
1369  * Writes a tile with the given data.
1370  *
1371  * @param   p_codec             the jpeg2000 codec.
1372  * @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.
1373  * @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.
1374  * @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
1375  *                              tile_width * tile_height * component_size. component_size can be 1,2 or 4 bytes, depending on the precision of the given component.
1376  * @param   p_stream            the stream to write data to.
1377  *
1378  * @return  true if the data could be written.
1379  */
1380 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_write_tile(opj_codec_t *p_codec,
1381         OPJ_UINT32 p_tile_index,
1382         OPJ_BYTE * p_data,
1383         OPJ_UINT32 p_data_size,
1384         opj_stream_t *p_stream);
1385
1386 /**
1387  * Reads a tile header. This function is compulsory and allows one to know the size of the tile that will be decoded.
1388  * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1389  *
1390  * @param   p_codec         the jpeg2000 codec.
1391  * @param   p_tile_index    pointer to a value that will hold the index of the tile being decoded, in case of success.
1392  * @param   p_data_size     pointer to a value that will hold the maximum size of the decoded data, in case of success. In case
1393  *                          of truncated codestreams, the actual number of bytes decoded may be lower. The computation of the size is the same
1394  *                          as depicted in opj_write_tile.
1395  * @param   p_tile_x0       pointer to a value that will hold the x0 pos of the tile (in the image).
1396  * @param   p_tile_y0       pointer to a value that will hold the y0 pos of the tile (in the image).
1397  * @param   p_tile_x1       pointer to a value that will hold the x1 pos of the tile (in the image).
1398  * @param   p_tile_y1       pointer to a value that will hold the y1 pos of the tile (in the image).
1399  * @param   p_nb_comps      pointer to a value that will hold the number of components in the tile.
1400  * @param   p_should_go_on  pointer to a boolean that will hold the fact that the decoding should go on. In case the
1401  *                          codestream is over at the time of the call, the value will be set to false. The user should then stop
1402  *                          the decoding.
1403  * @param   p_stream        the stream to decode.
1404  * @return  true            if the tile header could be decoded. In case the decoding should end, the returned value is still true.
1405  *                          returning false may be the result of a shortage of memory or an internal error.
1406  */
1407 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_read_tile_header(opj_codec_t *p_codec,
1408         opj_stream_t * p_stream,
1409         OPJ_UINT32 * p_tile_index,
1410         OPJ_UINT32 * p_data_size,
1411         OPJ_INT32 * p_tile_x0, OPJ_INT32 * p_tile_y0,
1412         OPJ_INT32 * p_tile_x1, OPJ_INT32 * p_tile_y1,
1413         OPJ_UINT32 * p_nb_comps,
1414         OPJ_BOOL * p_should_go_on);
1415
1416 /**
1417  * Reads a tile data. This function is compulsory and allows one to decode tile data. opj_read_tile_header should be called before.
1418  * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
1419  *
1420  * @param   p_codec         the jpeg2000 codec.
1421  * @param   p_tile_index    the index of the tile being decoded, this should be the value set by opj_read_tile_header.
1422  * @param   p_data          pointer to a memory block that will hold the decoded data.
1423  * @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.
1424  * @param   p_stream        the stream to decode.
1425  *
1426  * @return  true            if the data could be decoded.
1427  */
1428 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode_tile_data(opj_codec_t *p_codec,
1429         OPJ_UINT32 p_tile_index,
1430         OPJ_BYTE * p_data,
1431         OPJ_UINT32 p_data_size,
1432         opj_stream_t *p_stream);
1433
1434 /* COMPRESSION FUNCTIONS*/
1435
1436 /**
1437  * Creates a J2K/JP2 compression structure
1438  * @param   format      Coder to select
1439  * @return              Returns a handle to a compressor if successful, returns NULL otherwise
1440  */
1441 OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
1442
1443 /**
1444 Set encoding parameters to default values, that means :
1445 <ul>
1446 <li>Lossless
1447 <li>1 tile
1448 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
1449 <li>Size of code-block : 64 x 64
1450 <li>Number of resolutions: 6
1451 <li>No SOP marker in the codestream
1452 <li>No EPH marker in the codestream
1453 <li>No sub-sampling in x or y direction
1454 <li>No mode switch activated
1455 <li>Progression order: LRCP
1456 <li>No index file
1457 <li>No ROI upshifted
1458 <li>No offset of the origin of the image
1459 <li>No offset of the origin of the tiles
1460 <li>Reversible DWT 5-3
1461 </ul>
1462 @param parameters Compression parameters
1463 */
1464 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(
1465     opj_cparameters_t *parameters);
1466
1467 /**
1468  * Setup the encoder parameters using the current image and using user parameters.
1469  * @param p_codec       Compressor handle
1470  * @param parameters    Compression parameters
1471  * @param image         Input filled image
1472  */
1473 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_encoder(opj_codec_t *p_codec,
1474         opj_cparameters_t *parameters,
1475         opj_image_t *image);
1476
1477 /**
1478  * Start to compress the current image.
1479  * @param p_codec       Compressor handle
1480  * @param image         Input filled image
1481  * @param p_stream      Input stgream
1482  */
1483 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_start_compress(opj_codec_t *p_codec,
1484         opj_image_t * p_image,
1485         opj_stream_t *p_stream);
1486
1487 /**
1488  * End to compress the current image.
1489  * @param p_codec       Compressor handle
1490  * @param p_stream      Input stgream
1491  */
1492 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_compress(opj_codec_t *p_codec,
1493         opj_stream_t *p_stream);
1494
1495 /**
1496  * Encode an image into a JPEG-2000 codestream
1497  * @param p_codec       compressor handle
1498  * @param p_stream      Output buffer stream
1499  *
1500  * @return              Returns true if successful, returns false otherwise
1501  */
1502 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_encode(opj_codec_t *p_codec,
1503         opj_stream_t *p_stream);
1504 /*
1505 ==========================================================
1506    codec output functions definitions
1507 ==========================================================
1508 */
1509 /* EXPERIMENTAL FUNCTIONS FOR NOW, USED ONLY IN J2K_DUMP*/
1510
1511 /**
1512 Destroy Codestream information after compression or decompression
1513 @param cstr_info Codestream information structure
1514 */
1515 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_v2_t
1516         **cstr_info);
1517
1518
1519 /**
1520  * Dump the codec information into the output stream
1521  *
1522  * @param   p_codec         the jpeg2000 codec.
1523  * @param   info_flag       type of information dump.
1524  * @param   output_stream   output stream where dump the information gotten from the codec.
1525  *
1526  */
1527 OPJ_API void OPJ_CALLCONV opj_dump_codec(opj_codec_t *p_codec,
1528         OPJ_INT32 info_flag,
1529         FILE* output_stream);
1530
1531 /**
1532  * Get the codestream information from the codec
1533  *
1534  * @param   p_codec         the jpeg2000 codec.
1535  *
1536  * @return                  a pointer to a codestream information structure.
1537  *
1538  */
1539 OPJ_API opj_codestream_info_v2_t* OPJ_CALLCONV opj_get_cstr_info(
1540     opj_codec_t *p_codec);
1541
1542 /**
1543  * Get the codestream index from the codec
1544  *
1545  * @param   p_codec         the jpeg2000 codec.
1546  *
1547  * @return                  a pointer to a codestream index structure.
1548  *
1549  */
1550 OPJ_API opj_codestream_index_t * OPJ_CALLCONV opj_get_cstr_index(
1551     opj_codec_t *p_codec);
1552
1553 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_index(opj_codestream_index_t
1554         **p_cstr_index);
1555
1556
1557 /**
1558  * Get the JP2 file information from the codec FIXME
1559  *
1560  * @param   p_codec         the jpeg2000 codec.
1561  *
1562  * @return                  a pointer to a JP2 metadata structure.
1563  *
1564  */
1565 OPJ_API opj_jp2_metadata_t* OPJ_CALLCONV opj_get_jp2_metadata(
1566     opj_codec_t *p_codec);
1567
1568 /**
1569  * Get the JP2 file index from the codec FIXME
1570  *
1571  * @param   p_codec         the jpeg2000 codec.
1572  *
1573  * @return                  a pointer to a JP2 index structure.
1574  *
1575  */
1576 OPJ_API opj_jp2_index_t* OPJ_CALLCONV opj_get_jp2_index(opj_codec_t *p_codec);
1577
1578
1579 /*
1580 ==========================================================
1581    MCT functions
1582 ==========================================================
1583 */
1584
1585 /**
1586  * Sets the MCT matrix to use.
1587  *
1588  * @param   parameters      the parameters to change.
1589  * @param   pEncodingMatrix the encoding matrix.
1590  * @param   p_dc_shift      the dc shift coefficients to use.
1591  * @param   pNbComp         the number of components of the image.
1592  *
1593  * @return  true if the parameters could be set.
1594  */
1595 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_MCT(opj_cparameters_t *parameters,
1596         OPJ_FLOAT32 * pEncodingMatrix,
1597         OPJ_INT32 * p_dc_shift,
1598         OPJ_UINT32 pNbComp);
1599
1600 /*
1601 ==========================================================
1602    Thread functions
1603 ==========================================================
1604 */
1605
1606 /** Returns if the library is built with thread support.
1607  * OPJ_TRUE if mutex, condition, thread, thread pool are available.
1608  */
1609 OPJ_API OPJ_BOOL OPJ_CALLCONV opj_has_thread_support(void);
1610
1611 /** Return the number of virtual CPUs */
1612 OPJ_API int OPJ_CALLCONV opj_get_num_cpus(void);
1613
1614
1615 #ifdef __cplusplus
1616 }
1617 #endif
1618
1619 #endif /* OPENJPEG_H */