EffectsStreamT: the template class describes an input or output stream to which one or multiple effects are applied. Each channel is processed by its own independent clone of the effect chain (created via AudioEffect::clone()), so e.g. a stereo signal keeps its channel separation and effects that carry internal state (Delay's ring buffer, ADSRGain/Tremolo's envelope or oscillator phase, etc.) don't get confused by interleaved samples from different channels. addEffect() adds to a shared template chain that is cloned into every channel on begin() (and immediately cloned into all already-active channels if called afterwards); use addEffect(channel, effect) to register an effect directly on just one channel instead. Note that size()/operator[]/findEffect() operate on the template chain, not on the per-channel clones: mutating a pointer obtained from them after begin() has already cloned it does not retroactively change already-cloned per-channel copies. 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 ()=default

	AudioEffectStreamT (const AudioEffectStreamT &)=delete

	AudioEffectStreamT (Print &out)

	AudioEffectStreamT (Stream &io)

	~AudioEffectStreamT ()

void	addEffect (AudioEffect &effect)
	Adds an effect object (by reference) to the template chain: cloned into every channel.

void	addEffect (AudioEffect *effect)
	Adds an effect using a pointer to the template chain: cloned into every channel.

void	addEffect (int channel, AudioEffect &effect)

void	addEffect (int channel, AudioEffect *effect)

virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.

virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo

virtual AudioInfo	audioInfoOut ()

int	available () override

int	availableForWrite () override

bool	begin ()

bool	begin (AudioInfo cfg)

int	channelCount ()
	Provides the number of channels that have their own effect chain (valid after begin())

AudioEffectCommon &	channelEffects (int channel)
	Provides access to a single channel's own effect chain (valid after begin())

void	clear ()
	deletes all defined effects

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

AudioInfo	defaultConfig ()

void	end () override

AudioEffect *	findEffect (int id)
	Finds an effect by id in the template chain.

virtual void	flush () override

bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.

virtual	operator bool ()

AudioEffectStreamT &	operator= (const AudioEffectStreamT &)=delete

AudioEffect *	operator[] (int idx)
	gets an effect by index from the template chain

size_t	readBytes (uint8_t *data, size_t len) override

virtual size_t	readSilence (uint8_t *buffer, size_t length)
	Source to generate silence: just sets the buffer to 0.

virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.

virtual void	setAudioInfo (AudioInfo newInfo) override
	Defines the input AudioInfo.

void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)

virtual void	setOutput (AudioOutput &out)
	Defines/Changes the output target and registers for audio change notifications.

void	setOutput (Print &print) override
	Defines/Changes the output target.

virtual void	setStream (AudioStream &io)
	Defines/Changes the input & output and registers for audio change notifications.

void	setStream (Stream &io) override
	Defines/Changes the input & output.

void	setWriteBufferSize (int size)

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

size_t	write (const uint8_t *data, size_t len) override

virtual size_t	write (uint8_t ch) override

virtual void	writeSilence (size_t len)
	Writes len bytes of silence (=0).

Protected Member Functions
void	cloneInto (int ch, AudioEffect *effect)
	clones a single effect into a single channel's chain, tracking ownership

virtual int	not_supported (int out, const char *msg="")

void	notifyAudioChange (AudioInfo info)

void	refillReadBuffer ()
	Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()

void	setupChannels ()
	(re)builds channel_effects from the template `effects` chain

Protected Attributes
int	_timeout = 10

bool	active = false

Vector< AudioEffectCommon >	channel_effects

AudioEffectCommon	effects

AudioInfo	info

bool	is_notify_active = true

Vector< AudioInfoSupport * >	notify_vector

Vector< AudioEffect * >	owned_clones

Stream *	p_io =nullptr

Print *	p_print =nullptr

RingBuffer< uint8_t >	tmp_in {0}

RingBuffer< uint8_t >	tmp_out {0}

int	write_buffer_size = MAX_SINGLE_CHARS

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. Each channel is processed by its own independent clone of the effect chain (created via AudioEffect::clone()), so e.g. a stereo signal keeps its channel separation and effects that carry internal state (Delay's ring buffer, ADSRGain/Tremolo's envelope or oscillator phase, etc.) don't get confused by interleaved samples from different channels. addEffect() adds to a shared template chain that is cloned into every channel on begin() (and immediately cloned into all already-active channels if called afterwards); use addEffect(channel, effect) to register an effect directly on just one channel instead. Note that size()/operator[]/findEffect() operate on the template chain, not on the per-channel clones: mutating a pointer obtained from them after begin() has already cloned it does not retroactively change already-cloned per-channel copies. 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

Constructor & Destructor Documentation

◆ AudioEffectStreamT() [1/4]

template<class T >

AudioEffectStreamT ( )

