zk-audio 0.1.0

Audio processing library for voice recording and enhancement
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

use crate::contracts::{AudioProcessor, ProcessorBuildRequest, ProcessorFactory};
use crate::core::AudioResult;
use crate::profiles::build_processors;

pub struct ProfileProcessorFactory;

impl ProfileProcessorFactory {
    pub fn new() -> Self {
        Self
    }
}

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

impl ProcessorFactory for ProfileProcessorFactory {
    fn build_processors(
        &self,
        request: ProcessorBuildRequest,
    ) -> AudioResult<Vec<Box<dyn AudioProcessor>>> {
        build_processors(
            request.profile,
            request.gain_db,
            request.limiter_threshold,
            request.high_pass_hz,
            request.noise_suppression_amount,
            request.noise_calibration_ms,
            request.delay_effect,
            &request.stage_overrides,
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::core::{AudioProfile, DelayEffectConfig, DelayEffectPreset};
    use std::collections::BTreeMap;

    #[test]
    fn factory_builds_expected_hvac_chain() {
        let factory = ProfileProcessorFactory::new();
        let processors = factory
            .build_processors(ProcessorBuildRequest {
                profile: AudioProfile::VoiceHvac,
                gain_db: 2.0,
                limiter_threshold: 0.92,
                high_pass_hz: 100.0,
                noise_suppression_amount: 0.5,
                noise_calibration_ms: 350,
                delay_effect: None,
                stage_overrides: BTreeMap::new(),
            })
            .unwrap();

        let names = processors.iter().map(|p| p.name()).collect::<Vec<_>>();
        assert_eq!(
            names,
            vec![
                "high_pass",
                "low_shelf_cut",
                "low_pass",
                "expander",
                "noise_suppression",
                "adaptive_gain",
                "compressor",
                "agc",
                "adaptive_tone_shaper",
                "mid_resonance_suppressor",
                "high_band_cleanup",
                "presence_boost",
                "deesser",
                "tail_suppression",
                "air_band_reducer",
                "voice_finisher",
                "limiter"
            ]
        );
    }

    #[test]
    fn factory_builds_raw_profile_without_processors() {
        let factory = ProfileProcessorFactory::new();
        let processors = factory
            .build_processors(ProcessorBuildRequest {
                profile: AudioProfile::Raw,
                gain_db: 0.0,
                limiter_threshold: 0.92,
                high_pass_hz: 0.0,
                noise_suppression_amount: 0.0,
                noise_calibration_ms: 0,
                delay_effect: None,
                stage_overrides: BTreeMap::new(),
            })
            .unwrap();

        assert!(processors.is_empty());
    }

    #[test]
    fn factory_builds_delay_stage_before_limiter_when_enabled() {
        let factory = ProfileProcessorFactory::new();
        let processors = factory
            .build_processors(ProcessorBuildRequest {
                profile: AudioProfile::VoiceClean,
                gain_db: 2.0,
                limiter_threshold: 0.92,
                high_pass_hz: 100.0,
                noise_suppression_amount: 0.5,
                noise_calibration_ms: 350,
                delay_effect: Some(DelayEffectConfig {
                    preset: DelayEffectPreset::Slapback,
                }),
                stage_overrides: BTreeMap::new(),
            })
            .unwrap();

        let names = processors.iter().map(|p| p.name()).collect::<Vec<_>>();
        assert_eq!(names[names.len() - 3], "doubling_delay");
        assert_eq!(names[names.len() - 2], "voice_finisher");
        assert_eq!(names[names.len() - 1], "limiter");
    }
}