rabu 0.3.1

Rust Audio Basic Utilies
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

use crate::units::{Duration, Frequency, Seconds};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// Represents a sample rate (in Hz.).
#[derive(Copy, Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct SampleRate(Frequency);

impl SampleRate {
    /// Gives the sample rate as a `Frequency`.
    pub fn as_frequency(&self) -> Frequency {
        self.0
    }

    /// Gives back the raw value as a `u32`.
    pub fn as_u32(&self) -> u32 {
        self.as_f64() as _
    }

    /// Gives back the raw value as a `usize`.
    pub fn as_usize(&self) -> usize {
        self.as_f64() as usize
    }

    /// Gives back the raw value as a `f64`.
    pub fn as_f64(&self) -> f64 {
        self.0.as_f64()
    }

    /// Gives back the raw value as a `u64`.
    pub fn as_u64(&self) -> u64 {
        self.as_f64() as u64
    }

    /// Gets the duration between two consecutive samples:
    /// Gets the time in seconds between tho consecutive samples:
    /// ```
    /// use rabu::units::{Duration, SampleRate};
    ///
    /// let sample_rate = SampleRate::from(20);
    /// let period = sample_rate.time_between_samples();
    ///
    /// assert_eq!(period, Duration::from_secs_f64(0.05));
    /// ```
    pub fn time_between_samples(&self) -> Duration {
        Duration::from_secs_f64(1.0 / self.as_f64())
    }

    /// Gets the time in seconds between tho consecutive samples:
    /// ```
    /// use rabu::units::{SampleRate, Seconds};
    ///
    /// let sample_rate = SampleRate::from(10);
    /// let period_secs = sample_rate.secs_between_samples();
    ///
    /// assert_eq!(period_secs, Seconds::from(0.1));
    /// ```
    pub fn secs_between_samples(&self) -> Seconds {
        Seconds::from(1.0 / self.as_f64())
    }
}

macro_rules! impl_from_int_type {
    ($int_type: ty) => {
        impl From<$int_type> for SampleRate {
            fn from(value: $int_type) -> Self {
                Self(Frequency::from(value))
            }
        }
    };
}

impl_from_int_type!(u64);
impl_from_int_type!(u32);
impl_from_int_type!(u16);
impl_from_int_type!(u8);
impl_from_int_type!(usize);

impl_from_int_type!(i64);
impl_from_int_type!(i32);
impl_from_int_type!(i16);
impl_from_int_type!(i8);
impl_from_int_type!(isize);

macro_rules! impl_float_conversions {
    ($int_type: ty) => {
        impl From<$int_type> for SampleRate {
            fn from(value: $int_type) -> Self {
                Self(Frequency::from(value))
            }
        }

        impl From<SampleRate> for $int_type {
            fn from(value: SampleRate) -> Self {
                value.as_f64() as _
            }
        }
    };
}

impl_float_conversions!(f64);
impl_float_conversions!(f32);