Utility class for logarithmically smoothed linear values. More...

Inheritance diagram for juce::dsp::LogRampedValue< FloatType >:

Public Member Functions
	LogRampedValue ()=default
	Constructor.

	LogRampedValue (FloatType initialValue) noexcept
	Constructor.

void	setLogParameters (FloatType midPointAmplitudedB, bool rateOfChangeShouldIncrease) noexcept
	Sets the behaviour of the log ramp.

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	setTargetValue (FloatType newValue) noexcept
	Set a new target value.

FloatType	getNextValue () noexcept
	Compute the next value.

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

Public Member Functions inherited from juce::SmoothedValueBase< LogRampedValue< FloatType > >
	SmoothedValueBase ()=default
	Constructor.

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

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

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

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

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.

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

int	getNumSamplesToReachTarget () const noexcept
	Returns the number of samples remaining to reach the target value.

Additional Inherited Members
Public Types inherited from juce::SmoothedValueBase< LogRampedValue< FloatType > >
using	FloatType = typename FloatTypeHelper< LogRampedValue< FloatType > >::Type

Protected Attributes inherited from juce::SmoothedValueBase< LogRampedValue< FloatType > >
FloatType	currentValue

FloatType	target

int	countdown

Detailed Description

template<typename FloatType>
class juce::dsp::LogRampedValue< FloatType >

Utility class for logarithmically smoothed linear values.

Logarithmically smoothed values can be more relevant than linear ones for specific cases such as algorithm change smoothing, using two of them in opposite directions.

The gradient of the logarithmic/exponential slope can be configured by calling LogRampedValue::setLogParameters.

See also: SmoothedValue

Constructor & Destructor Documentation

◆ LogRampedValue() [1/2]

template<typename FloatType >

juce::dsp::LogRampedValue< FloatType >::LogRampedValue ( )

default

Constructor.

◆ LogRampedValue() [2/2]

template<typename FloatType >

juce::dsp::LogRampedValue< FloatType >::LogRampedValue ( FloatType initialValue )

inlinenoexcept

Constructor.

References juce::SmoothedValueBase< LogRampedValue< FloatType > >::currentValue, and juce::SmoothedValueBase< LogRampedValue< FloatType > >::target.

Member Function Documentation

◆ setLogParameters()

template<typename FloatType >

void juce::dsp::LogRampedValue< FloatType >::setLogParameters	(	FloatType	midPointAmplitudedB,
		bool	rateOfChangeShouldIncrease
	)

inlinenoexcept

Sets the behaviour of the log ramp.

Parameters

midPointAmplitudedB	Sets the amplitude of the mid point in decibels, with the target value at 0 dB and the initial value at -inf dB
rateOfChangeShouldIncrease	If true then the ramp starts shallow and gets progressively steeper, if false then the ramp is initially steep and flattens out as you approach the target value

References juce::Decibels::decibelsToGain(), and jassert.