← Back to branch summary

~ubuntu-branches/ubuntu/vivid/emscripten/vivid

« back to all changes in this revision

Viewing changes to tests/openjpeg/libopenjpeg/jp2.h

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2013-05-02 13:11:51 UTC
  • Revision ID: package-import@ubuntu.com-20130502131151-q8dvteqr1ef2x7xz
Tags: upstream-1.4.1~20130504~adb56cb
Import upstream version 1.4.1~20130504~adb56cb

Show diffs side-by-side

added added

removed removed

Lines of Context:
tests/openjpeg/libopenjpeg/jp2.h
 
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_DTBL 0x6474626c             /**< Data Reference box */
 
50
#define JP2_BPCC 0x62706363             /**< Bits per component box */
 
51
#define JP2_JP2  0x6a703220             /**< File type fields */
 
52
#define JP2_PCLR 0x70636c72             /**< Palette box */
 
53
#define JP2_CMAP 0x636d6170             /**< Component Mapping box */
 
54
#define JP2_CDEF 0x63646566             /**< Channel Definition box */
 
55
 
 
56
/* ----------------------------------------------------------------------- */
 
57
/** 
 
58
Channel description: channel index, type, assocation
 
59
*/
 
60
typedef struct opj_jp2_cdef_info
 
61
{
 
62
    unsigned short cn, typ, asoc;
 
63
} opj_jp2_cdef_info_t;
 
64
 
 
65
/** 
 
66
Channel descriptions and number of descriptions
 
67
*/
 
68
typedef struct opj_jp2_cdef
 
69
{
 
70
    opj_jp2_cdef_info_t *info;
 
71
    unsigned short n;
 
72
} opj_jp2_cdef_t;
 
73
 
 
74
/** 
 
75
Component mappings: channel index, mapping type, palette index
 
76
*/
 
77
typedef struct opj_jp2_cmap_comp
 
78
{
 
79
    unsigned short cmp;
 
80
    unsigned char mtyp, pcol;
 
81
} opj_jp2_cmap_comp_t;
 
82
 
 
83
/** 
 
84
Palette data: table entries, palette columns
 
85
*/
 
86
typedef struct opj_jp2_pclr
 
87
{
 
88
    unsigned int *entries;
 
89
    unsigned char *channel_sign;
 
90
    unsigned char *channel_size;
 
91
    opj_jp2_cmap_comp_t *cmap;
 
92
    unsigned short nr_entries, nr_channels;
 
93
} opj_jp2_pclr_t;
 
94
 
 
95
/** 
 
96
Collector for ICC profile, palette, component mapping, channel description 
 
97
*/
 
98
typedef struct opj_jp2_color
 
99
{
 
100
    unsigned char *icc_profile_buf;
 
101
    int icc_profile_len;
 
102
 
 
103
    opj_jp2_cdef_t *jp2_cdef;
 
104
    opj_jp2_pclr_t *jp2_pclr;
 
105
    unsigned char jp2_has_colr;
 
106
} opj_jp2_color_t;
 
107
 
 
108
/** 
 
109
JP2 component
 
110
*/
 
111
typedef struct opj_jp2_comps {
 
112
  int depth;              
 
113
  int sgnd;                
 
114
  int bpcc;
 
115
} opj_jp2_comps_t;
 
116
 
 
117
/**
 
118
JPEG-2000 file format reader/writer
 
119
*/
 
120
typedef struct opj_jp2 {
 
121
        /** codec context */
 
122
        opj_common_ptr cinfo;
 
123
        /** handle to the J2K codec  */
 
124
        opj_j2k_t *j2k;
 
125
        unsigned int w;
 
126
        unsigned int h;
 
127
        unsigned int numcomps;
 
128
        unsigned int bpc;
 
129
        unsigned int C;
 
130
        unsigned int UnkC;
 
131
        unsigned int IPR;
 
132
        unsigned int meth;
 
133
        unsigned int approx;
 
134
        unsigned int enumcs;
 
135
        unsigned int precedence;
 
136
        unsigned int brand;
 
137
        unsigned int minversion;
 
138
        unsigned int numcl;
 
139
        unsigned int *cl;
 
140
        opj_jp2_comps_t *comps;
 
141
        unsigned int j2k_codestream_offset;
 
142
        unsigned int j2k_codestream_length;
 
143
} opj_jp2_t;
 
