]> Creatis software - gdcm.git/blob - src/gdcmopenjpeg/libopenjpeg/cio.h
0f4048b74c090bbced8ab819237d1157dbd38356
[gdcm.git] / src / gdcmopenjpeg / libopenjpeg / cio.h
1 /*
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
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
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.
17  *
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.
29  */
30
31 #ifndef __CIO_H
32 #define __CIO_H
33 /**
34 @file cio.h
35 @brief Implementation of a byte input-output process (CIO)
36
37 The functions in CIO.C have for goal to realize a byte input / output process.
38 */
39
40 /** @defgroup CIO CIO - byte input-output stream */
41 /*@{*/
42
43 /** @name Exported functions (see also openjpeg.h) */
44 /*@{*/
45 /* ----------------------------------------------------------------------- */
46 /**
47 Number of bytes left before the end of the stream
48 @param cio CIO handle
49 @return Returns the number of bytes before the end of the stream
50 */
51 int cio_numbytesleft(opj_cio_t *cio);
52 /**
53 Get pointer to the current position in the stream
54 @param cio CIO handle
55 @return Returns a pointer to the current position
56 */
57 unsigned char *cio_getbp(opj_cio_t *cio);
58 /**
59 Write some bytes
60 @param cio CIO handle
61 @param v Value to write
62 @param n Number of bytes to write
63 @return Returns the number of bytes written or 0 if an error occured
64 */
65 unsigned int cio_write(opj_cio_t *cio, unsigned int v, int n);
66 /**
67 Read some bytes
68 @param cio CIO handle
69 @param n Number of bytes to read
70 @return Returns the value of the n bytes read
71 */
72 unsigned int cio_read(opj_cio_t *cio, int n);
73 /**
74 Skip some bytes
75 @param cio CIO handle
76 @param n Number of bytes to skip
77 */
78 void cio_skip(opj_cio_t *cio, int n);
79 /* ----------------------------------------------------------------------- */
80 /*@}*/
81
82 /*@}*/
83
84 #endif /* __CIO_H */
85