Defines three new functions

[openjpeg.git] / src / lib / openjp2 / pi.h

diff --git a/src/lib/openjp2/pi.h b/src/lib/openjp2/pi.h
index c8f576614c83f7f970bd4c45a9fb41af8ecfff72..f239679f5bd387fb013fe68263b78d189d94cd53 100644 (file)
--- a/src/lib/openjp2/pi.h
+++ b/src/lib/openjp2/pi.h
@@ -1,9 +1,15 @@
 /*
- * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
- * Copyright (c) 2002-2007, Professor Benoit Macq
+ * 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.
+ *
+ * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
+ * 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 and Antonin Descampe
+ * Copyright (c) 2003-2007, Francois-Olivier Devaux 
+ * Copyright (c) 2003-2014, Antonin Descampe
  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  * All rights reserved.
  *
@@ -47,17 +53,17 @@ by some function in T2.C.
 FIXME DOC
 */
 typedef struct opj_pi_resolution {
-  int pdx, pdy;
-  int pw, ph;
+  OPJ_UINT32 pdx, pdy;
+  OPJ_UINT32 pw, ph;
 } opj_pi_resolution_t;
 
 /**
 FIXME DOC
 */
 typedef struct opj_pi_comp {
-  int dx, dy;
+  OPJ_UINT32 dx, dy;
   /** number of resolution levels */
-  int numresolutions;
+  OPJ_UINT32 numresolutions;
   opj_pi_resolution_t *resolutions;
 } opj_pi_comp_t;
 
@@ -65,36 +71,40 @@ typedef struct opj_pi_comp {
 Packet iterator
 */
 typedef struct opj_pi_iterator {
-       /** Enabling Tile part generation*/
-       char tp_on;
-       /** precise if the packet has been already used (usefull 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*/
+  OPJ_BYTE tp_on;
+  /** precise if the packet has been already used (usefull for progression order change) */
+  OPJ_INT16 *include;
+  /** layer step used to localize the packet in the include vector */
+  OPJ_UINT32 step_l;
+  /** resolution step used to localize the packet in the include vector */
+  OPJ_UINT32 step_r;
+  /** component step used to localize the packet in the include vector */
+  OPJ_UINT32 step_c;
+  /** precinct step used to localize the packet in the include vector */
+  OPJ_UINT32 step_p;
+  /** component that identify the packet */
+  OPJ_UINT32 compno;
+  /** resolution that identify the packet */
+  OPJ_UINT32 resno;
+  /** precinct that identify the packet */
+  OPJ_UINT32 precno;
+  /** layer that identify the packet */
+  OPJ_UINT32 layno;
+  /** 0 if the first packet */
+  OPJ_BOOL first;
+  /** progression order change information */
+  opj_poc_t poc;
+  /** number of components in the image */
+  OPJ_UINT32 numcomps;
+  /** Components*/
+  opj_pi_comp_t *comps;
+  /** FIXME DOC*/
+  OPJ_INT32 tx0, ty0, tx1, ty1;
+  /** FIXME DOC*/
+  OPJ_INT32 x, y;
+  /** FIXME DOC*/
+  OPJ_UINT32 dx, dy;
 } opj_pi_iterator_t;
 
 /** @name Exported functions */
@@ -111,7 +121,7 @@ typedef struct opj_pi_iterator {
  * @return     a list of packet iterator that points to the first packet of the tile (not true).
 */
 opj_pi_iterator_t *opj_pi_initialise_encode(const opj_image_t *image,
-                                            opj_cp_v2_t *cp,
+                                            opj_cp_t *cp,
                                             OPJ_UINT32 tileno,
                                             J2K_T2_MODE t2_mode);
 
@@ -123,7 +133,7 @@ opj_pi_iterator_t *opj_pi_initialise_encode(const opj_image_t *image,
  * @param      p_tile_no       index of the tile being encoded.
 */
 void opj_pi_update_encoding_parameters(        const opj_image_t *p_image,
-                                        opj_cp_v2_t *p_cp,
+                                        opj_cp_t *p_cp,
                                         OPJ_UINT32 p_tile_no );
 
 /**
@@ -137,7 +147,7 @@ Modify the packet iterator for enabling tile part generation
 @param t2_mode FIXME DOC
 */
 void opj_pi_create_encode(  opj_pi_iterator_t *pi, 
-                            opj_cp_v2_t *cp,
+                            opj_cp_t *cp,
                             OPJ_UINT32 tileno, 
                             OPJ_UINT32 pino,
                             OPJ_UINT32 tpnum, 
@@ -153,7 +163,7 @@ Create a packet iterator for Decoder
 @see opj_pi_destroy
 */
 opj_pi_iterator_t *opj_pi_create_decode(opj_image_t * image, 
-                                        opj_cp_v2_t * cp,
+                                        opj_cp_t * cp,
                                         OPJ_UINT32 tileno);
 /**
  * Destroys a packet iterator array.
@@ -169,7 +179,7 @@ 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
 */
-opj_bool opj_pi_next(opj_pi_iterator_t * pi);
+OPJ_BOOL opj_pi_next(opj_pi_iterator_t * pi);
 /* ----------------------------------------------------------------------- */
 /*@}*/