ov_ectl_ratemanage_arg

declared in "vorbis/vorbisenc.h"

The ov_ectl_ratemanage_arg structure is used with vorbis_encode_ctl() 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 vorbis_encode_ctl() with the ov_ectl_ratemanage2_arg struct and OV_ECTL_RATEMANAGE2_GET and OV_ECTL_RATEMANAGE2_SET calls in new code.

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; };

Relevant Struct Members

management_active

nonzero if bitrate management is active

bitrate_hard_min

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.

bitrate_hard_max

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.

bitrate_hard_window

the window period (in seconds) used to regulate the hard bitrate minimum and maximum

bitrate_av_lo

soft lower limit (in kilobits per second) below which the average bitrate tracker will start nudging the bitrate higher.

bitrate_av_hi

soft upper limit (in kilobits per second) above which the average bitrate tracker will start nudging the bitrate lower.

bitrate_av_window

the window period (in seconds) used to regulate the average bitrate minimum and maximum.

bitrate_av_window_center

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.