minor changes in cmake flags
[openjpeg.git] / libopenjpeg / pi.h
index 5e39276b58548af2081d7728512e237c461f0cc1..80febc5c65e36c0b5226ce43e57dc4b924c70b7c 100644 (file)
@@ -1,9 +1,10 @@
 /*
+ * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
+ * Copyright (c) 2002-2007, Professor Benoit Macq
  * Copyright (c) 2001-2003, David Janssens
  * Copyright (c) 2002-2003, Yannick Verschueren
- * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
- * Copyright (c) 2005, Herv� Drolon, FreeImage Team
- * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
+ * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
+ * Copyright (c) 2005, Herve Drolon, FreeImage Team
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -64,84 +65,73 @@ typedef struct opj_pi_comp {
 Packet iterator 
 */
 typedef struct opj_pi_iterator {
-  /** 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;
-  /** */
-  int numcomps;
-  /** */
-  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 (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;
 } opj_pi_iterator_t;
 
-/** @name Local static functions */
+/** @name Exported functions */
 /*@{*/
 /* ----------------------------------------------------------------------- */
 /**
-Get next packet in layer-resolution-component-precinct order.
-@param pi packet iterator to modify
-@return returns false if pi pointed to the last packet or else returns true 
-*/
-static bool pi_next_lrcp(opj_pi_iterator_t * pi);
-/**
-Get next packet in resolution-layer-component-precinct order.
-@param pi packet iterator to modify
-@return returns false if pi pointed to the last packet or else returns true 
-*/
-static bool pi_next_rlcp(opj_pi_iterator_t * pi);
-/**
-Get next packet in resolution-precinct-component-layer order.
-@param pi packet iterator to modify
-@return returns false if pi pointed to the last packet or else returns true 
-*/
-static bool pi_next_rpcl(opj_pi_iterator_t * pi);
-/**
-Get next packet in precinct-component-resolution-layer order.
-@param pi packet iterator to modify
-@return returns false if pi pointed to the last packet or else returns true 
+Create a packet iterator for Encoder
+@param image Raw image for which the packets will be listed
+@param cp Coding parameters
+@param tileno Number that identifies the tile for which to list the packets
+@param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass
+@return Returns a packet iterator that points to the first packet of the tile
+@see pi_destroy
 */
-static bool pi_next_pcrl(opj_pi_iterator_t * pi);
+opj_pi_iterator_t *pi_initialise_encode(opj_image_t *image, opj_cp_t *cp, int tileno,J2K_T2_MODE t2_mode);
 /**
-Get next packet in component-precinct-resolution-layer order.
-@param pi packet iterator to modify
-@return returns false if pi pointed to the last packet or else returns true 
+Modify the packet iterator for enabling tile part generation
+@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
+@param tpnum Tile part number of the current tile
+@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 
 */
-static bool pi_next_cprl(opj_pi_iterator_t * pi);
-/* ----------------------------------------------------------------------- */
-/*@}*/
-
-/** @name Exported functions */
-/*@{*/
-/* ----------------------------------------------------------------------- */
+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
+Create a packet iterator for Decoder
 @param image Raw image for which the packets will be listed
 @param cp Coding parameters
 @param tileno Number that identifies the tile for which to list the packets
 @return Returns a packet iterator that points to the first packet of the tile
 @see pi_destroy
 */
-opj_pi_iterator_t *pi_create(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