bitpacking.html 3.3 KB

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