Struct NdarrayAdapter 

pub struct NdarrayAdapter<U, O> { /* private fields */ }

A wrapper implementing the audioadapter traits for a two-dimensional ndarray array.

The axis order O records whether the array is channel-major (ChannelsFrames) or frame-major (FramesChannels).

Implementations

impl<S> NdarrayAdapter<ArrayBase<S, Ix2>, ChannelsFrames>

where S: Data,

pub fn new_channels_frames(array: ArrayBase<S, Ix2>) -> Self

Wrap an array shaped (channels, frames).

impl<S> NdarrayAdapter<ArrayBase<S, Ix2>, FramesChannels>

where S: Data,

pub fn new_frames_channels(array: ArrayBase<S, Ix2>) -> Self

Wrap an array shaped (frames, channels).

impl<U, O> NdarrayAdapter<U, O>

pub fn into_inner(self) -> U

Consume the adapter and return the wrapped array.

pub fn inner(&self) -> &U

Get a reference to the wrapped array.

Trait Implementations

impl<S, O> Adapter<<S as RawData>::Elem> for NdarrayAdapter<ArrayBase<S, Ix2>, O>

where S: Data, S::Elem: Clone, O: AxisOrder,

fn channels(&self) -> usize

Get the number of channels stored in this buffer.

fn frames(&self) -> usize

Get the number of frames stored in this buffer.

unsafe fn read_sample_unchecked(&self, channel: usize, frame: usize) -> S::Elem

Read the sample at a given combination of frame and channel.

fn copy_from_channel_to_slice( &self, channel: usize, skip: usize, slice: &mut [S::Elem], ) -> usize

Copy values from a channel of self to a slice. The skip argument is the offset in samples from where the first value will be copied. If the target slice is longer than the available number of values in the channel, then only the available number of samples will be copied.

fn read_sample(&self, channel: usize, frame: usize) -> Option<T>

Read the sample at a given combination of frame and channel. Returns None if the frame or channel is out of bounds of the buffer.

fn copy_from_frame_to_slice( &self, frame: usize, skip: usize, slice: &mut [T], ) -> usize

Copy values from a frame of self to a slice. The skip argument is the offset in samples from where the first value will be copied. If the slice is longer than the available number of values in the frame, then only the available number of samples will be copied.

impl<S, O> AdapterMut<<S as RawData>::Elem> for NdarrayAdapter<ArrayBase<S, Ix2>, O>

where S: DataMut, S::Elem: Clone, O: AxisOrder,

unsafe fn write_sample_unchecked( &mut self, channel: usize, frame: usize, value: &S::Elem, ) -> bool

Write a sample to the given combination of frame and channel. Returns a boolean indicating if the sample value was clipped during conversion. Implementations that do not perform any conversion always return false.

fn copy_from_slice_to_channel( &mut self, channel: usize, skip: usize, slice: &[S::Elem], ) -> (usize, usize)

Copies values from a slice into a channel of self. The skip argument is the offset into the channel to where the first value will be copied. If the slice is longer than the available space in the channel, then only the number of samples that fit will be copied.

fn write_sample( &mut self, channel: usize, frame: usize, value: &T, ) -> Option<bool>

Write a sample to the given combination of frame and channel. Returns a boolean indicating if the sample value was clipped during conversion. Implementations that do not perform any conversion always return false. Returns None if the frame or channel is out of bounds of the buffer.

fn copy_from_slice_to_frame( &mut self, frame: usize, skip: usize, slice: &[T], ) -> (usize, usize)

Copy values from a slice into a frame of self. The skip argument is the offset into the frame to where the first value will be copied. If the slice is longer than the available space in the frame, then only the number of samples that fit will be copied.

fn copy_from_other_to_channel( &mut self, other: &dyn Adapter<T>, other_channel: usize, self_channel: usize, other_skip: usize, self_skip: usize, take: usize, ) -> Option<usize>

Copy values from a channel of another Adapter. The self_skip and other_skip arguments are the offsets in frames for where copying starts in the two channels. The method copies take values.

fn copy_from_other( &mut self, other: &dyn Adapter<T>, other_skip: usize, self_skip: usize, take: usize, ) -> Option<usize>

Copy values from another Adapter into self. The self_skip and other_skip arguments are the offsets in frames for where copying starts in the two buffers. The method copies take frames for all channels in other.

fn fill_channel_with(&mut self, channel: usize, value: &T) -> Option<()>

Write the provided value to every sample in a channel. Can be used to clear a channel by writing zeroes, or to initialize each sample to a certain value. Returns None if called with an invalid channel number.

fn fill_frame_with(&mut self, frame: usize, value: &T) -> Option<()>

Write the provided value to every sample in a frame. Can be used to clear a frame by writing zeroes, or to initialize each sample to a certain value. Returns None if called with an invalid frame number.

fn fill_frames_with( &mut self, start: usize, count: usize, value: &T, ) -> Option<usize>

Write the provided value to every sample in a range of frames. Can be used to clear a range of frames by writing zeroes, or to initialize each sample to a certain value. Returns None if called with a too large range.

fn fill_with(&mut self, value: &T)

Write the provided value to every sample in the entire buffer. Can be used to clear a buffer by writing zeroes, or to initialize each sample to a certain value.

fn copy_frames_within( &mut self, src: usize, dest: usize, count: usize, ) -> Option<usize>

Copy frames within the buffer. Copying is performed for all channels. Copies count frames, from the range src..src+count, to the range dest..dest+count. The two regions are allowed to overlap. The default implementation copies by calling the read and write methods, while type specific implementations can use more efficient methods.

fn copy_sample_within( &mut self, source_channel: usize, source_frame: usize, target_channel: usize, target_frame: usize, ) -> bool

Copy a single sample within the buffer. Copies from the source to the target frame and channel. Returns true if the sample was copied, and false if not, which may happen if the source or target frame or channel was out of bounds. The default implementation copies by calling the read and write methods, while type specific implementations can use more efficient methods.

fn swap_samples( &mut self, channel_a: usize, frame_a: usize, channel_b: usize, frame_b: usize, ) -> bool

Swap two samples in the buffer. Returns true if the samples were swapped, and false if not, which may happen if the channel or frame for either sample was out of bounds. The default implementation copies by calling the read and write methods, while type specific implementations can use more efficient methods.