Revert "OpenJPEG: update to 2.1 from 1.5"
[blender.git] / extern / libopenjpeg / pi.h
index f239679f5bd387fb013fe68263b78d189d94cd53..cf9135fd1f52c1ee03e497db74e01f1f8d62307c 100644 (file)
@@ -1,15 +1,9 @@
 /*
- * 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) 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-2007, Francois-Olivier Devaux 
- * Copyright (c) 2003-2014, Antonin Descampe
+ * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  * All rights reserved.
  *
@@ -50,136 +44,110 @@ by some function in T2.C.
 /*@{*/
 
 /**
-FIXME DOC
+FIXME: documentation
 */
 typedef struct opj_pi_resolution {
-  OPJ_UINT32 pdx, pdy;
-  OPJ_UINT32 pw, ph;
+  int pdx, pdy;
+  int pw, ph;
 } opj_pi_resolution_t;
 
 /**
-FIXME DOC
+FIXME: documentation
 */
 typedef struct opj_pi_comp {
-  OPJ_UINT32 dx, dy;
+  int dx, dy;
   /** number of resolution levels */
-  OPJ_UINT32 numresolutions;
+  int numresolutions;
   opj_pi_resolution_t *resolutions;
 } opj_pi_comp_t;
 
-/**
-Packet iterator
+/** 
+Packet iterator 
 */
 typedef struct opj_pi_iterator {
-  /** 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;
+       /** 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 Exported functions */
 /*@{*/
 /* ----------------------------------------------------------------------- */
 /**
- * Creates a packet iterator for encoding.
- *
- * @param      image           the image being encoded.
- * @param      cp              the coding parameters.
- * @param      tileno  index of the tile being encoded.
- * @param      t2_mode the type of pass for generating the packet 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_t *cp,
-                                            OPJ_UINT32 tileno,
-                                            J2K_T2_MODE t2_mode);
-
-/**
- * Updates the encoding parameters of the codec.
- *
- * @param      p_image         the image being encoded.
- * @param      p_cp            the coding parameters.
- * @param      p_tile_no       index of the tile being encoded.
+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
 */
-void opj_pi_update_encoding_parameters(        const opj_image_t *p_image,
-                                        opj_cp_t *p_cp,
-                                        OPJ_UINT32 p_tile_no );
-
+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   FIXME DOC
+@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 FIXME DOC
+@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 
 */
-void opj_pi_create_encode(  opj_pi_iterator_t *pi, 
-                            opj_cp_t *cp,
-                            OPJ_UINT32 tileno, 
-                            OPJ_UINT32 pino,
-                            OPJ_UINT32 tpnum, 
-                            OPJ_INT32 tppos, 
-                            J2K_T2_MODE t2_mode);
-
+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
 @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 opj_pi_destroy
+@see pi_destroy
 */
-opj_pi_iterator_t *opj_pi_create_decode(opj_image_t * image, 
-                                        opj_cp_t * cp,
-                                        OPJ_UINT32 tileno);
+opj_pi_iterator_t *pi_create_decode(opj_image_t * image, opj_cp_t * cp, int tileno);
+
 /**
- * Destroys a packet iterator array.
- *
- * @param      p_pi                    the packet iterator array to destroy.
- * @param      p_nb_elements   the number of elements in the array.
- */
-void opj_pi_destroy(opj_pi_iterator_t *p_pi,
-                    OPJ_UINT32 p_nb_elements);
+Destroy a packet iterator
+@param pi Previously created packet iterator
+@param cp Coding parameters
+@param tileno Number that identifies the tile for which the packets were listed
+@see pi_create
+*/
+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 opj_pi_next(opj_pi_iterator_t * pi);
+opj_bool pi_next(opj_pi_iterator_t * pi);
 /* ----------------------------------------------------------------------- */
 /*@}*/