libopenjpeg/openjpeg.h

   1  /*
   2  * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
   3  * Copyright (c) 2002-2007, Professor Benoit Macq
   4  * Copyright (c) 2001-2003, David Janssens
   5  * Copyright (c) 2002-2003, Yannick Verschueren
   6  * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
   7  * Copyright (c) 2005, Herve Drolon, FreeImage Team
   8  * Copyright (c) 2006-2007, Parvatha Elangovan
   9  * Copyright (c) 2010-2011, Kaori Hagihara
  10  * All rights reserved.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  */
  33 #ifndef OPENJPEG_H
  34 #define OPENJPEG_H
  35
  36
  37 /*
  38 ==========================================================
  39    Compiler directives
  40 ==========================================================
  41 */
  42
  43 #if defined(OPJ_STATIC) || !defined(_WIN32)
  44 #define OPJ_API
  45 #define OPJ_CALLCONV
  46 #else
  47 #define OPJ_CALLCONV __stdcall
  48 /*
  49 The following ifdef block is the standard way of creating macros which make exporting
  50 from a DLL simpler. All files within this DLL are compiled with the OPJ_EXPORTS
  51 symbol defined on the command line. this symbol should not be defined on any project
  52 that uses this DLL. This way any other project whose source files include this file see
  53 OPJ_API functions as being imported from a DLL, wheras this DLL sees symbols
  54 defined with this macro as being exported.
  55 */
  56 #if defined(OPJ_EXPORTS) || defined(DLL_EXPORT)
  57 #define OPJ_API __declspec(dllexport)
  58 #else
  59 #define OPJ_API __declspec(dllimport)
  60 #endif /* OPJ_EXPORTS */
  61 #endif /* !OPJ_STATIC || !_WIN32 */
  62
  63 typedef int opj_bool;
  64 #define OPJ_TRUE 1
  65 #define OPJ_FALSE 0
  66
  67 // Avoid compile-time warning because parameter is not used
  68 #define OPJ_ARG_NOT_USED(x) (void)(x)
  69 /*
  70 ==========================================================
  71    Useful constant definitions
  72 ==========================================================
  73 */
  74
  75 #define OPJ_PATH_LEN 4096 /**< Maximum allowed size for filenames */
  76
  77 #define J2K_MAXRLVLS 33                                 /**< Number of maximum resolution level authorized */
  78 #define J2K_MAXBANDS (3*J2K_MAXRLVLS-2) /**< Number of maximum sub-band linked to number of resolution level */
  79
  80 /* UniPG>> */
  81 #define JPWL_MAX_NO_TILESPECS   16 /**< Maximum number of tile parts expected by JPWL: increase at your will */
  82 #define JPWL_MAX_NO_PACKSPECS   16 /**< Maximum number of packet parts expected by JPWL: increase at your will */
  83 #define JPWL_MAX_NO_MARKERS     512 /**< Maximum number of JPWL markers: increase at your will */
  84 #define JPWL_PRIVATEINDEX_NAME "jpwl_index_privatefilename" /**< index file name used when JPWL is on */
  85 #define JPWL_EXPECTED_COMPONENTS 3 /**< Expect this number of components, so you'll find better the first EPB */
  86 #define JPWL_MAXIMUM_TILES 8192 /**< Expect this maximum number of tiles, to avoid some crashes */
  87 #define JPWL_MAXIMUM_HAMMING 2 /**< Expect this maximum number of bit errors in marker id's */
  88 #define JPWL_MAXIMUM_EPB_ROOM 65450 /**< Expect this maximum number of bytes for composition of EPBs */
  89 /* <<UniPG */
  90
  91 /*
  92 ==========================================================
  93    enum definitions
  94 ==========================================================
  95 */
  96 /**
  97 Rsiz Capabilities
  98 */
  99 typedef enum RSIZ_CAPABILITIES {
 100         STD_RSIZ = 0,           /** Standard JPEG2000 profile*/
 101         CINEMA2K = 3,           /** Profile name for a 2K image*/
 102         CINEMA4K = 4            /** Profile name for a 4K image*/
 103 } OPJ_RSIZ_CAPABILITIES;
 104
 105 /**
 106 Digital cinema operation mode
 107 */
 108 typedef enum CINEMA_MODE {
 109         OFF = 0,                                        /** Not Digital Cinema*/
 110         CINEMA2K_24 = 1,        /** 2K Digital Cinema at 24 fps*/
 111         CINEMA2K_48 = 2,        /** 2K Digital Cinema at 48 fps*/
 112         CINEMA4K_24 = 3         /** 4K Digital Cinema at 24 fps*/
 113 }OPJ_CINEMA_MODE;
 114
 115 /**
 116 Progression order
 117 */
 118 typedef enum PROG_ORDER {
 119         PROG_UNKNOWN = -1,      /**< place-holder */
 120         LRCP = 0,               /**< layer-resolution-component-precinct order */
 121         RLCP = 1,               /**< resolution-layer-component-precinct order */
 122         RPCL = 2,               /**< resolution-precinct-component-layer order */
 123         PCRL = 3,               /**< precinct-component-resolution-layer order */
 124         CPRL = 4                /**< component-precinct-resolution-layer order */
 125 } OPJ_PROG_ORDER;
 126
 127 /**
 128 Supported image color spaces
 129 */
 130 typedef enum COLOR_SPACE {
 131         CLRSPC_UNKNOWN = -1,    /**< not supported by the library */
 132         CLRSPC_UNSPECIFIED = 0, /**< not specified in the codestream */
 133         CLRSPC_SRGB = 1,                /**< sRGB */
 134         CLRSPC_GRAY = 2,                /**< grayscale */
 135         CLRSPC_SYCC = 3                 /**< YUV */
 136 } OPJ_COLOR_SPACE;
 137
 138 /**
 139 Supported codec
 140 */
 141 typedef enum CODEC_FORMAT {
 142         CODEC_UNKNOWN = -1,     /**< place-holder */
 143         CODEC_J2K  = 0,         /**< JPEG-2000 codestream : read/write */
 144         CODEC_JPT  = 1,         /**< JPT-stream (JPEG 2000, JPIP) : read only */
 145         CODEC_JP2  = 2,         /**< JPEG-2000 file format : read/write */
 146 } OPJ_CODEC_FORMAT;
 147
 148 /**
 149 Limit decoding to certain portions of the codestream.
 150 */
 151 typedef enum LIMIT_DECODING {
 152         NO_LIMITATION = 0,                                /**< No limitation for the decoding. The entire codestream will de decoded */
 153         LIMIT_TO_MAIN_HEADER = 1,               /**< The decoding is limited to the Main Header */
 154         DECODE_ALL_BUT_PACKETS = 2      /**< Decode everything except the JPEG 2000 packets */
 155 } OPJ_LIMIT_DECODING;
 156
 157 /*
 158 ==========================================================
 159    event manager typedef definitions
 160 ==========================================================
 161 */
 162
 163 /**
 164 Callback function prototype for events
 165 @param msg Event message
 166 @param client_data
 167 */
 168 typedef void (*opj_msg_callback) (const char *msg, void *client_data);
 169
 170 /**
 171 Message handler object
 172 used for
 173 <ul>
 174 <li>Error messages
 175 <li>Warning messages
 176 <li>Debugging messages
 177 </ul>
 178 */
 179 typedef struct opj_event_mgr {
 180         /** Error message callback if available, NULL otherwise */
 181         opj_msg_callback error_handler;
 182         /** Warning message callback if available, NULL otherwise */
 183         opj_msg_callback warning_handler;
 184         /** Debug message callback if available, NULL otherwise */
 185         opj_msg_callback info_handler;
 186 } opj_event_mgr_t;
 187
 188
 189 /*
 190 ==========================================================
 191    codec typedef definitions
 192 ==========================================================
 193 */
 194
 195 /**
 196 Progression order changes
 197 */
 198 typedef struct opj_poc {
 199         /** Resolution num start, Component num start, given by POC */
 200         int resno0, compno0;
 201         /** Layer num end,Resolution num end, Component num end, given by POC */
 202         int layno1, resno1, compno1;
 203         /** Layer num start,Precinct num start, Precinct num end */
 204         int layno0, precno0, precno1;
 205         /** Progression order enum*/
 206         OPJ_PROG_ORDER prg1,prg;
 207         /** Progression order string*/
 208         char progorder[5];
 209         /** Tile number */
 210         int tile;
 211         /** Start and end values for Tile width and height*/
 212         int tx0,tx1,ty0,ty1;
 213         /** Start value, initialised in pi_initialise_encode*/
 214         int layS, resS, compS, prcS;
 215         /** End value, initialised in pi_initialise_encode */
 216         int layE, resE, compE, prcE;
 217         /** Start and end values of Tile width and height, initialised in pi_initialise_encode*/
 218         int txS,txE,tyS,tyE,dx,dy;
 219         /** Temporary values for Tile parts, initialised in pi_create_encode */
 220         int lay_t, res_t, comp_t, prc_t,tx0_t,ty0_t;
 221 } opj_poc_t;
 222
 223 /**
 224 Compression parameters
 225 */
 226 typedef struct opj_cparameters {
 227         /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */
 228         opj_bool tile_size_on;
 229         /** XTOsiz */
 230         int cp_tx0;
 231         /** YTOsiz */
 232         int cp_ty0;
 233         /** XTsiz */
 234         int cp_tdx;
 235         /** YTsiz */
 236         int cp_tdy;
 237         /** allocation by rate/distortion */
 238         int cp_disto_alloc;
 239         /** allocation by fixed layer */
 240         int cp_fixed_alloc;
 241         /** add fixed_quality */
 242         int cp_fixed_quality;
 243         /** fixed layer */
 244         int *cp_matrice;
 245         /** comment for coding */
 246         char *cp_comment;
 247         /** csty : coding style */
 248         int csty;
 249         /** progression order (default LRCP) */
 250         OPJ_PROG_ORDER prog_order;
 251         /** progression order changes */
 252         opj_poc_t POC[32];
 253         /** number of progression order changes (POC), default to 0 */
 254         int numpocs;
 255         /** number of layers */
 256         int tcp_numlayers;
 257         /** rates of layers */
 258         float tcp_rates[100];
 259         /** different psnr for successive layers */
 260         float tcp_distoratio[100];
 261         /** number of resolutions */
 262         int numresolution;
 263         /** initial code block width, default to 64 */
 264         int cblockw_init;
 265         /** initial code block height, default to 64 */
 266         int cblockh_init;
 267         /** mode switch (cblk_style) */
 268         int mode;
 269         /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
 270         int irreversible;
 271         /** region of interest: affected component in [0..3], -1 means no ROI */
 272         int roi_compno;
 273         /** region of interest: upshift value */
 274         int roi_shift;
 275         /* number of precinct size specifications */
 276         int res_spec;
 277         /** initial precinct width */
 278         int prcw_init[J2K_MAXRLVLS];
 279         /** initial precinct height */
 280         int prch_init[J2K_MAXRLVLS];
 281
 282         /**@name command line encoder parameters (not used inside the library) */
 283         /*@{*/
 284         /** input file name */
 285         char infile[OPJ_PATH_LEN];
 286         /** output file name */
 287         char outfile[OPJ_PATH_LEN];
 288         /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
 289         int index_on;
 290         /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
 291         char index[OPJ_PATH_LEN];
 292         /** subimage encoding: origin image offset in x direction */
 293         int image_offset_x0;
 294         /** subimage encoding: origin image offset in y direction */
 295         int image_offset_y0;
 296         /** subsampling value for dx */
 297         int subsampling_dx;
 298         /** subsampling value for dy */
 299         int subsampling_dy;
 300         /** input file format 0: PGX, 1: PxM, 2: BMP 3:TIF*/
 301         int decod_format;
 302         /** output file format 0: J2K, 1: JP2, 2: JPT */
 303         int cod_format;
 304         /*@}*/
 305
 306 /* UniPG>> */
 307         /**@name JPWL encoding parameters */
 308         /*@{*/
 309         /** enables writing of EPC in MH, thus activating JPWL */
 310         opj_bool jpwl_epc_on;
 311         /** error protection method for MH (0,1,16,32,37-128) */
 312         int jpwl_hprot_MH;
 313         /** tile number of header protection specification (>=0) */
 314         int jpwl_hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 315         /** error protection methods for TPHs (0,1,16,32,37-128) */
 316         int jpwl_hprot_TPH[JPWL_MAX_NO_TILESPECS];
 317         /** tile number of packet protection specification (>=0) */
 318         int jpwl_pprot_tileno[JPWL_MAX_NO_PACKSPECS];
 319         /** packet number of packet protection specification (>=0) */
 320         int jpwl_pprot_packno[JPWL_MAX_NO_PACKSPECS];
 321         /** error protection methods for packets (0,1,16,32,37-128) */
 322         int jpwl_pprot[JPWL_MAX_NO_PACKSPECS];
 323         /** enables writing of ESD, (0=no/1/2 bytes) */
 324         int jpwl_sens_size;
 325         /** sensitivity addressing size (0=auto/2/4 bytes) */
 326         int jpwl_sens_addr;
 327         /** sensitivity range (0-3) */
 328         int jpwl_sens_range;
 329         /** sensitivity method for MH (-1=no,0-7) */
 330         int jpwl_sens_MH;
 331         /** tile number of sensitivity specification (>=0) */
 332         int jpwl_sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 333         /** sensitivity methods for TPHs (-1=no,0-7) */
 334         int jpwl_sens_TPH[JPWL_MAX_NO_TILESPECS];
 335         /*@}*/
 336 /* <<UniPG */
 337
 338         /** Digital Cinema compliance 0-not compliant, 1-compliant*/
 339         OPJ_CINEMA_MODE cp_cinema;
 340         /** Maximum rate for each component. If == 0, component size limitation is not considered */
 341         int max_comp_size;
 342         /** Profile name*/
 343         OPJ_RSIZ_CAPABILITIES cp_rsiz;
 344         /** Tile part generation*/
 345         char tp_on;
 346         /** Flag for Tile part generation*/
 347         char tp_flag;
 348         /** MCT (multiple component transform) */
 349         char tcp_mct;
 350         /** Enable JPIP indexing*/
 351         opj_bool jpip_on;
 352 } opj_cparameters_t;
 353
 354 /**
 355 Decompression parameters
 356 */
 357 typedef struct opj_dparameters {
 358         /**
 359         Set the number of highest resolution levels to be discarded.
 360         The image resolution is effectively divided by 2 to the power of the number of discarded levels.
 361         The reduce factor is limited by the smallest total number of decomposition levels among tiles.
 362         if != 0, then original dimension divided by 2^(reduce);
 363         if == 0 or not used, image is decoded to the full resolution
 364         */
 365         int cp_reduce;
 366         /**
 367         Set the maximum number of quality layers to decode.
 368         If there are less quality layers than the specified number, all the quality layers are decoded.
 369         if != 0, then only the first "layer" layers are decoded;
 370         if == 0 or not used, all the quality layers are decoded
 371         */
 372         int cp_layer;
 373
 374         /**@name command line encoder parameters (not used inside the library) */
 375         /*@{*/
 376         /** input file name */
 377         char infile[OPJ_PATH_LEN];
 378         /** output file name */
 379         char outfile[OPJ_PATH_LEN];
 380         /** input file format 0: J2K, 1: JP2, 2: JPT */
 381         int decod_format;
 382         /** output file format 0: PGX, 1: PxM, 2: BMP */
 383         int cod_format;
 384         /*@}*/
 385
 386 /* UniPG>> */
 387         /**@name JPWL decoding parameters */
 388         /*@{*/
 389         /** activates the JPWL correction capabilities */
 390         opj_bool jpwl_correct;
 391         /** expected number of components */
 392         int jpwl_exp_comps;
 393         /** maximum number of tiles */
 394         int jpwl_max_tiles;
 395         /*@}*/
 396 /* <<UniPG */
 397
 398         /**
 399         Specify whether the decoding should be done on the entire codestream, or be limited to the main header
 400         Limiting the decoding to the main header makes it possible to extract the characteristics of the codestream
 401         if == NO_LIMITATION, the entire codestream is decoded;
 402         if == LIMIT_TO_MAIN_HEADER, only the main header is decoded;
 403         */
 404         OPJ_LIMIT_DECODING cp_limit_decoding;
 405
 406 } opj_dparameters_t;
 407
 408 /** Common fields between JPEG-2000 compression and decompression master structs. */
 409
 410 #define opj_common_fields \
 411         opj_event_mgr_t *event_mgr;     /**< pointer to the event manager */\
 412         void * client_data;                     /**< Available for use by application */\
 413         opj_bool is_decompressor;       /**< So common code can tell which is which */\
 414         OPJ_CODEC_FORMAT codec_format;  /**< selected codec */\
 415         void *j2k_handle;                       /**< pointer to the J2K codec */\
 416         void *jp2_handle;                       /**< pointer to the JP2 codec */\
 417         void *mj2_handle                        /**< pointer to the MJ2 codec */
 418
 419 /* Routines that are to be used by both halves of the library are declared
 420  * to receive a pointer to this structure.  There are no actual instances of
 421  * opj_common_struct_t, only of opj_cinfo_t and opj_dinfo_t.
 422  */
 423 typedef struct opj_common_struct {
 424   opj_common_fields;            /* Fields common to both master struct types */
 425   /* Additional fields follow in an actual opj_cinfo_t or
 426    * opj_dinfo_t.  All three structs must agree on these
 427    * initial fields!  (This would be a lot cleaner in C++.)
 428    */
 429 } opj_common_struct_t;
 430
 431 typedef opj_common_struct_t * opj_common_ptr;
 432
 433 /**
 434 Compression context info
 435 */
 436 typedef struct opj_cinfo {
 437         /** Fields shared with opj_dinfo_t */
 438         opj_common_fields;
 439         /* other specific fields go here */
 440 } opj_cinfo_t;
 441
 442 /**
 443 Decompression context info
 444 */
 445 typedef struct opj_dinfo {
 446         /** Fields shared with opj_cinfo_t */
 447         opj_common_fields;
 448         /* other specific fields go here */
 449 } opj_dinfo_t;
 450
 451 /*
 452 ==========================================================
 453    I/O stream typedef definitions
 454 ==========================================================
 455 */
 456
 457 /*
 458  * Stream open flags.
 459  */
 460 /** The stream was opened for reading. */
 461 #define OPJ_STREAM_READ 0x0001
 462 /** The stream was opened for writing. */
 463 #define OPJ_STREAM_WRITE 0x0002
 464
 465 /**
 466 Byte input-output stream (CIO)
 467 */
 468 typedef struct opj_cio {
 469         /** codec context */
 470         opj_common_ptr cinfo;
 471
 472         /** open mode (read/write) either OPJ_STREAM_READ or OPJ_STREAM_WRITE */
 473         int openmode;
 474         /** pointer to the start of the buffer */
 475         unsigned char *buffer;
 476         /** buffer size in bytes */
 477         int length;
 478
 479         /** pointer to the start of the stream */
 480         unsigned char *start;
 481         /** pointer to the end of the stream */
 482         unsigned char *end;
 483         /** pointer to the current position */
 484         unsigned char *bp;
 485 } opj_cio_t;
 486
 487 /*
 488 ==========================================================
 489    image typedef definitions
 490 ==========================================================
 491 */
 492
 493 /**
 494 Defines a single image component
 495 */
 496 typedef struct opj_image_comp {
 497         /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
 498         int dx;
 499         /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
 500         int dy;
 501         /** data width */
 502         int w;
 503         /** data height */
 504         int h;
 505         /** x component offset compared to the whole image */
 506         int x0;
 507         /** y component offset compared to the whole image */
 508         int y0;
 509         /** precision */
 510         int prec;
 511         /** image depth in bits */
 512         int bpp;
 513         /** signed (1) / unsigned (0) */
 514         int sgnd;
 515         /** number of decoded resolution */
 516         int resno_decoded;
 517         /** number of division by 2 of the out image compared to the original size of image */
 518         int factor;
 519         /** image component data */
 520         int *data;
 521 } opj_image_comp_t;
 522
 523 /**
 524 Defines image data and characteristics
 525 */
 526 typedef struct opj_image {
 527         /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
 528         int x0;
 529         /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
 530         int y0;
 531         /** Xsiz: width of the reference grid */
 532         int x1;
 533         /** Ysiz: height of the reference grid */
 534         int y1;
 535         /** number of components in the image */
 536         int numcomps;
 537         /** color space: sRGB, Greyscale or YUV */
 538         OPJ_COLOR_SPACE color_space;
 539         /** image components */
 540         opj_image_comp_t *comps;
 541         /** 'restricted' ICC profile */
 542         unsigned char *icc_profile_buf;
 543         /** size of ICC profile */
 544         int icc_profile_len;
 545 } opj_image_t;
 546
 547 /**
 548 Component parameters structure used by the opj_image_create function
 549 */
 550 typedef struct opj_image_comptparm {
 551         /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
 552         int dx;
 553         /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
 554         int dy;
 555         /** data width */
 556         int w;
 557         /** data height */
 558         int h;
 559         /** x component offset compared to the whole image */
 560         int x0;
 561         /** y component offset compared to the whole image */
 562         int y0;
 563         /** precision */
 564         int prec;
 565         /** image depth in bits */
 566         int bpp;
 567         /** signed (1) / unsigned (0) */
 568         int sgnd;
 569 } opj_image_cmptparm_t;
 570
 571 /*
 572 ==========================================================
 573    Information on the JPEG 2000 codestream
 574 ==========================================================
 575 */
 576
 577 /**
 578 Index structure : Information concerning a packet inside tile
 579 */
 580 typedef struct opj_packet_info {
 581         /** packet start position (including SOP marker if it exists) */
 582         int start_pos;
 583         /** end of packet header position (including EPH marker if it exists)*/
 584         int end_ph_pos;
 585         /** packet end position */
 586         int end_pos;
 587         /** packet distorsion */
 588         double disto;
 589 } opj_packet_info_t;
 590
 591
 592 /* UniPG>> */
 593 /**
 594 Marker structure
 595 */
 596 typedef struct opj_marker_info_t {
 597         /** marker type */
 598         unsigned short int type;
 599         /** position in codestream */
 600         int pos;
 601         /** length, marker val included */
 602         int len;
 603 } opj_marker_info_t;
 604 /* <<UniPG */
 605
 606 /**
 607 Index structure : Information concerning tile-parts
 608 */
 609 typedef struct opj_tp_info {
 610         /** start position of tile part */
 611         int tp_start_pos;
 612         /** end position of tile part header */
 613         int tp_end_header;
 614         /** end position of tile part */
 615         int tp_end_pos;
 616         /** start packet of tile part */
 617         int tp_start_pack;
 618         /** number of packets of tile part */
 619         int tp_numpacks;
 620 } opj_tp_info_t;
 621
 622 /**
 623 Index structure : information regarding tiles
 624 */
 625 typedef struct opj_tile_info {
 626         /** value of thresh for each layer by tile cfr. Marcela   */
 627         double *thresh;
 628         /** number of tile */
 629         int tileno;
 630         /** start position */
 631         int start_pos;
 632         /** end position of the header */
 633         int end_header;
 634         /** end position */
 635         int end_pos;
 636         /** precinct number for each resolution level (width) */
 637         int pw[33];
 638         /** precinct number for each resolution level (height) */
 639         int ph[33];
 640         /** precinct size (in power of 2), in X for each resolution level */
 641         int pdx[33];
 642         /** precinct size (in power of 2), in Y for each resolution level */
 643         int pdy[33];
 644         /** information concerning packets inside tile */
 645         opj_packet_info_t *packet;
 646         /** add fixed_quality */
 647         int numpix;
 648         /** add fixed_quality */
 649         double distotile;
 650         /** number of markers */
 651         int marknum;
 652         /** list of markers */
 653         opj_marker_info_t *marker;
 654         /** actual size of markers array */
 655         int maxmarknum;
 656         /** number of tile parts */
 657         int num_tps;
 658         /** information concerning tile parts */
 659         opj_tp_info_t *tp;
 660 } opj_tile_info_t;
 661
 662 /**
 663 Index structure of the codestream
 664 */
 665 typedef struct opj_codestream_info {
 666         /** maximum distortion reduction on the whole image (add for Marcela) */
 667         double D_max;
 668         /** packet number */
 669         int packno;
 670         /** writing the packet in the index with t2_encode_packets */
 671         int index_write;
 672         /** image width */
 673         int image_w;
 674         /** image height */
 675         int image_h;
 676         /** progression order */
 677         OPJ_PROG_ORDER prog;
 678         /** tile size in x */
 679         int tile_x;
 680         /** tile size in y */
 681         int tile_y;
 682         /** */
 683         int tile_Ox;
 684         /** */
 685         int tile_Oy;
 686         /** number of tiles in X */
 687         int tw;
 688         /** number of tiles in Y */
 689         int th;
 690         /** component numbers */
 691         int numcomps;
 692         /** number of layer */
 693         int numlayers;
 694         /** number of decomposition for each component */
 695         int *numdecompos;
 696 /* UniPG>> */
 697         /** number of markers */
 698         int marknum;
 699         /** list of markers */
 700         opj_marker_info_t *marker;
 701         /** actual size of markers array */
 702         int maxmarknum;
 703 /* <<UniPG */
 704         /** main header position */
 705         int main_head_start;
 706         /** main header position */
 707         int main_head_end;
 708         /** codestream's size */
 709         int codestream_size;
 710         /** information regarding tiles inside image */
 711         opj_tile_info_t *tile;
 712 } opj_codestream_info_t;
 713
 714 #ifdef __cplusplus
 715 extern "C" {
 716 #endif
 717
 718
 719 /*
 720 ==========================================================
 721    openjpeg version
 722 ==========================================================
 723 */
 724
 725 OPJ_API const char * OPJ_CALLCONV opj_version(void);
 726
 727 /*
 728 ==========================================================
 729    image functions definitions
 730 ==========================================================
 731 */
 732
 733 /**
 734 Create an image
 735 @param numcmpts number of components
 736 @param cmptparms components parameters
 737 @param clrspc image color space
 738 @return returns a new image structure if successful, returns NULL otherwise
 739 */
 740 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(int numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
 741
 742 /**
 743 Deallocate any resources associated with an image
 744 @param image image to be destroyed
 745 */
 746 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
 747
 748 /*
 749 ==========================================================
 750    stream functions definitions
 751 ==========================================================
 752 */
 753
 754 /**
 755 Open and allocate a memory stream for read / write.
 756 On reading, the user must provide a buffer containing encoded data. The buffer will be
 757 wrapped by the returned CIO handle.
 758 On writing, buffer parameters must be set to 0: a buffer will be allocated by the library
 759 to contain encoded data.
 760 @param cinfo Codec context info
 761 @param buffer Reading: buffer address. Writing: NULL
 762 @param length Reading: buffer length. Writing: 0
 763 @return Returns a CIO handle if successful, returns NULL otherwise
 764 */
 765 OPJ_API opj_cio_t* OPJ_CALLCONV opj_cio_open(opj_common_ptr cinfo, unsigned char *buffer, int length);
 766
 767 /**
 768 Close and free a CIO handle
 769 @param cio CIO handle to free
 770 */
 771 OPJ_API void OPJ_CALLCONV opj_cio_close(opj_cio_t *cio);
 772
 773 /**
 774 Get position in byte stream
 775 @param cio CIO handle
 776 @return Returns the position in bytes
 777 */
 778 OPJ_API int OPJ_CALLCONV cio_tell(opj_cio_t *cio);
 779 /**
 780 Set position in byte stream
 781 @param cio CIO handle
 782 @param pos Position, in number of bytes, from the beginning of the stream
 783 */
 784 OPJ_API void OPJ_CALLCONV cio_seek(opj_cio_t *cio, int pos);
 785
 786 /*
 787 ==========================================================
 788    event manager functions definitions
 789 ==========================================================
 790 */
 791
 792 OPJ_API opj_event_mgr_t* OPJ_CALLCONV opj_set_event_mgr(opj_common_ptr cinfo, opj_event_mgr_t *event_mgr, void *context);
 793
 794 /*
 795 ==========================================================
 796    codec functions definitions
 797 ==========================================================
 798 */
 799 /**
 800 Creates a J2K/JPT/JP2 decompression structure
 801 @param format Decoder to select
 802 @return Returns a handle to a decompressor if successful, returns NULL otherwise
 803 */
 804 OPJ_API opj_dinfo_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format);
 805 /**
 806 Destroy a decompressor handle
 807 @param dinfo decompressor handle to destroy
 808 */
 809 OPJ_API void OPJ_CALLCONV opj_destroy_decompress(opj_dinfo_t *dinfo);
 810 /**
 811 Set decoding parameters to default values
 812 @param parameters Decompression parameters
 813 */
 814 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters);
 815 /**
 816 Setup the decoder decoding parameters using user parameters.
 817 Decoding parameters are returned in j2k->cp.
 818 @param dinfo decompressor handle
 819 @param parameters decompression parameters
 820 */
 821 OPJ_API void OPJ_CALLCONV opj_setup_decoder(opj_dinfo_t *dinfo, opj_dparameters_t *parameters);
 822 /**
 823 Decode an image from a JPEG-2000 codestream
 824 @param dinfo decompressor handle
 825 @param cio Input buffer stream
 826 @return Returns a decoded image if successful, returns NULL otherwise
 827 */
 828 OPJ_API opj_image_t* OPJ_CALLCONV opj_decode(opj_dinfo_t *dinfo, opj_cio_t *cio);
 829
 830 /**
 831 Decode an image from a JPEG-2000 codestream and extract the codestream information
 832 @param dinfo decompressor handle
 833 @param cio Input buffer stream
 834 @param cstr_info Codestream information structure if needed afterwards, NULL otherwise
 835 @return Returns a decoded image if successful, returns NULL otherwise
 836 */
 837 OPJ_API opj_image_t* OPJ_CALLCONV opj_decode_with_info(opj_dinfo_t *dinfo, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
 838 /**
 839 Creates a J2K/JP2 compression structure
 840 @param format Coder to select
 841 @return Returns a handle to a compressor if successful, returns NULL otherwise
 842 */
 843 OPJ_API opj_cinfo_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
 844 /**
 845 Destroy a compressor handle
 846 @param cinfo compressor handle to destroy
 847 */
 848 OPJ_API void OPJ_CALLCONV opj_destroy_compress(opj_cinfo_t *cinfo);
 849 /**
 850 Set encoding parameters to default values, that means :
 851 <ul>
 852 <li>Lossless
 853 <li>1 tile
 854 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
 855 <li>Size of code-block : 64 x 64
 856 <li>Number of resolutions: 6
 857 <li>No SOP marker in the codestream
 858 <li>No EPH marker in the codestream
 859 <li>No sub-sampling in x or y direction
 860 <li>No mode switch activated
 861 <li>Progression order: LRCP
 862 <li>No index file
 863 <li>No ROI upshifted
 864 <li>No offset of the origin of the image
 865 <li>No offset of the origin of the tiles
 866 <li>Reversible DWT 5-3
 867 </ul>
 868 @param parameters Compression parameters
 869 */
 870 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(opj_cparameters_t *parameters);
 871 /**
 872 Setup the encoder parameters using the current image and using user parameters.
 873 @param cinfo Compressor handle
 874 @param parameters Compression parameters
 875 @param image Input filled image
 876 */
 877 OPJ_API void OPJ_CALLCONV opj_setup_encoder(opj_cinfo_t *cinfo, opj_cparameters_t *parameters, opj_image_t *image);
 878 /**
 879 Encode an image into a JPEG-2000 codestream
 880 3@param cinfo compressor handle
 881 @param cio Output buffer stream
 882 @param image Image to encode
 883 @param index Depreacted -> Set to NULL. To extract index, used opj_encode_wci()
 884 @return Returns true if successful, returns false otherwise
 885 */
 886 OPJ_API opj_bool OPJ_CALLCONV opj_encode(opj_cinfo_t *cinfo, opj_cio_t *cio, opj_image_t *image, char *index);
 887 /**
 888 Encode an image into a JPEG-2000 codestream and extract the codestream information
 889 @param cinfo compressor handle
 890 @param cio Output buffer stream
 891 @param image Image to encode
 892 @param cstr_info Codestream information structure if needed afterwards, NULL otherwise
 893 @return Returns true if successful, returns false otherwise
 894 */
 895 OPJ_API opj_bool OPJ_CALLCONV opj_encode_with_info(opj_cinfo_t *cinfo, opj_cio_t *cio, opj_image_t *image, opj_codestream_info_t *cstr_info);
 896 /**
 897 Destroy Codestream information after compression or decompression
 898 @param cstr_info Codestream information structure
 899 */
 900 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_t *cstr_info);
 901
 902
 903 #ifdef __cplusplus
 904 }
 905 #endif
 906
 907 #endif /* OPENJPEG_H */