Trait dsp::Node [−] [src]

pub trait Node<F> where F: Frame {
    fn audio_requested(&mut self, buffer: &mut [F], sample_hz: f64);

    fn dry(&self) -> F::Sample::Float { ... }
    fn wet(&self) -> F::Sample::Float { ... }
}

Types to be used as a Node within the DSP Graph.

Required Methods

fn audio_requested(&mut self, buffer: &mut [F], sample_hz: f64)

Request audio from the Node given some sample_hz (aka sample rate in hertz). If the Node has no inputs, the buffer will be zeroed. If the Node has some inputs, the buffer will consist of the inputs summed together.

Any source/generator type nodes should simply render straight to the buffer. Any effects/processor type nodes should mutate the buffer directly.

Provided Methods

fn dry(&self) -> F::Sample::Float

Following the call to the Node's audio_requested method, the Graph will sum together some of the original (dry) signal with some of the processed (wet) signal.

This method specifies the amount of the dry signal to be used (0.0 ... 1.0).

By default, we don't want any of the original signal. This default is useful for generator types, where the original signal is often 0.0 anyway.

For processors and effects, this should be overridden to return the amount of the non-processed signal that should be summed with the processed.

Note: overriding this method will be more efficient than implementing your own dry/wet summing in audio_requested, as Graph reserves a single buffer especially for this.

fn wet(&self) -> F::Sample::Float

Following the call to the Node's audio_requested method, the Graph will sum together some of the original (dry) signal with some of the processed (wet) signal.

This method specifies the amount of the wet signal to be used (0.0 ... 1.0).

By default, we want only the fully wet signal (1.0). This default is useful for generator types where we are generating a brand new signal.

For processors and effects, this should be overridden to return the amount of the processed signal that should be summed with the non-processed.

Note: overriding this method will be more efficient than implementing your own dry/wet summing in audio_requested, as Graph reserves a single buffer especially for this.

Implementors