arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
VolumeMeter Class Reference
Arduino Audio Tools » IO | Arduino Audio Tools » DSP » Volume

A simple class to determine the volume. You can use it as final output or as output or input in your audio chain. More...

#include <CodecOpusOgg.h>

Inheritance diagram for VolumeMeter:
ModifyingStream ModifyingStream AudioStream AudioStream AudioStream AudioStream AudioInfoSource AudioInfoSupport BaseStream AudioInfoSource AudioInfoSupport BaseStream AudioInfoSource AudioInfoSupport BaseStream AudioInfoSource AudioInfoSupport BaseStream AudioInfoSource AudioInfoSupport BaseStream AudioInfoSource AudioInfoSupport BaseStream AudioInfoSource AudioInfoSupport BaseStream AudioInfoSource AudioInfoSupport BaseStream

Public Member Functions

 VolumeMeter ()=default
 VolumeMeter ()=default
 VolumeMeter (AudioOutput &ao)
 VolumeMeter (AudioOutput &ao)
 VolumeMeter (AudioStream &as)
 VolumeMeter (AudioStream &as)
 VolumeMeter (Print &print)
 VolumeMeter (Print &print)
 VolumeMeter (Stream &stream)
 VolumeMeter (Stream &stream)
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
virtual AudioInfo audioInfoOut ()
virtual AudioInfo audioInfoOut ()
virtual int available () override
virtual int available () override
virtual int availableForWrite () override
virtual int availableForWrite () override
bool begin () override
bool begin () override
bool begin (AudioInfo info)
bool begin (AudioInfo info)
void clear ()
 Resets the actual volume.
void clear ()
 Resets the actual volume.
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
virtual void end ()
virtual void end ()
virtual void flush () override
virtual void flush () override
bool isActive () const
bool isActive () const
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
virtual operator bool ()
virtual operator bool ()
size_t readBytes (uint8_t *data, size_t len) override
size_t readBytes (uint8_t *data, size_t len) override
virtual size_t readSilence (uint8_t *buffer, size_t length)
 Source to generate silence: just sets the buffer to 0.
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 bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
void setActivityCallback (ActivityCallback callback, float threshold=0.2, unsigned long duration_ms=2000)
void setActivityCallback (ActivityCallback callback, float threshold=0.2, unsigned long duration_ms=2000)
void setAudioInfo (AudioInfo info) override
 Defines the input AudioInfo.
void setAudioInfo (AudioInfo info) override
 Defines the input AudioInfo.
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void setOutput (AudioOutput &out)
 Defines/Changes the output target and registers for audio change notifications.
void setOutput (AudioOutput &out)
 Defines/Changes the output target and registers for audio change notifications.
void setOutput (Print &out) override
 Defines/Changes the output target.
void setOutput (Print &out) override
 Defines/Changes the output target.
void setStream (AudioStream &io)
 Defines/Changes the input & output and registers for audio change notifications.
void setStream (AudioStream &io)
 Defines/Changes the input & output and registers for audio change notifications.
void setStream (Stream &io) override
 Defines/Changes the input & output.
void setStream (Stream &io) override
 Defines/Changes the input & output.
void setWriteBufferSize (int size)
void setWriteBufferSize (int size)
float volume ()
float volume ()
float volume (int channel)
float volume (int channel)
float volumeAvg ()
 Average volume of all channels.
float volumeAvg ()
 Average volume of all channels.
float volumeAvg (int channel)
 Average volume of indicated channel.
float volumeAvg (int channel)
 Average volume of indicated channel.
float volumeDB ()
 Volume in db: max amplitude is 0 (range: -1000 to 0).
float volumeDB ()
 Volume in db: max amplitude is 0 (range: -1000 to 0).
float volumeDB (int channel)
 Volume of indicated channel in db: max amplitude is 0.
float volumeDB (int channel)
 Volume of indicated channel in db: max amplitude is 0.
float volumePercent ()
 Volume in %: max amplitude is 100.
float volumePercent ()
 Volume in %: max amplitude is 100.
float volumePercent (int channel)
 Volume of indicated channel in %: max amplitude is 100.
float volumePercent (int channel)
 Volume of indicated channel in %: max amplitude is 100.
float volumeRatio ()
 Volume Ratio: max amplitude is 1.0.
