src/lib/openjp2/pi.h

   1 /*
   2  * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
   3  * Copyright (c) 2002-2007, Professor Benoit Macq
   4  * Copyright (c) 2001-2003, David Janssens
   5  * Copyright (c) 2002-2003, Yannick Verschueren
   6  * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
   7  * Copyright (c) 2005, Herve Drolon, FreeImage Team
   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 FIXME DOC
  48 */
  49 typedef struct opj_pi_resolution {
  50   OPJ_UINT32 pdx, pdy;
  51   OPJ_UINT32 pw, ph;
  52 } opj_pi_resolution_t;
  53
  54 /**
  55 FIXME DOC
  56 */
  57 typedef struct opj_pi_comp {
  58   OPJ_UINT32 dx, dy;
  59   /** number of resolution levels */
  60   OPJ_UINT32 numresolutions;
  61   opj_pi_resolution_t *resolutions;
  62 } opj_pi_comp_t;
  63
  64 /**
  65 Packet iterator
  66 */
  67 typedef struct opj_pi_iterator {
  68         /** Enabling Tile part generation*/
  69         OPJ_BYTE tp_on;
  70         /** precise if the packet has been already used (usefull for progression order change) */
  71         OPJ_INT16 *include;
  72         /** layer step used to localize the packet in the include vector */
  73         OPJ_UINT32 step_l;
  74         /** resolution step used to localize the packet in the include vector */
  75         OPJ_UINT32 step_r;
  76         /** component step used to localize the packet in the include vector */
  77         OPJ_UINT32 step_c;
  78         /** precinct step used to localize the packet in the include vector */
  79         OPJ_UINT32 step_p;
  80         /** component that identify the packet */
  81         OPJ_UINT32 compno;
  82         /** resolution that identify the packet */
  83         OPJ_UINT32 resno;
  84         /** precinct that identify the packet */
  85         OPJ_UINT32 precno;
  86         /** layer that identify the packet */
  87         OPJ_UINT32 layno;
  88         /** 0 if the first packet TODO MSD xhange to opj_bool*/
  89         int first;
  90         /** progression order change information */
  91         opj_poc_t poc;
  92         /** number of components in the image */
  93         OPJ_UINT32 numcomps;
  94         /** Components*/
  95         opj_pi_comp_t *comps;
  96     /** FIXME DOC*/
  97         OPJ_INT32 tx0, ty0, tx1, ty1;
  98     /** FIXME DOC*/
  99         OPJ_INT32 x, y;
 100     /** FIXME DOC*/
 101     OPJ_UINT32 dx, dy;
 102 } opj_pi_iterator_t;
 103
 104 /** @name Exported functions */
 105 /*@{*/
 106 /* ----------------------------------------------------------------------- */
 107 /**
 108  * Creates a packet iterator for encoding.
 109  *
 110  * @param       image           the image being encoded.
 111  * @param       cp              the coding parameters.
 112  * @param       tileno  index of the tile being encoded.
 113  * @param       t2_mode the type of pass for generating the packet iterator
 114  *
 115  * @return      a list of packet iterator that points to the first packet of the tile (not true).
 116 */
 117 opj_pi_iterator_t *opj_pi_initialise_encode(const opj_image_t *image,
 118                                             opj_cp_t *cp,
 119                                             OPJ_UINT32 tileno,
 120                                             J2K_T2_MODE t2_mode);
 121
 122 /**
 123  * Updates the encoding parameters of the codec.
 124  *
 125  * @param       p_image         the image being encoded.
 126  * @param       p_cp            the coding parameters.
 127  * @param       p_tile_no       index of the tile being encoded.
 128 */
 129 void opj_pi_update_encoding_parameters( const opj_image_t *p_image,
 130                                         opj_cp_t *p_cp,
 131                                         OPJ_UINT32 p_tile_no );
 132
 133 /**
 134 Modify the packet iterator for enabling tile part generation
 135 @param pi Handle to the packet iterator generated in pi_initialise_encode
 136 @param cp Coding parameters
 137 @param tileno Number that identifies the tile for which to list the packets
 138 @param pino   FIXME DOC
 139 @param tpnum Tile part number of the current tile
 140 @param tppos The position of the tile part flag in the progression order
 141 @param t2_mode FIXME DOC
 142 */
 143 void opj_pi_create_encode(  opj_pi_iterator_t *pi,
 144                             opj_cp_t *cp,
 145                             OPJ_UINT32 tileno,
 146                             OPJ_UINT32 pino,
 147                             OPJ_UINT32 tpnum,
 148                             OPJ_INT32 tppos,
 149                             J2K_T2_MODE t2_mode);
 150
 151 /**
 152 Create a packet iterator for Decoder
 153 @param image Raw image for which the packets will be listed
 154 @param cp Coding parameters
 155 @param tileno Number that identifies the tile for which to list the packets
 156 @return Returns a packet iterator that points to the first packet of the tile
 157 @see opj_pi_destroy
 158 */
 159 opj_pi_iterator_t *opj_pi_create_decode(opj_image_t * image,
 160                                         opj_cp_t * cp,
 161                                         OPJ_UINT32 tileno);
 162 /**
 163  * Destroys a packet iterator array.
 164  *
 165  * @param       p_pi                    the packet iterator array to destroy.
 166  * @param       p_nb_elements   the number of elements in the array.
 167  */
 168 void opj_pi_destroy(opj_pi_iterator_t *p_pi,
 169                     OPJ_UINT32 p_nb_elements);
 170
 171 /**
 172 Modify the packet iterator to point to the next packet
 173 @param pi Packet iterator to modify
 174 @return Returns false if pi pointed to the last packet or else returns true
 175 */
 176 opj_bool opj_pi_next(opj_pi_iterator_t * pi);
 177 /* ----------------------------------------------------------------------- */
 178 /*@}*/
 179
 180 /*@}*/
 181
 182 #endif /* __PI_H */