vorbis - datatype - ov_ectl_ratemanage2

From 23aa8d73e55609dd7de845818db50cda75858591 Mon Sep 17 00:00:00 2001 From: Monty Date: Tue, 3 Aug 2004 05:05:40 +0000 Subject: [PATCH] Finished data structure docs svn path=/trunk/vorbis/; revision=7461 --- doc/vorbisenc/examples.html | 2 +- doc/vorbisenc/ov_ectl_ratemanage2_arg.html | 92 ++++++++++++++++++++++++++++++ doc/vorbisenc/ov_ectl_ratemanage_arg.html | 92 ++++++++++++++++++++++++++++++ doc/vorbisenc/vorbis_info.html | 5 +- 4 files changed, 188 insertions(+), 3 deletions(-) create mode 100644 doc/vorbisenc/ov_ectl_ratemanage2_arg.html create mode 100644 doc/vorbisenc/ov_ectl_ratemanage_arg.html diff --git a/doc/vorbisenc/examples.html b/doc/vorbisenc/examples.html index 6fad4e6..75f50ff 100644 --- a/doc/vorbisenc/examples.html +++ b/doc/vorbisenc/examples.html @@ -91,7 +91,7 @@ use with libvorbis.

if(ret) exit(1); -

Example: encoding using VBR sleected by approximate bitrate

Example: encoding using VBR selected by approximate bitrate

 
diff --git a/doc/vorbisenc/ov_ectl_ratemanage2_arg.html b/doc/vorbisenc/ov_ectl_ratemanage2_arg.html
new file mode 100644
index 0000000..cca07dd
--- /dev/null
+++ b/doc/vorbisenc/ov_ectl_ratemanage2_arg.html
@@ -0,0 +1,92 @@
+
+
+
+vorbis - datatype - ov_ectl_ratemanage2_arg
+
+
+
+
+
+
+
+
+
+libvorbisenc documentation libvorbisenc release 1.1 - 20040709
+
+ov_ectl_ratemanage2_arg
+
+declared in "vorbis/vorbisenc.h"
+
+
+
+The ov_ectl_ratemanage2_arg structure is used with ov_ectl() 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.
+
+

+
+
+
+	
+
+
+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;
+};
+	
+
+
Relevant Struct Members
+
+management_active
+nonzero if bitrate management is active
+
+bitrate_limit_min_kbps
+Lower allowed bitrate limit in kilobits per second
+bitrate_limit_max_kbps
+Upper allowed bitrate limit in kilobits per second
+bitrate_limit_reservoir_bits
+Size of the bitrate reservoir in bits
+bitrate_limit_reservoir_bias
+
+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 
+
+bitrate_average_kbps
+Average bitrate setting in kilobits per second
+
+bitrate_average_damping
 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.
+
+
+
+
+
+
+


+
+
+
+
+
+
+
+
+
+copyright © 2004 vorbis team Ogg Vorbis
team@vorbis.org
vorbisfile documentation libvorbisenc release 1.1 - 20040709
+
+
+
+
diff --git a/doc/vorbisenc/ov_ectl_ratemanage_arg.html b/doc/vorbisenc/ov_ectl_ratemanage_arg.html
new file mode 100644
index 0000000..8ad9aea
--- /dev/null
+++ b/doc/vorbisenc/ov_ectl_ratemanage_arg.html
@@ -0,0 +1,92 @@
+
+
+
+vorbis - datatype - ov_ectl_ratemanage_arg
+
+
+
+
+
+
+
+
+
+libvorbisenc documentation libvorbisenc release 1.1 - 20040709
+
+ov_ectl_ratemanage_arg
+
+declared in "vorbis/vorbisenc.h"
+
+
+
+The ov_ectl_ratemanage_arg structure is used with ov_ectl() 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 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.
+
+
+
+
+


+
+
+
+
+
+
+
+
+
+copyright © 2004 vorbis team Ogg Vorbis
team@vorbis.org
vorbisfile documentation libvorbisenc release 1.1 - 20040709
+
+
+
+
diff --git a/doc/vorbisenc/vorbis_info.html b/doc/vorbisenc/vorbis_info.html
index 1d853f8..99d2bbe 100644
--- a/doc/vorbisenc/vorbis_info.html
+++ b/doc/vorbisenc/vorbis_info.html
@@ -57,8 +57,9 @@ The vorbis_info structure contains information about a vorbis bitstream.
 bitrate_lower
 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.
 bitrate_window
-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.
+Specifies the size of the bit reservoir in seconds relative to the nominal bitrate.  May be unset.
+codec_setup
+Pointer to private encoder setup state.
 
 
 
-- 
2.7.4