A utility class for values that need smoothing to avoid audio glitches. More...

#include <juce_SmoothedValue.h>

Inheritance diagram for juce::SmoothedValue< FloatType, SmoothingType >:

[legend]

Collaboration diagram for juce::SmoothedValue< FloatType, SmoothingType >:

[legend]

Public Types
using	FloatType = typename FloatTypeHelper< SmoothedValueType >::Type

Public Member Functions
	SmoothedValue () noexcept
	Constructor.

	SmoothedValue (FloatType initialValue) noexcept
	Constructor.

void	applyGain (AudioBuffer< FloatType > &buffer, int numSamples) noexcept
	Applies a smoothed gain to a buffer.

void	applyGain (FloatType *samples, int numSamples) noexcept
	Applies a smoothed gain to a stream of samples S[i] *= gain.

void	applyGain (FloatType samplesOut, const FloatType samplesIn, int numSamples) noexcept
	Computes output as a smoothed gain applied to a stream of samples.

FloatType	getCurrentValue () const noexcept
	Returns the current value of the ramp.

FloatType	getNextValue () noexcept
	Compute the next value.

FloatType	getTargetValue () const noexcept
	Returns the target value towards which the smoothed value is currently moving.

bool	isSmoothing () const noexcept
	Returns true if the current value is currently being interpolated.

void	reset (double sampleRate, double rampLengthInSeconds) noexcept
	Reset to a new sample rate and ramp length.

void	reset (int numSteps) noexcept
	Set a new ramp length directly in samples.

void	setCurrentAndTargetValue (FloatType newValue)
	Sets the current value and the target value.

void	setTargetValue (FloatType newValue) noexcept
	Set the next value to ramp towards.

FloatType	skip (int numSamples) noexcept
	Skip the next numSamples samples.

Protected Attributes
int	countdown = 0

FloatType	currentValue = 0

FloatType	target = currentValue

Private Member Functions
FloatType	getNextSmoothedValue () noexcept

template<typename T = SmoothingType>
void	setNextValue () noexcept

template<typename T = SmoothingType>
void	setStepSize () noexcept

template<typename T = SmoothingType>
void	skipCurrentValue (int numSamples) noexcept

Private Attributes
FloatType	step = FloatType()

int	stepsToTarget = 0

Detailed Description

template<typename FloatType, typename SmoothingType = ValueSmoothingTypes::Linear>
class juce::SmoothedValue< FloatType, SmoothingType >

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.

SmoothedValue<float, ValueSmoothingTypes::Linear> yourSmoothedValue;

juce::SmoothedValue

A utility class for values that need smoothing to avoid audio glitches.

Definition juce_SmoothedValue.h:239

A ValueSmoothingTypes::Multiplicative template parameter selects multiplicative smoothing increments towards the target value.

SmoothedValue<float, ValueSmoothingTypes::Multiplicative> yourSmoothedValue;

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}

Member Typedef Documentation

◆ FloatType

template<typename SmoothedValueType >

using juce::SmoothedValueBase< SmoothedValueType >::FloatType = typename FloatTypeHelper<SmoothedValueType>::Type

inherited

Constructor & Destructor Documentation

◆ SmoothedValue() [1/2]

template<typename FloatType , typename SmoothingType = ValueSmoothingTypes::Linear>

juce::SmoothedValue< FloatType, SmoothingType >::SmoothedValue ( )

inlinenoexcept

Constructor.

◆ SmoothedValue() [2/2]

template<typename FloatType , typename SmoothingType = ValueSmoothingTypes::Linear>

juce::SmoothedValue< FloatType, SmoothingType >::SmoothedValue ( FloatType initialValue )

inlinenoexcept

Constructor.

References juce::approximatelyEqual(), juce::SmoothedValueBase< SmoothedValueType >::currentValue, jassert, and juce::SmoothedValueBase< SmoothedValueType >::target.

Member Function Documentation

◆ applyGain() [1/3]

template<typename SmoothedValueType >

void juce::SmoothedValueBase< SmoothedValueType >::applyGain	(	AudioBuffer< FloatType > &	buffer,
		int	numSamples
	)

inlinenoexceptinherited

Applies a smoothed gain to a buffer.

