src/gdcmopenjpeg/libopenjpeg/pi.h

   1 /*\r
   2  * Copyright (c) 2001-2003, David Janssens\r
   3  * Copyright (c) 2002-2003, Yannick Verschueren\r
   4  * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe\r
   5  * Copyright (c) 2005, Hervé Drolon, FreeImage Team\r
   6  * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium\r
   7  * All rights reserved.\r
   8  *\r
   9  * Redistribution and use in source and binary forms, with or without\r
  10  * modification, are permitted provided that the following conditions\r
  11  * are met:\r
  12  * 1. Redistributions of source code must retain the above copyright\r
  13  *    notice, this list of conditions and the following disclaimer.\r
  14  * 2. Redistributions in binary form must reproduce the above copyright\r
  15  *    notice, this list of conditions and the following disclaimer in the\r
  16  *    documentation and/or other materials provided with the distribution.\r
  17  *\r
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'\r
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE\r
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
  28  * POSSIBILITY OF SUCH DAMAGE.\r
  29  */\r
  30 \r
  31 #ifndef __PI_H\r
  32 #define __PI_H\r
  33 /**\r
  34 @file pi.h\r
  35 @brief Implementation of a packet iterator (PI)\r
  36 \r
  37 The functions in PI.C have for goal to realize a packet iterator that permits to get the next\r
  38 packet following the progression order and change of it. The functions in PI.C are used\r
  39 by some function in T2.C.\r
  40 */\r
  41 \r
  42 /** @defgroup PI PI - Implementation of a packet iterator */\r
  43 /*@{*/\r
  44 \r
  45 /**\r
  46 FIXME: documentation\r
  47 */\r
  48 typedef struct opj_pi_resolution {\r
  49   int pdx, pdy;\r
  50   int pw, ph;\r
  51 } opj_pi_resolution_t;\r
  52 \r
  53 /**\r
  54 FIXME: documentation\r
  55 */\r
  56 typedef struct opj_pi_comp {\r
  57   int dx, dy;\r
  58   /** number of resolution levels */\r
  59   int numresolutions;\r
  60   opj_pi_resolution_t *resolutions;\r
  61 } opj_pi_comp_t;\r
  62 \r
  63 /** \r
  64 Packet iterator \r
  65 */\r
  66 typedef struct opj_pi_iterator {\r
  67   /** precise if the packet has been already used (usefull for progression order change) */\r
  68   short int *include;\r
  69   /** layer step used to localize the packet in the include vector */\r
  70   int step_l;\r
  71   /** resolution step used to localize the packet in the include vector */\r
  72   int step_r;  \r
  73   /** component step used to localize the packet in the include vector */\r
  74   int step_c;  \r
  75   /** precinct step used to localize the packet in the include vector */\r
  76   int step_p;  \r
  77   /** component that identify the packet */\r
  78   int compno;\r
  79   /** resolution that identify the packet */\r
  80   int resno;\r
  81   /** precinct that identify the packet */\r
  82   int precno;\r
  83   /** layer that identify the packet */\r
  84   int layno;   \r
  85   /** 0 if the first packet */\r
  86   int first;\r
  87   /** progression order change information */\r
  88   opj_poc_t poc;\r
  89   /** */\r
  90   int numcomps;\r
  91   /** */\r
  92   opj_pi_comp_t *comps;\r
  93   int tx0, ty0, tx1, ty1;\r
  94   int x, y, dx, dy;\r
  95 } opj_pi_iterator_t;\r
  96 \r
  97 /** @name Exported functions */\r
  98 /*@{*/\r
  99 /* ----------------------------------------------------------------------- */\r
 100 /**\r
 101 Create a packet iterator\r
 102 @param image Raw image for which the packets will be listed\r
 103 @param cp Coding parameters\r
 104 @param tileno Number that identifies the tile for which to list the packets\r
 105 @return Returns a packet iterator that points to the first packet of the tile\r
 106 @see pi_destroy\r
 107 */\r
 108 opj_pi_iterator_t *pi_create(opj_image_t * image, opj_cp_t * cp, int tileno);\r
 109 \r
 110 /**\r
 111 Destroy a packet iterator\r
 112 @param pi Previously created packet iterator\r
 113 @param cp Coding parameters\r
 114 @param tileno Number that identifies the tile for which the packets were listed\r
 115 @see pi_create\r
 116 */\r
 117 void pi_destroy(opj_pi_iterator_t *pi, opj_cp_t *cp, int tileno);\r
 118 \r
 119 /**\r
 120 Modify the packet iterator to point to the next packet\r
 121 @param pi Packet iterator to modify\r
 122 @return Returns false if pi pointed to the last packet or else returns true \r
 123 */\r
 124 bool pi_next(opj_pi_iterator_t * pi);\r
 125 /* ----------------------------------------------------------------------- */\r
 126 /*@}*/\r
 127 \r
 128 /*@}*/\r
 129 \r
 130 #endif /* __PI_H */\r