[xiph-commits] r7461 - trunk/vorbis/doc/vorbisenc
xiphmont at motherfish-iii.xiph.org
xiphmont
Thu Aug 5 19:07:51 PDT 2004
Author: xiphmont
Date: Thu Aug 5 19:07:51 2004
New Revision: 7461
Added:
trunk/vorbis/doc/vorbisenc/ov_ectl_ratemanage2_arg.html
trunk/vorbis/doc/vorbisenc/ov_ectl_ratemanage_arg.html
Modified:
trunk/vorbis/doc/vorbisenc/examples.html
trunk/vorbis/doc/vorbisenc/vorbis_info.html
Log:
Finished data structure docs
Modified: trunk/vorbis/doc/vorbisenc/examples.html
===================================================================
--- trunk/vorbis/doc/vorbisenc/examples.html 2004-08-03 03:50:51 UTC (rev 7460)
+++ trunk/vorbis/doc/vorbisenc/examples.html 2004-08-03 05:05:40 UTC (rev 7461)
@@ -91,7 +91,7 @@
if(ret) exit(1);
</b></pre></td></tr></table>
-<h2>Example: encoding using VBR sleected by approximate bitrate</h2>
+<h2>Example: encoding using VBR selected by approximate bitrate</h2>
<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc><td><pre><b>
Added: trunk/vorbis/doc/vorbisenc/ov_ectl_ratemanage2_arg.html
===================================================================
--- trunk/vorbis/doc/vorbisenc/ov_ectl_ratemanage2_arg.html 2004-08-03 03:50:51 UTC (rev 7460)
+++ trunk/vorbis/doc/vorbisenc/ov_ectl_ratemanage2_arg.html 2004-08-03 05:05:40 UTC (rev 7461)
@@ -0,0 +1,92 @@
+<html>
+
+<head>
+<title>vorbis - datatype - ov_ectl_ratemanage2_arg</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>ov_ectl_ratemanage2_arg</h1>
+
+<p><i>declared in "vorbis/vorbisenc.h"</i></p>
+
+<p>
+
+The ov_ectl_ratemanage2_arg structure is used with <a
+href="ov_ectl.html">ov_ectl()</a> and the OV_ECTL_RATEMANAGE2_GET and
+OV_ECTL_RATEMANAGE2_SET calls in order to query and modify specifics
+of the encoder's bitrate management configuration.
+
+<p>
+
+<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+ <td>
+<pre><b>struct ovectl_ratemanage2_arg {
+ int management_active;
+
+ long bitrate_limit_min_kbps;
+ long bitrate_limit_max_kbps;
+ long bitrate_limit_reservoir_bits;
+ double bitrate_limit_reservoir_bias;
+
+ long bitrate_average_kbps;
+ double bitrate_average_damping;
+};</b></pre>
+ </td>
+</tr>
+</table>
+
+<h3>Relevant Struct Members</h3>
+<dl>
+<dt><i>management_active</i></dt>
+<dd>nonzero if bitrate management is active</dd>
+
+<dt><i>bitrate_limit_min_kbps</i></dt>
+<dd>Lower allowed bitrate limit in kilobits per second</dd>
+<dt><i>bitrate_limit_max_kbps</i></dt>
+<dd>Upper allowed bitrate limit in kilobits per second</dd>
+<dt><i>bitrate_limit_reservoir_bits</i></dt>
+<dd>Size of the bitrate reservoir in bits</dd>
+<dt><i>bitrate_limit_reservoir_bias</i></dt>
+
+<dd>Regulates the bitrate reservoir's preferred fill level in a range
+from 0.0 to 1.0; 0.0 tries to bank bits to buffer against future
+bitrate spikes, 1.0 buffers against future sudden drops in
+instantaneous bitrate. Default is 0.1 </dd>
+
+<dt><i>bitrate_average_kbps</i></dt>
+<dd>Average bitrate setting in kilobits per second</dd>
+
+<dt><i>bitrate_average_damping</i></dt> <dd>Slew rate limit setting
+for average bitrate adjustment; sets the minimum time in seconds the
+bitrate tracker may swing from one extreme to the other when boosting
+or damping average bitrate.</dd>
+
+
+
+</dl>
+
+
+<br><br>
+<hr noshade>
+<table border=0 width=100%>
+<tr valign=top>
+<td><p class=tiny>copyright © 2004 vorbis team</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 at vorbis.org">team at vorbis.org</a></p></td>
+</tr><tr>
+<td><p class=tiny>vorbisfile documentation</p></td>
+<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
+</tr>
+</table>
+
+</body>
+
+</html>
Added: trunk/vorbis/doc/vorbisenc/ov_ectl_ratemanage_arg.html
===================================================================
--- trunk/vorbis/doc/vorbisenc/ov_ectl_ratemanage_arg.html 2004-08-03 03:50:51 UTC (rev 7460)
+++ trunk/vorbis/doc/vorbisenc/ov_ectl_ratemanage_arg.html 2004-08-03 05:05:40 UTC (rev 7461)
@@ -0,0 +1,92 @@
+<html>
+
+<head>
+<title>vorbis - datatype - ov_ectl_ratemanage_arg</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>ov_ectl_ratemanage_arg</h1>
+
+<p><i>declared in "vorbis/vorbisenc.h"</i></p>
+
+<p>
+
+The ov_ectl_ratemanage_arg structure is used with <a
+href="ov_ectl.html">ov_ectl()</a> and the OV_ECTL_RATEMANAGE_GET,
+OV_ECTL_RATEMANAGE_SET, OV_ECTL_RATEMANAGE_AVG,
+OV_ECTL_RATEMANAGE_HARD calls in order to query and modify specifics
+of the encoder's bitrate management configuration. Note that this is
+a deprecated interface; please use ov_ectl() with the <a
+href="ov_ectl_ratemanage2_arg.html">ov_ectl_ratemanage2_arg</a> struct
+and OV_ECTL_RATEMANAGE2_GET and OV_ECTL_RATEMANAGE2_SET calls in new
+code.
+
+<p>
+
+<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+ <td>
+<pre><b>struct ovectl_ratemanage_arg {
+ int management_active;
+
+ long bitrate_hard_min;
+ long bitrate_hard_max;
+ double bitrate_hard_window;
+
+ long bitrate_av_lo;
+ long bitrate_av_hi;
+ double bitrate_av_window;
+ double bitrate_av_window_center;
+};</b></pre>
+ </td>
+</tr>
+</table>
+
+<h3>Relevant Struct Members</h3>
+<dl>
+
+<dt><i>management_active</i></dt>
+<dd>nonzero if bitrate management is active</dd>
+
+<dt><i>bitrate_hard_min</i></dt>
+<dd>hard lower limit (in kilobits per second) below which the stream bitrate will never be allowed for any given bitrate_hard_window seconds of time.</dd>
+<dt><i>bitrate_hard_max</i></dt>
+<dd>hard upper limit (in kilobits per second) above which the stream bitrate will never be allowed for any given bitrate_hard_window seconds of time.</dd>
+<dt><i>bitrate_hard_window</i></dt>
+<dd>the window period (in seconds) used to regulate the hard bitrate minimum and maximum</dd>
+
+<dt><i>bitrate_av_lo</i></dt>
+<dd>soft lower limit (in kilobits per second) below which the average bitrate tracker will start nudging the bitrate higher.</dd>
+<dt><i>bitrate_av_hi</i></dt>
+<dd>soft upper limit (in kilobits per second) above which the average bitrate tracker will start nudging the bitrate lower.</dd>
+<dt><i>bitrate_av_window</i></dt>
+<dd>the window period (in seconds) used to regulate the average bitrate minimum and maximum.</dd>
+<dt><i>bitrate_av_window_center</i></dt>
+<dd>Regulates the relative centering of the average and hard windows; in libvorbis 1.0 and 1.0.1, the hard window regulation overlapped but followed the average window regulation. In libvorbis 1.1 a bit-reservoir interface replaces the old windowing interface; the older windowing interface is simulated and this field has no effect.</dd>
+
+</dl>
+
+
+<br><br>
+<hr noshade>
+<table border=0 width=100%>
+<tr valign=top>
+<td><p class=tiny>copyright © 2004 vorbis team</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 at vorbis.org">team at vorbis.org</a></p></td>
+</tr><tr>
+<td><p class=tiny>vorbisfile documentation</p></td>
+<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
+</tr>
+</table>
+
+</body>
+
+</html>
Modified: trunk/vorbis/doc/vorbisenc/vorbis_info.html
===================================================================
--- trunk/vorbis/doc/vorbisenc/vorbis_info.html 2004-08-03 03:50:51 UTC (rev 7460)
+++ trunk/vorbis/doc/vorbisenc/vorbis_info.html 2004-08-03 05:05:40 UTC (rev 7461)
@@ -57,8 +57,9 @@
<dt><i>bitrate_lower</i></dt>
<dd>Specifies the lower limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_upper parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd>
<dt><i>bitrate_window</i></dt>
-<dd>Specifies the size of the bit reservoir in /
-lower limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_upper parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd>
+<dd>Specifies the size of the bit reservoir in seconds relative to the nominal bitrate. May be unset.</dd>
+<dt><i>codec_setup</i></dt>
+<dd>Pointer to private encoder setup state.</dd>
</dl>
More information about the commits
mailing list