Skip to main content

EncodePlan

Struct EncodePlan 

Source
pub struct EncodePlan {
Show 13 fields pub input: PathBuf, pub output: PathBuf, pub summary: String, pub expected_bytes: Option<u64>, pub target_bytes: Option<u64>, pub target_vmaf: Option<f64>, pub source_duration_sec: f64, pub source_width: Option<u32>, pub source_height: Option<u32>, pub source_fps: Option<f64>, pub spec: EncodeSpec, pub guard_larger: bool, pub ceiling_crf: Option<u8>,
}
Expand description

The encode plan — the result of Engine::plan. Usable for --dry-run.

Fields§

§input: PathBuf§output: PathBuf§summary: String

Human-readable description of the plan (codec, bitrates, passes).

§expected_bytes: Option<u64>

Expected final size in bytes, if predictable.

§target_bytes: Option<u64>

The hard size cap, if any (drives the post-encode correction retry).

§target_vmaf: Option<f64>

Target VMAF for a CRF search, if requested (quality mode only).

§source_duration_sec: f64

Source duration in seconds (for progress reporting).

§source_width: Option<u32>

Source resolution and frame rate — the reference for VMAF measurement.

§source_height: Option<u32>§source_fps: Option<f64>§spec: EncodeSpec§guard_larger: bool

Keep the original instead of producing a result that isn’t smaller (see ShrinkOpts::allow_larger). Engines without a guard set false.

§ceiling_crf: Option<u8>

Size targets only: the quality preset’s CRF, used as a ceiling — when a CRF encode is predicted to land well under the target, it’s used instead of spending the whole budget (a 2 s clip needn’t take 10 MB for Discord).

Trait Implementations§

Source§

impl Clone for EncodePlan

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EncodePlan

Source§

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

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

impl PartialEq for EncodePlan

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EncodePlan

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.