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
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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.
36 @brief Implementation of a packet iterator (PI)
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.
43 /** @defgroup PI PI - Implementation of a packet iterator */
49 typedef struct opj_pi_resolution {
52 } opj_pi_resolution_t;
57 typedef struct opj_pi_comp {
59 /** number of resolution levels */
61 opj_pi_resolution_t *resolutions;
67 typedef struct opj_pi_iterator {
68 /** Enabling Tile part generation*/
70 /** precise if the packet has been already used (usefull for progression order change) */
72 /** layer step used to localize the packet in the include vector */
74 /** resolution step used to localize the packet in the include vector */
76 /** component step used to localize the packet in the include vector */
78 /** precinct step used to localize the packet in the include vector */
80 /** component that identify the packet */
82 /** resolution that identify the packet */
84 /** precinct that identify the packet */
86 /** layer that identify the packet */
88 /** 0 if the first packet */
90 /** progression order change information */
92 /** number of components in the image */
96 int tx0, ty0, tx1, ty1;
100 /** @name Exported functions */
102 /* ----------------------------------------------------------------------- */
104 Create a packet iterator for Encoder
105 @param image Raw image for which the packets will be listed
106 @param cp Coding parameters
107 @param tileno Number that identifies the tile for which to list the packets
108 @param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass
109 @return Returns a packet iterator that points to the first packet of the tile
112 opj_pi_iterator_t *pi_initialise_encode(opj_image_t *image, opj_cp_t *cp, int tileno,J2K_T2_MODE t2_mode);
114 Modify the packet iterator for enabling tile part generation
115 @param pi Handle to the packet iterator generated in pi_initialise_encode
116 @param cp Coding parameters
117 @param tileno Number that identifies the tile for which to list the packets
118 @param pino Iterator index for pi
119 @param tpnum Tile part number of the current tile
120 @param tppos The position of the tile part flag in the progression order
121 @param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass
122 @param cur_totnum_tp The total number of tile parts in the current tile
123 @return Returns true if an error is detected
125 opj_bool pi_create_encode(opj_pi_iterator_t *pi, opj_cp_t *cp,int tileno, int pino,int tpnum, int tppos, J2K_T2_MODE t2_mode,int cur_totnum_tp);
127 Create a packet iterator for Decoder
128 @param image Raw image for which the packets will be listed
129 @param cp Coding parameters
130 @param tileno Number that identifies the tile for which to list the packets
131 @return Returns a packet iterator that points to the first packet of the tile
134 opj_pi_iterator_t *pi_create_decode(opj_image_t * image, opj_cp_t * cp, int tileno);
138 Create a packet iterator for Decoder
139 @param image Raw image for which the packets will be listed
140 @param cp Coding parameters
141 @param tileno Number that identifies the tile for which to list the packets
142 @return Returns a packet iterator that points to the first packet of the tile
145 opj_pi_iterator_t *pi_create_decode_v2(struct opj_image_header * image, struct opj_cp_v2 * cp, OPJ_UINT32 tileno);
149 Destroy a packet iterator
150 @param pi Previously created packet iterator
151 @param cp Coding parameters
152 @param tileno Number that identifies the tile for which the packets were listed
155 void pi_destroy(opj_pi_iterator_t *pi, opj_cp_t *cp, int tileno);
159 * Destroys a packet iterator array.
161 * @param p_pi the packet iterator array to destroy.
162 * @param p_nb_elements the number of elements in the array.
165 opj_pi_iterator_t *p_pi,
166 OPJ_UINT32 p_nb_elements);
169 Modify the packet iterator to point to the next packet
170 @param pi Packet iterator to modify
171 @return Returns false if pi pointed to the last packet or else returns true
173 opj_bool pi_next(opj_pi_iterator_t * pi);
174 /* ----------------------------------------------------------------------- */