2 * Copyright (c) 2001-2003, David Janssens
3 * Copyright (c) 2002-2003, Yannick Verschueren
4 * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
5 * Copyright (c) 2005, Herv� Drolon, FreeImage Team
6 * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
36 @brief Implementation of a byte input-output process (CIO)
38 The functions in CIO.C have for goal to realize a byte input / output process.
41 /** @defgroup CIO CIO - byte input-output stream */
44 /** @name Exported functions (see also openjpeg.h) */
46 /* ----------------------------------------------------------------------- */
48 Number of bytes left before the end of the stream
50 @return Returns the number of bytes before the end of the stream
52 int cio_numbytesleft(opj_cio_t *cio);
54 Get pointer to the current position in the stream
56 @return Returns a pointer to the current position
58 unsigned char *cio_getbp(opj_cio_t *cio);
62 @param v Value to write
63 @param n Number of bytes to write
64 @return Returns the number of bytes written or 0 if an error occured
66 unsigned int cio_write(opj_cio_t *cio, unsigned int v, int n);
70 @param n Number of bytes to read
71 @return Returns the value of the n bytes read
73 unsigned int cio_read(opj_cio_t *cio, int n);
77 @param n Number of bytes to skip
79 void cio_skip(opj_cio_t *cio, int n);
80 /* ----------------------------------------------------------------------- */