arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ConverterStream< T > Class Template Reference

Both the data of the read or write operations will be converted with the help of the indicated converter. More...

#include <AudioStreams.h>

Inheritance diagram for ConverterStream< T >:
ModifyingStream AudioStream Stream AudioInfoSupport AudioInfoSource Print

Public Member Functions

 ConverterStream (BaseConverter &converter)
 
 ConverterStream (Print &out, BaseConverter &converter)
 
 ConverterStream (Stream &stream, BaseConverter &converter)
 
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
 Returns the available bytes in the buffer: to be avoided.
 
virtual int availableForWrite ()
 
virtual bool begin ()
 
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 setConverter (BaseConverter &cnv)
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
void setOutput (Print &out)
 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)
 
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
 
AudioInfo info
 
bool is_notify_active = true
 
Vector< AudioInfoSupport * > notify_vector
 
BaseConverterp_converter
 
Printp_out = nullptr
 
Streamp_stream = nullptr
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 

Detailed Description

template<typename T>
class audio_tools::ConverterStream< T >

Both the data of the read or write operations will be converted with the help of the indicated converter.

Template Parameters
T
Parameters
out
converter

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