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