annotate src/libvorbis-1.3.3/doc/libvorbis/vorbis_info.html @ 168:ceec0dd9ec9c

Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam <cannam@all-day-breakfast.com>
date Fri, 07 Feb 2020 11:51:13 +0000
parents 98c1576536ae
children
rev   line source
cannam@86 1 <html>
cannam@86 2
cannam@86 3 <head>
cannam@86 4 <title>libvorbis - datatype - vorbis_info</title>
cannam@86 5 <link rel=stylesheet href="style.css" type="text/css">
cannam@86 6 </head>
cannam@86 7
cannam@86 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
cannam@86 9 <table border=0 width=100%>
cannam@86 10 <tr>
cannam@86 11 <td><p class=tiny>libvorbis documentation</p></td>
cannam@86 12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
cannam@86 13 </tr>
cannam@86 14 </table>
cannam@86 15
cannam@86 16 <h1>vorbis_info</h1>
cannam@86 17
cannam@86 18 <p><i>declared in "vorbis/codec.h"</i></p>
cannam@86 19
cannam@86 20 <p>
cannam@86 21 The vorbis_info structure contains basic information about the audio in a vorbis bitstream.
cannam@86 22 <p>
cannam@86 23
cannam@86 24 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
cannam@86 25 <tr bgcolor=#cccccc>
cannam@86 26 <td>
cannam@86 27 <pre><b>typedef struct vorbis_info{
cannam@86 28 int version;
cannam@86 29 int channels;
cannam@86 30 long rate;
cannam@86 31
cannam@86 32 long bitrate_upper;
cannam@86 33 long bitrate_nominal;
cannam@86 34 long bitrate_lower;
cannam@86 35 long bitrate_window;
cannam@86 36
cannam@86 37 void *codec_setup;
cannam@86 38
cannam@86 39 } vorbis_info;</b></pre>
cannam@86 40 </td>
cannam@86 41 </tr>
cannam@86 42 </table>
cannam@86 43
cannam@86 44 <h3>Relevant Struct Members</h3>
cannam@86 45 <dl>
cannam@86 46 <dt><i>version</i></dt>
cannam@86 47 <dd>Vorbis encoder version used to create this bitstream.</dd>
cannam@86 48 <dt><i>channels</i></dt>
cannam@86 49 <dd>Int signifying number of channels in bitstream.</dd>
cannam@86 50 <dt><i>rate</i></dt>
cannam@86 51 <dd>Sampling rate of the bitstream.</dd>
cannam@86 52 <dt><i>bitrate_upper</i></dt>
cannam@86 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>
cannam@86 54 <dt><i>bitrate_nominal</i></dt>
cannam@86 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>
cannam@86 56 <dt><i>bitrate_lower</i></dt>
cannam@86 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>
cannam@86 58 <dt><i>bitrate_window</i></dt>
cannam@86 59 <dd>Currently unset.</dd>
cannam@86 60
cannam@86 61 <dt><i>codec_setup</i></dt>
cannam@86 62 <dd>Internal structure that contains the detailed/unpacked configuration for decoding the current Vorbis bitstream.</dd>
cannam@86 63 </dl>
cannam@86 64
cannam@86 65
cannam@86 66 <br><br>
cannam@86 67 <hr noshade>
cannam@86 68 <table border=0 width=100%>
cannam@86 69 <tr valign=top>
cannam@86 70 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
cannam@86 71 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
cannam@86 72 </tr><tr>
cannam@86 73 <td><p class=tiny>libvorbis documentation</p></td>
cannam@86 74 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
cannam@86 75 </tr>
cannam@86 76 </table>
cannam@86 77
cannam@86 78 </body>
cannam@86 79
cannam@86 80 </html>