rodio 0.22.2

Audio playback and recording library
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
104
105
106
107
108
109
110

use std::time::Duration;

use super::SeekError;
use crate::common::{ChannelCount, SampleRate};
use crate::{Float, Source};

/// Internal function that builds a `Distortion` object.
pub(crate) fn distortion<I>(input: I, gain: Float, threshold: Float) -> Distortion<I>
where
    I: Source,
{
    Distortion {
        input,
        gain,
        threshold,
    }
}

/// Filter that applies a distortion effect to the source.
#[derive(Clone, Debug)]
pub struct Distortion<I> {
    input: I,
    gain: Float,
    threshold: Float,
}

impl<I> Distortion<I> {
    /// Modifies the distortion gain.
    #[inline]
    pub fn set_gain(&mut self, gain: Float) {
        self.gain = gain;
    }

    /// Modifies the distortion threshold.
    #[inline]
    pub fn set_threshold(&mut self, threshold: Float) {
        self.threshold = threshold;
    }

    /// Returns a reference to the inner source.
    #[inline]
    pub fn inner(&self) -> &I {
        &self.input
    }

    /// Returns a mutable reference to the inner source.
    #[inline]
    pub fn inner_mut(&mut self) -> &mut I {
        &mut self.input
    }

    /// Returns the inner source.
    #[inline]
    pub fn into_inner(self) -> I {
        self.input
    }
}

impl<I> Iterator for Distortion<I>
where
    I: Source,
{
    type Item = I::Item;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        self.input.next().map(|value| {
            let v = value * self.gain;
            let t = self.threshold;
            v.clamp(-t, t)
        })
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.input.size_hint()
    }
}

impl<I> ExactSizeIterator for Distortion<I> where I: Source + ExactSizeIterator {}

impl<I> Source for Distortion<I>
where
    I: Source,
{
    #[inline]
    fn current_span_len(&self) -> Option<usize> {
        self.input.current_span_len()
    }

    #[inline]
    fn channels(&self) -> ChannelCount {
        self.input.channels()
    }

    #[inline]
    fn sample_rate(&self) -> SampleRate {
        self.input.sample_rate()
    }

    #[inline]
    fn total_duration(&self) -> Option<Duration> {
        self.input.total_duration()
    }

    #[inline]
    fn try_seek(&mut self, pos: Duration) -> Result<(), SeekError> {
        self.input.try_seek(pos)
    }
}