Avoided ABI breakage
[openjpeg.git] / indexer_JPIP / pi.h
1 /*
2  * Copyright (c) 2001-2002, David Janssens
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef __PI_H
28 #define __PI_H
29
30 #include "j2k.h"
31 #include "tcd.h"
32
33 typedef struct {
34         int pdx, pdy;
35         int pw, ph;
36 } pi_resolution_t;
37
38 typedef struct {
39         int dx, dy;
40         int numresolutions;
41         pi_resolution_t *resolutions;
42 } pi_comp_t;
43
44 typedef struct {
45         short int *include;
46   int step_l, step_r, step_c, step_p; 
47         int compno, resno, precno, layno;       /* component, resolution, precinct and layer that indentify the packet */
48         int first;
49         j2k_poc_t poc;
50         int numcomps;
51         pi_comp_t *comps;
52         int tx0, ty0, tx1, ty1;
53         int x, y, dx, dy;
54 } pi_iterator_t;                                                                /* packet iterator */
55
56 /*
57  * Create a packet iterator
58  * img: raw image for which the packets will be listed
59  * cp: coding paremeters
60  * tileno: number that identifies the tile for which to list the packets
61  * return value: returns a packet iterator that points to the first packet of the tile
62  */
63 pi_iterator_t *pi_create(j2k_image_t * img, j2k_cp_t * cp, int tileno);
64
65 /* 
66  * Modify the packet iterator to point to the next packet
67  * pi: packet iterator to modify
68  * return value: returns 0 if pi pointed to the last packet or else returns 1 
69  */
70 int pi_next(pi_iterator_t * pi);
71
72 #endif