FilteredStream< T, TF > Class Template Reference

Stream to which we can apply Filters for each channel. The filter might change the result size! More...

#include <AudioStreams.h>

Inheritance diagram for FilteredStream< T, TF >:

Public Member Functions
	FilteredStream (Print &stream)
	FilteredStream (Print &stream, int channels)
	FilteredStream (Stream &stream)
	FilteredStream (Stream &stream, int channels)
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 ()
virtual int	available () override
virtual int	availableForWrite () override
bool	begin () override
bool	begin (AudioInfo info)
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end () override
virtual void	flush () override
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual	operator bool ()
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	setFilter (int channel, Filter< TF > &filter)
void	setFilter (int channel, Filter< TF > *filter)
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
void	setOutput (Print &stream) override
	Defines/Changes the output target.
void	setStream (Stream &stream) override
	Defines/Changes the input & output.
virtual 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
virtual int	not_supported (int out, const char *msg="")
void	notifyAudioChange (AudioInfo info)
void	refillReadBuffer ()

Protected Attributes
int	_timeout = 10
int	channels = 0
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
ConverterNChannels< T, TF > *	p_converter = nullptr
Print *	p_print = nullptr
Stream *	p_stream = nullptr
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}

Detailed Description

template<typename T, class TF>
class audio_tools::FilteredStream< T, TF >

Stream to which we can apply Filters for each channel. The filter might change the result size!

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, 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 PureDataStream, PWMAudioOutput, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, and ResampleStream.

available()

template<typename T , class TF >

virtual int available ( )

inlineoverridevirtual

Reimplemented from BaseStream.

availableForWrite()

template<typename T , class TF >

virtual int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin()

template<typename T , class TF >

bool begin ( )

inlineoverridevirtual

Reimplemented from BaseStream.

end()

template<typename T , class TF >

void end ( )

inlineoverridevirtual

Reimplemented from BaseStream.

flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.

operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in A2DPStream, I2SStream, MemoryStream, and Pipeline.

readBytes()

template<typename T , class TF >

size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtual

Reimplemented from AudioStream.

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in VS1053Stream, WM8960Stream, I2SBitBang, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, VolumeStream, MiniAudioStream, PortAudioStream, I2SCodecStream, MozziStream, SPDIFOutput, AudioLoRa, AnalogAudioStream, I2SStream, TimerCallbackAudioStream, AudioBLEStream, LoRaStream, AudioFFTBase, AudioKitStream, VBANStream, AnalogAudioArduino, Equalizer3Bands, AdapterAudioOutputToAudioStream, TimedStream, MeasuringStream, ProgressStream, CallbackStream, VolumeMeter, FormatConverterStream, FadeStream, Pipeline::ModifyingStreamAdapter, PureDataStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, Pipeline, and ResampleStream.

setFilter() [1/2]

template<typename T , class TF >

void setFilter ( int  channel, Filter< TF > &  filter  )

inline

defines the filter for an individual channel - the first channel is 0. The number of channels must have been defined before we can call this function.

setFilter() [2/2]

template<typename T , class TF >

void setFilter ( int  channel, Filter< TF > *  filter  )

inline

defines the filter for an individual channel - the first channel is 0. The number of channels must have been defined before we can call this function.

setOutput()

template<typename T , class TF >

void setOutput ( Print &  out )

inlineoverridevirtual

Defines/Changes the output target.

Implements ModifyingStream.

setStream()

template<typename T , class TF >

void setStream ( Stream &  in )

inlineoverridevirtual

Defines/Changes the input & output.

Implements ModifyingStream.

write() [1/2]

template<typename T , class TF >

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

inlineoverridevirtual

Reimplemented from AudioStream.

write() [2/2]

virtual size_t write ( uint8_t  ch )

inlineoverridevirtualinherited

Reimplemented in BufferedTaskStream, and BufferedStream.

---

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

• src/AudioTools/CoreAudio/AudioStreams.h