Skip to main content

VorbisDecoder

Struct VorbisDecoder 

Source
pub struct VorbisDecoder {
    pub sample_rate: u32,
    pub channels: u8,
    pub state: DecoderState,
    pub packets_decoded: u64,
    /* private fields */
}
Expand description

Vorbis audio decoder.

Fields§

§sample_rate: u32

Sample rate (filled from ID header).

§channels: u8

Channel count (filled from ID header).

§state: DecoderState

Current decoder state.

§packets_decoded: u64

Number of audio packets decoded.

Implementations§

Source§

impl VorbisDecoder

Source

pub fn new() -> Self

Create a new, uninitialised decoder.

Feed the three header packets via decode_packet before audio.

Source

pub fn decode_packet(&mut self, data: &[u8]) -> CodecResult<Option<Vec<f32>>>

Decode one Vorbis packet.

  • Header packets are parsed for configuration.
  • Audio packets are decoded to interleaved f32 PCM.

Returns None for header packets, Some(Vec<f32>) for audio.

§Errors

Returns CodecError if the packet is malformed.

Source

pub fn process_header_packet( &mut self, data: &[u8], ) -> CodecResult<VorbisHeaderType>

Process a Vorbis header packet and return which header type was parsed.

This is an alternative entry-point to decode_packet for callers that only need the structured header information without PCM output.

§Errors

Returns CodecError if the packet is malformed or received out of order.

Source

pub fn id_header(&self) -> Option<&VorbisIdHeader>

Return a reference to the parsed identification header, if available.

Source

pub fn comment_header(&self) -> Option<&VorbisCommentHeader>

Return a reference to the parsed comment header, if available.

Source

pub fn is_ready(&self) -> bool

Returns true once all three Vorbis header packets have been processed and the decoder is ready for audio packets.

Source

pub fn decode_audio_packet(&self, data: &[u8]) -> CodecResult<Vec<f32>>

Validate and structurally decode a Vorbis audio packet.

This checks that the decoder is ready and that the packet starts with the audio-packet type byte (0x00). A full Vorbis II floor/residue decode is performed by decode_packet; this entry-point is provided for callers that only need structural validation.

§Errors

Returns CodecError if the decoder is not yet ready, the packet is empty, or the packet-type byte is not 0x00.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.