doc/libvorbis/vorbis_analysis_buffer.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbis - function - vorbis_analysis_buffer</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>libvorbis documentation</p></td>
  12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>vorbis_analysis_buffer</h1>
  17
  18 <p><i>declared in "vorbis/codec.h";</i></p>
  19
  20 <p>This fuction requests a buffer array for delivering audio to the
  21 encoder for compression.</p>
  22
  23 <p>The Vorbis encoder expects the caller to write audio data as
  24 non-interleaved floating point samples into its internal buffers.
  25 </p>
  26 <p>
  27 The general procedure is to call this function with the number of samples
  28 you have available. The encoder will arrange for that much internal storage
  29 and return an array of buffer pointers, one for each channel of audio.
  30 The caller must then write the audio samples into those buffers, as
  31 float values, and finally call vorbis_analysis_wrote() to tell the
  32 encoder the data is available for analysis.
  33 </p>
  34
  35 <table border=0 color=black cellspacing=0 cellpadding=7>
  36 <tr bgcolor=#cccccc>
  37         <td>
  38 <pre><b>
  39 extern float  **vorbis_analysis_buffer(vorbis_dsp_state *v,int vals);
  40 </b></pre>
  41         </td>
  42 </tr>
  43 </table>
  44
  45 <h3>Parameters</h3>
  46 <dl>
  47 <dt><i>v</i></dt>
  48 <dd>Pointer to the vorbis_dsp_state representing the encoder.</dd>
  49 <dt><i>vals</i></dt>
  50 <dd>Number of samples to provide space for in the returned buffer. 1024 is a reasonable choice.</dd>
  51 </dl>
  52
  53
  54 <h3>Return Values</h3>
  55 <p>Returns an array of floating point buffers which can accept data.
  56 A (**float) where the first index is the channel, and the second is
  57 the sample index.<p>
  58
  59 <br><br>
  60 <hr noshade>
  61 <table border=0 width=100%>
  62 <tr valign=top>
  63 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  64 <td align=right><p class=tiny><a href="https://xiph.org/vorbis/">Ogg Vorbis</a></p></td>
  65 </tr><tr>
  66 <td><p class=tiny>libvorbis documentation</p></td>
  67 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  68 </tr>
  69 </table>
  70
  71
  72 </body>
  73
  74 </html>