adds echo to the audio data. More...

#include <Echo.h>

Inheritance diagram for HephAudio::Echo:

Public Member Functions
	Echo ()

	Echo (size_t reflectionCount, double reflectionDelay, double decayFactor, double echoStart, double echoDuration)

virtual	~Echo ()=default

virtual std::string	Name () const override

virtual void	ResetInternalState () override

virtual void	Process (AudioBuffer &buffer, size_t startIndex, size_t frameCount) override

virtual size_t	GetReflectionCount () const

virtual void	SetReflectionCount (size_t reflectionCount)

virtual double	GetReflectionDelay () const

virtual void	SetReflectionDelay (double reflectionDelay)

virtual double	GetDecayFactor () const

virtual void	SetDecayFactor (double decayFactor)

virtual double	GetEchoStart () const

virtual void	SetEchoStart (double echoStart)

virtual double	GetEchoDuration () const

virtual void	SetEchoDuration (double echoDuration)

virtual void	Process (AudioBuffer &buffer)

virtual void	Process (AudioBuffer &buffer, size_t startIndex)

Public Member Functions inherited from HephAudio::AudioEffect
virtual	~AudioEffect ()=default

virtual bool	HasMTSupport () const

virtual bool	HasRTSupport () const

virtual size_t	GetThreadCount () const

virtual void	SetThreadCount (size_t threadCount)

virtual size_t	CalculateRequiredFrameCount (size_t outputFrameCount, const AudioFormatInfo &formatInfo) const

virtual size_t	CalculateOutputFrameCount (size_t inputFrameCount, const AudioFormatInfo &formatInfo) const

virtual size_t	CalculateAdvanceSize (size_t renderFrameCount, const AudioFormatInfo &formatInfo) const

Protected Member Functions
void	ProcessST (const AudioBuffer &inputBuffer, AudioBuffer &outputBuffer, size_t startIndex, size_t frameCount) override

Protected Member Functions inherited from HephAudio::AudioEffect
	AudioEffect ()

virtual void	ProcessMT (const AudioBuffer &inputBuffer, AudioBuffer &outputBuffer, size_t startIndex, size_t frameCount)

Protected Attributes
size_t	reflectionCount

double	reflectionDelay

double	decayFactor

double	echoStart

double	echoDuration

AudioBuffer	pastSamples

size_t	currentIndex

Protected Attributes inherited from HephAudio::AudioEffect
size_t	threadCount

Detailed Description

adds echo to the audio data.

Constructor & Destructor Documentation

◆ Echo() [1/2]

HephAudio::Echo::Echo ( )

creates a new instance and initializes it with default values.

◆ Echo() [2/2]

HephAudio::Echo::Echo	(	size_t	reflectionCount,
		double	reflectionDelay,
		double	decayFactor,
		double	echoStart,
		double	echoDuration )

creates a new instance and initializes it with the provided values.

Parameters

reflectionCount	number of times the audio data will be reflected.
reflectionDelay	elapsed time, in seconds, between the start of each reflection.
decayFactor	the factor which echo data will be multiplied by between each reflection.
echoStart	start time, in seconds, of the audio data that will be used as echo.
echoDuration	duration of the audio data, in seconds, that will be used as echo.

◆ ~Echo()

virtual HephAudio::Echo::~Echo ( )

virtualdefault

releases the resources and destroys the instance.

Member Function Documentation

◆ Name()

virtual std::string HephAudio::Echo::Name ( ) const

overridevirtual

gets the name of the audio effect.

Implements HephAudio::AudioEffect.

◆ ResetInternalState()

virtual void HephAudio::Echo::ResetInternalState ( )

overridevirtual

resets the variables internally used for processing.

Reimplemented from HephAudio::AudioEffect.

◆ Process() [1/3]

virtual void HephAudio::Echo::Process	(	AudioBuffer &	buffer,
		size_t	startIndex,
		size_t	frameCount )

overridevirtual

Applies the effect.

Parameters

buffer	contains the audio data which will be processed.
startIndex	index of the first audio frame to process.
frameCount	number of frames to process.

Reimplemented from HephAudio::AudioEffect.

◆ GetReflectionCount()

virtual size_t HephAudio::Echo::GetReflectionCount ( ) const

virtual

gets the reflection count.

◆ SetReflectionCount()