References juce::SmoothedValueBase< SmoothedValueType >::getNextSmoothedValue(), juce::SmoothedValueBase< SmoothedValueType >::isSmoothing(), jassert, and juce::SmoothedValueBase< SmoothedValueType >::target.

◆ applyGain() [2/3]

template<typename SmoothedValueType >

void juce::SmoothedValueBase< SmoothedValueType >::applyGain	(	FloatType *	samples,
		int	numSamples
	)

inlinenoexceptinherited

Applies a smoothed gain to a stream of samples S[i] *= gain.

Parameters

samples	Pointer to a raw array of samples
numSamples	Length of array of samples

References juce::SmoothedValueBase< SmoothedValueType >::getNextSmoothedValue(), juce::SmoothedValueBase< SmoothedValueType >::isSmoothing(), jassert, and juce::SmoothedValueBase< SmoothedValueType >::target.

◆ applyGain() [3/3]

template<typename SmoothedValueType >

void juce::SmoothedValueBase< SmoothedValueType >::applyGain	(	FloatType *	samplesOut,
		const FloatType *	samplesIn,
		int	numSamples
	)

inlinenoexceptinherited

Computes output as a smoothed gain applied to a stream of samples.

Sout[i] = Sin[i] * gain

Parameters

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

References juce::SmoothedValueBase< SmoothedValueType >::getNextSmoothedValue(), juce::SmoothedValueBase< SmoothedValueType >::isSmoothing(), jassert, and juce::SmoothedValueBase< SmoothedValueType >::target.

◆ getCurrentValue()

template<typename SmoothedValueType >

FloatType juce::SmoothedValueBase< SmoothedValueType >::getCurrentValue ( ) const

inlinenoexceptinherited

Returns the current value of the ramp.

References juce::SmoothedValueBase< SmoothedValueType >::currentValue.

◆ getNextSmoothedValue()

template<typename SmoothedValueType >

FloatType juce::SmoothedValueBase< SmoothedValueType >::getNextSmoothedValue ( )

inlineprivatenoexceptinherited

Referenced by juce::SmoothedValueBase< SmoothedValueType >::applyGain(), juce::SmoothedValueBase< SmoothedValueType >::applyGain(), and juce::SmoothedValueBase< SmoothedValueType >::applyGain().

◆ getNextValue()

template<typename FloatType , typename SmoothingType = ValueSmoothingTypes::Linear>

FloatType juce::SmoothedValue< FloatType, SmoothingType >::getNextValue ( )

inlinenoexcept

Compute the next value.

Returns: Smoothed value

References juce::SmoothedValueBase< SmoothedValueType >::countdown, juce::SmoothedValueBase< SmoothedValueType >::currentValue, juce::SmoothedValueBase< SmoothedValueType >::isSmoothing(), juce::SmoothedValue< FloatType, SmoothingType >::setNextValue(), and juce::SmoothedValueBase< SmoothedValueType >::target.

Referenced by juce::dsp::Oscillator< SampleType >::process(), juce::Reverb::processMono(), juce::dsp::Oscillator< SampleType >::processSample(), and juce::Reverb::processStereo().

◆ getTargetValue()

template<typename SmoothedValueType >

FloatType juce::SmoothedValueBase< SmoothedValueType >::getTargetValue ( ) const

inlinenoexceptinherited

Returns the target value towards which the smoothed value is currently moving.

References juce::SmoothedValueBase< SmoothedValueType >::target.

Referenced by juce::dsp::Oscillator< SampleType >::getFrequency().

◆ isSmoothing()

template<typename SmoothedValueType >

bool juce::SmoothedValueBase< SmoothedValueType >::isSmoothing ( ) const

inlinenoexceptinherited

Returns true if the current value is currently being interpolated.

References juce::SmoothedValueBase< SmoothedValueType >::countdown.

Referenced by juce::SmoothedValueBase< SmoothedValueType >::applyGain(), juce::SmoothedValueBase< SmoothedValueType >::applyGain(), juce::SmoothedValueBase< SmoothedValueType >::applyGain(), juce::SmoothedValue< FloatType, SmoothingType >::getNextValue(), and juce::dsp::Oscillator< SampleType >::process().

◆ reset() [1/2]

template<typename FloatType , typename SmoothingType = ValueSmoothingTypes::Linear>

void juce::SmoothedValue< FloatType, SmoothingType >::reset	(	double	sampleRate,
		double	rampLengthInSeconds
	)

