culsynth 0.2.0

Culsynth DSP 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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

use super::*;

/// An iterator builder for [RingModInput]
///
/// Use this to easily build iterators to [RingModInput] out of iterators to
/// its constituent parts.
pub struct RingModInputIter<T, A, B>
where
    T: DspFormatBase,
    A: Iterator<Item = T::Sample>,
    B: Iterator<Item = T::Sample>,
{
    signal_a: A,
    signal_b: B,
    phantom: core::marker::PhantomData<T>,
}

impl<T, A, B> RingModInputIter<T, A, B>
where
    T: DspFormatBase,
    A: Iterator<Item = T::Sample>,
    B: Iterator<Item = T::Sample>,
{
    /// Replace the current carrier source with the one provided
    pub fn with_signal_a<New: Iterator<Item = T::Sample>>(
        self,
        new: New,
    ) -> RingModInputIter<T, New, B> {
        RingModInputIter {
            signal_a: new,
            signal_b: self.signal_b,
            phantom: self.phantom,
        }
    }
    /// Replace the current modulator source with the
    /// one provided
    pub fn with_signal_b<New: Iterator<Item = T::Sample>>(
        self,
        new: New,
    ) -> RingModInputIter<T, A, New> {
        RingModInputIter {
            signal_a: self.signal_a,
            signal_b: new,
            phantom: self.phantom,
        }
    }
}

impl<T, A, B> Iterator for RingModInputIter<T, A, B>
where
    T: DspFormatBase,
    A: Iterator<Item = T::Sample>,
    B: Iterator<Item = T::Sample>,
{
    type Item = RingModInput<T>;
    fn next(&mut self) -> Option<RingModInput<T>> {
        Some(RingModInput {
            signal_a: self.signal_a.next()?,
            signal_b: self.signal_b.next()?,
        })
    }
}

/// Create a new [RingModInputIter], which initially creates instances of
/// with zero signals for both the carrier and modulator
/// until calling the `with_*()` methods.
pub fn new_ringmod_input_iter<T: DspFormatBase>(
) -> RingModInputIter<T, Repeat<T::Sample>, Repeat<T::Sample>> {
    RingModInputIter {
        signal_a: repeat(T::Sample::zero()),
        signal_b: repeat(T::Sample::zero()),
        phantom: Default::default(),
    }
}

/// An iterator builder for [RingModParams]
///
/// Use this to easily build iterators to [RingModParams] out of iterators
/// to its constituent parts.
pub struct RingModParamIter<T, A, B, C>
where
    T: DspFormatBase,
    A: Iterator<Item = T::Scalar>,
    B: Iterator<Item = T::Scalar>,
    C: Iterator<Item = T::Scalar>,
{
    mix_a: A,
    mix_b: B,
    mix_mod: C,
    phantom: core::marker::PhantomData<T>,
}

impl<T, A, B, C> RingModParamIter<T, A, B, C>
where
    T: DspFormatBase,
    A: Iterator<Item = T::Scalar>,
    B: Iterator<Item = T::Scalar>,
    C: Iterator<Item = T::Scalar>,
{
    /// Replace the current carrier gain source with the one provided
    pub fn with_mix_a<New: Iterator<Item = T::Scalar>>(
        self,
        new: New,
    ) -> RingModParamIter<T, New, B, C> {
        RingModParamIter {
            mix_a: new,
            mix_b: self.mix_b,
            mix_mod: self.mix_mod,
            phantom: self.phantom,
        }
    }
    /// Replace the current modulator gain source with the one provided
    pub fn with_mix_b<New: Iterator<Item = T::Scalar>>(
        self,
        new: New,
    ) -> RingModParamIter<T, A, New, C> {
        RingModParamIter {
            mix_a: self.mix_a,
            mix_b: new,
            mix_mod: self.mix_mod,
            phantom: self.phantom,
        }
    }
    /// Replace the current output gain source with the one provided
    pub fn with_mix_mod<New: Iterator<Item = T::Scalar>>(
        self,
        new: New,
    ) -> RingModParamIter<T, A, B, New> {
        RingModParamIter {
            mix_a: self.mix_a,
            mix_b: self.mix_b,
            mix_mod: new,
            phantom: self.phantom,
        }
    }
}

impl<T, A, B, C> Iterator for RingModParamIter<T, A, B, C>
where
    T: DspFormatBase,
    A: Iterator<Item = T::Scalar>,
    B: Iterator<Item = T::Scalar>,
    C: Iterator<Item = T::Scalar>,
{
    type Item = RingModParams<T>;
    fn next(&mut self) -> Option<RingModParams<T>> {
        Some(RingModParams {
            mix_a: self.mix_a.next()?,
            mix_b: self.mix_b.next()?,
            mix_mod: self.mix_mod.next()?,
        })
    }
}

/// Create a new [RingModParamIter], which initially creates instances of
/// [RingModParams] with the unity gain for the carrier signal and zero gain
/// for the modulator and output signals
#[allow(clippy::type_complexity)]
pub fn new_ringmod_param_iter<T: DspFormatBase>(
) -> RingModParamIter<T, Repeat<T::Scalar>, Repeat<T::Scalar>, Repeat<T::Scalar>> {
    RingModParamIter {
        mix_a: repeat(T::Scalar::one()),
        mix_b: repeat(T::Scalar::zero()),
        mix_mod: repeat(T::Scalar::zero()),
        phantom: Default::default(),
    }
}