bbx_dsp 0.4.3

Block-based audio DSP graph system with oscillators, effects, modulators, and realtime-safe processing
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

//! Voltage Controlled Amplifier (VCA) block.
//!
//! Multiplies an audio signal by a control signal, typically from an envelope.

use crate::{block::Block, context::DspContext, parameter::ModulationOutput, sample::Sample};

/// A voltage controlled amplifier that multiplies audio by a control signal.
///
/// The VCA takes two inputs:
/// - Input 0: Audio signal
/// - Input 1: Control signal (typically 0.0 to 1.0 from an envelope)
///
/// The output is the sample-by-sample product of both inputs.
pub struct VcaBlock<S: Sample> {
    _phantom: std::marker::PhantomData<S>,
}

impl<S: Sample> VcaBlock<S> {
    /// Create a new VCA block.
    pub fn new() -> Self {
        Self {
            _phantom: std::marker::PhantomData,
        }
    }
}

impl<S: Sample> Default for VcaBlock<S> {
    fn default() -> Self {
        Self::new()
    }
}

impl<S: Sample> Block<S> for VcaBlock<S> {
    #[inline]
    fn process(&mut self, inputs: &[&[S]], outputs: &mut [&mut [S]], _modulation_values: &[S], _context: &DspContext) {
        let output = match outputs.first_mut() {
            Some(out) => out,
            None => return,
        };

        let audio_input = inputs.first().copied().unwrap_or(&[]);
        let control_input = inputs.get(1).copied().unwrap_or(&[]);

        for (i, out_sample) in output.iter_mut().enumerate() {
            let audio = audio_input.get(i).copied().unwrap_or(S::ZERO);
            let control = control_input.get(i).copied().unwrap_or(S::ONE);
            *out_sample = audio * control;
        }
    }

    #[inline]
    fn input_count(&self) -> usize {
        2
    }

    #[inline]
    fn output_count(&self) -> usize {
        1
    }

    #[inline]
    fn modulation_outputs(&self) -> &[ModulationOutput] {
        &[]
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{channel::ChannelLayout, context::DspContext};

    fn test_context(buffer_size: usize) -> DspContext {
        DspContext {
            sample_rate: 44100.0,
            num_channels: 1,
            buffer_size,
            current_sample: 0,
            channel_layout: ChannelLayout::default(),
        }
    }

    #[test]
    fn test_vca_multiplication() {
        let mut vca = VcaBlock::<f32>::new();
        let context = test_context(4);

        let audio = [1.0f32, 0.5, -0.5, -1.0];
        let control = [1.0f32, 0.5, 0.5, 0.0];
        let mut output = [0.0f32; 4];

        let inputs: [&[f32]; 2] = [&audio, &control];
        let mut outputs: [&mut [f32]; 1] = [&mut output];

        vca.process(&inputs, &mut outputs, &[], &context);

        assert!((output[0] - 1.0).abs() < 1e-6);
        assert!((output[1] - 0.25).abs() < 1e-6);
        assert!((output[2] - -0.25).abs() < 1e-6);
        assert!((output[3] - 0.0).abs() < 1e-6);
    }

    #[test]
    fn test_vca_missing_control_defaults_to_unity() {
        let mut vca = VcaBlock::<f32>::new();
        let context = test_context(4);

        let audio = [0.5f32, 0.5, 0.5, 0.5];
        let mut output = [0.0f32; 4];

        let inputs: [&[f32]; 1] = [&audio];
        let mut outputs: [&mut [f32]; 1] = [&mut output];

        vca.process(&inputs, &mut outputs, &[], &context);

        for sample in output.iter() {
            assert!((sample - 0.5).abs() < 1e-6);
        }
    }

    #[test]
    fn test_vca_input_output_counts_f32() {
        let vca = VcaBlock::<f32>::new();
        assert_eq!(vca.input_count(), 2);
        assert_eq!(vca.output_count(), 1);
    }

    #[test]
    fn test_vca_input_output_counts_f64() {
        let vca = VcaBlock::<f64>::new();
        assert_eq!(vca.input_count(), 2);
        assert_eq!(vca.output_count(), 1);
    }

    #[test]
    fn test_vca_multiplication_f64() {
        let mut vca = VcaBlock::<f64>::new();
        let context = test_context(4);

        let audio = [1.0f64, 0.5, -0.5, -1.0];
        let control = [1.0f64, 0.5, 0.5, 0.0];
        let mut output = [0.0f64; 4];

        let inputs: [&[f64]; 2] = [&audio, &control];
        let mut outputs: [&mut [f64]; 1] = [&mut output];

        vca.process(&inputs, &mut outputs, &[], &context);

        assert!((output[0] - 1.0).abs() < 1e-12);
        assert!((output[1] - 0.25).abs() < 1e-12);
        assert!((output[2] - -0.25).abs() < 1e-12);
        assert!((output[3] - 0.0).abs() < 1e-12);
    }

    #[test]
    fn test_vca_default() {
        let vca = VcaBlock::<f32>::default();
        assert_eq!(vca.input_count(), 2);
        assert_eq!(vca.output_count(), 1);
    }

    #[test]
    fn test_vca_modulation_outputs_empty() {
        let vca = VcaBlock::<f32>::new();
        assert!(vca.modulation_outputs().is_empty());
    }
}