X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libopenjpeg%2Fopenjpeg.h;h=b5772263bbfc76055cff01240f4da584e2b74602;hb=3de14fc63ecddf490637117ea650e0f559e7f9fe;hp=94fbdfa5dae5417e4df205b2076ee14d82e8795a;hpb=d44375aece5dea2af83ffb8c9de4ade2ad35c593;p=openjpeg.git diff --git a/libopenjpeg/openjpeg.h b/libopenjpeg/openjpeg.h index 94fbdfa5..b5772263 100644 --- a/libopenjpeg/openjpeg.h +++ b/libopenjpeg/openjpeg.h @@ -6,7 +6,9 @@ * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe * Copyright (c) 2005, Herve Drolon, FreeImage Team * Copyright (c) 2006-2007, Parvatha Elangovan + * Copyright (c) 2008, Jerome Fimes, Communications & Systemes * Copyright (c) 2010-2011, Kaori Hagihara + * Copyright (c) 2011, Mickael Savinaud, Communications & Systemes * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -40,6 +42,16 @@ ========================================================== */ +/* deprecated attribute */ +#ifdef __GNUC__ + #define DEPRECATED(func) func __attribute__ ((deprecated)) +#elif defined(_MSC_VER) + #define DEPRECATED(func) __declspec(deprecated) func +#else + #pragma message("WARNING: You need to implement DEPRECATED for this compiler") + #define DEPRECATED(func) func +#endif + #if defined(OPJ_STATIC) || !defined(_WIN32) #define OPJ_API #define OPJ_CALLCONV @@ -60,21 +72,51 @@ defined with this macro as being exported. #endif /* OPJ_EXPORTS */ #endif /* !OPJ_STATIC || !_WIN32 */ -typedef int opj_bool; +typedef int opj_bool; /*FIXME it should be to follow the name of others OPJ_TYPE -> OPJ_BOOL*/ #define OPJ_TRUE 1 #define OPJ_FALSE 0 -typedef unsigned int OPJ_UINT32; -typedef int OPJ_INT32; -typedef unsigned short OPJ_UINT16; -typedef short OPJ_INT16; -typedef char OPJ_CHAR; +typedef char OPJ_CHAR; +typedef float OPJ_FLOAT32; +typedef double OPJ_FLOAT64; typedef unsigned char OPJ_BYTE; -typedef unsigned int OPJ_SIZE_T; -typedef double OPJ_FLOAT64; -typedef float OPJ_FLOAT32; +typedef size_t OPJ_SIZE_T; + +#include "opj_config.h" +#ifdef HAVE_STDINT_H +#include +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; +#define OPJ_INT64_F "ll" +#define OPJ_UINT64_F "ll" +#else +#if defined(_WIN32) +typedef signed __int8 OPJ_INT8; +typedef unsigned __int8 OPJ_UINT8; +typedef signed __int16 OPJ_INT16; +typedef unsigned __int16 OPJ_UINT16; +typedef signed __int32 OPJ_INT32; +typedef unsigned __int32 OPJ_UINT32; +typedef signed __int64 OPJ_INT64; +typedef unsigned __int64 OPJ_UINT64; +#define OPJ_INT64_F "I64" +#define OPJ_UINT64_F "I64" +#else +#error unsupported platform +#endif +#endif + +/* 64-bit file offset type */ +typedef OPJ_INT64 OPJ_OFF_T; +#define OPJ_OFF_F OPJ_INT64_F -// Avoid compile-time warning because parameter is not used +/* Avoid compile-time warning because parameter is not used */ #define OPJ_ARG_NOT_USED(x) (void)(x) /* @@ -106,12 +148,18 @@ typedef float OPJ_FLOAT32; /* < -
  • Error messages -
  • Warning messages -
  • Debugging messages - -*/ + * Message handler object used for + *
      + *
    • Error messages + *
    • Warning messages + *
    • Debugging messages + *
    + * */ typedef struct opj_event_mgr { + /** FIXME DOC */ void* client_data; /** Error message callback if available, NULL otherwise */ opj_msg_callback error_handler; @@ -223,13 +269,13 @@ typedef struct opj_event_mgr { */ /** -Progression order changes -*/ + * Progression order changes + * */ typedef struct opj_poc { /** Resolution num start, Component num start, given by POC */ - int resno0, compno0; + OPJ_UINT32 resno0, compno0; /** Layer num end,Resolution num end, Component num end, given by POC */ - int layno1, resno1, compno1; + OPJ_UINT32 layno1, resno1, compno1; /** Layer num start,Precinct num start, Precinct num end */ int layno0, precno0, precno1; /** Progression order enum*/ @@ -251,8 +297,8 @@ typedef struct opj_poc { } opj_poc_t; /** -Compression parameters -*/ + * Compression parameters + * */ typedef struct opj_cparameters { /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */ opj_bool tile_size_on; @@ -381,9 +427,11 @@ typedef struct opj_cparameters { opj_bool jpip_on; } opj_cparameters_t; +#define OPJ_DPARAMETERS_IGNORE_PCLR_CMAP_CDEF_FLAG 0x0001 + /** -Decompression parameters -*/ + * Decompression parameters + * */ typedef struct opj_dparameters { /** Set the number of highest resolution levels to be discarded. @@ -401,7 +449,7 @@ typedef struct opj_dparameters { */ int cp_layer; - /**@name command line encoder parameters (not used inside the library) */ + /**@name command line decoder parameters (not used inside the library) */ /*@{*/ /** input file name */ char infile[OPJ_PATH_LEN]; @@ -411,6 +459,23 @@ typedef struct opj_dparameters { int decod_format; /** output file format 0: PGX, 1: PxM, 2: BMP */ int cod_format; + + /** Decoding area left boundary */ + OPJ_UINT32 DA_x0; + /** Decoding area right boundary */ + OPJ_UINT32 DA_x1; + /** Decoding area up boundary */ + OPJ_UINT32 DA_y0; + /** Decoding area bottom boundary */ + OPJ_UINT32 DA_y1; + /** Verbose mode */ + opj_bool m_verbose; + + /** tile number ot the decoded tile*/ + OPJ_UINT32 tile_index; + /** Nb of tile to decode */ + OPJ_UINT32 nb_tile_to_decode; + /*@}*/ /* UniPG>> */ @@ -433,16 +498,11 @@ typedef struct opj_dparameters { */ OPJ_LIMIT_DECODING cp_limit_decoding; - - /* V2 */ - OPJ_UINT32 ROI_x0; - OPJ_UINT32 ROI_x1; - OPJ_UINT32 ROI_y0; - OPJ_UINT32 ROI_y1; - - + unsigned int flags; } opj_dparameters_t; + +/* ---> FIXME V1 style */ /** Common fields between JPEG-2000 compression and decompression master structs. */ #define opj_common_fields \ @@ -469,8 +529,8 @@ typedef struct opj_common_struct { typedef opj_common_struct_t * opj_common_ptr; /** -Compression context info -*/ + * Compression context info + * */ typedef struct opj_cinfo { /** Fields shared with opj_dinfo_t */ opj_common_fields; @@ -478,17 +538,19 @@ typedef struct opj_cinfo { } opj_cinfo_t; /** -Decompression context info -*/ + * Decompression context info + * */ typedef struct opj_dinfo { /** Fields shared with opj_cinfo_t */ opj_common_fields; /* other specific fields go here */ } opj_dinfo_t; +/* <--- V1 style */ + /** - * J2k codec. - */ + * JPEG2000 codec V2. + * */ typedef void * opj_codec_t; /* @@ -527,12 +589,18 @@ typedef struct opj_cio { unsigned char *bp; } opj_cio_t; -typedef OPJ_UINT32 (* opj_stream_read_fn) (void * p_buffer, OPJ_UINT32 p_nb_bytes, void * p_user_data) ; -typedef OPJ_UINT32 (* opj_stream_write_fn) (void * p_buffer, OPJ_UINT32 p_nb_bytes, void * p_user_data) ; -typedef OPJ_SIZE_T (* opj_stream_skip_fn) (OPJ_SIZE_T p_nb_bytes, void * p_user_data) ; -typedef opj_bool (* opj_stream_seek_fn) (OPJ_SIZE_T p_nb_bytes, void * p_user_data) ; +/* + * FIXME DOC + */ +typedef OPJ_SIZE_T (* opj_stream_read_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ; +typedef OPJ_SIZE_T (* opj_stream_write_fn) (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ; +typedef OPJ_OFF_T (* opj_stream_skip_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ; +typedef opj_bool (* opj_stream_seek_fn) (OPJ_OFF_T p_nb_bytes, void * p_user_data) ; +/* + * JPEG2000 Stream. + */ typedef void * opj_stream_t; /* @@ -542,38 +610,38 @@ typedef void * opj_stream_t; */ /** -Defines a single image component -*/ + * Defines a single image component + * */ typedef struct opj_image_comp { /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */ - int dx; + OPJ_UINT32 dx; /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */ - int dy; + OPJ_UINT32 dy; /** data width */ - int w; + OPJ_UINT32 w; /** data height */ - int h; + OPJ_UINT32 h; /** x component offset compared to the whole image */ - int x0; + OPJ_UINT32 x0; /** y component offset compared to the whole image */ - int y0; + OPJ_UINT32 y0; /** precision */ - int prec; + OPJ_UINT32 prec; /** image depth in bits */ - int bpp; + OPJ_UINT32 bpp; /** signed (1) / unsigned (0) */ - int sgnd; + OPJ_UINT32 sgnd; /** number of decoded resolution */ - int resno_decoded; + OPJ_UINT32 resno_decoded; /** number of division by 2 of the out image compared to the original size of image */ - int factor; + OPJ_UINT32 factor; /** image component data */ - int *data; + OPJ_INT32 *data; } opj_image_comp_t; /** -Defines image data and characteristics -*/ + * Defines image data and characteristics + * */ typedef struct opj_image { /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */ OPJ_UINT32 x0; @@ -584,21 +652,21 @@ typedef struct opj_image { /** Ysiz: height of the reference grid */ OPJ_UINT32 y1; /** number of components in the image */ - OPJ_UINT16 numcomps; + OPJ_UINT32 numcomps; /** color space: sRGB, Greyscale or YUV */ OPJ_COLOR_SPACE color_space; /** image components */ opj_image_comp_t *comps; /** 'restricted' ICC profile */ - unsigned char *icc_profile_buf; + OPJ_BYTE *icc_profile_buf; /** size of ICC profile */ - int icc_profile_len; + OPJ_INT32 icc_profile_len; } opj_image_t; /** -Component parameters structure used by the opj_image_create function -*/ + * Component parameters structure used by the opj_image_create function + * */ typedef struct opj_image_comptparm { /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */ int dx; @@ -621,76 +689,6 @@ typedef struct opj_image_comptparm { } opj_image_cmptparm_t; - -/** -Defines a single image component characteristics (uses in new API) -*/ -typedef struct opj_image_comp_header { - /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */ - int dx; - /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */ - int dy; - /** data width */ - int w; - /** data height */ - int h; - /** x component offset compared to the whole image */ - int x0; - /** y component offset compared to the whole image */ - int y0; - /** precision */ - int prec; - /** image depth in bits */ - int bpp; - /** signed (1) / unsigned (0) */ - int sgnd; - /** number of decoded resolution */ - int resno_decoded; - /** number of division by 2 of the out image compared to the original size of image */ - int factor; -} opj_image_comp_header_t; - -/** -Defines image characteristics (uses in new API) -*/ -typedef struct opj_image_header { - /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */ - OPJ_UINT32 x0; - /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */ - OPJ_UINT32 y0; - /** Xsiz: width of the reference grid */ - OPJ_UINT32 x1; - /** Ysiz: height of the reference grid */ - OPJ_UINT32 y1; - /** number of components in the image */ - OPJ_UINT16 numcomps; - /** color space: sRGB, Greyscale or YUV */ - OPJ_COLOR_SPACE color_space; - /** image components */ - opj_image_comp_header_t *comps; - -#ifdef TODO_MSD - /** XTOsiz */ - OPJ_UINT32 tile_x0; - /** YTOsiz */ - OPJ_UINT32 tile_y0; - /** XTsiz */ - OPJ_UINT32 tile_width; - /** YTsiz */ - OPJ_UINT32 tile_height; - /** number of tiles in width */ - OPJ_UINT32 nb_tiles_x; - /** number of tiles in height */ - OPJ_UINT32 nb_tiles_y; -#endif - - /** 'restricted' ICC profile */ - unsigned char *icc_profile_buf; - /** size of ICC profile */ - int icc_profile_len; -} opj_image_header_t; - - /* ========================================================== Information on the JPEG 2000 codestream @@ -698,15 +696,15 @@ typedef struct opj_image_header { */ /** -Index structure : Information concerning a packet inside tile -*/ + * Index structure : Information concerning a packet inside tile + * */ typedef struct opj_packet_info { /** packet start position (including SOP marker if it exists) */ - int start_pos; + OPJ_OFF_T start_pos; /** end of packet header position (including EPH marker if it exists)*/ - int end_ph_pos; + OPJ_OFF_T end_ph_pos; /** packet end position */ - int end_pos; + OPJ_OFF_T end_pos; /** packet distorsion */ double disto; } opj_packet_info_t; @@ -714,20 +712,20 @@ typedef struct opj_packet_info { /* UniPG>> */ /** -Marker structure -*/ + * Marker structure + * */ typedef struct opj_marker_info_t { /** marker type */ unsigned short int type; /** position in codestream */ - int pos; + OPJ_OFF_T pos; /** length, marker val included */ int len; } opj_marker_info_t; /* <> */ + /** number of markers */ + OPJ_UINT32 marknum; + /** list of markers */ + opj_marker_info_t *marker; + /** actual size of markers array */ + OPJ_UINT32 maxmarknum; + /* <> */ /** number of markers */ - int marknum; + OPJ_UINT32 marknum; /** list of markers */ opj_marker_info_t *marker; /** actual size of markers array */ - int maxmarknum; + OPJ_UINT32 maxmarknum; /* < */ /* ========================================================== @@ -993,37 +1003,24 @@ typedef struct opj_codestream_info_v2 { */ /** -Info structure of the file -*/ + * Info structure of the JP2 file + * FIXME + */ typedef struct opj_jp2_metadata { /** */ - OPJ_INT32 empty_fields; + OPJ_INT32 not_used; } opj_jp2_metadata_t; -/* -========================================================== - Information on the JPEG2000 file -========================================================== -*/ - /** -Info structure of the file -*/ -typedef struct opj_file_info { - /** file format */ - OPJ_INT32 file_format; - /** file info level*/ - OPJ_INT32 file_info_flag; - /** image info*/ - opj_image_header_t img_info; - /** codestream info */ - opj_codestream_info_v2_t codestream_info; - /** file info */ - opj_jp2_metadata_t jp2_metadata; - -} opj_file_info_t; + * Index structure of the JP2 file + * FIXME + */ +typedef struct opj_jp2_index { + /** */ + OPJ_INT32 not_used; +} opj_jp2_index_t; #ifdef __cplusplus @@ -1046,21 +1043,20 @@ OPJ_API const char * OPJ_CALLCONV opj_version(void); */ /** -Create an image -@param numcmpts number of components -@param cmptparms components parameters -@param clrspc image color space -@return returns a new image structure if successful, returns NULL otherwise -*/ + * Create an image + * @param numcmpts number of components + * @param cmptparms components parameters + * @param clrspc image color space + * @return returns a new image structure if successful, returns NULL otherwise + * */ OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(int numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc); /** -Deallocate any resources associated with an image -@param image image to be destroyed -*/ + * Deallocate any resources associated with an image + * @param image image to be destroyed + */ OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image); -OPJ_API void OPJ_CALLCONV opj_image_header_destroy(opj_image_header_t *image_header); /* ========================================================== @@ -1100,6 +1096,8 @@ Set position in byte stream */ OPJ_API void OPJ_CALLCONV cio_seek(opj_cio_t *cio, int pos); +/* <----------- */ +/* V2 framework */ /** * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream. @@ -1109,7 +1107,7 @@ OPJ_API void OPJ_CALLCONV cio_seek(opj_cio_t *cio, int pos); * @return a stream object. */ 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_UINT32 p_size, 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); /** * Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must @@ -1155,17 +1153,24 @@ OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream, o */ OPJ_API void OPJ_CALLCONV opj_stream_set_user_data (opj_stream_t* p_stream, void * p_data); +/** + * Sets the length of the user data for the stream. + * @param p_stream the stream to modify + * @param data_length length of the user_data. +*/ +OPJ_API void OPJ_CALLCONV opj_stream_set_user_data_length(opj_stream_t* p_stream, OPJ_UINT64 data_length); + /** * Helper function. * Sets the stream to be a file stream. The FILE must have been open previously. - * @param p_stream the stream to modify - * @param p_file handler to an already open file. + * @param p_file the file stream to operate on + * @param p_is_read_stream whether the stream is a read stream (true) or not (false) */ OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream (FILE * p_file, opj_bool p_is_read_stream); -OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream (FILE * p_file, OPJ_UINT32 p_buffer_size, opj_bool p_is_read_stream); - +OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream (FILE * p_file, OPJ_SIZE_T p_buffer_size, opj_bool p_is_read_stream); +/* -----------> */ /* ========================================================== @@ -1173,56 +1178,209 @@ OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream (FILE * p_file, ========================================================== */ -OPJ_API opj_event_mgr_t* OPJ_CALLCONV opj_set_event_mgr(opj_common_ptr cinfo, opj_event_mgr_t *event_mgr, void *context); +/** + */ +DEPRECATED( OPJ_API opj_event_mgr_t* OPJ_CALLCONV opj_set_event_mgr(opj_common_ptr cinfo, opj_event_mgr_t *event_mgr, void *context)); + +/** + * Initialize a default event handler. This function set the output of message event to be stderr for warning and error output + * and stdout for info output in the verbose mode. In the case of the non-verbose mode only the error message are displayed. + * You can initialize your own event handler struct when you fill the field of the event structure. If you provide a null + * structure to the opj_setup_decoder function, no output will be displayed. + * + * @param p_manager a opj_event_mgr structure which will be pass to the codec. + * + */ +OPJ_API void OPJ_CALLCONV opj_initialize_default_event_handler(opj_event_mgr_t * p_manager, opj_bool verbose); + /* ========================================================== codec functions definitions ========================================================== */ + /** Creates a J2K/JPT/JP2 decompression structure @param format Decoder to select @return Returns a handle to a decompressor if successful, returns NULL otherwise */ -OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress_v2(OPJ_CODEC_FORMAT format); - +DEPRECATED( OPJ_API opj_dinfo_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format) ); /** -Creates a J2K/JPT/JP2 decompression structure -@param format Decoder to select -@return Returns a handle to a decompressor if successful, returns NULL otherwise -*/ -OPJ_API opj_dinfo_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format); + * Creates a J2K/JP2 decompression structure + * @param format Decoder to select + * + * @return Returns a handle to a decompressor if successful, returns NULL otherwise + * */ +OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_decompress_v2(OPJ_CODEC_FORMAT format); + /** Destroy a decompressor handle @param dinfo decompressor handle to destroy */ -OPJ_API void OPJ_CALLCONV opj_destroy_decompress(opj_dinfo_t *dinfo); +DEPRECATED( OPJ_API void OPJ_CALLCONV opj_destroy_decompress(opj_dinfo_t *dinfo) ); + +/** + * Read after the codestream if necessary + */ +OPJ_API opj_bool OPJ_CALLCONV opj_end_decompress ( opj_codec_t *p_codec, + opj_stream_t *p_cio); + + /** Set decoding parameters to default values @param parameters Decompression parameters */ OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters); + /** Setup the decoder decoding parameters using user parameters. Decoding parameters are returned in j2k->cp. @param dinfo decompressor handle @param parameters decompression parameters */ -OPJ_API void OPJ_CALLCONV opj_setup_decoder(opj_dinfo_t *dinfo, opj_dparameters_t *parameters); +DEPRECATED( OPJ_API void OPJ_CALLCONV opj_setup_decoder(opj_dinfo_t *dinfo, opj_dparameters_t *parameters) ); + +/** + * Setup the decoder with decompression parameters provided by the user and with the message handler + * provided by the user. + * + * @param dinfo decompressor handlers + * @param parameters decompression parameters + * @param event_mgr message handler + * + * @return true if the decoder is correctly set + */ OPJ_API opj_bool OPJ_CALLCONV opj_setup_decoder_v2( opj_codec_t *p_info, opj_dparameters_t *parameters, opj_event_mgr_t* event_mgr); +/** + * Decodes an image header. + * + * @param p_cio the jpeg2000 stream. + * @param p_codec the jpeg2000 codec to read. + * @param p_image the image structure initialized with the characteristics of encoded image. + * + * @return true if the main header of the codestream and the JP2 header is correctly read. + */ +OPJ_API opj_bool OPJ_CALLCONV opj_read_header ( opj_stream_t *p_cio, + opj_codec_t *p_codec, + opj_image_t **p_image); + +/** + * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading. + * + * @param p_codec the jpeg2000 codec. + * @param p_start_x the left position of the rectangle to decode (in image coordinates). + * @param p_end_x the right position of the rectangle to decode (in image coordinates). + * @param p_start_y the up position of the rectangle to decode (in image coordinates). + * @param p_end_y the bottom position of the rectangle to decode (in image coordinates). + * + * @return true if the area could be set. + */ +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 ); + /** Decode an image from a JPEG-2000 codestream @param dinfo decompressor handle @param cio Input buffer stream @return Returns a decoded image if successful, returns NULL otherwise */ -OPJ_API opj_image_t* OPJ_CALLCONV opj_decode(opj_dinfo_t *dinfo, opj_cio_t *cio); +DEPRECATED( OPJ_API opj_image_t* OPJ_CALLCONV opj_decode(opj_dinfo_t *dinfo, opj_cio_t *cio) ); + +/** + * Decode an image from a JPEG-2000 codestream + * @param p_decompressor decompressor handle + * @param cio Input buffer stream + * @param p_image the decoded image + * @return Returns a true on success, otherwise false + * */ +OPJ_API opj_bool OPJ_CALLCONV opj_decode_v2(opj_codec_t *p_decompressor, + opj_stream_t * cio, + opj_image_t *p_image); + + +/** + * Get the decoded tile from the codec + * @param p_codec the jpeg2000 codec. + * @param p_cio input streamm + * @param p_image output image + * @param tile_index index of the tile which will be decode + * + * @return opj_true if all is ok. + */ +OPJ_API opj_bool OPJ_CALLCONV opj_get_decoded_tile( opj_codec_t *p_codec, + opj_stream_t *p_cio, + opj_image_t *p_image, + OPJ_UINT32 tile_index); + + +/** + * Set the resolution factor of the decoded image + * @param p_codec the jpeg2000 codec. + * @param res_factor resolution factor to set + * + * @return opj_true if all is ok. + */ +OPJ_API opj_bool OPJ_CALLCONV opj_set_decoded_resolution_factor(opj_codec_t *p_codec, OPJ_UINT32 res_factor); + + + +/** + * Reads a tile header. This function is compulsory and allows one to know the size of the tile thta will be decoded. + * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile. + * + * @param p_codec the jpeg2000 codec. + * @param p_tile_index pointer to a value that will hold the index of the tile being decoded, in case of success. + * @param p_data_size pointer to a value that will hold the maximum size of the decoded data, in case of success. In case + * of truncated codestreams, the actual number of bytes decoded may be lower. The computation of the size is the same + * as depicted in opj_write_tile. + * @param p_tile_x0 pointer to a value that will hold the x0 pos of the tile (in the image). + * @param p_tile_y0 pointer to a value that will hold the y0 pos of the tile (in the image). + * @param p_tile_x1 pointer to a value that will hold the x1 pos of the tile (in the image). + * @param p_tile_y1 pointer to a value that will hold the y1 pos of the tile (in the image). + * @param p_nb_comps pointer to a value that will hold the number of components in the tile. + * @param p_should_go_on pointer to a boolean that will hold the fact that the decoding should go on. In case the + * codestream is over at the time of the call, the value will be set to false. The user should then stop + * the decoding. + * @param p_stream the stream to decode. + * @return true if the tile header could be decoded. In case the decoding should end, the returned value is still true. + * returning false may be the result of a shortage of memory or an internal error. + */ +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 ); + + +/** + * Reads a tile data. This function is compulsory and allows one to decode tile data. opj_read_tile_header should be called before. + * The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile. + * + * @param p_codec the jpeg2000 codec. + * @param p_tile_index the index of the tile being decoded, this should be the value set by opj_read_tile_header. + * @param p_data pointer to a memory block that will hold the decoded data. + * @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. + * @param p_stream the stream to decode. + * + * @return true if the data could be decoded. + */ +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 ); + /** Decode an image from a JPEG-2000 codestream and extract the codestream information @@ -1231,7 +1389,10 @@ Decode an image from a JPEG-2000 codestream and extract the codestream informati @param cstr_info Codestream information structure if needed afterwards, NULL otherwise @return Returns a decoded image if successful, returns NULL otherwise */ -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); +DEPRECATED( 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) ); + +/* COMPRESSION FUNCTIONS*/ + /** Creates a J2K/JP2 compression structure @param format Coder to select @@ -1290,50 +1451,94 @@ Encode an image into a JPEG-2000 codestream and extract the codestream informati @return Returns true if successful, returns false otherwise */ 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); + + + + /** Destroy Codestream information after compression or decompression @param cstr_info Codestream information structure */ OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_t *cstr_info); +OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info_v2(opj_codestream_info_v2_t **cstr_info); + + /** - * Decodes an image header. + * Destroy a decompressor handle * - * @param p_codec codec to use to decode the image. - * @param p_image pointer to a previously created image. - * @param p_tile_x0 pointer to a value that will hold the reference point x0 of the tiling grid. - * @param p_tile_y0 pointer to a value that will hold the reference point y0 of the tiling grid. - * @param p_tile_width pointer to a value that will hold the size in x of a tile in the grid. - * @param p_tile_height pointer to a value that will hold the size in y of a tile in the grid. - * @param p_nb_tiles_x pointer to a value that will hold the number of tiles in the x direction. - * @param p_nb_tiles_y pointer to a value that will hold the number of tiles in the y direction. + * @param p_codec decompressor handle to destroy */ -OPJ_API opj_bool OPJ_CALLCONV opj_read_header ( opj_stream_t *p_cio, - opj_codec_t *p_codec, - opj_file_info_t * p_file_info, - OPJ_INT32 file_info_flag); +OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec); -/** -Destroy a decompressor handle -@param dinfo decompressor handle to destroy + + + +/* +========================================================== + codec output functions definitions +========================================================== */ -OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec); /** - * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading. + * Dump the codec information into the output stream * * @param p_codec the jpeg2000 codec. - * @param p_start_x the left position of the rectangle to decode (in image coordinates). - * @param p_end_x the right position of the rectangle to decode (in image coordinates). - * @param p_start_y the up position of the rectangle to decode (in image coordinates). - * @param p_end_y the bottom position of the rectangle to decode (in image coordinates). + * @param info_flag type of information dump. + * @param output_stream output stream where dump the informations get from the codec. * - * @return true if the area could be set. */ -OPJ_API opj_bool OPJ_CALLCONV opj_set_decode_area( opj_codec_t *p_codec, - OPJ_INT32 p_start_x, OPJ_INT32 p_start_y, - OPJ_INT32 p_end_x, OPJ_INT32 p_end_y ); +OPJ_API void OPJ_CALLCONV opj_dump_codec( opj_codec_t *p_codec, + OPJ_INT32 info_flag, + FILE* output_stream); + +/** + * Get the codestream information from the codec + * + * @param p_codec the jpeg2000 codec. + * + * @return a pointer to a codestream information structure. + * + */ +OPJ_API opj_codestream_info_v2_t* OPJ_CALLCONV opj_get_cstr_info(opj_codec_t *p_codec); + +/** + * Get the codestream index from the codec + * + * @param p_codec the jpeg2000 codec. + * + * @return a pointer to a codestream index structure. + * + */ +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); + + +/** + * Get the JP2 file information from the codec FIXME + * + * @param p_codec the jpeg2000 codec. + * + * @return a pointer to a JP2 metadata structure. + * + */ +OPJ_API opj_jp2_metadata_t* OPJ_CALLCONV opj_get_jp2_metadata(opj_codec_t *p_codec); + +/** + * Get the JP2 file index from the codec FIXME + * + * @param p_codec the jpeg2000 codec. + * + * @return a pointer to a JP2 index structure. + * + */ +OPJ_API opj_jp2_index_t* OPJ_CALLCONV opj_get_jp2_index(opj_codec_t *p_codec); + + + + #ifdef __cplusplus }