OpenJPEG: index_manager.h Source File

OpenJPEG 2.5.0

index_manager.h
Go to the documentation of this file.
1/*
2 * $Id$
3 *
4 * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
5 * Copyright (c) 2002-2014, Professor Benoit Macq
6 * Copyright (c) 2010-2011, Kaori Hagihara
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef INDEX_MANAGER_H_
32# define INDEX_MANAGER_H_
33
34#include "opj_config.h"
35#include "opj_includes.h"
36
37#include "byte_manager.h"
38#include "faixbox_manager.h"
39#include "metadata_manager.h"
40#include "mhixbox_manager.h"
41
43#if 0
44typedef enum porder {
45 PROG_UNKNOWN = -1,
46 LRCP = 0,
47 RLCP = 1,
48 RPCL = 2,
49 PCRL = 3,
50 CPRL = 4
51} porder_t;
52#endif
53
55 typedef struct SIZmarker_param {
56 Byte2_t Lsiz;
57 Byte2_t Rsiz;
58 Byte4_t Xsiz;
59 Byte4_t Ysiz;
60 Byte4_t XOsiz;
61 Byte4_t YOsiz;
62 Byte4_t XTsiz;
63 Byte4_t YTsiz;
64 Byte4_t XTOsiz;
65 Byte4_t YTOsiz;
66 Byte4_t XTnum;
67 Byte4_t YTnum;
68 Byte2_t Csiz;
69 Byte_t Ssiz[3];
70 Byte_t XRsiz[3];
71 Byte_t YRsiz[3];
72} SIZmarker_param_t;
73
75 typedef struct CODmarker_param {
76 Byte2_t Lcod;
77 Byte_t Scod;
78 OPJ_PROG_ORDER prog_order;
79 Byte2_t numOflayers;
80 Byte_t numOfdecomp;
81 Byte4_t *XPsiz;
82 Byte4_t *YPsiz;
83} CODmarker_param_t;
84
86 typedef struct index_param {
87 metadatalist_param_t *metadatalist;
88 OPJ_OFF_T offset;
89 Byte8_t length;
90 Byte8_t mhead_length;
91 SIZmarker_param_t SIZ;
92 CODmarker_param_t COD;
93 faixbox_param_t *tilepart;
94 mhixbox_param_t
95 **tileheader;
96 faixbox_param_t
97 **precpacket;
98} index_param_t;
99
100
108 index_param_t * parse_jp2file(int fd);
109
115void print_index(index_param_t index);
116
122void print_SIZ(SIZmarker_param_t SIZ);
123
129void print_COD(CODmarker_param_t COD);
130
136void delete_index(index_param_t **index);
137
143void delete_COD(CODmarker_param_t COD);
144
145
147 typedef struct range_param {
148 Byte4_t minvalue;
149 Byte4_t maxvalue;
150} range_param_t;
151
160 range_param_t get_tile_Xrange(SIZmarker_param_t SIZ, Byte4_t tile_id,
161 int level);
162
171 range_param_t get_tile_Yrange(SIZmarker_param_t SIZ, Byte4_t tile_id,
172 int level);
173
174
183 Byte4_t get_tile_XSiz(SIZmarker_param_t SIZ, Byte4_t tile_id, int level);
184 Byte4_t get_tile_YSiz(SIZmarker_param_t SIZ, Byte4_t tile_id, int level);
185
186
193 OPJ_BOOL isJPTfeasible(index_param_t index);
194
195#endif /* !INDEX_MANAGER_H_ */
byte_manager.h
Byte2_t
uint16_t Byte2_t
Definition: byte_manager.h:38
Byte8_t
uint64_t Byte8_t
Definition: byte_manager.h:40
Byte4_t
uint32_t Byte4_t
Definition: byte_manager.h:39
Byte_t
uint8_t Byte_t
Definition: byte_manager.h:37
faixbox_manager.h
delete_COD
void delete_COD(CODmarker_param_t COD)
delete dynamic arrays in COD marker
Definition: index_manager.c:215
print_SIZ
void print_SIZ(SIZmarker_param_t SIZ)
print Image and Tile SIZ parameters
Definition: index_manager.c:151
range_param_t
struct range_param range_param_t
1-dimensional range parameters
get_tile_Xrange
range_param_t get_tile_Xrange(SIZmarker_param_t SIZ, Byte4_t tile_id, int level)
get horizontal range of the tile in reference grid
Definition: index_manager.c:729
get_tile_XSiz
Byte4_t get_tile_XSiz(SIZmarker_param_t SIZ, Byte4_t tile_id, int level)
get tile wdith at the decomposition level
Definition: index_manager.c:757
delete_index
void delete_index(index_param_t **index)
delete index
Definition: index_manager.c:192
get_tile_YSiz
Byte4_t get_tile_YSiz(SIZmarker_param_t SIZ, Byte4_t tile_id, int level)
Definition: index_manager.c:765
index_param_t
struct index_param index_param_t
index parameters
print_COD
void print_COD(CODmarker_param_t COD)
print Coding style default COD parameters
Definition: index_manager.c:175
get_tile_Yrange
range_param_t get_tile_Yrange(SIZmarker_param_t SIZ, Byte4_t tile_id, int level)
get vertical range of the tile in reference grid
Definition: index_manager.c:735
print_index
void print_index(index_param_t index)
print index parameters
Definition: index_manager.c:122
isJPTfeasible
OPJ_BOOL isJPTfeasible(index_param_t index)
answers if the target is feasible to JPT-stream
Definition: index_manager.c:792
SIZmarker_param_t
struct SIZmarker_param SIZmarker_param_t
progression order
CODmarker_param_t
struct CODmarker_param CODmarker_param_t
A.6.1 Coding style default (COD)
parse_jp2file
index_param_t * parse_jp2file(int fd)
parse JP2 file AnnexI: Indexing JPEG2000 files for JPIP
Definition: index_manager.c:73
metadata_manager.h
mhixbox_manager.h
OPJ_PROG_ORDER
enum PROG_ORDER OPJ_PROG_ORDER
Progression order.
OPJ_OFF_T
int64_t OPJ_OFF_T
Definition: openjpeg.h:136
OPJ_BOOL
int OPJ_BOOL
Definition: openjpeg.h:116
opj_includes.h
CODmarker_param
A.6.1 Coding style default (COD)
Definition: index_manager.h:75
CODmarker_param::numOflayers
Byte2_t numOflayers
number of layers
Definition: index_manager.h:79
CODmarker_param::Scod
Byte_t Scod
Coding style for all components.
Definition: index_manager.h:77
CODmarker_param::prog_order
OPJ_PROG_ORDER prog_order
progression order
Definition: index_manager.h:78
CODmarker_param::numOfdecomp
Byte_t numOfdecomp
number of decompositions levels
Definition: index_manager.h:80
CODmarker_param::YPsiz
Byte4_t * YPsiz
dynamic array of precinct height at successive resolution level in order
Definition: index_manager.h:82
CODmarker_param::Lcod
Byte2_t Lcod
length of marker segment excluding the marker
Definition: index_manager.h:76
CODmarker_param::XPsiz
Byte4_t * XPsiz
dynamic array of precinct width at successive resolution level in order
Definition: index_manager.h:81
SIZmarker_param
progression order
Definition: index_manager.h:55
SIZmarker_param::Lsiz
Byte2_t Lsiz
length of marker segment excluding the marker
Definition: index_manager.h:56
SIZmarker_param::Ysiz
Byte4_t Ysiz
height of the reference grid
Definition: index_manager.h:59
SIZmarker_param::Ssiz
Byte_t Ssiz[3]
precision (depth) in bits and sign of the component samples
Definition: index_manager.h:69
SIZmarker_param::YTOsiz
Byte4_t YTOsiz
vertical offset from the origin of the reference grid to the top side of the first tile
Definition: index_manager.h:65
SIZmarker_param::YTnum
Byte4_t YTnum
number of tiles in vertical direction
Definition: index_manager.h:67
SIZmarker_param::YOsiz
Byte4_t YOsiz
vertical offset from the origin of the reference grid to the top side of the image area
Definition: index_manager.h:61
SIZmarker_param::XTnum
Byte4_t XTnum
number of tiles in horizontal direction
Definition: index_manager.h:66
SIZmarker_param::XRsiz
Byte_t XRsiz[3]
horizontal separation of a sample of component with respect to the reference grid
Definition: index_manager.h:70
SIZmarker_param::Rsiz
Byte2_t Rsiz
capabilities that a decoder needs
Definition: index_manager.h:57
SIZmarker_param::Csiz
Byte2_t Csiz
number of the components in the image
Definition: index_manager.h:68
SIZmarker_param::XTOsiz
Byte4_t XTOsiz
horizontal offset from the origin of the reference grid to the left side of the first tile
Definition: index_manager.h:64
SIZmarker_param::YRsiz
Byte_t YRsiz[3]
vertical separation of a sample of component with respect to the reference grid
Definition: index_manager.h:71
SIZmarker_param::Xsiz
Byte4_t Xsiz
width of the reference grid
Definition: index_manager.h:58
SIZmarker_param::YTsiz
Byte4_t YTsiz
height of one reference tile with respect to the reference grid
Definition: index_manager.h:63
SIZmarker_param::XOsiz
Byte4_t XOsiz
horizontal offset from the origin of the reference grid to the left side of the image area
Definition: index_manager.h:60
SIZmarker_param::XTsiz
Byte4_t XTsiz
width of one reference tile with respect to the reference grid
Definition: index_manager.h:62
faixbox_param
fragment array index box parameters
Definition: faixbox_manager.h:77
index_param
index parameters
Definition: index_manager.h:86
index_param::mhead_length
Byte8_t mhead_length
main header length
Definition: index_manager.h:90
index_param::precpacket
faixbox_param_t ** precpacket
dynamic array of precint packet information from ppix box
Definition: index_manager.h:97
index_param::tileheader
mhixbox_param_t ** tileheader
dynamic array of tile header information from thix box
Definition: index_manager.h:95
index_param::offset
OPJ_OFF_T offset
codestream offset
Definition: index_manager.h:88
index_param::tilepart
faixbox_param_t * tilepart
tile part information from tpix box
Definition: index_manager.h:93
index_param::SIZ
SIZmarker_param_t SIZ
SIZ marker information.
Definition: index_manager.h:91
index_param::length
Byte8_t length
codestream length
Definition: index_manager.h:89
index_param::COD
CODmarker_param_t COD
COD marker information.
Definition: index_manager.h:92
index_param::metadatalist
metadatalist_param_t * metadatalist
metadata-bin list
Definition: index_manager.h:87
metadatalist_param
metadata-bin list parameters
Definition: metadata_manager.h:54
mhixbox_param
header index table box parameters
Definition: mhixbox_manager.h:52
range_param
1-dimensional range parameters
Definition: index_manager.h:147
range_param::maxvalue
Byte4_t maxvalue
maximal value
Definition: index_manager.h:149
range_param::minvalue
Byte4_t minvalue
minimal value
Definition: index_manager.h:148