float volumeRatio ()
 Volume Ratio: max amplitude is 1.0.
float volumeRatio (int channel)
 Volume Ratio of indicated channel: max amplitude is 1.0.
float volumeRatio (int channel)
 Volume Ratio of indicated channel: max amplitude is 1.0.
virtual size_t write (uint8_t ch) override
size_t write (const uint8_t *data, size_t len) override
size_t write (const uint8_t *data, size_t len) override
virtual void writeSilence (size_t len)
 Writes len bytes of silence (=0).
virtual void writeSilence (size_t len)
 Writes len bytes of silence (=0).

Protected Member Functions

void commit ()
void commit ()
virtual int not_supported (int out, const char *msg="")
virtual int not_supported (int out, const char *msg="")
void notifyAudioChange (AudioInfo info)
void notifyAudioChange (AudioInfo info)
void refillReadBuffer ()
 Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read().
void refillReadBuffer ()
 Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read().
void updateActivityState ()
void updateActivityState ()
void updateVolume (float tmp, int j)
void updateVolume (float tmp, int j)
void updateVolumes (const uint8_t *data, size_t len)
void updateVolumes (const uint8_t *data, size_t len)
template<typename T>
void updateVolumesT (const uint8_t *buffer, size_t size)
template<typename T>
void updateVolumesT (const uint8_t *buffer, size_t size)

Protected Attributes

int _timeout = 10
ActivityCallback activity_callback = nullptr
unsigned long activity_duration_ms = 0
bool activity_monitoring_enabled = false
float activity_threshold = 0.0f
float f_volume = 0
float f_volume_tmp = 0
unsigned long inactive_start_time = 0
AudioInfo info
bool is_active = false
bool is_notify_active = true
Vector< AudioInfoSupport * > notify_vector
Print * p_out = nullptr
Stream * p_stream = nullptr
size_t sample_count_per_channel = 0
Vector< float > sum {0}
Vector< float > sum_tmp {0}
RingBuffer< uint8_t > tmp_in {0}
RingBuffer< uint8_t > tmp_out {0}
Vector< float > volumes {0}
Vector< float > volumes_tmp {0}
int write_buffer_size = 8

Detailed Description

A simple class to determine the volume. You can use it as final output or as output or input in your audio chain.

Author
Phil Schatzmann
Copyright
GPLv3

Constructor & Destructor Documentation

◆ VolumeMeter() [1/10]

VolumeMeter ( )
default

◆ VolumeMeter() [2/10]

VolumeMeter ( AudioStream & as)
inline

◆ VolumeMeter() [3/10]

VolumeMeter ( AudioOutput & ao)
inline

◆ VolumeMeter() [4/10]

VolumeMeter ( Print & print)
inline

◆ VolumeMeter() [5/10]

VolumeMeter ( Stream & stream)
inline

◆ VolumeMeter() [6/10]

VolumeMeter ( )
default

◆ VolumeMeter() [7/10]

VolumeMeter ( AudioStream & as)
inline

◆ VolumeMeter() [8/10]

VolumeMeter ( AudioOutput & ao)
inline

◆ VolumeMeter() [9/10]

VolumeMeter ( Print & print)
inline

◆ VolumeMeter() [10/10]

VolumeMeter ( Stream & stream)
inline

Member Function Documentation

◆ addNotifyAudioChange() [1/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi)
inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ addNotifyAudioChange() [2/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi)
inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ audioInfo() [1/2]

virtual AudioInfo audioInfo ( )
inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterAudioOutputToAudioStream, AdapterAudioOutputToAudioStream, EncodedAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, TimerCallbackAudioStream, TimerCallbackAudioStream, EncodedAudioStream, GeneratedSoundStream< T >, InputMerge< T >, JupyterAudioT< T >, JupyterAudioT< int16_t >, MozziStream, PureDataStream, and TimerCallbackAudioStream.

◆ audioInfo() [2/2]

virtual AudioInfo audioInfo ( )
inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterAudioOutputToAudioStream, AdapterAudioOutputToAudioStream, EncodedAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, TimerCallbackAudioStream, TimerCallbackAudioStream, EncodedAudioStream, GeneratedSoundStream< T >, InputMerge< T >, JupyterAudioT< T >, JupyterAudioT< int16_t >, MozziStream, PureDataStream, and TimerCallbackAudioStream.

