Skip to main content

AudioFrame

Struct AudioFrame 

Source
pub struct AudioFrame {
    pub samples: Vec<u8>,
    pub sample_count: usize,
    pub sample_rate: u32,
    pub channels: usize,
    pub format: SampleFormat,
    pub pts: Option<i64>,
    pub duration: Option<u64>,
}
Expand description

An audio frame containing decoded samples.

Audio frames store PCM samples in interleaved format for multi-channel audio. For example, stereo audio is stored as [L0, R0, L1, R1, L2, R2, …].

Fields§

§samples: Vec<u8>

Raw sample data (interleaved if multi-channel)

§sample_count: usize

Number of samples per channel

§sample_rate: u32

Sample rate in Hz (e.g., 48000 for 48kHz)

§channels: usize

Number of channels (1 = mono, 2 = stereo, etc.)

§format: SampleFormat

Sample format

§pts: Option<i64>

Presentation timestamp in sample units

§duration: Option<u64>

Duration in sample units

Implementations§

Source§

impl AudioFrame

Source

pub fn new( samples: Vec<u8>, sample_count: usize, sample_rate: u32, channels: usize, format: SampleFormat, ) -> Self

Creates a new audio frame.

§Arguments
  • samples - Raw sample data (interleaved if multi-channel)
  • sample_count - Number of samples per channel
  • sample_rate - Sample rate in Hz
  • channels - Number of channels
  • format - Sample format
Source

pub fn with_timing( samples: Vec<u8>, sample_count: usize, sample_rate: u32, channels: usize, format: SampleFormat, pts: i64, duration: u64, ) -> Self

Creates a new audio frame with timing information.

Source

pub const fn total_samples(&self) -> usize

Returns the total number of samples (all channels combined).

Source

pub fn byte_size(&self) -> usize

Returns the size in bytes of the audio data.

Source

pub fn duration_seconds(&self) -> f64

Returns the duration in seconds.

Source

pub fn to_f32(&self) -> CodecResult<Vec<f32>>

Converts bytes to f32 and returns a new Vec.

Source

pub fn to_i16(&self) -> CodecResult<Vec<i16>>

Converts bytes to i16 and returns a new Vec.

Trait Implementations§

Source§

impl Clone for AudioFrame

Source§

fn clone(&self) -> AudioFrame

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AudioFrame

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.