vpx_rs::enc::ctrl

Enum EncoderControlSet

pub enum EncoderControlSet<'a> {
Show 50 variants
    Vp8RoiMap(&'a vpx_roi_map),
    ActiveMap(&'a vpx_active_map),
    ScaleMode(vpx_scaling_mode),
    CpuUsed(i32),
    EnableAutoAltRef(u32),
    Vp8NoiseSensitivity(Vp8NoiseSensitivity),
    Sharpness(u32),
    StaticThreshold(u32),
    Vp8TokenPartitions(vp8e_token_partitions),
    ARNRMaxFrames(u32),
    ARNRStrength(u32),
    Tuning(vp8e_tuning),
    CQLevel(u32),
    MaxIntraBitratePct(u32),
    Vp8FrameFlags(i32),
    Vp9MaxInterBitratePct(u32),
    Vp9GoldenFrameCBRBoostPct(u32),
    Vp8TemporalLayerID(i32),
    Vp8ScreenContentMode(Vp8ScreenContentMode),
    Vp9CodingMode(Vp9CodingMode),
    Vp9TileColumns(u32),
    Vp9TileRows(u32),
    Vp9FrameParallelDecoding(bool),
    Vp9AQMode(Vp9AQMode),
    Vp9FramePeriodicBoost(bool),
    Vp9NoiseSensitivity(Vp9NoiseSensitivity),
    Vp9Svc(bool),
    Vp9RoiMap(Option<&'a vpx_roi_map>),
    Vp9TuneContent(Vp9TuneContent),
    Vp9ColorSpace(vpx_color_space),
    Vp9MinGFInterval(u32),
    Vp9MaxGFInterval(u32),
    Vp9ColorRange(Vp9ColorRange),
    Vp9SvcRefFrameConfig(&'a vpx_svc_ref_frame_config),
    Vp9RenderSize {
        width: i32,
        height: i32,
    },
    Vp9TargetLevel(u8),
    Vp9RowMT(bool),
    Vp9AltRefAQ(bool),
    Vp8GoldenFrameCBRBoostPct(u32),
    Vp9SvcInterLayerPred(Vp9SvcInterLayerPred),
    Vp9SvcFrameDropLayer(vpx_svc_frame_drop),
    Vp9SvcGFTemporalRef(bool),
    Vp9SvcSpatialLayerSync(vpx_svc_spatial_layer_sync),
    Vp9SetTPL(bool),
    Vp9PostEncodeDrop(bool),
    Vp9DeltaQUV(i32),
    Vp9DisableOvershootMaxQCBR(bool),
    Vp9Loopfilter(Vp9Loopfilter),
    Vp9ExternalRateControl(&'a vpx_rc_funcs),
    Vp9SetQuantizerOnePass(i32),
}

Expand description

Encapsulates the vp8e_enc_control_id values with their associated argument types to provide enhanced type safety. Enum values prefixed with the respective codec type (Vp8 or Vp9) are codec-specific. Values without the prefix apply to all codecs.

Attempting to set a control on the wrong codec type will result in an error.

Variants§

§

Vp8RoiMap(&'a vpx_roi_map)

Codec control function to pass an ROI map to encoder.

Supported in codecs: VP8

§

ActiveMap(&'a vpx_active_map)

Codec control function to pass an Active map to encoder.

Supported in codecs: VP8, VP9

§

ScaleMode(vpx_scaling_mode)

Codec control function to set encoder scaling mode.

Supported in codecs: VP8, VP9

§

CpuUsed(i32)

Codec control function to set encoder internal speed settings.

Changes in this value influences, among others, the encoder’s selection of motion estimation methods. Values greater than 0 will increase encoder speed at the expense of quality.

Note: Valid range for VP8: -16..16
Note: Valid range for VP9: -9..9
Note: A negative value (-n) is treated as its absolute value (n) in VP9.

Supported in codecs: VP8, VP9

§

EnableAutoAltRef(u32)

Codec control function to enable automatic use of arf frames.

Note: Valid range for VP8: 0..1
Note: Valid range for VP9: 0..6

Supported in codecs: VP8, VP9

§

Vp8NoiseSensitivity(Vp8NoiseSensitivity)

control function to set noise sensitivity

Supported in codecs: VP8

§

Sharpness(u32)

Codec control function to set higher sharpness at the expense of a lower PSNR.

Note: Valid range: 0..7

Supported in codecs: VP8, VP9

§

StaticThreshold(u32)

Codec control function to set the threshold for MBs treated static.

Supported in codecs: VP8, VP9

§

Vp8TokenPartitions(vp8e_token_partitions)

Codec control function to set the number of token partitions.

Supported in codecs: VP8

§

ARNRMaxFrames(u32)

Codec control function to set the max no of frames to create arf.

Supported in codecs: VP8, VP9

§

ARNRStrength(u32)

Codec control function to set the filter strength for the arf.

Supported in codecs: VP8, VP9

§

Tuning(vp8e_tuning)

Codec control function to set visual tuning.

Supported in codecs: VP8, VP9

§

CQLevel(u32)

Codec control function to set constrained / constant quality level.

For this value to be used, you must construct the encoder with super::EncoderConfig::rate_control set to super::RateControl::ConstrainedQuality or super::RateControl::ConstantQuality.

Note: Valid range: 0..63

Supported in codecs: VP8, VP9

§

MaxIntraBitratePct(u32)

Codec control function to set Max data rate for Intra frames.

This value controls additional clamping on the maximum size of a keyframe. It is expressed as a percentage of the average per-frame bitrate, with the special (and default) value 0 meaning unlimited, or no additional clamping beyond the codec’s built-in algorithm.

For example, to allocate no more than 4.5 frames worth of bitrate to a keyframe, set this to 450.

Supported in codecs: VP8, VP9

§

Vp8FrameFlags(i32)

Codec control function to set reference and update frame flags.

Supported in codecs: VP8

§

Vp9MaxInterBitratePct(u32)

Codec control function to set max data rate for Inter frames.

This value controls additional clamping on the maximum size of an inter frame. It is expressed as a percentage of the average per-frame bitrate, with the special (and default) value 0 meaning unlimited, or no additional clamping beyond the codec’s built-in algorithm.

For example, to allow no more than 4.5 frames worth of bitrate to an inter frame, set this to 450.

Supported in codecs: VP9

§

Vp9GoldenFrameCBRBoostPct(u32)

Boost percentage for Golden Frame in CBR mode.

This value controls the amount of boost given to Golden Frame in CBR mode. It is expressed as a percentage of the average per-frame bitrate, with the special (and default) value 0 meaning the feature is off, i.e., no golden frame boost in CBR mode and average bitrate target is used.

For example, to allow 100% more bits, i.e., 2X, in a golden frame than average frame, set this to 100.

Supported in codecs: VP9

§

Vp8TemporalLayerID(i32)

Codec control function to set the temporal layer id.

For temporal scalability: this control allows the application to set the layer id for each frame to be encoded. Note that this control must be set for every frame prior to encoding. The usage of this control function supersedes the internal temporal pattern counter, which is now deprecated.

Supported in codecs: VP8

§

Vp8ScreenContentMode(Vp8ScreenContentMode)

Codec control function to set encoder screen content mode.

Supported in codecs: VP8

§

Vp9CodingMode(Vp9CodingMode)

Codec control function to set encoding mode.

VP9 can operate in lossless encoding mode, in which the bitstream produced will be able to decode and reconstruct a perfect copy of input source. This control function provides a mean to switch encoder into lossless coding mode or normal coding mode that may be lossy.

By default, encoder operates in normal coding mode (lossy).

Supported in codecs: VP9

§

Vp9TileColumns(u32)

Codec control function to set number of tile columns.

In encoding and decoding, VP9 allows an input image frame be partitioned into separated vertical tile columns, which can be encoded or decoded independently. This enables easy implementation of parallel encoding and decoding. This control requests the encoder to use column tiles in encoding an input frame, with number of tile columns (in Log2 unit) as the parameter:

0 = 1 tile column
1 = 2 tile columns
2 = 4 tile columns
…..
n = 2ⁿ tile columns

The requested tile columns will be capped by the encoder based on image size limitations (The minimum width of a tile column is 256 pixels, the maximum is 4096).

By default, the value is 6, i.e., the maximum number of tiles supported by the resolution.

Supported in codecs: VP9

§

Vp9TileRows(u32)

Codec control function to set number of tile rows.

In encoding and decoding, VP9 allows an input image frame be partitioned into separated horizontal tile rows. Tile rows are encoded or decoded sequentially. Even though encoding/decoding of later tile rows depends on earlier ones, this allows the encoder to output data packets for tile rows prior to completely processing all tile rows in a frame, thereby reducing the latency in processing between input and output. The parameter for this control describes the number of tile rows, which has a valid range [0, 2]:

0 = 1 tile row
1 = 2 tile rows
2 = 4 tile rows

By default, the value is 0, i.e. one single row tile for entire image.

Supported in codecs: VP9

§

Vp9FrameParallelDecoding(bool)

Codec control function to enable frame parallel decoding feature.

VP9 has a bitstream feature to reduce decoding dependency between frames by turning off backward update of probability context used in encoding and decoding. This allows staged parallel processing of more than one video frame in the decoder. This control function provides a means to turn this feature on or off for bitstreams produced by encoder.

By default, this feature is on.

Supported in codecs: VP9

§

Vp9AQMode(Vp9AQMode)

Codec control function to set adaptive quantization mode.

VP9 has a segment based feature that allows encoder to adaptively change quantization parameter for each segment within a frame to improve the subjective quality. This control makes encoder operate in one of the several AQ_modes supported.

By default, encoder operates with AQ_Mode 0(adaptive quantization off).

Supported in codecs: VP9

§

Vp9FramePeriodicBoost(bool)

Codec control function to enable/disable periodic Q boost.

One VP9 encoder speed feature is to enable quality boost by lowering frame level Q periodically. This control function provides a mean to turn on/off this feature.

By default, the encoder is allowed to use this feature for appropriate encoding modes.

Supported in codecs: VP9

§

Vp9NoiseSensitivity(Vp9NoiseSensitivity)

Codec control function to set noise sensitivity.

Supported in codecs: VP9

§

Vp9Svc(bool)

Codec control function to turn on/off SVC in encoder.

Note: Returns an error if the encoder does not support SVC in its current encoding mode

Supported in codecs: VP9

§

Vp9RoiMap(Option<&'a vpx_roi_map>)

Codec control function to pass an ROI map to encoder.

Supported in codecs: VP9

§

Vp9TuneContent(Vp9TuneContent)

Codec control function to set content type.

Supported in codecs: VP9

§

Vp9ColorSpace(vpx_color_space)

Codec control function to set color space info.

Supported in codecs: VP9

§

Vp9MinGFInterval(u32)

Codec control function to set minimum interval between GF/ARF frames.

By default the value is set as 4.

Supported in codecs: VP9

§

Vp9MaxGFInterval(u32)

Codec control function to set miximum interval between GF/ARF frames.

By default the value is set as 16.

Supported in codecs: VP9

§

Vp9ColorRange(Vp9ColorRange)

Codec control function to set color range bit. Supported in codecs: VP9

§

Vp9SvcRefFrameConfig(&'a vpx_svc_ref_frame_config)

Codec control function to set the frame flags and buffer indices for spatial layers. The frame flags and buffer indices are set using the struct #vpx_svc_ref_frame_config defined below.

Supported in codecs: VP9

§

Vp9RenderSize

Codec control function to set intended rendering image size

By default, this is identical to the image size in pixels.

Supported in codecs: VP9

Fields

§width: i32

Rendering image width in pixels.

§height: i32

Rendering image height in pixels.

§

Vp9TargetLevel(u8)

Codec control function to set target level.

255: off (default)
0: only keep level stats
10: target for level 1.0
11: target for level 1.1
…
62: target for level 6.2

Supported in codecs: VP9

§

Vp9RowMT(bool)

Codec control function to set row level multi-threading.

Supported in codecs: VP9

§

Vp9AltRefAQ(bool)

Codec control function to enable/disable special mode for altref adaptive quantization. You can use it with –aq-mode concurrently.

Enable special adaptive quantization for altref frames based on their expected prediction quality for the future frames.

Supported in codecs: VP9

§

Vp8GoldenFrameCBRBoostPct(u32)

Boost percentage for Golden Frame in CBR mode.

This value controls the amount of boost given to Golden Frame in CBR mode. It is expressed as a percentage of the average per-frame bitrate, with the special (and default) value 0 meaning the feature is off, i.e., no golden frame boost in CBR mode and average bitrate target is used.

For example, to allow 100% more bits, i.e., 2X, in a golden frame than average frame, set this to 100.

Supported in codecs: VP8

§

Vp9SvcInterLayerPred(Vp9SvcInterLayerPred)

Codec control function to constrain the inter-layer prediction (prediction of lower spatial resolution) in VP9 SVC.

Supported in codecs: VP9

§

Vp9SvcFrameDropLayer(vpx_svc_frame_drop)

Codec control function to set mode and thresholds for frame dropping in SVC. Drop frame thresholds are set per-layer. Mode is set as: 0 : layer-dependent dropping, 1 : constrained dropping, current layer drop forces drop on all upper layers. Default mode is 0.

Supported in codecs: VP9

§

Vp9SvcGFTemporalRef(bool)

Codec control function to enable/disable use of golden reference as a second temporal reference for SVC. Only used when inter-layer prediction is disabled on INTER frames.

Supported in codecs: VP9

§

Vp9SvcSpatialLayerSync(vpx_svc_spatial_layer_sync)

Codec control function to enable spatial layer sync frame, for any spatial layer. Enabling it for layer k means spatial layer k will disable all temporal prediction, but keep the inter-layer prediction. It will refresh any temporal reference buffer for that layer, and reset the* temporal layer for the superframe to 0. Setting the layer sync for base spatial layer forces a key frame. Default is off (0) for all spatial layers. Spatial layer sync flag is reset to 0 after each encoded layer, so when control is invoked it is only used for the current superframe.

Supported in codecs: VP9

§