/* * 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 <[email protected]> * 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 … #elif defined(__GNUC__) #define INLINE … #elif defined(__MWERKS__) #define INLINE … #else /* add other compilers here ... */ #define INLINE #endif /* defined(<Compiler>) */ #endif /* INLINE */ /* deprecated attribute */ #ifdef __GNUC__ #define OPJ_DEPRECATED(func) … #elif defined(_MSC_VER) #define OPJ_DEPRECATED … #else #pragma message("WARNING: You need to implement DEPRECATED for this compiler") #define OPJ_DEPRECATED … #endif #if defined(__GNUC__) && __GNUC__ >= 6 #define OPJ_DEPRECATED_STRUCT_MEMBER … #else #define OPJ_DEPRECATED_STRUCT_MEMBER(memb, msg) … #endif #if defined(OPJ_STATIC) || !defined(_WIN32) /* http://gcc.gnu.org/wiki/Visibility */ # if !defined(_WIN32) && __GNUC__ >= 4 # if defined(OPJ_STATIC) /* static library uses "hidden" */ #define OPJ_API … # else #define OPJ_API … # endif #define OPJ_LOCAL … # else #define OPJ_API #define OPJ_LOCAL # endif #define OPJ_CALLCONV #else #define OPJ_CALLCONV … /* 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 … # else #define OPJ_API … # endif /* OPJ_EXPORTS */ #endif /* !OPJ_STATIC || !_WIN32 */ OPJ_BOOL; #define OPJ_TRUE … #define OPJ_FALSE … OPJ_CHAR; OPJ_FLOAT32; OPJ_FLOAT64; OPJ_BYTE; #include <stdint.h> OPJ_INT8; OPJ_UINT8; OPJ_INT16; OPJ_UINT16; OPJ_INT32; OPJ_UINT32; OPJ_INT64; OPJ_UINT64; OPJ_OFF_T; /* 64-bit file offset type */ #include <stdio.h> OPJ_SIZE_T; #include "opj_config.h" /* Avoid compile-time warning because parameter is not used */ #define OPJ_ARG_NOT_USED(x) … /* ========================================================== Useful constant definitions ========================================================== */ #define OPJ_PATH_LEN … #define OPJ_J2K_MAXRLVLS … #define OPJ_J2K_MAXBANDS … #define OPJ_J2K_DEFAULT_NB_SEGS … #define OPJ_J2K_STREAM_CHUNK_SIZE … #define OPJ_J2K_DEFAULT_HEADER_SIZE … #define OPJ_J2K_MCC_DEFAULT_NB_RECORDS … #define OPJ_J2K_MCT_DEFAULT_NB_RECORDS … /* UniPG>> */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */ #define JPWL_MAX_NO_TILESPECS … #define JPWL_MAX_NO_PACKSPECS … #define JPWL_MAX_NO_MARKERS … #define JPWL_PRIVATEINDEX_NAME … #define JPWL_EXPECTED_COMPONENTS … #define JPWL_MAXIMUM_TILES … #define JPWL_MAXIMUM_HAMMING … #define JPWL_MAXIMUM_EPB_ROOM … /* <<UniPG */ /** * EXPERIMENTAL FOR THE MOMENT * Supported options about file information used only in j2k_dump */ #define OPJ_IMG_INFO … #define OPJ_J2K_MH_INFO … #define OPJ_J2K_TH_INFO … #define OPJ_J2K_TCH_INFO … #define OPJ_J2K_MH_IND … #define OPJ_J2K_TH_IND … /*FIXME #define OPJ_J2K_CSTR_IND 48*/ /**< */ #define OPJ_JP2_INFO … #define OPJ_JP2_IND … /** * JPEG 2000 Profiles, see Table A.10 from 15444-1 (updated in various AMD) * These values help choosing the RSIZ value for the J2K codestream. * The RSIZ value triggers various encoding options, as detailed in Table A.10. * If OPJ_PROFILE_PART2 is chosen, it has to be combined with one or more extensions * described hereunder. * Example: rsiz = OPJ_PROFILE_PART2 | OPJ_EXTENSION_MCT; * For broadcast profiles, the OPJ_PROFILE value has to be combined with the targeted * mainlevel (3-0 LSB, value between 0 and 11): * Example: rsiz = OPJ_PROFILE_BC_MULTI | 0x0005; (here mainlevel 5) * For IMF profiles, the OPJ_PROFILE value has to be combined with the targeted mainlevel * (3-0 LSB, value between 0 and 11) and sublevel (7-4 LSB, value between 0 and 9): * Example: rsiz = OPJ_PROFILE_IMF_2K | 0x0040 | 0x0005; (here main 5 and sublevel 4) * */ #define OPJ_PROFILE_NONE … #define OPJ_PROFILE_0 … #define OPJ_PROFILE_1 … #define OPJ_PROFILE_PART2 … #define OPJ_PROFILE_CINEMA_2K … #define OPJ_PROFILE_CINEMA_4K … #define OPJ_PROFILE_CINEMA_S2K … #define OPJ_PROFILE_CINEMA_S4K … #define OPJ_PROFILE_CINEMA_LTS … #define OPJ_PROFILE_BC_SINGLE … #define OPJ_PROFILE_BC_MULTI … #define OPJ_PROFILE_BC_MULTI_R … #define OPJ_PROFILE_IMF_2K … #define OPJ_PROFILE_IMF_4K … #define OPJ_PROFILE_IMF_8K … #define OPJ_PROFILE_IMF_2K_R … #define OPJ_PROFILE_IMF_4K_R … #define OPJ_PROFILE_IMF_8K_R … /** * JPEG 2000 Part-2 extensions * */ #define OPJ_EXTENSION_NONE … #define OPJ_EXTENSION_MCT … /** * JPEG 2000 profile macros * */ #define OPJ_IS_CINEMA(v) … #define OPJ_IS_STORAGE(v) … #define OPJ_IS_BROADCAST(v) … #define OPJ_IS_IMF(v) … #define OPJ_IS_PART2(v) … #define OPJ_GET_IMF_PROFILE(v) … #define OPJ_GET_IMF_MAINLEVEL(v) … #define OPJ_GET_IMF_SUBLEVEL(v) … #define OPJ_IMF_MAINLEVEL_MAX … /** Max. Components Sampling Rate (MSamples/sec) per IMF main level */ #define OPJ_IMF_MAINLEVEL_1_MSAMPLESEC … #define OPJ_IMF_MAINLEVEL_2_MSAMPLESEC … #define OPJ_IMF_MAINLEVEL_3_MSAMPLESEC … #define OPJ_IMF_MAINLEVEL_4_MSAMPLESEC … #define OPJ_IMF_MAINLEVEL_5_MSAMPLESEC … #define OPJ_IMF_MAINLEVEL_6_MSAMPLESEC … #define OPJ_IMF_MAINLEVEL_7_MSAMPLESEC … #define OPJ_IMF_MAINLEVEL_8_MSAMPLESEC … #define OPJ_IMF_MAINLEVEL_9_MSAMPLESEC … #define OPJ_IMF_MAINLEVEL_10_MSAMPLESEC … #define OPJ_IMF_MAINLEVEL_11_MSAMPLESEC … /** Max. compressed Bit Rate (Mbits/s) per IMF sub level */ #define OPJ_IMF_SUBLEVEL_1_MBITSSEC … #define OPJ_IMF_SUBLEVEL_2_MBITSSEC … #define OPJ_IMF_SUBLEVEL_3_MBITSSEC … #define OPJ_IMF_SUBLEVEL_4_MBITSSEC … #define OPJ_IMF_SUBLEVEL_5_MBITSSEC … #define OPJ_IMF_SUBLEVEL_6_MBITSSEC … #define OPJ_IMF_SUBLEVEL_7_MBITSSEC … #define OPJ_IMF_SUBLEVEL_8_MBITSSEC … #define OPJ_IMF_SUBLEVEL_9_MBITSSEC … /** * JPEG 2000 codestream and component size limits in cinema profiles * */ #define OPJ_CINEMA_24_CS … #define OPJ_CINEMA_48_CS … #define OPJ_CINEMA_24_COMP … #define OPJ_CINEMA_48_COMP … /* ========================================================== enum definitions ========================================================== */ /** * DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead * Rsiz Capabilities * */ OPJ_RSIZ_CAPABILITIES; /** * DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead * Digital cinema operation mode * */ OPJ_CINEMA_MODE; /** * Progression order * */ OPJ_PROG_ORDER; /** * Supported image color spaces */ OPJ_COLOR_SPACE; /** * Supported codec */ OPJ_CODEC_FORMAT; /* ========================================================== event manager typedef definitions ========================================================== */ /** * Callback function prototype for events * @param msg Event message * @param client_data Client object where will be return the event message * */ opj_msg_callback; /* ========================================================== codec typedef definitions ========================================================== */ #ifndef OPJ_UINT32_SEMANTICALLY_BUT_INT32 #define OPJ_UINT32_SEMANTICALLY_BUT_INT32 … #endif /** * Progression order changes * */ opj_poc_t; /** * Compression parameters * */ opj_cparameters_t; #define OPJ_DPARAMETERS_IGNORE_PCLR_CMAP_CDEF_FLAG … #define OPJ_DPARAMETERS_DUMP_FLAG … /** * Decompression parameters * */ opj_dparameters_t; /** * JPEG2000 codec V2. * */ opj_codec_t; /* ========================================================== I/O stream typedef definitions ========================================================== */ /** * Stream open flags. * */ /** The stream was opened for reading. */ #define OPJ_STREAM_READ … /** The stream was opened for writing. */ #define OPJ_STREAM_WRITE … /* * Callback function prototype for read function */ opj_stream_read_fn ; /* * Callback function prototype for write function */ opj_stream_write_fn ; /* * Callback function prototype for skip function */ opj_stream_skip_fn ; /* * Callback function prototype for seek function */ opj_stream_seek_fn ; /* * Callback function prototype for free user data function */ opj_stream_free_user_data_fn ; /* * JPEG2000 Stream. */ opj_stream_t; /* ========================================================== image typedef definitions ========================================================== */ /** * Defines a single image component * */ opj_image_comp_t; /** * Defines image data and characteristics * */ opj_image_t; /** * Component parameters structure used by the opj_image_create function * */ opj_image_cmptparm_t; /* ========================================================== Information on the JPEG 2000 codestream ========================================================== */ /* QUITE EXPERIMENTAL FOR THE MOMENT */ /** * Index structure : Information concerning a packet inside tile * */ opj_packet_info_t; /* UniPG>> */ /** * Marker structure * */ opj_marker_info_t; /* <<UniPG */ /** * Index structure : Information concerning tile-parts */ opj_tp_info_t; /** * Index structure : information regarding tiles */ opj_tile_info_t; /** * Index structure of the codestream */ opj_codestream_info_t; /* <----------------------------------------------------------- */ /* new output management of the codestream information and index */ /** * Tile-component coding parameters information */ opj_tccp_info_t; /** * Tile coding parameters information */ opj_tile_info_v2_t; /** * Information structure about the codestream (FIXME should be expand and enhance) */ opj_codestream_info_v2_t; /** * Index structure about a tile part */ opj_tp_index_t; /** * Index structure about a tile */ opj_tile_index_t; /** * Index structure of the codestream (FIXME should be expand and enhance) */ opj_codestream_index_t; /* -----------------------------------------------------------> */ /* ========================================================== Metadata from the JP2file ========================================================== */ /** * Info structure of the JP2 file * EXPERIMENTAL FOR THE MOMENT */ opj_jp2_metadata_t; /** * Index structure of the JP2 file * EXPERIMENTAL FOR THE MOMENT */ 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 ========================================================== */ /** * 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(OPJ_UINT32 numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc); /** * 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); /** * Creates an image without allocating memory for the image (used in the new version of the library). * * @param numcmpts the number of components * @param cmptparms the components parameters * @param clrspc the image color space * * @return a new image structure if successful, NULL otherwise. */ OPJ_API opj_image_t* OPJ_CALLCONV opj_image_tile_create(OPJ_UINT32 numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc); /** * Allocator for opj_image_t->comps[].data * To be paired with opj_image_data_free. * * @param size number of bytes to allocate * * @return a new pointer if successful, NULL otherwise. * @since 2.2.0 */ OPJ_API void* OPJ_CALLCONV opj_image_data_alloc(OPJ_SIZE_T size); /** * Destructor for opj_image_t->comps[].data * To be paired with opj_image_data_alloc. * * @param ptr Pointer to free * * @since 2.2.0 */ OPJ_API void OPJ_CALLCONV opj_image_data_free(void* ptr); /* ========================================================== stream functions definitions ========================================================== */ /** * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream. * * @param p_is_input if set to true then the stream will be an input stream, an output stream else. * * @return a stream object. */ OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_default_create( OPJ_BOOL p_is_input); /** * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream. * * @param p_buffer_size FIXME DOC * @param p_is_input if set to true then the stream will be an input stream, an output stream else. * * @return a stream object. */ 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 * close its own implementation of the stream. * * @param p_stream the stream to destroy. */ OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream); /** * Sets the given function to be used as a read function. * @param p_stream the stream to modify * @param p_function the function to use a read function. */ OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream, opj_stream_read_fn p_function); /** * Sets the given function to be used as a write function. * @param p_stream the stream to modify * @param p_function the function to use a write function. */ OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream, opj_stream_write_fn p_function); /** * Sets the given function to be used as a skip function. * @param p_stream the stream to modify * @param p_function the function to use a skip function. */ OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream, opj_stream_skip_fn p_function); /** * Sets the given function to be used as a seek function, the stream is then seekable, * using SEEK_SET behavior. * @param p_stream the stream to modify * @param p_function the function to use a skip function. */ OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream, opj_stream_seek_fn p_function); /** * Sets the given data to be used as a user data for the stream. * @param p_stream the stream to modify * @param p_data the data to set. * @param p_function the function to free p_data when opj_stream_destroy() is called. */ 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); /** * 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); /** * Create a stream from a file identified with its filename with default parameters (helper function) * @param fname the filename of the file to stream * @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( const char *fname, OPJ_BOOL p_is_read_stream); /** Create a stream from a file identified with its filename with a specific buffer size * @param fname the filename of the file to stream * @param p_buffer_size size of the chunk used to stream * @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_file_stream( const char *fname, OPJ_SIZE_T p_buffer_size, OPJ_BOOL p_is_read_stream); /* ========================================================== event manager functions definitions ========================================================== */ /** * Set the info handler use by openjpeg. * @param p_codec the codec previously initialise * @param p_callback the callback function which will be used * @param p_user_data client object where will be returned the message */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_info_handler(opj_codec_t * p_codec, opj_msg_callback p_callback, void * p_user_data); /** * Set the warning handler use by openjpeg. * @param p_codec the codec previously initialise * @param p_callback the callback function which will be used * @param p_user_data client object where will be returned the message */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_warning_handler(opj_codec_t * p_codec, opj_msg_callback p_callback, void * p_user_data); /** * Set the error handler use by openjpeg. * @param p_codec the codec previously initialise * @param p_callback the callback function which will be used * @param p_user_data client object where will be returned the message */ 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 ========================================================== */ /** * 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( OPJ_CODEC_FORMAT format); /** * Destroy a decompressor handle * * @param p_codec decompressor handle to destroy */ OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec); /** * Read after the codestream if necessary * @param p_codec the JPEG2000 codec to read. * @param p_stream the JPEG2000 stream. */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_decompress(opj_codec_t *p_codec, opj_stream_t *p_stream); /** * 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 with decompression parameters provided by the user and with the message handler * provided by the user. * * @param p_codec decompressor handler * @param parameters decompression parameters * * @return true if the decoder is correctly set */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_decoder(opj_codec_t *p_codec, opj_dparameters_t *parameters); /** * Set strict decoding parameter for this decoder. If strict decoding is enabled, partial bit * streams will fail to decode. If strict decoding is disabled, the decoder will decode partial * bitstreams as much as possible without erroring * * @param p_codec decompressor handler * @param strict OPJ_TRUE to enable strict decoding, OPJ_FALSE to disable * * @return true if the decoder is correctly set */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decoder_set_strict_mode(opj_codec_t *p_codec, OPJ_BOOL strict); /** * Allocates worker threads for the compressor/decompressor. * * By default, only the main thread is used. If this function is not used, * but the OPJ_NUM_THREADS environment variable is set, its value will be * used to initialize the number of threads. The value can be either an integer * number, or "ALL_CPUS". If OPJ_NUM_THREADS is set and this function is called, * this function will override the behaviour of the environment variable. * * This function must be called after opj_setup_decoder() and * before opj_read_header() for the decoding side, or after opj_setup_encoder() * and before opj_start_compress() for the encoding side. * * @param p_codec decompressor or compressor handler * @param num_threads number of threads. * * @return OPJ_TRUE if the function is successful. */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_codec_set_threads(opj_codec_t *p_codec, int num_threads); /** * Decodes an image header. * * @param p_stream 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_stream, opj_codec_t *p_codec, opj_image_t **p_image); /** Restrict the number of components to decode. * * This function should be called after opj_read_header(). * * This function enables to restrict the set of decoded components to the * specified indices. * Note that the current implementation (apply_color_transforms == OPJ_FALSE) * is such that neither the multi-component transform at codestream level, * nor JP2 channel transformations will be applied. * Consequently the indices are relative to the codestream. * * Note: opj_decode_tile_data() should not be used together with opj_set_decoded_components(). * * @param p_codec the jpeg2000 codec to read. * @param numcomps Size of the comps_indices array. * @param comps_indices Array of numcomps values representing the indices * of the components to decode (relative to the * codestream, starting at 0) * @param apply_color_transforms Whether multi-component transform at codestream level * or JP2 channel transformations should be applied. * Currently this parameter should be set to OPJ_FALSE. * Setting it to OPJ_TRUE will result in an error. * * @return OPJ_TRUE in case of success. */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decoded_components(opj_codec_t *p_codec, OPJ_UINT32 numcomps, const OPJ_UINT32* comps_indices, OPJ_BOOL apply_color_transforms); /** * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading. * * The coordinates passed to this function should be expressed in the reference grid, * that is to say at the highest resolution level, even if requesting the image at lower * resolution levels. * * Generally opj_set_decode_area() should be followed by opj_decode(), and the * codec cannot be re-used. * In the particular case of an image made of a single tile, several sequences of * calls to opoj_set_decode_area() and opj_decode() are allowed, and will bring * performance improvements when reading an image by chunks. * * @param p_codec the jpeg2000 codec. * @param p_image the decoded image previously set by opj_read_header * @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 p_decompressor decompressor handle * @param p_stream Input buffer stream * @param p_image the decoded image * @return true if success, otherwise false * */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_decode(opj_codec_t *p_decompressor, opj_stream_t *p_stream, opj_image_t *p_image); /** * Get the decoded tile from the codec * * @param p_codec the jpeg2000 codec. * @param p_stream input stream * @param p_image output image * @param tile_index index of the tile which will be decode * * @return true if success, otherwise false */ 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); /** * Set the resolution factor of the decoded image * @param p_codec the jpeg2000 codec. * @param res_factor resolution factor to set * * @return true if success, otherwise false */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decoded_resolution_factor( opj_codec_t *p_codec, OPJ_UINT32 res_factor); /** * Writes a tile with the given data. * * @param p_codec the jpeg2000 codec. * @param p_tile_index the index of the tile to write. At the moment, the tiles must be written from 0 to n-1 in sequence. * @param p_data pointer to the data to write. Data is arranged in sequence, data_comp0, then data_comp1, then ... NO INTERLEAVING should be set. * @param p_data_size this value os used to make sure the data being written is correct. The size must be equal to the sum for each component of * tile_width * tile_height * component_size. component_size can be 1,2 or 4 bytes, depending on the precision of the given component. * @param p_stream the stream to write data to. * * @return true if the data could be written. */ 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); /** * Reads a tile header. This function is compulsory and allows one to know the size of the tile that 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. * * Note: opj_decode_tile_data() should not be used together with opj_set_decoded_components(). * * @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); /* COMPRESSION FUNCTIONS*/ /** * Creates a J2K/JP2 compression structure * @param format Coder to select * @return Returns a handle to a compressor if successful, returns NULL otherwise */ OPJ_API opj_codec_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format); /** Set encoding parameters to default values, that means : <ul> <li>Lossless <li>1 tile <li>Size of precinct : 2^15 x 2^15 (means 1 precinct) <li>Size of code-block : 64 x 64 <li>Number of resolutions: 6 <li>No SOP marker in the codestream <li>No EPH marker in the codestream <li>No sub-sampling in x or y direction <li>No mode switch activated <li>Progression order: LRCP <li>No index file <li>No ROI upshifted <li>No offset of the origin of the image <li>No offset of the origin of the tiles <li>Reversible DWT 5-3 </ul> @param parameters Compression parameters */ OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters( opj_cparameters_t *parameters); /** * Setup the encoder parameters using the current image and using user parameters. * @param p_codec Compressor handle * @param parameters Compression parameters * @param image Input filled image */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_encoder(opj_codec_t *p_codec, opj_cparameters_t *parameters, opj_image_t *image); /** * Specify extra options for the encoder. * * This may be called after opj_setup_encoder() and before opj_start_compress() * * This is the way to add new options in a fully ABI compatible way, without * extending the opj_cparameters_t structure. * * Currently supported options are: * <ul> * <li>PLT=YES/NO. Defaults to NO. If set to YES, PLT marker segments, * indicating the length of each packet in the tile-part header, will be * written. Since 2.4.0</li> * <li>TLM=YES/NO. Defaults to NO (except for Cinema and IMF profiles). * If set to YES, TLM marker segments, indicating the length of each * tile-part part will be written. Since 2.4.0</li> * <li>GUARD_BITS=value. Number of guard bits in [0,7] range. Default value is 2. * 1 may be used sometimes (like in SMPTE DCP Bv2.1 Application Profile for 2K images). * Since 2.5.0</li> * </ul> * * @param p_codec Compressor handle * @param p_options Compression options. This should be a NULL terminated * array of strings. Each string is of the form KEY=VALUE. * * @return OPJ_TRUE in case of success. * @since 2.4.0 */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_encoder_set_extra_options( opj_codec_t *p_codec, const char* const* p_options); /** * Start to compress the current image. * @param p_codec Compressor handle * @param p_image Input filled image * @param p_stream Input stgream */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_start_compress(opj_codec_t *p_codec, opj_image_t * p_image, opj_stream_t *p_stream); /** * End to compress the current image. * @param p_codec Compressor handle * @param p_stream Input stgream */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_end_compress(opj_codec_t *p_codec, opj_stream_t *p_stream); /** * Encode an image into a JPEG-2000 codestream * @param p_codec compressor handle * @param p_stream Output buffer stream * * @return Returns true if successful, returns false otherwise */ 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*/ /** 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_v2_t **cstr_info); /** * Dump the codec information into the output stream * * @param p_codec the jpeg2000 codec. * @param info_flag type of information dump. * @param output_stream output stream where dump the information gotten from the codec. * */ 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); /* ========================================================== MCT functions ========================================================== */ /** * Sets the MCT matrix to use. * * @param parameters the parameters to change. * @param pEncodingMatrix the encoding matrix. * @param p_dc_shift the dc shift coefficients to use. * @param pNbComp the number of components of the image. * * @return true if the parameters could be set. */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_MCT(opj_cparameters_t *parameters, OPJ_FLOAT32 * pEncodingMatrix, OPJ_INT32 * p_dc_shift, OPJ_UINT32 pNbComp); /* ========================================================== Thread functions ========================================================== */ /** Returns if the library is built with thread support. * OPJ_TRUE if mutex, condition, thread, thread pool are available. */ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_has_thread_support(void); /** Return the number of virtual CPUs */ OPJ_API int OPJ_CALLCONV opj_get_num_cpus(void); #ifdef __cplusplus } #endif #endif /* OPENJPEG_H */
Codebase Browser
chromium