virtual void HephAudio::Echo::SetReflectionCount ( size_t reflectionCount )

virtual

sets the reflection count.

Parameters

reflectionCount number of times the audio data will be reflected.

◆ GetReflectionDelay()

virtual double HephAudio::Echo::GetReflectionDelay ( ) const

virtual

gets the reflection delay.

◆ SetReflectionDelay()

virtual void HephAudio::Echo::SetReflectionDelay ( double reflectionDelay )

virtual

sets the reflection delay.

Parameters

reflectionDelay elapsed time, in seconds, between the start of each reflection.

◆ GetDecayFactor()

virtual double HephAudio::Echo::GetDecayFactor ( ) const

virtual

gets the decay factor.

◆ SetDecayFactor()

virtual void HephAudio::Echo::SetDecayFactor ( double decayFactor )

virtual

sets the decay factor.

Parameters

decayFactor the factor which echo data will be multiplied by between each reflection.

◆ GetEchoStart()

virtual double HephAudio::Echo::GetEchoStart ( ) const

virtual

gets the echo start.

◆ SetEchoStart()

virtual void HephAudio::Echo::SetEchoStart ( double echoStart )

virtual

sets the echo start.

Parameters

echoStart start time, in seconds, of the audio data that will be used as echo.

◆ GetEchoDuration()

virtual double HephAudio::Echo::GetEchoDuration ( ) const

virtual

gets the echo duration.

◆ SetEchoDuration()

virtual void HephAudio::Echo::SetEchoDuration ( double echoDuration )

virtual

sets the echo duration.

Parameters

echoDuration duration of the audio data, in seconds, that will be used as echo.

◆ ProcessST()

void HephAudio::Echo::ProcessST	(	const AudioBuffer &	inputBuffer,
		AudioBuffer &	outputBuffer,
		size_t	startIndex,
		size_t	frameCount )

overrideprotectedvirtual

applies the effect using single thread.

Parameters

inputBuffer	contains the audio data which will be processed.
outputBuffer	contains the processed audio data.
startIndex	index of the first sample to process.
frameCount	number of frames to process.

Implements HephAudio::AudioEffect.

◆ Process() [2/3]

virtual void HephAudio::AudioEffect::Process ( AudioBuffer & buffer )

virtual

Applies the effect.

Parameters

buffer contains the audio data which will be processed.

Reimplemented from HephAudio::AudioEffect.

◆ Process() [3/3]

virtual void HephAudio::AudioEffect::Process	(	AudioBuffer &	buffer,
		size_t	startIndex )

virtual

Applies the effect.

Parameters

buffer	contains the audio data which will be processed.
startIndex	index of the first audio frame to process.

Reimplemented from HephAudio::AudioEffect.

Member Data Documentation

◆ reflectionCount

size_t HephAudio::Echo::reflectionCount

protected

number of times the audio data will be reflected.

◆ reflectionDelay

double HephAudio::Echo::reflectionDelay

protected

elapsed time, in seconds, between the start of each reflection.

◆ decayFactor

double HephAudio::Echo::decayFactor

protected

the factor which echo data will be multiplied by between each reflection.

◆ echoStart

double HephAudio::Echo::echoStart

protected

start time, in seconds, of the audio data that will be used as echo.

◆ echoDuration

double HephAudio::Echo::echoDuration

protected

duration of the audio data, in seconds, that will be used as echo.

◆ pastSamples

AudioBuffer HephAudio::Echo::pastSamples

protected

past samples required for real-time processing.

◆ currentIndex

size_t HephAudio::Echo::currentIndex

protected

for real-time processing.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Echo() [1/2]

◆ Echo() [2/2]

◆ ~Echo()

Member Function Documentation

◆ Name()

◆ ResetInternalState()

◆ Process() [1/3]

◆ GetReflectionCount()

◆ SetReflectionCount()

◆ GetReflectionDelay()

◆ SetReflectionDelay()

◆ GetDecayFactor()

◆ SetDecayFactor()

◆ GetEchoStart()

◆ SetEchoStart()

◆ GetEchoDuration()

◆ SetEchoDuration()

◆ ProcessST()

◆ Process() [2/3]

◆ Process() [3/3]

Member Data Documentation

◆ reflectionCount

◆ reflectionDelay

◆ decayFactor

◆ echoStart

◆ echoDuration

◆ pastSamples

◆ currentIndex