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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
//! In-memory backend, useful for testing.
use super::{AudioReader, AudioWriter};
use crate::buffer::{AudioBufferIn, AudioBufferOut, AudioChunk};
#[cfg(feature = "dasp_sample")]
// Re-exports from the `dasp-sample` crate
pub mod dasp_sample {
    pub use dasp_sample::*;
}
use std::borrow::Borrow;
use std::marker::PhantomData;

/// An [`AudioReader`] that reads from a given [`AudioChunk`].
/// The generic parameter type `S` represents the sample type.
///
#[cfg_attr(
    feature = "backend-combined-wav-0-6",
    doc = "\
# Example

The following example illustrates how an [`AudioChunk`] can be generated from a wav file.

_Remark_ the example assumes the `rsynth` crate is compiled with the `backend-combined-wav-0-6` feature.

_Remark_ the example does not use proper error handling.
```
use std::fs::File;
use std::path::Path;
use rsynth::backend::combined::memory::{AudioChunkReader, wav_0_6::read};

fn create_reader_from_file(filename: &str) {
    let mut file = File::open(Path::new(filename)).unwrap();
    let (header, samples) = read(&mut file).unwrap();
    let reader = AudioChunkReader::<f32, _>::from((header, samples));
}
```
"
)]
///
/// [`AudioReader`]: ../trait.AudioReader.html
/// [`AudioChunk`]: ../../../buffer/struct.AudioChunk.html
pub struct AudioChunkReader<S, T>
where
    T: Borrow<AudioChunk<S>>,
    S: Copy,
{
    frames_per_second: u64,
    frame: usize,
    chunk: T,
    phantom: PhantomData<S>,
}

impl<S, T> AudioChunkReader<S, T>
where
    T: Borrow<AudioChunk<S>>,
    S: Copy,
{
    /// Construct a new `AudioChunkReader` with the given [`AudioChunk`] and
    /// sample rate in frames per second.
    ///
    /// [`AudioChunk`]: ../../../buffer/struct.AudioChunk.html
    pub fn new(buffer: T, frames_per_second: u64) -> Self {
        Self {
            chunk: buffer,
            frames_per_second,
            frame: 0,
            phantom: PhantomData::<S>,
        }
    }
}

impl<S, T> AudioReader<S> for AudioChunkReader<S, T>
where
    T: Borrow<AudioChunk<S>>,
    S: Copy,
{
    type Err = std::convert::Infallible;
    fn number_of_channels(&self) -> usize {
        self.chunk.borrow().channels().len()
    }
    fn frames_per_second(&self) -> u64 {
        self.frames_per_second
    }

    fn fill_buffer(&mut self, output: &mut AudioBufferOut<S>) -> Result<usize, Self::Err> {
        assert_eq!(output.number_of_channels(), self.number_of_channels());
        // Note: `self.number_of_channels() > 0`
        let buffer_size = output.number_of_frames();
        let remainder = self.chunk.borrow().channels()[0].len() - self.frame;
        let frames_to_copy = std::cmp::min(buffer_size, remainder);

        for (output_channel, input_channel) in output
            .channel_iter_mut()
            .zip(self.chunk.borrow().channels().iter())
        {
            assert_eq!(buffer_size, output_channel.len());
            output_channel[0..frames_to_copy]
                .copy_from_slice(&input_channel[self.frame..self.frame + frames_to_copy]);
        }
        self.frame += frames_to_copy;
        Ok(frames_to_copy)
    }
}

/// An [`AudioReader`] that reads from a given [`AudioChunk`].
/// The generic parameter type `S` represents the sample type.
///
/// [`AudioReader`]: ../trait.AudioReader.html
/// [`AudioChunk`]: ../../../buffer/struct.AudioChunk.html
pub type AudioBufferReader<'b, S> = AudioChunkReader<S, &'b AudioChunk<S>>;

#[cfg(test)]
mod AudioBufferReaderTests {
    mod fill_buffer {
        use super::super::super::AudioReader;
        use super::super::AudioBufferReader;
        use crate::buffer::{AudioBufferOut, AudioChunk};

