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

use derive_more::{Add, AddAssign, Sub, SubAssign};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

use crate::units::{SampleRate, Seconds};

/// Represents samples in the audio domain.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Add, Sub, AddAssign, SubAssign, Ord, PartialOrd)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Samples(u64);

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

    /// Converts to seconds using the given sample rate.
    pub fn to_seconds(&self, sr: SampleRate) -> Seconds {
        Seconds::from(self.as_u64() as f64 / sr.as_u32() as f64)
    }

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

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

macro_rules! impl_int_conversions {
    ($int_type:ty) => {
        impl From<$int_type> for Samples {
            fn from(value: $int_type) -> Self {
                Self(value as _)
            }
        }

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

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

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

#[cfg(test)]
mod tests {
    use crate::units::{SampleRate, Samples, Seconds};
    use test_case::test_case;

    #[test_case(Samples::from(1000), SampleRate::from(10) => Seconds::from(100.0); "case 1")]
    fn samples_to_seconds(samples: Samples, sample_rate: SampleRate) -> Seconds {
        samples.to_seconds(sample_rate)
    }
}