OpenJPEG  2.2.0
pi.h
Go to the documentation of this file.
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 OPJ_PI_H
39 #define OPJ_PI_H
40 
51 
55 typedef struct opj_pi_resolution {
59 
63 typedef struct opj_pi_comp {
69 
73 typedef struct opj_pi_iterator {
111 
114 /* ----------------------------------------------------------------------- */
126  opj_cp_t *cp,
127  OPJ_UINT32 tileno,
128  J2K_T2_MODE t2_mode);
129 
138  opj_cp_t *p_cp,
139  OPJ_UINT32 p_tile_no);
140 
152  opj_cp_t *cp,
153  OPJ_UINT32 tileno,
154  OPJ_UINT32 pino,
155  OPJ_UINT32 tpnum,
156  OPJ_INT32 tppos,
157  J2K_T2_MODE t2_mode);
158 
168  opj_cp_t * cp,
169  OPJ_UINT32 tileno);
177  OPJ_UINT32 p_nb_elements);
178 
185 /* ----------------------------------------------------------------------- */
189 
190 #endif /* OPJ_PI_H */
opj_pi_comp_t * comps
Components.
Definition: pi.h:103
OPJ_INT32 ty0
Definition: pi.h:105
OPJ_UINT32 precno
precinct that identify the packet
Definition: pi.h:93
enum T2_MODE J2K_T2_MODE
T2 encoding mode.
OPJ_UINT32 include_size
Number of elements in include array.
Definition: pi.h:79
Progression order changes.
Definition: openjpeg.h:325
int OPJ_BOOL
Definition: openjpeg.h:110
FIXME DOC.
Definition: pi.h:63
OPJ_UINT32 step_c
component step used to localize the packet in the include vector
Definition: pi.h:85
unsigned char OPJ_BYTE
Definition: openjpeg.h:117
opj_pi_iterator_t * opj_pi_create_decode(opj_image_t *image, opj_cp_t *cp, OPJ_UINT32 tileno)
Create a packet iterator for Decoder.
Definition: pi.c:1350
OPJ_UINT32 dy
Definition: pi.h:64
struct opj_pi_resolution opj_pi_resolution_t
FIXME DOC.
int32_t OPJ_INT32
Definition: openjpeg.h:125
OPJ_UINT32 compno
component that identify the packet
Definition: pi.h:89
OPJ_INT16 * include
precise if the packet has been already used (useful for progression order change) ...
Definition: pi.h:77
Packet iterator.
Definition: pi.h:73
OPJ_UINT32 pw
Definition: pi.h:57
struct opj_pi_comp opj_pi_comp_t
FIXME DOC.
OPJ_UINT32 numcomps
number of components in the image
Definition: pi.h:101
Defines image data and characteristics.
Definition: openjpeg.h:666
OPJ_INT32 x
FIXME DOC.
Definition: pi.h:107
OPJ_INT32 y
Definition: pi.h:107
OPJ_UINT32 numresolutions
number of resolution levels
Definition: pi.h:66
OPJ_UINT32 resno
resolution that identify the packet
Definition: pi.h:91
FIXME DOC.
Definition: pi.h:55
OPJ_INT32 ty1
Definition: pi.h:105
opj_pi_resolution_t * resolutions
Definition: pi.h:67
OPJ_BOOL opj_pi_next(opj_pi_iterator_t *pi)
Modify the packet iterator to point to the next packet.
Definition: pi.c:2068
OPJ_UINT32 step_r
resolution step used to localize the packet in the include vector
Definition: pi.h:83
OPJ_UINT32 pdy
Definition: pi.h:56
OPJ_BYTE tp_on
Enabling Tile part generation.
Definition: pi.h:75
opj_poc_t poc
progression order change information
Definition: pi.h:99
OPJ_UINT32 pdx
Definition: pi.h:56
OPJ_INT32 tx1
Definition: pi.h:105
Coding parameters.
Definition: j2k.h:345
int16_t OPJ_INT16
Definition: openjpeg.h:123
OPJ_UINT32 step_p
precinct step used to localize the packet in the include vector
Definition: pi.h:87
struct opj_pi_iterator opj_pi_iterator_t
Packet iterator.
OPJ_UINT32 layno
layer that identify the packet
Definition: pi.h:95
OPJ_UINT32 dy
Definition: pi.h:109
OPJ_UINT32 ph
Definition: pi.h:57
void opj_pi_destroy(opj_pi_iterator_t *p_pi, OPJ_UINT32 p_nb_elements)
Destroys a packet iterator array.
Definition: pi.c:2003
void opj_pi_update_encoding_parameters(const opj_image_t *p_image, opj_cp_t *p_cp, OPJ_UINT32 p_tile_no)
Updates the encoding parameters of the codec.
Definition: pi.c:2035
uint32_t OPJ_UINT32
Definition: openjpeg.h:126
OPJ_INT32 tx0
FIXME DOC.
Definition: pi.h:105
OPJ_UINT32 dx
Definition: pi.h:64
OPJ_UINT32 step_l
layer step used to localize the packet in the include vector
Definition: pi.h:81
opj_pi_iterator_t * opj_pi_initialise_encode(const opj_image_t *image, opj_cp_t *cp, OPJ_UINT32 tileno, J2K_T2_MODE t2_mode)
Creates a packet iterator for encoding.
Definition: pi.c:1549
void opj_pi_create_encode(opj_pi_iterator_t *pi, opj_cp_t *cp, OPJ_UINT32 tileno, OPJ_UINT32 pino, OPJ_UINT32 tpnum, OPJ_INT32 tppos, J2K_T2_MODE t2_mode)
Modify the packet iterator for enabling tile part generation.
Definition: pi.c:1741
OPJ_UINT32 dx
FIXME DOC.
Definition: pi.h:109
OPJ_BOOL first
0 if the first packet
Definition: pi.h:97