Skip to main content

Ffv1Config

Struct Ffv1Config 

Source
pub struct Ffv1Config {
    pub version: Ffv1Version,
    pub width: u32,
    pub height: u32,
    pub colorspace: Ffv1Colorspace,
    pub chroma_type: Ffv1ChromaType,
    pub bits_per_raw_sample: u8,
    pub num_h_slices: u32,
    pub num_v_slices: u32,
    pub ec: bool,
    pub state_transition_delta: Vec<i16>,
    pub range_coder_mode: bool,
}
Expand description

FFV1 configuration record.

Contains all parameters needed to initialize the encoder or decoder. In a container, this is stored as codec extradata (the “configuration record”).

Fields§

§version: Ffv1Version

FFV1 version.

§width: u32

Frame width in pixels.

§height: u32

Frame height in pixels.

§colorspace: Ffv1Colorspace

Colorspace.

§chroma_type: Ffv1ChromaType

Chroma subsampling (only meaningful for YCbCr).

§bits_per_raw_sample: u8

Bits per raw sample (8, 10, 12, or 16).

§num_h_slices: u32

Number of horizontal slices.

§num_v_slices: u32

Number of vertical slices.

§ec: bool

Error correction enabled (CRC32 per slice, v3+ only).

§state_transition_delta: Vec<i16>

Range coder state transition table index (0 = default).

§range_coder_mode: bool

Whether to use range coder (true) or Golomb-Rice (false). For v3 this is always true.

Implementations§

Source§

impl Ffv1Config

Source

pub fn num_slices(&self) -> u32

Total number of slices.

Source

pub fn max_sample_value(&self) -> i32

Maximum sample value for the configured bit depth.

Source

pub fn plane_count(&self) -> usize

Number of planes for this configuration.

Source

pub fn plane_dimensions(&self, plane_index: usize) -> (u32, u32)

Get the dimensions for a given plane index.

Source

pub fn validate(&self) -> CodecResult<()>

Validate the configuration.

Trait Implementations§

Source§

impl Clone for Ffv1Config

Source§

fn clone(&self) -> Ffv1Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Ffv1Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Ffv1Config

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.