WIP: begin to test opj_read_tile_header with V2 style
[openjpeg.git] / libopenjpeg / openjpeg.h
index 0f35fbd334b8c91736e668e78daa58df3c2d620f..80c0f79b34eb2974b1b2d4b627f1ac6d9c1aa522 100644 (file)
@@ -105,6 +105,15 @@ typedef float                      OPJ_FLOAT32;
 #define JPWL_MAXIMUM_EPB_ROOM 65450 /**< Expect this maximum number of bytes for composition of EPBs */
 /* <<UniPG */
 
+/**
+Supported options about file information
+*/
+#define OPJ_NO_INFO            0x0     /**< No information provied to the user */
+#define OPJ_IMG_INFO   0x1     /**< Basic image information provided to the user */
+#define OPJ_J2K_INFO   0x2     /**< J2K codestream information provided to the user */
+#define OPJ_JP2_INFO   0x4     /**< JP2 file information provided to the user */
+
+
 /* 
 ==========================================================
    enum definitions
@@ -171,6 +180,9 @@ typedef enum LIMIT_DECODING {
        DECODE_ALL_BUT_PACKETS = 2      /**< Decode everything except the JPEG 2000 packets */
 } OPJ_LIMIT_DECODING;
 
+
+
+
 /* 
 ==========================================================
    event manager typedef definitions
@@ -421,6 +433,14 @@ 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;
+
+
 } opj_dparameters_t;
 
 /** Common fields between JPEG-2000 compression and decompression master structs. */
@@ -600,6 +620,77 @@ typedef struct opj_image_comptparm {
        int sgnd;
 } 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
@@ -743,6 +834,198 @@ typedef struct opj_codestream_info {
        opj_tile_info_t *tile;
 } opj_codestream_info_t;
 
