Mercurial > hg > sv-dependency-builds

annotate src/libogg-1.3.0/doc/libogg/bitpacking.html @ 86:98c1576536ae

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Bring in flac, ogg, vorbis
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
cannam@86 1 <html>
cannam@86 2
cannam@86 3 <head>
cannam@86 4 <title>libogg - Bitpacking Functions</title>
cannam@86 5 <link rel=stylesheet href="style.css" type="text/css">
cannam@86 6 </head>
cannam@86 7
cannam@86 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
cannam@86 9 <table border=0 width=100%>
cannam@86 10 <tr>
cannam@86 11 <td><p class=tiny>libogg documentation</p></td>
cannam@86 12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
cannam@86 13 </tr>
cannam@86 14 </table>
cannam@86 15
cannam@86 16 <h1>Bitpacking Functions</h1>
cannam@86 17 <p>Libogg contains a basic bitpacking library that is useful for manipulating data within a buffer.
cannam@86 18 <p>
cannam@86 19 All the <b>libogg</b> specific functions are declared in "ogg/ogg.h".
cannam@86 20 <p>
cannam@86 21
cannam@86 22 <table border=1 color=black width=50% cellspacing=0 cellpadding=7>
cannam@86 23 <tr bgcolor=#cccccc>
cannam@86 24 <td><b>function</b></td>
cannam@86 25 <td><b>purpose</b></td>
cannam@86 26 </tr>
cannam@86 27 <tr valign=top>
cannam@86 28 <td><a href="oggpack_writeinit.html">oggpack_writeinit</a></td>
cannam@86 29 <td>Initializes a buffer for writing using this bitpacking library.</td>
cannam@86 30 </tr>
cannam@86 31 <tr valign=top>
cannam@86 32 <td><a href="oggpack_writecheck.html">oggpack_writecheck</a></td>
cannam@86 33 <td>Asynchronously checks error status of bitpacker write buffer.</td>
cannam@86 34 </tr>
cannam@86 35 <tr valign=top>
cannam@86 36 <td><a href="oggpack_reset.html">oggpack_reset</a></td>
cannam@86 37 <td>Clears and resets the buffer to the initial position.</td>
cannam@86 38 </tr>
cannam@86 39 <tr valign=top>
cannam@86 40 <td><a href="oggpack_writeclear.html">oggpack_writeclear</a></td>
cannam@86 41 <td>Frees the memory used by the buffer.</td>
cannam@86 42 </tr>
cannam@86 43 <tr valign=top>
cannam@86 44 <td><a href="oggpack_readinit.html">oggpack_readinit</a></td>
cannam@86 45 <td>Initializes a buffer for reading using this bitpacking library.</td>
cannam@86 46 </tr>
cannam@86 47 <tr valign=top>
cannam@86 48 <td><a href="oggpack_write.html">oggpack_write</a></td>
cannam@86 49 <td>Writes bytes to the specified location within the buffer.</td>
cannam@86 50 </tr>
cannam@86 51 <tr valign=top>
cannam@86 52 <td><a href="oggpack_look.html">oggpack_look</a></td>
cannam@86 53 <td>Look at a specified number of bits, <=32, without advancing the location pointer.</td>
cannam@86 54 </tr>
cannam@86 55 <tr valign=top>
cannam@86 56 <td><a href="oggpack_look1.html">oggpack_look1</a></td>
cannam@86 57 <td>Looks at one bit without advancing the location pointer.</td>
cannam@86 58 </tr>
cannam@86 59 <tr valign=top>
cannam@86 60 <td><a href="oggpack_adv.html">oggpack_adv</a></td>
cannam@86 61 <td>Advances the location pointer by a specified number of bits.</td>
cannam@86 62 </tr>
cannam@86 63 <tr valign=top>
cannam@86 64 <td><a href="oggpack_adv1.html">oggpack_adv1</a></td>
cannam@86 65 <td>Advances the location pointer by one bit.</td>
cannam@86 66 </tr>
cannam@86 67 <tr valign=top>
cannam@86 68 <td><a href="oggpack_read.html">oggpack_read</a></td>
cannam@86 69 <td>Reads a specified number of bits from the buffer.</td>
cannam@86 70 </tr>
cannam@86 71 <tr valign=top>
cannam@86 72 <td><a href="oggpack_read1.html">oggpack_read1</a></td>
cannam@86 73 <td>Reads one bit from the buffer.</td>
cannam@86 74 </tr>
cannam@86 75 <tr valign=top>
cannam@86 76 <td><a href="oggpack_bytes.html">oggpack_bytes</a></td>
cannam@86 77 <td>Returns the total number of bytes contained within the buffer.</td>
cannam@86 78 </tr>
cannam@86 79 <tr valign=top>
cannam@86 80 <td><a href="oggpack_bits.html">oggpack_bits</a></td>
cannam@86 81 <td>Returns the total number of bits contained within the buffer.</td>
cannam@86 82 </tr>
cannam@86 83 <tr valign=top>
cannam@86 84 <td><a href="oggpack_get_buffer.html">oggpack_get_buffer</a></td>
cannam@86 85 <td>Returns a pointer to the buffer encapsulated within the <a href="oggpack_buffer.html">oggpack_buffer</a> struct.</td>
cannam@86 86 </tr>
cannam@86 87 </table>
cannam@86 88
cannam@86 89 <br><br>
cannam@86 90 <hr noshade>
cannam@86 91 <table border=0 width=100%>
cannam@86 92 <tr valign=top>
cannam@86 93 <td><p class=tiny>copyright &copy; 2000-2011 Xiph.Org</p></td>
cannam@86 94 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
cannam@86 95 </tr><tr>
cannam@86 96 <td><p class=tiny>libogg documentation</p></td>
cannam@86 97 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
cannam@86 98 </tr>
cannam@86 99 </table>
cannam@86 100
cannam@86 101 </body>
cannam@86 102
cannam@86 103 </html>