• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2
3<head>
4<title>vorbis - datatype - ov_ectl_ratemanage2_arg</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>libvorbisenc documentation</p></td>
12<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
13</tr>
14</table>
15
16<h1>ov_ectl_ratemanage2_arg</h1>
17
18<p><i>declared in "vorbis/vorbisenc.h"</i></p>
19
20<p>
21
22The ov_ectl_ratemanage2_arg structure is used with <a
23href="vorbis_encode_ctl.html">vorbis_encode_ctl()</a> and the OV_ECTL_RATEMANAGE2_GET and
24OV_ECTL_RATEMANAGE2_SET  calls in order to query and modify specifics
25of the encoder's bitrate management configuration.
26
27<p>
28
29<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
30<tr bgcolor=#cccccc>
31	<td>
32<pre><b>struct ovectl_ratemanage2_arg {
33  int    management_active;
34
35  long   bitrate_limit_min_kbps;
36  long   bitrate_limit_max_kbps;
37  long   bitrate_limit_reservoir_bits;
38  double bitrate_limit_reservoir_bias;
39
40  long   bitrate_average_kbps;
41  double bitrate_average_damping;
42};</b></pre>
43	</td>
44</tr>
45</table>
46
47<h3>Relevant Struct Members</h3>
48<dl>
49<dt><i>management_active</i></dt>
50<dd>nonzero if bitrate management is active</dd>
51
52<dt><i>bitrate_limit_min_kbps</i></dt>
53<dd>Lower allowed bitrate limit in kilobits per second</dd>
54<dt><i>bitrate_limit_max_kbps</i></dt>
55<dd>Upper allowed bitrate limit in kilobits per second</dd>
56<dt><i>bitrate_limit_reservoir_bits</i></dt>
57<dd>Size of the bitrate reservoir in bits</dd>
58<dt><i>bitrate_limit_reservoir_bias</i></dt>
59
60<dd>Regulates the bitrate reservoir's preferred fill level in a range
61from 0.0 to 1.0; 0.0 tries to bank bits to buffer against future
62bitrate spikes, 1.0 buffers against future sudden drops in
63instantaneous bitrate.  Default is 0.1 </dd>
64
65<dt><i>bitrate_average_kbps</i></dt>
66<dd>Average bitrate setting in kilobits per second</dd>
67
68<dt><i>bitrate_average_damping</i></dt> <dd>Slew rate limit setting
69for average bitrate adjustment; sets the minimum time in seconds the
70bitrate tracker may swing from one extreme to the other when boosting
71or damping average bitrate.</dd>
72
73
74
75</dl>
76
77
78<br><br>
79<hr noshade>
80<table border=0 width=100%>
81<tr valign=top>
82<td><p class=tiny>copyright &copy; 2004 vorbis team</p></td>
83<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>
84</tr><tr>
85<td><p class=tiny>vorbisfile documentation</p></td>
86<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
87</tr>
88</table>
89
90</body>
91
92</html>
93