Struct rsynth::backend::combined::memory::AudioChunkReader

pub struct AudioChunkReader<S, T> where
    T: Borrow<AudioChunk<S>>,
    S: Copy,  { /* fields omitted */ }

An AudioReader that reads from a given AudioChunk. The generic parameter type S represents the sample type.

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));
}

Implementations

impl<S, T> AudioChunkReader<S, T> where
    T: Borrow<AudioChunk<S>>,
    S: Copy, 

pub fn new(buffer: T, frames_per_second: u64) -> Self

Construct a new AudioChunkReader with the given AudioChunk and sample rate in frames per second.

Trait Implementations

impl<S, T> AudioReader<S> for AudioChunkReader<S, T> where
    T: Borrow<AudioChunk<S>>,
    S: Copy, 

type Err = Infallible

The type of the error that occurs when reading data.

fn number_of_channels(&self) -> usize

The number of audio channels that can be read.

fn frames_per_second(&self) -> u64

The sampling frequency in frames per second.

fn fill_buffer(
    &mut self,
    output: &mut AudioBufferOut<'_, '_, S>
) -> Result<usize, Self::Err>

Fill the buffers. Return the number of frames that have been read and written to the buffer. If the return value is < the number of frames in the input, no more frames can be expected.

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

Performs the conversion.