Skip to main content

PcmChunk

Struct PcmChunk

pub struct PcmChunk {
    pub pcm: PcmBuf,
    pub meta: PcmMeta,
}

Expand description

PCM chunk containing interleaved audio samples with automatic pool recycling.

The pcm buffer is pool-backed via PcmBuf: when the chunk is dropped, the buffer returns to the global PCM pool for reuse instead of being deallocated.

§Invariants

pcm.len() % channels == 0 (frame-aligned)
spec.channels > 0 and spec.sample_rate > 0
All samples are f32 and interleaved (LRLRLR…)

Fields§

§pcm: PcmBuf§meta: PcmMeta

Implementations§

impl PcmChunk

pub fn new(meta: PcmMeta, pcm: PcmBuf) -> Self

Create a new PcmChunk from a pool-backed buffer.

pub fn frames(&self) -> usize

Number of audio frames in this chunk.

A frame contains one sample per channel.

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

Borrow the raw interleaved sample buffer.

Sugar accessor for &chunk.pcm[..]; the underlying field stays pub for the legacy direct-access call sites that currently rely on Deref<Target = [f32]> semantics of PcmBuf.

pub fn spec(&self) -> PcmSpec

Audio format specification.

Trait Implementations§

impl AsRef<[f32]> for PcmChunk

fn as_ref(&self) -> &[f32]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PcmChunk

fn clone(&self) -> Self

Clone creates a new pool-backed buffer with copied samples.

Each clone gets its own PcmBuf from the global pool, so both original and clone recycle independently on drop.

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for PcmChunk

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

Formats the value using the given formatter. Read more

impl Default for PcmChunk

fn default() -> Self

Returns the “default value” for a type. Read more

impl TryFrom<DecoderChunkOutcome> for PcmChunk

type Error = DecoderChunkOutcome

The type returned in the event of a conversion error.

fn try_from(outcome: DecoderChunkOutcome) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

impl Freeze for PcmChunk

impl !RefUnwindSafe for PcmChunk

impl Send for PcmChunk

impl Sync for PcmChunk

impl Unpin for PcmChunk

impl UnsafeUnpin for PcmChunk

impl !UnwindSafe for PcmChunk

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

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

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

fn into_sample(self) -> T

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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

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

impl<T> MaybeSync for T
where T: Sync,