Skip to main content

TimecodeValue

Struct TimecodeValue 

Source
pub struct TimecodeValue {
    pub hh: u8,
    pub mm: u8,
    pub ss: u8,
    pub ff: u8,
    pub fps: f32,
    pub drop_frame: bool,
}
Expand description

A timecode value with arithmetic support.

Fields§

§hh: u8

Hours component (0-23)

§mm: u8

Minutes component (0-59)

§ss: u8

Seconds component (0-59)

§ff: u8

Frames component (0 to fps-1)

§fps: f32

Frames per second (e.g. 25.0, 29.97, 30.0)

§drop_frame: bool

Whether this timecode uses drop-frame notation

Implementations§

Source§

impl TimecodeValue

Source

pub fn new(hh: u8, mm: u8, ss: u8, ff: u8, fps: f32, drop_frame: bool) -> Self

Create a new timecode value.

Source

pub fn to_frame_count(&self) -> u64

Convert to total frame count since 00:00:00:00.

For drop-frame timecode, applies the standard SMPTE drop-frame adjustment.

Source

pub fn from_frame_count(frames: u64, fps: f32, drop_frame: bool) -> Self

Create a timecode value from a frame count.

Source

pub fn add_frames(&self, frames: i64) -> Self

Add a number of frames (positive or negative), wrapping at 24 hours.

Source

pub fn subtract(&self, other: &Self) -> i64

Compute the signed frame difference between self and another timecode.

Returns a positive value if self is later than other.

Source

pub fn to_string_formatted(&self) -> String

Convert to a formatted timecode string.

Uses colons for non-drop-frame and semicolons for drop-frame.

Source

pub fn parse(s: &str, fps: f32) -> Option<Self>

Parse a timecode string.

Detects drop-frame from the presence of a semicolon before the frame count. Format: HH:MM:SS:FF (NDF) or HH:MM:SS;FF (DF).

Trait Implementations§

Source§

impl Clone for TimecodeValue

Source§

fn clone(&self) -> TimecodeValue

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 Copy for TimecodeValue

Source§

impl Debug for TimecodeValue

Source§

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

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

impl Display for TimecodeValue

Source§

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

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

impl PartialEq for TimecodeValue

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for TimecodeValue

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.