OpenJPEG 1.5.2
indexbox_manager.h
Go to the documentation of this file.
1/*
2 * $Id: indexbox_manager.h 897 2011-08-28 21:43:57Z Kaori.Hagihara@gmail.com $
3 *
4 * Copyright (c) 2002-2011, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
5 * Copyright (c) 2002-2011, Professor Benoit Macq
6 * Copyright (c) 2003-2004, Yannick Verschueren
7 * Copyright (c) 2010-2011, Kaori Hagihara
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
35
36#ifndef INDEXBOX_MANAGER_H_
37# define INDEXBOX_MANAGER_H_
38
39#include "openjpeg.h"
40#include "j2k.h" /* needed to use jp2.h */
41#include "jp2.h"
42
43#define JPIP_CIDX 0x63696478 /* Codestream index */
44#define JPIP_CPTR 0x63707472 /* Codestream Finder Box */
45#define JPIP_MANF 0x6d616e66 /* Manifest Box */
46#define JPIP_FAIX 0x66616978 /* Fragment array Index box */
47#define JPIP_MHIX 0x6d686978 /* Main Header Index Table */
48#define JPIP_TPIX 0x74706978 /* Tile-part Index Table box */
49#define JPIP_THIX 0x74686978 /* Tile header Index Table box */
50#define JPIP_PPIX 0x70706978 /* Precinct Packet Index Table box */
51#define JPIP_PHIX 0x70686978 /* Packet Header index Table */
52#define JPIP_FIDX 0x66696478 /* File Index */
53#define JPIP_FPTR 0x66707472 /* File Finder */
54#define JPIP_PRXY 0x70727879 /* Proxy boxes */
55#define JPIP_IPTR 0x69707472 /* Index finder box */
56#define JPIP_PHLD 0x70686c64 /* Place holder */
57
58
59/*
60 * Write tile-part Index table box (superbox)
61 *
62 * @param[in] coff offset of j2k codestream
63 * @param[in] cstr_info codestream information
64 * @param[in] j2klen length of j2k codestream
65 * @param[in] cio file output handle
66 * @return length of tpix box
67 */
68int write_tpix( int coff, opj_codestream_info_t cstr_info, int j2klen, opj_cio_t *cio);
69
70
71/*
72 * Write tile header index table box (superbox)
73 *
74 * @param[in] coff offset of j2k codestream
75 * @param[in] cstr_info codestream information pointer
76 * @param[in] cio file output handle
77 * @return length of thix box
78 */
79int write_thix( int coff, opj_codestream_info_t cstr_info, opj_cio_t *cio);
80
81
82/*
83 * Write precinct packet index table box (superbox)
84 *
85 * @param[in] coff offset of j2k codestream
86 * @param[in] cstr_info codestream information
87 * @param[in] EPHused true if EPH option used
88 * @param[in] j2klen length of j2k codestream
89 * @param[in] cio file output handle
90 * @return length of ppix box
91 */
92int write_ppix( int coff, opj_codestream_info_t cstr_info, opj_bool EPHused, int j2klen, opj_cio_t *cio);
93
94
95/*
96 * Write packet header index table box (superbox)
97 *
98 * @param[in] coff offset of j2k codestream
99 * @param[in] cstr_info codestream information
100 * @param[in] EPHused true if EPH option used
101 * @param[in] j2klen length of j2k codestream
102 * @param[in] cio file output handle
103 * @return length of ppix box
104 */
105int write_phix( int coff, opj_codestream_info_t cstr_info, opj_bool EPHused, int j2klen, opj_cio_t *cio);
106
107/*
108 * Wriet manifest box (box)
109 *
110 * @param[in] second number to be visited
111 * @param[in] v number of boxes
112 * @param[in] box box to be manifested
113 * @param[in] cio file output handle
114 */
115void write_manf(int second, int v, opj_jp2_box_t *box, opj_cio_t *cio);
116
117
118#endif /* !INDEXBOX_MANAGER_H_ */
int write_phix(int coff, opj_codestream_info_t cstr_info, opj_bool EPHused, int j2klen, opj_cio_t *cio)
Definition phix_manager.c:53
int write_thix(int coff, opj_codestream_info_t cstr_info, opj_cio_t *cio)
Definition thix_manager.c:52
int write_tpix(int coff, opj_codestream_info_t cstr_info, int j2klen, opj_cio_t *cio)
Definition tpix_manager.c:55
void write_manf(int second, int v, opj_jp2_box_t *box, opj_cio_t *cio)
Definition cidx_manager.c:143
int write_ppix(int coff, opj_codestream_info_t cstr_info, opj_bool EPHused, int j2klen, opj_cio_t *cio)
Definition ppix_manager.c:54
The JPEG-2000 Codestream Reader/Writer (J2K)
The JPEG-2000 file format Reader/Writer (JP2)
struct opj_jp2_box opj_jp2_box_t
JP2 Box.
struct opj_codestream_info opj_codestream_info_t
Index structure of the codestream.
int opj_bool
Definition openjpeg.h:63
struct opj_cio opj_cio_t
Byte input-output stream (CIO)