annotate src/libvorbis-1.3.3/doc/libvorbis/vorbis_analysis_buffer.html @ 86:98c1576536ae

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