AnalogAudioArduino Class Reference

Analog Data IO using a timer and the Arduino analogRead() method and writing using analogWrite();. More...

#include <AnalogAudioArduino.h>

Inheritance diagram for AnalogAudioArduino:

Public Member Functions
	AnalogAudioArduino ()=default
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 ()
int	available () override
int	availableForWrite () override
bool	begin () override
	Reopen with last config.
bool	begin (AnalogConfigStd cfg)
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
AnalogConfigStd	defaultConfig ()
	provides the default configuration
void	end () override
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) override
	Provides the sampled audio data.
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
	Defines the input AudioInfo.
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
void	setWriteBufferSize (int size)
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)
	Writes len bytes of silence (=0).

Protected Member Functions
int	decimation ()
int	effectiveOutputSampleRate ()
	Returns the effective output sample rate.
bool	isCombinedChannel ()
bool	isDecimateActive ()
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()
bool	setupBuffer ()
bool	setupPins ()
	pinmode input for defined analog pins
bool	setupTimer ()
bool	setupTx ()
void	updateAvg ()
void	updateMinMax (int value)

Static Protected Member Functions
static void	callback (void *arg)
	Sample data and write to buffer.

Protected Attributes
int	_timeout = 10
int	avg_value
BaseBuffer< uint8_t > *	buffer = nullptr
AnalogConfigStd	config
int	count
int	decim = 1
uint16_t	frame_size = 0
AudioInfo	info
bool	is_active = false
bool	is_combined_channels = false
bool	is_notify_active = true
int	max
int	min
Vector< AudioInfoSupport * >	notify_vector
int	result_factor = 1
TimerAlarmRepeating	timer
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

Analog Data IO using a timer and the Arduino analogRead() method and writing using analogWrite();.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AnalogAudioArduino()

AnalogAudioArduino ( )

default

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

int available ( )

inlineoverridevirtual

Reimplemented from BaseStream.

availableForWrite()

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin() [1/2]

bool begin ( )

inlineoverridevirtual

Reopen with last config.

Reimplemented from BaseStream.

begin() [2/2]

bool begin ( AnalogConfigStd  cfg )

inline

callback()

static void callback ( void *  arg )

inlinestaticprotected

Sample data and write to buffer.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

decimation()

int decimation ( )

inlineprotected

defaultConfig()

AnalogConfigStd defaultConfig ( )

inline

provides the default configuration

effectiveOutputSampleRate()

int effectiveOutputSampleRate ( )

inlineprotected

Returns the effective output sample rate.

end()

void end ( )

inlineoverridevirtual

Reimplemented from BaseStream.

flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

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

isCombinedChannel()

bool isCombinedChannel ( )

inlineprotected

isDecimateActive()

bool isDecimateActive ( )

inlineprotected

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

isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

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

Provides the sampled audio data.

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

Defines the input AudioInfo.

Reimplemented from AudioStream.

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

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

setupBuffer()

bool setupBuffer ( )

inlineprotected

setupPins()

bool setupPins ( )

inlineprotected

pinmode input for defined analog pins

setupTimer()

bool setupTimer ( )

inlineprotected

setupTx()

bool setupTx ( )

inlineprotected

setWriteBufferSize()

void setWriteBufferSize ( int  size )

inlineinherited

updateAvg()

void updateAvg ( )

inlineprotected

updateMinMax()

void updateMinMax ( int  value )

inlineprotected

write() [1/2]

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

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

avg_value

int avg_value

protected

buffer

BaseBuffer<uint8_t>* buffer = nullptr

protected

config

AnalogConfigStd config

protected

count

int count

protected

decim

int decim = 1

protected

frame_size

uint16_t frame_size = 0

protected

info

AudioInfo info

protectedinherited

is_active

bool is_active = false

protected

is_combined_channels

bool is_combined_channels = false

protected

is_notify_active

bool is_notify_active = true

protectedinherited

max

int max

protected

min

int min

protected

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

result_factor

int result_factor = 1

protected

timer

TimerAlarmRepeating timer

protected

tmp_in

RingBuffer<uint8_t> tmp_in {0}

protectedinherited

tmp_out

RingBuffer<uint8_t> tmp_out {0}

protectedinherited

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/AudioAnalog/AnalogAudioArduino.h