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