EffectsStreamT: the template class describes an input or output stream to which one or multiple effects are applied. The number of channels are used to merge the samples of one frame into one sample before outputting the result as a frame (by repeating the result sample for each channel). Currently only int16_t values are supported, so I recommend to use the AudioEffectStream class which is defined as using AudioEffectStream = AudioEffectStreamT<effect_t>;. More...

#include <AudioEffects.h>

Inheritance diagram for AudioEffectStreamT< T >:

Public Member Functions
	AudioEffectStreamT (Print &out)

	AudioEffectStreamT (Stream &io)

void	addEffect (AudioEffect &effect)
	Adds an effect object (by reference)

void	addEffect (AudioEffect *effect)
	Adds an effect using a pointer.

int	available () override

int	availableForWrite () override

bool	begin (AudioBaseInfo cfg)

void	clear ()
	deletes all defined effects

AudioBaseInfo	defaultConfig ()

void	end () override

AudioEffect *	findEffect (int id)
	Finds an effect by id.

AudioEffect *	operator[] (int idx)
	gets an effect by index

size_t	readBytes (uint8_t *buffer, size_t length) override

void	setInput (Stream &io)

void	setOutput (Print &print)

void	setOutput (Stream &io)

size_t	size ()
	Provides the actual number of defined effects.

size_t	write (const uint8_t *buffer, size_t length) override

Public Member Functions inherited from AudioStreamX
	AudioStreamX (AudioStreamX const &)=delete

AudioStreamX &	operator= (AudioStreamX const &)=delete

virtual int	peek () override

virtual int	read () override

virtual size_t	write (uint8_t) override

Public Member Functions inherited from AudioStream
	AudioStream (AudioStream const &)=delete

virtual AudioBaseInfo	audioInfo () override

virtual bool	begin ()

virtual void	flush () override

	operator bool ()

AudioStream &	operator= (AudioStream const &)=delete

virtual size_t	readBytes (char *buffer, size_t length)

virtual void	setAudioInfo (AudioBaseInfo info) override

virtual void	setNotifyAudioChange (AudioBaseInfoDependent &bi) override

virtual Stream *	toStreamPointer ()

virtual void	writeSilence (size_t len)

Public Member Functions inherited from Stream
virtual void	setTimeout (size_t t)

Public Member Functions inherited from Print
virtual int	print (char c, PrintCharFmt spec)

virtual int	print (const char *msg)

virtual int	print (int number)

virtual int	println (const char *msg="")

virtual size_t	write (const char *buffer, size_t size)

virtual size_t	write (const char *str)

Public Member Functions inherited from AudioBaseInfoDependent
virtual bool	validate (AudioBaseInfo &info)

Protected Attributes
bool	active = false

AudioEffectCommon	effects

Stream *	p_io =nullptr

Print *	p_print =nullptr

Protected Attributes inherited from AudioStream
AudioBaseInfo	info

AudioBaseInfoDependent *	p_notify =nullptr

Additional Inherited Members
Protected Member Functions inherited from AudioStream
virtual int	not_supported (int out)

Detailed Description

template<class T>
class audio_tools::AudioEffectStreamT< T >

EffectsStreamT: the template class describes an input or output stream to which one or multiple effects are applied. The number of channels are used to merge the samples of one frame into one sample before outputting the result as a frame (by repeating the result sample for each channel). Currently only int16_t values are supported, so I recommend to use the AudioEffectStream class which is defined as using AudioEffectStream = AudioEffectStreamT<effect_t>;.

Author: Phil Schatzmann

Copyright: GPLv3

Member Function Documentation

◆ readBytes()

size_t readBytes	(	uint8_t *	buffer,
		size_t	length
	)

inlineoverridevirtual

Provides the audio data by reading the assinged Stream and applying the effects on that input

Reimplemented from AudioStreamX.

◆ write()

size_t write	(	const uint8_t *	buffer,
		size_t	length
	)

inlineoverridevirtual

Writes the samples passed in the buffer and applies the effects before writing the result to the output defined in the constructor.

Reimplemented from AudioStreamX.

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

src/AudioEffects/AudioEffects.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class T> class audio_tools::AudioEffectStreamT< T >

Member Function Documentation

◆ readBytes()

◆ write()

template<class T>
class audio_tools::AudioEffectStreamT< T >