A utility class for values that need smoothing to avoid audio glitches. More...
#include <juce_SmoothedValue.h>
Public Types | |
using | FloatType = typename FloatTypeHelper< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::Type |
Public Member Functions | |
SmoothedValue () noexcept | |
Constructor. More... | |
SmoothedValue (FloatType initialValue) noexcept | |
Constructor. More... | |
void | applyGain (AudioBuffer< FloatType > &buffer, int numSamples) noexcept |
Applies a smoothed gain to a buffer. More... | |
void | applyGain (FloatType *samples, int numSamples) noexcept |
Applies a smoothed gain to a stream of samples S[i] *= gain. More... | |
void | applyGain (FloatType *samplesOut, const FloatType *samplesIn, int numSamples) noexcept |
Computes output as a smoothed gain applied to a stream of samples. More... | |
FloatType | getCurrentValue () const noexcept |
Returns the current value of the ramp. More... | |
FloatType | getNextValue () noexcept |
Compute the next value. More... | |
FloatType | getTargetValue () const noexcept |
Returns the target value towards which the smoothed value is currently moving. More... | |
bool | isSmoothing () const noexcept |
Returns true if the current value is currently being interpolated. More... | |
void | reset (double sampleRate, double rampLengthInSeconds) noexcept |
Reset to a new sample rate and ramp length. More... | |
void | reset (int numSteps) noexcept |
Set a new ramp length directly in samples. More... | |
void | setCurrentAndTargetValue (FloatType newValue) |
Sets the current value and the target value. More... | |
void | setTargetValue (FloatType newValue) noexcept |
Set the next value to ramp towards. More... | |
FloatType | skip (int numSamples) noexcept |
Skip the next numSamples samples. More... | |
Protected Attributes | |
int | countdown |
FloatType | currentValue |
FloatType | target |
Private Types | |
template<typename T > | |
using | LinearVoid = typename std::enable_if< std::is_same< T, ValueSmoothingTypes::Linear >::value, void >::type |
template<typename T > | |
using | MultiplicativeVoid = typename std::enable_if< std::is_same< T, ValueSmoothingTypes::Multiplicative >::value, void >::type |
Private Member Functions | |
FloatType | getNextSmoothedValue () noexcept |
template<typename T = SmoothingType> | |
LinearVoid< T > | setNextValue () noexcept |
template<typename T = SmoothingType> | |
MultiplicativeVoid< T > | setNextValue () noexcept |
template<typename T = SmoothingType> | |
MultiplicativeVoid< T > | setStepSize () |
template<typename T = SmoothingType> | |
LinearVoid< T > | setStepSize () noexcept |
template<typename T = SmoothingType> | |
MultiplicativeVoid< T > | skipCurrentValue (int numSamples) |
template<typename T = SmoothingType> | |
LinearVoid< T > | skipCurrentValue (int numSamples) noexcept |
Private Attributes | |
FloatType | step = FloatType() |
int | stepsToTarget = 0 |
A utility class for values that need smoothing to avoid audio glitches.
A ValueSmoothingTypes::Linear template parameter selects linear smoothing, which increments the SmoothedValue linearly towards its target value.
A ValueSmoothingTypes::Multiplicative template parameter selects multiplicative smoothing increments towards the target value.
Multiplicative smoothing is useful when you are dealing with exponential/logarithmic values like volume in dB or frequency in Hz. For example a 12 step ramp from 440.0 Hz (A4) to 880.0 Hz (A5) will increase the frequency with an equal temperament tuning across the octave. A 10 step smoothing from 1.0 (0 dB) to 3.16228 (10 dB) will increase the value in increments of 1 dB.
Note that when you are using multiplicative smoothing you cannot ever reach a target value of zero!
@tags{Audio}
|
inherited |
|
private |
|
private |
|
inlinenoexcept |
Constructor.
|
inlinenoexcept |
Constructor.
|
inlinenoexceptinherited |
Applies a smoothed gain to a buffer.
|
inlinenoexceptinherited |
Applies a smoothed gain to a stream of samples S[i] *= gain.
samples | Pointer to a raw array of samples |
numSamples | Length of array of samples |
|
inlinenoexceptinherited |
Computes output as a smoothed gain applied to a stream of samples.
Sout[i] = Sin[i] * gain
samplesOut | A pointer to a raw array of output samples |
samplesIn | A pointer to a raw array of input samples |
numSamples | The length of the array of samples |
|
inlinenoexceptinherited |
Returns the current value of the ramp.
|
inlineprivatenoexceptinherited |
|
inlinenoexcept |
Compute the next value.
Referenced by juce::dsp::Gain< FloatType >::process(), juce::dsp::Bias< FloatType >::process(), juce::dsp::Oscillator< SampleType >::process(), juce::Reverb::processMono(), juce::dsp::Gain< FloatType >::processSample(), juce::dsp::Bias< FloatType >::processSample(), juce::dsp::Oscillator< SampleType >::processSample(), and juce::Reverb::processStereo().
|
inlinenoexceptinherited |
Returns the target value towards which the smoothed value is currently moving.
|
inlinenoexceptinherited |
Returns true if the current value is currently being interpolated.
|
inlinenoexcept |
Reset to a new sample rate and ramp length.
sampleRate | The sample rate |
rampLengthInSeconds | The duration of the ramp in seconds |
Referenced by juce::dsp::Gain< FloatType >::reset(), juce::dsp::Bias< FloatType >::reset(), juce::dsp::Oscillator< SampleType >::reset(), juce::SmoothedValue< SampleType, juce::ValueSmoothingTypes::Linear >::reset(), juce::Reverb::setSampleRate(), and juce::dsp::Bias< FloatType >::updateRamp().
|
inlinenoexcept |
Set a new ramp length directly in samples.
numSteps | The number of samples over which the ramp should be active |
|
inlineinherited |
Sets the current value and the target value.
newValue | the new value to take |
|
inlineprivatenoexcept |
|
inlineprivatenoexcept |
|
inlineprivate |
|
inlineprivatenoexcept |
|
inlinenoexcept |
Set the next value to ramp towards.
newValue | The new target value |
Referenced by juce::dsp::Bias< FloatType >::setBias(), juce::Reverb::setDamping(), juce::dsp::Oscillator< SampleType >::setFrequency(), juce::dsp::Gain< FloatType >::setGainLinear(), juce::Reverb::setParameters(), juce::dsp::LadderFilter< SampleType >::updateCutoffFreq(), and juce::dsp::LadderFilter< SampleType >::updateResonance().
|
inlinenoexcept |
Skip the next numSamples samples.
This is identical to calling getNextValue numSamples times. It returns the new current value.
Referenced by juce::dsp::Gain< FloatType >::process(), juce::dsp::Bias< FloatType >::process(), and juce::dsp::Oscillator< SampleType >::process().
|
inlineprivate |
|
inlineprivatenoexcept |
|
protectedinherited |
|
protectedinherited |
|
private |
|
private |
|
protectedinherited |