Struct Timecode 

pub struct Timecode { /* private fields */ }

A SMPTE timecode value.

Internally stored as a validated tuple (hh, mm, ss, ff). Drop-frame flag determines the string representation and frame counting.

Implementations

impl Timecode

pub fn new( hours: u8, minutes: u8, seconds: u8, frames: u8, rate: FrameRate, drop_frame: bool, ) -> Result<Self, TimecodeError>

Construct a timecode from components.

Errors

Returns TimecodeError if any component is out of range.

pub fn hours(&self) -> u8

Hours component.

pub fn minutes(&self) -> u8

Minutes component.

pub fn seconds(&self) -> u8

Seconds component.

pub fn frames(&self) -> u8

Frames component.

pub fn rate(&self) -> FrameRate

Frame rate.

pub fn is_drop_frame(&self) -> bool

Whether this is a drop-frame timecode.

pub fn to_frame_count(self) -> u64

Convert to an absolute frame count (from 00:00:00:00).

Uses the standard SMPTE drop-frame algorithm for DF timecodes.

pub fn from_frame_count( total: u64, rate: FrameRate, drop_frame: bool, ) -> Result<Self, TimecodeError>

Construct from an absolute frame count.

Errors

Returns an error if the resulting components are invalid.

pub fn to_secs_f64(self) -> f64

Convert to real-time seconds from 00:00:00:00.

pub fn from_secs_f64( secs: f64, rate: FrameRate, drop_frame: bool, ) -> Result<Self, TimecodeError>

Construct from real-time seconds.

Errors

Returns an error if the resulting components are invalid.

pub fn add_frames(self, frames: i64) -> Result<Self, TimecodeError>

Add a frame count to this timecode.

Errors

Returns an error if the result is out of range.

pub fn diff_frames(self, other: Self) -> Option<i64>

Compute the signed frame-count difference (self - other).

Returns None if the rates differ.

pub fn parse(s: &str, rate: FrameRate) -> Result<Self, TimecodeError>

Parse a SMPTE timecode string.

Accepts HH:MM:SS:FF (NDF) and HH:MM:SS;FF (DF).

Errors

Returns a TimecodeError if the string is malformed.

Trait Implementations

impl Clone for Timecode

fn clone(&self) -> Timecode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Timecode

impl Debug for Timecode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Timecode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Timecode

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

Formats the value using the given formatter.

impl Eq for Timecode

impl Hash for Timecode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Timecode

fn eq(&self, other: &Timecode) -> 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 Serialize for Timecode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Timecode