Monitors audio input and reports if the volume exceeds a specified limit within a given period. More...

#include <AudioStreams.h>

Inheritance diagram for AudioInputMonitor:

Public Member Functions
	AudioInputMonitor (AudioOutput &ao, uint8_t limitPercent=20)
	Construct a new AudioInputMonitor with an output.

	AudioInputMonitor (AudioStream &as, uint8_t limitPercent=20)
	Construct a new AudioInputMonitor with an input stream.

	AudioInputMonitor (Print &print, uint8_t limitPercent=20)
	Construct a new AudioInputMonitor with a Print output.

	AudioInputMonitor (Stream &stream, uint8_t limitPercent=20)
	Construct a new AudioInputMonitor with a Stream input.

	AudioInputMonitor (uint8_t limitPercent=20)
	Construct a new AudioInputMonitor with a volume limit in percent.

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 ()

virtual int	available () override

virtual int	availableForWrite () override

bool	begin () override
	Begin processing with the current audio information.

bool	begin (AudioInfo info)
	Begin processing with the given audio information.

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

virtual void	end ()

virtual void	flush () override

VolumeMeter &	getVolumeMeter ()
	Access the underlying VolumeMeter.

bool	isActive (uint16_t time_ms=1000)
	Returns true if the volume exceeded the limit during the last period.

bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.

uint8_t	limitPercent () const
	Get the current volume threshold as percent.

virtual	operator bool ()

size_t	readBytes (uint8_t *data, size_t len) override
	Read audio data from the monitor (same as VolumeMeter)

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
	Set the audio information.

void	setLimitPercent (uint8_t percent)
	Set the volume threshold as percent.

void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)

void	setOutput (AudioOutput &out)
	Set the output target.

void	setOutput (Print &out) override
	Set the output target.

void	setStream (AudioStream &io)
	Set the input stream.

void	setStream (Stream &io) override
	Set the input stream.

void	setWriteBufferSize (int size)

size_t	write (const uint8_t *data, size_t len) override
	Write audio data to the monitor (same as VolumeMeter)

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 ()
	Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()

Protected Attributes
int	_timeout = 10

AudioInfo	info

bool	is_notify_active = true

uint8_t	limit_percent = 20
	Threshold percent.

Vector< AudioInfoSupport * >	notify_vector

uint64_t	time_over_last_volume_limit = 0
	Last over-limit time (ms)

RingBuffer< uint8_t >	tmp_in {0}

RingBuffer< uint8_t >	tmp_out {0}

VolumeMeter	volume_meter
	Volume calculation.

int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

Monitors audio input and reports if the volume exceeds a specified limit within a given period.

This class uses a VolumeMeter internally and tracks if the input volume has exceeded the specified limit during the last period. It can be used in an audio processing chain as a ModifyingStream.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ AudioInputMonitor() [1/5]

AudioInputMonitor ( uint8_t limitPercent = 20 )

inline

Construct a new AudioInputMonitor with a volume limit in percent.

Parameters

limitPercent The volume threshold as percent (default: 20)

◆ AudioInputMonitor() [2/5]

AudioInputMonitor	(	AudioStream &	as,
		uint8_t	limitPercent = `20`
	)

inline

Construct a new AudioInputMonitor with an input stream.

Parameters

as	Reference to an AudioStream
limitPercent	The volume threshold as percent (default: 20)

◆ AudioInputMonitor() [3/5]

AudioInputMonitor	(	AudioOutput &	ao,
		uint8_t	limitPercent = `20`
	)

inline

Construct a new AudioInputMonitor with an output.

Parameters

ao	Reference to an AudioOutput
limitPercent	The volume threshold as percent (default: 20)

◆ AudioInputMonitor() [4/5]

AudioInputMonitor	(	Print &	print,
		uint8_t	limitPercent = `20`
	)

inline

Construct a new AudioInputMonitor with a Print output.

Parameters

print	Reference to a Print object
limitPercent	The volume threshold as percent (default: 20)

◆ AudioInputMonitor() [5/5]

AudioInputMonitor	(	Stream &	stream,
		uint8_t	limitPercent = `20`
	)

inline

Construct a new AudioInputMonitor with a Stream input.

Parameters

stream	Reference to a Stream object
limitPercent	The volume threshold as percent (default: 20)

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

◆ audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

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

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

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

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

◆ available()

virtual int available ( )

inlineoverridevirtualinherited

Reimplemented from Stream.

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

◆ availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

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

◆ begin() [1/2]

bool begin ( )

inlineoverridevirtual

Begin processing with the current audio information.

Returns: true if successful

Reimplemented from BaseStream.

◆ begin() [2/2]

bool begin ( AudioInfo info )

inline

Begin processing with the given audio information.

Parameters

info	AudioInfo structure

Returns: true if successful

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ end()

virtual void end ( )

inlinevirtualinherited

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

◆ flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in PureDataStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, ReformatBaseStream, AudioStreamWrapper, ResampleStream, EncodedAudioStream, URLStream, BufferedTaskStream, I2SStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and BufferedStream.

