Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 2.65 KB

README.md

File metadata and controls

59 lines (44 loc) · 2.65 KB

Crates.io Crates.io GitHub last commit GitHub Workflow Status

bwavfile

Wave File Reader/Writer library in Rust, with Broadcast-WAV, RF64 and production metadata support

Features

bwavfile provides a reader WaveReader and writer type WaveWriter for reading and creating new wave audio files.

WaveReader and WaveWriter support:

  • A unified interface for standard RIFF and RF64/BW64 64-bit Wave files.
  • When using WaveWriter, wave files are transparently upgraded from RIFF to RF64 when required.
  • Unpacked reading and writing of Integer PCM and IEEE float audio data formats.
  • A unified interface for standard WaveFormat and extended WaveFormatEx wave data format.

The library has extensive metadata support, with emphasis on film and video production metadata:

  • Broadcast-Wave metadata extension, including long description, originator, SMPTE UMID and coding history.
  • Reading and writing of embedded iXML and axml/ADM metadata.
  • Reading and writing of timed cues and and timed cue regions.
  • Multichannel, surround, and ambisonic audio data description including surround channel maps, ADM AudioTrackFormat, AudioChannelFormatRef and AudioPackRef data structures.

Feature Roadmap

Some features that may be included in the future include:

  • Broadcast-Wave levl waveform overview data reading and writing.
  • Sampler and Instrument metadata.
  • Performance improvements.

Use Examples

  • blits shows how to use WaveWriter to create a new file with BLITS alignment tones.
  • wave-inter uses WaveReader and WaveWriter to interleave several input Wave files into a single polyphonic Wave file.
  • wave-deinter uses WaveReader and WaveWriter to de-interleave an input Wave file into several monoarual Wave files.

Note on Testing

All of the media for the integration tests is committed to the respository in zipped form. Before you can run tests, you need to cd into the tests directory and run the create_test_media.sh script. Note that one of the test files (the RF64 test case) is over four gigs in size.