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.
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.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
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.
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.
42 @brief Implementation of a packet iterator (PI)
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.
49 /** @defgroup PI PI - Implementation of a packet iterator */
55 typedef struct opj_pi_resolution {
58 } opj_pi_resolution_t;
63 typedef struct opj_pi_comp {
65 /** number of resolution levels */
66 OPJ_UINT32 numresolutions;
67 opj_pi_resolution_t *resolutions;
73 typedef struct opj_pi_iterator {
74 /** Enabling Tile part generation*/
76 /** precise if the packet has been already used (useful for progression order change) */
78 /** Number of elements in include array */
79 OPJ_UINT32 include_size;
80 /** layer step used to localize the packet in the include vector */
82 /** resolution step used to localize the packet in the include vector */
84 /** component step used to localize the packet in the include vector */
86 /** precinct step used to localize the packet in the include vector */
88 /** component that identify the packet */
90 /** resolution that identify the packet */
92 /** precinct that identify the packet */
94 /** layer that identify the packet */
96 /** 0 if the first packet */
98 /** progression order change information */
100 /** number of components in the image */
103 opj_pi_comp_t *comps;
105 OPJ_INT32 tx0, ty0, tx1, ty1;
112 /** @name Exported functions */
114 /* ----------------------------------------------------------------------- */
116 * Creates a packet iterator for encoding.
118 * @param image the image being encoded.
119 * @param cp the coding parameters.
120 * @param tileno index of the tile being encoded.
121 * @param t2_mode the type of pass for generating the packet iterator
123 * @return a list of packet iterator that points to the first packet of the tile (not true).
125 opj_pi_iterator_t *opj_pi_initialise_encode(const opj_image_t *image,
128 J2K_T2_MODE t2_mode);
131 * Updates the encoding parameters of the codec.
133 * @param p_image the image being encoded.
134 * @param p_cp the coding parameters.
135 * @param p_tile_no index of the tile being encoded.
137 void opj_pi_update_encoding_parameters(const opj_image_t *p_image,
139 OPJ_UINT32 p_tile_no);
142 Modify the packet iterator for enabling tile part generation
143 @param pi Handle to the packet iterator generated in pi_initialise_encode
144 @param cp Coding parameters
145 @param tileno Number that identifies the tile for which to list the packets
146 @param pino FIXME DOC
147 @param tpnum Tile part number of the current tile
148 @param tppos The position of the tile part flag in the progression order
149 @param t2_mode FIXME DOC
151 void opj_pi_create_encode(opj_pi_iterator_t *pi,
157 J2K_T2_MODE t2_mode);
160 Create a packet iterator for Decoder
161 @param image Raw image for which the packets will be listed
162 @param cp Coding parameters
163 @param tileno Number that identifies the tile for which to list the packets
164 @return Returns a packet iterator that points to the first packet of the tile
167 opj_pi_iterator_t *opj_pi_create_decode(opj_image_t * image,
171 * Destroys a packet iterator array.
173 * @param p_pi the packet iterator array to destroy.
174 * @param p_nb_elements the number of elements in the array.
176 void opj_pi_destroy(opj_pi_iterator_t *p_pi,
177 OPJ_UINT32 p_nb_elements);
180 Modify the packet iterator to point to the next packet
181 @param pi Packet iterator to modify
182 @return Returns false if pi pointed to the last packet or else returns true
184 OPJ_BOOL opj_pi_next(opj_pi_iterator_t * pi);
185 /* ----------------------------------------------------------------------- */
190 #endif /* OPJ_PI_H */