PWMAudioOutput Class Reference

Common functionality for PWM output. We generate audio using PWM with a frequency that is above the hearing range. The sample rate is usually quite restricted, so we also automatically decimate the data. Further info see PWMConfig. More...

#include <PWMAudioOutput.h>

Inheritance diagram for PWMAudioOutput:

Public Member Functions
	PWMAudioOutput ()=default
	PWMAudioOutput (DriverPWMBase &ext_driver)
	~PWMAudioOutput ()
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
int	availableForWrite () override
bool	begin ()
virtual bool	begin (AudioInfo info)
bool	begin (PWMConfig config)
	starts the processing using Streams
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
PWMConfig	config ()
virtual PWMConfig	defaultConfig (RxTxMode mode=TX_MODE)
DriverPWMBase *	driver ()
virtual void	end () override
virtual void	flush ()
uint32_t	framesPerSecond ()
virtual bool	isDeletable ()
	If true we need to release the related memory in the destructor.
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual	operator bool ()
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
void	setAudioInfo (AudioInfo info) override
	updates the sample rate dynamically
void	setBuffer (BaseBuffer< uint8_t > *buffer)
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
uint32_t	underflowsPerSecond ()
size_t	write (const uint8_t *data, size_t len) override
virtual size_t	write (uint8_t ch) override
virtual void	writeSilence (size_t len)

Protected Member Functions
void	notifyAudioChange (AudioInfo info)

Protected Attributes
int	_timeout = 10
PWMConfig	audio_config
AudioInfo	cfg
PWMDriver	default_driver
bool	is_active = false
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
DriverPWMBase *	p_driver = &default_driver
SingleBuffer< uint8_t >	tmp {MAX_SINGLE_CHARS}
int	tmpPos = 0

Detailed Description

Common functionality for PWM output. We generate audio using PWM with a frequency that is above the hearing range. The sample rate is usually quite restricted, so we also automatically decimate the data. Further info see PWMConfig.

Constructor & Destructor Documentation

PWMAudioOutput() [1/2]

PWMAudioOutput ( )

default

PWMAudioOutput() [2/2]

PWMAudioOutput ( DriverPWMBase &  ext_driver )

inline

~PWMAudioOutput()

~PWMAudioOutput ( )

inline

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 AdapterPrintToAudioOutput, EncodedAudioOutput, and AdapterAudioStreamToAudioOutput.

audioInfoOut()

AudioInfo audioInfoOut ( )

inlineoverridevirtual

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

Reimplemented from AudioInfoSupport.

availableForWrite()

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

begin() [1/3]

bool begin ( )

inlinevirtual

Reimplemented from AudioOutput.

begin() [2/3]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

Reimplemented in AudioESP32ULP, RTSPOutput< Platform >, RTTTLOutput< T >, ChannelsSelectOutput, CsvOutput< T >, and EncodedAudioOutput.

begin() [3/3]

bool begin ( PWMConfig  config )

inline

starts the processing using Streams

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

config()

PWMConfig config ( )

inline

defaultConfig()

virtual PWMConfig defaultConfig ( RxTxMode  mode = TX_MODE )

inlinevirtual

driver()

DriverPWMBase * driver ( )

inline

end()

virtual void end ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

flush()

virtual void flush ( )

inlinevirtualinherited

Reimplemented from Print.

Reimplemented in MultiOutput, and HexDumpOutput.

framesPerSecond()

uint32_t framesPerSecond ( )

inline

isDeletable()

virtual bool isDeletable ( )

inlinevirtualinherited

If true we need to release the related memory in the destructor.

Reimplemented in AdapterPrintToAudioOutput, and AdapterAudioStreamToAudioOutput.

isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in RTSPOutput< Platform >, EncodedAudioOutput, and AdapterAudioStreamToAudioOutput.

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

updates the sample rate dynamically

Reimplemented from AudioOutput.

setBuffer()

void setBuffer ( BaseBuffer< uint8_t > *  buffer )

inline

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

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

underflowsPerSecond()

uint32_t underflowsPerSecond ( )

inline

write() [1/2]

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

Implements AudioOutput.

write() [2/2]

virtual size_t write ( uint8_t  ch )

inlineoverridevirtualinherited

Reimplemented in MetaDataOutput, and MultiOutput.

writeSilence()

virtual void writeSilence ( size_t  len )

inlinevirtualinherited

Writes n 0 values (= silence)

Parameters

len

Member Data Documentation

_timeout

int _timeout = 10

protectedinherited

audio_config

PWMConfig audio_config

protected

cfg

AudioInfo cfg

protectedinherited

default_driver

PWMDriver default_driver

protected

is_active

bool is_active = false

protectedinherited

is_notify_active

bool is_notify_active = true

protectedinherited

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

p_driver

DriverPWMBase* p_driver = &default_driver

protected

tmp

SingleBuffer<uint8_t> tmp {MAX_SINGLE_CHARS}

protectedinherited

tmpPos

int tmpPos = 0

protectedinherited

---

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

• src/AudioTools/CoreAudio/AudioPWM/PWMAudioOutput.h