vorbis_analysis_blockout.html 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. <html>
  2. <head>
  3. <title>libvorbis - function - vorbis_analysis_blockout</title>
  4. <link rel=stylesheet href="style.css" type="text/css">
  5. </head>
  6. <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
  7. <table border=0 width=100%>
  8. <tr>
  9. <td><p class=tiny>libvorbis documentation</p></td>
  10. <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  11. </tr>
  12. </table>
  13. <h1>vorbis_analysis_blockout</h1>
  14. <p><i>declared in "vorbis/codec.h";</i></p>
  15. <p>This fuction examines the available uncompressed data and tries to
  16. break it into appropriate sized blocks. It should be called in a loop
  17. after adding new data with vorbis_analysis_buffer()/vorbis_analysis_wrote()
  18. until it returns zero (need more data) or an negative value (error).
  19. </p>
  20. <p>
  21. Each block returned should be passed to vorbis_analysis() for transform
  22. and coding.
  23. </p>
  24. <table border=0 color=black cellspacing=0 cellpadding=7>
  25. <tr bgcolor=#cccccc>
  26. <td>
  27. <pre><b>
  28. extern int vorbis_analysis_blockout(vorbis_dsp_state *v,vorbis_block *vb);
  29. </b></pre>
  30. </td>
  31. </tr>
  32. </table>
  33. <h3>Parameters</h3>
  34. <dl>
  35. <dt><i>v</i></dt>
  36. <dd>Pointer to the vorbis_dsp_state representing the encoder.</dd>
  37. <dt><i>vb</i></dt>
  38. <dd>Pointer to a previously initialized vorbis_block object to hold the
  39. returned data.
  40. </dl>
  41. <h3>Return Values</h3>
  42. <ul>
  43. <li>1 for success when more blocks are available.</li>
  44. <li>0 for success when this is the last block available from the current input.</li>
  45. <li>negative values for failure:
  46. <ul>
  47. <li>OV_EINVAL - Invalid parameters.</li>
  48. <li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li>
  49. <li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li>
  50. </ul>
  51. </li>
  52. </ul>
  53. <br><br>
  54. <hr noshade>
  55. <table border=0 width=100%>
  56. <tr valign=top>
  57. <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  58. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
  59. </tr><tr>
  60. <td><p class=tiny>libvorbis documentation</p></td>
  61. <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  62. </tr>
  63. </table>
  64. </body>
  65. </html>