default

◆ AudioEffectStreamT() [2/4]

template<class T >

AudioEffectStreamT ( Stream & io )

inline

◆ AudioEffectStreamT() [3/4]

template<class T >

AudioEffectStreamT ( Print & out )

inline

◆ AudioEffectStreamT() [4/4]

template<class T >

AudioEffectStreamT ( const AudioEffectStreamT< T > & )

delete

◆ ~AudioEffectStreamT()

template<class T >

~AudioEffectStreamT ( )

inline

Member Function Documentation

◆ addEffect() [1/4]

template<class T >

void addEffect ( AudioEffect & effect )

inline

Adds an effect object (by reference) to the template chain: cloned into every channel.

◆ addEffect() [2/4]

template<class T >

void addEffect ( AudioEffect * effect )

inline

Adds an effect using a pointer to the template chain: cloned into every channel.

◆ addEffect() [3/4]

template<class T >

void addEffect	(	int	channel,
		AudioEffect &	effect
	)

inline

Adds an effect object (by reference) directly to a single channel's own chain (not cloned, not owned by this class). Requires begin() to have already been called.

◆ addEffect() [4/4]

template<class T >

void addEffect	(	int	channel,
		AudioEffect *	effect
	)

inline

Adds an effect using a pointer directly to a single channel's own chain (not cloned, not owned by this class). Requires begin() to have already been called.

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

◆ audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, EncodedAudioStream, PureDataStream, AdapterAudioOutputToAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and InputMerge< T >.

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in MP3EncoderShine, PureDataStream, PWMAudioOutput< PWMDriverT >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

◆ available()

template<class T >

int available ( )

inlineoverridevirtual

Reimplemented from BaseStream.

◆ availableForWrite()

template<class T >

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

◆ begin() [1/2]

template<class T >

bool begin ( )

inlinevirtual

Reimplemented from BaseStream.

◆ begin() [2/2]

template<class T >

bool begin ( AudioInfo cfg )

inline

◆ channelCount()

template<class T >

int channelCount ( )

inline

Provides the number of channels that have their own effect chain (valid after begin())

◆ channelEffects()

template<class T >

AudioEffectCommon & channelEffects ( int channel )

inline

Provides access to a single channel's own effect chain (valid after begin())

◆ clear()

template<class T >

void clear ( )

inline

deletes all defined effects

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ cloneInto()

template<class T >

void cloneInto	(	int	ch,
		AudioEffect *	effect
	)

inlineprotected

clones a single effect into a single channel's chain, tracking ownership

◆ defaultConfig()

template<class T >

AudioInfo defaultConfig ( )

inline

◆ end()

template<class T >

void end ( )

inlineoverridevirtual

Reimplemented from BaseStream.

◆ findEffect()

template<class T >

AudioEffect * findEffect ( int id )

inline

Finds an effect by id in the template chain.

◆ flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in PureDataStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, ReformatBaseStream, AudioStreamWrapper, ResampleStream, EncodedAudioStream, URLStream, BufferedTaskStream, I2SStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and BufferedStream.

◆ isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ not_supported()

virtual int not_supported	(	int	out,
		const char *	msg = `""`
	)

inlineprotectedvirtualinherited

◆ notifyAudioChange()

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in A2DPStream, ICYStreamT< T >, AudioBLEStream, PortAudioStream, URLStream, USBAudioDeviceBase, I2SStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, Pipeline, and AudioFFTBase.

◆ operator=()

template<class T >

AudioEffectStreamT & operator= ( const AudioEffectStreamT< T > & )

delete

◆ operator[]()

template<class T >

AudioEffect * operator[] ( int idx )

inline

gets an effect by index from the template chain

◆ readBytes()

template<class T >

