Enum Reader

pub enum Reader<R>
where
    R: Read + Seek,
{
    Flac(FlacReader<R>),
    OggVorbis(OggStreamReader<R>),
    Wav(WavReader<R>),
    CafAlac(AlacReader<R>),
}

Returned by the read function, enumerates the various supported readers.

Variants

Flac(FlacReader<R>)

OggVorbis(OggStreamReader<R>)

Wav(WavReader<R>)

CafAlac(AlacReader<R>)

Implementations

impl Reader<BufReader<File>>

pub fn open<P>(file_path: P) -> Result<Self, ReadError>

where P: AsRef<Path>,

Attempts to open an audio Reader from the file at the specified Path.

This function is a convenience wrapper around the Reader::new function.

This function pays no attention to the file_path’s extension and instead attempts to read a supported Format via the file header.

impl<R> Reader<R>

where R: Read + Seek,

pub fn new(reader: R) -> Result<Self, ReadError>

Attempts to read the format of the audio read by the given reader and returns the associated Reader variant.

The format is determined by attempting to construct each specific format reader until one is successful.

pub fn format(&self) -> Format

The format from which the audio will be read.

pub fn description(&self) -> Description

A basic description of the audio being read.

pub fn samples<S>(&mut self) -> Samples<'_, R, S>

where S: Sample,

Produce an iterator that reads samples from the underlying reader, converts them to the sample type S if not already in that format and yields them.

When reading from multiple channels, samples are interleaved.

pub fn frames<F>(&mut self) -> Frames<'_, R, F>

where F: Frame, F::Sample: Sample,

Produce an iterator that yields read frames from the underlying Reader.

This method currently expects that the frame type F has the same number of channels as stored in the underlying audio format.

TODO: Should consider changing this behaviour to check the audio file’s actual number of channels and automatically convert to F’s number of channels while reading.