Public Types | Public Member Functions | List of all members
dsp::DryWetMixer< SampleType > Class Template Reference

A processor to handle dry/wet mixing of two audio signals, where the wet signal may have additional latency. More...

Public Types

using MixingRule = DryWetMixingRule
 

Public Member Functions

 DryWetMixer ()
 Default constructor. More...
 
 DryWetMixer (int maximumWetLatencyInSamples)
 Constructor. More...
 
void setMixingRule (MixingRule newRule)
 Sets the mix rule. More...
 
void setWetMixProportion (SampleType newWetMixProportion)
 Sets the current dry/wet mix proportion, with 0.0 being full dry and 1.0 being fully wet. More...
 
void setWetLatency (SampleType wetLatencyInSamples)
 Sets the relative latency of the wet signal path compared to the dry signal path, and thus the amount of latency compensation that will be added to the dry samples in this processor. More...
 
void prepare (const ProcessSpec &spec)
 Initialises the processor. More...
 
void reset ()
 Resets the internal state variables of the processor. More...
 
void pushDrySamples (const AudioBlock< const SampleType > drySamples)
 Copies the dry path samples into an internal delay line. More...
 
void mixWetSamples (AudioBlock< SampleType > wetSamples)
 Mixes the supplied wet samples with the latency-compensated dry samples from pushDrySamples. More...
 

Detailed Description

template<typename SampleType>
class dsp::DryWetMixer< SampleType >

A processor to handle dry/wet mixing of two audio signals, where the wet signal may have additional latency.

Once a DryWetMixer object is configured, push the dry samples using pushDrySamples and mix into the fully wet samples using mixWetSamples.

Member Typedef Documentation

◆ MixingRule

template<typename SampleType >
using dsp::DryWetMixer< SampleType >::MixingRule = DryWetMixingRule

Constructor & Destructor Documentation

◆ DryWetMixer() [1/2]

template<typename SampleType >
dsp::DryWetMixer< SampleType >::DryWetMixer ( )

Default constructor.

◆ DryWetMixer() [2/2]

template<typename SampleType >
dsp::DryWetMixer< SampleType >::DryWetMixer ( int  maximumWetLatencyInSamples)
explicit

Constructor.

Member Function Documentation

◆ setMixingRule()

template<typename SampleType >
void dsp::DryWetMixer< SampleType >::setMixingRule ( MixingRule  newRule)

Sets the mix rule.

◆ setWetMixProportion()

template<typename SampleType >
void dsp::DryWetMixer< SampleType >::setWetMixProportion ( SampleType  newWetMixProportion)

Sets the current dry/wet mix proportion, with 0.0 being full dry and 1.0 being fully wet.

◆ setWetLatency()

template<typename SampleType >
void dsp::DryWetMixer< SampleType >::setWetLatency ( SampleType  wetLatencyInSamples)

Sets the relative latency of the wet signal path compared to the dry signal path, and thus the amount of latency compensation that will be added to the dry samples in this processor.

◆ prepare()

template<typename SampleType >
void dsp::DryWetMixer< SampleType >::prepare ( const ProcessSpec spec)

Initialises the processor.

◆ reset()

template<typename SampleType >
void dsp::DryWetMixer< SampleType >::reset ( )

Resets the internal state variables of the processor.

◆ pushDrySamples()

template<typename SampleType >
void dsp::DryWetMixer< SampleType >::pushDrySamples ( const AudioBlock< const SampleType >  drySamples)

Copies the dry path samples into an internal delay line.

◆ mixWetSamples()

template<typename SampleType >
void dsp::DryWetMixer< SampleType >::mixWetSamples ( AudioBlock< SampleType >  wetSamples)

Mixes the supplied wet samples with the latency-compensated dry samples from pushDrySamples.

Parameters
wetSamplesInput: The AudioBlock references fully wet samples. Output: The AudioBlock references the wet samples mixed with the latency compensated dry samples.
See also
pushDrySamples

The documentation for this class was generated from the following file: