vorbis/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.3.2 - 20101101</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 libvorbisfile decoding. These structures are declared in "vorbis/vorbisfile.h" and "vorbis/codec.h".
  18 <p>
  19 <p>When using libvorbisfile, it's not necessary to know about most of the contents of these data structures, but it may be helpful to understand what they contain.
  20 <br><br>
  21
  22 <table border=1 color=black width=50% cellspacing=0 cellpadding=7>
  23 <tr bgcolor=#cccccc>
  24         <td><b>datatype</b></td>
  25         <td><b>purpose</b></td>
  26 </tr>
  27 <tr valign=top>
  28         <td><a href="OggVorbis_File.html">OggVorbis_File</a></td>
  29         <td>This structure represents the basic file information. It contains
  30         a pointer to the physical file or bitstream and various information about that bitstream.</td>
  31 </tr>
  32 <tr valign=top>
  33 <td><a href="../libvorbis/vorbis_comment.html">vorbis_comment</a></td>
  34         <td>This structure contains the file comments. It contains
  35         a pointer to unlimited user comments, information about the number of comments, and a vendor description.</td>
  36 </tr>
  37 <tr valign=top>
  38 <td><a href="../libvorbis/vorbis_info.html">vorbis_info</a></td>
  39         <td>This structure contains encoder-related information about the bitstream.  It includes encoder info, channel info, and bitrate limits.</td>
  40 </tr>
  41 <tr valign=top>
  42 <td><a href="ov_callbacks.html">ov_callbacks</a></td>
  43         <td>This structure contains pointers to the application-specified file manipulation routines set for use by <a href="ov_open_callbacks.html">ov_open_callbacks()</a>. See also the <a href="callbacks.html">provided document on using application-provided callbacks instead of stdio</a>.</td>
  44 </tr>
  45 </table>
  46
  47 <br><br>
  48 <hr noshade>
  49 <table border=0 width=100%>
  50 <tr valign=top>
  51 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
  52 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  53 </tr><tr>
  54 <td><p class=tiny>Vorbisfile documentation</p></td>
  55 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
  56 </tr>
  57 </table>
  58
  59 </body>
  60
  61 </html>