openjpeg.h

Go to the documentation of this file.

 /*
 * The copyright in this software is being made available under the 2-clauses 
 * BSD License, included below. This software may be subject to other third 
 * party and contributor rights, including patent rights, and no such rights
 * are granted under this license.
 *
 * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
 * Copyright (c) 2002-2014, Professor Benoit Macq
 * Copyright (c) 2001-2003, David Janssens
 * Copyright (c) 2002-2003, Yannick Verschueren
 * Copyright (c) 2003-2007, Francois-Olivier Devaux 
 * Copyright (c) 2003-2014, Antonin Descampe
 * Copyright (c) 2005, Herve Drolon, FreeImage Team
 * Copyright (c) 2006-2007, Parvatha Elangovan
 * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
 * Copyright (c) 2010-2011, Kaori Hagihara
 * Copyright (c) 2011-2012, Centre National d'Etudes Spatiales (CNES), France 
 * Copyright (c) 2012, CS Systemes d'Information, France
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef OPENJPEG_H
#define OPENJPEG_H


/* 
==========================================================
   Compiler directives
==========================================================
*/

/*
The inline keyword is supported by C99 but not by C90. 
Most compilers implement their own version of this keyword ... 
*/
#ifndef INLINE
        #if defined(_MSC_VER)
                #define INLINE __forceinline
        #elif defined(__GNUC__)
                #define INLINE __inline__
        #elif defined(__MWERKS__)
                #define INLINE inline
        #else 
                /* add other compilers here ... */
                #define INLINE 
        #endif /* defined(<Compiler>) */
#endif /* INLINE */

/* deprecated attribute */
#ifdef __GNUC__
        #define OPJ_DEPRECATED(func) func __attribute__ ((deprecated))
#elif defined(_MSC_VER)
        #define OPJ_DEPRECATED(func) __declspec(deprecated) func
#else
        #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
        #define OPJ_DEPRECATED(func) func
#endif

#if defined(OPJ_STATIC) || !defined(_WIN32)
/* http://gcc.gnu.org/wiki/Visibility */
#       if __GNUC__ >= 4
#               if defined(OPJ_STATIC) /* static library uses "hidden" */
#                       define OPJ_API    __attribute__ ((visibility ("hidden")))
#               else
#                       define OPJ_API    __attribute__ ((visibility ("default")))
#               endif
#               define OPJ_LOCAL  __attribute__ ((visibility ("hidden")))
#       else
#               define OPJ_API
#               define OPJ_LOCAL
#       endif
#       define OPJ_CALLCONV
#else
#       define OPJ_CALLCONV __stdcall
/*
The following ifdef block is the standard way of creating macros which make exporting 
from a DLL simpler. All files within this DLL are compiled with the OPJ_EXPORTS
symbol defined on the command line. this symbol should not be defined on any project
that uses this DLL. This way any other project whose source files include this file see 
OPJ_API functions as being imported from a DLL, whereas this DLL sees symbols
defined with this macro as being exported.
*/
#       if defined(OPJ_EXPORTS) || defined(DLL_EXPORT)
#               define OPJ_API __declspec(dllexport)
#       else
#               define OPJ_API __declspec(dllimport)
#       endif /* OPJ_EXPORTS */
#endif /* !OPJ_STATIC || !_WIN32 */

typedef int OPJ_BOOL;
#define OPJ_TRUE 1
#define OPJ_FALSE 0

typedef char          OPJ_CHAR;
typedef float         OPJ_FLOAT32;
typedef double        OPJ_FLOAT64;
typedef unsigned char OPJ_BYTE;

#include "opj_stdint.h"

typedef int8_t   OPJ_INT8;
typedef uint8_t  OPJ_UINT8;
typedef int16_t  OPJ_INT16;
typedef uint16_t OPJ_UINT16;
typedef int32_t  OPJ_INT32;
typedef uint32_t OPJ_UINT32;
typedef int64_t  OPJ_INT64;
typedef uint64_t OPJ_UINT64;

typedef int64_t  OPJ_OFF_T; /* 64-bit file offset type */

