src/lib/openmj2/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) 2002-2014, Universite catholique de Louvain (UCL), Belgium
   8  * Copyright (c) 2002-2014, Professor Benoit Macq
   9  * Copyright (c) 2001-2003, David Janssens
  10  * Copyright (c) 2002-2003, Yannick Verschueren
  11  * Copyright (c) 2003-2007, Francois-Olivier Devaux
  12  * Copyright (c) 2003-2014, Antonin Descampe
  13  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  14  * All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  * 1. Redistributions of source code must retain the above copyright
  20  *    notice, this list of conditions and the following disclaimer.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #ifndef __PI_H
  39 #define __PI_H
  40 /**
  41 @file pi.h
  42 @brief Implementation of a packet iterator (PI)
  43
  44 The functions in PI.C have for goal to realize a packet iterator that permits to get the next
  45 packet following the progression order and change of it. The functions in PI.C are used
  46 by some function in T2.C.
  47 */
  48
  49 /** @defgroup PI PI - Implementation of a packet iterator */
  50 /*@{*/
  51
  52 /**
  53 FIXME: documentation
  54 */
  55 typedef struct opj_pi_resolution {
  56     int pdx, pdy;
  57     int pw, ph;
  58 } opj_pi_resolution_t;
  59
  60 /**
  61 FIXME: documentation
  62 */
  63 typedef struct opj_pi_comp {
  64     int dx, dy;
  65     /** number of resolution levels */
  66     int numresolutions;
  67     opj_pi_resolution_t *resolutions;
  68 } opj_pi_comp_t;
  69
  70 /**
  71 Packet iterator
  72 */
  73 typedef struct opj_pi_iterator {
  74     /** Enabling Tile part generation*/
  75     char tp_on;
  76     /** precise if the packet has been already used (useful for progression order change) */
  77     short int *include;
  78     /** layer step used to localize the packet in the include vector */
  79     int step_l;
  80     /** resolution step used to localize the packet in the include vector */
  81     int step_r;
  82     /** component step used to localize the packet in the include vector */
  83     int step_c;
  84     /** precinct step used to localize the packet in the include vector */
  85     int step_p;
  86     /** component that identify the packet */
  87     int compno;
  88     /** resolution that identify the packet */
  89     int resno;
  90     /** precinct that identify the packet */
  91     int precno;
  92     /** layer that identify the packet */
  93     int layno;
  94     /** 0 if the first packet */
  95     int first;
  96     /** progression order change information */
  97     opj_poc_t poc;
  98     /** number of components in the image */
  99     int numcomps;
 100     /** Components*/
 101     opj_pi_comp_t *comps;
 102     int tx0, ty0, tx1, ty1;
 103     int x, y, dx, dy;
 104 } opj_pi_iterator_t;
 105
 106 /** @name Exported functions */
 107 /*@{*/
 108 /* ----------------------------------------------------------------------- */
 109 /**
 110 Create a packet iterator for Encoder
 111 @param image Raw image for which the packets will be listed
 112 @param cp Coding parameters
 113 @param tileno Number that identifies the tile for which to list the packets
 114 @param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass
 115 @return Returns a packet iterator that points to the first packet of the tile
 116 @see pi_destroy
 117 */
 118 opj_pi_iterator_t *pi_initialise_encode(opj_image_t *image, opj_cp_t *cp,
 119                                         int tileno, J2K_T2_MODE t2_mode);
 120 /**
 121 Modify the packet iterator for enabling tile part generation
 122 @param pi Handle to the packet iterator generated in pi_initialise_encode
 123 @param cp Coding parameters
 124 @param tileno Number that identifies the tile for which to list the packets
 125 @param pino Iterator index for pi
 126 @param tpnum Tile part number of the current tile
 127 @param tppos The position of the tile part flag in the progression order
 128 @param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass
 129 @param cur_totnum_tp The total number of tile parts in the current tile
 130 @return Returns true if an error is detected
 131 */
 132 opj_bool pi_create_encode(opj_pi_iterator_t *pi, opj_cp_t *cp, int tileno,
 133                           int pino, int tpnum, int tppos, J2K_T2_MODE t2_mode, int cur_totnum_tp);
 134 /**
 135 Create a packet iterator for Decoder
 136 @param image Raw image for which the packets will be listed
 137 @param cp Coding parameters
 138 @param tileno Number that identifies the tile for which to list the packets
 139 @return Returns a packet iterator that points to the first packet of the tile
 140 @see pi_destroy
 141 */
 142 opj_pi_iterator_t *pi_create_decode(opj_image_t * image, opj_cp_t * cp,
 143                                     int tileno);
 144
 145 /**
 146 Destroy a packet iterator
 147 @param pi Previously created packet iterator
 148 @param cp Coding parameters
 149 @param tileno Number that identifies the tile for which the packets were listed
 150 @see pi_create
 151 */
 152 void pi_destroy(opj_pi_iterator_t *pi, opj_cp_t *cp, int tileno);
 153
 154 /**
 155 Modify the packet iterator to point to the next packet
 156 @param pi Packet iterator to modify
 157 @return Returns false if pi pointed to the last packet or else returns true
 158 */
 159 opj_bool pi_next(opj_pi_iterator_t * pi);
 160 /* ----------------------------------------------------------------------- */
 161 /*@}*/
 162
 163 /*@}*/
 164
 165 #endif /* __PI_H */