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

A simple limiter with standard threshold and release time controls, featuring two compressors and a hard clipper at 0 dB. More...

Public Member Functions

 Limiter ()=default
 Constructor. More...
 
void setThreshold (SampleType newThreshold)
 Sets the threshold in dB of the limiter. More...
 
void setRelease (SampleType newRelease)
 Sets the release time in milliseconds of the limiter. 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::Limiter< SampleType >

A simple limiter with standard threshold and release time controls, featuring two compressors and a hard clipper at 0 dB.

Constructor & Destructor Documentation

◆ Limiter()

template<typename SampleType >
dsp::Limiter< SampleType >::Limiter ( )
default

Constructor.

Member Function Documentation

◆ setThreshold()

template<typename SampleType >
void dsp::Limiter< SampleType >::setThreshold ( SampleType  newThreshold)

Sets the threshold in dB of the limiter.

◆ setRelease()

template<typename SampleType >
void dsp::Limiter< SampleType >::setRelease ( SampleType  newRelease)

Sets the release time in milliseconds of the limiter.

◆ prepare()

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

Initialises the processor.

◆ reset()

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

Resets the internal state variables of the processor.

◆ process()

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

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

References FloatVectorOperations::clip(), int(), and jassert.


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