culsynth 0.1.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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200

use super::*;
use crate::fixedmath::{apply_scalar_i, widen_i};

/// A basic ring modulator with parameters to mix either of the original signals
/// in with the output.
#[derive(Clone)]
pub struct RingMod<Smp> {
    outbuf: BufferT<Smp>,
}

/// Parameters for a [RingMod]
pub struct RingModParams<'a, Smp> {
    /// The volume of the output modulation signal
    pub mix_out: &'a [Smp],
    /// The volume of the input signal a mixed back in
    pub mix_a: &'a [Smp],
    /// The volume of the input signal b mixed back in
    pub mix_b: &'a [Smp],
}

impl<'a, Smp> RingModParams<'a, Smp> {
    /// The length of the input parameters, defined as the length of the shortest
    /// input slice.
    pub fn len(&self) -> usize {
        min_size(&[self.mix_a.len(), self.mix_b.len(), self.mix_out.len()])
    }
    /// True if any subslice is empty
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }
}

/// Mutable parameters for a [RingMod]
pub struct MutRingModParams<'a, Smp> {
    /// The volume of the output modulation signal
    pub mix_out: &'a mut [Smp],
    /// The volume of the input signal a mixed back in
    pub mix_a: &'a mut [Smp],
    /// The volume of the input signal b mixed back in
    pub mix_b: &'a mut [Smp],
}

impl<'a, Smp> MutRingModParams<'a, Smp> {
    /// The length of the input parameters, defined as the length of the shortest
    /// input slice.
    pub fn len(&self) -> usize {
        min_size(&[self.mix_a.len(), self.mix_b.len(), self.mix_out.len()])
    }
    /// True if any subslice is empty
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }
}

impl<'a, Smp> From<MutRingModParams<'a, Smp>> for RingModParams<'a, Smp> {
    fn from(value: MutRingModParams<'a, Smp>) -> Self {
        RingModParams {
            mix_out: value.mix_out,
            mix_a: value.mix_a,
            mix_b: value.mix_b,
        }
    }
}

impl<Smp: Float> RingMod<Smp> {
    /// Constructor
    pub fn new() -> Self {
        Self {
            outbuf: [Smp::ZERO; STATIC_BUFFER_SIZE],
        }
    }
    /// Run the ring modulator on the provided input signals and mix the result
    /// back in with the input signals according to the provided parameters.
    ///
    /// Note: The output slice from this function may be shorter than the
    /// input slices.  Callers must check the number of returned samples and
    /// copy them into their own output buffers before calling this function
    /// again to process the remainder of the data.
    pub fn process(
        &mut self,
        _ctx: &Context<Smp>,
        a: &[Smp],
        b: &[Smp],
        params: RingModParams<Smp>,
    ) -> &[Smp] {
        let numsamples = min_size(&[params.len(), a.len(), b.len(), STATIC_BUFFER_SIZE]);
        for i in 0..numsamples {
            let out = a[i] * b[i];
            self.outbuf[i] =
                out * params.mix_out[i] + a[i] * params.mix_a[i] + b[i] * params.mix_b[i];
        }
        &self.outbuf[0..numsamples]
    }
}

impl<Smp: Float> Default for RingMod<Smp> {
    fn default() -> Self {
        Self::new()
    }
}

/// Parameters for a [RingModFxP]
pub struct RingModParamsFxP<'a> {
    /// The volume of the output modulation signal
    pub mix_out: &'a [ScalarFxP],
    /// The volume of the input signal a mixed back in
    pub mix_a: &'a [ScalarFxP],
    /// The volume of the input signal b mixed back in
    pub mix_b: &'a [ScalarFxP],
}

impl<'a> RingModParamsFxP<'a> {
    /// The length of the input parameters, defined as the length of the shortest
    /// input slice.
    pub fn len(&self) -> usize {
        min_size(&[self.mix_a.len(), self.mix_b.len(), self.mix_out.len()])
    }
    /// True if any subslice is empty.
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }
}

/// Mutable Parameters for a [RingModFxP]
pub struct MutRingModParamsFxP<'a> {
    /// The volume of the output modulation signal
    pub mix_out: &'a mut [ScalarFxP],
    /// The volume of the input signal a mixed back in
    pub mix_a: &'a mut [ScalarFxP],
    /// The volume of the input signal b mixed back in
    pub mix_b: &'a mut [ScalarFxP],
}

impl<'a> MutRingModParamsFxP<'a> {
    /// The length of the input parameters, defined as the length of the shortest
    /// input slice.
    pub fn len(&self) -> usize {
        min_size(&[self.mix_a.len(), self.mix_b.len(), self.mix_out.len()])
    }
    /// True if any subslice is empty
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }
}

impl<'a> From<MutRingModParamsFxP<'a>> for RingModParamsFxP<'a> {
    fn from(value: MutRingModParamsFxP<'a>) -> Self {
        Self {
            mix_a: value.mix_a,
            mix_b: value.mix_b,
            mix_out: value.mix_out,
        }
    }
}

/// A basic ring modulator with parameters to mix either of the original signals
/// in with the output using fixed-point logic.
#[derive(Clone)]
pub struct RingModFxP {
    outbuf: BufferT<SampleFxP>,
}

impl RingModFxP {
    /// Constructor
    pub fn new() -> Self {
        Self {
            outbuf: [SampleFxP::ZERO; STATIC_BUFFER_SIZE],
        }
    }
    /// Run the ring modulator on the provided input signals and mix the result
    /// back in with the input signals according to the provided parameters.
    ///
    /// Note: The output slice from this function may be shorter than the
    /// input slices.  Callers must check the number of returned samples and
    /// copy them into their own output buffers before calling this function
    /// again to process the remainder of the data.
    pub fn process(
        &mut self,
        _ctx: &ContextFxP,
        a: &[SampleFxP],
        b: &[SampleFxP],
        params: RingModParamsFxP,
    ) -> &[SampleFxP] {
        let numsamples = min_size(&[params.len(), a.len(), b.len(), STATIC_BUFFER_SIZE]);
        for i in 0..numsamples {
            let out = SampleFxP::saturating_from_num(a[i].wide_mul(b[i]));
            let mixed_32bits = widen_i(apply_scalar_i(out, params.mix_out[i]))
                + widen_i(apply_scalar_i(a[i], params.mix_a[i]))
                + widen_i(apply_scalar_i(b[i], params.mix_b[i]));
            self.outbuf[i] = SampleFxP::saturating_from_num(mixed_32bits);
        }
        &self.outbuf[0..numsamples]
    }
}

impl Default for RingModFxP {
    fn default() -> Self {
        Self::new()
    }
}