annotate src/libvorbis-1.3.3/doc/libvorbis/vorbis_synthesis_pcmout.html @ 169:223a55898ab9 tip default

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