Struct SubframeTimestamp 

pub struct SubframeTimestamp {
    pub timecode: Timecode,
    pub sample: u32,
    pub sample_rate: u32,
}

A timecode extended with a sub-frame audio sample offset.

Fields

timecode: Timecode

The integer-frame SMPTE timecode.

sample: u32

Zero-based sample offset within the current frame.

sample_rate: u32

Audio sample rate in Hz (e.g. 48000, 44100).

Implementations

impl SubframeTimestamp

pub fn new(tc: Timecode, sample: u32, sample_rate: u32) -> Self

Create a new SubframeTimestamp.

sample is the zero-based sample index within the frame identified by tc. sample_rate must be > 0.

Errors

Returns TimecodeError::InvalidConfiguration if sample_rate is 0.

pub fn to_nanos(&self) -> u64

Convert to an absolute nanosecond offset from timecode midnight (00:00:00:00).

The calculation is:

tc_nanos   = timecode.to_frames() * 1_000_000_000 / frame_rate
sub_nanos  = sample * 1_000_000_000 / sample_rate
total_nanos = tc_nanos + sub_nanos

Integer arithmetic is used throughout to avoid floating-point error. For drop-frame rates, timecode.to_frames() already accounts for the frame drops.

pub fn subframe_fraction(&self) -> f64

Return the sub-frame offset as a fraction in [0.0, 1.0) of one frame.

fraction = sample / (sample_rate / frame_rate)
         = sample * frame_rate / sample_rate

pub fn to_seconds_f64(&self) -> f64

Convert back to floating-point seconds from midnight.

pub fn advance_samples(&self, samples: u32) -> Result<Self, TimecodeError>

Advance by samples audio samples, wrapping timecode frames as needed.

Returns Err if timecode increment fails (e.g. wrapping past 23:59:59:xx).

Trait Implementations

impl Clone for SubframeTimestamp

fn clone(&self) -> SubframeTimestamp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubframeTimestamp

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

Formats the value using the given formatter.

impl Display for SubframeTimestamp

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

Formats the value using the given formatter.

impl Ord for SubframeTimestamp

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SubframeTimestamp

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for SubframeTimestamp

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SubframeTimestamp

impl Eq for SubframeTimestamp