OpenJPEG: box_manager.h Source File

OpenJPEG 2.5.0

box_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 BOX_MANAGER_H_
32# define BOX_MANAGER_H_
33
34#include "byte_manager.h"
35
37 typedef struct box_param {
38 int fd;
39 OPJ_OFF_T offset;
40 Byte_t headlen;
41 Byte8_t length;
42 char type[4];
43 struct box_param *next;
44} box_param_t;
45
46
48 typedef struct boxlist_param {
49 box_param_t *first;
50 box_param_t *last;
51} boxlist_param_t;
52
53
59 boxlist_param_t * gene_boxlist(void);
60
69 boxlist_param_t * get_boxstructure(int fd, OPJ_OFF_T offset, OPJ_SIZE_T length);
70
71
79 box_param_t * gene_boxbyOffset(int fd, OPJ_OFF_T offset);
80
81
89 box_param_t * gene_boxbyOffinStream(Byte_t *stream, OPJ_OFF_T offset);
90
100 box_param_t * gene_boxbyType(int fd, OPJ_OFF_T offset, OPJ_SIZE_T length,
101 const char TBox[]);
102
112 box_param_t * gene_boxbyTypeinStream(Byte_t *stream, OPJ_OFF_T offset,
113 OPJ_SIZE_T length, const char TBox[]);
114
122 box_param_t * gene_childboxbyOffset(box_param_t *superbox, OPJ_OFF_T offset);
123
132 box_param_t * gene_childboxbyType(box_param_t *superbox, OPJ_OFF_T offset,
133 const char TBox[]);
134
141 OPJ_OFF_T get_DBoxoff(box_param_t *box);
142
143
150 OPJ_SIZE_T get_DBoxlen(box_param_t *box);
151
152
159 Byte_t * fetch_headbytes(box_param_t *box);
160
161
170 Byte_t * fetch_DBoxbytes(box_param_t *box, OPJ_OFF_T offset, OPJ_SIZE_T size);
171
179 Byte_t fetch_DBox1byte(box_param_t *box, OPJ_OFF_T offset);
180
188 Byte2_t fetch_DBox2bytebigendian(box_param_t *box, OPJ_OFF_T offset);
189
197 Byte4_t fetch_DBox4bytebigendian(box_param_t *box, OPJ_OFF_T offset);
198
206 Byte8_t fetch_DBox8bytebigendian(box_param_t *box, OPJ_OFF_T offset);
207
208
216 box_param_t * search_box(const char type[], boxlist_param_t *boxlist);
217
223void print_box(box_param_t *box);
224
225
231void print_allbox(boxlist_param_t *boxlist);
232
239void delete_box_in_list(box_param_t **box, boxlist_param_t *boxlist);
240
241
248void delete_box_in_list_by_type(const char type[], boxlist_param_t *boxlist);
249
250
256void delete_boxlist(boxlist_param_t **boxlist);
257
258
265void insert_box_into_list(box_param_t *box, boxlist_param_t *boxlist);
266
267#endif /* !BOX_MANAGER_H_ */
gene_boxbyOffset
box_param_t * gene_boxbyOffset(int fd, OPJ_OFF_T offset)
generate box from JP2 file at the given offset
Definition: box_manager.c:86
print_box
void print_box(box_param_t *box)
print box parameters
Definition: box_manager.c:365
get_DBoxlen
OPJ_SIZE_T get_DBoxlen(box_param_t *box)
get DBox length
Definition: box_manager.c:311
fetch_DBox4bytebigendian
Byte4_t fetch_DBox4bytebigendian(box_param_t *box, OPJ_OFF_T offset)
fetch DBox (Box Contents) 4-byte big endian Byte codes in file stream
Definition: box_manager.c:336
fetch_DBox2bytebigendian
Byte2_t fetch_DBox2bytebigendian(box_param_t *box, OPJ_OFF_T offset)
fetch DBox (Box Contents) 2-byte big endian Byte codes in file stream
Definition: box_manager.c:331
print_allbox
void print_allbox(boxlist_param_t *boxlist)
print all box parameters
Definition: box_manager.c:375
fetch_DBoxbytes
Byte_t * fetch_DBoxbytes(box_param_t *box, OPJ_OFF_T offset, OPJ_SIZE_T size)
fetch DBox (Box Contents) bytes of data in file stream
Definition: box_manager.c:321
fetch_DBox8bytebigendian
Byte8_t fetch_DBox8bytebigendian(box_param_t *box, OPJ_OFF_T offset)
fetch DBox (Box Contents) 8-byte big endian Byte codes in file stream
Definition: box_manager.c:341
delete_box_in_list_by_type
void delete_box_in_list_by_type(const char type[], boxlist_param_t *boxlist)
delete a box in list by Type
Definition: box_manager.c:415
gene_boxbyType
box_param_t * gene_boxbyType(int fd, OPJ_OFF_T offset, OPJ_SIZE_T length, const char TBox[])
generate(search) box from JP2 file
Definition: box_manager.c:173
gene_boxbyTypeinStream
box_param_t * gene_boxbyTypeinStream(Byte_t *stream, OPJ_OFF_T offset, OPJ_SIZE_T length, const char TBox[])
generate(search) box from code stream
Definition: box_manager.c:243
box_param_t
struct box_param box_param_t
box parameters
gene_childboxbyOffset
box_param_t * gene_childboxbyOffset(box_param_t *superbox, OPJ_OFF_T offset)
generate child box from JP2 file at the given offset
Definition: box_manager.c:288
gene_childboxbyType
box_param_t * gene_childboxbyType(box_param_t *superbox, OPJ_OFF_T offset, const char TBox[])
generate(search) box from JP2 file
Definition: box_manager.c:293
get_boxstructure
boxlist_param_t * get_boxstructure(int fd, OPJ_OFF_T offset, OPJ_SIZE_T length)
get box structure of JP2 file
Definition: box_manager.c:60
gene_boxlist
boxlist_param_t * gene_boxlist(void)
generate a box list
Definition: box_manager.c:48
delete_box_in_list
void delete_box_in_list(box_param_t **box, boxlist_param_t *boxlist)
delete a box in list
Definition: box_manager.c:395
gene_boxbyOffinStream
box_param_t * gene_boxbyOffinStream(Byte_t *stream, OPJ_OFF_T offset)
generate box from code stream (JPP or JPT stream) at the given offset
Definition: box_manager.c:138
boxlist_param_t
struct boxlist_param boxlist_param_t
Box list parameters.
search_box
box_param_t * search_box(const char type[], boxlist_param_t *boxlist)
search a box by box type
Definition: box_manager.c:346
get_DBoxoff
OPJ_OFF_T get_DBoxoff(box_param_t *box)
get DBox offset
Definition: box_manager.c:306
fetch_headbytes
Byte_t * fetch_headbytes(box_param_t *box)
fetch header bytes in file stream
Definition: box_manager.c:316
fetch_DBox1byte
Byte_t fetch_DBox1byte(box_param_t *box, OPJ_OFF_T offset)
fetch DBox (Box Contents) 1-byte Byte codes in file stream
Definition: box_manager.c:326
delete_boxlist
void delete_boxlist(boxlist_param_t **boxlist)
delete box list
Definition: box_manager.c:423
insert_box_into_list
void insert_box_into_list(box_param_t *box, boxlist_param_t *boxlist)
insert a box into list
Definition: box_manager.c:440
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
OPJ_OFF_T
int64_t OPJ_OFF_T
Definition: openjpeg.h:136
OPJ_SIZE_T
size_t OPJ_SIZE_T
Definition: openjpeg.h:139
box_param
box parameters
Definition: box_manager.h:37
box_param::type
char type[4]
type of information in the DBox
Definition: box_manager.h:42
box_param::length
Byte8_t length
length of the whole Box
Definition: box_manager.h:41
box_param::offset
OPJ_OFF_T offset
byte position of the whole Box (LBox) in the file
Definition: box_manager.h:39
box_param::next
struct box_param * next
pointer to the next box
Definition: box_manager.h:43
box_param::headlen
Byte_t headlen
header length 8 or 16
Definition: box_manager.h:40
box_param::fd
int fd
file descriptor
Definition: box_manager.h:38
boxlist_param
Box list parameters.
Definition: box_manager.h:48
boxlist_param::last
box_param_t * last
last box pointer of the list
Definition: box_manager.h:50
boxlist_param::first
box_param_t * first
first box pointer of the list
Definition: box_manager.h:49