mirror of
https://github.com/iluvcapra/bwavfile.git
synced 2026-01-02 01:40:45 +00:00
prettify code
This commit is contained in:
38
src/lib.rs
38
src/lib.rs
@@ -1,29 +1,29 @@
|
||||
/*!
|
||||
/*!
|
||||
# bwavfile
|
||||
|
||||
|
||||
Rust Wave File Reader/Writer with Broadcast-WAV, MBWF and RF64 Support
|
||||
|
||||
## Interfaces
|
||||
|
||||
### `WaveReader`
|
||||
|
||||
`WaveReader` can open and parse a Wave, Broadcast-Wave, or RF64/BW64 64-bit
|
||||
`WaveReader` can open and parse a Wave, Broadcast-Wave, or RF64/BW64 64-bit
|
||||
wave file. Metadata can be accessed and parsed in arbitrary order and audio
|
||||
samples can be accessed using the `AudioFrameReader` type, created by an
|
||||
samples can be accessed using the `AudioFrameReader` type, created by an
|
||||
accessor method of `WaveReader`.
|
||||
|
||||
### `WaveWriter`
|
||||
|
||||
`WaveWriter` can create a new Wave, Broadcast-Wave, or RF64/BW64 64-bit wave
|
||||
file. Metadata chunks and audio samples are added sequentially, write-only, to
|
||||
a Wave file which is automatically promoted from standard Wave to RF64 wave
|
||||
`WaveWriter` can create a new Wave, Broadcast-Wave, or RF64/BW64 64-bit wave
|
||||
file. Metadata chunks and audio samples are added sequentially, write-only, to
|
||||
a Wave file which is automatically promoted from standard Wave to RF64 wave
|
||||
when the total WAVE form size exceeds 0xFFFFFFFF bytes.
|
||||
|
||||
|
||||
## 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
|
||||
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:
|
||||
@@ -36,29 +36,29 @@ Apps we test against:
|
||||
[github]: https://github.com/iluvcapra/bwavfile
|
||||
*/
|
||||
|
||||
extern crate encoding;
|
||||
extern crate byteorder;
|
||||
extern crate encoding;
|
||||
extern crate uuid;
|
||||
|
||||
mod fourcc;
|
||||
mod errors;
|
||||
mod common_format;
|
||||
mod errors;
|
||||
mod fourcc;
|
||||
|
||||
mod parser;
|
||||
mod list_form;
|
||||
mod parser;
|
||||
|
||||
mod bext;
|
||||
mod chunks;
|
||||
mod cue;
|
||||
mod bext;
|
||||
mod fmt;
|
||||
|
||||
mod wavereader;
|
||||
mod wavewriter;
|
||||
|
||||
pub use errors::Error;
|
||||
pub use wavereader::{WaveReader, AudioFrameReader};
|
||||
pub use wavewriter::{WaveWriter, AudioFrameWriter};
|
||||
pub use bext::Bext;
|
||||
pub use fmt::{WaveFmt, WaveFmtExtended, ChannelDescriptor, ChannelMask, ADMAudioID};
|
||||
pub use common_format::CommonFormat;
|
||||
pub use cue::Cue;
|
||||
pub use cue::Cue;
|
||||
pub use errors::Error;
|
||||
pub use fmt::{ADMAudioID, ChannelDescriptor, ChannelMask, WaveFmt, WaveFmtExtended};
|
||||
pub use wavereader::{AudioFrameReader, WaveReader};
|
||||
pub use wavewriter::{AudioFrameWriter, WaveWriter};
|
||||
|
||||
Reference in New Issue
Block a user