AudioKit Stream which uses the https://github.com/pschatzmann/arduino-audiokit library. More...

#include <AudioKit.h>

Inheritance diagram for AudioKitStream:

Public Member Functions
	AudioKitStream ()

void	addAction (int pin, void(action)(bool, int, void ), AudioActions::ActiveLogic activeLogic, void *ref=nullptr)
	Defines a new action that is executed when the indicated pin is active.

void	addAction (int pin, void(action)(bool, int, void ), void *ref=nullptr)
	Defines a new action that is executed when the indicated pin is active.

virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.

AudioActions &	audioActions ()
	Provides access to the AudioActions.

virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo

virtual AudioInfo	audioInfoOut ()

int	available ()
	We get the data via I2S - we expect to fill one buffer size.

virtual int	availableForWrite () override

bool	begin () override

bool	begin (AudioKitStreamConfig config)
	Starts the processing.

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

AudioKitStreamConfig &	config ()

AudioKitStreamConfig	defaultConfig (RxTxMode mode=RXTX_MODE)
	Provides the default configuration.

void	end () override
	Stops the processing.

virtual void	flush () override

bool	headphoneStatus ()
	Returns true if the headphone was detected.

void	incrementVolume (int vol)
	Relative volume control.

bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.

virtual	operator bool ()

int8_t	pinAdcDetect ()
	Get the gpio number for adc detection.

int8_t	pinAuxin ()
	Get the gpio number for auxin detection.

int8_t	pinBlueLed ()
	Get green led gpio number.

int8_t	pinEs7243Mclk ()
	Get the mclk gpio number of es7243.

int8_t	pinGreenLed ()
	Get DSP reset gpio number.

int8_t	pinHeadphoneDetect ()
	Get the gpio number for headphone detection.

int8_t	pinInputMode ()
	Get the number for mode-button.

int8_t	pinInputPlay ()
	Get number for play function.

int8_t	pinInputRec ()
	Get the record-button id for adc-button.

int8_t	pinInputSet ()
	Get number for set function.

int8_t	pinPaEnable ()
	Get the gpio number for PA enable.

int8_t	pinResetBoard ()
	Get DSP reset gpio number.

int8_t	pinResetCodec ()
	Get green led gpio number.

int8_t	pinVolumeDown ()
	Get number for volume down function.

int8_t	pinVolumeUp ()
	number for volume up function

void	processActions ()
	Process input keys and pins.

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.

bool	setActive (bool active)
	Sets the codec active / inactive.

void	setAudioInfo (AudioInfo info) override

bool	setMute (bool mute)
	Mutes the output.

void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)

void	setSpeakerActive (bool active)

bool	setVolume (double vol)
	Defines the Volume: Range 0 to 1.0.

bool	setVolume (float vol)
	Defines the Volume: Range 0 to 1.0.

bool	setVolume (int vol)
	Defines the Volume: Range 0 to 100.

void	setWriteBufferSize (int size)

int	volume ()
	Determines the volume.

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

Static Public Member Functions
static void	actionHeadphoneDetection (bool, int, void *)
	Switch off the PA if the headphone in plugged in and switch it on again if the headphone is unplugged. This method complies with the.

static void	actionStart (bool, int, void *)
	Start.

static void	actionStartStop (bool, int, void *)
	Toggle start stop.

static void	actionStop (bool, int, void *)
	Stop.

static void	actionVolumeDown (bool, int, void *)
	Decrease the volume.

static void	actionVolumeUp (bool, int, void *)
	Increase the volume.

Protected Member Functions
AudioActions::ActiveLogic	getActionLogic (int pin)
	Determines the action logic (ActiveLow or ActiveTouch) for the pin.

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

void	notifyAudioChange (AudioInfo info)

void	refillReadBuffer ()

void	setupActions ()
	Setup the supported default actions.

Protected Attributes
int	_timeout = 10

AudioActions	actions

bool	active = true

AudioKitStreamConfig	cfg = defaultConfig(RXTX_MODE)

I2SStream	i2s_stream

AudioInfo	info

bool	is_notify_active = true

bool	is_started = false

AudioKit	kit

Vector< AudioInfoSupport * >	notify_vector

RingBuffer< uint8_t >	tmp_in {0}

RingBuffer< uint8_t >	tmp_out {0}

int	volume_value = 40

int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

AudioKit Stream which uses the https://github.com/pschatzmann/arduino-audiokit library.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ AudioKitStream()

AudioKitStream ( )

inline

Member Function Documentation

◆ actionHeadphoneDetection()

static void actionHeadphoneDetection	(	bool	,
		int	,
		void *
	)

inlinestatic

