Files
bwavfile/src/lib.rs
Jamie Hardt b8a428e757 Documentation and exposure
Documentation in the fmt module has been improved.

ReadWaveData trait is now public.

The
2023-06-02 11:06:53 -07:00

57 lines
1.3 KiB
Rust

/*!
# bwavfile
Rust Wave File Reader/Writer with Broadcast-WAV, MBWF and RF64 Support
Refer to the individual modules for relevant documentation. For opening
and writing files begin with [WaveReader] and [WaveWriter] respectively.
## Objectives and Roadmap
This package aims to support read and writing any kind of WAV file you are likely
to encounter in a professional audio, motion picture production, broadcast, or music
production.
Apps we test against:
- Avid Pro Tools
- iZotope RX Audio Editor
- FFMpeg
- Audacity
- Sound Devices field recorders: 702T, MixPre-10 II
[github]: https://github.com/iluvcapra/bwavfile
*/
extern crate byteorder;
extern crate encoding;
extern crate uuid;
mod common_format;
mod errors;
mod fourcc;
mod list_form;
mod parser;
mod bext;
mod chunks;
mod cue;
mod fmt;
mod sample;
mod wavereader;
mod wavewriter;
pub use bext::Bext;
pub use common_format::{
CommonFormat, WAVE_TAG_EXTENDED, WAVE_TAG_FLOAT, WAVE_TAG_MPEG, WAVE_TAG_PCM,
WAVE_UUID_BFORMAT_FLOAT, WAVE_UUID_BFORMAT_PCM, WAVE_UUID_FLOAT, WAVE_UUID_MPEG, WAVE_UUID_PCM,
};
pub use cue::Cue;
pub use errors::Error;
pub use fmt::{ADMAudioID, ChannelDescriptor, ChannelMask, WaveFmt, WaveFmtExtended, ReadWavAudioData};
pub use sample::{Sample, I24};
pub use wavereader::{AudioFrameReader, WaveReader};
pub use wavewriter::{AudioFrameWriter, WaveWriter};