◆ getVolumeMeter()

VolumeMeter & getVolumeMeter ( )

inline

Access the underlying VolumeMeter.

Returns: Reference to the internal VolumeMeter

◆ isActive()

bool isActive ( uint16_t time_ms = 1000 )

inline

Returns true if the volume exceeded the limit during the last period.

Parameters

time_ms The period in milliseconds to check (default: 1000)

Returns: true if the volume exceeded the limit during the period

◆ isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ limitPercent()

uint8_t limitPercent ( ) const

inline

Get the current volume threshold as percent.

Returns: The current volume threshold (0-100)

◆ not_supported()

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

inlineprotectedvirtualinherited

◆ notifyAudioChange()

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool()

virtual operator bool ( )

inlinevirtualinherited

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

◆ readBytes()

size_t readBytes	(	uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

Read audio data from the monitor (same as VolumeMeter)

Parameters

data	Pointer to buffer to fill
len	Number of bytes to read

Returns: Number of bytes read

Reimplemented from AudioStream.

◆ readSilence()

virtual size_t readSilence	(	uint8_t *	buffer,
		size_t	length
	)

inlinevirtualinherited

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

◆ refillReadBuffer()

void refillReadBuffer ( )

inlineprotectedinherited

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

◆ removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

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

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ setAudioInfo()

void setAudioInfo ( AudioInfo info )

inlineoverridevirtual

Set the audio information.

Parameters

info	AudioInfo structure

Reimplemented from AudioStream.

◆ setLimitPercent()

void setLimitPercent ( uint8_t percent )

inline

Set the volume threshold as percent.

Parameters

percent The new volume threshold (0-100)

◆ setNotifyActive()

void setNotifyActive ( bool flag )

inlineinherited

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

◆ setOutput() [1/2]

void setOutput ( AudioOutput & out )

inline

Set the output target.

Parameters

out	Reference to a Print object

◆ setOutput() [2/2]

void setOutput ( Print & out )

inlineoverridevirtual

Set the output target.

Parameters

out	Reference to a Print object

Implements ModifyingStream.

◆ setStream() [1/2]

void setStream ( AudioStream & io )

inline

Set the input stream.

Parameters

io	Reference to a Stream object

◆ setStream() [2/2]

void setStream ( Stream & io )

inlineoverridevirtual

Set the input stream.

Parameters

io	Reference to a Stream object

Implements ModifyingStream.

◆ setWriteBufferSize()

void setWriteBufferSize ( int size )

inlineinherited

◆ write() [1/2]

size_t write	(	const uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

Write audio data to the monitor (same as VolumeMeter)

Parameters

data	Pointer to audio data
len	Number of bytes

Returns: Number of bytes written

Reimplemented from AudioStream.

◆ write() [2/2]

virtual size_t write ( uint8_t ch )

inlineoverridevirtualinherited

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

◆ writeSilence()

virtual void writeSilence ( size_t len )

inlinevirtualinherited

Writes len bytes of silence (=0).

Member Data Documentation

◆ _timeout

int _timeout = 10

protectedinherited

◆ info

AudioInfo info

protectedinherited

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ limit_percent

uint8_t limit_percent = 20

protected

Threshold percent.

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ time_over_last_volume_limit

uint64_t time_over_last_volume_limit = 0

protected

Last over-limit time (ms)

◆ tmp_in

RingBuffer<uint8_t> tmp_in {0}

protectedinherited

◆ tmp_out

RingBuffer<uint8_t> tmp_out {0}

protectedinherited

◆ volume_meter

VolumeMeter volume_meter

protected

Volume calculation.

◆ write_buffer_size

int write_buffer_size = MAX_SINGLE_CHARS

protectedinherited

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

src/AudioTools/CoreAudio/AudioStreams.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AudioInputMonitor() [1/5]

◆ AudioInputMonitor() [2/5]

◆ AudioInputMonitor() [3/5]

◆ AudioInputMonitor() [4/5]

◆ AudioInputMonitor() [5/5]

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ available()

◆ availableForWrite()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clearNotifyAudioChange()

◆ end()

◆ flush()

◆ getVolumeMeter()

◆ isActive()

◆ isNotifyActive()

◆ limitPercent()

◆ not_supported()

◆ notifyAudioChange()

◆ operator bool()

◆ readBytes()

◆ readSilence()

◆ refillReadBuffer()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setLimitPercent()

◆ setNotifyActive()

◆ setOutput() [1/2]

◆ setOutput() [2/2]

◆ setStream() [1/2]

◆ setStream() [2/2]

◆ setWriteBufferSize()

◆ write() [1/2]

◆ write() [2/2]

◆ writeSilence()

Member Data Documentation

◆ _timeout

◆ info

◆ is_notify_active

◆ limit_percent

◆ notify_vector

◆ time_over_last_volume_limit

◆ tmp_in

◆ tmp_out

◆ volume_meter

◆ write_buffer_size