annotate src/libvorbis-1.3.3/doc/vorbisfile/datastructures.html @ 1:05aa0afa9217

Bring in flac, ogg, vorbis
author Chris Cannam
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
Chris@1 1 <html>
Chris@1 2
Chris@1 3 <head>
Chris@1 4 <title>Vorbisfile - Base Data Structures</title>
Chris@1 5 <link rel=stylesheet href="style.css" type="text/css">
Chris@1 6 </head>
Chris@1 7
Chris@1 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
Chris@1 9 <table border=0 width=100%>
Chris@1 10 <tr>
Chris@1 11 <td><p class=tiny>Vorbisfile documentation</p></td>
Chris@1 12 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
Chris@1 13 </tr>
Chris@1 14 </table>
Chris@1 15
Chris@1 16 <h1>Base Data Structures</h1>
Chris@1 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".
Chris@1 18 <p>
Chris@1 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.
Chris@1 20 <br><br>
Chris@1 21
Chris@1 22 <table border=1 color=black width=50% cellspacing=0 cellpadding=7>
Chris@1 23 <tr bgcolor=#cccccc>
Chris@1 24 <td><b>datatype</b></td>
Chris@1 25 <td><b>purpose</b></td>
Chris@1 26 </tr>
Chris@1 27 <tr valign=top>
Chris@1 28 <td><a href="OggVorbis_File.html">OggVorbis_File</a></td>
Chris@1 29 <td>This structure represents the basic file information. It contains
Chris@1 30 a pointer to the physical file or bitstream and various information about that bitstream.</td>
Chris@1 31 </tr>
Chris@1 32 <tr valign=top>
Chris@1 33 <td><a href="../libvorbis/vorbis_comment.html">vorbis_comment</a></td>
Chris@1 34 <td>This structure contains the file comments. It contains
Chris@1 35 a pointer to unlimited user comments, information about the number of comments, and a vendor description.</td>
Chris@1 36 </tr>
Chris@1 37 <tr valign=top>
Chris@1 38 <td><a href="../libvorbis/vorbis_info.html">vorbis_info</a></td>
Chris@1 39 <td>This structure contains encoder-related information about the bitstream. It includes encoder info, channel info, and bitrate limits.</td>
Chris@1 40 </tr>
Chris@1 41 <tr valign=top>
Chris@1 42 <td><a href="ov_callbacks.html">ov_callbacks</a></td>
Chris@1 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>
Chris@1 44 </tr>
Chris@1 45 </table>
Chris@1 46
Chris@1 47 <br><br>
Chris@1 48 <hr noshade>
Chris@1 49 <table border=0 width=100%>
Chris@1 50 <tr valign=top>
Chris@1 51 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
Chris@1 52 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
Chris@1 53 </tr><tr>
Chris@1 54 <td><p class=tiny>Vorbisfile documentation</p></td>
Chris@1 55 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
Chris@1 56 </tr>
Chris@1 57 </table>
Chris@1 58
Chris@1 59 </body>
Chris@1 60
Chris@1 61 </html>