aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/libraries/openjpeg-libsl/libopenjpeg/jp2.h
diff options
context:
space:
mode:
authordan miller2007-10-18 08:29:49 +0000
committerdan miller2007-10-18 08:29:49 +0000
commitcc07c64bdef46f4d25c2203e874f91ee94583f56 (patch)
tree004c68e8d8813ff1addfd9749e3dbdc6ff4432a9 /libraries/openjpeg-libsl/libopenjpeg/jp2.h
parenthmm... trying again to get everything committed (diff)
downloadopensim-SC_OLD-cc07c64bdef46f4d25c2203e874f91ee94583f56.zip
opensim-SC_OLD-cc07c64bdef46f4d25c2203e874f91ee94583f56.tar.gz
opensim-SC_OLD-cc07c64bdef46f4d25c2203e874f91ee94583f56.tar.bz2
opensim-SC_OLD-cc07c64bdef46f4d25c2203e874f91ee94583f56.tar.xz
one more time
Diffstat (limited to 'libraries/openjpeg-libsl/libopenjpeg/jp2.h')
-rw-r--r--libraries/openjpeg-libsl/libopenjpeg/jp2.h176
1 files changed, 176 insertions, 0 deletions
diff --git a/libraries/openjpeg-libsl/libopenjpeg/jp2.h b/libraries/openjpeg-libsl/libopenjpeg/jp2.h
new file mode 100644
index 0000000..61fc1e4
--- /dev/null
+++ b/libraries/openjpeg-libsl/libopenjpeg/jp2.h
@@ -0,0 +1,176 @@
1/*
2 * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
3 * Copyright (c) 2002-2007, Professor Benoit Macq
4 * Copyright (c) 2002-2003, Yannick Verschueren
5 * Copyright (c) 2005, Herve Drolon, FreeImage Team
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
28 */
29#ifndef __JP2_H
30#define __JP2_H
31/**
32@file jp2.h
33@brief The JPEG-2000 file format Reader/Writer (JP2)
34
35*/
36
37/** @defgroup JP2 JP2 - JPEG-2000 file format reader/writer */
38/*@{*/
39
40#define JPIP_JPIP 0x6a706970
41
42#define JP2_JP 0x6a502020 /**< JPEG 2000 signature box */
43#define JP2_FTYP 0x66747970 /**< File type box */
44#define JP2_JP2H 0x6a703268 /**< JP2 header box */
45#define JP2_IHDR 0x69686472 /**< Image header box */
46#define JP2_COLR 0x636f6c72 /**< Colour specification box */
47#define JP2_JP2C 0x6a703263 /**< Contiguous codestream box */
48#define JP2_URL 0x75726c20 /**< URL box */
49#define JP2_DBTL 0x6474626c /**< ??? */
50#define JP2_BPCC 0x62706363 /**< Bits per component box */
51#define JP2_JP2 0x6a703220 /**< File type fields */
52
53/* ----------------------------------------------------------------------- */
54
55/**
56JP2 component
57*/
58typedef struct opj_jp2_comps {
59 int depth;
60 int sgnd;
61 int bpcc;
62} opj_jp2_comps_t;
63
64/**
65JPEG-2000 file format reader/writer
66*/
67typedef struct opj_jp2 {
68 /** codec context */
69 opj_common_ptr cinfo;
70 /** handle to the J2K codec */
71 opj_j2k_t *j2k;
72 unsigned int w;
73 unsigned int h;
74 unsigned int numcomps;
75 unsigned int bpc;
76 unsigned int C;
77 unsigned int UnkC;
78 unsigned int IPR;
79 unsigned int meth;
80 unsigned int approx;
81 unsigned int enumcs;
82 unsigned int precedence;
83 unsigned int brand;
84 unsigned int minversion;
85 unsigned int numcl;
86 unsigned int *cl;
87 opj_jp2_comps_t *comps;
88 unsigned int j2k_codestream_offset;
89 unsigned int j2k_codestream_length;
90} opj_jp2_t;
91
92/**
93JP2 Box
94*/
95typedef struct opj_jp2_box {
96 int length;
97 int type;
98 int init_pos;
99} opj_jp2_box_t;
100
101/** @name Exported functions */
102/*@{*/
103/* ----------------------------------------------------------------------- */
104/**
105Write the JP2H box - JP2 Header box (used in MJ2)
106@param jp2 JP2 handle
107@param cio Output buffer stream
108*/
109void jp2_write_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
110/**
111Read the JP2H box - JP2 Header box (used in MJ2)
112@param jp2 JP2 handle
113@param cio Input buffer stream
114@return Returns true if successful, returns false otherwise
115*/
116bool jp2_read_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
117/**
118Creates a JP2 decompression structure
119@param cinfo Codec context info
120@return Returns a handle to a JP2 decompressor if successful, returns NULL otherwise
121*/
122opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);
123/**
124Destroy a JP2 decompressor handle
125@param jp2 JP2 decompressor handle to destroy
126*/
127void jp2_destroy_decompress(opj_jp2_t *jp2);
128/**
129Setup the decoder decoding parameters using user parameters.
130Decoding parameters are returned in jp2->j2k->cp.
131@param jp2 JP2 decompressor handle
132@param parameters decompression parameters
133*/
134void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
135/**
136Decode an image from a JPEG-2000 file stream
137@param jp2 JP2 decompressor handle
138@param cio Input buffer stream
139@return Returns a decoded image if successful, returns NULL otherwise
140*/
141opj_image_t* jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio);
142/**
143Creates a JP2 compression structure
144@param cinfo Codec context info
145@return Returns a handle to a JP2 compressor if successful, returns NULL otherwise
146*/
147opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);
148/**
149Destroy a JP2 compressor handle
150@param jp2 JP2 compressor handle to destroy
151*/
152void jp2_destroy_compress(opj_jp2_t *jp2);
153/**
154Setup the encoder parameters using the current image and using user parameters.
155Coding parameters are returned in jp2->j2k->cp.
156@param jp2 JP2 compressor handle
157@param parameters compression parameters
158@param image input filled image
159*/
160void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);
161/**
162Encode an image into a JPEG-2000 file stream
163@param jp2 JP2 compressor handle
164@param cio Output buffer stream
165@param image Image to encode
166@param index Name of the index file if required, NULL otherwise
167@return Returns true if successful, returns false otherwise
168*/
169bool jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, char *index);
170/* ----------------------------------------------------------------------- */
171/*@}*/
172
173/*@}*/
174
175#endif /* __JP2_H */
176