OpenJPEG: pi.h Source File

OpenJPEG 2.5.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
51
55 typedef struct opj_pi_resolution {
56 OPJ_UINT32 pdx, pdy;
57 OPJ_UINT32 pw, ph;
58} opj_pi_resolution_t;
59
63 typedef struct opj_pi_comp {
64 OPJ_UINT32 dx, dy;
66 OPJ_UINT32 numresolutions;
67 opj_pi_resolution_t *resolutions;
68} opj_pi_comp_t;
69
73 typedef struct opj_pi_iterator {
75 OPJ_BYTE tp_on;
77 OPJ_INT16 *include;
79 OPJ_UINT32 include_size;
81 OPJ_UINT32 step_l;
83 OPJ_UINT32 step_r;
85 OPJ_UINT32 step_c;
87 OPJ_UINT32 step_p;
89 OPJ_UINT32 compno;
91 OPJ_UINT32 resno;
93 OPJ_UINT32 precno;
95 OPJ_UINT32 layno;
97 OPJ_BOOL first;
99 opj_poc_t poc;
101 OPJ_UINT32 numcomps;
103 opj_pi_comp_t *comps;
105 OPJ_UINT32 tx0, ty0, tx1, ty1;
107 OPJ_UINT32 x, y;
109 OPJ_UINT32 dx, dy;
111 opj_event_mgr_t* manager;
112} opj_pi_iterator_t;
113
116/* ----------------------------------------------------------------------- */
128 opj_pi_iterator_t *opj_pi_initialise_encode(const opj_image_t *image,
129 opj_cp_t *cp,
130 OPJ_UINT32 tileno,
131 J2K_T2_MODE t2_mode,
132 opj_event_mgr_t* manager);
133
141void opj_pi_update_encoding_parameters(const opj_image_t *p_image,
142 opj_cp_t *p_cp,
143 OPJ_UINT32 p_tile_no);
144
155void opj_pi_create_encode(opj_pi_iterator_t *pi,
156 opj_cp_t *cp,
157 OPJ_UINT32 tileno,
158 OPJ_UINT32 pino,
159 OPJ_UINT32 tpnum,
160 OPJ_INT32 tppos,
161 J2K_T2_MODE t2_mode);
162
172 opj_pi_iterator_t *opj_pi_create_decode(opj_image_t * image,
173 opj_cp_t * cp,
174 OPJ_UINT32 tileno,
175 opj_event_mgr_t* manager);
182void opj_pi_destroy(opj_pi_iterator_t *p_pi,
183 OPJ_UINT32 p_nb_elements);
184
190 OPJ_BOOL opj_pi_next(opj_pi_iterator_t * pi);
191
198 OPJ_UINT32 opj_get_encoding_packet_count(const opj_image_t *p_image,
199 const opj_cp_t *p_cp,
200 OPJ_UINT32 p_tile_no);
201
202/* ----------------------------------------------------------------------- */
206
207#endif /* OPJ_PI_H */
J2K_T2_MODE
enum T2_MODE J2K_T2_MODE
T2 encoding mode.
OPJ_BYTE
unsigned char OPJ_BYTE
Definition: openjpeg.h:123
OPJ_INT32
int32_t OPJ_INT32
Definition: openjpeg.h:131
OPJ_UINT32
uint32_t OPJ_UINT32
Definition: openjpeg.h:132
OPJ_INT16
int16_t OPJ_INT16
Definition: openjpeg.h:129
OPJ_BOOL
int OPJ_BOOL
Definition: openjpeg.h:116
opj_pi_iterator_t
struct opj_pi_iterator opj_pi_iterator_t
Packet iterator.
opj_pi_update_encoding_parameters
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:2103
opj_pi_comp_t
struct opj_pi_comp opj_pi_comp_t
FIXME DOC.
opj_pi_destroy
void opj_pi_destroy(opj_pi_iterator_t *p_pi, OPJ_UINT32 p_nb_elements)
Destroys a packet iterator array.
Definition: pi.c:2071
opj_pi_next
OPJ_BOOL opj_pi_next(opj_pi_iterator_t *pi)
Modify the packet iterator to point to the next packet.
Definition: pi.c:2136
opj_get_encoding_packet_count
OPJ_UINT32 opj_get_encoding_packet_count(const opj_image_t *p_image, const opj_cp_t *p_cp, OPJ_UINT32 p_tile_no)
Return the number of packets in the tile.
Definition: pi.c:1592
opj_pi_resolution_t
struct opj_pi_resolution opj_pi_resolution_t
FIXME DOC.
opj_pi_initialise_encode
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, opj_event_mgr_t *manager)
Creates a packet iterator for encoding.
Definition: pi.c:1615
opj_pi_create_encode
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:1808
opj_pi_create_decode
opj_pi_iterator_t * opj_pi_create_decode(opj_image_t *image, opj_cp_t *cp, OPJ_UINT32 tileno, opj_event_mgr_t *manager)
Create a packet iterator for Decoder.
Definition: pi.c:1393
opj_cp
Coding parameters.
Definition: j2k.h:351
opj_event_mgr
Message handler object used for.
Definition: event.h:50
opj_image
Defines image data and characteristics.
Definition: openjpeg.h:709
opj_pi_comp
FIXME DOC.
Definition: pi.h:63
opj_pi_comp::resolutions
opj_pi_resolution_t * resolutions
Definition: pi.h:67
opj_pi_comp::dx
OPJ_UINT32 dx
Definition: pi.h:64
opj_pi_comp::numresolutions
OPJ_UINT32 numresolutions
number of resolution levels
Definition: pi.h:66
opj_pi_comp::dy
OPJ_UINT32 dy
Definition: pi.h:64
opj_pi_iterator
Packet iterator.
Definition: pi.h:73
opj_pi_iterator::step_p
OPJ_UINT32 step_p
precinct step used to localize the packet in the include vector
Definition: pi.h:87
opj_pi_iterator::dx
OPJ_UINT32 dx
FIXME DOC.
Definition: pi.h:109
opj_pi_iterator::precno
OPJ_UINT32 precno
precinct that identify the packet
Definition: pi.h:93
opj_pi_iterator::compno
OPJ_UINT32 compno
component that identify the packet
Definition: pi.h:89
opj_pi_iterator::step_l
OPJ_UINT32 step_l
layer step used to localize the packet in the include vector
Definition: pi.h:81
opj_pi_iterator::numcomps
OPJ_UINT32 numcomps
number of components in the image
Definition: pi.h:101
opj_pi_iterator::first
OPJ_BOOL first
0 if the first packet
Definition: pi.h:97
opj_pi_iterator::tx1
OPJ_UINT32 tx1
Definition: pi.h:105
opj_pi_iterator::resno
OPJ_UINT32 resno
resolution that identify the packet
Definition: pi.h:91
opj_pi_iterator::dy
OPJ_UINT32 dy
Definition: pi.h:109
opj_pi_iterator::y
OPJ_UINT32 y
Definition: pi.h:107
opj_pi_iterator::ty0
OPJ_UINT32 ty0
Definition: pi.h:105
opj_pi_iterator::comps
opj_pi_comp_t * comps
Components.
Definition: pi.h:103
opj_pi_iterator::tp_on
OPJ_BYTE tp_on
Enabling Tile part generation.
Definition: pi.h:75
opj_pi_iterator::step_r
OPJ_UINT32 step_r
resolution step used to localize the packet in the include vector
Definition: pi.h:83
opj_pi_iterator::manager
opj_event_mgr_t * manager
event manager
Definition: pi.h:111
opj_pi_iterator::include_size
OPJ_UINT32 include_size
Number of elements in include array.
Definition: pi.h:79
opj_pi_iterator::x
OPJ_UINT32 x
FIXME DOC.
Definition: pi.h:107
opj_pi_iterator::poc
opj_poc_t poc
progression order change information
Definition: pi.h:99
opj_pi_iterator::include
OPJ_INT16 * include
precise if the packet has been already used (useful for progression order change)
Definition: pi.h:77
opj_pi_iterator::step_c
OPJ_UINT32 step_c
component step used to localize the packet in the include vector
Definition: pi.h:85
opj_pi_iterator::ty1
OPJ_UINT32 ty1
Definition: pi.h:105
opj_pi_iterator::tx0
OPJ_UINT32 tx0
FIXME DOC.
Definition: pi.h:105
opj_pi_iterator::layno
OPJ_UINT32 layno
layer that identify the packet
Definition: pi.h:95
opj_pi_resolution
FIXME DOC.
Definition: pi.h:55
opj_pi_resolution::pdy
OPJ_UINT32 pdy
Definition: pi.h:56
opj_pi_resolution::pdx
OPJ_UINT32 pdx
Definition: pi.h:56
opj_pi_resolution::pw
OPJ_UINT32 pw
Definition: pi.h:57
opj_pi_resolution::ph
OPJ_UINT32 ph
Definition: pi.h:57
opj_poc
Progression order changes.
Definition: openjpeg.h:365