remove deprecated v1 style function j2k_read_cod
[openjpeg.git] / libopenjpeg / tcd.h
index 6489ddeba2870ed03b54c4d17a2a365d07fdb9d9..bd2fe69efcd42d2175a19fcb1e3606d2d6491ce9 100644 (file)
@@ -34,8 +34,8 @@
 @file tcd.h
 @brief Implementation of a tile coder/decoder (TCD)
 
-The functions in TCD.C have for goal to encode or decode each tile independently from
-each other. The functions in TCD.C are used by some function in J2K.C.
+The functions in TCD.C encode or decode each tile independently from
+each other. The functions in TCD.C are used by other functions in J2K.C.
 */
 
 /** @defgroup TCD TCD - Implementation of a tile coder/decoder */
@@ -44,28 +44,28 @@ each other. The functions in TCD.C are used by some function in J2K.C.
 /**
 FIXME: documentation
 */
-//typedef struct opj_tcd_seg {
-//  unsigned char** data;
-//  int dataindex;
-//  int numpasses;
-//  int len;
-//  int maxpasses;
-//  int numnewpasses;
-//  int newlen;
-//} opj_tcd_seg_t;
+/*typedef struct opj_tcd_seg { */
+/*  unsigned char** data; */
+/*  int dataindex; */
+/*  int numpasses; */
+/*  int len; */
+/*  int maxpasses; */
+/*  int numnewpasses; */
+/*  int newlen; */
+/*} opj_tcd_seg_t; */
 
 /**
 FIXME: documentation
 */
 typedef struct opj_tcd_seg {
-  OPJ_BYTE ** data;
-  OPJ_UINT32 dataindex;
-  OPJ_UINT32 numpasses;
-  OPJ_UINT32 real_num_passes;
-  OPJ_UINT32 len;
-  OPJ_UINT32 maxpasses;
-  OPJ_UINT32 numnewpasses;
-  OPJ_UINT32 newlen;
+       OPJ_BYTE ** data;
+       OPJ_UINT32 dataindex;
+       OPJ_UINT32 numpasses;
+       OPJ_UINT32 real_num_passes;
+       OPJ_UINT32 len;
+       OPJ_UINT32 maxpasses;
+       OPJ_UINT32 numnewpasses;
+       OPJ_UINT32 newlen;
 } opj_tcd_seg_t;
 
 /**
@@ -77,14 +77,21 @@ typedef struct opj_tcd_pass {
   int term, len;
 } opj_tcd_pass_t;
 
+typedef struct opj_tcd_pass_v2 {
+       OPJ_UINT32 rate;
+       OPJ_FLOAT64 distortiondec;
+       OPJ_UINT32 len;
+       OPJ_UINT32 term : 1;
+} opj_tcd_pass_v2_t;
+
 /**
 FIXME: documentation
 */
 typedef struct opj_tcd_layer {
-  int numpasses;               /* Number of passes in the layer */
-  int len;                     /* len of information */
-  double disto;                        /* add for index (Cfr. Marcela) */
-  unsigned char *data;         /* data */
+       OPJ_UINT32 numpasses;           /* Number of passes in the layer */
+       OPJ_UINT32 len;                         /* len of information */
+       OPJ_FLOAT64 disto;                      /* add for index (Cfr. Marcela) */
+       OPJ_BYTE *data;                         /* data */
 } opj_tcd_layer_t;
 
 /**
@@ -102,77 +109,93 @@ typedef struct opj_tcd_cblk_enc {
   int totalpasses;             /* total number of passes */
 } opj_tcd_cblk_enc_t;
 
