A delay line processor featuring several algorithms for the fractional delay calculation, block processing, and sample-by-sample processing useful when modulating the delay in real time or creating a standard delay effect with feedback. More...

#include <juce_DelayLine.h>

Inheritance diagram for juce::dsp::DelayLine< SampleType, InterpolationType >:

[legend]

Collaboration diagram for juce::dsp::DelayLine< SampleType, InterpolationType >:

[legend]

Public Member Functions
	DelayLine ()
	Default constructor.

	DelayLine (int maximumDelayInSamples)
	Constructor.

SampleType	getDelay () const
	Returns the current delay in samples.

int	getMaximumDelayInSamples () const noexcept
	Gets the maximum possible delay in samples.

SampleType	popSample (int channel, SampleType delayInSamples=-1, bool updateReadPointer=true)
	Pops a single sample from one channel of the delay line.

void	prepare (const ProcessSpec &spec)
	Initialises the processor.

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

void	pushSample (int channel, SampleType sample)
	Pushes a single sample into one channel of the delay line.

void	reset ()
	Resets the internal state variables of the processor.

void	setDelay (SampleType newDelayInSamples)
	Sets the delay in samples.

void	setMaximumDelayInSamples (int maxDelayInSamples)
	Sets a new maximum delay in samples.

Private Member Functions
SampleType	interpolateSample (int channel)

void	updateInternalVariables ()

Private Attributes
SampleType	alpha = 0.0

AudioBuffer< SampleType >	bufferData

SampleType	delay = 0.0

SampleType	delayFrac = 0.0

int	delayInt = 0

std::vector< int >	readPos

double	sampleRate

int	totalSize = 4

std::vector< SampleType >	v

std::vector< int >	writePos

Detailed Description

template<typename SampleType, typename InterpolationType = DelayLineInterpolationTypes::Linear>
class juce::dsp::DelayLine< SampleType, InterpolationType >

A delay line processor featuring several algorithms for the fractional delay calculation, block processing, and sample-by-sample processing useful when modulating the delay in real time or creating a standard delay effect with feedback.

Note: If you intend to change the delay in real time, you may want to smooth changes to the delay systematically using either a ramp or a low-pass filter.

See also: SmoothedValue, FirstOrderTPTFilter

@tags{DSP}

Constructor & Destructor Documentation

◆ DelayLine() [1/2]

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

juce::dsp::DelayLine< SampleType, InterpolationType >::DelayLine ( )

Default constructor.

◆ DelayLine() [2/2]

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

juce::dsp::DelayLine< SampleType, InterpolationType >::DelayLine ( int maximumDelayInSamples )

explicit

Constructor.

Member Function Documentation

◆ getDelay()

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

SampleType juce::dsp::DelayLine< SampleType, InterpolationType >::getDelay ( ) const

Returns the current delay in samples.

◆ getMaximumDelayInSamples()

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

int juce::dsp::DelayLine< SampleType, InterpolationType >::getMaximumDelayInSamples ( ) const

inlinenoexcept

Gets the maximum possible delay in samples.

For very short delay times, the result of getMaximumDelayInSamples() may differ from the last value passed to setMaximumDelayInSamples().

References juce::dsp::DelayLine< SampleType, InterpolationType >::totalSize.

◆ interpolateSample()

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

SampleType juce::dsp::DelayLine< SampleType, InterpolationType >::interpolateSample ( int channel )

inlineprivate

References juce::dsp::DelayLine< SampleType, InterpolationType >::alpha, juce::approximatelyEqual(), juce::dsp::DelayLine< SampleType, InterpolationType >::bufferData, juce::dsp::DelayLine< SampleType, InterpolationType >::delayFrac, juce::dsp::DelayLine< SampleType, InterpolationType >::delayInt, juce::AudioBuffer< Type >::getReadPointer(), juce::AudioBuffer< Type >::getSample(), juce::dsp::DelayLine< SampleType, InterpolationType >::readPos, juce::dsp::DelayLine< SampleType, InterpolationType >::totalSize, and juce::dsp::DelayLine< SampleType, InterpolationType >::v.

◆ popSample()

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

SampleType juce::dsp::DelayLine< SampleType, InterpolationType >::popSample	(	int	channel,
		SampleType	delayInSamples = `-1`,
		bool	updateReadPointer = `true`
	)

Pops a single sample from one channel of the delay line.

Use this function to modulate the delay in real time or implement standard delay effects with feedback.

Parameters

channel	the target channel for the delay line.
delayInSamples	sets the wanted fractional delay in samples, or -1 to use the value being used before or set with setDelay function.
updateReadPointer	should be set to true if you use the function once for each sample, or false if you need multi-tap delay capabilities.

See also: setDelay, pushSample, process

Referenced by juce::dsp::DelayLine< SampleType, InterpolationType >::process().

◆ prepare()

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

void juce::dsp::DelayLine< SampleType, InterpolationType >::prepare ( const ProcessSpec & spec )

Initialises the processor.

◆ process()

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

template<typename ProcessContext >