#include <stdio.h>
typedef size_t   OPJ_SIZE_T;

/* Avoid compile-time warning because parameter is not used */
#define OPJ_ARG_NOT_USED(x) (void)(x)

/* 
==========================================================
   Useful constant definitions
==========================================================
*/

#define OPJ_PATH_LEN 4096 
#define OPJ_J2K_MAXRLVLS 33                                     
#define OPJ_J2K_MAXBANDS (3*OPJ_J2K_MAXRLVLS-2) 
#define OPJ_J2K_DEFAULT_NB_SEGS                         10
#define OPJ_J2K_STREAM_CHUNK_SIZE                       0x100000 
#define OPJ_J2K_DEFAULT_HEADER_SIZE                     1000
#define OPJ_J2K_MCC_DEFAULT_NB_RECORDS          10
#define OPJ_J2K_MCT_DEFAULT_NB_RECORDS          10

/* UniPG>> */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */
#define JPWL_MAX_NO_TILESPECS   16 
#define JPWL_MAX_NO_PACKSPECS   16 
#define JPWL_MAX_NO_MARKERS     512 
#define JPWL_PRIVATEINDEX_NAME "jpwl_index_privatefilename" 
#define JPWL_EXPECTED_COMPONENTS 3 
#define JPWL_MAXIMUM_TILES 8192 
#define JPWL_MAXIMUM_HAMMING 2 
#define JPWL_MAXIMUM_EPB_ROOM 65450 
/* <<UniPG */

#define OPJ_IMG_INFO            1       
#define OPJ_J2K_MH_INFO         2       
#define OPJ_J2K_TH_INFO         4       
#define OPJ_J2K_TCH_INFO        8       
#define OPJ_J2K_MH_IND          16      
#define OPJ_J2K_TH_IND          32      
/*FIXME #define OPJ_J2K_CSTR_IND        48*/    
#define OPJ_JP2_INFO            128     
#define OPJ_JP2_IND                     256     
#define OPJ_PROFILE_NONE        0x0000 
#define OPJ_PROFILE_0           0x0001 
#define OPJ_PROFILE_1           0x0002 
#define OPJ_PROFILE_PART2       0x8000 
#define OPJ_PROFILE_CINEMA_2K   0x0003 
#define OPJ_PROFILE_CINEMA_4K   0x0004 
#define OPJ_PROFILE_CINEMA_S2K  0x0005 
#define OPJ_PROFILE_CINEMA_S4K  0x0006 
#define OPJ_PROFILE_CINEMA_LTS  0x0007 
#define OPJ_PROFILE_BC_SINGLE   0x0100 
#define OPJ_PROFILE_BC_MULTI    0x0200 
#define OPJ_PROFILE_BC_MULTI_R  0x0300 
#define OPJ_PROFILE_IMF_2K      0x0400 
#define OPJ_PROFILE_IMF_4K      0x0401 
#define OPJ_PROFILE_IMF_8K      0x0402 
#define OPJ_PROFILE_IMF_2K_R    0x0403 
#define OPJ_PROFILE_IMF_4K_R    0x0800 
#define OPJ_PROFILE_IMF_8K_R    0x0801  
#define OPJ_EXTENSION_NONE      0x0000 
#define OPJ_EXTENSION_MCT       0x0100  
#define OPJ_IS_CINEMA(v)     (((v) >= OPJ_PROFILE_CINEMA_2K)&&((v) <= OPJ_PROFILE_CINEMA_S4K))
#define OPJ_IS_STORAGE(v)    ((v) == OPJ_PROFILE_CINEMA_LTS)
#define OPJ_IS_BROADCAST(v)  (((v) >= OPJ_PROFILE_BC_SINGLE)&&((v) <= ((OPJ_PROFILE_BC_MULTI_R) | (0x000b))))
#define OPJ_IS_IMF(v)        (((v) >= OPJ_PROFILE_IMF_2K)&&((v) <= ((OPJ_PROFILE_IMF_8K_R) | (0x009b))))
#define OPJ_IS_PART2(v)      ((v) & OPJ_PROFILE_PART2)

