622 lines
18 KiB
C
622 lines
18 KiB
C
/*
|
|
* Copyright (c) 2001-2003, David Janssens
|
|
* Copyright (c) 2002-2003, Yannick Verschueren
|
|
* Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
|
|
* Copyright (c) 2005, Hervé Drolon, FreeImage Team
|
|
* Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
|
|
* 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
|
|
|
|
#define OPENJPEG_VERSION "1.0.0"
|
|
|
|
#if defined(_WIN32) && !defined (OPJ_STATIC)
|
|
#ifdef OPJ_SHARED
|
|
#define OPJ_EXPORT __declspec(dllexport)
|
|
#else
|
|
#define OPJ_EXPORT __declspec(dllimport)
|
|
#endif
|
|
#else
|
|
#ifdef OPJ_STATIC
|
|
#define OPJ_EXPORT extern
|
|
#else
|
|
#define OPJ_EXPORT
|
|
#endif
|
|
#endif
|
|
|
|
/*
|
|
==========================================================
|
|
Compiler directives
|
|
==========================================================
|
|
*/
|
|
#ifndef __cplusplus
|
|
#if defined(HAVE_STDBOOL_H)
|
|
/*
|
|
The C language implementation does correctly provide the standard header
|
|
file "stdbool.h".
|
|
*/
|
|
#include <stdbool.h>
|
|
#else
|
|
/*
|
|
The C language implementation does not provide the standard header file
|
|
"stdbool.h" as required by ISO/IEC 9899:1999. Try to compensate for this
|
|
braindamage below.
|
|
*/
|
|
#if !defined(bool)
|
|
#define bool int
|
|
#endif
|
|
#if !defined(true)
|
|
#define true 1
|
|
#endif
|
|
#if !defined(false)
|
|
#define false 0
|
|
#endif
|
|
#endif
|
|
#endif /* __cplusplus */
|
|
|
|
/*
|
|
==========================================================
|
|
Useful constant definitions
|
|
==========================================================
|
|
*/
|
|
|
|
#ifndef MAX_PATH
|
|
#define MAX_PATH 260 /**< Maximum allowed size for filenames */
|
|
#endif /* MAX_PATH */
|
|
|
|
#define J2K_MAXRLVLS 33 /**< Number of maximum resolution level authorized */
|
|
#define J2K_MAXBANDS (3*J2K_MAXRLVLS-2) /**< Number of maximum sub-band linked to number of resolution level */
|
|
|
|
/*
|
|
==========================================================
|
|
enum definitions
|
|
==========================================================
|
|
*/
|
|
|
|
/** Progression order */
|
|
typedef enum PROG_ORDER {
|
|
PROG_UNKNOWN = -1, /**< place-holder */
|
|
LRCP = 0, /**< layer-resolution-component-precinct order */
|
|
RLCP = 1, /**< resolution-layer-component-precinct order */
|
|
RPCL = 2, /**< resolution-precinct-component-layer order */
|
|
PCRL = 3, /**< precinct-component-resolution-layer order */
|
|
CPRL = 4 /**< component-precinct-resolution-layer order */
|
|
} OPJ_PROG_ORDER;
|
|
|
|
/**
|
|
Supported image color spaces
|
|
*/
|
|
typedef enum COLOR_SPACE {
|
|
CLRSPC_UNKNOWN = -1, /**< place-holder */
|
|
CLRSPC_SRGB = 1, /**< sRGB */
|
|
CLRSPC_GRAY = 2, /**< grayscale */
|
|
CLRSPC_SYCC = 3 /**< YUV */
|
|
} OPJ_COLOR_SPACE;
|
|
|
|
/**
|
|
Supported codec
|
|
*/
|
|
typedef enum CODEC_FORMAT {
|
|
CODEC_UNKNOWN = -1, /**< place-holder */
|
|
CODEC_J2K = 0, /**< JPEG-2000 codestream : read/write */
|
|
CODEC_JPT = 1, /**< JPT-stream (JPEG 2000, JPIP) : read only */
|
|
CODEC_JP2 = 2 /**< JPEG-2000 file format : read/write */
|
|
} OPJ_CODEC_FORMAT;
|
|
|
|
/*
|
|
==========================================================
|
|
event manager typedef definitions
|
|
==========================================================
|
|
*/
|
|
|
|
/**
|
|
Callback function prototype for events
|
|
@param msg Event message
|
|
@param client_data
|
|
*/
|
|
typedef void (*opj_msg_callback) (const char *msg, void *client_data);
|
|
|
|
/**
|
|
Message handler object
|
|
used for
|
|
<ul>
|
|
<li>Error messages
|
|
<li>Warning messages
|
|
<li>Debugging messages
|
|
</ul>
|
|
*/
|
|
typedef struct opj_event_mgr {
|
|
/** Error message callback if available, NULL otherwise */
|
|
opj_msg_callback error_handler;
|
|
/** Warning message callback if available, NULL otherwise */
|
|
opj_msg_callback warning_handler;
|
|
/** Debug message callback if available, NULL otherwise */
|
|
opj_msg_callback info_handler;
|
|
} opj_event_mgr_t;
|
|
|
|
|
|
/*
|
|
==========================================================
|
|
codec typedef definitions
|
|
==========================================================
|
|
*/
|
|
|
|
/**
|
|
Progression order changes
|
|
*/
|
|
typedef struct opj_poc {
|
|
int resno0, compno0;
|
|
int layno1, resno1, compno1;
|
|
OPJ_PROG_ORDER prg;
|
|
int tile;
|
|
char progorder[4];
|
|
} opj_poc_t;
|
|
|
|
/**
|
|
Compression parameters
|
|
*/
|
|
typedef struct opj_cparameters {
|
|
/** size of tile: tile_size_on = false (not in argument) or = true (in argument) */
|
|
bool tile_size_on;
|
|
/** XTOsiz */
|
|
int cp_tx0;
|
|
/** YTOsiz */
|
|
int cp_ty0;
|
|
/** XTsiz */
|
|
int cp_tdx;
|
|
/** YTsiz */
|
|
int cp_tdy;
|
|
/** allocation by rate/distortion */
|
|
int cp_disto_alloc;
|
|
/** allocation by fixed layer */
|
|
int cp_fixed_alloc;
|
|
/** add fixed_quality */
|
|
int cp_fixed_quality;
|
|
/** fixed layer */
|
|
int *cp_matrice;
|
|
/** comment for coding */
|
|
char *cp_comment;
|
|
/** csty : coding style */
|
|
int csty;
|
|
/** progression order (default LRCP) */
|
|
OPJ_PROG_ORDER prog_order;
|
|
/** progression order changes */
|
|
opj_poc_t POC[32];
|
|
/** number of progression order changes (POC), default to 0 */
|
|
int numpocs;
|
|
/** number of layers */
|
|
int tcp_numlayers;
|
|
/** rates of layers */
|
|
int tcp_rates[100];
|
|
/** different psnr for successive layers */
|
|
float tcp_distoratio[100];
|
|
/** number of resolutions */
|
|
int numresolution;
|
|
/** initial code block width, default to 64 */
|
|
int cblockw_init;
|
|
/** initial code block height, default to 64 */
|
|
int cblockh_init;
|
|
/** mode switch (cblk_style) */
|
|
int mode;
|
|
/** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
|
|
int irreversible;
|
|
/** region of interest: affected component in [0..3], -1 means no ROI */
|
|
int roi_compno;
|
|
/** region of interest: upshift value */
|
|
int roi_shift;
|
|
/* number of precinct size specifications */
|
|
int res_spec;
|
|
/** initial precinct width */
|
|
int prcw_init[J2K_MAXRLVLS];
|
|
/** initial precinct height */
|
|
int prch_init[J2K_MAXRLVLS];
|
|
|
|
/**@name command line encoder parameters (not used inside the library) */
|
|
/*@{*/
|
|
/** input file name */
|
|
char infile[MAX_PATH];
|
|
/** output file name */
|
|
char outfile[MAX_PATH];
|
|
/** creation of an index file, default to 0 (false) */
|
|
int index_on;
|
|
/** index file name */
|
|
char index[MAX_PATH];
|
|
/** subimage encoding: origin image offset in x direction */
|
|
int image_offset_x0;
|
|
/** subimage encoding: origin image offset in y direction */
|
|
int image_offset_y0;
|
|
/** subsampling value for dx */
|
|
int subsampling_dx;
|
|
/** subsampling value for dy */
|
|
int subsampling_dy;
|
|
/** input file format 0: PGX, 1: PxM, 2: BMP */
|
|
int decod_format;
|
|
/** output file format 0: J2K, 1: JP2, 2: JPT */
|
|
int cod_format;
|
|
/*@}*/
|
|
} opj_cparameters_t;
|
|
|
|
/**
|
|
Decompression parameters
|
|
*/
|
|
typedef struct opj_dparameters {
|
|
/**
|
|
Set the number of highest resolution levels to be discarded.
|
|
The image resolution is effectively divided by 2 to the power of the number of discarded levels.
|
|
The reduce factor is limited by the smallest total number of decomposition levels among tiles.
|
|
if != 0, then original dimension divided by 2^(reduce);
|
|
if == 0 or not used, image is decoded to the full resolution
|
|
*/
|
|
int cp_reduce;
|
|
/**
|
|
Set the maximum number of quality layers to decode.
|
|
If there are less quality layers than the specified number, all the quality layers are decoded.
|
|
if != 0, then only the first "layer" layers are decoded;
|
|
if == 0 or not used, all the quality layers are decoded
|
|
*/
|
|
int cp_layer;
|
|
|
|
/**@name command line encoder parameters (not used inside the library) */
|
|
/*@{*/
|
|
/** input file name */
|
|
char infile[MAX_PATH];
|
|
/** output file name */
|
|
char outfile[MAX_PATH];
|
|
/** input file format 0: J2K, 1: JP2, 2: JPT */
|
|
int decod_format;
|
|
/** output file format 0: PGX, 1: PxM, 2: BMP */
|
|
int cod_format;
|
|
/*@}*/
|
|
} opj_dparameters_t;
|
|
|
|
/** Common fields between JPEG-2000 compression and decompression master structs. */
|
|
|
|
#define opj_common_fields \
|
|
opj_event_mgr_t *event_mgr; /**< pointer to the event manager */\
|
|
void * client_data; /**< Available for use by application */\
|
|
bool is_decompressor; /**< So common code can tell which is which */\
|
|
OPJ_CODEC_FORMAT codec_format; /**< selected codec */\
|
|
void *j2k_handle; /**< pointer to the J2K codec */\
|
|
void *jp2_handle /**< pointer to the JP2 codec */
|
|
|
|
/* Routines that are to be used by both halves of the library are declared
|
|
* to receive a pointer to this structure. There are no actual instances of
|
|
* opj_common_struct_t, only of opj_cinfo_t and opj_dinfo_t.
|
|
*/
|
|
typedef struct opj_common_struct {
|
|
opj_common_fields; /* Fields common to both master struct types */
|
|
/* Additional fields follow in an actual opj_cinfo_t or
|
|
* opj_dinfo_t. All three structs must agree on these
|
|
* initial fields! (This would be a lot cleaner in C++.)
|
|
*/
|
|
} opj_common_struct_t;
|
|
|
|
typedef opj_common_struct_t * opj_common_ptr;
|
|
|
|
/**
|
|
Compression context info
|
|
*/
|
|
typedef struct opj_cinfo {
|
|
/** Fields shared with opj_dinfo_t */
|
|
opj_common_fields;
|
|
/* other specific fields go here */
|
|
} opj_cinfo_t;
|
|
|
|
/**
|
|
Decompression context info
|
|
*/
|
|
typedef struct opj_dinfo {
|
|
/** Fields shared with opj_cinfo_t */
|
|
opj_common_fields;
|
|
/* other specific fields go here */
|
|
} opj_dinfo_t;
|
|
|
|
/*
|
|
==========================================================
|
|
I/O stream typedef definitions
|
|
==========================================================
|
|
*/
|
|
|
|
/*
|
|
* Stream open flags.
|
|
*/
|
|
/** The stream was opened for reading. */
|
|
#define OPJ_STREAM_READ 0x0001
|
|
/** The stream was opened for writing. */
|
|
#define OPJ_STREAM_WRITE 0x0002
|
|
|
|
/**
|
|
Byte input-output stream (CIO)
|
|
*/
|
|
typedef struct opj_cio {
|
|
/** codec context */
|
|
opj_common_ptr cinfo;
|
|
|
|
/** open mode (read/write) either OPJ_STREAM_READ or OPJ_STREAM_WRITE */
|
|
int openmode;
|
|
/** pointer to the start of the buffer */
|
|
unsigned char *buffer;
|
|
/** buffer size in bytes */
|
|
int length;
|
|
|
|
/** pointer to the start of the stream */
|
|
unsigned char *start;
|
|
/** pointer to the end of the stream */
|
|
unsigned char *end;
|
|
/** pointer to the current position */
|
|
unsigned char *bp;
|
|
} opj_cio_t;
|
|
|
|
/*
|
|
==========================================================
|
|
image typedef definitions
|
|
==========================================================
|
|
*/
|
|
|
|
/**
|
|
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;
|
|
/** 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;
|
|
/** image component data */
|
|
int *data;
|
|
} opj_image_comp_t;
|
|
|
|
/**
|
|
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 */
|
|
int x0;
|
|
/** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
|
|
int y0;
|
|
/** Xsiz: width of the reference grid */
|
|
int x1;
|
|
/** Ysiz: height of the reference grid */
|
|
int y1;
|
|
/** number of components in the image */
|
|
int numcomps;
|
|
/** color space: sRGB, Greyscale or YUV */
|
|
OPJ_COLOR_SPACE color_space;
|
|
/** image components */
|
|
opj_image_comp_t *comps;
|
|
} opj_image_t;
|
|
|
|
/**
|
|
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;
|
|
/** 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;
|
|
} opj_image_cmptparm_t;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
/*
|
|
==========================================================
|
|
openjpeg version
|
|
==========================================================
|
|
*/
|
|
|
|
const char * opj_version();
|
|
|
|
/*
|
|
==========================================================
|
|
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_EXPORT opj_image_t *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
|
|
*/
|
|
OPJ_EXPORT void opj_image_destroy(opj_image_t *image);
|
|
|
|
/*
|
|
==========================================================
|
|
stream functions definitions
|
|
==========================================================
|
|
*/
|
|
|
|
/**
|
|
Open and allocate a memory stream for read / write.
|
|
On reading, the user must provide a buffer containing encoded data. The buffer will be
|
|
wrapped by the returned CIO handle.
|
|
On writing, buffer parameters must be set to 0: a buffer will be allocated by the library
|
|
to contain encoded data.
|
|
@param cinfo Codec context info
|
|
@param buffer Reading: buffer address. Writing: NULL
|
|
@param length Reading: buffer length. Writing: 0
|
|
@return Returns a CIO handle if successful, returns NULL otherwise
|
|
*/
|
|
OPJ_EXPORT opj_cio_t* opj_cio_open(opj_common_ptr cinfo, unsigned char *buffer, int length);
|
|
|
|
/**
|
|
Close and free a CIO handle
|
|
@param cio CIO handle to free
|
|
*/
|
|
OPJ_EXPORT void opj_cio_close(opj_cio_t *cio);
|
|
|
|
/**
|
|
Get position in byte stream
|
|
@param cio CIO handle
|
|
@return Returns the position in bytes
|
|
*/
|
|
OPJ_EXPORT int cio_tell(opj_cio_t *cio);
|
|
/**
|
|
Set position in byte stream
|
|
@param cio CIO handle
|
|
@param pos Position, in number of bytes, from the beginning of the stream
|
|
*/
|
|
void cio_seek(opj_cio_t *cio, int pos);
|
|
|
|
/*
|
|
==========================================================
|
|
event manager functions definitions
|
|
==========================================================
|
|
*/
|
|
|
|
OPJ_EXPORT opj_event_mgr_t* opj_set_event_mgr(opj_common_ptr cinfo, opj_event_mgr_t *event_mgr, void *context);
|
|
|
|
/*
|
|
==========================================================
|
|
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_EXPORT opj_dinfo_t* opj_create_decompress(OPJ_CODEC_FORMAT format);
|
|
/**
|
|
Destroy a decompressor handle
|
|
@param dinfo decompressor handle to destroy
|
|
*/
|
|
OPJ_EXPORT void opj_destroy_decompress(opj_dinfo_t *dinfo);
|
|
/**
|
|
Set decoding parameters to default values
|
|
@param parameters Decompression parameters
|
|
*/
|
|
OPJ_EXPORT void 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_EXPORT void opj_setup_decoder(opj_dinfo_t *dinfo, opj_dparameters_t *parameters);
|
|
/**
|
|
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_EXPORT opj_image_t* opj_decode(opj_dinfo_t *dinfo, opj_cio_t *cio);
|
|
/**
|
|
Creates a J2K/JP2 compression structure
|
|
@param format Coder to select
|
|
@return Returns a handle to a compressor if successful, returns NULL otherwise
|
|
*/
|
|
OPJ_EXPORT opj_cinfo_t* opj_create_compress(OPJ_CODEC_FORMAT format);
|
|
/**
|
|
Destroy a compressor handle
|
|
@param cinfo compressor handle to destroy
|
|
*/
|
|
OPJ_EXPORT void opj_destroy_compress(opj_cinfo_t *cinfo);
|
|
/**
|
|
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_EXPORT void opj_set_default_encoder_parameters(opj_cparameters_t *parameters);
|
|
/**
|
|
Setup the encoder parameters using the current image and using user parameters.
|
|
@param cinfo compressor handle
|
|
@param parameters compression parameters
|
|
@param image input filled image
|
|
*/
|
|
OPJ_EXPORT void opj_setup_encoder(opj_cinfo_t *cinfo, opj_cparameters_t *parameters, opj_image_t *image);
|
|
/**
|
|
Encode an image into a JPEG-2000 codestream
|
|
@param cinfo compressor handle
|
|
@param cio Output buffer stream
|
|
@param image Image to encode
|
|
@param index Name of the index file if required, NULL otherwise
|
|
@return Returns true if successful, returns false otherwise
|
|
*/
|
|
OPJ_EXPORT bool opj_encode(opj_cinfo_t *cinfo, opj_cio_t *cio, opj_image_t *image, char *index);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* OPENJPEG_H */
|