void juce::dsp::DelayLine< SampleType, InterpolationType >::process ( const ProcessContext & context )

inlinenoexcept

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

Can be used for block processing when the delay is not going to change during processing. The delay must first be set by calling setDelay.

See also: setDelay

References jassert, juce::dsp::DelayLine< SampleType, InterpolationType >::popSample(), juce::dsp::DelayLine< SampleType, InterpolationType >::pushSample(), and juce::dsp::DelayLine< SampleType, InterpolationType >::writePos.

◆ pushSample()

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

void juce::dsp::DelayLine< SampleType, InterpolationType >::pushSample	(	int	channel,
		SampleType	sample
	)

Pushes a single sample into one channel of the delay line.

Use this function and popSample instead of process if you need to modulate the delay in real time instead of using a fixed delay value, or if you want to code a delay effect with a feedback loop.

See also: setDelay, popSample, process

Referenced by juce::dsp::DelayLine< SampleType, InterpolationType >::process().

◆ reset()

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

void juce::dsp::DelayLine< SampleType, InterpolationType >::reset ( )

Resets the internal state variables of the processor.

◆ setDelay()

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

void juce::dsp::DelayLine< SampleType, InterpolationType >::setDelay ( SampleType newDelayInSamples )

Sets the delay in samples.

◆ setMaximumDelayInSamples()

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

void juce::dsp::DelayLine< SampleType, InterpolationType >::setMaximumDelayInSamples ( int maxDelayInSamples )

Sets a new maximum delay in samples.

Also clears the delay line.

This may allocate internally, so you should never call it from the audio thread.

◆ updateInternalVariables()

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

void juce::dsp::DelayLine< SampleType, InterpolationType >::updateInternalVariables ( )

inlineprivate

References juce::dsp::DelayLine< SampleType, InterpolationType >::alpha, juce::dsp::DelayLine< SampleType, InterpolationType >::delayFrac, and juce::dsp::DelayLine< SampleType, InterpolationType >::delayInt.

Member Data Documentation

◆ alpha

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

SampleType juce::dsp::DelayLine< SampleType, InterpolationType >::alpha = 0.0

private

Referenced by juce::dsp::DelayLine< SampleType, InterpolationType >::interpolateSample(), and juce::dsp::DelayLine< SampleType, InterpolationType >::updateInternalVariables().

◆ bufferData

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

AudioBuffer<SampleType> juce::dsp::DelayLine< SampleType, InterpolationType >::bufferData

private

Referenced by juce::dsp::DelayLine< SampleType, InterpolationType >::interpolateSample().

◆ delay

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

SampleType juce::dsp::DelayLine< SampleType, InterpolationType >::delay = 0.0

private

◆ delayFrac

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

SampleType juce::dsp::DelayLine< SampleType, InterpolationType >::delayFrac = 0.0

private

Referenced by juce::dsp::DelayLine< SampleType, InterpolationType >::interpolateSample(), and juce::dsp::DelayLine< SampleType, InterpolationType >::updateInternalVariables().

◆ delayInt

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

int juce::dsp::DelayLine< SampleType, InterpolationType >::delayInt = 0

private

Referenced by juce::dsp::DelayLine< SampleType, InterpolationType >::interpolateSample(), and juce::dsp::DelayLine< SampleType, InterpolationType >::updateInternalVariables().

◆ readPos

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

std::vector<int> juce::dsp::DelayLine< SampleType, InterpolationType >::readPos

private

Referenced by juce::dsp::DelayLine< SampleType, InterpolationType >::interpolateSample().

◆ sampleRate

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

double juce::dsp::DelayLine< SampleType, InterpolationType >::sampleRate

private

◆ totalSize

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

int juce::dsp::DelayLine< SampleType, InterpolationType >::totalSize = 4

private

Referenced by juce::dsp::DelayLine< SampleType, InterpolationType >::getMaximumDelayInSamples(), and juce::dsp::DelayLine< SampleType, InterpolationType >::interpolateSample().

◆ v

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

std::vector<SampleType> juce::dsp::DelayLine< SampleType, InterpolationType >::v

private

Referenced by juce::dsp::DelayLine< SampleType, InterpolationType >::interpolateSample().

◆ writePos

template<typename SampleType , typename InterpolationType = DelayLineInterpolationTypes::Linear>

std::vector<int> juce::dsp::DelayLine< SampleType, InterpolationType >::writePos

private

Referenced by juce::dsp::DelayLine< SampleType, InterpolationType >::process().

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

juce_DelayLine.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DelayLine() [1/2]

◆ DelayLine() [2/2]

Member Function Documentation

◆ getDelay()

◆ getMaximumDelayInSamples()

◆ interpolateSample()

◆ popSample()

◆ prepare()

◆ process()

◆ pushSample()

◆ reset()

◆ setDelay()

◆ setMaximumDelayInSamples()

◆ updateInternalVariables()

Member Data Documentation

◆ alpha

◆ bufferData

◆ delay

◆ delayFrac

◆ delayInt

◆ readPos

◆ sampleRate

◆ totalSize

◆ v

◆ writePos