-//typedef struct opj_tcd_cblk_dec {
-//  unsigned char* data;       /* Data */
-//  opj_tcd_seg_t* segs;               /* segments informations */
-//     int x0, y0, x1, y1;             /* dimension of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
-//  int numbps;
-//  int numlenbits;
-//  int len;                   /* length */
-//  int numnewpasses;          /* number of pass added to the code-blocks */
-//  int numsegs;                       /* number of segments */
-//} opj_tcd_cblk_dec_t;
+/**
+FIXME: documentation
+*/
+typedef struct opj_tcd_cblk_enc_v2 {
+       OPJ_BYTE* data;                                 /* Data */
+       opj_tcd_layer_t* layers;                /* layer information */
+       opj_tcd_pass_v2_t* passes;              /* information about the passes */
+       OPJ_INT32 x0, y0, x1, y1;               /* dimension of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
+       OPJ_UINT32 numbps;
+       OPJ_UINT32 numlenbits;
+       OPJ_UINT32 numpasses;                   /* number of pass already done for the code-blocks */
+       OPJ_UINT32 numpassesinlayers;   /* number of passes in the layer */
+       OPJ_UINT32 totalpasses;                 /* total number of passes */
+} opj_tcd_cblk_enc_v2_t;
 
 typedef struct opj_tcd_cblk_dec {
-  OPJ_BYTE * data;     /* Data */
-  opj_tcd_seg_t* segs;         /* segments informations */
-  OPJ_INT32 x0, y0, x1, y1;            /* dimension of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
-  OPJ_UINT32 numbps;
-  OPJ_UINT32 numlenbits;
-  OPJ_UINT32 len;                      /* length */
-  OPJ_UINT32 numnewpasses;             /* number of pass added to the code-blocks */
-  OPJ_UINT32 numsegs;                  /* number of segments */
-  OPJ_UINT32 real_num_segs;
-  OPJ_UINT32 m_current_max_segs;
+  unsigned char* data; /* Data */
+  opj_tcd_seg_t* segs;         /* segments information */
+       int x0, y0, x1, y1;             /* dimension of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
+  int numbps;
+  int numlenbits;
+  int len;                     /* length */
+  int numnewpasses;            /* number of pass added to the code-blocks */
+  int numsegs;                 /* number of segments */
 } opj_tcd_cblk_dec_t;
 
+
+typedef struct opj_tcd_cblk_dec_v2 {
+       OPJ_BYTE * data;                                /* Data */
+       opj_tcd_seg_t* segs;                    /* segments information */
+       OPJ_INT32 x0, y0, x1, y1;               /* dimension of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
+       OPJ_UINT32 numbps;
+       OPJ_UINT32 numlenbits;
+       OPJ_UINT32 len;                                 /* length */
+       OPJ_UINT32 numnewpasses;                /* number of pass added to the code-blocks */
+       OPJ_UINT32 numsegs;                             /* number of segments */
+       OPJ_UINT32 real_num_segs;
+       OPJ_UINT32 m_current_max_segs;
+} opj_tcd_cblk_dec_v2_t;
+
 /**
 FIXME: documentation
 */