◆ audioInfoOut() [1/2]

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

◆ audioInfoOut() [2/2]

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

◆ available() [1/2]

virtual int available ( )
inlineoverridevirtualinherited

Reimplemented from Stream.

Reimplemented in A2DPStream, AnalogAudioStream, AudioStreamWrapper, AudioStreamWrapper, BufferedStream, BufferedStream, CallbackStream, CallbackStream, CatStream, CatStream, ConverterStream< T >, ConverterStream< T >, DynamicMemoryStream, DynamicMemoryStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, InputMixer< T, SumT >, InputMixer< T, SumT >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, RingBufferStream, RingBufferStream, Throttle, Throttle, TimedStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioKitStream, AudioLoRa, AudioMP34DT05, AudioStreamWrapper, AutomaticGainControlStream, BufferedStream, BufferedTaskStream, CallbackStream, CatStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, ConverterStream< T >, DynamicMemoryStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, ESPNowStream, FadeStream, FaustStream< DSP >, FileLoopT< FileType >, FileLoopT< File >, FilteredStream< T, TF >, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GeneratedSoundStream< T >, HammingFEC< bytecount, block_t >, HLSStreamT< URLStream >, HLSStreamT< URLStreamESP32 >, HttpRequest, I2SCodecStream, I2SStream, ICYStreamT< T >, ICYStreamT< URLStream >, ICYStreamT< URLStreamESP32 >, InputMerge< T >, InputMixer< T, SumT >, MeasuringStream, MemoryStream, MiniAudioStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, Pipeline::ModifyingStreamAdapter, ProgressStream, QualityAnalysisStream, QueueStream< T >, ReedSolomonFEC< bytecount, additional_bytes >, ReformatBaseStream, RingBufferStream, SPIAudioSlave, StdioStream, SupportedRatesStream, TfLiteAudioStream, Throttle, TimedStream, UDPStream, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamBufferedT< ICYStreamESP32 >, URLStreamBufferedT< URLStream >, URLStreamBufferedT< URLStreamESP32 >, USBAudioStreamBase, VBANStream, and VolumeStream.

◆ available() [2/2]

virtual int available ( )
inlineoverridevirtualinherited

Reimplemented from Stream.

Reimplemented in A2DPStream, AnalogAudioStream, AudioStreamWrapper, AudioStreamWrapper, BufferedStream, BufferedStream, CallbackStream, CallbackStream, CatStream, CatStream, ConverterStream< T >, ConverterStream< T >, DynamicMemoryStream, DynamicMemoryStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, InputMixer< T, SumT >, InputMixer< T, SumT >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, RingBufferStream, RingBufferStream, Throttle, Throttle, TimedStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioKitStream, AudioLoRa, AudioMP34DT05, AudioStreamWrapper, AutomaticGainControlStream, BufferedStream, BufferedTaskStream, CallbackStream, CatStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, ConverterStream< T >, DynamicMemoryStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, ESPNowStream, FadeStream, FaustStream< DSP >, FileLoopT< FileType >, FileLoopT< File >, FilteredStream< T, TF >, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GeneratedSoundStream< T >, HammingFEC< bytecount, block_t >, HLSStreamT< URLStream >, HLSStreamT< URLStreamESP32 >, HttpRequest, I2SCodecStream, I2SStream, ICYStreamT< T >, ICYStreamT< URLStream >, ICYStreamT< URLStreamESP32 >, InputMerge< T >, InputMixer< T, SumT >, MeasuringStream, MemoryStream, MiniAudioStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, Pipeline::ModifyingStreamAdapter, ProgressStream, QualityAnalysisStream, QueueStream< T >, ReedSolomonFEC< bytecount, additional_bytes >, ReformatBaseStream, RingBufferStream, SPIAudioSlave, StdioStream, SupportedRatesStream, TfLiteAudioStream, Throttle, TimedStream, UDPStream, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamBufferedT< ICYStreamESP32 >, URLStreamBufferedT< URLStream >, URLStreamBufferedT< URLStreamESP32 >, USBAudioStreamBase, VBANStream, and VolumeStream.

◆ availableForWrite() [1/2]

