sonora 0.1.0

WebRTC Audio Processing — pure Rust port with echo cancellation, noise suppression, and AGC
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

//! Sliding window maximum with exponential decay.
//!
//! Ported from `modules/audio_processing/echo_detector/moving_max.h/cc`.

/// Decay factor: max decays to 1% after 460 updates past window end.
const DECAY_FACTOR: f32 = 0.99;

/// Tracks the maximum value within a sliding window.
#[derive(Debug)]
pub(crate) struct MovingMax {
    max_value: f32,
    counter: usize,
    window_size: usize,
}

impl MovingMax {
    pub(crate) fn new(window_size: usize) -> Self {
        debug_assert!(window_size > 0);
        Self {
            max_value: 0.0,
            counter: 0,
            window_size,
        }
    }

    pub(crate) fn update(&mut self, value: f32) {
        if self.counter >= self.window_size - 1 {
            self.max_value *= DECAY_FACTOR;
        } else {
            self.counter += 1;
        }
        if value > self.max_value {
            self.max_value = value;
            self.counter = 0;
        }
    }

    pub(crate) fn max(&self) -> f32 {
        self.max_value
    }

    pub(crate) fn clear(&mut self) {
        self.max_value = 0.0;
        self.counter = 0;
    }
}

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

    #[test]
    fn simple() {
        let mut mm = MovingMax::new(5);
        mm.update(1.0);
        mm.update(1.1);
        mm.update(1.9);
        mm.update(1.87);
        mm.update(1.89);
        assert_eq!(mm.max(), 1.9);
    }

    #[test]
    fn sliding_window() {
        let mut mm = MovingMax::new(5);
        mm.update(1.0);
        mm.update(1.9);
        mm.update(1.7);
        mm.update(1.87);
        mm.update(1.89);
        mm.update(1.3);
        mm.update(1.2);
        assert!(mm.max() < 1.9);
    }

    #[test]
    fn clear_test() {
        let mut mm = MovingMax::new(5);
        mm.update(1.0);
        mm.update(1.1);
        mm.update(1.9);
        mm.update(1.87);
        mm.update(1.89);
        assert_eq!(mm.max(), 1.9);
        mm.clear();
        assert_eq!(mm.max(), 0.0);
    }

    #[test]
    fn decay() {
        let mut mm = MovingMax::new(1);
        mm.update(1.0);
        let mut previous_value = 1.0;
        for _ in 0..500 {
            mm.update(0.0);
            assert!(mm.max() < previous_value);
            assert!(mm.max() > 0.0);
            previous_value = mm.max();
        }
        assert!(mm.max() < 0.01);
    }
}