libvorbis-1.0.1/doc/vorbisenc/vorbis_info.html

   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>vorbisfile documentation</p></td>
  12 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</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.  Most of the information in this struct is more complex and in-depth than we need when using basic API calls.
  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
  37   long blocksizes[2];
  38
  39   int        modes;
  40   int        maps;
  41   int        times;
  42   int        floors;
  43   int        residues;
  44   int        books;
  45   int        psys;     /* encode only */
  46
  47   vorbis_info_mode    *mode_param[64];
  48   int                  map_type[64];
  49   vorbis_info_mapping *map_param[64];
  50   int                  time_type[64];
  51   vorbis_info_time    *time_param[64];
  52   int                  floor_type[64];
  53   vorbis_info_floor   *floor_param[64];
  54   int                  residue_type[64];
  55   vorbis_info_residue *residue_param[64];
  56   static_codebook     *book_param[256];
  57   vorbis_info_psy     *psy_param[64]; /* encode only */
  58
  59   /* for block long/sort tuning; encode only */
  60   int        envelopesa;
  61   double     preecho_thresh;
  62   double     preecho_clamp;
  63
  64 } vorbis_info;</b></pre>
  65         </td>
  66 </tr>
  67 </table>
  68
  69 <h3>Relevant Struct Members</h3>
  70 <dl>
  71 <dt><i>version</i></dt>
  72 <dd>Vorbis encoder version used to create this bitstream.</dd>
  73 <dt><i>channels</i></dt>
  74 <dd>Int signifying number of channels in bitstream.</dd>
  75 <dt><i>rate</i></dt>
  76 <dd>Sampling rate of the bitstream.</dd>
  77 <dt><i>bitrate_upper</i></dt>
  78 <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>
  79 <dt><i>bitrate_nominal</i></dt>
  80 <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>
  81 <dt><i>bitrate_lower</i></dt>
  82 <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>
  83 <dt><i>blocksizes[2]</i></dt>
  84 <dd>Contains the sizes of the long and short blocks for this particular bitstream.  These are variable and can be set by the encoder.  Vorbis only supports two sizes, long and short.</dd>
  85 </dl>
  86
  87
  88 <br><br>
  89 <hr noshade>
  90 <table border=0 width=100%>
  91 <tr valign=top>
  92 <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  93 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
  94 </tr><tr>
  95 <td><p class=tiny>vorbisfile documentation</p></td>
  96 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  97 </tr>
  98 </table>
  99
 100 </body>
 101
 102 </html>