size_t readBytes	(	uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

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

Reimplemented from AudioStream.

◆ readSilence()

virtual size_t readSilence	(	uint8_t *	buffer,
		size_t	length
	)

inlinevirtualinherited

Source to generate silence: just sets the buffer to 0.

◆ refillReadBuffer()

void refillReadBuffer ( )

inlineprotectedinherited

Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()

◆ removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ setAudioInfo()

virtual void setAudioInfo ( AudioInfo info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in VS1053Stream, WM8960Stream, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, VolumeStream, MiniAudioStream, PortAudioStream, I2SCodecStream, MozziStream, SPDIFOutput, AudioLoRa, AnalogAudioStream, I2SStream, TimerCallbackAudioStream, AudioBLEStream, MDFEchoCancellationStream< T, SampleType >, AudioKitStream, NRF24Stream, SPIAudioSlave, USBAudioDeviceBase, VBANStream, Equalizer3Bands, Equalizer3BandsPerChannel, AdapterAudioOutputToAudioStream, TimedStream, MeasuringStream, ProgressStream, CallbackStream, VolumeMeter, AudioInputMonitor, FormatConverterStream, FadeStream, GoertzelStream, Pipeline::ModifyingStreamAdapter, QualityAnalysisStream, AudioFFTBase, EncodedAudioStream, PureDataStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

◆ setNotifyActive()

void setNotifyActive ( bool flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active)

◆ setOutput() [1/2]

virtual void setOutput ( AudioOutput & out )

inlinevirtualinherited

Defines/Changes the output target and registers for audio change notifications.

Reimplemented in TimedStream, VolumeMeter, AudioInputMonitor, QualityAnalysisStream, ReformatBaseStream, FormatConverterStream, and EncodedAudioStream.

◆ setOutput() [2/2]

template<class T >

void setOutput ( Print & out )

inlineoverridevirtual

Defines/Changes the output target.

Implements ModifyingStream.

◆ setStream() [1/2]

virtual void setStream ( AudioStream & io )

inlinevirtualinherited

Defines/Changes the input & output and registers for audio change notifications.

Reimplemented in VolumeMeter, AudioInputMonitor, QualityAnalysisStream, FormatConverterStream, ReformatBaseStream, TimedStream, and EncodedAudioStream.

◆ setStream() [2/2]

template<class T >

void setStream ( Stream & in )

inlineoverridevirtual

Defines/Changes the input & output.

Implements ModifyingStream.

◆ setupChannels()

template<class T >

void setupChannels ( )

inlineprotected

(re)builds channel_effects from the template effects chain

◆ setWriteBufferSize()

void setWriteBufferSize ( int size )

inlineinherited

◆ size()

template<class T >

size_t size ( )

inline

Provides the actual number of defined effects in the template chain.

◆ write() [1/2]

template<class T >

size_t write	(	const uint8_t *	data,
		size_t	len
	)

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 AudioStream.

◆ write() [2/2]

virtual size_t write ( uint8_t ch )

inlineoverridevirtualinherited

Reimplemented in MemoryStream, AudioStreamWrapper, BufferedTaskStream, RingBufferStream, BufferedStream, and URLStream.

◆ writeSilence()

virtual void writeSilence ( size_t len )

inlinevirtualinherited

Writes len bytes of silence (=0).

Member Data Documentation

◆ _timeout

int _timeout = 10

protectedinherited

◆ active

template<class T >

bool active = false

protected

◆ channel_effects

template<class T >

Vector<AudioEffectCommon> channel_effects

protected

◆ effects

template<class T >

AudioEffectCommon effects

protected

◆ info

AudioInfo info

protectedinherited

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ owned_clones

template<class T >

Vector<AudioEffect*> owned_clones

protected

◆ p_io

template<class T >

Stream* p_io =nullptr

protected

◆ p_print

template<class T >

Print* p_print =nullptr

protected

◆ tmp_in

RingBuffer<uint8_t> tmp_in {0}

protectedinherited

◆ tmp_out

RingBuffer<uint8_t> tmp_out {0}

protectedinherited

◆ write_buffer_size

int write_buffer_size = MAX_SINGLE_CHARS

protectedinherited

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

src/AudioTools/CoreAudio/AudioEffects/AudioEffects.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AudioEffectStreamT() [1/4]

◆ AudioEffectStreamT() [2/4]

◆ AudioEffectStreamT() [3/4]

◆ AudioEffectStreamT() [4/4]

◆ ~AudioEffectStreamT()

Member Function Documentation

◆ addEffect() [1/4]

◆ addEffect() [2/4]

◆ addEffect() [3/4]

◆ addEffect() [4/4]

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ available()

◆ availableForWrite()

◆ begin() [1/2]

◆ begin() [2/2]

◆ channelCount()

◆ channelEffects()

◆ clear()

◆ clearNotifyAudioChange()

◆ cloneInto()

◆ defaultConfig()

◆ end()

◆ findEffect()

◆ flush()

◆ isNotifyActive()

◆ not_supported()

◆ notifyAudioChange()

◆ operator bool()

◆ operator=()

◆ operator[]()

◆ readBytes()

◆ readSilence()

◆ refillReadBuffer()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setNotifyActive()

◆ setOutput() [1/2]

◆ setOutput() [2/2]

◆ setStream() [1/2]

◆ setStream() [2/2]

◆ setupChannels()

◆ setWriteBufferSize()

◆ size()

◆ write() [1/2]

◆ write() [2/2]

◆ writeSilence()

Member Data Documentation

◆ _timeout

◆ active

◆ channel_effects

◆ effects

◆ info

◆ is_notify_active

◆ notify_vector

◆ owned_clones

◆ p_io

◆ p_print

◆ tmp_in

◆ tmp_out

◆ write_buffer_size