inlinenoexcept

Reset to a new sample rate and ramp length.

Parameters

sampleRate	The sample rate
rampLengthInSeconds	The duration of the ramp in seconds

References jassert, and juce::SmoothedValue< FloatType, SmoothingType >::reset().

Referenced by juce::dsp::Oscillator< SampleType >::reset(), juce::SmoothedValue< FloatType, SmoothingType >::reset(), and juce::Reverb::setSampleRate().

◆ reset() [2/2]

template<typename FloatType , typename SmoothingType = ValueSmoothingTypes::Linear>

void juce::SmoothedValue< FloatType, SmoothingType >::reset ( int numSteps )

inlinenoexcept

Set a new ramp length directly in samples.

Parameters

numSteps The number of samples over which the ramp should be active

References juce::SmoothedValueBase< SmoothedValueType >::setCurrentAndTargetValue(), juce::SmoothedValue< FloatType, SmoothingType >::stepsToTarget, and juce::SmoothedValueBase< SmoothedValueType >::target.

◆ setCurrentAndTargetValue()

template<typename SmoothedValueType >

void juce::SmoothedValueBase< SmoothedValueType >::setCurrentAndTargetValue ( FloatType newValue )

inlineinherited

Sets the current value and the target value.

Parameters

newValue the new value to take

References juce::SmoothedValueBase< SmoothedValueType >::countdown, juce::SmoothedValueBase< SmoothedValueType >::currentValue, and juce::SmoothedValueBase< SmoothedValueType >::target.

Referenced by juce::SmoothedValue< FloatType, SmoothingType >::reset(), juce::dsp::Oscillator< SampleType >::setFrequency(), juce::SmoothedValue< FloatType, SmoothingType >::setTargetValue(), and juce::SmoothedValue< FloatType, SmoothingType >::skip().

◆ setNextValue()

template<typename FloatType , typename SmoothingType = ValueSmoothingTypes::Linear>

template<typename T = SmoothingType>

void juce::SmoothedValue< FloatType, SmoothingType >::setNextValue ( )

inlineprivatenoexcept

References juce::SmoothedValueBase< SmoothedValueType >::currentValue, and juce::SmoothedValue< FloatType, SmoothingType >::step.

Referenced by juce::SmoothedValue< FloatType, SmoothingType >::getNextValue().

◆ setStepSize()

template<typename FloatType , typename SmoothingType = ValueSmoothingTypes::Linear>

template<typename T = SmoothingType>

void juce::SmoothedValue< FloatType, SmoothingType >::setStepSize ( )

inlineprivatenoexcept

References juce::SmoothedValueBase< SmoothedValueType >::countdown, juce::SmoothedValueBase< SmoothedValueType >::currentValue, juce::SmoothedValue< FloatType, SmoothingType >::step, and juce::SmoothedValueBase< SmoothedValueType >::target.

Referenced by juce::SmoothedValue< FloatType, SmoothingType >::setTargetValue().

◆ setTargetValue()

template<typename FloatType , typename SmoothingType = ValueSmoothingTypes::Linear>

void juce::SmoothedValue< FloatType, SmoothingType >::setTargetValue ( FloatType newValue )

inlinenoexcept

Set the next value to ramp towards.

Parameters

newValue The new target value

References juce::approximatelyEqual(), juce::SmoothedValueBase< SmoothedValueType >::countdown, jassert, juce::SmoothedValueBase< SmoothedValueType >::setCurrentAndTargetValue(), juce::SmoothedValue< FloatType, SmoothingType >::setStepSize(), juce::SmoothedValue< FloatType, SmoothingType >::stepsToTarget, and juce::SmoothedValueBase< SmoothedValueType >::target.

Referenced by juce::Reverb::setDamping(), juce::dsp::Oscillator< SampleType >::setFrequency(), juce::Reverb::setParameters(), juce::dsp::LadderFilter< SampleType >::updateCutoffFreq(), and juce::dsp::LadderFilter< SampleType >::updateResonance().

◆ skip()

template<typename FloatType , typename SmoothingType = ValueSmoothingTypes::Linear>

FloatType juce::SmoothedValue< FloatType, SmoothingType >::skip ( int numSamples )

inlinenoexcept

Skip the next numSamples samples.

