]> git.jsancho.org Git - lugaru.git/blob - libogg-1.0/doc/ogg/vorbis_info.html
Added (more or less) demo data files.
[lugaru.git] / libogg-1.0 / doc / ogg / vorbis_info.html
1 <html>
2
3 <head>
4 <title>Vorbisfile - datatype - vorbis_info</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>libVorbisfile version 1.65 - 20020702</p></td>
13 </tr>
14 </table>
15
16 <h1>vorbis_info</h1>
17
18 <p><i>declared in "vorbis/codec.h"</i></p>
19
20 <p>
21 The vorbis_info structure contains basic information about the audio in a vorbis bitstream.
22 <p>
23
24 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
25 <tr bgcolor=#cccccc>
26         <td>
27 <pre><b>typedef struct vorbis_info{
28   int version;
29   int channels;
30   long rate;
31   
32   long bitrate_upper;
33   long bitrate_nominal;
34   long bitrate_lower;
35   long bitrate_window;
36
37   void *codec_setup;
38
39 } vorbis_info;</b></pre>
40         </td>
41 </tr>
42 </table>
43
44 <h3>Relevant Struct Members</h3>
45 <dl>
46 <dt><i>version</i></dt>
47 <dd>Vorbis encoder version used to create this bitstream.</dd>
48 <dt><i>channels</i></dt>
49 <dd>Int signifying number of channels in bitstream.</dd>
50 <dt><i>rate</i></dt>
51 <dd>Sampling rate of the bitstream.</dd>
52 <dt><i>bitrate_upper</i></dt>
53 <dd>Specifies the upper limit in a VBR bitstream.  If the value matches the bitrate_nominal and bitrate_lower parameters, the stream is fixed bitrate.  May be unset if no limit exists.</dd>
54 <dt><i>bitrate_nominal</i></dt>
55 <dd>Specifies the average bitrate for a VBR bitstream.  May be unset.  If the bitrate_upper and bitrate_lower parameters match, the stream is fixed bitrate.</dd>
56 <dt><i>bitrate_lower</i></dt>
57 <dd>Specifies the lower limit in a VBR bitstream.  If the value matches the bitrate_nominal and bitrate_upper parameters, the stream is fixed bitrate.  May be unset if no limit exists.</dd>
58 <dt><i>bitrate_window</i></dt>
59 <dd>Currently unset.</dd>
60
61 <dt><i>codec_setup</i></dt>
62 <dd>Internal structure that contains the detailed/unpacked configuration for decoding the current Vorbis bitstream.</dd>
63 </dl>
64
65
66 <br><br>
67 <hr noshade>
68 <table border=0 width=100%>
69 <tr valign=top>
70 <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
71 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
72 </tr><tr>
73 <td><p class=tiny>Vorbisfile documentation</p></td>
74 <td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>
75 </tr>
76 </table>
77
78 </body>
79
80 </html>