Skip to main content

AudioClip

Struct AudioClip 

Source
pub struct AudioClip {
    sample_rate: u32,
    channels: u16,
    pcm: Arc<[f32]>,
}
Expand description

Decoded audio: interleaved f32 PCM samples.

Clips are immutable and cheap to clone (sample data is shared). Decoding a file normalizes to MASTER_SAMPLE_RATE and MASTER_CHANNELS; clips built with AudioClip::from_pcm may carry any rate/channels and the mixer adapts them on the fly.

Fields§

§sample_rate: u32§channels: u16§pcm: Arc<[f32]>

Implementations§

Source§

impl AudioClip

Source

pub fn from_pcm( pcm: impl Into<Arc<[f32]>>, sample_rate: u32, channels: u16, ) -> Self

Build a clip from interleaved PCM samples.

Source

pub fn sine(freq: f64, secs: f64, amplitude: f64) -> Self

A mono sine tone, mainly for tests and self-contained examples.

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self, AudioError>

Available on crate feature audio-decode only.

Decode audio bytes in memory (requires the audio-decode feature).

Any format symphonia supports decodes: WAV, MP3, FLAC, AAC/M4A, Ogg Vorbis. Output is normalized to MASTER_SAMPLE_RATE and MASTER_CHANNELS — other sample rates are resampled with rubato’s FFT resampler, mono is duplicated to stereo, and beyond-stereo channel layouts keep their front left/right pair.

This is the whole-file entry point that works everywhere std::io does, including wasm; AudioClip::from_file is a thin wrapper.

Source

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, AudioError>

Available on crate feature audio-decode only.

Decode an audio file (requires the audio-decode feature).

Pure-Rust decoding via symphonia — no ffmpeg binary on PATH. See AudioClip::from_bytes for the supported formats and the normalization applied to the output.

Source

pub fn sample_rate(&self) -> u32

Sample rate of the PCM data.

Source

pub fn channels(&self) -> u16

Channel count of the interleaved PCM data.

Source

pub fn pcm(&self) -> &Arc<[f32]> ⓘ

The interleaved PCM samples.

Source

pub fn duration_secs(&self) -> f64

Duration in seconds.

Source

fn frames(&self) -> usize

Trait Implementations§

Source§

impl Clone for AudioClip

Source§

fn clone(&self) -> AudioClip

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 AudioClip

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
§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Discard for T

Source§

fn discard(&self)

Simply returns ()
Source§

impl<T> DynClone for T
where T: Clone,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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

impl<T> IntoResult<T> for T

§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

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

Source§

fn transformed<G>(self, transform: G) -> Transformed<Self, G>

Return self wrapped with transform stored exactly as G.
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> With for T

Source§

fn with(self, f: impl Fn(&mut Self)) -> Self
where Self: Sized,

Mutating a value in place
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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