This is identical to calling getNextValue numSamples times. It returns the new current value.

See also: getNextValue

References juce::SmoothedValueBase< SmoothedValueType >::countdown, juce::SmoothedValueBase< SmoothedValueType >::currentValue, juce::SmoothedValueBase< SmoothedValueType >::setCurrentAndTargetValue(), juce::SmoothedValue< FloatType, SmoothingType >::skipCurrentValue(), and juce::SmoothedValueBase< SmoothedValueType >::target.

Referenced by juce::dsp::Oscillator< SampleType >::process().

◆ skipCurrentValue()

template<typename FloatType , typename SmoothingType = ValueSmoothingTypes::Linear>

template<typename T = SmoothingType>

void juce::SmoothedValue< FloatType, SmoothingType >::skipCurrentValue ( int numSamples )

inlineprivatenoexcept

References juce::SmoothedValueBase< SmoothedValueType >::currentValue, and juce::SmoothedValue< FloatType, SmoothingType >::step.

Referenced by juce::SmoothedValue< FloatType, SmoothingType >::skip().

Member Data Documentation

◆ countdown

template<typename SmoothedValueType >

int juce::SmoothedValueBase< SmoothedValueType >::countdown = 0

protectedinherited

Referenced by juce::SmoothedValue< FloatType, SmoothingType >::getNextValue(), juce::SmoothedValueBase< SmoothedValueType >::isSmoothing(), juce::SmoothedValueBase< SmoothedValueType >::setCurrentAndTargetValue(), juce::SmoothedValue< FloatType, SmoothingType >::setStepSize(), juce::SmoothedValue< FloatType, SmoothingType >::setTargetValue(), and juce::SmoothedValue< FloatType, SmoothingType >::skip().

◆ currentValue

template<typename SmoothedValueType >

FloatType juce::SmoothedValueBase< SmoothedValueType >::currentValue = 0

protectedinherited

Referenced by juce::SmoothedValue< FloatType, SmoothingType >::SmoothedValue(), juce::SmoothedValueBase< SmoothedValueType >::getCurrentValue(), juce::SmoothedValue< FloatType, SmoothingType >::getNextValue(), juce::SmoothedValueBase< SmoothedValueType >::setCurrentAndTargetValue(), juce::SmoothedValue< FloatType, SmoothingType >::setNextValue(), juce::SmoothedValue< FloatType, SmoothingType >::setStepSize(), juce::SmoothedValue< FloatType, SmoothingType >::skip(), and juce::SmoothedValue< FloatType, SmoothingType >::skipCurrentValue().

◆ step

template<typename FloatType , typename SmoothingType = ValueSmoothingTypes::Linear>

FloatType juce::SmoothedValue< FloatType, SmoothingType >::step = FloatType()

private

Referenced by juce::SmoothedValue< FloatType, SmoothingType >::setNextValue(), juce::SmoothedValue< FloatType, SmoothingType >::setStepSize(), and juce::SmoothedValue< FloatType, SmoothingType >::skipCurrentValue().

◆ stepsToTarget

template<typename FloatType , typename SmoothingType = ValueSmoothingTypes::Linear>

int juce::SmoothedValue< FloatType, SmoothingType >::stepsToTarget = 0

private

Referenced by juce::SmoothedValue< FloatType, SmoothingType >::reset(), and juce::SmoothedValue< FloatType, SmoothingType >::setTargetValue().

◆ target

template<typename SmoothedValueType >

FloatType juce::SmoothedValueBase< SmoothedValueType >::target = currentValue

protectedinherited

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

juce_SmoothedValue.h

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ FloatType

Constructor & Destructor Documentation

◆ SmoothedValue() [1/2]

◆ SmoothedValue() [2/2]

Member Function Documentation

◆ applyGain() [1/3]

◆ applyGain() [2/3]

◆ applyGain() [3/3]

◆ getCurrentValue()

◆ getNextSmoothedValue()

◆ getNextValue()

◆ getTargetValue()

◆ isSmoothing()

◆ reset() [1/2]

◆ reset() [2/2]

◆ setCurrentAndTargetValue()

◆ setNextValue()

◆ setStepSize()

◆ setTargetValue()

◆ skip()

◆ skipCurrentValue()

Member Data Documentation

◆ countdown

◆ currentValue

◆ step

◆ stepsToTarget

◆ target