virtual int availableForWrite ( )
inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in A2DPStream, AbstractURLStream, AnalogAudioStream, AudioStreamWrapper, AudioStreamWrapper, ConverterStream< T >, ConverterStream< T >, DynamicMemoryStream, DynamicMemoryStream, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, RingBufferStream, RingBufferStream, Throttle, Throttle, TimedStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioLoRa, AudioStreamWrapper, AutomaticGainControlStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, ConverterStream< T >, DynamicMemoryStream, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, ESPNowStream, FadeStream, FaustStream< DSP >, FilteredStream< T, TF >, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, HammingFEC< bytecount, block_t >, I2SCodecStream, I2SStream, MeasuringStream, MemoryStream, MiniAudioStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, ProgressStream, QualityAnalysisStream, QueueStream< T >, ReedSolomonFEC< bytecount, additional_bytes >, ReformatBaseStream, RingBufferStream, SPIAudioSlave, StdioStream, SupportedRatesStream, Throttle, TimedStream, UDPStream, URLStreamESP32, USBAudioStreamBase, VBANStream, and VolumeStream.

◆ availableForWrite() [2/2]

virtual int availableForWrite ( )
inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in A2DPStream, AbstractURLStream, AnalogAudioStream, AudioStreamWrapper, AudioStreamWrapper, ConverterStream< T >, ConverterStream< T >, DynamicMemoryStream, DynamicMemoryStream, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, RingBufferStream, RingBufferStream, Throttle, Throttle, TimedStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioLoRa, AudioStreamWrapper, AutomaticGainControlStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, ConverterStream< T >, DynamicMemoryStream, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, ESPNowStream, FadeStream, FaustStream< DSP >, FilteredStream< T, TF >, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, HammingFEC< bytecount, block_t >, I2SCodecStream, I2SStream, MeasuringStream, MemoryStream, MiniAudioStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, ProgressStream, QualityAnalysisStream, QueueStream< T >, ReedSolomonFEC< bytecount, additional_bytes >, ReformatBaseStream, RingBufferStream, SPIAudioSlave, StdioStream, SupportedRatesStream, Throttle, TimedStream, UDPStream, URLStreamESP32, USBAudioStreamBase, VBANStream, and VolumeStream.

◆ begin() [1/4]

bool begin ( )
inlineoverridevirtual

Reimplemented from BaseStream.

◆ begin() [2/4]

bool begin ( )
inlineoverridevirtual

Reimplemented from BaseStream.

◆ begin() [3/4]

bool begin ( AudioInfo info)
inline

◆ begin() [4/4]

bool begin ( AudioInfo info)
inline

◆ clear() [1/2]

void clear ( )
inline

Resets the actual volume.

◆ clear() [2/2]

void clear ( )
inline

Resets the actual volume.

◆ clearNotifyAudioChange() [1/2]

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

◆ clearNotifyAudioChange() [2/2]

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

◆ commit() [1/2]

void commit ( )
inlineprotected

◆ commit() [2/2]

void commit ( )
inlineprotected

◆ end() [1/2]

virtual void end ( )
inlinevirtualinherited

Reimplemented in A2DPStream, AbstractURLStream, AdapterAudioOutputToAudioStream, AdaptiveResamplingStream, AnalogAudioStream, AdapterAudioOutputToAudioStream, AudioStreamWrapper, AudioStreamWrapper, CallbackStream, CallbackStream, CatStream, CatStream, DynamicMemoryStream, DynamicMemoryStream, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, InputMixer< T, SumT >, InputMixer< T, SumT >, MemoryStream, MemoryStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, TimerCallbackAudioStream, TimerCallbackAudioStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioBLEStream, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioKitStream, AudioLoRa, AudioMP34DT05, AudioStreamWrapper, AutomaticGainControlStream, BufferedTaskStream, CallbackStream, CatStream, ChannelFormatConverterStream, DynamicMemoryStream, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, ESPNowStream, FaustStream< DSP >, FileLoopT< FileType >, FileLoopT< File >, FilteredStream< T, TF >, FormatConverterStream, GeneratedSoundStream< T >, GoertzelStream, HLSStreamT< URLStream >, HLSStreamT< URLStreamESP32 >, HttpRequest, I2SCodecStream, I2SStream, ICYStreamT< T >, ICYStreamT< URLStream >, ICYStreamT< URLStreamESP32 >, InputMerge< T >, InputMixer< T, SumT >, MemoryStream, MiniAudioStream, MozziStream, NRF24Stream, NumberFormatConverterStream, Pipeline, Pipeline::ModifyingStreamAdapter, PortAudioStream, PureDataStream, QueueStream< T >, ReformatBaseStream, SPDIFOutput, SPIAudioSlave, StdioStream, SupportedRatesStream, TimerCallbackAudioStream, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamBufferedT< ICYStreamESP32 >, URLStreamBufferedT< URLStream >, URLStreamBufferedT< URLStreamESP32 >, URLStreamESP32, USBAudioDeviceBase, USBAudioHostBase, VolumeStream, VS1053Stream, and WM8960Stream.

◆ end() [2/2]

virtual void end ( )
inlinevirtualinherited

Reimplemented in A2DPStream, AbstractURLStream, AdapterAudioOutputToAudioStream, AdaptiveResamplingStream, AnalogAudioStream, AdapterAudioOutputToAudioStream, AudioStreamWrapper, AudioStreamWrapper, CallbackStream, CallbackStream, CatStream, CatStream, DynamicMemoryStream, DynamicMemoryStream, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, InputMixer< T, SumT >, InputMixer< T, SumT >, MemoryStream, MemoryStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, TimerCallbackAudioStream, TimerCallbackAudioStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioBLEStream, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioKitStream, AudioLoRa, AudioMP34DT05, AudioStreamWrapper, AutomaticGainControlStream, BufferedTaskStream, CallbackStream, CatStream, ChannelFormatConverterStream, DynamicMemoryStream, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, ESPNowStream, FaustStream< DSP >, FileLoopT< FileType >, FileLoopT< File >, FilteredStream< T, TF >, FormatConverterStream, GeneratedSoundStream< T >, GoertzelStream, HLSStreamT< URLStream >, HLSStreamT< URLStreamESP32 >, HttpRequest, I2SCodecStream, I2SStream, ICYStreamT< T >, ICYStreamT< URLStream >, ICYStreamT< URLStreamESP32 >, InputMerge< T >, InputMixer< T, SumT >, MemoryStream, MiniAudioStream, MozziStream, NRF24Stream, NumberFormatConverterStream, Pipeline, Pipeline::ModifyingStreamAdapter, PortAudioStream, PureDataStream, QueueStream< T >, ReformatBaseStream, SPDIFOutput, SPIAudioSlave, StdioStream, SupportedRatesStream, TimerCallbackAudioStream, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamBufferedT< ICYStreamESP32 >, URLStreamBufferedT< URLStream >, URLStreamBufferedT< URLStreamESP32 >, URLStreamESP32, USBAudioDeviceBase, USBAudioHostBase, VolumeStream, VS1053Stream, and WM8960Stream.

◆ flush() [1/2]

virtual void flush ( )
inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AudioStreamWrapper, AudioStreamWrapper, BufferedStream, BufferedStream, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, MemoryStream, MemoryStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, RingBufferStream, RingBufferStream, TimedStream, AudioEffectStream, AudioEffectStreamT< T >, AudioStreamWrapper, AutomaticGainControlStream, BufferedStream, BufferedTaskStream, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, FadeStream, FilteredStream< T, TF >, GeneratedSoundStream< T >, I2SStream, MeasuringStream, MemoryStream, Pipeline::ModifyingStreamAdapter, PureDataStream, QualityAnalysisStream, QueueStream< T >, ReformatBaseStream, ResampleStream, RingBufferStream, SupportedRatesStream, TimedStream, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamBufferedT< ICYStreamESP32 >, URLStreamBufferedT< URLStream >, URLStreamBufferedT< URLStreamESP32 >, and VolumeStream.

◆ flush() [2/2]

virtual void flush ( )
inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AudioStreamWrapper, AudioStreamWrapper, BufferedStream, BufferedStream, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, MemoryStream, MemoryStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, RingBufferStream, RingBufferStream, TimedStream, AudioEffectStream, AudioEffectStreamT< T >, AudioStreamWrapper, AutomaticGainControlStream, BufferedStream, BufferedTaskStream, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, FadeStream, FilteredStream< T, TF >, GeneratedSoundStream< T >, I2SStream, MeasuringStream, MemoryStream, Pipeline::ModifyingStreamAdapter, PureDataStream, QualityAnalysisStream, QueueStream< T >, ReformatBaseStream, ResampleStream, RingBufferStream, SupportedRatesStream, TimedStream, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamBufferedT< ICYStreamESP32 >, URLStreamBufferedT< URLStream >, URLStreamBufferedT< URLStreamESP32 >, and VolumeStream.

◆ isActive() [1/2]

bool isActive ( ) const
inline

Get current activity state

Returns
true if active (volume above threshold), false if inactive

◆ isActive() [2/2]

bool isActive ( ) const
inline

Get current activity state

Returns
true if active (volume above threshold), false if inactive

◆ isNotifyActive() [1/2]

bool isNotifyActive ( )
inlineinherited

Checks if the automatic AudioInfo update is active.

◆ isNotifyActive() [2/2]

bool isNotifyActive ( )
inlineinherited

Checks if the automatic AudioInfo update is active.

◆ not_supported() [1/2]

virtual int not_supported ( int out,
const char * msg = "" )
inlineprotectedvirtualinherited

◆ not_supported() [2/2]

virtual int not_supported ( int out,
const char * msg = "" )
inlineprotectedvirtualinherited

◆ notifyAudioChange() [1/2]

void notifyAudioChange ( AudioInfo info)
inlineprotectedinherited

◆ notifyAudioChange() [2/2]

void notifyAudioChange ( AudioInfo info)
inlineprotectedinherited

◆ operator bool() [1/2]

virtual operator bool ( )
inlinevirtualinherited

Reimplemented in A2DPStream, AdapterAudioOutputToAudioStream, AdapterAudioOutputToAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, MemoryStream, MemoryStream, TimedStream, AudioBLEStream, AudioFFTBase, GeneratedSoundStream< T >, I2SStream, ICYStreamT< T >, ICYStreamT< URLStream >, ICYStreamT< URLStreamESP32 >, MemoryStream, Pipeline, PortAudioStream, TimedStream, URLStream, and USBAudioStreamBase.

◆ operator bool() [2/2]

virtual operator bool ( )
inlinevirtualinherited

Reimplemented in A2DPStream, AdapterAudioOutputToAudioStream, AdapterAudioOutputToAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, MemoryStream, MemoryStream, TimedStream, AudioBLEStream, AudioFFTBase, GeneratedSoundStream< T >, I2SStream, ICYStreamT< T >, ICYStreamT< URLStream >, ICYStreamT< URLStreamESP32 >, MemoryStream, Pipeline, PortAudioStream, TimedStream, URLStream, and USBAudioStreamBase.

◆ readBytes() [1/2]

size_t readBytes ( uint8_t * data,
size_t len )
inlineoverridevirtual

Reimplemented from AudioStream.

◆ readBytes() [2/2]

size_t readBytes ( uint8_t * data,
size_t len )
inlineoverridevirtual

Reimplemented from AudioStream.

◆ readSilence() [1/2]

virtual size_t readSilence ( uint8_t * buffer,
size_t length )
inlinevirtualinherited

Source to generate silence: just sets the buffer to 0.

◆ readSilence() [2/2]

virtual size_t readSilence ( uint8_t * buffer,
size_t length )
inlinevirtualinherited

Source to generate silence: just sets the buffer to 0.

◆ refillReadBuffer() [1/2]

void refillReadBuffer ( )
inlineprotectedinherited

Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read().

◆ refillReadBuffer() [2/2]

void refillReadBuffer ( )
inlineprotectedinherited

Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read().

◆ removeNotifyAudioChange() [1/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi)
inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

◆ removeNotifyAudioChange() [2/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi)
inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

◆ setActivityCallback() [1/2]

void setActivityCallback ( ActivityCallback callback,
float threshold = 0.2,
unsigned long duration_ms = 2000 )
inline

Set activity monitoring callback and configure threshold

Parameters
callbackFunction to call when activity state changes (nullptr to disable)
thresholdVolume threshold (0.0 to 1.0) - activity detected when volume exceeds this
duration_msTime in milliseconds volume must be below threshold to be considered inactive

◆ setActivityCallback() [2/2]

void setActivityCallback ( ActivityCallback callback,
float threshold = 0.2,
unsigned long duration_ms = 2000 )
inline

