annotate src/libvorbis-1.3.3/doc/vorbisenc/ovectl_ratemanage_arg.html @ 148:b4bfdf10c4b3

Update Win64 capnp builds to v0.6
author Chris Cannam <cannam@all-day-breakfast.com>
date Mon, 22 May 2017 18:56:49 +0100
parents 98c1576536ae
children
rev   line source
cannam@86 1 <html>
cannam@86 2
cannam@86 3 <head>
cannam@86 4 <title>vorbis - datatype - ovectl_ratemanage_arg</title>
cannam@86 5 <link rel=stylesheet href="style.css" type="text/css">
cannam@86 6 </head>
cannam@86 7
cannam@86 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
cannam@86 9 <table border=0 width=100%>
cannam@86 10 <tr>
cannam@86 11 <td><p class=tiny>libvorbisenc documentation</p></td>
cannam@86 12 <td align=right><p class=tiny>libvorbisenc version 1.3.2 - 20101101</p></td>
cannam@86 13 </tr>
cannam@86 14 </table>
cannam@86 15
cannam@86 16 <h1>ovectl_ratemanage_arg</h1>
cannam@86 17
cannam@86 18 <p><i>declared in "vorbis/vorbisenc.h"</i></p>
cannam@86 19
cannam@86 20 <p>
cannam@86 21
cannam@86 22 The ovectl_ratemanage_arg structure is used with <a
cannam@86 23 href="vorbis_encode_ctl.html">vorbis_encode_ctl()</a> and the OV_ECTL_RATEMANAGE_GET,
cannam@86 24 OV_ECTL_RATEMANAGE_SET, OV_ECTL_RATEMANAGE_AVG,
cannam@86 25 OV_ECTL_RATEMANAGE_HARD calls in order to query and modify specifics
cannam@86 26 of the encoder's bitrate management configuration. Note that this is
cannam@86 27 a deprecated interface; please use vorbis_encode_ctl() with the <a
cannam@86 28 href="ovectl_ratemanage2_arg.html">ovectl_ratemanage2_arg</a> struct
cannam@86 29 and OV_ECTL_RATEMANAGE2_GET and OV_ECTL_RATEMANAGE2_SET calls in new
cannam@86 30 code.
cannam@86 31
cannam@86 32 <p>
cannam@86 33
cannam@86 34 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
cannam@86 35 <tr bgcolor=#cccccc>
cannam@86 36 <td>
cannam@86 37 <pre><b>struct ovectl_ratemanage_arg {
cannam@86 38 int management_active;
cannam@86 39
cannam@86 40 long bitrate_hard_min;
cannam@86 41 long bitrate_hard_max;
cannam@86 42 double bitrate_hard_window;
cannam@86 43
cannam@86 44 long bitrate_av_lo;
cannam@86 45 long bitrate_av_hi;
cannam@86 46 double bitrate_av_window;
cannam@86 47 double bitrate_av_window_center;
cannam@86 48 };</b></pre>
cannam@86 49 </td>
cannam@86 50 </tr>
cannam@86 51 </table>
cannam@86 52
cannam@86 53 <h3>Relevant Struct Members</h3>
cannam@86 54 <dl>
cannam@86 55
cannam@86 56 <dt><i>management_active</i></dt>
cannam@86 57 <dd>nonzero if bitrate management is active</dd>
cannam@86 58
cannam@86 59 <dt><i>bitrate_hard_min</i></dt>
cannam@86 60 <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>
cannam@86 61 <dt><i>bitrate_hard_max</i></dt>
cannam@86 62 <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>
cannam@86 63 <dt><i>bitrate_hard_window</i></dt>
cannam@86 64 <dd>the window period (in seconds) used to regulate the hard bitrate minimum and maximum</dd>
cannam@86 65
cannam@86 66 <dt><i>bitrate_av_lo</i></dt>
cannam@86 67 <dd>soft lower limit (in kilobits per second) below which the average bitrate tracker will start nudging the bitrate higher.</dd>
cannam@86 68 <dt><i>bitrate_av_hi</i></dt>
cannam@86 69 <dd>soft upper limit (in kilobits per second) above which the average bitrate tracker will start nudging the bitrate lower.</dd>
cannam@86 70 <dt><i>bitrate_av_window</i></dt>
cannam@86 71 <dd>the window period (in seconds) used to regulate the average bitrate minimum and maximum.</dd>
cannam@86 72 <dt><i>bitrate_av_window_center</i></dt>
cannam@86 73 <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>
cannam@86 74
cannam@86 75 </dl>
cannam@86 76
cannam@86 77
cannam@86 78 <br><br>
cannam@86 79 <hr noshade>
cannam@86 80 <table border=0 width=100%>
cannam@86 81 <tr valign=top>
cannam@86 82 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
cannam@86 83 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
cannam@86 84 </tr><tr>
cannam@86 85 <td><p class=tiny>libvorbisenc documentation</p></td>
cannam@86 86 <td align=right><p class=tiny>libvorbisenc version 1.3.2 - 20101101</p></td>
cannam@86 87 </tr>
cannam@86 88 </table>
cannam@86 89
cannam@86 90 </body>
cannam@86 91
cannam@86 92 </html>