2 * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
3 * Copyright (c) 2002-2007, Professor Benoit Macq
4 * Copyright (c) 2001-2003, David Janssens
5 * Copyright (c) 2002-2003, Yannick Verschueren
6 * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
7 * Copyright (c) 2005, Herve Drolon, FreeImage Team
8 * Copyright (c) 2006-2007, Parvatha Elangovan
9 * Copyright (c) 2010-2011, Kaori Hagihara
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
38 ==========================================================
40 ==========================================================
43 #if defined(OPJ_STATIC) || !defined(_WIN32)
47 #define OPJ_CALLCONV __stdcall
49 The following ifdef block is the standard way of creating macros which make exporting
50 from a DLL simpler. All files within this DLL are compiled with the OPJ_EXPORTS
51 symbol defined on the command line. this symbol should not be defined on any project
52 that uses this DLL. This way any other project whose source files include this file see
53 OPJ_API functions as being imported from a DLL, wheras this DLL sees symbols
54 defined with this macro as being exported.
56 #if defined(OPJ_EXPORTS) || defined(DLL_EXPORT)
57 #define OPJ_API __declspec(dllexport)
59 #define OPJ_API __declspec(dllimport)
60 #endif /* OPJ_EXPORTS */
61 #endif /* !OPJ_STATIC || !_WIN32 */
67 /* Avoid compile-time warning because parameter is not used */
68 #define OPJ_ARG_NOT_USED(x) (void)(x)
70 ==========================================================
71 Useful constant definitions
72 ==========================================================
75 #define OPJ_PATH_LEN 4096 /**< Maximum allowed size for filenames */
77 #define J2K_MAXRLVLS 33 /**< Number of maximum resolution level authorized */
78 #define J2K_MAXBANDS (3*J2K_MAXRLVLS-2) /**< Number of maximum sub-band linked to number of resolution level */
81 #define JPWL_MAX_NO_TILESPECS 16 /**< Maximum number of tile parts expected by JPWL: increase at your will */
82 #define JPWL_MAX_NO_PACKSPECS 16 /**< Maximum number of packet parts expected by JPWL: increase at your will */
83 #define JPWL_MAX_NO_MARKERS 512 /**< Maximum number of JPWL markers: increase at your will */
84 #define JPWL_PRIVATEINDEX_NAME "jpwl_index_privatefilename" /**< index file name used when JPWL is on */
85 #define JPWL_EXPECTED_COMPONENTS 3 /**< Expect this number of components, so you'll find better the first EPB */
86 #define JPWL_MAXIMUM_TILES 8192 /**< Expect this maximum number of tiles, to avoid some crashes */
87 #define JPWL_MAXIMUM_HAMMING 2 /**< Expect this maximum number of bit errors in marker id's */
88 #define JPWL_MAXIMUM_EPB_ROOM 65450 /**< Expect this maximum number of bytes for composition of EPBs */
92 ==========================================================
94 ==========================================================
99 typedef enum RSIZ_CAPABILITIES {
100 STD_RSIZ = 0, /** Standard JPEG2000 profile*/
101 CINEMA2K = 3, /** Profile name for a 2K image*/
102 CINEMA4K = 4 /** Profile name for a 4K image*/
103 } OPJ_RSIZ_CAPABILITIES;
106 Digital cinema operation mode
108 typedef enum CINEMA_MODE {
109 OFF = 0, /** Not Digital Cinema*/
110 CINEMA2K_24 = 1, /** 2K Digital Cinema at 24 fps*/
111 CINEMA2K_48 = 2, /** 2K Digital Cinema at 48 fps*/
112 CINEMA4K_24 = 3 /** 4K Digital Cinema at 24 fps*/
118 typedef enum PROG_ORDER {
119 PROG_UNKNOWN = -1, /**< place-holder */
120 LRCP = 0, /**< layer-resolution-component-precinct order */
121 RLCP = 1, /**< resolution-layer-component-precinct order */
122 RPCL = 2, /**< resolution-precinct-component-layer order */
123 PCRL = 3, /**< precinct-component-resolution-layer order */
124 CPRL = 4 /**< component-precinct-resolution-layer order */
128 Supported image color spaces
130 typedef enum COLOR_SPACE {
131 CLRSPC_UNKNOWN = -1, /**< not supported by the library */
132 CLRSPC_UNSPECIFIED = 0, /**< not specified in the codestream */
133 CLRSPC_SRGB = 1, /**< sRGB */
134 CLRSPC_GRAY = 2, /**< grayscale */
135 CLRSPC_SYCC = 3 /**< YUV */
138 #define ENUMCS_SRGB 16
139 #define ENUMCS_GRAY 17
140 #define ENUMCS_SYCC 18
145 typedef enum CODEC_FORMAT {
146 CODEC_UNKNOWN = -1, /**< place-holder */
147 CODEC_J2K = 0, /**< JPEG-2000 codestream : read/write */
148 CODEC_JPT = 1, /**< JPT-stream (JPEG 2000, JPIP) : read only */
149 CODEC_JP2 = 2 /**< JPEG-2000 file format : read/write */
153 Limit decoding to certain portions of the codestream.
155 typedef enum LIMIT_DECODING {
156 NO_LIMITATION = 0, /**< No limitation for the decoding. The entire codestream will de decoded */
157 LIMIT_TO_MAIN_HEADER = 1, /**< The decoding is limited to the Main Header */
158 DECODE_ALL_BUT_PACKETS = 2 /**< Decode everything except the JPEG 2000 packets */
159 } OPJ_LIMIT_DECODING;
162 ==========================================================
163 event manager typedef definitions
164 ==========================================================
168 Callback function prototype for events
169 @param msg Event message
172 typedef void (*opj_msg_callback) (const char *msg, void *client_data);
175 Message handler object
180 <li>Debugging messages
183 typedef struct opj_event_mgr {
184 /** Error message callback if available, NULL otherwise */
185 opj_msg_callback error_handler;
186 /** Warning message callback if available, NULL otherwise */
187 opj_msg_callback warning_handler;
188 /** Debug message callback if available, NULL otherwise */
189 opj_msg_callback info_handler;
194 ==========================================================
195 codec typedef definitions
196 ==========================================================
200 Progression order changes
202 typedef struct opj_poc {
203 /** Resolution num start, Component num start, given by POC */
205 /** Layer num end,Resolution num end, Component num end, given by POC */
206 int layno1, resno1, compno1;
207 /** Layer num start,Precinct num start, Precinct num end */
208 int layno0, precno0, precno1;
209 /** Progression order enum*/
210 OPJ_PROG_ORDER prg1,prg;
211 /** Progression order string*/
215 /** Start and end values for Tile width and height*/
217 /** Start value, initialised in pi_initialise_encode*/
218 int layS, resS, compS, prcS;
219 /** End value, initialised in pi_initialise_encode */
220 int layE, resE, compE, prcE;
221 /** Start and end values of Tile width and height, initialised in pi_initialise_encode*/
222 int txS,txE,tyS,tyE,dx,dy;
223 /** Temporary values for Tile parts, initialised in pi_create_encode */
224 int lay_t, res_t, comp_t, prc_t,tx0_t,ty0_t;
228 Compression parameters
230 typedef struct opj_cparameters {
231 /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */
232 opj_bool tile_size_on;
241 /** allocation by rate/distortion */
243 /** allocation by fixed layer */
245 /** add fixed_quality */
246 int cp_fixed_quality;
249 /** comment for coding */
251 /** csty : coding style */
253 /** progression order (default LRCP) */
254 OPJ_PROG_ORDER prog_order;
255 /** progression order changes */
257 /** number of progression order changes (POC), default to 0 */
259 /** number of layers */
261 /** rates of layers */
262 float tcp_rates[100];
263 /** different psnr for successive layers */
264 float tcp_distoratio[100];
265 /** number of resolutions */
267 /** initial code block width, default to 64 */
269 /** initial code block height, default to 64 */
271 /** mode switch (cblk_style) */
273 /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
275 /** region of interest: affected component in [0..3], -1 means no ROI */
277 /** region of interest: upshift value */
279 /* number of precinct size specifications */
281 /** initial precinct width */
282 int prcw_init[J2K_MAXRLVLS];
283 /** initial precinct height */
284 int prch_init[J2K_MAXRLVLS];
286 /**@name command line encoder parameters (not used inside the library) */
288 /** input file name */
289 char infile[OPJ_PATH_LEN];
290 /** output file name */
291 char outfile[OPJ_PATH_LEN];
292 /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
294 /** DEPRECATED. Index generation is now handeld with the opj_encode_with_info() function. Set to NULL */
295 char index[OPJ_PATH_LEN];
296 /** subimage encoding: origin image offset in x direction */
298 /** subimage encoding: origin image offset in y direction */
300 /** subsampling value for dx */
302 /** subsampling value for dy */
304 /** input file format 0: PGX, 1: PxM, 2: BMP 3:TIF*/
306 /** output file format 0: J2K, 1: JP2, 2: JPT */
311 /**@name JPWL encoding parameters */
313 /** enables writing of EPC in MH, thus activating JPWL */
314 opj_bool jpwl_epc_on;
315 /** error protection method for MH (0,1,16,32,37-128) */
317 /** tile number of header protection specification (>=0) */
318 int jpwl_hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
319 /** error protection methods for TPHs (0,1,16,32,37-128) */
320 int jpwl_hprot_TPH[JPWL_MAX_NO_TILESPECS];
321 /** tile number of packet protection specification (>=0) */
322 int jpwl_pprot_tileno[JPWL_MAX_NO_PACKSPECS];
323 /** packet number of packet protection specification (>=0) */
324 int jpwl_pprot_packno[JPWL_MAX_NO_PACKSPECS];
325 /** error protection methods for packets (0,1,16,32,37-128) */
326 int jpwl_pprot[JPWL_MAX_NO_PACKSPECS];
327 /** enables writing of ESD, (0=no/1/2 bytes) */
329 /** sensitivity addressing size (0=auto/2/4 bytes) */
331 /** sensitivity range (0-3) */
333 /** sensitivity method for MH (-1=no,0-7) */
335 /** tile number of sensitivity specification (>=0) */
336 int jpwl_sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
337 /** sensitivity methods for TPHs (-1=no,0-7) */
338 int jpwl_sens_TPH[JPWL_MAX_NO_TILESPECS];
342 /** Digital Cinema compliance 0-not compliant, 1-compliant*/
343 OPJ_CINEMA_MODE cp_cinema;
344 /** Maximum rate for each component. If == 0, component size limitation is not considered */
347 OPJ_RSIZ_CAPABILITIES cp_rsiz;
348 /** Tile part generation*/
350 /** Flag for Tile part generation*/
352 /** MCT (multiple component transform) */
354 /** Enable JPIP indexing*/
358 #define OPJ_DPARAMETERS_IGNORE_PCLR_CMAP_CDEF_FLAG 0x0001
361 Decompression parameters
363 typedef struct opj_dparameters {
365 Set the number of highest resolution levels to be discarded.
366 The image resolution is effectively divided by 2 to the power of the number of discarded levels.
367 The reduce factor is limited by the smallest total number of decomposition levels among tiles.
368 if != 0, then original dimension divided by 2^(reduce);
369 if == 0 or not used, image is decoded to the full resolution
373 Set the maximum number of quality layers to decode.
374 If there are less quality layers than the specified number, all the quality layers are decoded.
375 if != 0, then only the first "layer" layers are decoded;
376 if == 0 or not used, all the quality layers are decoded
380 /**@name command line encoder parameters (not used inside the library) */
382 /** input file name */
383 char infile[OPJ_PATH_LEN];
384 /** output file name */
385 char outfile[OPJ_PATH_LEN];
386 /** input file format 0: J2K, 1: JP2, 2: JPT */
388 /** output file format 0: PGX, 1: PxM, 2: BMP */
393 /**@name JPWL decoding parameters */
395 /** activates the JPWL correction capabilities */
396 opj_bool jpwl_correct;
397 /** expected number of components */
399 /** maximum number of tiles */
405 Specify whether the decoding should be done on the entire codestream, or be limited to the main header
406 Limiting the decoding to the main header makes it possible to extract the characteristics of the codestream
407 if == NO_LIMITATION, the entire codestream is decoded;
408 if == LIMIT_TO_MAIN_HEADER, only the main header is decoded;
410 OPJ_LIMIT_DECODING cp_limit_decoding;
415 /** Common fields between JPEG-2000 compression and decompression master structs. */
417 #define opj_common_fields \
418 opj_event_mgr_t *event_mgr; /**< pointer to the event manager */\
419 void * client_data; /**< Available for use by application */\
420 opj_bool is_decompressor; /**< So common code can tell which is which */\
421 OPJ_CODEC_FORMAT codec_format; /**< selected codec */\
422 void *j2k_handle; /**< pointer to the J2K codec */\
423 void *jp2_handle; /**< pointer to the JP2 codec */\
424 void *mj2_handle /**< pointer to the MJ2 codec */
426 /* Routines that are to be used by both halves of the library are declared
427 * to receive a pointer to this structure. There are no actual instances of
428 * opj_common_struct_t, only of opj_cinfo_t and opj_dinfo_t.
430 typedef struct opj_common_struct {
431 opj_common_fields; /* Fields common to both master struct types */
432 /* Additional fields follow in an actual opj_cinfo_t or
433 * opj_dinfo_t. All three structs must agree on these
434 * initial fields! (This would be a lot cleaner in C++.)
436 } opj_common_struct_t;
438 typedef opj_common_struct_t * opj_common_ptr;
441 Compression context info
443 typedef struct opj_cinfo {
444 /** Fields shared with opj_dinfo_t */
446 /* other specific fields go here */
450 Decompression context info
452 typedef struct opj_dinfo {
453 /** Fields shared with opj_cinfo_t */
455 /* other specific fields go here */
459 ==========================================================
460 I/O stream typedef definitions
461 ==========================================================
467 /** The stream was opened for reading. */
468 #define OPJ_STREAM_READ 0x0001
469 /** The stream was opened for writing. */
470 #define OPJ_STREAM_WRITE 0x0002
473 Byte input-output stream (CIO)
475 typedef struct opj_cio {
477 opj_common_ptr cinfo;
479 /** open mode (read/write) either OPJ_STREAM_READ or OPJ_STREAM_WRITE */
481 /** pointer to the start of the buffer */
482 unsigned char *buffer;
483 /** buffer size in bytes */
486 /** pointer to the start of the stream */
487 unsigned char *start;
488 /** pointer to the end of the stream */
490 /** pointer to the current position */
495 ==========================================================
496 image typedef definitions
497 ==========================================================
501 Defines a single image component
503 typedef struct opj_image_comp {
504 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
506 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
512 /** x component offset compared to the whole image */
514 /** y component offset compared to the whole image */
518 /** image depth in bits */
520 /** signed (1) / unsigned (0) */
522 /** number of decoded resolution */
524 /** number of division by 2 of the out image compared to the original size of image */
526 /** image component data */
531 Defines image data and characteristics
533 typedef struct opj_image {
534 /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
536 /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
538 /** Xsiz: width of the reference grid */
540 /** Ysiz: height of the reference grid */
542 /** number of components in the image */
544 /** color space: sRGB, Greyscale or YUV */
545 OPJ_COLOR_SPACE color_space;
546 /** image components */
547 opj_image_comp_t *comps;
548 /** 'restricted' ICC profile */
549 unsigned char *icc_profile_buf;
550 /** size of ICC profile */
555 Component parameters structure used by the opj_image_create function
557 typedef struct opj_image_comptparm {
558 /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
560 /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
566 /** x component offset compared to the whole image */
568 /** y component offset compared to the whole image */
572 /** image depth in bits */
574 /** signed (1) / unsigned (0) */
576 } opj_image_cmptparm_t;
579 ==========================================================
580 Information on the JPEG 2000 codestream
581 ==========================================================
585 Index structure : Information concerning a packet inside tile
587 typedef struct opj_packet_info {
588 /** packet start position (including SOP marker if it exists) */
590 /** end of packet header position (including EPH marker if it exists)*/
592 /** packet end position */
594 /** packet distorsion */
603 typedef struct opj_marker_info_t {
605 unsigned short int type;
606 /** position in codestream */
608 /** length, marker val included */
614 Index structure : Information concerning tile-parts
616 typedef struct opj_tp_info {
617 /** start position of tile part */
619 /** end position of tile part header */
621 /** end position of tile part */
623 /** start packet of tile part */
625 /** number of packets of tile part */
630 Index structure : information regarding tiles
632 typedef struct opj_tile_info {
633 /** value of thresh for each layer by tile cfr. Marcela */
635 /** number of tile */
637 /** start position */
639 /** end position of the header */
643 /** precinct number for each resolution level (width) */
645 /** precinct number for each resolution level (height) */
647 /** precinct size (in power of 2), in X for each resolution level */
649 /** precinct size (in power of 2), in Y for each resolution level */
651 /** information concerning packets inside tile */
652 opj_packet_info_t *packet;
653 /** add fixed_quality */
655 /** add fixed_quality */
657 /** number of markers */
659 /** list of markers */
660 opj_marker_info_t *marker;
661 /** actual size of markers array */
663 /** number of tile parts */
665 /** information concerning tile parts */
670 Index structure of the codestream
672 typedef struct opj_codestream_info {
673 /** maximum distortion reduction on the whole image (add for Marcela) */
677 /** writing the packet in the index with t2_encode_packets */
683 /** progression order */
685 /** tile size in x */
687 /** tile size in y */
693 /** number of tiles in X */
695 /** number of tiles in Y */
697 /** component numbers */
699 /** number of layer */
701 /** number of decomposition for each component */
704 /** number of markers */
706 /** list of markers */
707 opj_marker_info_t *marker;
708 /** actual size of markers array */
711 /** main header position */
713 /** main header position */
715 /** codestream's size */
717 /** information regarding tiles inside image */
718 opj_tile_info_t *tile;
719 } opj_codestream_info_t;
727 ==========================================================
729 ==========================================================
732 OPJ_API const char * OPJ_CALLCONV opj_version(void);
735 ==========================================================
736 image functions definitions
737 ==========================================================
742 @param numcmpts number of components
743 @param cmptparms components parameters
744 @param clrspc image color space
745 @return returns a new image structure if successful, returns NULL otherwise
747 OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(int numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
750 Deallocate any resources associated with an image
751 @param image image to be destroyed
753 OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
756 ==========================================================
757 stream functions definitions
758 ==========================================================
762 Open and allocate a memory stream for read / write.
763 On reading, the user must provide a buffer containing encoded data. The buffer will be
764 wrapped by the returned CIO handle.
765 On writing, buffer parameters must be set to 0: a buffer will be allocated by the library
766 to contain encoded data.
767 @param cinfo Codec context info
768 @param buffer Reading: buffer address. Writing: NULL
769 @param length Reading: buffer length. Writing: 0
770 @return Returns a CIO handle if successful, returns NULL otherwise
772 OPJ_API opj_cio_t* OPJ_CALLCONV opj_cio_open(opj_common_ptr cinfo, unsigned char *buffer, int length);
775 Close and free a CIO handle
776 @param cio CIO handle to free
778 OPJ_API void OPJ_CALLCONV opj_cio_close(opj_cio_t *cio);
781 Get position in byte stream
782 @param cio CIO handle
783 @return Returns the position in bytes
785 OPJ_API int OPJ_CALLCONV cio_tell(opj_cio_t *cio);
787 Set position in byte stream
788 @param cio CIO handle
789 @param pos Position, in number of bytes, from the beginning of the stream
791 OPJ_API void OPJ_CALLCONV cio_seek(opj_cio_t *cio, int pos);
794 ==========================================================
795 event manager functions definitions
796 ==========================================================
799 OPJ_API opj_event_mgr_t* OPJ_CALLCONV opj_set_event_mgr(opj_common_ptr cinfo, opj_event_mgr_t *event_mgr, void *context);
802 ==========================================================
803 codec functions definitions
804 ==========================================================
807 Creates a J2K/JPT/JP2 decompression structure
808 @param format Decoder to select
809 @return Returns a handle to a decompressor if successful, returns NULL otherwise
811 OPJ_API opj_dinfo_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format);
813 Destroy a decompressor handle
814 @param dinfo decompressor handle to destroy
816 OPJ_API void OPJ_CALLCONV opj_destroy_decompress(opj_dinfo_t *dinfo);
818 Set decoding parameters to default values
819 @param parameters Decompression parameters
821 OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters);
823 Setup the decoder decoding parameters using user parameters.
824 Decoding parameters are returned in j2k->cp.
825 @param dinfo decompressor handle
826 @param parameters decompression parameters
828 OPJ_API void OPJ_CALLCONV opj_setup_decoder(opj_dinfo_t *dinfo, opj_dparameters_t *parameters);
830 Decode an image from a JPEG-2000 codestream
831 @param dinfo decompressor handle
832 @param cio Input buffer stream
833 @return Returns a decoded image if successful, returns NULL otherwise
835 OPJ_API opj_image_t* OPJ_CALLCONV opj_decode(opj_dinfo_t *dinfo, opj_cio_t *cio);
838 Decode an image from a JPEG-2000 codestream and extract the codestream information
839 @param dinfo decompressor handle
840 @param cio Input buffer stream
841 @param cstr_info Codestream information structure if needed afterwards, NULL otherwise
842 @return Returns a decoded image if successful, returns NULL otherwise
844 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);
846 Creates a J2K/JP2 compression structure
847 @param format Coder to select
848 @return Returns a handle to a compressor if successful, returns NULL otherwise
850 OPJ_API opj_cinfo_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
852 Destroy a compressor handle
853 @param cinfo compressor handle to destroy
855 OPJ_API void OPJ_CALLCONV opj_destroy_compress(opj_cinfo_t *cinfo);
857 Set encoding parameters to default values, that means :
861 <li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
862 <li>Size of code-block : 64 x 64
863 <li>Number of resolutions: 6
864 <li>No SOP marker in the codestream
865 <li>No EPH marker in the codestream
866 <li>No sub-sampling in x or y direction
867 <li>No mode switch activated
868 <li>Progression order: LRCP
871 <li>No offset of the origin of the image
872 <li>No offset of the origin of the tiles
873 <li>Reversible DWT 5-3
875 @param parameters Compression parameters
877 OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(opj_cparameters_t *parameters);
879 Setup the encoder parameters using the current image and using user parameters.
880 @param cinfo Compressor handle
881 @param parameters Compression parameters
882 @param image Input filled image
884 OPJ_API void OPJ_CALLCONV opj_setup_encoder(opj_cinfo_t *cinfo, opj_cparameters_t *parameters, opj_image_t *image);
886 Encode an image into a JPEG-2000 codestream
887 3@param cinfo compressor handle
888 @param cio Output buffer stream
889 @param image Image to encode
890 @param index Depreacted -> Set to NULL. To extract index, used opj_encode_wci()
891 @return Returns true if successful, returns false otherwise
893 OPJ_API opj_bool OPJ_CALLCONV opj_encode(opj_cinfo_t *cinfo, opj_cio_t *cio, opj_image_t *image, char *index);
895 Encode an image into a JPEG-2000 codestream and extract the codestream information
896 @param cinfo compressor handle
897 @param cio Output buffer stream
898 @param image Image to encode
899 @param cstr_info Codestream information structure if needed afterwards, NULL otherwise
900 @return Returns true if successful, returns false otherwise
902 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);
904 Destroy Codestream information after compression or decompression
905 @param cstr_info Codestream information structure
907 OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_t *cstr_info);
914 #endif /* OPENJPEG_H */