144
 
 
145
/**
 
146
JP2 Box
 
147
*/
 
148
typedef struct opj_jp2_box {
 
149
  int length;
 
150
  int type;
 
151
  int init_pos;
 
152
} opj_jp2_box_t;
 
153
 
 
154
/** @name Exported functions */
 
155
/*@{*/
 
156
/* ----------------------------------------------------------------------- */
 
157
/**
 
158
Write the JP2H box - JP2 Header box (used in MJ2)
 
159
@param jp2 JP2 handle
 
160
@param cio Output buffer stream
 
161
*/
 
162
void jp2_write_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
 
163
/**
 
164
Read the JP2H box - JP2 Header box (used in MJ2)
 
165
@param jp2 JP2 handle
 
166
@param cio Input buffer stream
 
167
@param ext Collector for profile, cdef and pclr data
 
168
@return Returns true if successful, returns false otherwise
 
169
*/
 
170
bool jp2_read_jp2h(opj_jp2_t *jp2, opj_cio_t *cio, opj_jp2_color_t *color);
 
171
/**
 
172
Creates a JP2 decompression structure
 
173
@param cinfo Codec context info
 
174
@return Returns a handle to a JP2 decompressor if successful, returns NULL otherwise
 
175
*/
 
176
opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);
 
177
/**
 
178
Destroy a JP2 decompressor handle
 
179
@param jp2 JP2 decompressor handle to destroy
 
180
*/
 
181
void jp2_destroy_decompress(opj_jp2_t *jp2);
 
182
/**
 
183
Setup the decoder decoding parameters using user parameters.
 
184
Decoding parameters are returned in jp2->j2k->cp. 
 
185
@param jp2 JP2 decompressor handle
 
186
@param parameters decompression parameters
 
187
*/
 
188
void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
 
189
/**
 
190
Decode an image from a JPEG-2000 file stream
 
191
@param jp2 JP2 decompressor handle
 
192
@param cio Input buffer stream
 
193
@param cstr_info Codestream information structure if required, NULL otherwise
 
194
@return Returns a decoded image if successful, returns NULL otherwise
 
195
*/
 
196
opj_image_t* jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
 
197
/**
 
198
Creates a JP2 compression structure
 
199
@param cinfo Codec context info
 
200
@return Returns a handle to a JP2 compressor if successful, returns NULL otherwise
 
201
*/
 
202
opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);
 
203
/**
 
204
Destroy a JP2 compressor handle
 
205
@param jp2 JP2 compressor handle to destroy
 
206
*/
 
207
void jp2_destroy_compress(opj_jp2_t *jp2);
 
208
/**
 
209
Setup the encoder parameters using the current image and using user parameters. 
 
210
Coding parameters are returned in jp2->j2k->cp. 
 
211
@param jp2 JP2 compressor handle
 
212
@param parameters compression parameters
 
213
@param image input filled image
 
214
*/
 
215
void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);
 
216
/**
 
217
Encode an image into a JPEG-2000 file stream
 
218
@param jp2 JP2 compressor handle
 
219
@param cio Output buffer stream
 
220
@param image Image to encode
 
221
@param cstr_info Codestream information structure if required, NULL otherwise
 
222
@return Returns true if successful, returns false otherwise
 
223
*/
 
224
bool jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, opj_codestream_info_t *cstr_info);
 
225
/* ----------------------------------------------------------------------- */
 
226
/*@}*/
 
227
 
 
228
/*@}*/
 
229
 
 
230
#endif /* __JP2_H */
 
231