arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FormatConverterStream Class Reference

Converter which converts bits_per_sample, channels and the sample_rate. The conversion is supported both on the input and output side. More...

#include <AudioStreamsConverter.h>

Inheritance diagram for FormatConverterStream:
ReformatBaseStream ModifyingStream AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 FormatConverterStream (AudioOutput &print)
 
 FormatConverterStream (AudioStream &stream)
 
 FormatConverterStream (Print &print)
 
 FormatConverterStream (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
 
int available () override
 
int availableForWrite () override
 
virtual bool begin ()
 
bool begin (AudioInfo from)
 
bool begin (AudioInfo from, AudioInfo to)
 
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 info) override
 Defines the input AudioInfo.
 
void setAudioInfoOut (AudioInfo to)
 
void setBuffered (bool active)
 Buffering is active by default to minimize the number of output calls.
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
void setOutput (AudioOutput &print) override
 
void setOutput (Print &print) override
 Defines/Changes the output target.
 
void setStream (AudioStream &io) override
 
void setStream (Stream &io) 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.
 
float byteFactor ()
 
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
 
ChannelFormatConverterStream channelFormatConverter
 
AudioInfo from_cfg
 
AudioInfo info
 
bool is_buffered = true
 
bool is_notify_active = true
 
bool is_output_notify = false
 
Vector< AudioInfoSupport * > notify_vector
 
NumberFormatConverterStream numberFormatConverter
 
AudioInfoSupportp_notify_on_output = nullptr
 
Printp_print = nullptr
 
Streamp_stream = nullptr
 
TransformationReader< ReformatBaseStreamreader
 
ResampleStream sampleRateConverter
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 
AudioInfo to_cfg
 

Detailed Description

Converter which converts bits_per_sample, channels and the sample_rate. The conversion is supported both on the input and output side.

Author
Phil Schatzmann

Member Function Documentation

◆ byteFactor()

float byteFactor ( )
inlineprotected

e.g if we do channels 2->1 we nead to double the input data

Returns

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