annotate src/libvorbis-1.3.3/doc/libvorbis/vorbis_analysis_buffer.html @ 1:05aa0afa9217

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