BlockLayout

Enum BlockLayout 

Source
pub enum BlockLayout {
    Interleaved,
    Planar,
    Sequential,
}
Expand description

Represents the memory layout of audio data returned by AudioBlock::layout.

This enum allows consumers to determine the underlying data layout, which is essential for:

  • Direct raw data access
  • Performance optimizations
  • Efficient interfacing with external audio APIs

§Examples of layouts

Each variant represents a common pattern used in audio processing.

Variants§

§

Interleaved

Samples from different channels alternate in sequence.

Format: [ch0, ch1, ..., ch0, ch1, ..., ch0, ch1, ...]

This layout is common in consumer audio formats and some APIs.

§

Planar

Channels are separated into discrete chunks of memory.

Format: [[ch0, ch0, ch0, ...], [ch1, ch1, ch1, ...]]

Useful for operations that work on one channel at a time.

§

Sequential

All samples from one channel appear consecutively before the next channel.

Format: [ch0, ch0, ch0, ..., ch1, ch1, ch1, ...]

Also known as “planar” format in some audio libraries.

Trait Implementations§

Source§

impl Debug for BlockLayout

Source§

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

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

impl PartialEq for BlockLayout

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for BlockLayout

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> 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<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

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.