aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/libraries/openjpeg-libsl/libopenjpeg/cio.h
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/openjpeg-libsl/libopenjpeg/cio.h')
-rw-r--r--libraries/openjpeg-libsl/libopenjpeg/cio.h86
1 files changed, 86 insertions, 0 deletions
diff --git a/libraries/openjpeg-libsl/libopenjpeg/cio.h b/libraries/openjpeg-libsl/libopenjpeg/cio.h
new file mode 100644
index 0000000..580bf9c
--- /dev/null
+++ b/libraries/openjpeg-libsl/libopenjpeg/cio.h
@@ -0,0 +1,86 @@
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 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef __CIO_H
33#define __CIO_H
34/**
35@file cio.h
36@brief Implementation of a byte input-output process (CIO)
37
38The functions in CIO.C have for goal to realize a byte input / output process.
39*/
40
41/** @defgroup CIO CIO - byte input-output stream */
42/*@{*/
43
44/** @name Exported functions (see also openjpeg.h) */
45/*@{*/
46/* ----------------------------------------------------------------------- */
47/**
48Number of bytes left before the end of the stream
49@param cio CIO handle
50@return Returns the number of bytes before the end of the stream
51*/
52int cio_numbytesleft(opj_cio_t *cio);
53/**
54Get pointer to the current position in the stream
55@param cio CIO handle
56@return Returns a pointer to the current position
57*/
58unsigned char *cio_getbp(opj_cio_t *cio);
59/**
60Write some bytes
61@param cio CIO handle
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
65*/
66unsigned int cio_write(opj_cio_t *cio, unsigned int v, int n);
67/**
68Read some bytes
69@param cio CIO handle
70@param n Number of bytes to read
71@return Returns the value of the n bytes read
72*/
73unsigned int cio_read(opj_cio_t *cio, int n);
74/**
75Skip some bytes
76@param cio CIO handle
77@param n Number of bytes to skip
78*/
79void cio_skip(opj_cio_t *cio, int n);
80/* ----------------------------------------------------------------------- */
81/*@}*/
82
83/*@}*/
84
85#endif /* __CIO_H */
86