-//typedef struct opj_tcd_precinct {
-//  int x0, y0, x1, y1;                /* dimension of the precinct : left upper corner (x0, y0) right low corner (x1,y1) */
-//  int cw, ch;                        /* number of precinct in width and heigth */
-//  union{             /* code-blocks informations */
-//       opj_tcd_cblk_enc_t* enc;
-//       opj_tcd_cblk_dec_t* dec;
-//  } cblks;
-//  opj_tgt_tree_t *incltree;          /* inclusion tree */
-//  opj_tgt_tree_t *imsbtree;          /* IMSB tree */
-//} opj_tcd_precinct_t;
-
-
 typedef struct opj_tcd_precinct {
-  OPJ_INT32 x0, y0, x1, y1;            /* dimension of the precinct : left upper corner (x0, y0) right low corner (x1,y1) */
-  OPJ_UINT32 cw, ch;                   /* number of precinct in width and heigth */
-  union{               /* code-blocks informations */
+  int x0, y0, x1, y1;          /* dimension of the precinct : left upper corner (x0, y0) right low corner (x1,y1) */
+  int cw, ch;                  /* number of precinct in width and height */
+  union{               /* code-blocks information */
          opj_tcd_cblk_enc_t* enc;
          opj_tcd_cblk_dec_t* dec;
   } cblks;
-  OPJ_UINT32 block_size;               /* size taken by cblks (in bytes) */
-  struct opj_tgt_tree *incltree;               /* inclusion tree */
- struct opj_tgt_tree *imsbtree;                /* IMSB tree */
+  opj_tgt_tree_t *incltree;            /* inclusion tree */
+  opj_tgt_tree_t *imsbtree;            /* IMSB tree */
 } opj_tcd_precinct_t;
 
+
+typedef struct opj_tcd_precinct_v2 {
+       OPJ_INT32 x0, y0, x1, y1;               /* dimension of the precinct : left upper corner (x0, y0) right low corner (x1,y1) */
+       OPJ_UINT32 cw, ch;                              /* number of precinct in width and height */
+       union{                                                  /* code-blocks information */
+               opj_tcd_cblk_enc_v2_t* enc;
+               opj_tcd_cblk_dec_v2_t* dec;
+       } cblks;
+       OPJ_UINT32 block_size;                  /* size taken by cblks (in bytes) */
+       opj_tgt_tree_t *incltree;       /* inclusion tree */
+       opj_tgt_tree_t *imsbtree;       /* IMSB tree */
+} opj_tcd_precinct_v2_t;
+
 /**
 FIXME: documentation
 */
-//typedef struct opj_tcd_band {
-//  int x0, y0, x1, y1;                /* dimension of the subband : left upper corner (x0, y0) right low corner (x1,y1) */
-//  int bandno;
-//  opj_tcd_precinct_t *precincts;     /* precinct information */
-//  int numbps;
-//  float stepsize;
-//} opj_tcd_band_t;
-
 typedef struct opj_tcd_band {
-  OPJ_INT32 x0, y0, x1, y1;            /* dimension of the subband : left upper corner (x0, y0) right low corner (x1,y1) */
-  OPJ_UINT32 bandno;
+  int x0, y0, x1, y1;          /* dimension of the subband : left upper corner (x0, y0) right low corner (x1,y1) */
+  int bandno;
   opj_tcd_precinct_t *precincts;       /* precinct information */
-  OPJ_UINT32 precincts_data_size;              /* size of data taken by precincts */
-  OPJ_INT32 numbps;
-  OPJ_FLOAT32 stepsize;
+  int numbps;
+  float stepsize;
 } opj_tcd_band_t;
 
+typedef struct opj_tcd_band_v2 {
+       OPJ_INT32 x0, y0, x1, y1;               /* dimension of the subband : left upper corner (x0, y0) right low corner (x1,y1) */
+       OPJ_UINT32 bandno;
+       opj_tcd_precinct_v2_t *precincts;       /* precinct information */
+       OPJ_UINT32 precincts_data_size; /* size of data taken by precincts */
+       OPJ_INT32 numbps;
+       OPJ_FLOAT32 stepsize;
+} opj_tcd_band_v2_t;
+
 /**
 FIXME: documentation
 */
@@ -183,29 +206,36 @@ typedef struct opj_tcd_resolution {
   opj_tcd_band_t bands[3];             /* subband information */
 } opj_tcd_resolution_t;
 
+typedef struct opj_tcd_resolution_v2 {
+       OPJ_INT32 x0, y0, x1, y1;               /* dimension of the resolution level : left upper corner (x0, y0) right low corner (x1,y1) */
+       OPJ_UINT32 pw, ph;
+       OPJ_UINT32 numbands;                    /* number sub-band for the resolution level */
+       opj_tcd_band_v2_t bands[3];             /* subband information */
+} opj_tcd_resolution_v2_t;
+
 /**
 FIXME: documentation
 */
-//typedef struct opj_tcd_tilecomp {
-//  int x0, y0, x1, y1;                /* dimension of component : left upper corner (x0, y0) right low corner (x1,y1) */
-//  int numresolutions;                /* number of resolutions level */
-//  opj_tcd_resolution_t *resolutions; /* resolutions information */
-//  int *data;                 /* data of the component */
-//  int numpix;                        /* add fixed_quality */
-//} opj_tcd_tilecomp_t;
-
-typedef struct opj_tcd_tilecomp
-{
-  OPJ_INT32 x0, y0, x1, y1;            /* dimension of component : left upper corner (x0, y0) right low corner (x1,y1) */
-  OPJ_UINT32 numresolutions;           /* number of resolutions level */
-  OPJ_UINT32 minimum_num_resolutions;          /* number of resolutions level to decode (at max)*/
+typedef struct opj_tcd_tilecomp {
+  int x0, y0, x1, y1;          /* dimension of component : left upper corner (x0, y0) right low corner (x1,y1) */
+  int numresolutions;          /* number of resolutions level */
   opj_tcd_resolution_t *resolutions;   /* resolutions information */
-  OPJ_UINT32 resolutions_size;         /* size of data for resolutions (in bytes) */
-  OPJ_INT32 *data;                     /* data of the component */
-  OPJ_UINT32 data_size;                        /* size of the data of the component */
-  OPJ_INT32 numpix;                    /* add fixed_quality */
+  int *data;                   /* data of the component */
+  int numpix;                  /* add fixed_quality */
 } opj_tcd_tilecomp_t;
 
+typedef struct opj_tcd_tilecomp_v2
+{
+       OPJ_INT32 x0, y0, x1, y1;                               /* dimension of component : left upper corner (x0, y0) right low corner (x1,y1) */
+       OPJ_UINT32 numresolutions;                              /* number of resolutions level */
+       OPJ_UINT32 minimum_num_resolutions;             /* number of resolutions level to decode (at max)*/
+       opj_tcd_resolution_v2_t *resolutions;   /* resolutions information */
+       OPJ_UINT32 resolutions_size;                    /* size of data for resolutions (in bytes) */
+       OPJ_INT32 *data;                                                /* data of the component */
+       OPJ_UINT32 data_size;                                   /* size of the data of the component */
+       OPJ_INT32 numpix;                                               /* add fixed_quality */
+} opj_tcd_tilecomp_v2_t;
+
 
 /**
 FIXME: documentation
@@ -221,14 +251,31 @@ typedef struct opj_tcd_tile {
   int packno;
 } opj_tcd_tile_t;
 
+typedef struct opj_tcd_tile_v2 {
+       OPJ_INT32 x0, y0, x1, y1;               /* dimension of the tile : left upper corner (x0, y0) right low corner (x1,y1) */
+       OPJ_UINT32 numcomps;                    /* number of components in tile */
+       opj_tcd_tilecomp_v2_t *comps;   /* Components information */
+       OPJ_INT32 numpix;                               /* add fixed_quality */
+       OPJ_FLOAT64 distotile;                  /* add fixed_quality */
+       OPJ_FLOAT64 distolayer[100];    /* add fixed_quality */
+       /** packet number */
+       OPJ_UINT32 packno;
+} opj_tcd_tile_v2_t;
+
 /**
 FIXME: documentation
 */
 typedef struct opj_tcd_image {
-  int tw, th;                  /* number of tiles in width and heigth */
+  int tw, th;                  /* number of tiles in width and height */
   opj_tcd_tile_t *tiles;               /* Tiles information */
 } opj_tcd_image_t;
 
+typedef struct opj_tcd_image_v2
+{
+       opj_tcd_tile_v2_t *tiles;               /* Tiles information */
+}
+opj_tcd_image_v2_t;
+
 /**
 Tile coder/decoder
 */
@@ -282,9 +329,9 @@ typedef struct opj_tcd_v2
        /** Current Packet iterator number */
        OPJ_UINT32 cur_pino;
        /** info on each image tile */
-       opj_tcd_image_t *tcd_image;
-       /** image */
-       struct opj_image *image;
+       opj_tcd_image_v2_t *tcd_image;
+       /** image header */
+       opj_image_t *image;
        /** coding parameters */
        struct opj_cp_v2 *cp;
        /** coding/decoding parameters common to all tiles */
@@ -324,19 +371,15 @@ Destroy a previously created TCD handle
 void tcd_destroy_v2(opj_tcd_v2_t *tcd);
 
 /**
- * Initialize the tile coder and may reuse some meory.
+ * Initialize the tile coder and may reuse some memory.
  * @param      p_tcd           TCD handle.
  * @param      p_image         raw image.
  * @param      p_cp            coding parameters.
- * @param      p_tile_no       current tile index to encode.
  *
  * @return true if the encoding values could be set (false otherwise).
 */
-opj_bool tcd_init_v2(
-                                               opj_tcd_v2_t *p_tcd,
-                                               //struct opj_image * p_image,
+opj_bool tcd_init_v2(  opj_tcd_v2_t *p_tcd,
                                                opj_image_t * p_image,
-                                               //struct opj_cp * p_cp
                                                opj_cp_v2_t * p_cp
                                        );
 
@@ -344,13 +387,10 @@ opj_bool tcd_init_v2(
  * Allocates memory for decoding a specific tile.
  *
  * @param      p_tcd           the tile decoder.
- * @param      p_image         the image to decode.
- * @param      p_cp            the decoding parameters.
- * @param      p_tile_no       the index of the tile received in sequence. This not necesseraly lead to the
+ * @param      p_tile_no       the index of the tile received in sequence. This not necessarily lead to the
  * tile at index p_tile_no.
- * @param      p_cstr_info     codestream info (if any).
  *
- * @return     true if the remaining data is sufficient.s
+ * @return     true if the remaining data is sufficient.
  */
 opj_bool tcd_init_decode_tile(
                                                        opj_tcd_v2_t *p_tcd,
@@ -391,10 +431,28 @@ Initialize the tile decoder
 */
 void tcd_malloc_decode(opj_tcd_t *tcd, opj_image_t * image, opj_cp_t * cp);
 void tcd_malloc_decode_tile(opj_tcd_t *tcd, opj_image_t * image, opj_cp_t * cp, int tileno, opj_codestream_info_t *cstr_info);
+
 void tcd_makelayer_fixed(opj_tcd_t *tcd, int layno, int final);
+void tcd_makelayer_fixed_v2(opj_tcd_v2_t *tcd, OPJ_UINT32 layno, OPJ_UINT32 final);
+
 void tcd_rateallocate_fixed(opj_tcd_t *tcd);
+void tcd_rateallocate_fixed_v2(opj_tcd_v2_t *tcd);
+
 void tcd_makelayer(opj_tcd_t *tcd, int layno, double thresh, int final);
+
+void tcd_makelayer_v2( opj_tcd_v2_t *tcd,
+                                               OPJ_UINT32 layno,
+                                               OPJ_FLOAT64 thresh,
+                                               OPJ_UINT32 final);
+
 opj_bool tcd_rateallocate(opj_tcd_t *tcd, unsigned char *dest, int len, opj_codestream_info_t *cstr_info);
+
+opj_bool tcd_rateallocate_v2(  opj_tcd_v2_t *tcd,
+                                                               OPJ_BYTE *dest,
+                                                               OPJ_UINT32 * p_data_written,
+                                                               OPJ_UINT32 len,
+                                                               opj_codestream_info_t *cstr_info);
+
 /**
 Encode a tile from the raw image into a buffer
 @param tcd TCD handle
@@ -429,6 +487,24 @@ OPJ_UINT32 tcd_get_decoded_tile_size (
                                                 opj_tcd_v2_t *p_tcd
                                                 );
 
+/**
+ * Encodes a tile from the raw image into the given buffer.
+ * @param      p_tcd                   Tile Coder handle
+ * @param      p_tile_no               Index of the tile to encode.
+ * @param      p_dest                  Destination buffer
+ * @param      p_data_written  pointer to an int that is incremented by the number of bytes really written on p_dest
+ * @param      p_len                   Maximum length of the destination buffer
+ * @param      p_cstr_info             Codestream information structure
+ * @return  true if the coding is successfull.
+*/
+opj_bool tcd_encode_tile_v2(opj_tcd_v2_t *p_tcd,
+                                                       OPJ_UINT32 p_tile_no,
+                                                       OPJ_BYTE *p_dest,
+                                                       OPJ_UINT32 * p_data_written,
+                                                       OPJ_UINT32 p_len,
+                                                       struct opj_codestream_info *p_cstr_info);
+
+
 /**
 Decode a tile from a buffer into a raw image
 @param tcd TCD handle
@@ -436,17 +512,43 @@ Decode a tile from a buffer into a raw image
 @param len Length of source buffer
 @param tileno Number that identifies one of the tiles to be decoded
 */
-opj_bool tcd_decode_tile_v2(opj_tcd_v2_t *tcd, OPJ_BYTE *src, OPJ_UINT32 len, OPJ_UINT32 tileno, struct opj_codestream_info *cstr_info);
+opj_bool tcd_decode_tile_v2(opj_tcd_v2_t *tcd,
+                                                       OPJ_BYTE *src,
+                                                       OPJ_UINT32 len,
+                                                       OPJ_UINT32 tileno,
+                                                       opj_codestream_index_t *cstr_info);
 
 
 /**
  * Copies tile data from the system onto the given memory block.
  */
-opj_bool tcd_update_tile_data (
-                                                opj_tcd_v2_t *p_tcd,
-                                                OPJ_BYTE * p_dest,
-                                                OPJ_UINT32 p_dest_length
-                                                );
+opj_bool tcd_update_tile_data (        opj_tcd_v2_t *p_tcd,
+                                                               OPJ_BYTE * p_dest,
+                                                               OPJ_UINT32 p_dest_length );
+
+/**
+ *
+ */
+OPJ_UINT32 tcd_get_encoded_tile_size ( opj_tcd_v2_t *p_tcd );
+
+/**
+ * Initialize the tile coder and may reuse some meory.
+ * @param      p_tcd           TCD handle.
+ * @param      p_image         raw image.
+ * @param      p_cp            coding parameters.
+ * @param      p_tile_no       current tile index to encode.
+ *
+ * @return true if the encoding values could be set (false otherwise).
+*/
+opj_bool tcd_init_encode_tile (        opj_tcd_v2_t *p_tcd,
+                                                               OPJ_UINT32 p_tile_no );
+
+/**
+ * Copies tile data from the given memory block onto the system.
+ */
+opj_bool tcd_copy_tile_data (opj_tcd_v2_t *p_tcd,
+                                                        OPJ_BYTE * p_src,
+                                                        OPJ_UINT32 p_src_length );
 
 /* ----------------------------------------------------------------------- */
 /*@}*/