+// NEW codestream
+
+/**
+Tile-component coding parameters
+*/
+typedef struct opj_tccp_info
+{
+       /** component index */
+       OPJ_UINT32 compno;
+       /** coding style */
+       OPJ_UINT32 csty;
+       /** number of resolutions */
+       OPJ_UINT32 numresolutions;
+       /** code-blocks width */
+       OPJ_UINT32 cblkw;
+       /** code-blocks height */
+       OPJ_UINT32 cblkh;
+       /** code-block coding style */
+       OPJ_UINT32 cblksty;
+       /** discrete wavelet transform identifier */
+       OPJ_UINT32 qmfbid;
+       /** quantisation style */
+       OPJ_UINT32 qntsty;
+       /** stepsizes used for quantization */
+       //FIXME opj_stepsize_t stepsizes[J2K_MAXBANDS];
+       /** number of guard bits */
+       OPJ_UINT32 numgbits;
+       /** Region Of Interest shift */
+       OPJ_INT32 roishift;
+       /** precinct width */
+       OPJ_UINT32 prcw[J2K_MAXRLVLS];
+       /** precinct height */
+       OPJ_UINT32 prch[J2K_MAXRLVLS];
+}
+opj_tccp_info_t;
+
+typedef struct opj_tile_v2_info {
+
+       /** number (index) of tile */
+       int tileno;
+
+       /** start position */
+       int start_pos;
+       /** end position of the header */
+       int end_header;
+       /** end position */
+       int end_pos;
+
+       /** add fixed_quality */
+       int numpix;
+       /** add fixed_quality */
+       double distotile;
+
+       /** coding style */
+       OPJ_UINT32 csty;
+       /** progression order */
+       OPJ_PROG_ORDER prg;
+       /** number of layers */
+       OPJ_UINT32 numlayers;
+       /** multi-component transform identifier */
+       OPJ_UINT32 mct;
+       /** rates of layers */
+       OPJ_FLOAT32 rates[100];
+
+       /** precinct number for each resolution level (width) */
+       int pw[33];
+       /** precinct number for each resolution level (height) */
+       int ph[33];
+       /** precinct size (in power of 2), in X for each resolution level */
+       int pdx[33];
+       /** precinct size (in power of 2), in Y for each resolution level */
+       int pdy[33];
+       /** information concerning packets inside tile */
+       opj_packet_info_t *packet;
+
+
+       /** number of tile parts */
+       int num_tps;
+       /** information concerning tile parts */
+       opj_tp_info_t *tp;
+
+       /** information concerning tile component parameters*/
+       opj_tccp_info_t *tccp_info;
+
+       /** value of thresh for each layer by tile cfr. Marcela   */
+       double *thresh;
+} opj_tile_info_v2_t;
+
+/**
+Index structure of the codestream
+*/
+typedef struct opj_codestream_info_v2 {
+       /* Basic image info */
+       /** image width */
+       int image_w;
+       /** image height */
+       int image_h;
+       /** numbers of component */
+       int numcomps;
+
+       /* Codestream Info */
+       /** progression order */
+       OPJ_PROG_ORDER prog;
+       /** number of layer */
+       int numlayers;
+
+       /** tile origin in x */
+       int tx0;
+       /** tile origin in y */
+       int ty0;
+       /** tile size in x */
+       int tdx;
+       /** tile size in y */
+       int tdy;
+       /** number of tiles in X */
+       int tw;
+       /** number of tiles in Y */
+       int th;
+
+       /** number of decomposition for each component */
+       int *numdecompos;
+
+       /** maximum distortion reduction on the whole image (add for Marcela) */
+       double D_max;
+       /** packet number */
+       int packno;
+       /** writing the packet in the index with t2_encode_packets */
+       int index_write;
+
+
+
+/* UniPG>> */
+       /** number of markers */
+       int marknum;
+       /** list of markers */
+       opj_marker_info_t *marker;
+       /** actual size of markers array */
+       int maxmarknum;
+/* <<UniPG */
+
+       /** main header position */
+       int main_head_start;
+       /** main header position */
+       int main_head_end;
+       /** codestream's size */
+       int codestream_size;
+
+       /** information regarding tiles inside image */
+       opj_tile_info_v2_t *tile;
+} opj_codestream_info_v2_t;
+
+
+/*
+==========================================================
+   Metadata from the JP2file
+==========================================================
+*/
+
+/**
+Info structure of the file
+*/
+typedef struct opj_jp2_metadata {
+       /** */
+       OPJ_INT32       empty_fields;
+
+} 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;
+
+
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -777,6 +1060,8 @@ Deallocate any resources associated with an image
 */
 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);
+
 /* 
 ==========================================================
    stream functions definitions
@@ -1024,16 +1309,10 @@ OPJ_API void OPJ_CALLCONV opj_destroy_cstr_info(opj_codestream_info_t *cstr_info
  * @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.
  */
-OPJ_API opj_bool OPJ_CALLCONV opj_read_header (
-                                                                               opj_codec_t *p_codec,
-                                                                               opj_image_t ** p_image,
-                                                                               OPJ_INT32 * p_tile_x0,
-                                                                               OPJ_INT32 * p_tile_y0,
-                                                                               OPJ_UINT32 * p_tile_width,
-                                                                               OPJ_UINT32 * p_tile_height,
-                                                                               OPJ_UINT32 * p_nb_tiles_x,
-                                                                               OPJ_UINT32 * p_nb_tiles_y,
-                                                                               opj_stream_t *p_cio);
+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);
 
 /**
 Destroy a decompressor handle
@@ -1041,8 +1320,55 @@ Destroy a decompressor handle
 */
 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.
+ *
+ * @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_INT32 p_start_x, OPJ_INT32 p_start_y,
+                                                                                                       OPJ_INT32 p_end_x, OPJ_INT32 p_end_y );
+
+/**
+ * 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 );
+
 #ifdef __cplusplus
 }
 #endif
 
 #endif /* OPENJPEG_H */
+
+