Home | History | Annotate | Download | only in vorbisenc
      1 <html>
      2 
      3 <head>
      4 <title>vorbis - 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>libvorbisenc documentation</p></td>
     12 <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</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 information about a vorbis bitstream.
     22 
     23 <p>
     24 
     25 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
     26 <tr bgcolor=#cccccc>
     27 	<td>
     28 <pre><b>typedef struct vorbis_info{
     29   int version;
     30   int channels;
     31   long rate;
     32   
     33   long bitrate_upper;
     34   long bitrate_nominal;
     35   long bitrate_lower;
     36   long bitrate_window;
     37 
     38   void *codec_setup;
     39 
     40 } vorbis_info;</b></pre>
     41 	</td>
     42 </tr>
     43 </table>
     44 
     45 <h3>Relevant Struct Members</h3>
     46 <dl>
     47 <dt><i>version</i></dt>
     48 <dd>Vorbis encoder version used to create this bitstream.</dd>
     49 <dt><i>channels</i></dt>
     50 <dd>Int signifying number of channels in bitstream.</dd>
     51 <dt><i>rate</i></dt>
     52 <dd>Sampling rate of the bitstream.</dd>
     53 <dt><i>bitrate_upper</i></dt>
     54 <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>
     55 <dt><i>bitrate_nominal</i></dt>
     56 <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>
     57 <dt><i>bitrate_lower</i></dt>
     58 <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>
     59 <dt><i>bitrate_window</i></dt>
     60 <dd>Specifies the size of the bit reservoir in seconds relative to the nominal bitrate.  May be unset.</dd>
     61 <dt><i>codec_setup</i></dt>
     62 <dd>Pointer to private encoder setup state.</dd>
     63 
     64 </dl>
     65 
     66 
     67 <br><br>
     68 <hr noshade>
     69 <table border=0 width=100%>
     70 <tr valign=top>
     71 <td><p class=tiny>copyright &copy; 2004 vorbis team</p></td>
     72 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team (a] vorbis.org">team (a] vorbis.org</a></p></td>
     73 </tr><tr>
     74 <td><p class=tiny>vorbisfile documentation</p></td>
     75 <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
     76 </tr>
     77 </table>
     78 
     79 </body>
     80 
     81 </html>
     82