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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
//! Utilities for testing.

use crate::buffer::{AudioBufferInOut, AudioChunk};
use crate::event::{ContextualEventHandler, EventHandler};
use crate::{AudioHandler, AudioHandlerMeta, ContextualAudioRenderer};
use std::fmt::Debug;

pub struct DummyEventHandler;

impl<E> EventHandler<E> for DummyEventHandler {
    fn handle_event(&mut self, _event: E) {}
}

impl<E, C> ContextualEventHandler<E, C> for DummyEventHandler {
    fn handle_event(&mut self, _event: E, _context: &mut C) {}
}

/// A plugin useful for writing automated tests.
// TODO: Add more documentation.
pub struct TestPlugin<S, E, M> {
    expected_inputs: Vec<AudioChunk<S>>,
    provided_outputs: Vec<AudioChunk<S>>,
    expected_events: Vec<Vec<E>>,
    provided_events: Vec<Vec<E>>,
    meta: M,
    buffer_index: usize,
    event_index: usize,
}

impl<S, E, M> TestPlugin<S, E, M> {
    pub fn new(
        expected_inputs: Vec<AudioChunk<S>>,
        provided_outputs: Vec<AudioChunk<S>>,
        expected_events: Vec<Vec<E>>,
        provided_events: Vec<Vec<E>>,
        meta: M,
    ) -> Self {
        assert_eq!(expected_inputs.len(), provided_outputs.len(), "When constructing a test plugin, `expected_inputs` and `provided_outputs should have the same length.");
        assert!(expected_inputs.len() <= expected_events.len(), "When constructing a test plugin, `expected_inputs` and `provided_outputs` should be smaller in length than `expected_events`.");
        assert!(expected_inputs.len() + 1 >= expected_events.len(), "When constructing a test plugin, `expected_events` can have only one element more than `expected_inputs` and `provided_outputs`.");
        assert_eq!(expected_inputs.len(), provided_events.len(), "When constructing a test plugin, `expected_inputs`, `provided_outputs` and `provided_events` should all have the same length.");
        TestPlugin {
            expected_inputs,
            provided_outputs,
            expected_events,
            provided_events,
            meta,
            buffer_index: 0,
            event_index: 0,
        }
    }

    pub fn check_last(&self) {
        assert_eq!(self.buffer_index, self.expected_inputs.len());
    }
}

impl<S, E, M> AudioHandlerMeta for TestPlugin<S, E, M>
where
    M: AudioHandlerMeta,
{
    fn max_number_of_audio_inputs(&self) -> usize {
        self.meta.max_number_of_audio_inputs()
    }
    fn max_number_of_audio_outputs(&self) -> usize {
        self.meta.max_number_of_audio_outputs()
    }
}

impl<S, E, M> AudioHandler for TestPlugin<S, E, M>
where
    M: AudioHandler,
{
    fn set_sample_rate(&mut self, sample_rate: f64) {
        self.meta.set_sample_rate(sample_rate);
    }
}

impl<S, E, M, C> ContextualAudioRenderer<S, C> for TestPlugin<S, E, M>
where
    S: PartialEq + Debug + Copy,
    C: EventHandler<E>,
{
    fn render_buffer(&mut self, buffer: &mut AudioBufferInOut<S>, context: &mut C) {
        assert!(
            self.buffer_index < self.expected_inputs.len(),
            "`render_buffer` called more often than expected: expected only {} times",
            self.expected_inputs.len()
        );

        assert_eq!(
            self.event_index,
            self.expected_events[self.buffer_index].len(),
            "`handle_event` called {} times for buffer {} (zero-based), but {} times was expected",
            self.event_index,
            self.buffer_index,
            self.expected_events[self.buffer_index].len()
        );
        self.event_index = 0;

        let expected_input_channels = &self.expected_inputs[self.buffer_index].channels();
        assert_eq!(
            buffer.number_of_input_channels(),
            expected_input_channels.len(),
            "`render_buffer` called with {} input channels, but {} were expected",
            buffer.number_of_input_channels(),
            expected_input_channels.len()
        );
        for (input_channel_index, input_channel) in buffer.inputs().channels().iter().enumerate() {
            let expected_input_channel = &expected_input_channels[input_channel_index];
            assert_eq!(
                input_channel.len(),
                expected_input_channel.len(),
                "mismatch in input channel #{} in buffer #{}: \
                 expected input channel with length {}, but got one with length {}",
                input_channel_index,
                self.buffer_index,
                input_channel.len(),
                expected_input_channel.len()
            );
            for (sample_index, sample) in input_channel.iter().enumerate() {
                assert_eq!(
                    *sample,
                    expected_input_channel[sample_index],
                    "mismatch in input sample with index #{} in channel #{} in buffer #{}: \
                     expected {:?} but got {:?}",
                    sample_index,
                    input_channel_index,
                    self.buffer_index,
                    expected_input_channel[sample_index],
                    sample
                );
            }
        }

        let expected_output_channels = self.provided_outputs[self.buffer_index].channels();
        assert_eq!(
            buffer.number_of_output_channels(),
            expected_output_channels.len()
        );
        // TODO: Use an iterator here.
        for output_channel_index in 0..expected_output_channels.len() {
            let expected_output_channel = &expected_output_channels[output_channel_index];
            assert_eq!(
                buffer.number_of_frames(),
                expected_output_channel.len(),
                "mismatch in output channel #{} in buffer #{}: \
                 expected one with length {}, but got one with length {}",
                output_channel_index,
                self.buffer_index,
                expected_output_channel.len(),
                buffer.number_of_frames()
            );
            buffer
                .outputs()
                .index_channel(output_channel_index)
                .copy_from_slice(expected_output_channel);
        }

        let events = self.provided_events.drain(..1).next().unwrap();
        for event in events {
            context.handle_event(event);
        }

        self.buffer_index += 1;
        self.event_index = 0;
    }
}

impl<S, E, M> EventHandler<E> for TestPlugin<S, E, M>
where
    E: PartialEq + Debug,
{
    fn handle_event(&mut self, event: E) {
        assert!(
            self.buffer_index < self.expected_events.len(),
            "`handle_event` is called after {} calls to `render_buffer`; this is unexpected",
            self.expected_events.len()
        );
        let expected_events_for_this_buffer = &self.expected_events[self.buffer_index];
        assert!(
            self.event_index < expected_events_for_this_buffer.len(),
            "`handle_events` is called more than {0} times after {1} calls to `render_buffer`; \
             only {0} times are expected because we expect only \
             {0} events for the subsequent buffer",
            expected_events_for_this_buffer.len(),
            self.buffer_index
        );
        assert_eq!(
            event,
            expected_events_for_this_buffer[self.event_index],
            "mismatch for event #{} after {} calls to `render_buffer`: \
             expected {:?} but got {:?}.",
            self.event_index,
            self.buffer_index,
            expected_events_for_this_buffer[self.event_index],
            event
        );
        self.event_index += 1;
    }
}