sirena 0.1.0

Digital audio signal processing primitives.
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

use super::Signal;

/// Clip samples yielded by signal.
pub trait SignalClipAmp: Signal {
    /// Clips the amplitude of the signal to the given threshold amplitude.
    ///
    /// # Example
    ///
    /// ```rust
    /// use sirena::signal::{self, Signal, SignalClipAmp};
    /// let frames = [0.5, 2.0, -2.0];
    /// let mut signal = signal::from_iter(frames).clip_amp(1.0);
    /// assert_eq!(signal.next(), 0.5);
    /// assert_eq!(signal.next(), 1.0);
    /// assert_eq!(signal.next(), -1.0);
    /// ```
    fn clip_amp(self, threshold: f32) -> ClipAmp<Self>
    where
        Self: Sized,
    {
        ClipAmp {
            signal: self,
            threshold,
        }
    }
}

impl<T> SignalClipAmp for T where T: Signal {}

/// Clips samples yielded by `signal` to the given threshold amplitude.
#[derive(Clone)]
pub struct ClipAmp<S>
where
    S: Signal,
{
    signal: S,
    threshold: f32,
}

impl<S> Signal for ClipAmp<S>
where
    S: Signal,
{
    #[inline]
    fn next(&mut self) -> f32 {
        self.signal.next().clamp(-self.threshold, self.threshold)
    }
}