summaryrefslogtreecommitdiffhomepage
path: root/vorbis/doc/vorbisenc/ovectl_ratemanage2_arg.html
blob: 3d9d417b5753f111d0997b9b2d6245de77b0bb57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<html>

<head>
<title>vorbis - datatype - ovectl_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 version 1.3.2 - 20101101</p></td>
</tr>
</table>

<h1>ovectl_ratemanage2_arg</h1>

<p><i>declared in "vorbis/vorbisenc.h"</i></p>

<p>

The ovectl_ratemanage2_arg structure is used with <a
href="vorbis_encode_ctl.html">vorbis_encode_ctl()</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 &copy; 2000-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>libvorbisenc documentation</p></td>
<td align=right><p class=tiny>libvorbisenc version 1.3.2 - 20101101</p></td>
</tr>
</table>

</body>

</html>