Applies a gain to audio samples as single samples or AudioBlocks. More...

#include <juce_Gain.h>

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

[legend]

Public Member Functions
	Gain () noexcept=default

FloatType	getGainDecibels () const noexcept
	Returns the current gain in decibels. More...

FloatType	getGainLinear () const noexcept
	Returns the current gain as a linear value. More...

double	getRampDurationSeconds () const noexcept
	Returns the ramp duration in seconds. More...

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

void	prepare (const ProcessSpec &spec) noexcept
	Called before processing starts. More...

template<typename ProcessContext >
void	process (const ProcessContext &context) noexcept
	Processes the input and output buffers supplied in the processing context. More...

template<typename SampleType >
SampleType JUCE_VECTOR_CALLTYPE	processSample (SampleType s) noexcept
	Returns the result of processing a single sample. More...

void	reset () noexcept
	Resets the internal state of the gain. More...

void	setGainDecibels (FloatType newGainDecibels) noexcept
	Applies a new gain as a decibel value. More...

void	setGainLinear (FloatType newGain) noexcept
	Applies a new gain as a linear value. More...

void	setRampDurationSeconds (double newDurationSeconds) noexcept
	Sets the length of the ramp used for smoothing gain changes. More...

Private Attributes
SmoothedValue< FloatType >	gain

double	rampDurationSeconds = 0

double	sampleRate = 0

Detailed Description

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

Applies a gain to audio samples as single samples or AudioBlocks.

@tags{DSP}

Constructor & Destructor Documentation

◆ Gain()

template<typename FloatType >

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

defaultnoexcept

Member Function Documentation

◆ getGainDecibels()

template<typename FloatType >

FloatType juce::dsp::Gain< FloatType >::getGainDecibels ( ) const

inlinenoexcept

Returns the current gain in decibels.

References juce::dsp::Gain< FloatType >::getGainLinear().

◆ getGainLinear()

template<typename FloatType >

FloatType juce::dsp::Gain< FloatType >::getGainLinear ( ) const

inlinenoexcept

Returns the current gain as a linear value.

References juce::dsp::Gain< FloatType >::gain, and juce::SmoothedValueBase< SmoothedValueType >::getTargetValue().

Referenced by juce::dsp::Gain< FloatType >::getGainDecibels().

◆ getRampDurationSeconds()

template<typename FloatType >

double juce::dsp::Gain< FloatType >::getRampDurationSeconds ( ) const

inlinenoexcept

Returns the ramp duration in seconds.

References juce::dsp::Gain< FloatType >::rampDurationSeconds.

◆ isSmoothing()

template<typename FloatType >

bool juce::dsp::Gain< FloatType >::isSmoothing ( ) const

inlinenoexcept

Returns true if the current value is currently being interpolated.

References juce::dsp::Gain< FloatType >::gain, and juce::SmoothedValueBase< SmoothedValueType >::isSmoothing().

◆ prepare()

template<typename FloatType >

void juce::dsp::Gain< FloatType >::prepare ( const ProcessSpec & spec )

inlinenoexcept

Called before processing starts.

References juce::dsp::Gain< FloatType >::reset(), and juce::dsp::Gain< FloatType >::sampleRate.

◆ process()

template<typename FloatType >

template<typename ProcessContext >

void juce::dsp::Gain< FloatType >::process ( const ProcessContext & context )

inlinenoexcept

Processes the input and output buffers supplied in the processing context.

References juce::gl::dst, juce::dsp::Gain< FloatType >::gain, juce::SmoothedValue< FloatType, SmoothingType >::getNextValue(), jassert, JUCE_BEGIN_IGNORE_WARNINGS_MSVC, JUCE_END_IGNORE_WARNINGS_MSVC, juce::gl::len, juce::SmoothedValue< FloatType, SmoothingType >::skip(), and juce::gl::src.

◆ processSample()

template<typename FloatType >

template<typename SampleType >

SampleType JUCE_VECTOR_CALLTYPE juce::dsp::Gain< FloatType >::processSample ( SampleType s )

inlinenoexcept

Returns the result of processing a single sample.

References juce::dsp::Gain< FloatType >::gain, juce::SmoothedValue< FloatType, SmoothingType >::getNextValue(), and juce::gl::s.

◆ reset()

template<typename FloatType >

void juce::dsp::Gain< FloatType >::reset ( )

inlinenoexcept

Resets the internal state of the gain.

References juce::dsp::Gain< FloatType >::gain, juce::dsp::Gain< FloatType >::rampDurationSeconds, juce::SmoothedValue< FloatType, SmoothingType >::reset(), and juce::dsp::Gain< FloatType >::sampleRate.

Referenced by juce::dsp::Gain< FloatType >::prepare(), and juce::dsp::Gain< FloatType >::setRampDurationSeconds().

◆ setGainDecibels()

template<typename FloatType >

void juce::dsp::Gain< FloatType >::setGainDecibels ( FloatType newGainDecibels )

inlinenoexcept

Applies a new gain as a decibel value.

References juce::dsp::Gain< FloatType >::setGainLinear().

◆ setGainLinear()

template<typename FloatType >

void juce::dsp::Gain< FloatType >::setGainLinear ( FloatType newGain )

inlinenoexcept

Applies a new gain as a linear value.

References juce::dsp::Gain< FloatType >::gain, and juce::SmoothedValue< FloatType, SmoothingType >::setTargetValue().

Referenced by juce::dsp::Gain< FloatType >::setGainDecibels().

◆ setRampDurationSeconds()

template<typename FloatType >

void juce::dsp::Gain< FloatType >::setRampDurationSeconds ( double newDurationSeconds )

inlinenoexcept

Sets the length of the ramp used for smoothing gain changes.

References juce::dsp::Gain< FloatType >::rampDurationSeconds, and juce::dsp::Gain< FloatType >::reset().

Member Data Documentation

◆ gain

template<typename FloatType >

SmoothedValue<FloatType> juce::dsp::Gain< FloatType >::gain

private

Referenced by juce::dsp::Gain< FloatType >::getGainLinear(), juce::dsp::Gain< FloatType >::isSmoothing(), juce::dsp::Gain< FloatType >::process(), juce::dsp::Gain< FloatType >::processSample(), juce::dsp::Gain< FloatType >::reset(), and juce::dsp::Gain< FloatType >::setGainLinear().

◆ rampDurationSeconds

template<typename FloatType >

double juce::dsp::Gain< FloatType >::rampDurationSeconds = 0

private

Referenced by juce::dsp::Gain< FloatType >::getRampDurationSeconds(), juce::dsp::Gain< FloatType >::reset(), and juce::dsp::Gain< FloatType >::setRampDurationSeconds().

◆ sampleRate

template<typename FloatType >

double juce::dsp::Gain< FloatType >::sampleRate = 0

private

Referenced by juce::dsp::Gain< FloatType >::prepare(), and juce::dsp::Gain< FloatType >::reset().

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

juce_Gain.h

Public Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ Gain()

Member Function Documentation

◆ getGainDecibels()

◆ getGainLinear()

◆ getRampDurationSeconds()

◆ isSmoothing()

◆ prepare()

◆ process()

◆ processSample()

◆ reset()

◆ setGainDecibels()

◆ setGainLinear()

◆ setRampDurationSeconds()

Member Data Documentation

◆ gain

◆ rampDurationSeconds

◆ sampleRate

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