OpenJPEG  2.0.0
cio.h
Go to the documentation of this file.
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) 2001-2003, David Janssens
5  * Copyright (c) 2002-2003, Yannick Verschueren
6  * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
7  * Copyright (c) 2005, Herve Drolon, FreeImage Team
8  * Copyright (c) 2008;2011-2012, Centre National d'Etudes Spatiales (CNES), France
9  * Copyright (c) 2012, CS Systemes d'Information, France
10  * All rights reserved.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  * notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  * notice, this list of conditions and the following disclaimer in the
19  * documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef __CIO_H
35 #define __CIO_H
36 
45 
46 #include "opj_config.h"
47 
48 /* ----------------------------------------------------------------------- */
49 
50 #if defined(OPJ_BIG_ENDIAN)
51  #define opj_write_bytes opj_write_bytes_BE
52  #define opj_read_bytes opj_read_bytes_BE
53  #define opj_write_double opj_write_double_BE
54  #define opj_read_double opj_read_double_BE
55  #define opj_write_float opj_write_float_BE
56  #define opj_read_float opj_read_float_BE
57 #else
58  #define opj_write_bytes opj_write_bytes_LE
59  #define opj_read_bytes opj_read_bytes_LE
60  #define opj_write_double opj_write_double_LE
61  #define opj_read_double opj_read_double_LE
62  #define opj_write_float opj_write_float_LE
63  #define opj_read_float opj_read_float_LE
64 #endif
65 
66 
67 
68 typedef enum
69 {
70  opj_signed_sentinel = -1, /* do not use in code */
71  opj_stream_e_output = 0x1,
72  opj_stream_e_input = 0x2,
73  opj_stream_e_end = 0x4,
74  opj_stream_e_error = 0x8
75 }
76 opj_stream_flag ;
77 
81 typedef struct opj_stream_private
82 {
86  void * m_user_data;
87 
91  OPJ_UINT64 m_user_data_length;
92 
96  opj_stream_read_fn m_read_fn;
97 
101  opj_stream_write_fn m_write_fn;
102 
107  opj_stream_skip_fn m_skip_fn;
108 
112  opj_stream_seek_fn m_seek_fn;
113 
118  OPJ_BYTE * m_stored_data;
119 
123  OPJ_BYTE * m_current_data;
124 
128  OPJ_OFF_T (* m_opj_skip)(struct opj_stream_private * ,OPJ_OFF_T , struct opj_event_mgr *);
129 
133  OPJ_BOOL (* m_opj_seek) (struct opj_stream_private * , OPJ_OFF_T , struct opj_event_mgr *);
134 
138  OPJ_SIZE_T m_bytes_in_buffer;
139 
143  OPJ_OFF_T m_byte_offset;
144 
148  OPJ_SIZE_T m_buffer_size;
149 
153  opj_stream_flag m_status;
154 
155 }
156 opj_stream_private_t;
157 
160 /* ----------------------------------------------------------------------- */
167 void opj_write_bytes_BE (OPJ_BYTE * p_buffer, OPJ_UINT32 p_value, OPJ_UINT32 p_nb_bytes);
168 
176 void opj_read_bytes_BE(const OPJ_BYTE * p_buffer, OPJ_UINT32 * p_value, OPJ_UINT32 p_nb_bytes);
177 
185 void opj_write_bytes_LE (OPJ_BYTE * p_buffer, OPJ_UINT32 p_value, OPJ_UINT32 p_nb_bytes);
186 
194 void opj_read_bytes_LE(const OPJ_BYTE * p_buffer, OPJ_UINT32 * p_value, OPJ_UINT32 p_nb_bytes);
195 
196 
202 void opj_write_double_LE(OPJ_BYTE * p_buffer, OPJ_FLOAT64 p_value);
203 
204 /***
205  * Write some bytes to the given data buffer, this function is used in Big Endian cpus.
206  * @param p_buffer pointer the data buffer to write data to.
207  * @param p_value the value to write
208  */
209 void opj_write_double_BE(OPJ_BYTE * p_buffer, OPJ_FLOAT64 p_value);
210 
216 void opj_read_double_LE(const OPJ_BYTE * p_buffer, OPJ_FLOAT64 * p_value);
217 
223 void opj_read_double_BE(const OPJ_BYTE * p_buffer, OPJ_FLOAT64 * p_value);
224 
230 void opj_read_float_LE(const OPJ_BYTE * p_buffer, OPJ_FLOAT32 * p_value);
231 
237 void opj_read_float_BE(const OPJ_BYTE * p_buffer, OPJ_FLOAT32 * p_value);
238 
244 void opj_write_float_LE(OPJ_BYTE * p_buffer, OPJ_FLOAT32 p_value);
245 
246 /***
247  * Write some bytes to the given data buffer, this function is used in Big Endian cpus.
248  * @param p_buffer pointer the data buffer to write data to.
249  * @param p_value the value to write
250  */
251 void opj_write_float_BE(OPJ_BYTE * p_buffer, OPJ_FLOAT32 p_value);
252 
261 OPJ_SIZE_T opj_stream_read_data (opj_stream_private_t * p_stream,OPJ_BYTE * p_buffer, OPJ_SIZE_T p_size, struct opj_event_mgr * p_event_mgr);
262 
271 OPJ_SIZE_T opj_stream_write_data (opj_stream_private_t * p_stream,const OPJ_BYTE * p_buffer, OPJ_SIZE_T p_size, struct opj_event_mgr * p_event_mgr);
272 
279 OPJ_BOOL opj_stream_flush (opj_stream_private_t * p_stream, struct opj_event_mgr * p_event_mgr);
280 
288 OPJ_OFF_T opj_stream_skip (opj_stream_private_t * p_stream,OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
289 
297 OPJ_OFF_T opj_stream_tell (const opj_stream_private_t * p_stream);
298 
299 
307 OPJ_OFF_T opj_stream_get_number_byte_left (const opj_stream_private_t * p_stream);
308 
316 OPJ_OFF_T opj_stream_write_skip (opj_stream_private_t * p_stream, OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
317 
325 OPJ_OFF_T opj_stream_read_skip (opj_stream_private_t * p_stream, OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
326 
334 OPJ_BOOL opj_stream_read_seek (opj_stream_private_t * p_stream, OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
335 
343 OPJ_BOOL opj_stream_write_seek (opj_stream_private_t * p_stream, OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
344 
352 OPJ_BOOL opj_stream_seek (opj_stream_private_t * p_stream, OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
353 
357 OPJ_BOOL opj_stream_has_seek (const opj_stream_private_t * p_stream);
358 
362 OPJ_SIZE_T opj_stream_default_read (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data);
363 
367 OPJ_SIZE_T opj_stream_default_write (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data);
368 
372 OPJ_OFF_T opj_stream_default_skip (OPJ_OFF_T p_nb_bytes, void * p_user_data);
373 
377 OPJ_BOOL opj_stream_default_seek (OPJ_OFF_T p_nb_bytes, void * p_user_data);
378 
379 /* ----------------------------------------------------------------------- */
383 
384 
385 #endif /* __CIO_H */
386 
Generated by   doxygen 1.8.3.1