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

A processor to apply standard attack / release ballistics to an input signal. More...

Public Types

using LevelCalculationType = BallisticsFilterLevelCalculationType
 

Public Member Functions

 BallisticsFilter ()
 Constructor. More...
 
void setAttackTime (SampleType attackTimeMs)
 Sets the attack time in ms. More...
 
void setReleaseTime (SampleType releaseTimeMs)
 Sets the release time in ms. More...
 
void setLevelCalculationType (LevelCalculationType newCalculationType)
 Sets how the filter levels are calculated. More...
 
void prepare (const ProcessSpec &spec)
 Initialises the filter. More...
 
void reset ()
 Resets the internal state variables of the filter. More...
 
void reset (SampleType initialValue)
 Resets the internal state variables of the filter to the given initial value. More...
 
template<typename ProcessContext >
void process (const ProcessContext &context) noexcept
 Processes the input and output samples supplied in the processing context. More...
 
SampleType processSample (int channel, SampleType inputValue)
 Processes one sample at a time on a given channel. More...
 
void snapToZero () noexcept
 Ensure that the state variables are rounded to zero if the state variables are denormals. More...
 

Detailed Description

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

A processor to apply standard attack / release ballistics to an input signal.

This is useful in dynamics processors, envelope followers, modulated audio effects and for smoothing animation in data visualisation.

Member Typedef Documentation

◆ LevelCalculationType

template<typename SampleType>
using dsp::BallisticsFilter< SampleType >::LevelCalculationType = BallisticsFilterLevelCalculationType

Constructor & Destructor Documentation

◆ BallisticsFilter()

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

Constructor.

Member Function Documentation

◆ setAttackTime()

template<typename SampleType>
void dsp::BallisticsFilter< SampleType >::setAttackTime ( SampleType  attackTimeMs)

Sets the attack time in ms.

Attack times less than 0.001 ms will be snapped to zero and very long attack times will eventually saturate depending on the numerical precision used.

◆ setReleaseTime()

template<typename SampleType>
void dsp::BallisticsFilter< SampleType >::setReleaseTime ( SampleType  releaseTimeMs)

Sets the release time in ms.

Release times less than 0.001 ms will be snapped to zero and very long release times will eventually saturate depending on the numerical precision used.

◆ setLevelCalculationType()

template<typename SampleType>
void dsp::BallisticsFilter< SampleType >::setLevelCalculationType ( LevelCalculationType  newCalculationType)

Sets how the filter levels are calculated.

Level calculation in digital envelope followers is usually performed using peak detection with a rectifier function (like std::abs) and filtering, which returns an envelope dependant on the peak or maximum values of the signal amplitude.

To perform an estimation of the average value of the signal you can use an RMS (root mean squared) implementation of the ballistics filter instead. This is useful in some compressor and noise-gate designs, or in specific types of volume meters.

◆ prepare()

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

Initialises the filter.

◆ reset() [1/2]

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

Resets the internal state variables of the filter.

◆ reset() [2/2]

template<typename SampleType>
void dsp::BallisticsFilter< SampleType >::reset ( SampleType  initialValue)

Resets the internal state variables of the filter to the given initial value.

◆ process()

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

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

References jassert, dsp::BallisticsFilter< SampleType >::processSample(), and dsp::BallisticsFilter< SampleType >::snapToZero().

◆ processSample()

template<typename SampleType>
SampleType dsp::BallisticsFilter< SampleType >::processSample ( int  channel,
SampleType  inputValue 
)

Processes one sample at a time on a given channel.

Referenced by dsp::BallisticsFilter< SampleType >::process().

◆ snapToZero()

template<typename SampleType>
void dsp::BallisticsFilter< SampleType >::snapToZero ( )
noexcept

Ensure that the state variables are rounded to zero if the state variables are denormals.

This is only needed if you are doing sample by sample processing.

Referenced by dsp::BallisticsFilter< SampleType >::process().


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