Simple Delay effect consiting of a single tap delay with Effect Gain and feed back controls Constructor requires internal delay in samples.
More...
#include <AudioEffectsSuite.h>
Simple Delay effect consiting of a single tap delay with Effect Gain and feed back controls Constructor requires internal delay in samples.
- See also
- process
- Author
- Matthew Hamilton
- Copyright
- MIT License
◆ SimpleDelay() [1/2]
| SimpleDelay |
( |
int |
maxDelayInSamples = 8810, |
|
|
int |
samplingRate = 44100 |
|
) |
| |
|
inline |
Constructor: DigitalEffect Base Must Be initialised
- Parameters
-
| delayInSamples | Set the amount of delay in samples |
- See also
- DelayEffectBase constructor
◆ SimpleDelay() [2/2]
◆ ~SimpleDelay()
◆ active()
determines if the effect is active
◆ capGain()
capGain: caps gain to a range of 1 and -1;
- Parameters
-
| gain | address of gain value |
◆ clip()
| int16_t clip |
( |
int32_t |
in, |
|
|
int16_t |
clipLimit = 32767, |
|
|
int16_t |
resultLimit = 32767 |
|
) |
| |
|
inlineprotectedinherited |
◆ clone()
◆ copyParent()
◆ delaySample()
store input sample into the delay buffer and increment currentDelayWriteIndex for tracking when to loop back to start of buffer
- Parameters
-
| inputSample | sample to be stored for delay (effectsuite_t) |
◆ getInterpolatedOut()
get the value of the requested buffer index by interpolating other points
- Parameters
-
| bufferIndex | The required buffer index |
- Returns
- interpolated output
◆ getSplineOut()
get a cubic spline interpolated out from the wave table Derived from code by Alec Wright at repository: https://github.com/Alec-Wright/Chorus
- Authors
- Matthew Hamilton, Alec Wright
- Parameters
-
| bufferIndex | the required buffer index |
- Returns
- returns interpolated value as effectsuite_t
◆ id()
Allows to identify an effect.
◆ incDelayBuffReadIndex()
Increments the currentDelayBufferReadIndex by indexInc
- Parameters
-
| indexInc | The amount to increment the delay buffer index |
◆ incDelayBuffWriteIndex()
| void incDelayBuffWriteIndex |
( |
| ) |
|
|
inlineprotectedinherited |
Increments the currentDelayWriteBufferIndex by 1
◆ process()
Main process block for applying audio effect
- Parameters
-
| inputSample | The int16_t input audio sample for the effect to be applied to |
- Returns
- an audio sample as a int16_t with effect applied
Reimplemented from EffectSuiteBase.
◆ processDouble()
Apply delay and return input sample along with delay buffer signal
- Parameters
-
| inputSample | <#inputSample description#> |
- Returns
- <#return value description#>
Implements EffectSuiteBase.
◆ setActive()
| virtual void setActive |
( |
bool |
value | ) |
|
|
inlinevirtualinherited |
sets the effect active/inactive
◆ setDelayBuffer()
| bool setDelayBuffer |
( |
int |
bufferSizeSamples | ) |
|
|
inlineprotectedinherited |
Allocates memory for delay buffer and initialises all elements to 0
- Parameters
-
| bufferSizeSamples | the size of delay buffer to be used |
- Returns
- false and error description if there's a problem, or sets the internal delay buffer and returns true
◆ setDelayBuffReadIndex()
sets the currentDelayBufferReadIndex by indexInc (Currently no wrapping)
- Parameters
-
| index | the read index index required |
◆ setDelayGain()
setDelayGain: sets the delay gain to a value between 1 and -1
- Parameters
-
| gain | required delay gain. Values beyond 1 and -1 are capped to the maximum to avoid idiocy. Negative velus invoke a phase inversion. |
- See also
- setFeedbackGain
◆ setDelayTime()
<Description#>
- Parameters
-
| delayInSample | <#delayInSample description#> |
◆ setDelayTransitionTime()
<Description#>
- Parameters
-
| seconds | <#seconds description#> |
◆ setFeedbackGain()
setDelayGain: sets the feedback gain to a value between 1 and -1
- Parameters
-
| gain | required delay gain. Values beyond 1 and -1 are capped to the maximum to avoid idiocy. Negative velus invoke a phase inversion. |
- See also
- setDelayGain
◆ setId()
Allows to identify an effect.
◆ setInterpolationTable()
|
|
inlinestaticprotectedinherited |
Sets the internal lagrange interpolation table. Ideally it should be shared amongst all
- Returns
- false and an error description if there's a problem, or sets the interpolation lookup table and returns true
◆ setupDelayEffectBase()
| void setupDelayEffectBase |
( |
const int |
bufferSizeSamples | ) |
|
|
inlineinherited |
<Description#>
- Parameters
-
| bufferSizeSamples | <#bufferSizeSamples description#> |
◆ setupSimpleDelay()
| void setupSimpleDelay |
( |
int |
delayInSamples | ) |
|
|
inline |
<Description#>
- Parameters
-
| delayInSamples | <#delayInSamples description#> |
◆ storeSample()
store input sample into the delay buffer
- Parameters
-
| inputSample | sample to be stored for delay (effectsuite_t) |
◆ active_flag
◆ count
◆ currentDelayReadIndex
◆ currentDelaySamples
◆ currentDelayWriteIndex
| int currentDelayWriteIndex = 0 |
|
protectedinherited |
◆ delayBuffer
buffer to stored audio buffer for delay effects
◆ delayGain
◆ delayIncrement
increment when transition from current to target delay per sample set by delayTransitionTime
◆ delayTimeChanged
| bool delayTimeChanged = false |
|
protected |
◆ delayTimeSamples
| int delayTimeSamples = 44100 |
|
protectedinherited |
the delay time of signal in samples
◆ delayTransitionTime
time in seconds to transition from one delay to another
◆ delayTransitionTimeInSamples
◆ error
internal class error boolean
◆ feedbackGain
◆ id_value
◆ interpOrder
| const int interpOrder = 4 |
|
staticprotectedinherited |
◆ interpResolution
| const int interpResolution = 1000 |
|
staticprotectedinherited |
◆ invDelayIncrement
inverse of delay increment: for working out whole number cyles to reach target delay
◆ maxDelayBufferSize
| int maxDelayBufferSize = 441000 |
|
protectedinherited |
Maximum number of samples that can be stored in delayBuffer
◆ readHeadIndex
◆ sampleRate
◆ targetDelaySamples
◆ writeHeadIndex
| unsigned int writeHeadIndex |
|
protected |
The documentation for this class was generated from the following file:
