Main Page | Compound List | File List | Compound Members | File Members

speex_bits.h

Go to the documentation of this file.
00001 /* Copyright (C) 2002 Jean-Marc Valin */
00006 /*
00007    Redistribution and use in source and binary forms, with or without
00008    modification, are permitted provided that the following conditions
00009    are met:
00010    
00011    - Redistributions of source code must retain the above copyright
00012    notice, this list of conditions and the following disclaimer.
00013    
00014    - Redistributions in binary form must reproduce the above copyright
00015    notice, this list of conditions and the following disclaimer in the
00016    documentation and/or other materials provided with the distribution.
00017    
00018    - Neither the name of the Xiph.org Foundation nor the names of its
00019    contributors may be used to endorse or promote products derived from
00020    this software without specific prior written permission.
00021    
00022    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00023    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00024    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00025    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
00026    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00027    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00028    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00029    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00030    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00031    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00032    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 
00034 */
00035 
00036 #ifndef BITS_H
00037 #define BITS_H
00038 
00039 #ifdef __cplusplus
00040 extern "C" {
00041 #endif
00042 
00044 typedef struct SpeexBits {
00045    char *bytes;   
00046    int   nbBits;  
00047    int   bytePtr; 
00048    int   bitPtr;  
00049    int   owner;   
00050    int   overflow;
00051    int   buf_size;
00052    int   reserved1; 
00053    void *reserved2; 
00054 } SpeexBits;
00055 
00057 void speex_bits_init(SpeexBits *bits);
00058 
00060 void speex_bits_init_buffer(SpeexBits *bits, void *buff, int buf_size);
00061 
00063 void speex_bits_destroy(SpeexBits *bits);
00064 
00066 void speex_bits_reset(SpeexBits *bits);
00067 
00069 void speex_bits_rewind(SpeexBits *bits);
00070 
00072 void speex_bits_read_from(SpeexBits *bits, char *bytes, int len);
00073 
00079 void speex_bits_read_whole_bytes(SpeexBits *bits, char *bytes, int len);
00080 
00082 int speex_bits_write(SpeexBits *bits, char *bytes, int max_len);
00083 
00085 int speex_bits_write_whole_bytes(SpeexBits *bits, char *bytes, int max_len);
00086 
00092 void speex_bits_pack(SpeexBits *bits, int data, int nbBits);
00093 
00100 int speex_bits_unpack_signed(SpeexBits *bits, int nbBits);
00101 
00108 unsigned int speex_bits_unpack_unsigned(SpeexBits *bits, int nbBits);
00109 
00115 int speex_bits_nbytes(SpeexBits *bits);
00116 
00118 unsigned int speex_bits_peek_unsigned(SpeexBits *bits, int nbBits);
00119 
00125 int speex_bits_peek(SpeexBits *bits);
00126 
00132 void speex_bits_advance(SpeexBits *bits, int n);
00133 
00138 int speex_bits_remaining(SpeexBits *bits);
00139 
00145 void speex_bits_insert_terminator(SpeexBits *bits);
00146 
00147 #ifdef __cplusplus
00148 }
00149 #endif
00150 
00151 #endif

Generated on Sun Sep 21 16:07:08 2003 for speex by doxygen 1.3.2