Struct knyst::gen::dynamics::randja_compressor::RandjaCompressor

pub struct RandjaCompressor { /* private fields */ }

Randja compressor ported from https://www.musicdsp.org/en/latest/Synthesis/272-randja-compressor.html?highlight=compressor

Implementations

impl RandjaCompressor

pub fn new() -> Self

pub fn set_threshold(&mut self, threshold: Sample) -> &mut Self

Set the gain threshold in amplitude (0.0, 1.0]

pub fn set_ratio(&mut self, ratio: f32)

Sets the ratio; ‘value’ must be in range [0.0; 1.0] with 0.0 representing a oo:1 ratio, 0.5 a 2:1 ratio; 1.0 a 1:1 ratio and so on.

pub fn set_attack(&mut self, attack: f32)

Sets the attack time; ‘value’ gives the attack time in samples

pub fn set_release(&mut self, release: Sample)

Sets the release time; ‘value’ gives the release time in samples

pub fn set_output(&mut self, output: Sample)

Sets the output gain; ‘value’ represents the gain, where 0dBFS is 1.0 (see set_threshold())

pub fn reset(&mut self)

Resets the internal state of the compressor (gain reduction)

pub fn process( &mut self, input_left: &[Sample], input_right: &[Sample], output_left: &mut [Sample], output_right: &mut [Sample] ) -> GenState

impl RandjaCompressor

pub fn upload(self) -> Handle<RandjaCompressorHandle>

Upload the Gen to the currently selected Graph and return a handle

Trait Implementations

impl Gen for RandjaCompressor

fn process( &mut self, ctx: GenContext<'_, '_>, resources: &mut Resources ) -> GenState

The input and output buffers are both indexed using [in/out_index][sample_index].

fn num_inputs(&self) -> usize

The number of inputs this Gen takes. Determines how big the input buffer is.

fn num_outputs(&self) -> usize

The number of outputs this Gen produces. Determines how big the output buffer is.

fn input_desc(&self, input: usize) -> &'static str

Return a label for a given input channel index. This sets the label in the Connection API.

fn output_desc(&self, output: usize) -> &'static str

Return a label for a given output channel index. This sets the label in the Connection API.

fn init(&mut self, _block_size: usize, _sample_rate: Sample, _node_id: NodeId)

Initialize buffers etc. Default: noop

fn name(&self) -> &'static str

A name identifying this Gen.