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

#include <juce_LogRampedValue.h>

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

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

[legend]

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

Public Member Functions
	LogRampedValue ()=default
	Constructor. More...

	LogRampedValue (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	setLogParameters (FloatType midPointAmplitudedB, bool rateOfChangeShouldIncrease) noexcept
	Sets the behaviour of the log ramp. More...

void	setTargetValue (FloatType newValue) noexcept
	Set a new target value. More...

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

Protected Attributes
int	countdown

FloatType	currentValue

FloatType	target

Private Member Functions
FloatType	getNextSmoothedValue () noexcept

void	updateRampParameters ()

Private Attributes
FloatType	B = Decibels::decibelsToGain ((FloatType) -40)

FloatType	d = 1

bool	increasingRateOfChange = true

FloatType	r = 0

FloatType	source = 0

int	stepsToTarget = 0

FloatType	temp = 0

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

@tags{DSP}

Member Typedef Documentation

◆ FloatType

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

inherited

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

◆ applyGain() [1/3]

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

inlinenoexceptinherited

Applies a smoothed gain to a buffer.

◆ applyGain() [2/3]

void juce::SmoothedValueBase< LogRampedValue< FloatType > >::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

◆ applyGain() [3/3]

void juce::SmoothedValueBase< LogRampedValue< FloatType > >::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

◆ getCurrentValue()

FloatType juce::SmoothedValueBase< LogRampedValue< FloatType > >::getCurrentValue

inlinenoexceptinherited

Returns the current value of the ramp.

◆ getNextSmoothedValue()

FloatType juce::SmoothedValueBase< LogRampedValue< FloatType > >::getNextSmoothedValue

inlineprivatenoexceptinherited

◆ getNextValue()

template<typename FloatType >

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

inlinenoexcept

Compute the next value.

Returns: Smoothed value

References juce::SmoothedValueBase< LogRampedValue< FloatType > >::countdown, juce::SmoothedValueBase< LogRampedValue< FloatType > >::currentValue, juce::dsp::LogRampedValue< FloatType >::d, juce::SmoothedValueBase< LogRampedValue< FloatType > >::isSmoothing(), juce::jmap(), juce::dsp::LogRampedValue< FloatType >::r, juce::dsp::LogRampedValue< FloatType >::source, juce::SmoothedValueBase< LogRampedValue< FloatType > >::target, and juce::dsp::LogRampedValue< FloatType >::temp.

◆ getTargetValue()

FloatType juce::SmoothedValueBase< LogRampedValue< FloatType > >::getTargetValue

inlinenoexceptinherited

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

◆ isSmoothing()

bool juce::SmoothedValueBase< LogRampedValue< FloatType > >::isSmoothing

inlinenoexceptinherited

Returns true if the current value is currently being interpolated.

◆ reset() [1/2]

template<typename FloatType >

void juce::dsp::LogRampedValue< FloatType >::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.

◆ reset() [2/2]

template<typename FloatType >

void juce::dsp::LogRampedValue< FloatType >::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< LogRampedValue< FloatType > >::setCurrentAndTargetValue(), juce::dsp::LogRampedValue< FloatType >::stepsToTarget, juce::SmoothedValueBase< LogRampedValue< FloatType > >::target, and juce::dsp::LogRampedValue< FloatType >::updateRampParameters().

◆ setCurrentAndTargetValue()

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

inlineinherited

Sets the current value and the target value.

Parameters

newValue the new value to take

◆ 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::dsp::LogRampedValue< FloatType >::B, juce::Decibels::decibelsToGain(), juce::dsp::LogRampedValue< FloatType >::increasingRateOfChange, and jassert.