Enum AudioData 

pub enum AudioData<'a, T: AudioSample> {
    Mono(MonoData<'a, T>),
    Multi(MultiData<'a, T>),
}

Storage container for audio sample data.

Differentiates between mono (single-channel) and multi-channel audio data while providing a unified interface for processing operations.

Variants

• Mono: Single-channel audio data stored as 1D array
• Multi: Multi-channel audio data stored as 2D array (channels as rows)

Example

use audio_samples::{AudioData, MonoData, MultiData};
use ndarray::{array, Array1, Array2};

// Mono audio data
let mono: AudioData<f32> = AudioData::Mono(MonoData::from(array![0.1, 0.2, 0.3]));

// Stereo audio data
let stereo: AudioData<f32> = AudioData::Multi(MultiData::from(
    array![[0.1, 0.2], [0.3, 0.4]]
));

Variants

Mono(MonoData<'a, T>)

Single-channel audio data

Multi(MultiData<'a, T>)

Multi-channel audio data

Implementations

impl<T: AudioSample> AudioData<'static, T>

pub fn from_owned(data: AudioData<'_, T>) -> Self

Creates a new AudioData instance from owned data.

pub fn mean(&self) -> Option<T>

Computes the mean value across all samples in the audio data.

pub fn into_mono_data(self) -> Option<Array1<T>>

Consumes self and returns the underlying data as an owned Array1 or Array2.

pub fn into_multi_data(self) -> Option<Array2<T>>

Consumes self and returns the underlying data as an owned Array2. Returns None if the data is mono.

impl<T: AudioSample> AudioData<'_, T>

pub const fn new_mono(data: Array1<T>) -> AudioData<'static, T>

Creates a new mono AudioData from an owned Array1.

pub const fn new_multi(data: Array2<T>) -> AudioData<'static, T>

Creates a new multi-channel AudioData from an owned Array2.

pub fn from_slice<'a>(slice: &'a [T]) -> AudioData<'a, T>

Creates mono AudioData from a slice (borrowed).

pub fn from_slice_mut<'a>(slice: &'a mut [T]) -> AudioData<'a, T>

Creates mono AudioData from a mutable slice (borrowed).

pub fn from_slice_multi<'a>(slice: &'a [T], channels: usize) -> AudioData<'a, T>

Creates multi-channel AudioData from a slice with specified channel count (borrowed).

Panics

• If slice.len() is not divisible by channels
• If the slice cannot be reshaped into the desired shape

pub fn from_slice_multi_mut<'a>( slice: &'a mut [T], channels: usize, ) -> AudioData<'a, T>

Creates multi-channel AudioData from a mutable slice with specified channel count (borrowed).

Panics

• If slice.len() is not divisible by channels
• If the slice cannot be reshaped into the desired shape

pub fn from_vec(vec: Vec<T>) -> AudioData<'static, T>

Creates mono AudioData from a Vec (owned).

pub fn from_vec_multi(vec: Vec<T>, channels: usize) -> AudioData<'static, T>

Creates multi-channel AudioData from a Vec with specified channel count (owned).

Panics

• If vec.len() is not divisible by channels

impl<'a, T: AudioSample> AudioData<'a, T>

pub fn into_owned<'b>(self) -> AudioData<'b, T>

Converts this AudioData to owned data.

pub fn from_borrowed<'b>(&'b self) -> AudioData<'b, T>

Creates a new AudioData instance from borrowed data.

pub const fn from_borrowed_array1<'b>( view: ArrayView1<'b, T>, ) -> AudioData<'b, T>

Creates AudioData from a borrowed mono array view.

pub const fn from_borrowed_array1_mut<'b>( view: ArrayViewMut1<'b, T>, ) -> AudioData<'b, T>

Creates AudioData from a borrowed mutable mono array view.

pub const fn from_borrowed_array2<'b>( view: ArrayView2<'b, T>, ) -> AudioData<'b, T>

Creates AudioData from a borrowed multi-channel array view.

pub const fn from_borrowed_array2_mut<'b>( view: ArrayViewMut2<'b, T>, ) -> AudioData<'b, T>

Creates AudioData from a borrowed mutable multi-channel array view.

pub fn len(&self) -> usize

Returns the total number of samples in the audio data.

pub fn num_channels(&self) -> usize

Returns the number of channels in the audio data.

pub fn is_empty(&self) -> bool

Returns true if the audio data contains no samples.

pub const fn is_mono(&self) -> bool

Returns true if the audio data is mono (single channel).

pub const fn is_multi_channel(&self) -> bool

Returns true if the audio data has multiple channels.

pub fn shape(&self) -> &[usize]

Returns the shape of the underlying array data.

pub fn samples_per_channel(&self) -> usize

Returns the number of samples per channel.

pub fn mean_axis(&self, axis: Axis) -> Option<Self>

Returns the mean of the audio data along the specified axis.

pub fn as_slice(&self) -> Option<&[T]>

Returns audio data as a slice if contiguous.

pub fn bytes(&self) -> AudioSampleResult<AudioBytes<'_>>

Returns a contiguous byte view when possible, falling back to I24 packing when required.

pub const fn bytes_per_sample(&self) -> usize

Returns the number of bytes per sample for the current sample type.

pub fn into_bytes(&self) -> Vec<u8>

Returns an owned byte buffer.

