time_calc::samples

Struct Samples

Source
pub struct Samples(pub Samples);
Expand description

Time representation in the form of Samples.

Tuple Fields§

§0: Samples

Implementations§

Source§

impl Samples

Source

pub fn samples(&self) -> Samples

Return Samples as it’s unit value.

Source

pub fn bars(&self, bpm: Bpm, ts: TimeSig, sample_hz: SampleHz) -> f64

Convert to the equivalent duration in Bars.

Examples found in repository?
examples/test.rs (line 65)
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
fn main() {
    println!("time_calc demonstration!");

    // Out `Bars` type is a simplified version of a Measure.
    assert!(Bars(1).measure() == Measure(1, Division::Bar, DivType::Whole));
    // The same goes for out `Beats` type.
    assert!(Beats(1).measure() == Measure(1, Division::Beat, DivType::Whole));

    // We can use "parts per quarter note" to convert to ticks.
    println!("Parts per quarter note: {}", PPQN);
    println!("Duration of a beat in ticks: {}", Beats(1).ticks(PPQN));
    println!("Duration of 38_400 ticks in beats: {}", Ticks(38_400).beats(PPQN));

    // We can use "beats per minute" to convert from musical time to milliseconds.
    let bpm: Bpm = 120.0;
    println!("Duration of a beat at 120 beats per minute: {} milliseconds.", Beats(1).ms(bpm));

    // And we can use "samples per second" to convert our duration to samples.
    println!("Samples per second: {}", SAMPLE_HZ);
    println!("Duration of a beat at 120bpm in samples: {}", Beats(1).samples(bpm, SAMPLE_HZ));

    // We also need to know the "time signature" if we are to convert from "Bars".
    // This is because different time signatures can have a different duration in "Beats".
    let beats_per_bar = TimeSig { top: 4, bottom: 4 }.beats_per_bar();
    println!("Duration of a bar in `Beats` with a 4/4 Time Signature: {}", beats_per_bar);
    let beats_per_bar = TimeSig { top: 3, bottom: 4 }.beats_per_bar();
    println!("Duration of a bar in `Beats` with a 3/4 Time Signature: {}", beats_per_bar);
    let beats_per_bar = TimeSig { top: 7, bottom: 8 }.beats_per_bar();
    println!("Duration of a bar in `Beats` with a 7/8 Time Signature: {}", beats_per_bar);
    let time_sig = TimeSig { top: 4, bottom: 4 };
    println!("Duration of a bar at 120bpm, 44_100 sample_hz and 4/4 Time Sig in samples: {}",
             Bars(1).samples(bpm, time_sig, SAMPLE_HZ));

    // We can also convert back the other way! Here's an example from Ms -> Beats.
    println!("1 minute as a duration in beats: {}", Ms(60_000.0).beats(bpm));

    // Here's an example from Samples -> Bars.
    println!("176_400 samples as a duration in bars: {}",
             Samples(176_400).bars(bpm, time_sig, SAMPLE_HZ));

    println!("Great Success!");
}
Source

pub fn beats(&self, bpm: Bpm, sample_hz: SampleHz) -> f64

Convert to the equivalent duration in Beats.

Source

pub fn ms(&self, sample_hz: SampleHz) -> Ms

Convert to the unit value of Ms.

Source

pub fn to_ms(&self, sample_hz: SampleHz) -> Ms

Convert to Ms.

Source

pub fn ticks(&self, bpm: Bpm, ppqn: Ppqn, sample_hz: SampleHz) -> Ticks

Convert to the unit value of Ticks.

Source

pub fn to_ticks(&self, bpm: Bpm, ppqn: Ppqn, sample_hz: SampleHz) -> Ticks

Convert to Ticks.

Trait Implementations§

Source§

impl Add for Samples

Source§

type Output = Samples

The resulting type after applying the + operator.
Source§

fn add(self, rhs: Samples) -> Samples

Performs the + operation. Read more
Source§

impl AddAssign for Samples

Source§

fn add_assign(&mut self, rhs: Samples)

Performs the += operation. Read more
Source§

impl Clone for Samples

Source§

fn clone(&self) -> Samples

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Samples

Source§

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

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

impl Div for Samples

Source§

type Output = Samples

The resulting type after applying the / operator.
Source§

fn div(self, rhs: Samples) -> Samples

Performs the / operation. Read more
Source§

impl DivAssign for Samples

Source§

fn div_assign(&mut self, rhs: Samples)

Performs the /= operation. Read more
Source§

impl From<i64> for Samples

Source§

fn from(samples: Samples) -> Self

Converts to this type from the input type.
Source§

impl FromPrimitive for Samples

Source§

fn from_u64(n: u64) -> Option<Samples>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.
Source§

fn from_i64(n: i64) -> Option<Samples>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.
Source§

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.
Source§

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.
Source§

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.
Source§

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.
Source§

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Source§

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.
Source§

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.
Source§

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.
Source§

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.
Source§

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Source§

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.
Source§

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Source§

impl Hash for Samples

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Mul for Samples

Source§

type Output = Samples

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Samples) -> Samples

Performs the * operation. Read more
Source§

impl MulAssign for Samples

Source§

fn mul_assign(&mut self, rhs: Samples)

Performs the *= operation. Read more
Source§

impl Neg for Samples

Source§

type Output = Samples

The resulting type after applying the - operator.
Source§

fn neg(self) -> Samples

Performs the unary - operation. Read more
Source§

impl Ord for Samples

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Samples

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 PartialOrd for Samples

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl Rem for Samples

Source§

type Output = Samples

The resulting type after applying the % operator.
Source§

fn rem(self, rhs: Samples) -> Samples

Performs the % operation. Read more
Source§

impl RemAssign for Samples

Source§

fn rem_assign(&mut self, rhs: Samples)

Performs the %= operation. Read more
Source§

impl Sub for Samples

Source§

type Output = Samples

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: Samples) -> Samples

Performs the - operation. Read more
Source§

impl SubAssign for Samples

Source§

fn sub_assign(&mut self, rhs: Samples)

Performs the -= operation. Read more
Source§

impl ToPrimitive for Samples

Source§

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.
Source§

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.
Source§

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.
Source§

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.
Source§

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.
Source§

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.
Source§

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned. Read more
Source§

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.
Source§

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.
Source§

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.
Source§

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.
Source§

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned. Read more
Source§

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.
Source§

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64. Read more
Source§

impl Copy for Samples

Source§

impl Eq for Samples

Source§

impl StructuralPartialEq for Samples

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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 = 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.
Source§

impl<T, Rhs> NumAssignOps<Rhs> for T
where T: AddAssign<Rhs> + SubAssign<Rhs> + MulAssign<Rhs> + DivAssign<Rhs> + RemAssign<Rhs>,

Source§

impl<T, Rhs, Output> NumOps<Rhs, Output> for T
where T: Sub<Rhs, Output = Output> + Mul<Rhs, Output = Output> + Div<Rhs, Output = Output> + Add<Rhs, Output = Output> + Rem<Rhs, Output = Output>,