#define OPJ_CINEMA_24_CS     1302083    
#define OPJ_CINEMA_48_CS     651041     
#define OPJ_CINEMA_24_COMP   1041666    
#define OPJ_CINEMA_48_COMP   520833             
/* 
==========================================================
   enum definitions
==========================================================
*/

typedef enum RSIZ_CAPABILITIES {
    OPJ_STD_RSIZ = 0,           
    OPJ_CINEMA2K = 3,           
    OPJ_CINEMA4K = 4,           
    OPJ_MCT = 0x8100
} OPJ_RSIZ_CAPABILITIES;

typedef enum CINEMA_MODE {
    OPJ_OFF = 0,                        
    OPJ_CINEMA2K_24 = 1,        
    OPJ_CINEMA2K_48 = 2,        
    OPJ_CINEMA4K_24 = 3         
}OPJ_CINEMA_MODE;

typedef enum PROG_ORDER {
        OPJ_PROG_UNKNOWN = -1,  
        OPJ_LRCP = 0,                   
        OPJ_RLCP = 1,                   
        OPJ_RPCL = 2,                   
        OPJ_PCRL = 3,                   
        OPJ_CPRL = 4                    
} OPJ_PROG_ORDER;

typedef enum COLOR_SPACE {
    OPJ_CLRSPC_UNKNOWN = -1,    
    OPJ_CLRSPC_UNSPECIFIED = 0, 
    OPJ_CLRSPC_SRGB = 1,                
    OPJ_CLRSPC_GRAY = 2,                
    OPJ_CLRSPC_SYCC = 3,                
    OPJ_CLRSPC_EYCC = 4,        
    OPJ_CLRSPC_CMYK = 5         
} OPJ_COLOR_SPACE;

typedef enum CODEC_FORMAT {
        OPJ_CODEC_UNKNOWN = -1, 
        OPJ_CODEC_J2K  = 0,             
        OPJ_CODEC_JPT  = 1,             
    OPJ_CODEC_JP2  = 2,         
    OPJ_CODEC_JPP  = 3,         
    OPJ_CODEC_JPX  = 4          
} OPJ_CODEC_FORMAT;


/* 
==========================================================
   event manager typedef definitions
==========================================================
*/

typedef void (*opj_msg_callback) (const char *msg, void *client_data);

/* 
==========================================================
   codec typedef definitions
==========================================================
*/

typedef struct opj_poc {
        OPJ_UINT32 resno0, compno0;
        OPJ_UINT32 layno1, resno1, compno1;
        OPJ_UINT32 layno0, precno0, precno1;
        OPJ_PROG_ORDER prg1,prg;
        OPJ_CHAR progorder[5];
        OPJ_UINT32 tile;
        OPJ_INT32 tx0,tx1,ty0,ty1;
        OPJ_UINT32 layS, resS, compS, prcS;
        OPJ_UINT32 layE, resE, compE, prcE;
        OPJ_UINT32 txS,txE,tyS,tyE,dx,dy;
        OPJ_UINT32 lay_t, res_t, comp_t, prc_t,tx0_t,ty0_t;
} opj_poc_t;

