9f5e4ab62b55f1d9c6a3e3e275f8293a2f8cc295
[speexdsp.git] / libspeex / speex_bits.h
1 /* Copyright (C) 2002 Jean-Marc Valin 
2    File: speex_bits.h
3
4    Handles bit packing/unpacking
5
6    This library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10    
11    This library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15    
16    You should have received a copy of the GNU Lesser General Public
17    License along with this library; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
20 */
21
22 #ifndef BITS_H
23 #define BITS_H
24
25 #define MAX_BYTES_PER_FRAME 1000
26
27 typedef struct FrameBits {
28    char bytes[MAX_BYTES_PER_FRAME];
29    int  nbBits;
30    int  bytePtr;
31    int  bitPtr;
32 } FrameBits;
33
34 void frame_bits_init(FrameBits *bits);
35
36 void frame_bits_destroy(FrameBits *bits);
37
38 void frame_bits_reset(FrameBits *bits);
39
40 void frame_bits_rewind(FrameBits *bits);
41
42 void frame_bits_init_from(FrameBits *bits, char *bytes, int len);
43
44 void frame_bits_read_whole_bytes(FrameBits *bits, char *bytes, int len);
45
46 int frame_bits_write(FrameBits *bits, char *bytes, int max_len);
47
48 int frame_bits_write_whole_bytes(FrameBits *bits, char *bytes, int max_len);
49
50 void frame_bits_pack(FrameBits *bits, int data, int nbBits);
51
52 int frame_bits_unpack_signed(FrameBits *bits, int nbBits);
53
54 unsigned int frame_bits_unpack_unsigned(FrameBits *bits, int nbBits);
55
56
57 #endif