Switch off the PA if the headphone in plugged in and switch it on again if the headphone is unplugged. This method complies with the.

◆ actionStart()

static void actionStart	(	bool	,
		int	,
		void *
	)

inlinestatic

Start.

◆ actionStartStop()

static void actionStartStop	(	bool	,
		int	,
		void *
	)

inlinestatic

Toggle start stop.

◆ actionStop()

static void actionStop	(	bool	,
		int	,
		void *
	)

inlinestatic

Stop.

◆ actionVolumeDown()

static void actionVolumeDown	(	bool	,
		int	,
		void *
	)

inlinestatic

Decrease the volume.

◆ actionVolumeUp()

static void actionVolumeUp	(	bool	,
		int	,
		void *
	)

inlinestatic

Increase the volume.

◆ addAction() [1/2]

void addAction	(	int	pin,
		void()(bool, int, void )	action,
		AudioActions::ActiveLogic	activeLogic,
		void *	ref = `nullptr`
	)

inline

Defines a new action that is executed when the indicated pin is active.

Parameters

pin
action
activeLogic
ref

◆ addAction() [2/2]

void addAction	(	int	pin,
		void()(bool, int, void )	action,
		void *	ref = `nullptr`
	)

inline

Defines a new action that is executed when the indicated pin is active.

Parameters

pin
action
ref

◆ 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.

◆ audioActions()

AudioActions & audioActions ( )

inline

Provides access to the AudioActions.

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

inlinevirtual

We get the data via I2S - we expect to fill one buffer size.

Reimplemented from BaseStream.

◆ availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AudioLoRa, UDPStream, VBANStream, AudioStreamWrapper, ConverterStream< T >, LoRaStream, EncodedAudioStream, FaustStream< DSP >, AudioFFTBase, I2SCodecStream, MiniAudioStream, StdioStream, A2DPStream, ESPNowStream, HammingFEC< bytecount, block_t >, AbstractURLStream, URLStreamESP32, ReedSolomonFEC< bytecount, additional_bytes >, AnalogAudioArduino, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, ReformatBaseStream, TimedStream, MemoryStream, RingBufferStream, MeasuringStream, ProgressStream, Throttle, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, FadeStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, Pipeline, VolumeStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, and AudioBLEServer.

◆ begin() [1/2]

bool begin ( )

inlineoverridevirtual

Reimplemented from BaseStream.

◆ begin() [2/2]

bool begin ( AudioKitStreamConfig config )

inline

Starts the processing.

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ config()

AudioKitStreamConfig & config ( )

inline

◆ defaultConfig()

AudioKitStreamConfig defaultConfig ( RxTxMode mode = RXTX_MODE )

inline

Provides the default configuration.

◆ end()

void end ( )

inlineoverridevirtual

Stops the processing.

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.

◆ getActionLogic()

AudioActions::ActiveLogic getActionLogic ( int pin )

inlineprotected

Determines the action logic (ActiveLow or ActiveTouch) for the pin.

◆ headphoneStatus()

bool headphoneStatus ( )

inline

Returns true if the headphone was detected.

Returns

◆ incrementVolume()

void incrementVolume ( int vol )

inline

Relative volume control.

Parameters

vol

◆ 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.

◆ pinAdcDetect()

int8_t pinAdcDetect ( )

inline

Get the gpio number for adc detection.

Returns: -1 non-existent Others gpio number

◆ pinAuxin()

int8_t pinAuxin ( )

inline

Get the gpio number for auxin detection.

Returns: -1 non-existent Others gpio number

◆ pinBlueLed()

int8_t pinBlueLed ( )

inline

Get green led gpio number.

Returns: -1 non-existent Others gpio number

◆ pinEs7243Mclk()

int8_t pinEs7243Mclk ( )

inline

Get the mclk gpio number of es7243.

Returns: -1 non-existent Others gpio number

◆ pinGreenLed()

int8_t pinGreenLed ( )

inline

Get DSP reset gpio number.

Returns: -1 non-existent Others gpio number

◆ pinHeadphoneDetect()

int8_t pinHeadphoneDetect ( )

inline

Get the gpio number for headphone detection.

Returns: -1 non-existent Others gpio number

◆ pinInputMode()

int8_t pinInputMode ( )

inline

Get the number for mode-button.

Returns: -1 non-existent Others number

◆ pinInputPlay()

int8_t pinInputPlay ( )

inline

Get number for play function.

Returns: -1 non-existent Others number

◆ pinInputRec()

int8_t pinInputRec ( )

inline

Get the record-button id for adc-button.

Returns: -1 non-existent Others button id

◆ pinInputSet()

int8_t pinInputSet ( )

inline

Get number for set function.

