OpenJPEG  2.3.1
cio.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  * Copyright (c) 2001-2003, David Janssens
10  * Copyright (c) 2002-2003, Yannick Verschueren
11  * Copyright (c) 2003-2007, Francois-Olivier Devaux
12  * Copyright (c) 2003-2014, Antonin Descampe
13  * Copyright (c) 2005, Herve Drolon, FreeImage Team
14  * Copyright (c) 2008, 2011-2012, Centre National d'Etudes Spatiales (CNES), FR
15  * Copyright (c) 2012, CS Systemes d'Information, France
16  * All rights reserved.
17  *
18  * Redistribution and use in source and binary forms, with or without
19  * modification, are permitted provided that the following conditions
20  * are met:
21  * 1. Redistributions of source code must retain the above copyright
22  * notice, this list of conditions and the following disclaimer.
23  * 2. Redistributions in binary form must reproduce the above copyright
24  * notice, this list of conditions and the following disclaimer in the
25  * documentation and/or other materials provided with the distribution.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
28  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 #ifndef OPJ_CIO_H
41 #define OPJ_CIO_H
42 
51 
52 #include "opj_config_private.h"
53 
54 /* ----------------------------------------------------------------------- */
55 
56 #if defined(OPJ_BIG_ENDIAN)
57 #define opj_write_bytes opj_write_bytes_BE
58 #define opj_read_bytes opj_read_bytes_BE
59 #define opj_write_double opj_write_double_BE
60 #define opj_read_double opj_read_double_BE
61 #define opj_write_float opj_write_float_BE
62 #define opj_read_float opj_read_float_BE
63 #else
64 #define opj_write_bytes opj_write_bytes_LE
65 #define opj_read_bytes opj_read_bytes_LE
66 #define opj_write_double opj_write_double_LE
67 #define opj_read_double opj_read_double_LE
68 #define opj_write_float opj_write_float_LE
69 #define opj_read_float opj_read_float_LE
70 #endif
71 
72 
73 #define OPJ_STREAM_STATUS_OUTPUT 0x1U
74 #define OPJ_STREAM_STATUS_INPUT 0x2U
75 #define OPJ_STREAM_STATUS_END 0x4U
76 #define OPJ_STREAM_STATUS_ERROR 0x8U
77 
81 typedef struct opj_stream_private {
85  void * m_user_data;
86 
92  opj_stream_free_user_data_fn m_free_user_data_fn;
93 
97  OPJ_UINT64 m_user_data_length;
98 
102  opj_stream_read_fn m_read_fn;
103 
107  opj_stream_write_fn m_write_fn;
108 
113  opj_stream_skip_fn m_skip_fn;
114 
118  opj_stream_seek_fn m_seek_fn;
119 
124  OPJ_BYTE * m_stored_data;
125 
129  OPJ_BYTE * m_current_data;
130 
134  OPJ_OFF_T(* m_opj_skip)(struct opj_stream_private *, OPJ_OFF_T,
135  struct opj_event_mgr *);
136 
140  OPJ_BOOL(* m_opj_seek)(struct opj_stream_private *, OPJ_OFF_T,
141  struct opj_event_mgr *);
142 
146  OPJ_SIZE_T m_bytes_in_buffer;
147 
151  OPJ_OFF_T m_byte_offset;
152 
156  OPJ_SIZE_T m_buffer_size;
157 
162  OPJ_UINT32 m_status;
163 
164 }
165 opj_stream_private_t;
166 
169 /* ----------------------------------------------------------------------- */
176 void opj_write_bytes_BE(OPJ_BYTE * p_buffer, OPJ_UINT32 p_value,
177  OPJ_UINT32 p_nb_bytes);
178 
186 void opj_read_bytes_BE(const OPJ_BYTE * p_buffer, OPJ_UINT32 * p_value,
187  OPJ_UINT32 p_nb_bytes);
188 
196 void opj_write_bytes_LE(OPJ_BYTE * p_buffer, OPJ_UINT32 p_value,
197  OPJ_UINT32 p_nb_bytes);
198 
206 void opj_read_bytes_LE(const OPJ_BYTE * p_buffer, OPJ_UINT32 * p_value,
207  OPJ_UINT32 p_nb_bytes);
208 
209 
215 void opj_write_double_LE(OPJ_BYTE * p_buffer, OPJ_FLOAT64 p_value);
216 
217 /***
218  * Write some bytes to the given data buffer, this function is used in Big Endian cpus.
219  * @param p_buffer pointer the data buffer to write data to.
220  * @param p_value the value to write
221  */
222 void opj_write_double_BE(OPJ_BYTE * p_buffer, OPJ_FLOAT64 p_value);
223 
229 void opj_read_double_LE(const OPJ_BYTE * p_buffer, OPJ_FLOAT64 * p_value);
230 
236 void opj_read_double_BE(const OPJ_BYTE * p_buffer, OPJ_FLOAT64 * p_value);
237 
243 void opj_read_float_LE(const OPJ_BYTE * p_buffer, OPJ_FLOAT32 * p_value);
244 
250 void opj_read_float_BE(const OPJ_BYTE * p_buffer, OPJ_FLOAT32 * p_value);
251 
257 void opj_write_float_LE(OPJ_BYTE * p_buffer, OPJ_FLOAT32 p_value);
258 
259 /***
260  * Write some bytes to the given data buffer, this function is used in Big Endian cpus.
261  * @param p_buffer pointer the data buffer to write data to.
262  * @param p_value the value to write
263  */
264 void opj_write_float_BE(OPJ_BYTE * p_buffer, OPJ_FLOAT32 p_value);
265 
274 OPJ_SIZE_T opj_stream_read_data(opj_stream_private_t * p_stream,
275  OPJ_BYTE * p_buffer, OPJ_SIZE_T p_size, struct opj_event_mgr * p_event_mgr);
276 
285 OPJ_SIZE_T opj_stream_write_data(opj_stream_private_t * p_stream,
286  const OPJ_BYTE * p_buffer, OPJ_SIZE_T p_size,
287  struct opj_event_mgr * p_event_mgr);
288 
295 OPJ_BOOL opj_stream_flush(opj_stream_private_t * p_stream,
296  struct opj_event_mgr * p_event_mgr);
297 
305 OPJ_OFF_T opj_stream_skip(opj_stream_private_t * p_stream, OPJ_OFF_T p_size,
306  struct opj_event_mgr * p_event_mgr);
307 
315 OPJ_OFF_T opj_stream_tell(const opj_stream_private_t * p_stream);
316 
317 
325 OPJ_OFF_T opj_stream_get_number_byte_left(const opj_stream_private_t *
326  p_stream);
327 
335 OPJ_OFF_T opj_stream_write_skip(opj_stream_private_t * p_stream,
336  OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
337 
345 OPJ_OFF_T opj_stream_read_skip(opj_stream_private_t * p_stream,
346  OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
347 
355 OPJ_BOOL opj_stream_read_seek(opj_stream_private_t * p_stream, OPJ_OFF_T p_size,
356  struct opj_event_mgr * p_event_mgr);
357 
365 OPJ_BOOL opj_stream_write_seek(opj_stream_private_t * p_stream,
366  OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
367 
375 OPJ_BOOL opj_stream_seek(opj_stream_private_t * p_stream, OPJ_OFF_T p_size,
376  struct opj_event_mgr * p_event_mgr);
377 
381 OPJ_BOOL opj_stream_has_seek(const opj_stream_private_t * p_stream);
382 
386 OPJ_SIZE_T opj_stream_default_read(void * p_buffer, OPJ_SIZE_T p_nb_bytes,
387  void * p_user_data);
388 
392 OPJ_SIZE_T opj_stream_default_write(void * p_buffer, OPJ_SIZE_T p_nb_bytes,
393  void * p_user_data);
394 
398 OPJ_OFF_T opj_stream_default_skip(OPJ_OFF_T p_nb_bytes, void * p_user_data);
399 
403 OPJ_BOOL opj_stream_default_seek(OPJ_OFF_T p_nb_bytes, void * p_user_data);
404 
405 /* ----------------------------------------------------------------------- */
409 
410 
411 #endif /* OPJ_CIO_H */
412 
Generated by   doxygen 1.8.1