arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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 >:
AudioStream Stream AudioInfoSupport AudioInfoSource Print

Public Member Functions

 FilteredStream (Stream &stream)
 
 FilteredStream (Stream &stream, int channels)
 
virtual AudioInfo audioInfo () override
 
virtual int available () override
 
virtual int availableForWrite () override
 
bool begin () override
 
bool begin (AudioInfo info)
 
virtual void end ()
 
virtual void flush () override
 
 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 void setAudioInfo (AudioInfo info) override
 
void setFilter (int channel, Filter< TF > &filter)
 
void setFilter (int channel, Filter< TF > *filter)
 
virtual void setNotifyAudioChange (AudioInfoSupport &bi) override
 
virtual bool validate (AudioInfo &info)
 
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 refillReadBuffer ()
 

Protected Attributes

int channels =0
 
AudioInfo info
 
ConverterNChannels< T, TF > * p_converter
 
AudioInfoSupportp_notify =nullptr
 
Streamp_stream
 
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

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: