doc/libvorbis/vorbis_synthesis_lapout.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbis - function - vorbis_synthesis_lapout</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_lapout</h1>
  17
  18 <p><i>declared in "vorbis/codec.h";</i></p>
  19
  20 <p>This function retrieves buffers containing decoded audio samples, similarly
  21 to <a href="vorbis_synthesis_pcmout.html">vorbis_synthesis_pcmout</a>.
  22 However, it includes some extra samples extrapolated from the end of
  23 the audio, suitable for crosslapping with other blocks. This exists mainly
  24 for <a href="../vorbisfile/index.html">libvorbisfile</a> to use for
  25 handling chained bitstreams and bitstreams with holes.</p>
  26
  27 <table border=0 color=black cellspacing=0 cellpadding=7>
  28 <tr bgcolor=#cccccc>
  29         <td>
  30 <pre><b>
  31 extern int      vorbis_synthesis_lapout(vorbis_dsp_state *v,float ***pcm);
  32 </b></pre>
  33         </td>
  34 </tr>
  35 </table>
  36
  37 <h3>Parameters</h3>
  38 <dl>
  39 <dt><i>v</i></dt>
  40 <dd>The <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> for the
  41 decoder instance.</dd>
  42 <dt><i>pcm</i></dt>
  43 <dd>A pointer to a float** which will be made to point to an array of
  44 pointers to the decoded samples for each channel. The memory is owned
  45 by the decoder instance and will be freed when the application continues
  46 decoding or destroys the decoder instance. This can be NULL, in which
  47 case the return value gives the number of samples that would be returned
  48 if this function were called with a non-NULL pointer here.</dd>
  49 </dl>
  50
  51
  52 <h3>Return Values</h3>
  53 <blockquote>
  54 <li>The number of samples available in the output buffer.</li>
  55 <li>0 if no more samples are currently available.</li>
  56 </blockquote>
  57 <p>
  58
  59 <br><br>
  60 <hr noshade>
  61 <table border=0 width=100%>
  62 <tr valign=top>
  63 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  64 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
  65 </tr><tr>
  66 <td><p class=tiny>libvorbis documentation</p></td>
  67 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  68 </tr>
  69 </table>
  70
  71
  72 </body>
  73
  74 </html>