STKStream< StkCls > Class Template Reference

STK Stream for Instrument or Voicer. More...

#include <AudioSTK.h>

Inheritance diagram for STKStream< StkCls >:

Public Member Functions
	STKStream (StkCls &instrument)
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual int	available () override
	This is unbounded so we just return the buffer size.
virtual int	availableForWrite () override
bool	begin () override
	start the processing
bool	begin (AudioInfo cfg)
	start the processing
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
AudioInfo	defaultConfig ()
void	end () override
	stop the processing
void	flush () override
bool	isActive ()
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
	operator bool () override
size_t	readBytes (uint8_t *data, size_t len) override
	privide the data as byte stream
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	resize (int maxReadSize)
	Redefine the buffer size which is reported in available()
void	setAudioInfo (AudioInfo newInfo) override
	Defines the input AudioInfo.
void	setInput (SoundGenerator< int16_t > &generator)
void	setInput (StkCls &instrument)
void	setInput (StkCls *instrument)
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) override
virtual size_t	write (uint8_t ch) override
virtual void	writeSilence (size_t len)
	Writes len bytes of silence (=0).

Protected Member Functions
virtual int	not_supported (int out, const char *msg="")
void	notifyAudioChange (AudioInfo info)
void	refillReadBuffer ()

Protected Attributes
int	_timeout = 10
bool	active
int	buffer_size
STKGenerator< StkCls, int16_t >	generator
SoundGenerator< int16_t > *	generator_ptr
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
const char *	source_not_defined_error
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

template<class StkCls>
class audio_tools::STKStream< StkCls >

STK Stream for Instrument or Voicer.

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

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Reimplemented from AudioStream.

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

inlineoverridevirtualinherited

This is unbounded so we just return the buffer size.

Reimplemented from BaseStream.

availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in UDPStream, AudioFFTBase, I2SCodecStream, A2DPStream, AbstractURLStream, URLStreamESP32, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, MeasuringStream, ProgressStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, and VolumeStream.

begin()

bool begin ( )

inlineoverridevirtualinherited

start the processing

Reimplemented from BaseStream.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

end()

void end ( )

inlineoverridevirtualinherited

stop the processing

Reimplemented from BaseStream.

flush()

void flush ( )

inlineoverridevirtualinherited

Reimplemented from BaseStream.

operator bool()

operator bool ( )

inlineoverridevirtualinherited

Reimplemented from AudioStream.

readBytes()

size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtualinherited

privide the data as byte stream

Reimplemented from AudioStream.

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

inlineoverridevirtualinherited

Defines the input AudioInfo.

Reimplemented from AudioStream.

write() [1/2]

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

inlineoverridevirtualinherited

Implements BaseStream.

Reimplemented in I2SCodecStream, MozziStream, SPDIFOutput, I2SStream, FaustStream< DSP >, AudioFFTBase, TfLiteAudioStream, VS1053Stream, A2DPStream, AdaptiveResamplingStream, BufferedTaskStream, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3Bands, Equalizer3BandsPerChannel, TimedStream, BufferedStream, MeasuringStream, ProgressStream, AudioInputMonitor, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GoertzelStream, ResampleStreamT< TInterpolator >, VolumeStream, TfLiteAudioStreamBase, and AnalogDriverESP32V2::IO16Bit.

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/AudioSTK.h