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
127
128
129
130
131
132
133
134
135
136

use crate::core::AudioResult;
use crate::mic_sim::contracts::MicrophoneSimProcessor;
use crate::mic_sim::core::MicrophoneSimConfig;
use crate::mic_sim::processors::{SaturationProcessor, VoicingContourProcessor};
use crate::mic_sim::voicing::voicing_for;

pub struct MicrophoneSimulatorFactory;

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

    pub fn build_processors(
        &self,
        config: MicrophoneSimConfig,
    ) -> AudioResult<Vec<Box<dyn MicrophoneSimProcessor>>> {
        let Some(model) = config.active_model() else {
            return Ok(Vec::new());
        };
        let Some(voicing) = voicing_for(model) else {
            return Ok(Vec::new());
        };

        Ok(vec![
            Box::new(VoicingContourProcessor::new(voicing)),
            Box::new(SaturationProcessor::new(voicing.saturation_amount)),
        ])
    }
}

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

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

    #[test]
    fn factory_returns_empty_chain_when_disabled() {
        let factory = MicrophoneSimulatorFactory::new();
        let processors = factory
            .build_processors(MicrophoneSimConfig::default())
            .unwrap();
        assert!(processors.is_empty());
    }

    #[test]
    fn factory_builds_u87_chain() {
        let factory = MicrophoneSimulatorFactory::new();
        let processors = factory
            .build_processors(MicrophoneSimConfig {
                enabled: true,
                model: MicrophoneSimModel::U87,
            })
            .unwrap();

        let names = processors
            .iter()
            .map(|processor| processor.name())
            .collect::<Vec<_>>();
        assert_eq!(names, vec!["voicing_contour", "saturation"]);
    }

    #[test]
    fn factory_builds_c414_xlii_chain() {
        let factory = MicrophoneSimulatorFactory::new();
        let processors = factory
            .build_processors(MicrophoneSimConfig {
                enabled: true,
                model: MicrophoneSimModel::C414Xlii,
            })
            .unwrap();

        let names = processors
            .iter()
            .map(|processor| processor.name())
            .collect::<Vec<_>>();
        assert_eq!(names, vec!["voicing_contour", "saturation"]);
    }

    #[test]
    fn factory_builds_tlm103_chain() {
        let factory = MicrophoneSimulatorFactory::new();
        let processors = factory
            .build_processors(MicrophoneSimConfig {
                enabled: true,
                model: MicrophoneSimModel::Tlm103,
            })
            .unwrap();

        let names = processors
            .iter()
            .map(|processor| processor.name())
            .collect::<Vec<_>>();
        assert_eq!(names, vec!["voicing_contour", "saturation"]);
    }

    #[test]
    fn factory_builds_sm7b_chain() {
        let factory = MicrophoneSimulatorFactory::new();
        let processors = factory
            .build_processors(MicrophoneSimConfig {
                enabled: true,
                model: MicrophoneSimModel::SM7B,
            })
            .unwrap();

        let names = processors
            .iter()
            .map(|processor| processor.name())
            .collect::<Vec<_>>();
        assert_eq!(names, vec!["voicing_contour", "saturation"]);
    }

    #[test]
    fn factory_builds_rca44_chain() {
        let factory = MicrophoneSimulatorFactory::new();
        let processors = factory
            .build_processors(MicrophoneSimConfig {
                enabled: true,
                model: MicrophoneSimModel::Rca44,
            })
            .unwrap();

        let names = processors
            .iter()
            .map(|processor| processor.name())
            .collect::<Vec<_>>();
        assert_eq!(names, vec!["voicing_contour", "saturation"]);
    }
}