datastructures.html 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. <html>
  2. <head>
  3. <title>vorbisfile - Base Data Structures</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>vorbisfile documentation</p></td>
  10. <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  11. </tr>
  12. </table>
  13. <h1>Base Data Structures</h1>
  14. <p>There are several data structures used to hold file and bitstream information during vorbisfile decoding.
  15. <p>
  16. All the <b>vorbisfile</b> specific data structures are declared in "vorbis/vorbisfile.h" or "vorbis/codec.h".
  17. <p>
  18. <p>When using vorbisfile, we usually won't need to know about most of the contents of these data structures, but it may be helpful to understand what they contain.
  19. <br><br>
  20. <table border=1 color=black width=50% cellspacing=0 cellpadding=7>
  21. <tr bgcolor=#cccccc>
  22. <td><b>datatype</b></td>
  23. <td><b>purpose</b></td>
  24. </tr>
  25. <tr valign=top>
  26. <td><a href="OggVorbis_File.html">OggVorbis_File</a></td>
  27. <td>This structure represents the basic file information. It contains
  28. a pointer to the physical file or bitstream and various information about that bitstream.</td>
  29. </tr>
  30. <tr valign=top>
  31. <td><a href="vorbis_comment.html">vorbis_comment</a></td>
  32. <td>This structure contains the file comments. It contains
  33. a pointer to unlimited user comments, information about the number of comments, and a vendor description.</td>
  34. </tr>
  35. <tr valign=top>
  36. <td><a href="vorbis_info.html">vorbis_info</a></td>
  37. <td>This structure contains encoder-related information about the bitstream. It includes encoder info, channel info, and bitrate limits.</td>
  38. </tr>
  39. <tr valign=top>
  40. <td><a href="ov_callbacks.html">ov_callbacks</a></td>
  41. <td>This structure contains pointers to file manipulation routines. Can be user-specified for use with <a href="ov_open_callbacks.html">ov_open_callbacks()</a>.</td>
  42. </tr>
  43. </table>
  44. <br><br>
  45. <hr noshade>
  46. <table border=0 width=100%>
  47. <tr valign=top>
  48. <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  49. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
  50. </tr><tr>
  51. <td><p class=tiny>vorbisfile documentation</p></td>
  52. <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  53. </tr>
  54. </table>
  55. </body>
  56. </html>