Returns: -1 non-existent Others number

◆ pinPaEnable()

int8_t pinPaEnable ( )

inline

Get the gpio number for PA enable.

Returns: -1 non-existent Others gpio number

◆ pinResetBoard()

int8_t pinResetBoard ( )

inline

Get DSP reset gpio number.

Returns: -1 non-existent Others gpio number

◆ pinResetCodec()

int8_t pinResetCodec ( )

inline

Get green led gpio number.

Returns: -1 non-existent Others gpio number

◆ pinVolumeDown()

int8_t pinVolumeDown ( )

inline

Get number for volume down function.

Returns: -1 non-existent Others number

◆ pinVolumeUp()

int8_t pinVolumeUp ( )

inline

number for volume up function

Returns: -1 non-existent Others number

◆ processActions()

void processActions ( )

inline

Process input keys and pins.

◆ readBytes()

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

◆ removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ setActive()

bool setActive ( bool active )

inline

Sets the codec active / inactive.

◆ setAudioInfo()

void setAudioInfo ( AudioInfo info )

inlineoverridevirtual

Update the audio info with new values: e.g. new sample_rate, bits_per_samples or channels.

Reimplemented from AudioStream.

◆ setMute()

bool setMute ( bool mute )

inline

Mutes the output.

◆ setNotifyActive()

void setNotifyActive ( bool flag )

inlineinherited

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

◆ setSpeakerActive()

void setSpeakerActive ( bool active )

inline

Activates/Deactives the speaker

Parameters

active

◆ setupActions()

void setupActions ( )

inlineprotected

Setup the supported default actions.

◆ setVolume() [1/3]

bool setVolume ( double vol )

inline

Defines the Volume: Range 0 to 1.0.

◆ setVolume() [2/3]

bool setVolume ( float vol )

inline

Defines the Volume: Range 0 to 1.0.

◆ setVolume() [3/3]

bool setVolume ( int vol )

inline

Defines the Volume: Range 0 to 100.

◆ setWriteBufferSize()

void setWriteBufferSize ( int size )

inlineinherited

◆ volume()

int volume ( )

inline

Determines the volume.

◆ 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

◆ actions

AudioActions actions

protected

◆ active

bool active = true

protected

◆ cfg

AudioKitStreamConfig cfg = defaultConfig(RXTX_MODE)

protected

◆ i2s_stream

I2SStream i2s_stream

protected

◆ info

AudioInfo info

protectedinherited

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ is_started

bool is_started = false

protected

◆ kit

AudioKit kit

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

◆ volume_value

int volume_value = 40

protected

◆ write_buffer_size

int write_buffer_size = MAX_SINGLE_CHARS

protectedinherited

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

src/AudioTools/AudioLibs/AudioKit.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AudioKitStream()

Member Function Documentation

◆ actionHeadphoneDetection()

◆ actionStart()

◆ actionStartStop()

◆ actionStop()

◆ actionVolumeDown()

◆ actionVolumeUp()

◆ addAction() [1/2]

◆ addAction() [2/2]

◆ addNotifyAudioChange()

◆ audioActions()

◆ audioInfo()

◆ audioInfoOut()

◆ available()

◆ availableForWrite()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clearNotifyAudioChange()

◆ config()

◆ defaultConfig()

◆ end()

◆ flush()

◆ getActionLogic()

◆ headphoneStatus()

◆ incrementVolume()

◆ isNotifyActive()

◆ not_supported()

◆ notifyAudioChange()

◆ operator bool()

◆ pinAdcDetect()

◆ pinAuxin()

◆ pinBlueLed()

◆ pinEs7243Mclk()

◆ pinGreenLed()

◆ pinHeadphoneDetect()

◆ pinInputMode()

◆ pinInputPlay()

◆ pinInputRec()

◆ pinInputSet()

◆ pinPaEnable()

◆ pinResetBoard()

◆ pinResetCodec()

◆ pinVolumeDown()

◆ pinVolumeUp()

◆ processActions()

◆ readBytes()

◆ readSilence()

◆ refillReadBuffer()

◆ removeNotifyAudioChange()

◆ setActive()

◆ setAudioInfo()

◆ setMute()

◆ setNotifyActive()

◆ setSpeakerActive()

◆ setupActions()

◆ setVolume() [1/3]

◆ setVolume() [2/3]

◆ setVolume() [3/3]

◆ setWriteBufferSize()

◆ volume()

◆ write() [1/2]

◆ write() [2/2]

◆ writeSilence()

Member Data Documentation

◆ _timeout

◆ actions

◆ active

◆ cfg

◆ i2s_stream

◆ info

◆ is_notify_active

◆ is_started

◆ kit