annotate src/libvorbis-1.3.3/doc/libvorbis/vorbis_synthesis_pcmout.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_synthesis_pcmout</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_synthesis_pcmout</h1>
Chris@1 17
Chris@1 18 <p><i>declared in "vorbis/codec.h";</i></p>
Chris@1 19
Chris@1 20 <p>This function retrieves buffers containing decoded audio samples.</p>
Chris@1 21 <p>The application is not required to make use of all of the samples
Chris@1 22 made available to it by one call to this function before it continues to
Chris@1 23 decode. Use <a href="vorbis_synthesis_read.html">vorbis_synthesis_read</a>
Chris@1 24 to inform the decoder of how many samples were actually used. Any
Chris@1 25 unused samples will be included in the buffers output by the next call
Chris@1 26 to this function.</p>
Chris@1 27
Chris@1 28 <table border=0 color=black cellspacing=0 cellpadding=7>
Chris@1 29 <tr bgcolor=#cccccc>
Chris@1 30 <td>
Chris@1 31 <pre><b>
Chris@1 32 extern int vorbis_synthesis_pcmout(vorbis_dsp_state *v,float ***pcm);
Chris@1 33 </b></pre>
Chris@1 34 </td>
Chris@1 35 </tr>
Chris@1 36 </table>
Chris@1 37
Chris@1 38 <h3>Parameters</h3>
Chris@1 39 <dl>
Chris@1 40 <dt><i>v</i></dt>
Chris@1 41 <dd>The <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> for the
Chris@1 42 decoder instance.</dd>
Chris@1 43 <dt><i>pcm</i></dt>
Chris@1 44 <dd>A pointer to a float** which will be made to point to an array of
Chris@1 45 pointers to the decoded samples for each channel. The memory is owned
Chris@1 46 by the decoder instance and will be freed when the application continues
Chris@1 47 decoding or destroys the decoder instance. This can be NULL, in which
Chris@1 48 case the return value gives the number of samples that would be returned
Chris@1 49 if this function were called with a non-NULL pointer here.</dd>
Chris@1 50 </dl>
Chris@1 51
Chris@1 52
Chris@1 53 <h3>Return Values</h3>
Chris@1 54 <blockquote>
Chris@1 55 <li>The number of samples available in the output buffer.</li>
Chris@1 56 <li>0 if no more samples are currently available.</li>
Chris@1 57 </blockquote>
Chris@1 58 <p>
Chris@1 59
Chris@1 60 <br><br>
Chris@1 61 <hr noshade>
Chris@1 62 <table border=0 width=100%>
Chris@1 63 <tr valign=top>
Chris@1 64 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
Chris@1 65 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
Chris@1 66 </tr><tr>
Chris@1 67 <td><p class=tiny>libvorbis documentation</p></td>
Chris@1 68 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
Chris@1 69 </tr>
Chris@1 70 </table>
Chris@1 71
Chris@1 72
Chris@1 73 </body>
Chris@1 74
Chris@1 75 </html>