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 <AudioStreams.h>

Inheritance diagram for VolumeMeter:

Public Member Functions
	VolumeMeter (AudioOutput &ao)

	VolumeMeter (AudioStream &as)

	VolumeMeter (Print &print)

	VolumeMeter (Stream &stream)

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

virtual int	availableForWrite () override

bool	begin () override

bool	begin (AudioInfo info)

void	clear ()
	Resets the actual volume.

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.

virtual	operator bool ()

size_t	readBytes (uint8_t *data, size_t len)

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)
	Defines the input AudioInfo.

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

void	setOutput (Print &out) override
	Defines/Changes the output target.

void	setStream (Stream &io) override
	Defines/Changes the input & output.

float	volume ()

float	volume (int channel)

float	volumeAvg ()
	Average volume of all channels.

float	volumeAvg (int channel)
	Average volume of indicated channel.

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	volumePercent ()
	Volume 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 (int channel)
	Volume Ratio of indicated channel: max amplitude is 1.0.

size_t	write (const uint8_t *data, size_t len)

virtual size_t	write (uint8_t ch) override

virtual void	writeSilence (size_t len)
	Writes len bytes of silence (=0).

Protected Member Functions
void	commit ()

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

void	notifyAudioChange (AudioInfo info)

void	refillReadBuffer ()

void	updateVolume (float tmp, int j)

void	updateVolumes (const uint8_t *data, size_t len)

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

Protected Attributes
int	_timeout = 10

float	f_volume = 0

float	f_volume_tmp = 0

AudioInfo	info

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}

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

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, MP3DecoderMAD, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, MP3DecoderHelix, OggContainerDecoder, Pipeline, and Pipeline::ModifyingStreamAdapter.

◆ audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, PureDataStream, AdapterAudioOutputToAudioStream, GeneratedSoundStream< T >, and GeneratedSoundStream< int16_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, and ResampleStream.

◆ available()

virtual int available ( )

inlineoverridevirtualinherited

Reimplemented from Stream.

Reimplemented in AudioKitStream, A2DPStream, AudioFFTBase, HLSStream, I2SCodecStream, TfLiteAudioStream, UDPStream, ICYStreamT< T >, BufferedTaskStream, I2SStream, TimedStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, ConverterStream< T >, InputMerge< T >, Pipeline::ModifyingStreamAdapter, and VolumeStream.

◆ availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in UDPStream, A2DPStream, AudioFFTBase, I2SCodecStream, AbstractURLStream, URLStreamESP32, I2SStream, MeasuringStream, ProgressStream, and VolumeStream.

◆ begin()

bool begin ( )

inlineoverridevirtual

Reimplemented from BaseStream.

◆ end()

virtual void end ( )

inlinevirtualinherited

◆ flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.

◆ operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in A2DPStream, Pipeline, I2SStream, and MemoryStream.

◆ readBytes()

size_t readBytes	(	uint8_t *	data,
		size_t	len
	)

inlinevirtual

Reimplemented from AudioStream.

◆ setAudioInfo()

void setAudioInfo ( AudioInfo info )

inlinevirtual

Defines the input AudioInfo.

Reimplemented from AudioStream.

◆ setOutput()

void setOutput ( Print & out )

inlineoverridevirtual

Defines/Changes the output target.

Implements ModifyingStream.

◆ setStream()

void setStream ( Stream & in )

inlineoverridevirtual

Defines/Changes the input & output.

Implements ModifyingStream.

◆ volume() [1/2]

float volume ( )

inline

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

◆ volume() [2/2]

float volume ( int channel )

inline

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

◆ write() [1/2]

size_t write	(	const uint8_t *	data,
		size_t	len
	)

inlinevirtual

Reimplemented from AudioStream.

◆ write() [2/2]

virtual size_t write ( uint8_t ch )

inlineoverridevirtualinherited

Reimplemented in BufferedTaskStream, and BufferedStream.

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

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ available()

◆ availableForWrite()

◆ begin()

◆ end()

◆ flush()

◆ operator bool()

◆ readBytes()

◆ setAudioInfo()

◆ setOutput()

◆ setStream()

◆ volume() [1/2]

◆ volume() [2/2]

◆ write() [1/2]

◆ write() [2/2]