src/lib/openjp3d/pi.h

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