mirror of
https://github.com/iluvcapra/bwavfile.git
synced 2025-12-31 08:50:44 +00:00
56 lines
2.6 KiB
Markdown
56 lines
2.6 KiB
Markdown
[](LICENSE)
|
|
[](https://crates.io/crates/bwavfile/)
|
|
|
|
[](https://github.com/iluvcapra/bwavfile/actions?query=workflow%3ARust)
|
|
|
|
# bwavfile
|
|
Wave File Reader/Writer library in Rust, with Broadcast-WAV, MBWF and RF64 Support
|
|
|
|
## Features
|
|
|
|
__bwavfile__ provides a reader `WaveReader` and writer type `WaveWriter` for
|
|
reading and creating new audio files respectively.
|
|
|
|
`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 specification.
|
|
* Multichannel, surround, and ambisonic audio data description including
|
|
surround channel maps, ADM `AudioTrackFormat`, `AudioChannelFormatRef` and
|
|
`AudioPackRef` data structures.
|
|
* Broadcast-Wave metdata extension, including long description, originator
|
|
information, 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 region.
|
|
|
|
### Feature Roadmap
|
|
|
|
Some features that may be included in the future include:
|
|
* Broadcast-Wave `levl` waveform overview data reading and writing.
|
|
* Sampler and Instrument mentadata.
|
|
|
|
|
|
## Use Examples
|
|
|
|
Check out the [examples](examples) directory for some practical use cases:
|
|
|
|
* [blits](examples/blits.rs) shows how to use `WaveWriter` to create a new
|
|
file with BLITS alignment tones.
|
|
* [wave-inter](examples/wave-inter.rs) uses `WaveReader` and `WaveWriter` to
|
|
interleave several input Wave files into a single polyphonic Wave file.
|
|
* [wave-deinter](examples/wave-deinter.rs) 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.
|
|
|
|
[rf64test]: https://github.com/iluvcapra/bwavfile/blob/1f8542a7efb481da076120bf8107032c5b48889d/src/wavewriter.rs#L399
|