Skip to main content

AudioBuffer

Struct AudioBuffer 

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

Normalized, interleaved f32 audio with sample-rate and channel metadata.

Samples are stored interleaved (frame-major) and scaled to the [-1.0, 1.0] range regardless of the source bit depth. The buffer is cheap to clone and owns its samples, which can be taken with AudioBuffer::into_samples.

Implementations§

Source§

impl AudioBuffer

Source

pub fn new( sample_rate: u32, channels: u16, samples: Vec<f32>, ) -> Result<Self, ResampleError>

Create a buffer from interleaved f32 samples.

Returns ResampleError::InvalidSampleRate when sample_rate is zero, ResampleError::InvalidChannelCount when channels is zero, and ResampleError::BufferError when the sample count is not a whole number of frames.

Source

pub fn sample_rate(&self) -> u32

Source sample rate in Hz.

Source

pub fn channels(&self) -> u16

Number of channels.

Source

pub fn samples(&self) -> &[f32]

Interleaved sample slice.

Source

pub fn into_samples(self) -> Vec<f32>

Consume the buffer and return the owned interleaved samples.

Source

pub fn frame_count(&self) -> usize

Number of frames (samples.len() / channels).

Source

pub fn is_empty(&self) -> bool

true when the buffer holds no samples.

Source

pub fn resample_to(&self, output_rate: u32) -> Result<Self, ResampleError>

Resample to output_rate, preserving the channel layout.

Trait Implementations§

Source§

impl Clone for AudioBuffer

Source§

fn clone(&self) -> AudioBuffer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AudioBuffer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for AudioBuffer

Source§

fn eq(&self, other: &AudioBuffer) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AudioBuffer

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> 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.