<table border=0 width=100%>
<tr>
<td><p class=tiny>libvorbisenc documentation</p></td>
-<td align=right><p class=tiny>libvorbisenc version 1.1.2.2 - 20001104</p></td>
+<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
</tr>
</table>
<p><i>declared in "vorbis/libvorbisenc.h";</i></p>
-<p>This is the primary function within libvorbisenc. This is used to properly set up an encoding environment using libvorbisenc.
+<p>This is the primary function within libvorbisenc for setting up managed bitrate modes.
<p>Before this function is called, the <a href="vorbis_info.html">vorbis_info</a> struct should be initialized by using vorbis_info_init() from the libvorbis API. After encoding, vorbis_info_clear should be called.
<p>The max_bitrate, nominal_bitrate, and min_bitrate settings are used to set constraints for the encoded file. This function uses these settings to select the appropriate encoding mode and set it up.
<p>
<dt><i>rate</i></dt>
<dd>The sampling rate of the source audio.</dd>
<dt><i>max_bitrate</i></dt>
-<dd>Desired maximum bitrate (limit).</dd>
+<dd>Desired maximum bitrate (limit). -1 indicates unset.</dd>
<dt><i>nominal_bitrate</i></dt>
-<dd>Desired average, or central, bitrate.</dd>
+<dd>Desired average, or central, bitrate. -1 indicates unset.</dd>
<dt><i>min_bitrate</i></dt>
-<dd>Desired minimum bitrate.</dd>
+<dd>Desired minimum bitrate. -1 indicates unset.</dd>
</dl>
<li>less than zero for failure:</li>
<ul>
<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
+<li>OV_EINVAL - Invalid setup request, eg, out of range argument. </li>
+<li>OV_EIMPL - Unimplemented mode; unable to comply with bitrate request.</li>
</ul>
</blockquote>
<p>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2000 xiph.org</p></td>
+<td><p class=tiny>copyright © 2004 xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
</tr><tr>
<td><p class=tiny>libvorbisenc documentation</p></td>
-<td align=right><p class=tiny>libvorbisenc version 1.1.2.2 - 20001106</p></td>
+<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
</tr>
</table>
<table border=0 width=100%>
<tr>
<td><p class=tiny>libvorbisenc documentation</p></td>
-<td align=right><p class=tiny>libvorbisenc - 20011218</p></td>
+<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
</tr>
</table>
<p><i>declared in "vorbis/libvorbisenc.h";</i></p>
-<p>This is the primary function within libvorbisenc. This is used to properly set up an encoding environment using libvorbisenc.
+<p>This is the primary function within libvorbisenc for setting up variable bitrate ("quality" based) modes.
<p>Before this function is called, the <a href="vorbis_info.html">vorbis_info</a> struct should be initialized by using vorbis_info_init() from the libvorbis API. After encoding, vorbis_info_clear should be called.
-<p>The max_bitrate, nominal_bitrate, and min_bitrate settings are used to set constraints for the encoded file. This function uses these settings to select the appropriate encoding mode and set it up.
<p>
<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
long channels,
long rate,
- float base_quality /* from 0. (lo) to 1. (hi) */);
+ float base_quality);
</b></pre>
</td>
<dt><i>rate</i></dt>
<dd>The sampling rate of the source audio.</dd>
<dt><i>base_quality</i></dt>
-<dd>Desired quality level from 0.0 to 1.0 (lo to hi).</dd>
+<dd>Desired quality level, currently from -0.1 to 1.0 (lo to hi).</dd>
</dl>
<li>less than zero for failure:</li>
<ul>
<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
+<li>OV_EINVAL - Invalid setup request, eg, out of range argument. </li>
+<li>OV_EIMPL - Unimplemented mode; unable to comply with quality level request.</li>
</ul>
</blockquote>
<p>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2000 xiph.org</p></td>
+<td><p class=tiny>copyright © 2004 xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
</tr><tr>
<td><p class=tiny>libvorbisenc documentation</p></td>
-<td align=right><p class=tiny>libvorbisenc version 1.1.2.2 - 20001106</p></td>
+<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
</tr>
</table>
--- /dev/null
+<html>
+
+<head>
+<title>libvorbisenc - function - vorbis_encode_setup_init</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>libvorbisenc documentation</p></td>
+<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
+</tr>
+</table>
+
+<h1>vorbis_encode_setup_init</h1>
+
+<p><i>declared in "vorbis/libvorbisenc.h";</i></p>
+
+<p>This function performs the last stage of three-step encoding setup, as described in the API overview under <a href="overview.html#BBR">managed bitrate modes</a>.
+
+<p>Before this function is called, the <a
+href="vorbis_info.html">vorbis_info</a> struct should be initialized
+by using vorbis_info_init() from the libvorbis API, one of <a
+href="vorbis_encode_setup_managed.html">vorbis_encode_setup_managed()</a>
+or <a
+href="vorbis_encode_setup_vbr.html">vorbis_encode_setup_vbr()</a>
+called to initialize the high-level encoding setup, and <a
+href="vorbis_encode_ctl.html">vorbis_encode_ctl()</a> called if
+necessary to make encoding setup changes. vorbis_encode_setup_init()
+finalizes the highlevel encoding structure into a complete encoding
+setup after which the application may make no further setup changes.<p>
+
+After encoding, vorbis_info_clear should be called.
+<p>
+<br><br>
+<table border=0 color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+ <td>
+<pre><b>
+extern int vorbis_encode_setup_init(<a href="vorbis_info.html">vorbis_info</a> *vi);
+
+</b></pre>
+ </td>
+</tr>
+</table>
+
+<h3>Parameters</h3>
+<dl>
+<dt><i>vi</i></dt>
+<dd>File pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd>
+</dl>
+
+
+<h3>Return Values</h3>
+<blockquote>
+<li>
+0 for success</li>
+
+<li>less than zero for failure:</li>
+<ul>
+<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
+<li>OV_EINVAL - Attempt to use vorbis_encode_setup_init() without first calling one of <a
+href="vorbis_encode_setup_managed.html">vorbis_encode_setup_managed()</a>
+or <a
+href="vorbis_encode_setup_vbr.html">vorbis_encode_setup_vbr()</a>
+to initialize the high-level encoding setup
+</li>
+</ul>
+</blockquote>
+<p>
+
+<br><br>
+<hr noshade>
+<table border=0 width=100%>
+<tr valign=top>
+<td><p class=tiny>copyright © 2004 xiph.org</p></td>
+<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
+</tr><tr>
+<td><p class=tiny>libvorbisenc documentation</p></td>
+<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
+</tr>
+</table>
+
+
+</body>
+
+</html>
--- /dev/null
+<html>
+
+<head>
+<title>libvorbisenc - function - vorbis_encode_setup_managed</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>libvorbisenc documentation</p></td>
+<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
+</tr>
+</table>
+
+<h1>vorbis_encode_setup_managed</h1>
+
+<p><i>declared in "vorbis/libvorbisenc.h";</i></p>
+
+<p>This function performs step-one of a three-step bitrate-managed
+encode setup. It functions similarly to the one-step setup performed
+by <a href="vorbis_encode_init.html">vorbis_encode_init()</a> but
+allows an application to make further encode setup tweaks using <a
+href="vorbis_encode_ctl.html">vorbis_encode_ctl()</a> before finally
+calling <a
+href="vorbis_encode_setup_init.html">vorbis_encode_setup_init()</a> to
+complete the setup process.
+
+<p>Before this function is called, the <a
+href="vorbis_info.html">vorbis_info</a> struct should be initialized
+by using vorbis_info_init() from the libvorbis API. After encoding,
+vorbis_info_clear should be called.
+
+<p>The max_bitrate, nominal_bitrate, and min_bitrate settings are used
+to set constraints for the encoded file. This function uses these
+settings to select the appropriate encoding mode and set it up.
+<p>
+<br><br>
+<table border=0 color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+ <td>
+<pre><b>
+extern int vorbis_encode_init(<a href="vorbis_info.html">vorbis_info</a> *vi,
+ long channels,
+ long rate,
+
+ long max_bitrate,
+ long nominal_bitrate,
+ long min_bitrate);
+
+</b></pre>
+ </td>
+</tr>
+</table>
+
+<h3>Parameters</h3>
+<dl>
+<dt><i>vi</i></dt>
+<dd>File pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd>
+<dt><i>channels</i></dt>
+<dd>The number of channels to be encoded.</dd>
+<dt><i>rate</i></dt>
+<dd>The sampling rate of the source audio.</dd>
+<dt><i>max_bitrate</i></dt>
+<dd>Desired maximum bitrate (limit). -1 indicates unset.</dd>
+<dt><i>nominal_bitrate</i></dt>
+<dd>Desired average, or central, bitrate. -1 indicates unset.</dd>
+<dt><i>min_bitrate</i></dt>
+<dd>Desired minimum bitrate. -1 indicates unset.</dd>
+</dl>
+
+
+<h3>Return Values</h3>
+<blockquote>
+<li>
+0 for success</li>
+
+<li>less than zero for failure:</li>
+<ul>
+<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
+<li>OV_EINVAL - Invalid setup request, eg, out of range argument. </li>
+<li>OV_EIMPL - Unimplemented mode; unable to comply with bitrate request.</li>
+</ul>
+</blockquote>
+<p>
+
+<br><br>
+<hr noshade>
+<table border=0 width=100%>
+<tr valign=top>
+<td><p class=tiny>copyright © 2004 xiph.org</p></td>
+<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
+</tr><tr>
+<td><p class=tiny>libvorbisenc documentation</p></td>
+<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
+</tr>
+</table>
+
+
+</body>
+
+</html>
--- /dev/null
+<html>
+
+<head>
+<title>libvorbisenc - function - vorbis_encode_setup_vbr</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>libvorbisenc documentation</p></td>
+<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
+</tr>
+</table>
+
+<h1>vorbis_encode_setup_vbr</h1>
+
+<p><i>declared in "vorbis/libvorbisenc.h";</i></p>
+
+<p>This function performs step-one of a three-step variable bitrate
+(quality-based) encode setup. It functions similarly to the one-step
+setup performed by <a
+href="vorbis_encode_init_vbr.html">vorbis_encode_init_vbr()</a> but
+allows an application to make further encode setup tweaks using <a
+href="vorbis_encode_ctl.html">vorbis_encode_ctl()</a> before finally
+calling <a
+href="vorbis_encode_setup_init.html">vorbis_encode_setup_init()</a> to
+complete the setup process.
+
+<p>Before this function is called, the <a href="vorbis_info.html">vorbis_info</a> struct should be initialized by using vorbis_info_init() from the libvorbis API. After encoding, vorbis_info_clear should be called.
+<p>
+<br><br>
+<table border=0 color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+ <td>
+<pre><b>
+extern int vorbis_encode_init_vbr(<a href="vorbis_info.html">vorbis_info</a> *vi,
+ long channels,
+ long rate,
+
+ float base_quality);
+
+</b></pre>
+ </td>
+</tr>
+</table>
+
+<h3>Parameters</h3>
+<dl>
+<dt><i>vi</i></dt>
+<dd>File pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd>
+<dt><i>channels</i></dt>
+<dd>The number of channels to be encoded.</dd>
+<dt><i>rate</i></dt>
+<dd>The sampling rate of the source audio.</dd>
+<dt><i>base_quality</i></dt>
+<dd>Desired quality level, currently from -0.1 to 1.0 (lo to hi).</dd>
+</dl>
+
+
+<h3>Return Values</h3>
+<blockquote>
+<li>
+0 for success</li>
+
+<li>less than zero for failure:</li>
+<ul>
+<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
+<li>OV_EINVAL - Invalid setup request, eg, out of range argument. </li>
+<li>OV_EIMPL - Unimplemented mode; unable to comply with quality level request.</li>
+</ul>
+</blockquote>
+<p>
+
+<br><br>
+<hr noshade>
+<table border=0 width=100%>
+<tr valign=top>
+<td><p class=tiny>copyright © 2004 xiph.org</p></td>
+<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
+</tr><tr>
+<td><p class=tiny>libvorbisenc documentation</p></td>
+<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
+</tr>
+</table>
+
+
+</body>
+
+</html>
projects / platform / upstream / libvorbis.git / commitdiff