Merge pull request #1301 from rouault/fix_1299
[openjpeg.git] / src / lib / openjpip / imgreg_manager.h
index 7967120b55ecf4ff3fc7ed5358b82ed9199bbc32..6963467313a95f921cae8dd695804dcd172a97cb 100644 (file)
@@ -1,8 +1,8 @@
 /*
- * $Id: imgreg_manager.h 44 2011-02-15 12:32:29Z kaori $
+ * $Id$
  *
- * Copyright (c) 2002-2011, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
- * Copyright (c) 2002-2011, Professor Benoit Macq
+ * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
+ * Copyright (c) 2002-2014, Professor Benoit Macq
  * Copyright (c) 2010-2011, Kaori Hagihara
  * All rights reserved.
  *
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef        IMGREG_MANAGER_H_
-# define       IMGREG_MANAGER_H_
+#ifndef     IMGREG_MANAGER_H_
+# define    IMGREG_MANAGER_H_
 
 /** image region parameters */
-typedef struct imgreg_param{
-  int xosiz, yosiz; /** offset from the origin of the reference grid
-                   at the decomposition level */
-  int fx, fy;       /** frame size (fsiz) */
-  int ox, oy;       /** offset (roff) */
-  int sx, sy;       /** region size (rsiz) */
-  int level;        /** decomposition level */
+typedef struct imgreg_param {
+    int xosiz, yosiz; /** offset from the origin of the reference grid
+            at the decomposition level */
+    int fx, fy;       /** frame size (fsiz) */
+    int ox, oy;       /** offset (roff) */
+    int sx, sy;       /** region size (rsiz) */
+    int level;        /** decomposition level */
 } imgreg_param_t;
 
 
@@ -53,12 +53,12 @@ typedef struct imgreg_param{
  * @param[in] numOfreslev number of resolution levels
  * @return                structure of image region parameters
  */
-imgreg_param_t map_viewin2imgreg( const int fx,    const int fy, 
-                                 const int rx,    const int ry,
-                                 const int rw,    const int rh,
-                                 const int XOsiz, const int YOsiz,
-                                 const int Xsiz,  const int Ysiz,
-                                 const int numOfreslev);
+imgreg_param_t map_viewin2imgreg(const int fx,    const int fy,
+                                 const int rx,    const int ry,
+                                 const int rw,    const int rh,
+                                 const int XOsiz, const int YOsiz,
+                                 const int Xsiz,  const int Ysiz,
+                                 const int numOfreslev);
 
 
 /**
@@ -68,34 +68,35 @@ imgreg_param_t map_viewin2imgreg( const int fx,    const int fy,
  * Note: only round-down implemented
  *
  * @param[in]     maxlev maximum decomposition level
- * @param[in/out] lev    decomposition level pointer
- * @param[in/out] fx     horizontal frame size pointer
- * @param[in/out] fy     vertical   frame size pointer
- * @param[in/out] xmin   horizontal image offset pointer
- * @param[in/out] ymin   vertical   image offset pointer
- * @param[in/out] xmax   horizontal image size pointer
- * @param[in/out] ymax   vertical   image size pointer
+ * @param[in,out] lev    decomposition level pointer
+ * @param[in,out] fx     horizontal frame size pointer
+ * @param[in,out] fy     vertical   frame size pointer
+ * @param[in,out] xmin   horizontal image offset pointer
+ * @param[in,out] ymin   vertical   image offset pointer
+ * @param[in,out] xmax   horizontal image size pointer
+ * @param[in,out] ymax   vertical   image size pointer
  */
-void find_level( int maxlev, int *lev, int *fx, int *fy, int *xmin, int *ymin, int *xmax, int *ymax);
+void find_level(int maxlev, int *lev, int *fx, int *fy, int *xmin, int *ymin,
+                int *xmax, int *ymax);
 
 /**
  * compute decomposition level (only to get the level
  *   use find_level for all parameters
  *
- * @param[in] fx   horizontal frame size
- * @param[in] fy   vertical   frame size
+ * @param[in] fw   horizontal frame size
+ * @param[in] fh   vertical   frame size
  * @param[in] Xsiz image width
  * @param[in] Ysiz image height
  * @return decomposition level
  */
-int comp_decomplev( int fw, int fh, int Xsiz, int Ysiz);
+int comp_decomplev(int fw, int fh, int Xsiz, int Ysiz);
 
 /**
  * print image region parameters
  *
  * @param[in] imgreg image region structure of parameters
  */
-void print_imgreg( imgreg_param_t imgreg);
+void print_imgreg(imgreg_param_t imgreg);
 
 
-#endif             /* !IMGREG_MANAGER_H_ */
+#endif      /* !IMGREG_MANAGER_H_ */