Skip to main content

SimpleVorbisEncoder

Struct SimpleVorbisEncoder 

Source
pub struct SimpleVorbisEncoder { /* private fields */ }
Expand description

A simple Vorbis encoder that accepts interleaved f32 PCM and emits raw Ogg Vorbis payload bytes.

The first call to SimpleVorbisEncoder::encode_pcm prepends the three mandatory Vorbis header packets so the output is a self-contained stream.

§Example

use oximedia_codec::vorbis::{SimpleVorbisEncoder, VorbisEncConfig};

let cfg = VorbisEncConfig {
    sample_rate: 44100,
    channels: 2,
    quality: 0.5,
};
let mut enc = SimpleVorbisEncoder::new(cfg)?;
let pcm = vec![0.0f32; 4096]; // 2048 stereo frames
let payload = enc.encode_pcm(&pcm)?;
assert!(!payload.is_empty());

Implementations§

Source§

impl SimpleVorbisEncoder

Source

pub fn new(config: VorbisEncConfig) -> CodecResult<Self>

Create a new encoder.

§Errors

Returns CodecError::InvalidParameter if sample_rate or channels are out of the valid range (see VorbisEncoder).

Source

pub fn encode_pcm(&mut self, samples: &[f32]) -> CodecResult<Vec<u8>>

Encode interleaved f32 PCM samples (range [−1, +1]).

On the first call the three Vorbis header packets are prepended so the returned bytes form a complete, decodable stream. Subsequent calls return only audio packets.

§Errors

Returns CodecError::InvalidParameter if samples.len() is not a multiple of the channel count.

Source

pub fn flush(&mut self) -> CodecResult<Vec<u8>>

Flush any remaining buffered samples.

Returns the final payload bytes (may be empty if no samples were buffered).

§Errors

This implementation forwards errors from the underlying encoder.

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.