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

// Augmented Audio: Audio libraries and applications
// Copyright (c) 2022 Pedro Tacla Yamada
//
// The MIT License (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
use audio_processor_traits::{Float, SimpleAudioProcessor};
use std::marker::PhantomData;
use std::ops::AddAssign;

/// An `AudioProcessor` which will sum all input channels into input 0.
///
/// If there are no channels it'll no-op. It'll not mute the remaining channels.
pub struct StereoToMonoProcessor<SampleType> {
    phantom: PhantomData<SampleType>,
}

impl<SampleType> Default for StereoToMonoProcessor<SampleType> {
    fn default() -> Self {
        Self::new()
    }
}

impl<SampleType> StereoToMonoProcessor<SampleType> {
    pub fn new() -> Self {
        StereoToMonoProcessor {
            phantom: PhantomData::default(),
        }
    }
}

impl<SampleType> SimpleAudioProcessor for StereoToMonoProcessor<SampleType>
where
    SampleType: Float + Sync + Send + AddAssign,
{
    type SampleType = SampleType;

    fn s_process_frame(&mut self, frame: &mut [Self::SampleType]) {
        if frame.is_empty() {
            return;
        }

        let mut sum: SampleType = SampleType::zero();

        for sample in frame.iter_mut() {
            sum += *sample;
            *sample = SampleType::zero();
        }

        frame[0] = sum;
    }
}

#[cfg(test)]
mod test {
    use audio_processor_testing_helpers::assert_f_eq;
    use audio_processor_traits::{simple_processor, AudioBuffer, InterleavedAudioBuffer};

    use super::*;

    #[test]
    fn test_stereo_to_mono_processor_sums_channels() {
        let mut mono = StereoToMonoProcessor::new();
        let mut samples = [1., 0.1, 1., 0.1, 1., 0.1, 1., 0.1, 1., 0.1, 1., 0.1];
        let mut input = InterleavedAudioBuffer::new(2, &mut samples);

        simple_processor::process_buffer(&mut mono, &mut input);

        for sample_index in 0..input.num_samples() {
            let sample = *input.get(0, sample_index);
            assert_f_eq!(sample, 1.1);
        }
    }

    #[test]
    fn test_stereo_to_mono_can_handle_mono_input() {
        let mut mono = StereoToMonoProcessor::new();
        let mut samples = [1., 1., 1., 1., 1., 1.];
        let mut input = InterleavedAudioBuffer::new(1, &mut samples);

        simple_processor::process_buffer(&mut mono, &mut input);

        for sample_index in 0..input.num_samples() {
            let sample = *input.get(0, sample_index);
            assert_f_eq!(sample, 1.0);
        }
    }

    #[test]
    fn test_stereo_to_mono_can_handle_empty_input() {
        let mut mono = StereoToMonoProcessor::new();
        let mut samples: [f32; 0] = [];
        let mut input = InterleavedAudioBuffer::new(1, &mut samples);

        simple_processor::process_buffer(&mut mono, &mut input);
    }
}