Struct Config

pub struct Config {
    pub(crate) enc: EncoderConfig,
    pub(crate) rate_control: RateControlConfig,
    pub(crate) threads: usize,
    pub(crate) pool: Option<Arc<ThreadPool>>,
}

Contains the encoder configuration.

Fields

enc: EncoderConfig

Settings which impact the produced bitstream.

rate_control: RateControlConfig

Rate control configuration

threads: usize

The number of threads in the threadpool.

pool: Option<Arc<ThreadPool>>

Shared thread pool

Implementations

impl Config

pub fn new() -> Self

Create a default configuration

same as Default::default()

pub fn with_encoder_config(self, enc: EncoderConfig) -> Self

Set the encoder configuration

EncoderConfig contains the settings impacting the codec features used in the produced bitstream.

pub const fn with_threads(self, threads: usize) -> Self

Set the number of workers in the threadpool

The threadpool is shared across all the different parallel components in the encoder.

If it is left unset, the encoder will use the default global threadpool provided by Rayon instead.

pub const fn with_rate_control(self, rate_control: RateControlConfig) -> Self

Set the rate control configuration

The default configuration is single pass

impl Config

pub(crate) fn new_inner<T: Pixel>( &self, ) -> Result<ContextInner<T>, InvalidConfig>

pub(crate) fn new_thread_pool(&self) -> Option<Arc<ThreadPool>>

Create a new threadpool with this configuration if set, or return None if global threadpool should be used instead.

pub fn new_context<T: Pixel>(&self) -> Result<Context<T>, InvalidConfig>

Creates a Context with this configuration.

Errors

Returns InvalidConfig if the config is invalid.

Examples

use rav1e::prelude::*;

let cfg = Config::default();
let ctx: Context<u8> = cfg.new_context()?;

pub fn validate(&self) -> Result<(), InvalidConfig>

Validates the configuration.

Errors

• Returns InvalidConfig if the tiling config is invalid.

pub fn tiling_info(&self) -> Result<TilingInfo, InvalidConfig>

Provide the tiling information for the current Config

Useful for reporting and debugging.

Errors

• Returns InvalidConfig if the tiling config is invalid.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.