Note: this always allocates a new Vec<u8>. Use Self::bytes for a potentially zero-copy view.

pub fn as_bytes(&self) -> Vec<u8>

👎Deprecated: use bytes() for borrowed access or into_bytes() for owned bytes

Deprecated: use bytes() for borrowed access or into_bytes() for owned bytes.

pub fn mapv<F, U>(&self, f: F) -> AudioData<'static, U>

where F: Fn(T) -> U, U: AudioSample,

Maps a function over each sample, returning new owned audio data.

pub fn mapv_inplace<F>(&mut self, f: F)

where F: Fn(T) -> T,

Maps a function over each sample in place.

pub fn apply<F>(&mut self, func: F)

where F: Fn(T) -> T,

Applies a function to each sample in place.

pub fn apply_with_index<F>(&mut self, func: F)

where F: Fn(usize, T) -> T,

Applies a function to each sample with its index in place.

pub fn apply_windowed<F>( &mut self, window_size: usize, hop_size: usize, func: F, ) -> AudioSampleResult<()>

where F: Fn(&[T], &[T]) -> Vec<T>,

Applies a windowed function to the audio data with overlap processing.

pub fn apply_to_all_channels<F>(&mut self, f: F)

where F: Fn(T) -> T,

Applies a function to all samples in all channels.

pub fn apply_to_channels<F>(&mut self, channels: &[usize], f: F)

where F: Fn(T) -> T,

Applies a function to samples in specified channels only.

pub fn convert_to<O: AudioSample>(&self) -> AudioData<'static, O>

where T: ConvertTo<O>,

Converts the samples to another sample type.

This is an audio-aware conversion using ConvertTo, so it can clamp and scale as needed for the source/target sample formats.

pub fn to_interleaved_vec(self) -> Vec<T>

Converts the audio data to an interleaved vector, consuming the data.

pub fn as_interleaved_vec(&self) -> Vec<T>

Returns the audio data as an interleaved vector without consuming the data.

Trait Implementations

impl<'a, T: AudioSample> Add<T> for AudioData<'a, T>

type Output = AudioData<'a, T>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<'a, T: AudioSample> Add for AudioData<'a, T>

type Output = AudioData<'a, T>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<'a, T> AddAssign<T> for AudioData<'a, T>

where T: Clone + AudioSample,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<'a, T> AddAssign for AudioData<'a, T>

where T: Clone + AudioSample,

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: AudioSample> Clone for AudioData<'_, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug + AudioSample> Debug for AudioData<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: AudioSample> Div<T> for AudioData<'a, T>

type Output = AudioData<'a, T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<'a, T: AudioSample> Div for AudioData<'a, T>

type Output = AudioData<'a, T>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<'a, T> DivAssign<T> for AudioData<'a, T>

where T: Clone + AudioSample,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<'a, T> DivAssign for AudioData<'a, T>

where T: Clone + AudioSample,

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<'a, T: AudioSample> From<ArrayBase<OwnedRepr<T>, Dim<[usize; 1]>>> for AudioData<'a, T>

fn from(a: Array1<T>) -> Self

Converts to this type from the input type.

impl<'a, T: AudioSample> From<ArrayBase<OwnedRepr<T>, Dim<[usize; 2]>>> for AudioData<'a, T>

fn from(a: Array2<T>) -> Self

Converts to this type from the input type.

impl<'a, T: AudioSample> From<ArrayBase<ViewRepr<&'a T>, Dim<[usize; 1]>>> for AudioData<'a, T>

fn from(arr: ArrayView1<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T: AudioSample> From<ArrayBase<ViewRepr<&'a T>, Dim<[usize; 2]>>> for AudioData<'a, T>

fn from(arr: ArrayView2<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T: AudioSample> From<ArrayBase<ViewRepr<&'a mut T>, Dim<[usize; 1]>>> for AudioData<'a, T>

fn from(arr: ArrayViewMut1<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T: AudioSample> From<ArrayBase<ViewRepr<&'a mut T>, Dim<[usize; 2]>>> for AudioData<'a, T>

fn from(arr: ArrayViewMut2<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T: AudioSample> Index<usize> for AudioData<'a, T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T: AudioSample> Mul<T> for AudioData<'a, T>

type Output = AudioData<'a, T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<'a, T: AudioSample> Mul for AudioData<'a, T>

type Output = AudioData<'a, T>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<'a, T> MulAssign<T> for AudioData<'a, T>

where T: Clone + AudioSample,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<'a, T> MulAssign for AudioData<'a, T>

where T: Clone + AudioSample,

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<'a, T> Neg for AudioData<'a, T>

where T: Neg<Output = T> + AudioSample,

type Output = AudioData<'a, T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<'a, T: PartialEq + AudioSample> PartialEq for AudioData<'a, T>

fn eq(&self, other: &AudioData<'a, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T: AudioSample> Sub<T> for AudioData<'a, T>

type Output = AudioData<'a, T>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<'a, T: AudioSample> Sub for AudioData<'a, T>

type Output = AudioData<'a, T>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<'a, T> SubAssign<T> for AudioData<'a, T>

where T: Clone + AudioSample,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<'a, T> SubAssign for AudioData<'a, T>

where T: Clone + AudioSample,

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<'a, T: AudioSample> StructuralPartialEq for AudioData<'a, T>