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 ()
	provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

virtual int	available () override

virtual int	availableForWrite () override

bool	begin () override

bool	begin (AudioInfo info)

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

virtual void	end ()

virtual void	flush () override

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

	operator bool ()

size_t	readBytes (uint8_t *data, size_t length) 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)
	Defines/Changes the output target.

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

virtual size_t	write (const uint8_t *buffer, size_t size) 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

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

◆ setFilter() [1/2]

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]

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.

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

src/AudioTools/AudioStreams.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Function Documentation

◆ setFilter() [1/2]

◆ setFilter() [2/2]

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