mirror of
https://github.com/iluvcapra/bwavfile.git
synced 2025-12-31 08:50:44 +00:00
Documentation
This commit is contained in:
20
src/fmt.rs
20
src/fmt.rs
@@ -3,20 +3,20 @@ use super::common_format::CommonFormat;
|
|||||||
|
|
||||||
#[allow(dead_code)]
|
#[allow(dead_code)]
|
||||||
|
|
||||||
/// ADM Audio ID record
|
/// ADM Audio ID record.
|
||||||
///
|
///
|
||||||
/// This structure relates a channel in the wave file to either a common ADM
|
/// This structure relates a channel in the wave file to either a common ADM
|
||||||
/// channel definition or further definition in the WAV file's ADM metadata
|
/// channel definition or further definition in the WAV file's ADM metadata
|
||||||
/// chunk.
|
/// chunk.
|
||||||
///
|
///
|
||||||
/// An individual channel in a WAV file can have multiple Audio IDs in an ADM
|
/// An individual channel in a WAV file can have multiple Audio IDs in an ADM
|
||||||
/// AudioProgramme.
|
/// `AudioProgramme`.
|
||||||
///
|
///
|
||||||
/// See BS.2088-1 § 8, also BS.2094, also blahblahblah...
|
/// See BS.2088-1 § 8, also BS.2094, also blahblahblah...
|
||||||
pub struct ADMAudioID {
|
pub struct ADMAudioID {
|
||||||
track_uid: [char; 12],
|
pub track_uid: [char; 12],
|
||||||
channel_format_ref: [char; 14],
|
pub channel_format_ref: [char; 14],
|
||||||
pack_ref: [char; 11]
|
pub pack_ref: [char; 11]
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Describes a single channel in a WAV file.
|
/// Describes a single channel in a WAV file.
|
||||||
@@ -35,13 +35,9 @@ pub struct ChannelDescriptor {
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/// A bitmask indicating which channels are present in
|
||||||
/*
|
/// the file.
|
||||||
https://docs.microsoft.com/en-us/windows-hardware/drivers/audio/subformat-guids-for-compressed-audio-formats
|
///
|
||||||
|
|
||||||
These are from http://dream.cs.bath.ac.uk/researchdev/wave-ex/mulchaud.rtf
|
|
||||||
*/
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq)]
|
#[derive(Debug, Clone, Copy, PartialEq)]
|
||||||
pub enum ChannelMask {
|
pub enum ChannelMask {
|
||||||
DirectOut = 0x0,
|
DirectOut = 0x0,
|
||||||
|
|||||||
@@ -128,7 +128,7 @@ pub use errors::Error;
|
|||||||
pub use wavereader::WaveReader;
|
pub use wavereader::WaveReader;
|
||||||
pub use wavewriter::WaveWriter;
|
pub use wavewriter::WaveWriter;
|
||||||
pub use bext::Bext;
|
pub use bext::Bext;
|
||||||
pub use fmt::{WaveFmt, WaveFmtExtended, ChannelDescriptor, ChannelMask};
|
pub use fmt::{WaveFmt, WaveFmtExtended, ChannelDescriptor, ChannelMask, ADMAudioID};
|
||||||
pub use common_format::CommonFormat;
|
pub use common_format::CommonFormat;
|
||||||
pub use audio_frame_reader::AudioFrameReader;
|
pub use audio_frame_reader::AudioFrameReader;
|
||||||
pub use cue::Cue;
|
pub use cue::Cue;
|
||||||
Reference in New Issue
Block a user