I2SStream Class Reference

We support the Stream interface for the I2S access. In addition we allow a separate mute pin which might also be used to drive a LED... More...

#include <I2SStream.h>

Inheritance diagram for I2SStream:

Public Member Functions
	I2SStream ()=default
	~I2SStream ()
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 ()
virtual int	available () override
	Provides the available audio data.
virtual int	availableForWrite () override
	Provides the available audio data.
bool	begin ()
bool	begin (I2SConfig cfg)
	Starts the I2S interface.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
I2SConfig	defaultConfig (RxTxMode mode=TX_MODE)
	Provides the default configuration.
I2SDriver *	driver ()
	Provides access to the driver.
void	end ()
	Stops the I2S interface.
void	flush () override
bool	isActive ()
	Returns true if i2s is active.
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
	operator bool () override
	Returns true if i2s is active.
virtual size_t	readBytes (uint8_t *data, size_t len) override
	Reads the 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.
virtual void	setAudioInfo (AudioInfo info)
	updates the sample rate dynamically
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
void	setWriteBufferSize (int size)
virtual size_t	write (const uint8_t *data, size_t len)
	Writes the audio data to I2S.
virtual size_t	write (uint8_t ch) override
virtual void	writeSilence (size_t len)
	Writes len bytes of silence (=0).

Protected Member Functions
void	mute (bool is_mute)
	set mute pin on or off
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()

Protected Attributes
int	_timeout = 10
I2SDriver	i2s
AudioInfo	info
bool	is_active = false
bool	is_notify_active = true
int	mute_pin = -1
Vector< AudioInfoSupport * >	notify_vector
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

We support the Stream interface for the I2S access. In addition we allow a separate mute pin which might also be used to drive a LED...

Template Parameters

T

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

I2SStream()

I2SStream ( )

default

~I2SStream()

~I2SStream ( )

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

virtual int available ( )

inlineoverridevirtual

Provides the available audio data.

Reimplemented from BaseStream.

availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtual

Provides the available audio data.

Reimplemented from BaseStream.

begin() [1/2]

bool begin ( )

inlinevirtual

Reimplemented from BaseStream.

begin() [2/2]

bool begin ( I2SConfig  cfg )

inline

Starts the I2S interface.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

defaultConfig()

I2SConfig defaultConfig ( RxTxMode  mode = TX_MODE )

inline

Provides the default configuration.

driver()

I2SDriver * driver ( )

inline

Provides access to the driver.

end()

void end ( )

inlinevirtual

Stops the I2S interface.

Reimplemented from BaseStream.

flush()

void flush ( )

inlineoverridevirtual

Reimplemented from BaseStream.

isActive()

bool isActive ( )

inline

Returns true if i2s is active.

isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

mute()

void mute ( bool  is_mute )

inlineprotected

set mute pin on or off

not_supported()

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

inlineprotectedvirtualinherited

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

operator bool()

operator bool ( )

inlineoverridevirtual

Returns true if i2s is active.

Reimplemented from AudioStream.

readBytes()

virtual size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtual

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

virtual void setAudioInfo ( AudioInfo  info )

inlinevirtual

updates the sample rate dynamically

Reimplemented from AudioStream.

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

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

setWriteBufferSize()

void setWriteBufferSize ( int  size )

inlineinherited

write() [1/2]

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

inlinevirtual

Writes the audio data to I2S.

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

i2s

I2SDriver i2s

protected

info

AudioInfo info

protectedinherited

is_active

bool is_active = false

protected

is_notify_active

bool is_notify_active = true

protectedinherited

mute_pin

int mute_pin = -1

protected

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

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/AudioI2S/I2SStream.h