TimerCallbackAudioStream Class Reference

Callback driven Audio Source (rx_tx_mode==RX_MODE) or Audio Sink (rx_tx_mode==TX_MODE). This class allows to to integrate external libraries in order to consume or generate a data stream which is based on a timer. More...

#include <AudioStreams.h>

Inheritance diagram for TimerCallbackAudioStream:

Public Member Functions
AudioInfo	audioInfo ()
TimerCallbackAudioStreamInfo	audioInfoExt ()
	Provides the current audio information.
virtual int	available () override
	Returns the available bytes in the buffer: to be avoided.
virtual int	availableForWrite () override
bool	begin ()
	Restart the processing.
void	begin (TimerCallbackAudioStreamInfo config)
void	clear ()
	Clears all the data in the buffer.
uint16_t	currentSampleRate ()
	Provides the effective sample rate.
TimerCallbackAudioStreamInfo	defaultConfig ()
	Provides the default configuration.
void	end ()
	Stops the processing.
virtual void	flush () override
	empties the buffer
	operator bool ()
virtual int	peek () override
	peeks a byte - to be avoided
virtual int	read () override
	reads a byte - to be avoided
size_t	readBytes (uint8_t *data, size_t length) override
	Use this method !!
virtual size_t	readSilence (uint8_t *buffer, size_t length)
	Source to generate silence: just sets the buffer to 0.
virtual void	setAudioInfo (AudioInfo info)
	updates the audio information
void	setNotifyAudioChange (AudioInfoSupport &bi)
	Defines the target that needs to be notified.
virtual bool	validate (AudioInfo &info)
virtual size_t	write (const uint8_t *data, size_t len) override
	Use this method: write an array.
virtual size_t	write (uint8_t c) override
	writes a byte to the buffer
virtual void	writeSilence (size_t len)
	Writes len bytes of silence (=0).

Protected Member Functions
virtual void	measureSampleRate ()
	calculates the effective sample rate
virtual int	not_supported (int out, const char *msg="")
virtual void	notifyAudioChange ()
	Update Audio Information in target device.
virtual void	printSampleRate ()
	log and update effective sample rate
virtual size_t	readExt (uint8_t *data, size_t len) override
void	refill ()
void	refillReadBuffer ()
virtual size_t	writeExt (const uint8_t *data, size_t len) override

Static Protected Member Functions
static void	timerCallback (void *obj)

Protected Attributes
bool	active = false
RingBuffer< uint8_t > *	buffer = nullptr
TimerCallbackAudioStreamInfo	cfg
uint32_t	currentRateValue = 0
uint8_t *	frame = nullptr
uint16_t(*	frameCallback )(uint8_t *data, uint16_t len)
uint16_t	frameSize = 0
AudioInfo	info
unsigned long	lastTimestamp = 0u
AudioInfoSupport *	notifyTarget = nullptr
AudioInfoSupport *	p_notify =nullptr
uint32_t	printCount = 0
uint32_t	time = 0
TimerAlarmRepeating *	timer = nullptr
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}

Friends
void	timerCallback (void *obj)

Detailed Description

Callback driven Audio Source (rx_tx_mode==RX_MODE) or Audio Sink (rx_tx_mode==TX_MODE). This class allows to to integrate external libraries in order to consume or generate a data stream which is based on a timer.

Author

Phil Schatzmann

Copyright

GPLv3

---

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

• src/AudioTools/AudioStreams.h