src/lib/openjp3d/pi.h

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