Reformat: apply reformattin on .h files (#128)
[openjpeg.git] / src / lib / openmj2 / pi.h
index 7f2fe3ef903c8a0fe4b54016e20f6b43b6f2e1a2..c8976cc39d5f0f72a7d20492a5cedcb7af200c87 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.
@@ -53,54 +53,54 @@ by some function in T2.C.
 FIXME: documentation
 */
 typedef struct opj_pi_resolution {
-  int pdx, pdy;
-  int pw, ph;
+    int pdx, pdy;
+    int pw, ph;
 } opj_pi_resolution_t;
 
 /**
 FIXME: documentation
 */
 typedef struct opj_pi_comp {
-  int dx, dy;
-  /** number of resolution levels */
-  int numresolutions;
-  opj_pi_resolution_t *resolutions;
+    int dx, dy;
+    /** number of resolution levels */
+    int numresolutions;
+    opj_pi_resolution_t *resolutions;
 } opj_pi_comp_t;
 
-/** 
-Packet iterator 
+/**
+Packet iterator
 */
 typedef struct opj_pi_iterator {
-       /** Enabling Tile part generation*/
-       char tp_on;
-       /** precise if the packet has been already used (useful for progression order change) */
-       short int *include;
-       /** layer step used to localize the packet in the include vector */
-       int step_l;
-       /** resolution step used to localize the packet in the include vector */
-       int step_r;     
-       /** component step used to localize the packet in the include vector */
-       int step_c;     
-       /** precinct step used to localize the packet in the include vector */
-       int step_p;     
-       /** component that identify the packet */
-       int compno;
-       /** resolution that identify the packet */
-       int resno;
-       /** precinct that identify the packet */
-       int precno;
-       /** layer that identify the packet */
-       int layno;   
-       /** 0 if the first packet */
-       int first;
-       /** progression order change information */
-       opj_poc_t poc;
-       /** number of components in the image */
-       int numcomps;
-       /** Components*/
-       opj_pi_comp_t *comps;
-       int tx0, ty0, tx1, ty1;
-       int x, y, dx, dy;
+    /** Enabling Tile part generation*/
+    char tp_on;
+    /** precise if the packet has been already used (useful for progression order change) */
+    short int *include;
+    /** layer step used to localize the packet in the include vector */
+    int step_l;
+    /** resolution step used to localize the packet in the include vector */
+    int step_r;
+    /** component step used to localize the packet in the include vector */
+    int step_c;
+    /** precinct step used to localize the packet in the include vector */
+    int step_p;
+    /** component that identify the packet */
+    int compno;
+    /** resolution that identify the packet */
+    int resno;
+    /** precinct that identify the packet */
+    int precno;
+    /** layer that identify the packet */
+    int layno;
+    /** 0 if the first packet */
+    int first;
+    /** progression order change information */
+    opj_poc_t poc;
+    /** number of components in the image */
+    int numcomps;
+    /** Components*/
+    opj_pi_comp_t *comps;
+    int tx0, ty0, tx1, ty1;
+    int x, y, dx, dy;
 } opj_pi_iterator_t;
 
 /** @name Exported functions */
@@ -115,10 +115,11 @@ Create a packet iterator for Encoder
 @return Returns a packet iterator that points to the first packet of the tile
 @see pi_destroy
 */
-opj_pi_iterator_t *pi_initialise_encode(opj_image_t *image, opj_cp_t *cp, int tileno,J2K_T2_MODE t2_mode);
+opj_pi_iterator_t *pi_initialise_encode(opj_image_t *image, opj_cp_t *cp,
+                                        int tileno, J2K_T2_MODE t2_mode);
 /**
 Modify the packet iterator for enabling tile part generation
-@param pi Handle to the packet iterator generated in pi_initialise_encode  
+@param pi Handle to the packet iterator generated in pi_initialise_encode
 @param cp Coding parameters
 @param tileno Number that identifies the tile for which to list the packets
 @param pino Iterator index for pi
@@ -126,9 +127,10 @@ Modify the packet iterator for enabling tile part generation
 @param tppos The position of the tile part flag in the progression order
 @param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass
 @param cur_totnum_tp The total number of tile parts in the current tile
-@return Returns true if an error is detected 
+@return Returns true if an error is detected
 */
-opj_bool pi_create_encode(opj_pi_iterator_t *pi, opj_cp_t *cp,int tileno, int pino,int tpnum, int tppos, J2K_T2_MODE t2_mode,int cur_totnum_tp);
+opj_bool pi_create_encode(opj_pi_iterator_t *pi, opj_cp_t *cp, int tileno,
+                          int pino, int tpnum, int tppos, J2K_T2_MODE t2_mode, int cur_totnum_tp);
 /**
 Create a packet iterator for Decoder
 @param image Raw image for which the packets will be listed
@@ -137,7 +139,8 @@ Create a packet iterator for Decoder
 @return Returns a packet iterator that points to the first packet of the tile
 @see pi_destroy
 */
-opj_pi_iterator_t *pi_create_decode(opj_image_t * image, opj_cp_t * cp, int tileno);
+opj_pi_iterator_t *pi_create_decode(opj_image_t * image, opj_cp_t * cp,
+                                    int tileno);
 
 /**
 Destroy a packet iterator
@@ -151,7 +154,7 @@ void pi_destroy(opj_pi_iterator_t *pi, opj_cp_t *cp, int tileno);
 /**
 Modify the packet iterator to point to the next packet
 @param pi Packet iterator to modify
-@return Returns false if pi pointed to the last packet or else returns true 
+@return Returns false if pi pointed to the last packet or else returns true
 */
 opj_bool pi_next(opj_pi_iterator_t * pi);
 /* ----------------------------------------------------------------------- */