Struct WavReader 

pub struct WavReader<R> { /* private fields */ }

Streaming WAV decoder over any io::Read.

Construction parses the RIFF header, the fmt chunk, and every chunk up to and including the data chunk header. Samples are then decoded from a 64 KiB block buffer that is refilled with bulk reads clamped to the declared data boundary, so the underlying reader is never read past the end of the audio payload.

Implementations

impl WavReader<BufReader<File>>

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a WAV file from disk.

impl<R: Read> WavReader<R>

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

Parse the headers from reader and position it at the first sample.

Fails on a malformed container (Error::Format), an encoding outside the crate’s scope (Error::Unsupported), or a stream that ends inside the headers (Error::Io).

pub fn spec(&self) -> WavSpec

The stream parameters.

pub fn spec_ex(&self) -> WavSpecEx

The stream parameters plus the container width.

pub fn duration(&self) -> u32

Number of frames (samples per channel) the data chunk declares.

pub fn len(&self) -> u32

Total number of samples across all channels the data chunk declares.

For a stream the declared count can exceed what exists. The sample iterators report that shortfall as an error.

pub fn is_empty(&self) -> bool

Whether the data chunk declares zero samples.

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

Iterate over the remaining samples, borrowing the reader.

Items are Result<S>. The first error fuses the iterator. A type that cannot represent the file’s samples yields one Error::TooWide.

pub fn into_samples<S: Sample>(self) -> IntoSamples<R, S>

Iterate over the remaining samples, consuming the reader.

pub fn read_samples<S: Sample>(&mut self, buf: &mut [S]) -> Result<usize>

Decode samples into buf and return how many were written.

The buffer is filled completely unless the data chunk ends first, so a count below buf.len() means the end of the audio, and Ok(0) on a later call confirms it. A stream that ends before the declared data size returns Err instead of a short count.

pub fn into_inner(self) -> R

Return the underlying reader.

Bytes pulled into the block buffer but not yet yielded are lost.

impl<R: Read + Seek> WavReader<R>

pub fn seek(&mut self, frame: u32) -> Result<()>

Position the reader at frame (a frame is one sample per channel).

Seeking advances by the container width, so a 24-in-32 file seeks in 4-byte steps. frame may equal duration, which leaves no samples to read. Anything past that is InvalidInput.

Trait Implementations

impl<R> Debug for WavReader<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.