examples/sfexamples/oggvorbiscodec/src/libogg/doc/ogg/bitpacking.html

00001 <html>
00002 
00003 <head>
00004 <title>libogg - Bitpacking Functions</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007 
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>libogg documentation</p></td>
00012 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>Bitpacking Functions</h1>
00017 <p>Libogg contains a basic bitpacking library that is useful for manipulating data within a buffer.
00018 <p>
00019 All the <b>libogg</b> specific functions are declared in "ogg/ogg.h".
00020 <p>
00021 
00022 <table border=1 color=black width=50% cellspacing=0 cellpadding=7>
00023 <tr bgcolor=#cccccc>
00024         <td><b>function</b></td>
00025         <td><b>purpose</b></td>
00026 </tr>
00027 <tr valign=top>
00028 <td><a href="oggpack_writeinit.html">oggpack_writeinit</a></td>
00029         <td>Initializes a buffer for writing using this bitpacking library.</td>
00030 </tr>
00031 <tr valign=top>
00032 <td><a href="oggpack_reset.html">oggpack_reset</a></td>
00033         <td>Clears and resets the buffer to the initial position.</td>
00034 </tr>
00035 <tr valign=top>
00036 <td><a href="oggpack_writeclear.html">oggpack_writeclear</a></td>
00037         <td>Frees the memory used by the buffer.</td>
00038 </tr>
00039 <tr valign=top>
00040 <td><a href="oggpack_readinit.html">oggpack_readinit</a></td>
00041         <td>Initializes a buffer for reading using this bitpacking library.</td>
00042 </tr>
00043 <tr valign=top>
00044 <td><a href="oggpack_write.html">oggpack_write</a></td>
00045         <td>Writes bytes to the specified location within the buffer.</td>
00046 </tr>
00047 <tr valign=top>
00048 <td><a href="oggpack_look.html">oggpack_look</a></td>
00049         <td>Look at a specified number of bits, <=32, without advancing the location pointer.</td>
00050 </tr>
00051 <tr valign=top>
00052 <td><a href="oggpack_look1.html">oggpack_look1</a></td>
00053         <td>Looks at one bit without advancing the location pointer.</td>
00054 </tr>
00055 <tr valign=top>
00056 <td><a href="oggpack_adv.html">oggpack_adv</a></td>
00057         <td>Advances the location pointer by a specified number of bits.</td>
00058 </tr>
00059 <tr valign=top>
00060 <td><a href="oggpack_adv1.html">oggpack_adv1</a></td>
00061         <td>Advances the location pointer by one bit.</td>
00062 </tr>
00063 <tr valign=top>
00064 <td><a href="oggpack_read.html">oggpack_read</a></td>
00065         <td>Reads a specified number of bits from the buffer.</td>
00066 </tr>
00067 <tr valign=top>
00068 <td><a href="oggpack_read1.html">oggpack_read1</a></td>
00069         <td>Reads one bit from the buffer.</td>
00070 </tr>
00071 <tr valign=top>
00072 <td><a href="oggpack_bytes.html">oggpack_bytes</a></td>
00073         <td>Returns the total number of bytes contained within the buffer.</td>
00074 </tr>
00075 <tr valign=top>
00076 <td><a href="oggpack_bits.html">oggpack_bits</a></td>
00077         <td>Returns the total number of bits contained within the buffer.</td>
00078 </tr>
00079 <tr valign=top>
00080 <td><a href="oggpack_get_buffer.html">oggpack_get_buffer</a></td>
00081         <td>Returns a pointer to the buffer encapsulated within the <a href="oggpack_buffer.html">oggpack_buffer</a> struct.</td>
00082 </tr>
00083 </table>
00084 
00085 <br><br>
00086 <hr noshade>
00087 <table border=0 width=100%>
00088 <tr valign=top>
00089 <td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
00090 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
00091 </tr><tr>
00092 <td><p class=tiny>libogg documentation</p></td>
00093 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00094 </tr>
00095 </table>
00096 
00097 </body>
00098 
00099 </html>

Generated by  doxygen 1.6.2