examples/sfexamples/oggvorbiscodec/src/libvorbis/doc/vorbisfile/datastructures.html

00001 <html>
00002 
00003 <head>
00004 <title>Vorbisfile - Base Data Structures</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007 
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>Vorbisfile documentation</p></td>
00012 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>Base Data Structures</h1>
00017 <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".
00018 <p>
00019 <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.
00020 <br><br>
00021 
00022 <table border=1 color=black width=50% cellspacing=0 cellpadding=7>
00023 <tr bgcolor=#cccccc>
00024         <td><b>datatype</b></td>
00025         <td><b>purpose</b></td>
00026 </tr>
00027 <tr valign=top>
00028         <td><a href="OggVorbis_File.html">OggVorbis_File</a></td>
00029         <td>This structure represents the basic file information. It contains 
00030         a pointer to the physical file or bitstream and various information about that bitstream.</td>
00031 </tr>
00032 <tr valign=top>
00033 <td><a href="vorbis_comment.html">vorbis_comment</a></td>
00034         <td>This structure contains the file comments. It contains 
00035         a pointer to unlimited user comments, information about the number of comments, and a vendor description.</td>
00036 </tr>
00037 <tr valign=top>
00038 <td><a href="vorbis_info.html">vorbis_info</a></td>
00039         <td>This structure contains encoder-related information about the bitstream.  It includes encoder info, channel info, and bitrate limits.</td>
00040 </tr>
00041 <tr valign=top>
00042 <td><a href="ov_callbacks.html">ov_callbacks</a></td>
00043         <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>
00044 </tr>
00045 </table>
00046 
00047 <br><br>
00048 <hr noshade>
00049 <table border=0 width=100%>
00050 <tr valign=top>
00051 <td><p class=tiny>copyright &copy; 2003 Xiph.org</p></td>
00052 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00053 </tr><tr>
00054 <td><p class=tiny>Vorbisfile documentation</p></td>
00055 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00056 </tr>
00057 </table>
00058 
00059 </body>
00060 
00061 </html>

Generated by  doxygen 1.6.2