annotate src/libvorbis-1.3.3/doc/libvorbis/vorbis_info.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>libvorbis - datatype - vorbis_info</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>libvorbis documentation</p></td>
Chris@1 12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
Chris@1 13 </tr>
Chris@1 14 </table>
Chris@1 15
Chris@1 16 <h1>vorbis_info</h1>
Chris@1 17
Chris@1 18 <p><i>declared in "vorbis/codec.h"</i></p>
Chris@1 19
Chris@1 20 <p>
Chris@1 21 The vorbis_info structure contains basic information about the audio in a vorbis bitstream.
Chris@1 22 <p>
Chris@1 23
Chris@1 24 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
Chris@1 25 <tr bgcolor=#cccccc>
Chris@1 26 <td>
Chris@1 27 <pre><b>typedef struct vorbis_info{
Chris@1 28 int version;
Chris@1 29 int channels;
Chris@1 30 long rate;
Chris@1 31
Chris@1 32 long bitrate_upper;
Chris@1 33 long bitrate_nominal;
Chris@1 34 long bitrate_lower;
Chris@1 35 long bitrate_window;
Chris@1 36
Chris@1 37 void *codec_setup;
Chris@1 38
Chris@1 39 } vorbis_info;</b></pre>
Chris@1 40 </td>
Chris@1 41 </tr>
Chris@1 42 </table>
Chris@1 43
Chris@1 44 <h3>Relevant Struct Members</h3>
Chris@1 45 <dl>
Chris@1 46 <dt><i>version</i></dt>
Chris@1 47 <dd>Vorbis encoder version used to create this bitstream.</dd>
Chris@1 48 <dt><i>channels</i></dt>
Chris@1 49 <dd>Int signifying number of channels in bitstream.</dd>
Chris@1 50 <dt><i>rate</i></dt>
Chris@1 51 <dd>Sampling rate of the bitstream.</dd>
Chris@1 52 <dt><i>bitrate_upper</i></dt>
Chris@1 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>
Chris@1 54 <dt><i>bitrate_nominal</i></dt>
Chris@1 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>
Chris@1 56 <dt><i>bitrate_lower</i></dt>
Chris@1 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>
Chris@1 58 <dt><i>bitrate_window</i></dt>
Chris@1 59 <dd>Currently unset.</dd>
Chris@1 60
Chris@1 61 <dt><i>codec_setup</i></dt>
Chris@1 62 <dd>Internal structure that contains the detailed/unpacked configuration for decoding the current Vorbis bitstream.</dd>
Chris@1 63 </dl>
Chris@1 64
Chris@1 65
Chris@1 66 <br><br>
Chris@1 67 <hr noshade>
Chris@1 68 <table border=0 width=100%>
Chris@1 69 <tr valign=top>
Chris@1 70 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
Chris@1 71 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
Chris@1 72 </tr><tr>
Chris@1 73 <td><p class=tiny>libvorbis documentation</p></td>
Chris@1 74 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
Chris@1 75 </tr>
Chris@1 76 </table>
Chris@1 77
Chris@1 78 </body>
Chris@1 79
Chris@1 80 </html>