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