oximedia-effects 0.1.1

Professional audio effects suite for OxiMedia
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

//! State-variable filter - multi-mode filter.

use crate::AudioEffect;
use std::f32::consts::PI;

/// Filter mode for state-variable filter.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum FilterMode {
    /// Low-pass.
    LowPass,
    /// High-pass.
    HighPass,
    /// Band-pass.
    BandPass,
    /// Notch (band-reject).
    Notch,
}

/// State-variable filter configuration.
#[derive(Debug, Clone)]
pub struct StateVariableConfig {
    /// Cutoff frequency in Hz.
    pub frequency: f32,
    /// Resonance (Q factor, 0.5 - 20.0).
    pub resonance: f32,
    /// Filter mode.
    pub mode: FilterMode,
}

impl Default for StateVariableConfig {
    fn default() -> Self {
        Self {
            frequency: 1000.0,
            resonance: 0.707,
            mode: FilterMode::LowPass,
        }
    }
}

/// State-variable filter.
pub struct StateVariableFilter {
    // Filter states
    low: f32,
    band: f32,
    // Coefficients
    f: f32,
    q: f32,
    config: StateVariableConfig,
    sample_rate: f32,
}

impl StateVariableFilter {
    /// Create new state-variable filter.
    #[must_use]
    pub fn new(config: StateVariableConfig, sample_rate: f32) -> Self {
        let mut filter = Self {
            low: 0.0,
            band: 0.0,
            f: 0.0,
            q: 0.0,
            config,
            sample_rate,
        };
        filter.update_coefficients();
        filter
    }

    fn update_coefficients(&mut self) {
        // Calculate frequency coefficient
        self.f = 2.0 * (PI * self.config.frequency / self.sample_rate).sin();
        // Calculate Q coefficient
        self.q = 1.0 / self.config.resonance;
    }

    /// Set cutoff frequency.
    pub fn set_frequency(&mut self, frequency: f32) {
        self.config.frequency = frequency.clamp(20.0, self.sample_rate * 0.5);
        self.update_coefficients();
    }

    /// Set resonance.
    pub fn set_resonance(&mut self, resonance: f32) {
        self.config.resonance = resonance.clamp(0.5, 20.0);
        self.update_coefficients();
    }

    /// Set filter mode.
    pub fn set_mode(&mut self, mode: FilterMode) {
        self.config.mode = mode;
    }
}

impl AudioEffect for StateVariableFilter {
    fn process_sample(&mut self, input: f32) -> f32 {
        // State-variable filter equations
        self.low += self.f * self.band;
        let high = input - self.low - self.q * self.band;
        self.band += self.f * high;

        // Select output based on mode
        match self.config.mode {
            FilterMode::LowPass => self.low,
            FilterMode::HighPass => high,
            FilterMode::BandPass => self.band,
            FilterMode::Notch => high + self.low,
        }
    }

    fn reset(&mut self) {
        self.low = 0.0;
        self.band = 0.0;
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_svf() {
        let config = StateVariableConfig::default();
        let mut filter = StateVariableFilter::new(config, 48000.0);

        let output = filter.process_sample(1.0);
        assert!(output.is_finite());
    }

    #[test]
    fn test_svf_modes() {
        let modes = [
            FilterMode::LowPass,
            FilterMode::HighPass,
            FilterMode::BandPass,
            FilterMode::Notch,
        ];

        for mode in modes {
            let config = StateVariableConfig {
                mode,
                ..Default::default()
            };
            let mut filter = StateVariableFilter::new(config, 48000.0);

            for _ in 0..100 {
                let output = filter.process_sample(0.5);
                assert!(output.is_finite());
            }
        }
    }
}