Struct rsynth::buffer::AudioChunk

pub struct AudioChunk<S> { /* fields omitted */ }

A buffer representing a fixed amount of samples for a fixed amount of audio channels.

An AudioChunk “owns” all its samples.

Implementations

impl<S> AudioChunk<S>

pub fn new(number_of_channels: usize) -> Self

Create a new AudioChunk.

Panics

Panics if number_of_channels == 0.

Note: cannot be used in a real-time context

This method allocates memory and cannot be used in a real-time context.

pub fn zero(number_of_channels: usize, number_of_frames: usize) -> Self where
    S: Zero, 

Note: cannot be used in a real-time context

This method allocates memory and cannot be used in a real-time context.

pub fn from_channels(channels: Vec<Vec<S>>) -> Self

pub fn from_interlaced_iterator<I>(
    iterator: I,
    number_of_channels: usize
) -> Self where
    I: Iterator<Item = S>,
    S: Copy, 

Panics

Panics if number_of_channels == 0. Panics if the number of elements yielded by the iterator is not an integer multiple of number_of_channels.

pub fn interlaced<'a>(&'a self) -> InterlacedSampleIterator<'a, S> where
    S: Copy, 

Create an interlaced iterator from an AudioChunk

Example

#[macro_use]
extern crate rsynth;
let chunk = audio_chunk![[0, 1, 2], [3, 4, 5]];
let iterator = chunk.interlaced();
let interlaced: Vec<_> = iterator.collect();
assert_eq!(interlaced, vec![0, 3, 1, 4, 2, 5]);

pub fn with_capacity(number_of_channels: usize, capacity: usize) -> Self

Create a new AudioChunk in which each channel has the given capacity. This allows to append capacity frames to the AudioChunk (e.g. by calling append_sliced_chunk).

Note: cannot be used in a real-time context

This method allocates memory and cannot be used in a real-time context.

pub fn channels(&self) -> &Vec<Vec<S>>

pub fn number_of_channels(&self) -> usize

Return the number of channels.

pub fn append_sliced_chunk(&mut self, chunk: &[&[S]]) where
    S: Clone, 

Note about using in a real-time context

This method will allocate memory if the capacity of the chunk is exceeded and cannot be used in a real-time context in that case.

pub fn inner(self) -> Vec<Vec<S>>

pub fn as_slices<'a>(&'a self) -> Vec<&[S]>

Note: cannot be used in a real-time context

This method allocates memory and cannot be used in a real-time context.

pub fn as_mut_slices<'a>(&'a mut self) -> Vec<&mut [S]>

Note: cannot be used in a real-time context

This method allocates memory and cannot be used in a real-time context.

pub fn split(self, number_of_frames_per_chunk: usize) -> Vec<Self>

Note: cannot be used in a real-time context

This method allocates memory and cannot be used in a real-time context.

Trait Implementations

impl<S: Clone> Clone for AudioChunk<S>

fn clone(&self) -> AudioChunk<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for AudioChunk<S>

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

Formats the value using the given formatter.

impl<S: Eq> Eq for AudioChunk<S>

impl<S: PartialEq> PartialEq<AudioChunk<S>> for AudioChunk<S>

fn eq(&self, other: &AudioChunk<S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &AudioChunk<S>) -> bool

This method tests for !=.

impl<S> StructuralEq for AudioChunk<S>

impl<S> StructuralPartialEq for AudioChunk<S>