Speex  1.2~beta4
speex_bits.h
Go to the documentation of this file.
1 /* Copyright (C) 2002 Jean-Marc Valin */
6 /*
7  Redistribution and use in source and binary forms, with or without
8  modification, are permitted provided that the following conditions
9  are met:
10 
11  - Redistributions of source code must retain the above copyright
12  notice, this list of conditions and the following disclaimer.
13 
14  - 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  - Neither the name of the Xiph.org Foundation nor the names of its
19  contributors may be used to endorse or promote products derived from
20  this software without specific prior written permission.
21 
22  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
26  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef BITS_H
37 #define BITS_H
38 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
49 typedef struct SpeexBits {
50  char *chars;
51  int nbBits;
52  int charPtr;
53  int bitPtr;
54  int owner;
55  int overflow;
56  int buf_size;
57  int reserved1;
58  void *reserved2;
59 } SpeexBits;
60 
62 void speex_bits_init(SpeexBits *bits);
63 
65 void speex_bits_init_buffer(SpeexBits *bits, void *buff, int buf_size);
66 
68 void speex_bits_set_bit_buffer(SpeexBits *bits, void *buff, int buf_size);
69 
71 void speex_bits_destroy(SpeexBits *bits);
72 
74 void speex_bits_reset(SpeexBits *bits);
75 
77 void speex_bits_rewind(SpeexBits *bits);
78 
80 void speex_bits_read_from(SpeexBits *bits, char *bytes, int len);
81 
88 void speex_bits_read_whole_bytes(SpeexBits *bits, char *bytes, int len);
89 
97 int speex_bits_write(SpeexBits *bits, char *bytes, int max_len);
98 
100 int speex_bits_write_whole_bytes(SpeexBits *bits, char *bytes, int max_len);
101 
107 void speex_bits_pack(SpeexBits *bits, int data, int nbBits);
108 
115 int speex_bits_unpack_signed(SpeexBits *bits, int nbBits);
116 
123 unsigned int speex_bits_unpack_unsigned(SpeexBits *bits, int nbBits);
124 
130 int speex_bits_nbytes(SpeexBits *bits);
131 
138 unsigned int speex_bits_peek_unsigned(SpeexBits *bits, int nbBits);
139 
146 int speex_bits_peek(SpeexBits *bits);
147 
153 void speex_bits_advance(SpeexBits *bits, int n);
154 
161 
168 
169 #ifdef __cplusplus
170 }
171 #endif
172 
173 /* @} */
174 #endif
SpeexBits::overflow
int overflow
Definition: speex_bits.h:55
speex_bits_peek
int speex_bits_peek(SpeexBits *bits)
speex_bits_reset
void speex_bits_reset(SpeexBits *bits)
SpeexBits::buf_size
int buf_size
Definition: speex_bits.h:56
speex_bits_read_whole_bytes
void speex_bits_read_whole_bytes(SpeexBits *bits, char *bytes, int len)
SpeexBits
Definition: speex_bits.h:49
speex_bits_init_buffer
void speex_bits_init_buffer(SpeexBits *bits, void *buff, int buf_size)
speex_bits_destroy
void speex_bits_destroy(SpeexBits *bits)
speex_bits_write_whole_bytes
int speex_bits_write_whole_bytes(SpeexBits *bits, char *bytes, int max_len)
SpeexBits::charPtr
int charPtr
Definition: speex_bits.h:52
SpeexBits
struct SpeexBits SpeexBits
speex_bits_advance
void speex_bits_advance(SpeexBits *bits, int n)
speex_bits_set_bit_buffer
void speex_bits_set_bit_buffer(SpeexBits *bits, void *buff, int buf_size)
speex_bits_nbytes
int speex_bits_nbytes(SpeexBits *bits)
SpeexBits::chars
char * chars
Definition: speex_bits.h:50
speex_bits_rewind
void speex_bits_rewind(SpeexBits *bits)
SpeexBits::nbBits
int nbBits
Definition: speex_bits.h:51
speex_bits_unpack_signed
int speex_bits_unpack_signed(SpeexBits *bits, int nbBits)
speex_bits_insert_terminator
void speex_bits_insert_terminator(SpeexBits *bits)
SpeexBits::reserved1
int reserved1
Definition: speex_bits.h:57
speex_bits_write
int speex_bits_write(SpeexBits *bits, char *bytes, int max_len)
speex_bits_peek_unsigned
unsigned int speex_bits_peek_unsigned(SpeexBits *bits, int nbBits)
SpeexBits::reserved2
void * reserved2
Definition: speex_bits.h:58
SpeexBits::owner
int owner
Definition: speex_bits.h:54
speex_bits_init
void speex_bits_init(SpeexBits *bits)
speex_bits_read_from
void speex_bits_read_from(SpeexBits *bits, char *bytes, int len)
speex_bits_pack
void speex_bits_pack(SpeexBits *bits, int data, int nbBits)
speex_bits_unpack_unsigned
unsigned int speex_bits_unpack_unsigned(SpeexBits *bits, int nbBits)
SpeexBits::bitPtr
int bitPtr
Definition: speex_bits.h:53
speex_bits_remaining
int speex_bits_remaining(SpeexBits *bits)