doc/libvorbis/vorbis_synthesis_init.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbis - function - vorbis_synthesis_init</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_init</h1>
  17
  18 <p><i>declared in "vorbis/codec.h";</i></p>
  19
  20 <p>This function initializes a
  21 <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> structure for
  22 decoding and allocates internal storage for it.</p>
  23
  24 <table border=0 color=black cellspacing=0 cellpadding=7>
  25 <tr bgcolor=#cccccc>
  26         <td>
  27 <pre><b>
  28 extern int      vorbis_synthesis_init(vorbis_dsp_state *v,vorbis_info *vi);
  29 </b></pre>
  30         </td>
  31 </tr>
  32 </table>
  33
  34 <h3>Parameters</h3>
  35 <dl>
  36 <dt><i>v</i></dt>
  37 <dd>The <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> to initialize
  38 for decoding.</dd>
  39 <dt><i>vi</i></dt>
  40 <dd>The <a href="vorbis_info.html">vorbis_info</a> structure
  41 for the stream. The vorbis_info structure must have had <a
  42 href="vorbis_synthesis_headerin.html">vorbis_synthesis_headerin</a>
  43 called on it for each header packet in the stream.</dd>
  44 </dl>
  45
  46
  47 <h3>Return Values</h3>
  48 <blockquote>
  49 <li>0 on success.</li>
  50 <li>1 on error.</li>
  51 </blockquote>
  52 <p>
  53
  54 <br><br>
  55 <hr noshade>
  56 <table border=0 width=100%>
  57 <tr valign=top>
  58 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  59 <td align=right><p class=tiny><a href="https://xiph.org/vorbis/index.html">Ogg Vorbis</a></p></td>
  60 </tr><tr>
  61 <td><p class=tiny>libvorbis documentation</p></td>
  62 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  63 </tr>
  64 </table>
  65
  66
  67 </body>
  68
  69 </html>