Set activity monitoring callback and configure threshold

Parameters
callbackFunction to call when activity state changes (nullptr to disable)
thresholdVolume threshold (0.0 to 1.0) - activity detected when volume exceeds this
duration_msTime in milliseconds volume must be below threshold to be considered inactive

◆ setAudioInfo() [1/2]

void setAudioInfo ( AudioInfo info)
inlineoverridevirtual

Defines the input AudioInfo.

Reimplemented from AudioStream.

◆ setAudioInfo() [2/2]

void setAudioInfo ( AudioInfo info)
inlineoverridevirtual

Defines the input AudioInfo.

Reimplemented from AudioStream.

◆ setNotifyActive() [1/2]

void setNotifyActive ( bool flag)
inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active).

◆ setNotifyActive() [2/2]

void setNotifyActive ( bool flag)
inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active).

◆ setOutput() [1/4]

void setOutput ( AudioOutput & out)
inlinevirtual

Defines/Changes the output target and registers for audio change notifications.

Reimplemented from ModifyingStream.

◆ setOutput() [2/4]

void setOutput ( AudioOutput & out)
inlinevirtual

Defines/Changes the output target and registers for audio change notifications.

Reimplemented from ModifyingStream.

◆ setOutput() [3/4]

void setOutput ( Print & out)
inlineoverridevirtual

Defines/Changes the output target.

Implements ModifyingStream.

◆ setOutput() [4/4]

void setOutput ( Print & out)
inlineoverridevirtual

Defines/Changes the output target.

Implements ModifyingStream.

◆ setStream() [1/4]

void setStream ( AudioStream & io)
inlinevirtual

Defines/Changes the input & output and registers for audio change notifications.

Reimplemented from ModifyingStream.

◆ setStream() [2/4]

void setStream ( AudioStream & io)
inlinevirtual

Defines/Changes the input & output and registers for audio change notifications.

Reimplemented from ModifyingStream.

◆ setStream() [3/4]

void setStream ( Stream & in)
inlineoverridevirtual

Defines/Changes the input & output.

Implements ModifyingStream.

◆ setStream() [4/4]

void setStream ( Stream & in)
inlineoverridevirtual

Defines/Changes the input & output.

Implements ModifyingStream.

◆ setWriteBufferSize() [1/2]

void setWriteBufferSize ( int size)
inlineinherited

◆ setWriteBufferSize() [2/2]

void setWriteBufferSize ( int size)
inlineinherited

◆ updateActivityState() [1/2]

void updateActivityState ( )
inlineprotected

◆ updateActivityState() [2/2]

void updateActivityState ( )
inlineprotected

◆ updateVolume() [1/2]

void updateVolume ( float tmp,
int j )
inlineprotected

◆ updateVolume() [2/2]

void updateVolume ( float tmp,
int j )
inlineprotected

◆ updateVolumes() [1/2]

void updateVolumes ( const uint8_t * data,
size_t len )
inlineprotected

◆ updateVolumes() [2/2]

void updateVolumes ( const uint8_t * data,
size_t len )
inlineprotected

◆ updateVolumesT() [1/2]

template<typename T>
void updateVolumesT ( const uint8_t * buffer,
size_t size )
inlineprotected

◆ updateVolumesT() [2/2]

template<typename T>
void updateVolumesT ( const uint8_t * buffer,
size_t size )
inlineprotected

◆ volume() [1/4]

float volume ( )
inline

Determines the volume (max amplitude). The range depends on the bits_per_sample.

◆ volume() [2/4]

float volume ( )
inline

Determines the volume (max amplitude). The range depends on the bits_per_sample.

◆ volume() [3/4]

float volume ( int channel)
inline

Determines the volume for the indicated channel. You must call the begin method to define the number of channels

◆ volume() [4/4]

float volume ( int channel)
inline

Determines the volume for the indicated channel. You must call the begin method to define the number of channels

◆ volumeAvg() [1/4]

float volumeAvg ( )
inline

Average volume of all channels.

◆ volumeAvg() [2/4]

float volumeAvg ( )
inline

Average volume of all channels.

◆ volumeAvg() [3/4]

float volumeAvg ( int channel)
inline

Average volume of indicated channel.

◆ volumeAvg() [4/4]

float volumeAvg ( int channel)
inline

