Mercurial > hg > sv-dependency-builds

<html>

<head>
<title>libvorbis - function - vorbis_synthesis_pcmout</title>
<link rel=stylesheet href="style.css" type="text/css">
</head>

<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<tr>
<td><p class=tiny>libvorbis documentation</p></td>
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
</tr>
</table>

<h1>vorbis_synthesis_pcmout</h1>

<p><i>declared in "vorbis/codec.h";</i></p>

<p>This function retrieves buffers containing decoded audio samples.</p>
<p>The application is not required to make use of all of the samples
made available to it by one call to this function before it continues to
decode. Use <a href="vorbis_synthesis_read.html">vorbis_synthesis_read</a>
to inform the decoder of how many samples were actually used. Any
unused samples will be included in the buffers output by the next call
to this function.</p>

<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
	<td>
<pre><b>
extern int      vorbis_synthesis_pcmout(vorbis_dsp_state *v,float ***pcm);
</b></pre>
	</td>
</tr>
</table>

<h3>Parameters</h3>
<dl>
<dt><i>v</i></dt>
<dd>The <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> for the
decoder instance.</dd>
<dt><i>pcm</i></dt>
<dd>A pointer to a float** which will be made to point to an array of
pointers to the decoded samples for each channel. The memory is owned
by the decoder instance and will be freed when the application continues
decoding or destroys the decoder instance. This can be NULL, in which
case the return value gives the number of samples that would be returned
if this function were called with a non-NULL pointer here.</dd>
</dl>


<h3>Return Values</h3>
<blockquote>
<li>The number of samples available in the output buffer.</li>
<li>0 if no more samples are currently available.</li>
</blockquote>
<p>

<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
<td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>libvorbis documentation</p></td>
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
</tr>
</table>


</body>

</html>
author	Chris Cannam
date	Tue, 19 Mar 2013 17:37:49 +0000
parents
children