WM8960Stream Class Reference

Stream for reading and writing audio data using the WM8960 Codec Chip You need to install https://github.com/pschatzmann/arduino-wm8960. More...

#include <WM8960Stream.h>

Inheritance diagram for WM8960Stream:

Public Member Functions
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
virtual int	availableForWrite () override
bool	begin ()
	Starts with the default config or restarts.
bool	begin (WM8960Config config)
	Starts with the indicated configuration.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
WM8960Config	defaultConfig (RxTxMode mode=TX_MODE)
void	end ()
	Stops the processing and releases the memory.
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 size) override
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 c)
	Defines the input AudioInfo.
void	setAudioInfo (WM8960Config c)
	defines the default configuration that is used with the next begin()
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
bool	setVolume (float vol)
	Sets both input and output volume value (from 0 to 1.0)
void	setVolumeIn (float vol)
void	setVolumeOut (float vol)
float	volumeIn ()
	provides the volume
float	volumeOut ()
size_t	write (const uint8_t *data, size_t size) override
virtual size_t	write (uint8_t ch) override
virtual void	writeSilence (size_t len)
	Writes len bytes of silence (=0).

Protected Member Functions
void	adjustInputVolume (float vol)
bool	configure_clocking ()
bool	init (RxTxMode mode)
mtb_wm8960_mode_t	modeMasterSlave (bool microcontroller_is_master)
	if microcontroller is master then module is slave
virtual int	not_supported (int out, const char *msg="")
void	notifyAudioChange (AudioInfo info)
void	refillReadBuffer ()
mtb_wm8960_adc_dac_sample_rate_t	sampleRate (int rate)
void	setOutputVolume (float vol)
void	volumeError (float vol)
mtb_wm8960_word_length_t	wordLength (int bits)

Protected Attributes
int	_timeout = 10
WM8960Config	cfg
I2SStream	i2s
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
float	volume_in
float	volume_out

Detailed Description

Stream for reading and writing audio data using the WM8960 Codec Chip You need to install https://github.com/pschatzmann/arduino-wm8960.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, MP3DecoderMAD, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, MP3DecoderHelix, OggContainerDecoder, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, 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, and ResampleStream.

available()

virtual int available ( )

inlineoverridevirtualinherited

Reimplemented from Stream.

Reimplemented in AudioKitStream, A2DPStream, AudioFFTBase, HLSStreamT< URLStream >, I2SCodecStream, TfLiteAudioStream, UDPStream, ICYStreamT< T >, BufferedTaskStream, I2SStream, TimedStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, ConverterStream< T >, InputMerge< T >, Pipeline::ModifyingStreamAdapter, and VolumeStream.

availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in UDPStream, A2DPStream, AudioFFTBase, I2SCodecStream, AbstractURLStream, URLStreamESP32, I2SStream, MeasuringStream, ProgressStream, and VolumeStream.

begin()

bool begin ( )

inlinevirtual

Starts with the default config or restarts.

Reimplemented from BaseStream.

end()

void end ( )

inlinevirtual

Stops the processing and releases the memory.

Reimplemented from BaseStream.

flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.

operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in A2DPStream, Pipeline, I2SStream, and MemoryStream.

readBytes()

size_t readBytes ( uint8_t *  data, size_t  size  )

inlineoverridevirtual

Reimplemented from AudioStream.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlinevirtual

Defines the input AudioInfo.

Reimplemented from AudioStream.

write() [1/2]

size_t write ( const uint8_t *  data, size_t  size  )

inlineoverridevirtual

Reimplemented from AudioStream.

write() [2/2]

virtual size_t write ( uint8_t  ch )

inlineoverridevirtualinherited

Reimplemented in BufferedTaskStream, and BufferedStream.

---

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

• src/AudioTools/AudioLibs/WM8960Stream.h