Struct OggVorbisDecoderWrap

pub struct OggVorbisDecoderWrap {
    pub downmixer: Downmixer,
    /* private fields */
}

• The OggVorbis decoder for WaveReader

Fields

downmixer: Downmixer

The downmixer for multiple channels audio to decode into 2 or 1 channels

Implementations

impl OggVorbisDecoderWrap

pub fn new( reader: Box<dyn Reader>, data_offset: u64, data_length: u64, fmt: &FmtChunk, total_samples: u64, downmixer: Option<Downmixer>, ) -> Result<Self, AudioReadError>

pub fn get_channels(&self) -> u16

Get how many channels in the OggVorbis audio data

pub fn get_cur_frame_index(&self) -> u64

Get the current decoding audio frame index. The audio frame is an array for all channels’ one sample.

pub fn seek(&mut self, seek_from: SeekFrom) -> Result<(), AudioReadError>

Seek to the block that contains the specific frame index of the audio frame.

pub fn decode_frame<S>(&mut self) -> Result<Option<Vec<S>>, AudioReadError>

where S: SampleType,

Decode as audio frames. The audio frame is an array for all channels’ one sample.

pub fn decode_stereo<S>(&mut self) -> Result<Option<(S, S)>, AudioReadError>

where S: SampleType,

Decode as stereo audio

pub fn decode_mono<S>(&mut self) -> Result<Option<S>, AudioReadError>

where S: SampleType,

Decode as mono audio. All channel samples will be mixed into one.

Trait Implementations

impl Debug for OggVorbisDecoderWrap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S> Decoder<S> for OggVorbisDecoderWrap

where S: SampleType,

fn get_channels(&self) -> u16

Get num channels

fn get_cur_frame_index(&mut self) -> Result<u64, AudioReadError>

Get current frame index.

fn seek(&mut self, seek_from: SeekFrom) -> Result<(), AudioReadError>

Seek to a specific audio frame. An audio frame is each channel has one sample.

fn decode_frame(&mut self) -> Result<Option<Vec<S>>, AudioReadError>

Decode one audio frame. An audio frame is each channel has one sample. This method supports > 2 channels.

fn decode_stereo(&mut self) -> Result<Option<(S, S)>, AudioReadError>

Decode a stereo sample with left and right samples, if the audio has > 2 channels, this method fails.

fn decode_mono(&mut self) -> Result<Option<S>, AudioReadError>

Decode a mono sample, multiple channels will be mixed into one channel.

fn set_downmixer(&mut self, downmixer: &Downmixer)

Set the downmixer

fn get_downmixer(&self) -> Option<Downmixer>

Get the downmixer

fn decode_frames( &mut self, num_frames: usize, ) -> Result<Vec<Vec<S>>, AudioReadError>

Decode multiple audio frames. This method supports > 2 channels.

fn decode_monos(&mut self, num_monos: usize) -> Result<Vec<S>, AudioReadError>

Decode multiple mono samples, multiple channels will be mixed into one channel.

fn decode_stereos( &mut self, num_stereos: usize, ) -> Result<Vec<(S, S)>, AudioReadError>

Decode multiple stereo samples with left and right samples, if the audio has > 2 channels, this method fails.