Reformat: apply reformattin on .h files (#128)
[openjpeg.git] / src / lib / openmj2 / tcd.h
index 339e3b785a4ad5fda327f654fc6ca6c01971718e..f88c1ed3e2c2583c042bbe846250239eb87c91e9 100644 (file)
@@ -1,6 +1,6 @@
 /*
- * 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 
+ * 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.
  *
@@ -8,7 +8,7 @@
  * 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-2007, Francois-Olivier Devaux
  * Copyright (c) 2003-2014, Antonin Descampe
  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  * All rights reserved.
@@ -51,159 +51,166 @@ 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;
+    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_pass {
-  int rate;
-  double distortiondec;
-  int term, len;
+    int rate;
+    double distortiondec;
+    int term, len;
 } opj_tcd_pass_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 */
+    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_tcd_layer_t;
 
 /**
 FIXME: documentation
 */
 typedef struct opj_tcd_cblk_enc {
-  unsigned char* data; /* Data */
-  opj_tcd_layer_t* layers;     /* layer information */
-  opj_tcd_pass_t* passes;      /* information about the passes */
-  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 numpasses;               /* number of pass already done for the code-blocks */
-  int numpassesinlayers;       /* number of passes in the layer */
-  int totalpasses;             /* total number of passes */
+    unsigned char* data;  /* Data */
+    opj_tcd_layer_t* layers;  /* layer information */
+    opj_tcd_pass_t* passes;   /* information about the passes */
+    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 numpasses;        /* number of pass already done for the code-blocks */
+    int numpassesinlayers;    /* number of passes in the layer */
+    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 */
+    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_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 */
+    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;
 
 /**
 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;
+    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;
 
 /**
 FIXME: documentation
 */
 typedef struct opj_tcd_resolution {
-  int x0, y0, x1, y1;          /* dimension of the resolution level : left upper corner (x0, y0) right low corner (x1,y1) */
-  int pw, ph;
-  int numbands;                        /* number sub-band for the resolution level */
-  opj_tcd_band_t bands[3];             /* subband information */
+    int x0, y0, x1,
+        y1;       /* dimension of the resolution level : left upper corner (x0, y0) right low corner (x1,y1) */
+    int pw, ph;
+    int numbands;         /* number sub-band for the resolution level */
+    opj_tcd_band_t bands[3];      /* subband information */
 } opj_tcd_resolution_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 */
+    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;
 
 /**
 FIXME: documentation
 */
 typedef struct opj_tcd_tile {
-  int x0, y0, x1, y1;          /* dimension of the tile : left upper corner (x0, y0) right low corner (x1,y1) */
-  int numcomps;                        /* number of components in tile */
-  opj_tcd_tilecomp_t *comps;   /* Components information */
-  int numpix;                  /* add fixed_quality */
-  double distotile;            /* add fixed_quality */
-  double distolayer[100];      /* add fixed_quality */
-  /** packet number */
-  int packno;
+    int x0, y0, x1,
+        y1;       /* dimension of the tile : left upper corner (x0, y0) right low corner (x1,y1) */
+    int numcomps;         /* number of components in tile */
+    opj_tcd_tilecomp_t *comps;    /* Components information */
+    int numpix;           /* add fixed_quality */
+    double distotile;     /* add fixed_quality */
+    double distolayer[100];   /* add fixed_quality */
+    /** packet number */
+    int packno;
 } opj_tcd_tile_t;
 
 /**
 FIXME: documentation
 */
 typedef struct opj_tcd_image {
-  int tw, th;                  /* number of tiles in width and heigth */
-  opj_tcd_tile_t *tiles;               /* Tiles information */
+    int tw, th;           /* number of tiles in width and heigth */
+    opj_tcd_tile_t *tiles;        /* Tiles information */
 } opj_tcd_image_t;
 
 /**
 Tile coder/decoder
 */
 typedef struct opj_tcd {
-       /** Position of the tilepart flag in Progression order*/
-       int tp_pos;
-       /** Tile part number*/
-       int tp_num;
-       /** Current tile part number*/
-       int cur_tp_num;
-       /** Total number of tileparts of the current tile*/
-       int cur_totnum_tp;
-       /** Current Packet iterator number */
-       int cur_pino;
-       /** codec context */
-       opj_common_ptr cinfo;
+    /** Position of the tilepart flag in Progression order*/
+    int tp_pos;
+    /** Tile part number*/
+    int tp_num;
+    /** Current tile part number*/
+    int cur_tp_num;
+    /** Total number of tileparts of the current tile*/
+    int cur_totnum_tp;
+    /** Current Packet iterator number */
+    int cur_pino;
+    /** codec context */
+    opj_common_ptr cinfo;
 
-       /** info on each image tile */
-       opj_tcd_image_t *tcd_image;
-       /** image */
-       opj_image_t *image;
-       /** coding parameters */
-       opj_cp_t *cp;
-       /** pointer to the current encoded/decoded tile */
-       opj_tcd_tile_t *tcd_tile;
-       /** coding/decoding parameters common to all tiles */
-       opj_tcp_t *tcp;
-       /** current encoded/decoded tile */
-       int tcd_tileno;
-       /** Time taken to encode a tile*/
-       double encoding_time;
+    /** info on each image tile */
+    opj_tcd_image_t *tcd_image;
+    /** image */
+    opj_image_t *image;
+    /** coding parameters */
+    opj_cp_t *cp;
+    /** pointer to the current encoded/decoded tile */
+    opj_tcd_tile_t *tcd_tile;
+    /** coding/decoding parameters common to all tiles */
+    opj_tcp_t *tcp;
+    /** current encoded/decoded tile */
+    int tcd_tileno;
+    /** Time taken to encode a tile*/
+    double encoding_time;
 } opj_tcd_t;
 
 /** @name Exported functions */
@@ -232,7 +239,8 @@ Initialize the tile coder (allocate the memory)
 @param cp Coding parameters
 @param curtileno Number that identifies the tile that will be encoded
 */
-void tcd_malloc_encode(opj_tcd_t *tcd, opj_image_t * image, opj_cp_t * cp, int curtileno);
+void tcd_malloc_encode(opj_tcd_t *tcd, opj_image_t * image, opj_cp_t * cp,
+                       int curtileno);
 /**
 Free the memory allocated for encoding
 @param tcd TCD handle
@@ -245,7 +253,8 @@ Initialize the tile coder (reuses the memory allocated by tcd_malloc_encode)
 @param cp Coding parameters
 @param curtileno Number that identifies the tile that will be encoded
 */
-void tcd_init_encode(opj_tcd_t *tcd, opj_image_t * image, opj_cp_t * cp, int curtileno);
+void tcd_init_encode(opj_tcd_t *tcd, opj_image_t * image, opj_cp_t * cp,
+                     int curtileno);
 /**
 Initialize the tile decoder
 @param tcd TCD handle
@@ -253,21 +262,24 @@ Initialize the tile decoder
 @param cp Coding parameters
 */
 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_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_rateallocate_fixed(opj_tcd_t *tcd);
 void tcd_makelayer(opj_tcd_t *tcd, int layno, double thresh, int final);
-opj_bool tcd_rateallocate(opj_tcd_t *tcd, unsigned char *dest, int len, opj_codestream_info_t *cstr_info);
+opj_bool tcd_rateallocate(opj_tcd_t *tcd, unsigned char *dest, int len,
+                          opj_codestream_info_t *cstr_info);
 /**
 Encode a tile from the raw image into a buffer
 @param tcd TCD handle
 @param tileno Number that identifies one of the tiles to be encoded
 @param dest Destination buffer
 @param len Length of destination buffer
-@param cstr_info Codestream information structure 
-@return 
+@param cstr_info Codestream information structure
+@return
 */
-int tcd_encode_tile(opj_tcd_t *tcd, int tileno, unsigned char *dest, int len, opj_codestream_info_t *cstr_info);
+int tcd_encode_tile(opj_tcd_t *tcd, int tileno, unsigned char *dest, int len,
+                    opj_codestream_info_t *cstr_info);
 /**
 Decode a tile from a buffer into a raw image
 @param tcd TCD handle
@@ -276,7 +288,8 @@ Decode a tile from a buffer into a raw image
 @param tileno Number that identifies one of the tiles to be decoded
 @param cstr_info Codestream information structure
 */
-opj_bool tcd_decode_tile(opj_tcd_t *tcd, unsigned char *src, int len, int tileno, opj_codestream_info_t *cstr_info);
+opj_bool tcd_decode_tile(opj_tcd_t *tcd, unsigned char *src, int len,
+                         int tileno, opj_codestream_info_t *cstr_info);
 /**
 Free the memory allocated for decoding
 @param tcd TCD handle