DriverPWMBase Class Reference

Base Class for all PWM drivers. More...

#include <PWMDriverBase.h>

Inheritance diagram for DriverPWMBase:

Public Member Functions
	DriverPWMBase ()=default
virtual	~DriverPWMBase ()
PWMConfig &	audioInfo ()
virtual int	availableForWrite ()
bool	begin (PWMConfig cfg)
virtual PWMConfig	defaultConfig ()
virtual int	effectiveOutputSampleRate ()
	Provides the effective sample rate.
virtual void	end ()
uint32_t	framesPerSecond ()
bool	isTimerStarted ()
virtual int	maxChannels ()=0
virtual int	maxOutputValue ()=0
virtual void	pwmWrite (int channel, int value)=0
void	setBuffer (BaseBuffer< uint8_t > *buffer)
virtual void	setupPWM ()=0
virtual void	setupTimer ()=0
virtual void	startTimer ()=0
uint32_t	underflowsPerSecond ()
void	updateStatistics ()
virtual size_t	write (const uint8_t *data, size_t len)

Protected Member Functions
virtual int	decimation ()
	Decimation factor to reduce the sample rate.
void	deleteBuffer ()
virtual bool	isDecimateActive ()
virtual int	maxSampleRate ()
	Provides the max working sample rate.
virtual int	nextValue ()
	determines the next scaled value
void	playNextFrame ()
	writes the next frame to the output pins

Protected Attributes
AudioInfo	actual_info
PWMConfig	audio_config
BaseBuffer< uint8_t > *	buffer = nullptr
Decimate	decimate
int	decimation_factor = 0
uint32_t	frame_count = 0
uint32_t	frame_size = 0
uint32_t	frames_per_second = 0
bool	is_blocking_write = true
bool	is_timer_started = false
uint32_t	time_1_sec
uint32_t	underflow_count = 0
uint32_t	underflow_per_second = 0

Detailed Description

Base Class for all PWM drivers.

Constructor & Destructor Documentation

DriverPWMBase()

DriverPWMBase ( )

default

~DriverPWMBase()

virtual ~DriverPWMBase ( )

inlinevirtual

Member Function Documentation

audioInfo()

PWMConfig & audioInfo ( )

inline

availableForWrite()

virtual int availableForWrite ( )

inlinevirtual

begin()

bool begin ( PWMConfig  cfg )

inline

decimation()

virtual int decimation ( )

inlineprotectedvirtual

Decimation factor to reduce the sample rate.

Reimplemented in PWMDriverRenesas.

defaultConfig()

virtual PWMConfig defaultConfig ( )

inlinevirtual

Reimplemented in PWMDriverRenesas.

deleteBuffer()

void deleteBuffer ( )

inlineprotected

effectiveOutputSampleRate()

virtual int effectiveOutputSampleRate ( )

inlinevirtual

Provides the effective sample rate.

end()

virtual void end ( )

inlinevirtual

Reimplemented in PWMComplementaryDriverESP32, PWMDriverAVR, PWMDriverESP32, PWMDriverMBED, PWMDriverRenesas, and PWMDriverSTM32.

framesPerSecond()

uint32_t framesPerSecond ( )

inline

isDecimateActive()

virtual bool isDecimateActive ( )

inlineprotectedvirtual

The requested sampling rate is too hight: we only process half of the samples so we can half the sampling rate

isTimerStarted()

bool isTimerStarted ( )

inline

maxChannels()

virtual int maxChannels ( )

pure virtual

Implemented in PWMComplementaryDriverESP32, PWMDriverAVR, PWMDriverESP32, PWMDriverMBED, PWMDriverRenesas, and PWMDriverSTM32.

maxOutputValue()

virtual int maxOutputValue ( )

pure virtual

Implemented in PWMComplementaryDriverESP32, PWMDriverAVR, PWMDriverESP32, PWMDriverMBED, PWMDriverRenesas, and PWMDriverSTM32.

maxSampleRate()

virtual int maxSampleRate ( )

inlineprotectedvirtual

Provides the max working sample rate.

Reimplemented in PWMDriverRenesas.

nextValue()

virtual int nextValue ( )

inlineprotectedvirtual

determines the next scaled value

playNextFrame()

void playNextFrame ( )

inlineprotected

writes the next frame to the output pins

pwmWrite()

virtual void pwmWrite ( int  channel, int  value  )

pure virtual

Implemented in PWMComplementaryDriverESP32, PWMDriverAVR, PWMDriverESP32, PWMDriverMBED, PWMDriverRenesas, and PWMDriverSTM32.

setBuffer()

void setBuffer ( BaseBuffer< uint8_t > *  buffer )

inline

You can assign your own custom buffer impelementation: must be allocated on the heap and will be cleaned up by this class

setupPWM()

virtual void setupPWM ( )

pure virtual

Implemented in PWMComplementaryDriverESP32, PWMDriverAVR, PWMDriverESP32, PWMDriverMBED, PWMDriverRenesas, and PWMDriverSTM32.

setupTimer()

virtual void setupTimer ( )

pure virtual

Implemented in PWMComplementaryDriverESP32, PWMDriverAVR, PWMDriverESP32, PWMDriverMBED, PWMDriverRenesas, and PWMDriverSTM32.

startTimer()

virtual void startTimer ( )

pure virtual

Implemented in PWMComplementaryDriverESP32, PWMDriverAVR, PWMDriverESP32, PWMDriverMBED, PWMDriverRenesas, and PWMDriverSTM32.

underflowsPerSecond()

uint32_t underflowsPerSecond ( )

inline

updateStatistics()

void updateStatistics ( )

inline

write()

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

inlinevirtual

Member Data Documentation

actual_info

AudioInfo actual_info

protected

audio_config

PWMConfig audio_config

protected

buffer

BaseBuffer<uint8_t>* buffer = nullptr

protected

decimate

Decimate decimate

protected

decimation_factor

int decimation_factor = 0

protected

frame_count

uint32_t frame_count = 0

protected

frame_size

uint32_t frame_size = 0

protected

frames_per_second

uint32_t frames_per_second = 0

protected

is_blocking_write

bool is_blocking_write = true

protected

is_timer_started

bool is_timer_started = false

protected

time_1_sec

uint32_t time_1_sec

protected

underflow_count

uint32_t underflow_count = 0

protected

underflow_per_second

uint32_t underflow_per_second = 0

protected

---

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

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