Struct bwavfile::WaveReader

pub struct WaveReader<R: Read + Seek> {
    pub inner: R,
}

Wave, Broadcast-WAV and RF64/BW64 parser/reader.

Resources

Implementation of Broadcast Wave Files

• EBU Tech 3285 (May 2011), "Specification of the Broadcast Wave Format (BWF)"

Implementation of 64-bit Wave Files

• ITU-R 2088 (October 2019), "Long-form file format for the international exchange of audio programme materials with metadata"

  • Presently in force, adopted by the EBU in EBU Tech 3306v2 (June 2018).

• EBU Tech 3306v1 (July 2009), "MBWF / RF64: An extended File Format for Audio"

  • No longer in force, however long-established.

Implementation of Wave format fmt chunk

• MSDN WAVEFORMATEX
• MSDN WAVEFORMATEXTENSIBLE

Other resources

• RFC 3261 (June 1998) "WAVE and AVI Codec Registries"
• Peter Kabal, McGill University
  • Multimedia Programming Interface and Data Specifications 1.0 IBM Corporation and Microsoft Corporation, (August 1991)

Fields

inner: R

Implementations

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

pub fn validate_readable(&mut self) -> Result<(), ParserError>

Returns without Err if the source meets the minimum standard of readability by a permissive client:

1. fmt chunk and data chunk are present
2. fmt chunk appears before data chunk

pub fn validate_minimal(&mut self) -> Result<(), ParserError>

Validate minimal WAVE file

Returns without Err the source is validate_readable AND

• Contains only a fmt chunk and data chunk, with no other chunks present
• is not an RF64/BW64

Some clients require a WAVE file to only contain format and data without any other metadata and this function is provided to validate this condition.

pub fn validate_broadcast_wave(&mut self) -> Result<(), ParserError>

Validate Broadcast-WAVE file format

Returns without Err if validate_readable() and file contains a Broadcast-WAV metadata record (a bext chunk).

pub fn validate_data_chunk_alignment(&mut self) -> Result<(), ParserError>

Verify data is aligned to a block boundary

Returns without Err if validate_readable() and the start of the data chunk's content begins at 0x4000.

pub fn validate_prepared_for_append(&mut self) -> Result<(), ParserError>

Returns without Err if:

• validate_readable()
• there is a JUNK or FLLR immediately at the beginning of the chunk list adequately large enough to be overwritten by a ds64 (96 bytes)
• data is the final chunk

impl WaveReader<File>

pub fn open(path: &str) -> Result<Self, ParserError>

Open a file for reading.

A convenience that opens path and calls Self::new()

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

pub fn new(inner: R) -> Result<Self, ParserError>

Wrap a Read struct in a new WaveReader.

This is the primary entry point into the WaveReader interface. The stream passed as inner must be at the beginning of the header of the WAVE data. For a .wav file, this means it must be at the start of the file.

This function does a minimal validation on the provided stream and will return an Err(errors::Error) immediately if there is a structural inconsistency that makes the stream unreadable or if it's missing essential components that make interpreting the audio data impoossible.

pub fn into_inner(self) -> R

Unwrap and reliqnish ownership of the inner reader.

pub fn audio_frame_reader(
    &mut self
) -> Result<AudioFrameReader<RawChunkReader<'_, R>>, ParserError>

Create an AudioFrameReader for reading each audio frame.

pub fn frame_length(&mut self) -> Result<u64, ParserError>

The count of audio frames in the file.

pub fn format(&mut self) -> Result<WaveFmt, ParserError>

Sample and frame format of this wave file.

pub fn broadcast_extension(&mut self) -> Result<Bext, ParserError>

The Broadcast-WAV metadata record for this file.

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

pub fn get_chunk_extent_at_index(
    &mut self,
    fourcc: FourCC,
    index: u32
) -> Result<(u64, u64), ParserError>

Trait Implementations

impl<R: Debug + Read + Seek> Debug for WaveReader<R>

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

Formats the value using the given formatter.