Average volume of indicated channel.

◆ volumeDB() [1/4]

float volumeDB ( )
inline

Volume in db: max amplitude is 0 (range: -1000 to 0).

◆ volumeDB() [2/4]

float volumeDB ( )
inline

Volume in db: max amplitude is 0 (range: -1000 to 0).

◆ volumeDB() [3/4]

float volumeDB ( int channel)
inline

Volume of indicated channel in db: max amplitude is 0.

◆ volumeDB() [4/4]

float volumeDB ( int channel)
inline

Volume of indicated channel in db: max amplitude is 0.

◆ volumePercent() [1/4]

float volumePercent ( )
inline

Volume in %: max amplitude is 100.

◆ volumePercent() [2/4]

float volumePercent ( )
inline

Volume in %: max amplitude is 100.

◆ volumePercent() [3/4]

float volumePercent ( int channel)
inline

Volume of indicated channel in %: max amplitude is 100.

◆ volumePercent() [4/4]

float volumePercent ( int channel)
inline

Volume of indicated channel in %: max amplitude is 100.

◆ volumeRatio() [1/4]

float volumeRatio ( )
inline

Volume Ratio: max amplitude is 1.0.

◆ volumeRatio() [2/4]

float volumeRatio ( )
inline

Volume Ratio: max amplitude is 1.0.

◆ volumeRatio() [3/4]

float volumeRatio ( int channel)
inline

Volume Ratio of indicated channel: max amplitude is 1.0.

◆ volumeRatio() [4/4]

float volumeRatio ( int channel)
inline

Volume Ratio of indicated channel: max amplitude is 1.0.

◆ write() [1/3]

virtual size_t write ( uint8_t ch)
inlineoverridevirtualinherited

Reimplemented in AudioStreamWrapper, AudioStreamWrapper, BufferedStream, BufferedStream, MemoryStream, MemoryStream, RingBufferStream, RingBufferStream, AudioStreamWrapper, BufferedStream, BufferedTaskStream, MemoryStream, RingBufferStream, and URLStream.

◆ write() [2/3]

size_t write ( const uint8_t * data,
size_t len )
inlineoverridevirtual

Reimplemented from AudioStream.

◆ write() [3/3]

size_t write ( const uint8_t * data,
size_t len )
inlineoverridevirtual

Reimplemented from AudioStream.

◆ writeSilence() [1/2]

virtual void writeSilence ( size_t len)
inlinevirtualinherited

Writes len bytes of silence (=0).

◆ writeSilence() [2/2]

virtual void writeSilence ( size_t len)
inlinevirtualinherited

Writes len bytes of silence (=0).

Member Data Documentation

◆ _timeout

int _timeout = 10
protectedinherited

◆ activity_callback

ActivityCallback activity_callback = nullptr
protected

◆ activity_duration_ms

unsigned long activity_duration_ms = 0
protected

◆ activity_monitoring_enabled

bool activity_monitoring_enabled = false
protected

◆ activity_threshold

float activity_threshold = 0.0f
protected

◆ f_volume

float f_volume = 0
protected

◆ f_volume_tmp

float f_volume_tmp = 0
protected

◆ inactive_start_time

unsigned long inactive_start_time = 0
protected

◆ info

AudioInfo info
protectedinherited

◆ is_active

bool is_active = false
protected

◆ is_notify_active

bool is_notify_active = true
protectedinherited

◆ notify_vector

Vector< AudioInfoSupport * > notify_vector
protectedinherited

◆ p_out

Print * p_out = nullptr
protected

◆ p_stream

Stream * p_stream = nullptr
protected

◆ sample_count_per_channel

size_t sample_count_per_channel = 0
protected

◆ sum

Vector< float > sum {0}
protected

◆ sum_tmp

Vector< float > sum_tmp {0}
protected

◆ tmp_in

RingBuffer< uint8_t > tmp_in {0}
protectedinherited

◆ tmp_out

RingBuffer< uint8_t > tmp_out {0}
protectedinherited

◆ volumes

Vector< float > volumes {0}
protected

◆ volumes_tmp

Vector< float > volumes_tmp {0}
protected

◆ write_buffer_size

int write_buffer_size = 8
protectedinherited
The documentation for this class was generated from the following files:
Generated by doxygen 1.15.0