GLog: Workaround compilation error on Hurd
[blender-staging.git] / extern / libopenjpeg / raw.h
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) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
5  * Copyright (c) 2005, Herve Drolon, FreeImage Team
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef __RAW_H
31 #define __RAW_H
32 /**
33 @file raw.h
34 @brief Implementation of operations for raw encoding (RAW)
35
36 The functions in RAW.C have for goal to realize the operation of raw encoding linked
37 with the corresponding mode switch.
38 */
39
40 /** @defgroup RAW RAW - Implementation of operations for raw encoding */
41 /*@{*/
42
43 /**
44 RAW encoding operations
45 */
46 typedef struct opj_raw {
47         /** temporary buffer where bits are coded or decoded */
48         unsigned char c;
49         /** number of bits already read or free to write */
50         unsigned int ct;
51         /** maximum length to decode */
52         unsigned int lenmax;
53         /** length decoded */
54         unsigned int len;
55         /** pointer to the current position in the buffer */
56         unsigned char *bp;
57         /** pointer to the start of the buffer */
58         unsigned char *start;
59         /** pointer to the end of the buffer */
60         unsigned char *end;
61 } opj_raw_t;
62
63 /** @name Exported functions */
64 /*@{*/
65 /* ----------------------------------------------------------------------- */
66 /**
67 Create a new RAW handle 
68 @return Returns a new RAW handle if successful, returns NULL otherwise
69 */
70 opj_raw_t* raw_create(void);
71 /**
72 Destroy a previously created RAW handle
73 @param raw RAW handle to destroy
74 */
75 void raw_destroy(opj_raw_t *raw);
76 /**
77 Return the number of bytes written/read since initialisation
78 @param raw RAW handle to destroy
79 @return Returns the number of bytes already encoded
80 */
81 int raw_numbytes(opj_raw_t *raw);
82 /**
83 Initialize the decoder
84 @param raw RAW handle
85 @param bp Pointer to the start of the buffer from which the bytes will be read
86 @param len Length of the input buffer
87 */
88 void raw_init_dec(opj_raw_t *raw, unsigned char *bp, int len);
89 /**
90 Decode a symbol using raw-decoder. Cfr p.506 TAUBMAN
91 @param raw RAW handle
92 @return Returns the decoded symbol (0 or 1)
93 */
94 int raw_decode(opj_raw_t *raw);
95 /* ----------------------------------------------------------------------- */
96 /*@}*/
97
98 /*@}*/
99
100 #endif /* __RAW_H */