JUCE: SmoothedValue< FloatType, SmoothingType > Class Template Reference

JUCE

Public Member Functions | List of all members
SmoothedValue< FloatType, SmoothingType > Class Template Reference
juce_audio_basics » utilities

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

`#include <juce_SmoothedValue.h>`

Inheritance diagram for SmoothedValue< FloatType, SmoothingType >:

## Public Member Functions
| SmoothedValue () noexcept
| Constructor. More...
| SmoothedValue (FloatType initialValue) noexcept
| Constructor. 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 | setTargetValue (FloatType newValue) noexcept
| Set the next value to ramp towards. More...
FloatType | getNextValue () noexcept
| Compute the next value. More...
FloatType | skip (int numSamples) noexcept
| Skip the next numSamples samples. More...
Public Member Functions inherited from SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >
| SmoothedValueBase ()=default
| Constructor. More...
bool | isSmoothing () const noexcept
| Returns true if the current value is currently being interpolated. More...
FloatType | getCurrentValue () const noexcept
| Returns the current value of the ramp. More...
FloatType | getTargetValue () const noexcept
| Returns the target value towards which the smoothed value is currently moving. More...
void | setCurrentAndTargetValue (FloatType newValue)
| Sets the current value and the target value. 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...
void | applyGain (AudioBuffer< FloatType > &buffer, int numSamples) noexcept
| Applies a smoothed gain to a buffer. More...

## Additional Inherited Members
Public Types inherited from SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >
using | FloatType = typename FloatTypeHelper< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::Type
Protected Attributes inherited from SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >
FloatType | currentValue
FloatType | target
int | countdown

## Detailed Description

template<typename FloatType, typename SmoothingType = ValueSmoothingTypes::Linear>
class 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;
SmoothedValue
A utility class for values that need smoothing to avoid audio glitches.
Definition: juce_SmoothedValue.h:228

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!

## Constructor & Destructor Documentation

## ◆ SmoothedValue() [1/2]

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

SmoothedValue< FloatType, SmoothingType >::SmoothedValue | ( |  | ) |
| noexcept

Constructor.

## ◆ SmoothedValue() [2/2]

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

SmoothedValue< FloatType, SmoothingType >::SmoothedValue | ( | FloatType | initialValue | ) |
| noexcept

Constructor.

References SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::currentValue, jassert, SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::target, and gl::value.

## Member Function Documentation

## ◆ reset() [1/2]

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

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

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 SmoothedValue< FloatType, SmoothingType >::reset().

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

## ◆ reset() [2/2]

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

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

Set a new ramp length directly in samples.

Parameters

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

References SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::setCurrentAndTargetValue(), and SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::target.

## ◆ setTargetValue()

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

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

Set the next value to ramp towards.

Parameters

  newValue | The new target value

References SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::countdown, jassert, SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::setCurrentAndTargetValue(), SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::target, and gl::value.

## ◆ getNextValue()

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

FloatType SmoothedValue< FloatType, SmoothingType >::getNextValue | ( |  | ) |
| noexcept

Compute the next value.

Returns
  Smoothed value

References SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::countdown, SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::currentValue, SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::isSmoothing(), and SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::target.

## ◆ skip()

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

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

Skip the next numSamples samples.

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

See also
  getNextValue

References SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::countdown, SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::currentValue, SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::setCurrentAndTargetValue(), and SmoothedValueBase< SmoothedValue< FloatType, ValueSmoothingTypes::Linear > >::target.

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

- juce_SmoothedValue.h