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.
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.
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
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.
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.
44 @brief Implementation of a byte input-output process (CIO)
46 The functions in CIO.C have for goal to realize a byte input / output process.
49 /** @defgroup CIO CIO - byte input-output stream */
52 #include "opj_config_private.h"
54 /* ----------------------------------------------------------------------- */
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
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
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
79 Byte input-output stream.
81 typedef struct opj_stream_private
84 * User data, be it files, ... The actual data depends on the type of the stream.
89 * Pointer to function to free m_user_data (NULL at initialization)
90 * when destroying the stream. If pointer is NULL the function is not
91 * called and the m_user_data is not freed (even if non-NULL).
93 opj_stream_free_user_data_fn m_free_user_data_fn;
98 OPJ_UINT64 m_user_data_length;
101 * Pointer to actual read function (NULL at the initialization of the cio.
103 opj_stream_read_fn m_read_fn;
106 * Pointer to actual write function (NULL at the initialization of the cio.
108 opj_stream_write_fn m_write_fn;
111 * Pointer to actual skip function (NULL at the initialization of the cio.
112 * There is no seek function to prevent from back and forth slow procedures.
114 opj_stream_skip_fn m_skip_fn;
117 * Pointer to actual seek function (if available).
119 opj_stream_seek_fn m_seek_fn;
122 * Actual data stored into the stream if readed from. Data is read by chunk of fixed size.
123 * you should never access this data directly.
125 OPJ_BYTE * m_stored_data;
128 * Pointer to the current read data.
130 OPJ_BYTE * m_current_data;
135 OPJ_OFF_T (* m_opj_skip)(struct opj_stream_private * ,OPJ_OFF_T , struct opj_event_mgr *);
140 OPJ_BOOL (* m_opj_seek) (struct opj_stream_private * , OPJ_OFF_T , struct opj_event_mgr *);
143 * number of bytes containing in the buffer.
145 OPJ_SIZE_T m_bytes_in_buffer;
148 * The number of bytes read/written from the beginning of the stream
150 OPJ_OFF_T m_byte_offset;
153 * The size of the buffer.
155 OPJ_SIZE_T m_buffer_size;
158 * Flags to tell the status of the stream.
159 * Used with OPJ_STREAM_STATUS_* defines.
164 opj_stream_private_t;
166 /** @name Exported functions (see also openjpeg.h) */
168 /* ----------------------------------------------------------------------- */
170 * Write some bytes to the given data buffer, this function is used in Big Endian cpus.
171 * @param p_buffer pointer the data buffer to write data to.
172 * @param p_value the value to write
173 * @param p_nb_bytes the number of bytes to write
175 void opj_write_bytes_BE (OPJ_BYTE * p_buffer, OPJ_UINT32 p_value, OPJ_UINT32 p_nb_bytes);
178 * Reads some bytes from the given data buffer, this function is used in Big Endian cpus.
179 * @param p_buffer pointer the data buffer to read data from.
180 * @param p_value pointer to the value that will store the data.
181 * @param p_nb_bytes the nb bytes to read.
182 * @return the number of bytes read or -1 if an error occurred.
184 void opj_read_bytes_BE(const OPJ_BYTE * p_buffer, OPJ_UINT32 * p_value, OPJ_UINT32 p_nb_bytes);
187 * Write some bytes to the given data buffer, this function is used in Little Endian cpus.
188 * @param p_buffer pointer the data buffer to write data to.
189 * @param p_value the value to write
190 * @param p_nb_bytes the number of bytes to write
191 * @return the number of bytes written or -1 if an error occurred
193 void opj_write_bytes_LE (OPJ_BYTE * p_buffer, OPJ_UINT32 p_value, OPJ_UINT32 p_nb_bytes);
196 * Reads some bytes from the given data buffer, this function is used in Little Endian cpus.
197 * @param p_buffer pointer the data buffer to read data from.
198 * @param p_value pointer to the value that will store the data.
199 * @param p_nb_bytes the nb bytes to read.
200 * @return the number of bytes read or -1 if an error occurred.
202 void opj_read_bytes_LE(const OPJ_BYTE * p_buffer, OPJ_UINT32 * p_value, OPJ_UINT32 p_nb_bytes);
206 * Write some bytes to the given data buffer, this function is used in Little Endian cpus.
207 * @param p_buffer pointer the data buffer to write data to.
208 * @param p_value the value to write
210 void opj_write_double_LE(OPJ_BYTE * p_buffer, OPJ_FLOAT64 p_value);
213 * Write some bytes to the given data buffer, this function is used in Big Endian cpus.
214 * @param p_buffer pointer the data buffer to write data to.
215 * @param p_value the value to write
217 void opj_write_double_BE(OPJ_BYTE * p_buffer, OPJ_FLOAT64 p_value);
220 * Reads some bytes from the given data buffer, this function is used in Little Endian cpus.
221 * @param p_buffer pointer the data buffer to read data from.
222 * @param p_value pointer to the value that will store the data.
224 void opj_read_double_LE(const OPJ_BYTE * p_buffer, OPJ_FLOAT64 * p_value);
227 * Reads some bytes from the given data buffer, this function is used in Big Endian cpus.
228 * @param p_buffer pointer the data buffer to read data from.
229 * @param p_value pointer to the value that will store the data.
231 void opj_read_double_BE(const OPJ_BYTE * p_buffer, OPJ_FLOAT64 * p_value);
234 * Reads some bytes from the given data buffer, this function is used in Little Endian cpus.
235 * @param p_buffer pointer the data buffer to read data from.
236 * @param p_value pointer to the value that will store the data.
238 void opj_read_float_LE(const OPJ_BYTE * p_buffer, OPJ_FLOAT32 * p_value);
241 * Reads some bytes from the given data buffer, this function is used in Big Endian cpus.
242 * @param p_buffer pointer the data buffer to read data from.
243 * @param p_value pointer to the value that will store the data.
245 void opj_read_float_BE(const OPJ_BYTE * p_buffer, OPJ_FLOAT32 * p_value);
248 * Write some bytes to the given data buffer, this function is used in Little Endian cpus.
249 * @param p_buffer pointer the data buffer to write data to.
250 * @param p_value the value to write
252 void opj_write_float_LE(OPJ_BYTE * p_buffer, OPJ_FLOAT32 p_value);
255 * Write some bytes to the given data buffer, this function is used in Big Endian cpus.
256 * @param p_buffer pointer the data buffer to write data to.
257 * @param p_value the value to write
259 void opj_write_float_BE(OPJ_BYTE * p_buffer, OPJ_FLOAT32 p_value);
262 * Reads some bytes from the stream.
263 * @param p_stream the stream to read data from.
264 * @param p_buffer pointer to the data buffer that will receive the data.
265 * @param p_size number of bytes to read.
266 * @param p_event_mgr the user event manager to be notified of special events.
267 * @return the number of bytes read, or -1 if an error occurred or if the stream is at the end.
269 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);
272 * Writes some bytes to the stream.
273 * @param p_stream the stream to write data to.
274 * @param p_buffer pointer to the data buffer holds the data to be writtent.
275 * @param p_size number of bytes to write.
276 * @param p_event_mgr the user event manager to be notified of special events.
277 * @return the number of bytes writtent, or -1 if an error occurred.
279 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);
282 * Writes the content of the stream buffer to the stream.
283 * @param p_stream the stream to write data to.
284 * @param p_event_mgr the user event manager to be notified of special events.
285 * @return true if the data could be flushed, false else.
287 OPJ_BOOL opj_stream_flush (opj_stream_private_t * p_stream, struct opj_event_mgr * p_event_mgr);
290 * Skips a number of bytes from the stream.
291 * @param p_stream the stream to skip data from.
292 * @param p_size the number of bytes to skip.
293 * @param p_event_mgr the user event manager to be notified of special events.
294 * @return the number of bytes skipped, or -1 if an error occurred.
296 OPJ_OFF_T opj_stream_skip (opj_stream_private_t * p_stream,OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
299 * Tells the byte offset on the stream (similar to ftell).
301 * @param p_stream the stream to get the information from.
303 * @return the current position o fthe stream.
305 OPJ_OFF_T opj_stream_tell (const opj_stream_private_t * p_stream);
309 * Get the number of bytes left before the end of the stream (similar to cio_numbytesleft).
311 * @param p_stream the stream to get the information from.
313 * @return Number of bytes left before the end of the stream.
315 OPJ_OFF_T opj_stream_get_number_byte_left (const opj_stream_private_t * p_stream);
318 * Skips a number of bytes from the stream.
319 * @param p_stream the stream to skip data from.
320 * @param p_size the number of bytes to skip.
321 * @param p_event_mgr the user event manager to be notified of special events.
322 * @return the number of bytes skipped, or -1 if an error occurred.
324 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);
327 * Skips a number of bytes from the stream.
328 * @param p_stream the stream to skip data from.
329 * @param p_size the number of bytes to skip.
330 * @param p_event_mgr the user event manager to be notified of special events.
331 * @return the number of bytes skipped, or -1 if an error occurred.
333 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);
336 * Skips a number of bytes from the stream.
337 * @param p_stream the stream to skip data from.
338 * @param p_size the number of bytes to skip.
339 * @param p_event_mgr the user event manager to be notified of special events.
340 * @return OPJ_TRUE if success, or OPJ_FALSE if an error occurred.
342 OPJ_BOOL opj_stream_read_seek (opj_stream_private_t * p_stream, OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
345 * Skips a number of bytes from the stream.
346 * @param p_stream the stream to skip data from.
347 * @param p_size the number of bytes to skip.
348 * @param p_event_mgr the user event manager to be notified of special events.
349 * @return the number of bytes skipped, or -1 if an error occurred.
351 OPJ_BOOL opj_stream_write_seek (opj_stream_private_t * p_stream, OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
354 * Seeks a number of bytes from the stream.
355 * @param p_stream the stream to skip data from.
356 * @param p_size the number of bytes to skip.
357 * @param p_event_mgr the user event manager to be notified of special events.
358 * @return true if the stream is seekable.
360 OPJ_BOOL opj_stream_seek (opj_stream_private_t * p_stream, OPJ_OFF_T p_size, struct opj_event_mgr * p_event_mgr);
363 * Tells if the given stream is seekable.
365 OPJ_BOOL opj_stream_has_seek (const opj_stream_private_t * p_stream);
370 OPJ_SIZE_T opj_stream_default_read (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data);
375 OPJ_SIZE_T opj_stream_default_write (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data);
380 OPJ_OFF_T opj_stream_default_skip (OPJ_OFF_T p_nb_bytes, void * p_user_data);
385 OPJ_BOOL opj_stream_default_seek (OPJ_OFF_T p_nb_bytes, void * p_user_data);
387 /* ----------------------------------------------------------------------- */