typedef struct opj_cparameters {
        OPJ_BOOL tile_size_on;
        int cp_tx0;
        int cp_ty0;
        int cp_tdx;
        int cp_tdy;
        int cp_disto_alloc;
        int cp_fixed_alloc;
        int cp_fixed_quality;
        int *cp_matrice;
        char *cp_comment;
        int csty;
        OPJ_PROG_ORDER prog_order;
        opj_poc_t POC[32];
        OPJ_UINT32 numpocs;
        int tcp_numlayers;
        float tcp_rates[100];
        float tcp_distoratio[100];
        int numresolution;
        int cblockw_init;
        int cblockh_init;
        int mode;
        int irreversible;
        int roi_compno;
        int roi_shift;
        /* number of precinct size specifications */
        int res_spec;
        int prcw_init[OPJ_J2K_MAXRLVLS];
        int prch_init[OPJ_J2K_MAXRLVLS];

        char infile[OPJ_PATH_LEN];
        char outfile[OPJ_PATH_LEN];
        int index_on;
        char index[OPJ_PATH_LEN];
        int image_offset_x0;
        int image_offset_y0;
        int subsampling_dx;
        int subsampling_dy;
        int decod_format;
        int cod_format;
/* UniPG>> */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */
        OPJ_BOOL jpwl_epc_on;
        int jpwl_hprot_MH;
        int jpwl_hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
        int jpwl_hprot_TPH[JPWL_MAX_NO_TILESPECS];
        int jpwl_pprot_tileno[JPWL_MAX_NO_PACKSPECS];
        int jpwl_pprot_packno[JPWL_MAX_NO_PACKSPECS];
        int jpwl_pprot[JPWL_MAX_NO_PACKSPECS];
        int jpwl_sens_size;
        int jpwl_sens_addr;
        int jpwl_sens_range;
        int jpwl_sens_MH;
        int jpwl_sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
        int jpwl_sens_TPH[JPWL_MAX_NO_TILESPECS];
/* <<UniPG */

    OPJ_CINEMA_MODE cp_cinema;
        int max_comp_size;
    OPJ_RSIZ_CAPABILITIES cp_rsiz;
        char tp_on;
        char tp_flag;
        char tcp_mct;
        OPJ_BOOL jpip_on;
        void * mct_data;
    int max_cs_size;
    OPJ_UINT16 rsiz;
} opj_cparameters_t;  

#define OPJ_DPARAMETERS_IGNORE_PCLR_CMAP_CDEF_FLAG      0x0001

typedef struct opj_dparameters {
        OPJ_UINT32 cp_reduce;
        OPJ_UINT32 cp_layer;

        char infile[OPJ_PATH_LEN];
        char outfile[OPJ_PATH_LEN];
        int decod_format;
        int cod_format;

        OPJ_UINT32 DA_x0;
        OPJ_UINT32 DA_x1;
        OPJ_UINT32 DA_y0;
        OPJ_UINT32 DA_y1;
        OPJ_BOOL m_verbose;

        OPJ_UINT32 tile_index;
        OPJ_UINT32 nb_tile_to_decode;

/* UniPG>> */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */
        OPJ_BOOL jpwl_correct;
        int jpwl_exp_comps;
        int jpwl_max_tiles;
/* <<UniPG */

        unsigned int flags;

} opj_dparameters_t;


typedef void * opj_codec_t;

/* 
==========================================================
   I/O stream typedef definitions
==========================================================
*/

#define OPJ_STREAM_READ OPJ_TRUE

#define OPJ_STREAM_WRITE OPJ_FALSE

/*
 * Callback function prototype for read function
 */
