doc/vorbisfile/datastructures.html

   1 <html>
   2
   3 <head>
   4 <title>vorbisfile - Base Data Structures</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>vorbisfile documentation</p></td>
  12 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>Base Data Structures</h1>
  17 <p>There are several data structures used to hold file and bitstream information during vorbisfile decoding.
  18 <p>
  19 All the <b>vorbisfile</b> specific data structures are declared in "vorbis/vorbisfile.h" or "vorbis/codec.h".
  20 <p>\r
  21 <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.\r
  22 <br><br>
  23
  24 <table border=1 color=black width=50% cellspacing=0 cellpadding=7>
  25 <tr bgcolor=#cccccc>
  26         <td><b>datatype</b></td>
  27         <td><b>purpose</b></td>
  28 </tr>
  29 <tr valign=top>
  30         <td><a href="OggVorbis_File.html">OggVorbis_File</a></td>
  31         <td>This structure represents the basic file information. It contains
  32         a pointer to the physical file or bitstream and various information about that bitstream.</td>
  33 </tr>
  34 <tr valign=top>
  35 <td><a href="vorbis_comment.html">vorbis_comment</a></td>
  36         <td>This structure contains the file comments. It contains
  37         a pointer to unlimited user comments, information about the number of comments, and a vendor description.</td>
  38 </tr>
  39 <tr valign=top>
  40 <td><a href="vorbis_info.html">vorbis_info</a></td>
  41         <td>This structure contains encoder-related information about the bitstream.  It includes encoder info, channel info, and bitrate limits.</td>
  42 </tr>
  43 <tr valign=top>
  44 <td><a href="ov_callbacks.html">ov_callbacks</a></td>
  45         <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>
  46 </tr>
  47 </table>
  48
  49 <br><br>
  50 <hr noshade>
  51 <table border=0 width=100%>
  52 <tr valign=top>
  53 <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  54 <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>
  55 </tr><tr>
  56 <td><p class=tiny>vorbisfile documentation</p></td>
  57 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  58 </tr>
  59 </table>
  60
  61 </body>
  62
  63 </html>