summaryrefslogtreecommitdiffhomepage
path: root/contrib/vorbis/doc/libvorbis/vorbis_analysis_blockout.html
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/vorbis/doc/libvorbis/vorbis_analysis_blockout.html')
-rw-r--r--contrib/vorbis/doc/libvorbis/vorbis_analysis_blockout.html79
1 files changed, 79 insertions, 0 deletions
diff --git a/contrib/vorbis/doc/libvorbis/vorbis_analysis_blockout.html b/contrib/vorbis/doc/libvorbis/vorbis_analysis_blockout.html
new file mode 100644
index 0000000..94948b6
--- /dev/null
+++ b/contrib/vorbis/doc/libvorbis/vorbis_analysis_blockout.html
@@ -0,0 +1,79 @@
+<html>
+
+<head>
+<title>libvorbis - function - vorbis_analysis_blockout</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_analysis_blockout</h1>
+
+<p><i>declared in "vorbis/codec.h";</i></p>
+
+<p>This fuction examines the available uncompressed data and tries to
+break it into appropriate sized blocks. It should be called in a loop
+after adding new data with vorbis_analysis_buffer()/vorbis_analysis_wrote()
+until it returns zero (need more data) or an negative value (error).
+</p>
+<p>
+Each block returned should be passed to vorbis_analysis() for transform
+and coding.
+</p>
+
+<table border=0 color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+ <td>
+<pre><b>
+extern int vorbis_analysis_blockout(vorbis_dsp_state *v,vorbis_block *vb);
+</b></pre>
+ </td>
+</tr>
+</table>
+
+<h3>Parameters</h3>
+<dl>
+<dt><i>v</i></dt>
+<dd>Pointer to the vorbis_dsp_state representing the encoder.</dd>
+<dt><i>vb</i></dt>
+<dd>Pointer to a previously initialized vorbis_block object to hold the
+returned data.
+</dl>
+
+
+<h3>Return Values</h3>
+<ul>
+<li>1 for success when more blocks are available.</li>
+<li>0 for success when this is the last block available from the current input.</li>
+<li>negative values for failure:
+<ul>
+<li>OV_EINVAL - Invalid parameters.</li>
+<li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li>
+<li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li>
+</ul>
+</li>
+
+</ul>
+
+<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>