typedef OPJ_SIZE_T (* opj_stream_read_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;

/*
 * Callback function prototype for write function
 */
typedef OPJ_SIZE_T (* opj_stream_write_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ;

/*
 * Callback function prototype for skip function
 */
typedef OPJ_OFF_T (* opj_stream_skip_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ;

/*
 * Callback function prototype for seek function
 */
typedef OPJ_BOOL (* opj_stream_seek_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ;

/*
 * Callback function prototype for free user data function
 */
typedef void (* opj_stream_free_user_data_fn) (void * p_user_data) ;

/*
 * JPEG2000 Stream.
 */
typedef void * opj_stream_t;

/* 
==========================================================
   image typedef definitions
==========================================================
*/

typedef struct opj_image_comp {
        OPJ_UINT32 dx;
        OPJ_UINT32 dy;
        OPJ_UINT32 w;
        OPJ_UINT32 h;
        OPJ_UINT32 x0;
        OPJ_UINT32 y0;
        OPJ_UINT32 prec;
        OPJ_UINT32 bpp;
        OPJ_UINT32 sgnd;
        OPJ_UINT32 resno_decoded;
        OPJ_UINT32 factor;
        OPJ_INT32 *data;
  OPJ_UINT16 alpha;
} opj_image_comp_t;

typedef struct opj_image {
        OPJ_UINT32 x0;
        OPJ_UINT32 y0;
        OPJ_UINT32 x1;
        OPJ_UINT32 y1;
        OPJ_UINT32 numcomps;
        OPJ_COLOR_SPACE color_space;
        opj_image_comp_t *comps;
        OPJ_BYTE *icc_profile_buf;
        OPJ_UINT32 icc_profile_len;
} opj_image_t;


typedef struct opj_image_comptparm {
        OPJ_UINT32 dx;
        OPJ_UINT32 dy;
        OPJ_UINT32 w;
        OPJ_UINT32 h;
        OPJ_UINT32 x0;
        OPJ_UINT32 y0;
        OPJ_UINT32 prec;
        OPJ_UINT32 bpp;
        OPJ_UINT32 sgnd;
} opj_image_cmptparm_t;


/* 
==========================================================
   Information on the JPEG 2000 codestream
==========================================================
*/
/* QUITE EXPERIMENTAL FOR THE MOMENT */

typedef struct opj_packet_info {
        OPJ_OFF_T start_pos;
        OPJ_OFF_T end_ph_pos;
        OPJ_OFF_T end_pos;
        double disto;
} opj_packet_info_t;


/* UniPG>> */
typedef struct opj_marker_info {
        unsigned short int type;
        OPJ_OFF_T pos;
        int len;
} opj_marker_info_t;
/* <<UniPG */

typedef struct opj_tp_info {
        int tp_start_pos;
        int tp_end_header;
        int tp_end_pos;
        int tp_start_pack;
        int tp_numpacks;
} opj_tp_info_t;

typedef struct opj_tile_info {
        double *thresh;
        int tileno;
        int start_pos;
        int end_header;
        int end_pos;
        int pw[33];
        int ph[33];
        int pdx[33];
        int pdy[33];
        opj_packet_info_t *packet;
        int numpix;
        double distotile;
        int marknum;
        opj_marker_info_t *marker;
        int maxmarknum;
        int num_tps;
        opj_tp_info_t *tp;
} opj_tile_info_t;

typedef struct opj_codestream_info {
        double D_max;
        int packno;
        int index_write;
        int image_w;
        int image_h;
        OPJ_PROG_ORDER prog;
        int tile_x;
        int tile_y;
        int tile_Ox;
        int tile_Oy;
        int tw;
        int th;
        int numcomps;
        int numlayers;
        int *numdecompos;
/* UniPG>> */
        int marknum;
        opj_marker_info_t *marker;
        int maxmarknum;
/* <<UniPG */
        int main_head_start;
        int main_head_end;
        int codestream_size;
        opj_tile_info_t *tile;
} opj_codestream_info_t;

/* <----------------------------------------------------------- */
/* new output management of the codestream information and index */

typedef struct opj_tccp_info
{
        OPJ_UINT32 compno;
        OPJ_UINT32 csty;
        OPJ_UINT32 numresolutions;
        OPJ_UINT32 cblkw;
        OPJ_UINT32 cblkh;
        OPJ_UINT32 cblksty;
        OPJ_UINT32 qmfbid;
        OPJ_UINT32 qntsty;
        OPJ_UINT32 stepsizes_mant[OPJ_J2K_MAXBANDS];
        OPJ_UINT32 stepsizes_expn[OPJ_J2K_MAXBANDS];
        OPJ_UINT32 numgbits;
        OPJ_INT32 roishift;
        OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
        OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
}
opj_tccp_info_t;

typedef struct opj_tile_v2_info {

        int tileno;
        OPJ_UINT32 csty;
        OPJ_PROG_ORDER prg;
        OPJ_UINT32 numlayers;
        OPJ_UINT32 mct;

        opj_tccp_info_t *tccp_info;

} opj_tile_info_v2_t;

typedef struct opj_codestream_info_v2 {
        /* Tile info */
        OPJ_UINT32 tx0;
        OPJ_UINT32 ty0;
        OPJ_UINT32 tdx;
        OPJ_UINT32 tdy;
        OPJ_UINT32 tw;
        OPJ_UINT32 th;

        OPJ_UINT32 nbcomps;

        opj_tile_info_v2_t m_default_tile_info;

        opj_tile_info_v2_t *tile_info; /* FIXME not used for the moment */

} opj_codestream_info_v2_t;


typedef struct opj_tp_index {
        OPJ_OFF_T start_pos;
        OPJ_OFF_T end_header;
        OPJ_OFF_T end_pos;

} opj_tp_index_t;

typedef struct opj_tile_index {
        OPJ_UINT32 tileno;

        OPJ_UINT32 nb_tps;
        OPJ_UINT32 current_nb_tps;
        OPJ_UINT32 current_tpsno;
        opj_tp_index_t *tp_index;

        /* UniPG>> */ /* NOT USED FOR THE MOMENT IN THE V2 VERSION */
                OPJ_UINT32 marknum;
                opj_marker_info_t *marker;
                OPJ_UINT32 maxmarknum;
        /* <<UniPG */

        OPJ_UINT32 nb_packet;
        opj_packet_info_t *packet_index;

} opj_tile_index_t;

typedef struct opj_codestream_index {
        OPJ_OFF_T main_head_start;
        OPJ_OFF_T main_head_end;

        OPJ_UINT64 codestream_size;

/* UniPG>> */ /* NOT USED FOR THE MOMENT IN THE V2 VERSION */
        OPJ_UINT32 marknum;
        opj_marker_info_t *marker;
        OPJ_UINT32 maxmarknum;
/* <<UniPG */

        OPJ_UINT32 nb_of_tiles;
        opj_tile_index_t *tile_index; /* FIXME not used for the moment */

}opj_codestream_index_t;
/* -----------------------------------------------------------> */

/*
==========================================================
   Metadata from the JP2file
==========================================================
*/

typedef struct opj_jp2_metadata {
        OPJ_INT32       not_used;

} opj_jp2_metadata_t;

typedef struct opj_jp2_index {
        OPJ_INT32       not_used;

} opj_jp2_index_t;


#ifdef __cplusplus
extern "C" {
#endif


/* 
==========================================================
   openjpeg version
==========================================================
*/

/* Get the version of the openjpeg library*/
OPJ_API const char * OPJ_CALLCONV opj_version(void);

/* 
==========================================================
   image functions definitions
==========================================================
*/

OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(OPJ_UINT32 numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);

OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);

OPJ_API opj_image_t* OPJ_CALLCONV opj_image_tile_create(OPJ_UINT32 numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);

/* 
==========================================================
   stream functions definitions
==========================================================
*/

OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_default_create(OPJ_BOOL p_is_input);

OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create(OPJ_SIZE_T p_buffer_size, OPJ_BOOL p_is_input);

OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream);
 
OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream, opj_stream_read_fn p_function);

OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream, opj_stream_write_fn p_function);

OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream, opj_stream_skip_fn p_function);

OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream, opj_stream_seek_fn p_function);

OPJ_API void OPJ_CALLCONV opj_stream_set_user_data (opj_stream_t* p_stream, void * p_data, opj_stream_free_user_data_fn p_function);

OPJ_API void OPJ_CALLCONV opj_stream_set_user_data_length(opj_stream_t* p_stream, OPJ_UINT64 data_length);

OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream (const char *fname, OPJ_BOOL p_is_read_stream);
 
OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream (const char *fname,
                                                                     OPJ_SIZE_T p_buffer_size,
                                                                     OPJ_BOOL p_is_read_stream);
 
/* 
==========================================================
   event manager functions definitions
==========================================================
*/
OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_info_handler(opj_codec_t * p_codec, 
                                                   opj_msg_callback p_callback,
                                                   void * p_user_data);
OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_warning_handler(opj_codec_t * p_codec,
                                                      opj_msg_callback p_callback,
                                                      void * p_user_data);
OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_error_handler(opj_codec_t * p_codec, 
                                                    opj_msg_callback p_callback,
                                                    void * p_user_data);

/* 
==========================================================
   codec functions definitions
==========================================================
*/

OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format);

OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec);

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_decompress (      opj_codec_t *p_codec,
                                                                                                        opj_stream_t *p_stream);


OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters);

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_decoder(opj_codec_t *p_codec,
                                                                                                opj_dparameters_t *parameters );

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_read_header ( opj_stream_t *p_stream,
                                                                                                opj_codec_t *p_codec,
                                                                                                opj_image_t **p_image);

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decode_area(      opj_codec_t *p_codec,
                                                                                                        opj_image_t* p_image,
                                                                                                        OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
                                                                                                        OPJ_INT32 p_end_x, OPJ_INT32 p_end_y );

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode(   opj_codec_t *p_decompressor,
                                            opj_stream_t *p_stream,
                                            opj_image_t *p_image);

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_get_decoded_tile(     opj_codec_t *p_codec,
                                                                                                        opj_stream_t *p_stream,
                                                                                                        opj_image_t *p_image,
                                                                                                        OPJ_UINT32 tile_index);

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decoded_resolution_factor(opj_codec_t *p_codec, OPJ_UINT32 res_factor);

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_write_tile (  opj_codec_t *p_codec,
                                                                                                OPJ_UINT32 p_tile_index,
                                                                                                OPJ_BYTE * p_data,
                                                                                                OPJ_UINT32 p_data_size,
                                                                                                opj_stream_t *p_stream );

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_read_tile_header(     opj_codec_t *p_codec,
                                                                                                opj_stream_t * p_stream,
                                                                                                OPJ_UINT32 * p_tile_index,
                                                                                                OPJ_UINT32 * p_data_size,
                                                                                                OPJ_INT32 * p_tile_x0, OPJ_INT32 * p_tile_y0,
                                                                                                OPJ_INT32 * p_tile_x1, OPJ_INT32 * p_tile_y1,
                                                                                                OPJ_UINT32 * p_nb_comps,
                                                                                                OPJ_BOOL * p_should_go_on );

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode_tile_data(     opj_codec_t *p_codec,
                                                                                                        OPJ_UINT32 p_tile_index,
                                                                                                        OPJ_BYTE * p_data,
                                                                                                        OPJ_UINT32 p_data_size,
                                                                                                        opj_stream_t *p_stream );

/* COMPRESSION FUNCTIONS*/

OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);

OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(opj_cparameters_t *parameters);

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_encoder(opj_codec_t *p_codec, 
                                                                                                opj_cparameters_t *parameters, 
                                                                                                opj_image_t *image);

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_start_compress (      opj_codec_t *p_codec,
                                                                                                        opj_image_t * p_image,
                                                                                                        opj_stream_t *p_stream);

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_compress (opj_codec_t *p_codec,
                                                                                                opj_stream_t *p_stream);

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_encode(opj_codec_t *p_codec,
                                         opj_stream_t *p_stream);
/*
==========================================================
   codec output functions definitions
==========================================================
*/
/* EXPERIMENTAL FUNCTIONS FOR NOW, USED ONLY IN J2K_DUMP*/

OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_v2_t **cstr_info);


OPJ_API void OPJ_CALLCONV opj_dump_codec(       opj_codec_t *p_codec,
                                                                                        OPJ_INT32 info_flag,
                                                                                        FILE* output_stream);

OPJ_API opj_codestream_info_v2_t* OPJ_CALLCONV opj_get_cstr_info(opj_codec_t *p_codec);

OPJ_API opj_codestream_index_t * OPJ_CALLCONV opj_get_cstr_index(opj_codec_t *p_codec);

OPJ_API void OPJ_CALLCONV opj_destroy_cstr_index(opj_codestream_index_t **p_cstr_index);


OPJ_API opj_jp2_metadata_t* OPJ_CALLCONV opj_get_jp2_metadata(opj_codec_t *p_codec);

OPJ_API opj_jp2_index_t* OPJ_CALLCONV opj_get_jp2_index(opj_codec_t *p_codec);


/*
==========================================================
   MCT functions
==========================================================
*/

OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_MCT( opj_cparameters_t *parameters,
                                                   OPJ_FLOAT32 * pEncodingMatrix,
                                                   OPJ_INT32 * p_dc_shift,
                                                   OPJ_UINT32 pNbComp);



#ifdef __cplusplus
}
#endif

#endif /* OPENJPEG_H */