Skip to main content

AudioBuffer

Struct AudioBuffer 

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

Audio buffer for batch processing.

Provides utilities for normalization, resampling, and format conversion.

§Example

use speech_prep::buffer::AudioBuffer;

let samples = vec![0.1, 0.2, -0.1, -0.2];
let buffer = AudioBuffer::from_samples(samples, 16000)?;

assert_eq!(buffer.sample_rate(), 16000);
assert_eq!(buffer.len(), 4);

Implementations§

Source§

impl AudioBuffer

Source

pub fn from_samples(samples: Vec<f32>, sample_rate: u32) -> Result<Self>

Create AudioBuffer from f32 samples

§Arguments
  • samples - Audio samples (will be validated)
  • sample_rate - Sample rate in Hz
§Errors

Returns error if samples are empty or sample rate is invalid

§Example
use speech_prep::buffer::AudioBuffer;

let samples = vec![0.1, 0.2, -0.1];
let buffer = AudioBuffer::from_samples(samples, 16000)?;
assert_eq!(buffer.len(), 3);
Source

pub fn from_chunk(chunk: AudioChunk) -> Result<Self>

Create AudioBuffer from AudioChunk (zero-copy data)

Converts a streaming AudioChunk into an owned AudioBuffer.

§Example
use speech_prep::buffer::AudioBuffer;
use speech_prep::types::AudioChunk;

let chunk = AudioChunk::new(vec![0.1, 0.2], 0, 0.0, 16000);
let buffer = AudioBuffer::from_chunk(chunk)?;
assert_eq!(buffer.len(), 2);
Source

pub fn sample_rate(&self) -> u32

Get sample rate in Hz

Source

pub fn len(&self) -> usize

Get number of samples

Source

pub fn is_empty(&self) -> bool

Check if buffer is empty

Source

pub fn duration(&self) -> AudioDuration

Get duration as AudioDuration

§Example
use speech_prep::buffer::AudioBuffer;
use speech_prep::time::AudioDuration;

let buffer = AudioBuffer::from_samples(vec![0.0; 16000], 16000)?;
let duration = buffer.duration();
assert_eq!(duration.as_secs(), 1);
Source

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

Get immutable slice of samples

Source

pub fn samples_mut(&mut self) -> &mut [f32]

Get mutable slice of samples

Source

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

Consume buffer and return samples

Source

pub fn normalize(&mut self)

Normalize samples to [-1.0, 1.0] range

Applies peak normalization to ensure samples are within valid range.

§Example
use speech_prep::buffer::AudioBuffer;

let mut buffer = AudioBuffer::from_samples(vec![2.0, -2.0, 1.0], 16000)?;
buffer.normalize();

// Samples now scaled to [-1.0, 1.0]
assert!(buffer.samples().iter().all(|&s| s >= -1.0 && s <= 1.0));
Source

pub fn validate_samples(&self) -> Result<()>

Validate sample values are within expected range

Checks that all samples are finite and within reasonable bounds.

Source

pub fn metadata(&self) -> Option<&AudioBufferMetadata>

Get metadata

Source

pub fn set_metadata(&mut self, metadata: AudioBufferMetadata)

Set metadata

Trait Implementations§

Source§

impl Clone for AudioBuffer

Source§

fn clone(&self) -> AudioBuffer

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 AudioBuffer

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more