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

A simple chorus DSP widget that modulates the delay of a delay line in order to create sweeping notches in the magnitude frequency response. More...

Public Member Functions

 Chorus ()
 Constructor. More...
 
void setRate (SampleType newRateHz)
 Sets the rate (in Hz) of the LFO modulating the chorus delay line. More...
 
void setDepth (SampleType newDepth)
 Sets the volume of the LFO modulating the chorus delay line (between 0 and 1). More...
 
void setCentreDelay (SampleType newDelayMs)
 Sets the centre delay in milliseconds of the chorus delay line modulation. More...
 
void setFeedback (SampleType newFeedback)
 Sets the feedback volume (between -1 and 1) of the chorus delay line. More...
 
void setMix (SampleType newMix)
 Sets the amount of dry and wet signal in the output of the chorus (between 0 for full dry and 1 for full wet). More...
 
void prepare (const ProcessSpec &spec)
 Initialises the processor. More...
 
void reset ()
 Resets the internal state variables of the processor. More...
 
template<typename ProcessContext >
void process (const ProcessContext &context) noexcept
 Processes the input and output samples supplied in the processing context. More...
 

Detailed Description

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

A simple chorus DSP widget that modulates the delay of a delay line in order to create sweeping notches in the magnitude frequency response.

This audio effect can be controlled via the speed and depth of the LFO controlling the frequency response, a mix control, a feedback control, and the centre delay of the modulation.

Note: To get classic chorus sounds try to use a centre delay time around 7-8 ms with a low feeback volume and a low depth. This effect can also be used as a flanger with a lower centre delay time and a lot of feedback, and as a vibrato effect if the mix value is 1.

Constructor & Destructor Documentation

◆ Chorus()

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

Constructor.

Member Function Documentation

◆ setRate()

template<typename SampleType >
void dsp::Chorus< SampleType >::setRate ( SampleType  newRateHz)

Sets the rate (in Hz) of the LFO modulating the chorus delay line.

This rate must be lower than 100 Hz.

◆ setDepth()

template<typename SampleType >
void dsp::Chorus< SampleType >::setDepth ( SampleType  newDepth)

Sets the volume of the LFO modulating the chorus delay line (between 0 and 1).

◆ setCentreDelay()

template<typename SampleType >
void dsp::Chorus< SampleType >::setCentreDelay ( SampleType  newDelayMs)

Sets the centre delay in milliseconds of the chorus delay line modulation.

This delay must be between 1 and 100 ms.

◆ setFeedback()

template<typename SampleType >
void dsp::Chorus< SampleType >::setFeedback ( SampleType  newFeedback)

Sets the feedback volume (between -1 and 1) of the chorus delay line.

Negative values can be used to get specific chorus sounds.

◆ setMix()

template<typename SampleType >
void dsp::Chorus< SampleType >::setMix ( SampleType  newMix)

Sets the amount of dry and wet signal in the output of the chorus (between 0 for full dry and 1 for full wet).

◆ prepare()

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

Initialises the processor.

◆ reset()

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

Resets the internal state variables of the processor.

◆ process()

template<typename SampleType >
template<typename ProcessContext >
void dsp::Chorus< SampleType >::process ( const ProcessContext &  context)
noexcept

Processes the input and output samples supplied in the processing context.

References dsp::AudioBlock< SampleType >::getSubBlock(), AudioBuffer< Type >::getWritePointer(), jassert, and jmax().


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