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