OpenJPEG 2.5.3
opj_codec.h
Go to the documentation of this file.
1/*
2 * The copyright in this software is being made available under the 2-clauses
3 * BSD License, included below. This software may be subject to other third
4 * party and contributor rights, including patent rights, and no such rights
5 * are granted under this license.
6 *
7 * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
8 * Copyright (c) 2002-2014, Professor Benoit Macq
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32#ifndef OPJ_CODEC_H
33#define OPJ_CODEC_H
42typedef struct opj_codec_private {
44 union {
48 struct opj_decompression {
51 void * p_codec,
52 opj_image_t **p_image,
53 struct opj_event_mgr * p_manager);
54
56 OPJ_BOOL(*opj_decode)(void * p_codec,
57 struct opj_stream_private * p_cio,
58 opj_image_t * p_image,
59 struct opj_event_mgr * p_manager);
60
63 OPJ_UINT32 * p_tile_index,
64 OPJ_UINT32 * p_data_size,
65 OPJ_INT32 * p_tile_x0,
66 OPJ_INT32 * p_tile_y0,
67 OPJ_INT32 * p_tile_x1,
68 OPJ_INT32 * p_tile_y1,
69 OPJ_UINT32 * p_nb_comps,
70 OPJ_BOOL * p_should_go_on,
71 struct opj_stream_private * p_cio,
72 struct opj_event_mgr * p_manager);
73
76 OPJ_UINT32 p_tile_index,
77 OPJ_BYTE * p_data,
78 OPJ_UINT32 p_data_size,
79 struct opj_stream_private * p_cio,
80 struct opj_event_mgr * p_manager);
81
83 OPJ_BOOL(* opj_end_decompress)(void *p_codec,
84 struct opj_stream_private * cio,
85 struct opj_event_mgr * p_manager);
86
88 void (*opj_destroy)(void * p_codec);
89
91 void (*opj_setup_decoder)(void * p_codec, opj_dparameters_t * p_param);
92
94 void (*opj_decoder_set_strict_mode)(void * p_codec, OPJ_BOOL strict);
95
97 OPJ_BOOL(*opj_set_decode_area)(void * p_codec,
98 opj_image_t * p_image,
99 OPJ_INT32 p_start_x,
100 OPJ_INT32 p_end_x,
101 OPJ_INT32 p_start_y,
102 OPJ_INT32 p_end_y,
103 struct opj_event_mgr * p_manager);
104
107 opj_stream_private_t * p_cio,
108 opj_image_t *p_image,
109 struct opj_event_mgr * p_manager,
110 OPJ_UINT32 tile_index);
111
114 OPJ_UINT32 res_factor,
115 opj_event_mgr_t * p_manager);
116
119 OPJ_UINT32 num_comps,
120 const OPJ_UINT32* comps_indices,
121 opj_event_mgr_t * p_manager);
123
127 struct opj_compression {
128 OPJ_BOOL(* opj_start_compress)(void *p_codec,
129 struct opj_stream_private * cio,
130 struct opj_image * p_image,
131 struct opj_event_mgr * p_manager);
132
133 OPJ_BOOL(* opj_encode)(void * p_codec,
134 struct opj_stream_private *p_cio,
135 struct opj_event_mgr * p_manager);
136
137 OPJ_BOOL(* opj_write_tile)(void * p_codec,
138 OPJ_UINT32 p_tile_index,
139 OPJ_BYTE * p_data,
140 OPJ_UINT32 p_data_size,
141 struct opj_stream_private * p_cio,
142 struct opj_event_mgr * p_manager);
143
144 OPJ_BOOL(* opj_end_compress)(void * p_codec,
145 struct opj_stream_private * p_cio,
146 struct opj_event_mgr * p_manager);
147
148 void (* opj_destroy)(void * p_codec);
149
150 OPJ_BOOL(* opj_setup_encoder)(void * p_codec,
151 opj_cparameters_t * p_param,
152 struct opj_image * p_image,
153 struct opj_event_mgr * p_manager);
154
156 const char* const* p_options,
157 struct opj_event_mgr * p_manager);
158
162 void * m_codec;
167 void (*opj_dump_codec)(void * p_codec, OPJ_INT32 info_flag,
168 FILE* output_stream);
169 opj_codestream_info_v2_t* (*opj_get_codec_info)(void* p_codec);
170 opj_codestream_index_t* (*opj_get_codec_index)(void* p_codec);
171
173 OPJ_BOOL(*opj_set_threads)(void * p_codec, OPJ_UINT32 num_threads);
174}
176
177
178#endif /* OPJ_CODEC_H */
179
OPJ_BOOL OPJ_CALLCONV opj_set_decoded_resolution_factor(opj_codec_t *p_codec, OPJ_UINT32 res_factor)
Set the resolution factor of the decoded image.
Definition openjpeg.c:639
OPJ_BOOL OPJ_CALLCONV opj_get_decoded_tile(opj_codec_t *p_codec, opj_stream_t *p_stream, opj_image_t *p_image, OPJ_UINT32 tile_index)
Get the decoded tile from the codec.
Definition openjpeg.c:615
OPJ_BOOL OPJ_CALLCONV opj_start_compress(opj_codec_t *p_codec, opj_image_t *p_image, opj_stream_t *p_stream)
Start to compress the current image.
Definition openjpeg.c:871
OPJ_BOOL OPJ_CALLCONV opj_end_decompress(opj_codec_t *p_codec, opj_stream_t *p_stream)
Read after the codestream if necessary.
Definition openjpeg.c:924
OPJ_BOOL OPJ_CALLCONV opj_set_decoded_components(opj_codec_t *p_codec, OPJ_UINT32 numcomps, const OPJ_UINT32 *comps_indices, OPJ_BOOL apply_color_transforms)
Restrict the number of components to decode.
Definition openjpeg.c:485
OPJ_BOOL OPJ_CALLCONV opj_decoder_set_strict_mode(opj_codec_t *p_codec, OPJ_BOOL strict)
Set strict decoding parameter for this decoder.
Definition openjpeg.c:441
OPJ_BOOL OPJ_CALLCONV opj_setup_encoder(opj_codec_t *p_codec, opj_cparameters_t *parameters, opj_image_t *p_image)
Setup the encoder parameters using the current image and using user parameters.
Definition openjpeg.c:832
OPJ_BOOL OPJ_CALLCONV opj_encode(opj_codec_t *p_info, opj_stream_t *p_stream)
Encode an image into a JPEG-2000 codestream.
Definition openjpeg.c:890
OPJ_BOOL OPJ_CALLCONV opj_decode_tile_data(opj_codec_t *p_codec, OPJ_UINT32 p_tile_index, OPJ_BYTE *p_data, OPJ_UINT32 p_data_size, opj_stream_t *p_stream)
Reads a tile data.
Definition openjpeg.c:589
OPJ_BOOL OPJ_CALLCONV opj_read_tile_header(opj_codec_t *p_codec, opj_stream_t *p_stream, OPJ_UINT32 *p_tile_index, OPJ_UINT32 *p_data_size, OPJ_INT32 *p_tile_x0, OPJ_INT32 *p_tile_y0, OPJ_INT32 *p_tile_x1, OPJ_INT32 *p_tile_y1, OPJ_UINT32 *p_nb_comps, OPJ_BOOL *p_should_go_on)
Reads a tile header.
Definition openjpeg.c:558
OPJ_BOOL OPJ_CALLCONV opj_end_compress(opj_codec_t *p_codec, opj_stream_t *p_stream)
End to compress the current image.
Definition openjpeg.c:907
OPJ_BOOL OPJ_CALLCONV opj_write_tile(opj_codec_t *p_codec, OPJ_UINT32 p_tile_index, OPJ_BYTE *p_data, OPJ_UINT32 p_data_size, opj_stream_t *p_stream)
Writes a tile with the given data.
Definition openjpeg.c:974
OPJ_BOOL OPJ_CALLCONV opj_encoder_set_extra_options(opj_codec_t *p_codec, const char *const *options)
Specify extra options for the encoder.
Definition openjpeg.c:852
OPJ_BOOL OPJ_CALLCONV opj_read_header(opj_stream_t *p_stream, opj_codec_t *p_codec, opj_image_t **p_image)
Decodes an image header.
Definition openjpeg.c:461
OPJ_BOOL OPJ_CALLCONV opj_setup_decoder(opj_codec_t *p_codec, opj_dparameters_t *parameters)
Setup the decoder with decompression parameters provided by the user and with the message handler pro...
Definition openjpeg.c:421
OPJ_BOOL OPJ_CALLCONV opj_set_decode_area(opj_codec_t *p_codec, opj_image_t *p_image, OPJ_INT32 p_start_x, OPJ_INT32 p_start_y, OPJ_INT32 p_end_x, OPJ_INT32 p_end_y)
Sets the given area to be decoded.
Definition openjpeg.c:535
OPJ_BOOL OPJ_CALLCONV opj_decode(opj_codec_t *p_codec, opj_stream_t *p_stream, opj_image_t *p_image)
Decode an image from a JPEG-2000 codestream.
Definition openjpeg.c:514
unsigned char OPJ_BYTE
Definition openjpeg.h:123
int32_t OPJ_INT32
Definition openjpeg.h:131
uint32_t OPJ_UINT32
Definition openjpeg.h:132
int OPJ_BOOL
Definition openjpeg.h:116
struct opj_codec_private opj_codec_private_t
Main codec handler used for compression or decompression.
Main codec handler used for compression or decompression.
Definition opj_codec.h:42
OPJ_BOOL(* opj_set_threads)(void *p_codec, OPJ_UINT32 num_threads)
Set number of threads.
Definition opj_codec.h:173
OPJ_BOOL is_decompressor
Flag to indicate if the codec is used to decode or encode.
Definition opj_codec.h:166
void * m_codec
FIXME DOC.
Definition opj_codec.h:162
opj_event_mgr_t m_event_mgr
Event handler.
Definition opj_codec.h:164
union opj_codec_private::@2 m_codec_data
FIXME DOC.
void(* opj_dump_codec)(void *p_codec, OPJ_INT32 info_flag, FILE *output_stream)
Definition opj_codec.h:167
struct opj_codec_private::@2::opj_decompression m_decompression
struct opj_codec_private::@2::opj_compression m_compression
Index structure of the codestream (FIXME should be expand and enhance)
Definition openjpeg.h:1039
Information structure about the codestream (FIXME should be expand and enhance)
Definition openjpeg.h:964
Compression parameters.
Definition openjpeg.h:395
Decompression parameters.
Definition openjpeg.h:554
Message handler object used for.
Definition event.h:50
Defines image data and characteristics.
Definition openjpeg.h:711
Byte input-output stream.
Definition cio.h:81