Struct SuperFrames 

pub struct SuperFrames(pub u64);

Unit of time length (of a single de-interleaved channel) in super-frames.

A “super-frame” is a unit of time that is exactly 1 / 508,032,000 of a second. This number happens to be nicely divisible by all common sampling rates, allowing changes to sample rate in a project to be a lossless process.

Tuple Fields

0: u64

Implementations

impl SuperFrames

pub fn new(super_frames: u64) -> Self

• super_frames - The number of super-frames

A “super-frame” is a unit of time equal to 1 / 508,032,000 of a second. This number was chosen because it is nicely divisible by a whole slew of factors including 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 14, 15, 16, 18, 20, 24, 32, 64, 128, 256, 512, and 1920, as well as common sampling rates such as 22050, 24000, 44100, 48000, 88200, 96000, 176400, and 192000. This ensures that any recording of frame data in this format will always be at-least sample-accurate.

pub fn from_seconds(seconds: Seconds) -> Self

Get the time in SuperFrames from the time in Seconds

Note that this conversion is NOT lossless.

If the seconds value is negative, then the SuperFrames’s values will be 0.

pub fn from_frames(frames: Frames, sample_rate: SampleRate) -> Self

Get the time in SuperFrames from the time in Frames.

This conversion IS lossless if the sample rate happens to be equal to one of the common sample rates: 22050, 24000, 44100, 48000, 88200, 96000, 176400, or 192000. This conversion is NOT lossless otherwise.

pub fn to_seconds(&self) -> Seconds

Convert to the corresponding time in Seconds.

Note that this conversion is NOT lossless.

pub fn to_musical(&self, bpm: f64) -> MusicalTime

Convert to the corresponding MusicalTime.

Note that this conversion is NOT lossless.

pub fn to_nearest_frame_round(&self, sample_rate: SampleRate) -> Frames

Convert to the corresponding time length in Frames from the given SampleRate, rounded to the nearest frame.

Note that this conversion is NOT lossless.

pub fn to_nearest_frame_floor(&self, sample_rate: SampleRate) -> Frames

Convert to the corresponding time length in Frames from the given SampleRate, floored to the nearest frame.

Note that this conversion is NOT lossless.

pub fn to_nearest_frame_ceil(&self, sample_rate: SampleRate) -> Frames

Convert to the corresponding time length in Frames from the given SampleRate, ceil-ed to the nearest frame.

Note that this conversion is NOT lossless.

Trait Implementations

impl Add for SuperFrames

type Output = SuperFrames

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for SuperFrames

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for SuperFrames

fn clone(&self) -> SuperFrames

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SuperFrames

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

Formats the value using the given formatter.

impl Default for SuperFrames

fn default() -> Self

Returns the “default value” for a type.

impl Hash for SuperFrames

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 Mul<u64> for SuperFrames

type Output = SuperFrames

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Self::Output

Performs the * operation.

impl MulAssign<u64> for SuperFrames

fn mul_assign(&mut self, other: u64)

Performs the *= operation.

impl PartialEq for SuperFrames

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

fn partial_cmp(&self, other: &SuperFrames) -> 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 Sub for SuperFrames

type Output = SuperFrames

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for SuperFrames

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for SuperFrames

impl Eq for SuperFrames

impl StructuralPartialEq for SuperFrames