arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
NumberFormatConverterStreamT< TFrom, TTo > Class Template Reference

Converter which converts from source bits_per_sample to target bits_per_sample. More...

#include <AudioStreamsConverter.h>

Inheritance diagram for NumberFormatConverterStreamT< TFrom, TTo >:
ReformatBaseStream ModifyingStream AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 NumberFormatConverterStreamT (AudioOutput &print)
 
 NumberFormatConverterStreamT (AudioStream &stream)
 
 NumberFormatConverterStreamT (float gain)
 
 NumberFormatConverterStreamT (Print &print)
 
 NumberFormatConverterStreamT (Stream &stream)
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
AudioInfo audioInfoOut () override
 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
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
void end () override
 
virtual void flush () override
 
float getByteFactor ()
 
virtual PrintgetPrint ()
 
virtual StreamgetStream ()
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
 operator bool ()
 
size_t readBytes (uint8_t *data, size_t size) 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.
 
void setAudioInfo (AudioInfo newInfo) override
 Defines the input AudioInfo.
 
void setBuffered (bool flag)
 
void setGain (float value)
 Defines the gain (only available when buffered is true)
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
virtual void setOutput (AudioOutput &print)
 
virtual void setOutput (Print &print) override
 Defines/Changes the output target.
 
virtual void setStream (AudioStream &stream)
 
virtual void setStream (Stream &stream) override
 Defines/Changes the input & output.
 
virtual size_t write (const uint8_t *data, 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

void addNotifyOnFirstWrite ()
 Add notification on first call of write.
 
virtual int not_supported (int out, const char *msg="")
 
void notifyAudioChange (AudioInfo info)
 
void refillReadBuffer ()
 
void setNotifyOnOutput (AudioInfoSupport &info)
 Define potential notification.
 
void setupReader ()
 

Protected Attributes

int _timeout = 10
 
SingleBuffer< uint8_t > buffer {0}
 
float gain = 1.0f
 
AudioInfo info
 
bool is_buffered = true
 
bool is_notify_active = true
 
bool is_output_notify = false
 
Vector< AudioInfoSupport * > notify_vector
 
AudioInfoSupportp_notify_on_output = nullptr
 
Printp_print = nullptr
 
Streamp_stream = nullptr
 
TransformationReader< ReformatBaseStreamreader
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 

Detailed Description

template<typename TFrom, typename TTo>
class audio_tools::NumberFormatConverterStreamT< TFrom, TTo >

Converter which converts from source bits_per_sample to target bits_per_sample.

Author
Phil Schatzmann
Template Parameters
Tspecifies the current data type for the result of the read or write.
TArgis the data type of the Stream or Print Object that is passed in the Constructor

Member Function Documentation

◆ setBuffered()

void setBuffered ( bool  flag)
inline

if set to true we do one big write, else we get a lot of single writes per sample


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