Struct hexodsp::dsp::ProcBuf

pub struct ProcBuf(*mut [f32; 128]);

A processing buffer with the exact right maximum size. This is an unsafe abstraction, and should be used with a lot of care. You will have to manually free the buffer, and take care if you make copies of these.

This is an abstraction for the inner most DSP processing, where I don’t want to spend a nanosecond too much on accessing buffers.

The main user is crate::nodes::NodeProg, which takes extra care of allocating and managing the ProcBuf instances.

 let mut buf = hexodsp::dsp::ProcBuf::new();

 buf.write(0, 0.42);
 buf.write(1, 0.13);
 buf.write(2, 0.37);

 assert_eq!(((buf.read(0) * 100.0).floor()), 42.0);
 assert_eq!(((buf.read(1) * 100.0).floor()), 13.0);
 assert_eq!(((buf.read(2) * 100.0).floor()), 37.0);

 buf.free(); // YOU MUST DO THIS!

Tuple Fields

0: *mut [f32; 128]

Implementations

impl ProcBuf

pub fn new() -> Self

Creates a new ProcBuf with the size of MAX_BLOCK_SIZE.

pub fn null() -> Self

Create a new null ProcBuf, that can’t be used.

impl ProcBuf

pub fn write(&mut self, idx: usize, v: f32)

Writes the sample v at idx.

pub fn write_from(&mut self, slice: &[f32])

Writes the samples from slice to this ProcBuf. Be careful, the slice must not exceed MAX_BLOCK_SIZE, or else you will get UB.

pub fn read(&self, idx: usize) -> f32

Reads a sample at idx. Be careful to not let the idx land outside of MAX_BLOCK_SIZE.

pub fn slice(&self, len: usize) -> &[f32]

Returns a mutable slice to the inner buffer. len must not exceed MAX_BLOCK_SIZE.

pub fn slice_mut(&mut self, len: usize) -> &mut [f32]

Returns a mutable slice to the inner buffer. len must not exceed MAX_BLOCK_SIZE.

pub fn fill(&mut self, v: f32)

Fills the ProcBuf with the sample v.

pub fn is_null(&self) -> bool

Checks if this is a ProcBuf::null.

pub fn free(&self)

Deallocates the ProcBuf. If you still keep around other copies of this ProcBuf, you will most likely land in UB land.

Trait Implementations

impl Clone for ProcBuf

fn clone(&self) -> ProcBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProcBuf

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

Formats the value using the given formatter.

impl Display for ProcBuf

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

Formats the value using the given formatter.

impl MonitorSource for &ProcBuf

fn copy_to(&self, len: usize, slice: &mut [f32])

Copies the contents of this ProcBuf to the given slice.

• len - the number of samples to copy from this ProcBuf.
• slice - the slice to copy to.

impl Copy for ProcBuf

impl Send for ProcBuf

impl Sync for ProcBuf