        #[test]
        fn works_as_expected() {
            let audio_buffer =
                audio_chunk![[1, 2, 3, 4, 5], [6, 7, 8, 9, 10], [11, 12, 13, 14, 15]];
            let mut reader = AudioBufferReader::new(&audio_buffer, 16);
            let mut output_buffer = AudioChunk::zero(3, 2);
            let mut slices = output_buffer.as_mut_slices();
            {
                let mut buffers = AudioBufferOut::new(&mut slices, 2);
                assert_eq!(Ok(2), reader.fill_buffer(&mut buffers));
            }
            assert_eq!(slices[0], vec![1, 2].as_slice());
            assert_eq!(slices[1], vec![6, 7].as_slice());
            assert_eq!(slices[2], vec![11, 12].as_slice());
            {
                let mut buffers = AudioBufferOut::new(&mut slices, 2);
                assert_eq!(Ok(2), reader.fill_buffer(&mut buffers));
            }
            assert_eq!(slices[0], vec![3, 4].as_slice());
            assert_eq!(slices[1], vec![8, 9].as_slice());
            assert_eq!(slices[2], vec![13, 14].as_slice());
            {
                let mut buffers = AudioBufferOut::new(&mut slices, 2);
                assert_eq!(Ok(1), reader.fill_buffer(&mut buffers));
            }
            assert_eq!(slices[0], vec![5, 4].as_slice());
            assert_eq!(slices[1], vec![10, 9].as_slice());
            assert_eq!(slices[2], vec![15, 14].as_slice());
        }
    }
}

#[cfg(feature = "backend-combined-wav-0-6")]
pub mod wav_0_6 {
    /// Re-exports from we `wav` crate (version range 0.6.x).
    pub use wav_0_6::*;

    use super::dasp_sample::{FromSample, I24};
    use super::{AudioChunk, AudioChunkReader};
    use std::marker::PhantomData;

    impl<S> From<(Header, BitDepth)> for AudioChunkReader<S, AudioChunk<S>>
    where
        S: Copy + FromSample<u8> + FromSample<i16> + FromSample<I24> + FromSample<f32>,
    {
        fn from((header, samples): (Header, BitDepth)) -> Self {
            let chunk = match samples {
                BitDepth::Eight(s) => AudioChunk::from_interlaced_iterator(
                    s.iter().map(|a| S::from_sample_(*a)),
                    header.channel_count as usize,
                ),
                BitDepth::Sixteen(s) => AudioChunk::from_interlaced_iterator(
                    s.iter().map(|a| S::from_sample_(*a)),
                    header.channel_count as usize,
                ),
                BitDepth::TwentyFour(s) => AudioChunk::from_interlaced_iterator(
                    s.iter().map(|a| {
                        S::from_sample_(I24::new(*a).expect("24 bits sample should be 24 bits"))
                    }),
                    header.channel_count as usize,
                ),
                BitDepth::ThirtyTwoFloat(s) => AudioChunk::from_interlaced_iterator(
                    s.iter().map(|a| S::from_sample_(*a)),
                    header.channel_count as usize,
                ),
                BitDepth::Empty => AudioChunk::new(header.channel_count as usize),
            };
            Self {
                frames_per_second: header.sampling_rate as u64,
                frame: 0,
                chunk,
                phantom: PhantomData,
            }
        }
    }
}

/// An [`AudioWriter`] that appends to a given [`AudioChunk`].
/// The generic parameter type `S` represents the sample type.
///
/// Note about using in a real-time context
/// =======================================
/// Because this appends to an [`AudioChunk`], it may allocate memory
/// when the capacity of the [`AudioChunk`] is exceeded.
///
/// [`AudioWriter`]: ../trait.AudioWriter.html
/// [`AudioChunk`]: ../../../buffer/struct.AudioChunk.html
pub struct AudioBufferWriter<'b, S> {
    buffer: &'b mut AudioChunk<S>,
}

impl<'b, S> AudioBufferWriter<'b, S> {
    pub fn new(buffer: &'b mut AudioChunk<S>) -> Self {
        Self { buffer }
    }
}

impl<'b, S> AudioWriter<S> for AudioBufferWriter<'b, S>
where
    S: Copy,
{
    type Err = std::convert::Infallible;
    fn write_buffer(&mut self, buffer: &AudioBufferIn<S>) -> Result<(), Self::Err> {
        self.buffer.append_sliced_chunk(buffer.channels());
        Ok(())
    }

    fn specifies_number_of_channels(&self) -> bool {
        true
    }

    fn number_of_channels(&self) -> usize {
        self.buffer.number_of_channels()
    }
}