Source for reading generated tones. Please note. More...

#include <AudioStreams.h>

Inheritance diagram for GeneratedSoundStream< T >:

Public Member Functions
	GeneratedSoundStream ()=default

	GeneratedSoundStream (SoundGenerator< T > &generator)

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< T > &generator)

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 ()
	Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()

Protected Attributes
int	_timeout = 10

bool	active = true

int	buffer_size

SoundGenerator< T > *	generator_ptr

AudioInfo	info

bool	is_notify_active = true

Vector< AudioInfoSupport * >	notify_vector

const char *	source_not_defined_error = "Source not defined"

RingBuffer< uint8_t >	tmp_in {0}

RingBuffer< uint8_t >	tmp_out {0}

int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

template<class T = int16_t>
class audio_tools::GeneratedSoundStream< T >

Source for reading generated tones. Please note.

that the output is for one channel only!
we do not support reading of individual characters!
we do not support any write operations

Parameters

generator

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ GeneratedSoundStream() [1/2]

template<class T = int16_t>

GeneratedSoundStream ( )

default

◆ GeneratedSoundStream() [2/2]

template<class T = int16_t>

GeneratedSoundStream ( SoundGenerator< T > & generator )

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

template<class T = int16_t>

AudioInfo audioInfo ( )

inlineoverridevirtual

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

template<class T = int16_t>

virtual int available ( )

inlineoverridevirtual

This is unbounded so we just return the 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]

template<class T = int16_t>

bool begin ( )

inlineoverridevirtual

start the processing

Reimplemented from BaseStream.

◆ begin() [2/2]

template<class T = int16_t>

bool begin ( AudioInfo cfg )

inline

start the processing

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ defaultConfig()

template<class T = int16_t>

AudioInfo defaultConfig ( )

inline

◆ end()

template<class T = int16_t>

void end ( )

inlineoverridevirtual

stop the processing

Reimplemented from BaseStream.

◆ flush()

template<class T = int16_t>

void flush ( )

inlineoverridevirtual

Reimplemented from BaseStream.

◆ isActive()

template<class T = int16_t>

bool isActive ( )

inline

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

template<class T = int16_t>

operator bool ( )

inlineoverridevirtual

Reimplemented from AudioStream.

◆ readBytes()

template<class T = int16_t>

size_t readBytes	(	uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

privide the data as byte stream

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

◆ resize()

template<class T = int16_t>

void resize ( int maxReadSize )

inline

Redefine the buffer size which is reported in available()

◆ setAudioInfo()

template<class T = int16_t>

void setAudioInfo ( AudioInfo info )

inlineoverridevirtual

Defines the input AudioInfo.

Reimplemented from AudioStream.

◆ setInput()

template<class T = int16_t>

void setInput ( SoundGenerator< T > & generator )

inline

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

inlineoverridevirtualinherited

Implements BaseStream.

Reimplemented in URLStream, LMSEchoCancellationStream< T >, MDFEchoCancellationStream< Allocator >, AudioBLEServer, ESP3288AudioOutput, I2SCodecStream, MozziStream, PureDataStream, SPDIFOutput, AudioLoRa, I2SStream, AudioStreamWrapper, ConverterStream< T >, LoRaStream, EncodedAudioStream, FaustStream< DSP >, AudioFFTBase, AudioKitStream, MiniAudioStream, PortAudioStream, TfLiteAudioStream, VS1053Stream, A2DPStream, AdaptiveResamplingStream, BufferedTaskStream, URLStreamESP32, VBANStream, AnalogAudioArduino, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3Bands, Equalizer3BandsPerChannel, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, RingBufferStream, BufferedStream, MeasuringStream, ProgressStream, Throttle, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, VolumeMeter, AudioInputMonitor, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, FadeStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GoertzelStream, Pipeline, Pipeline::ModifyingStreamAdapter, ResampleStream, ResampleStreamT< TInterpolator >, VolumeStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, TfLiteAudioStreamBase, WM8960Stream, AnalogDriverESP32V1::IO16Bit, and AnalogDriverESP32V2::IO16Bit.

◆ 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

◆ active

template<class T = int16_t>

bool active = true

protected

◆ buffer_size

template<class T = int16_t>

int buffer_size

protected

Initial value:

=

DEFAULT_BUFFER_SIZE * 100

DEFAULT_BUFFER_SIZE

#define DEFAULT_BUFFER_SIZE

Definition avr.h:20

◆ generator_ptr

template<class T = int16_t>

SoundGenerator<T>* generator_ptr

protected

◆ info

AudioInfo info

protectedinherited

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ source_not_defined_error

template<class T = int16_t>

const char* source_not_defined_error = "Source not defined"

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GeneratedSoundStream() [1/2]

◆ GeneratedSoundStream() [2/2]

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ available()

◆ availableForWrite()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clearNotifyAudioChange()

◆ defaultConfig()

◆ end()

◆ flush()

◆ isActive()

◆ isNotifyActive()

◆ not_supported()

◆ notifyAudioChange()

◆ operator bool()

◆ readBytes()

◆ readSilence()

◆ refillReadBuffer()

◆ removeNotifyAudioChange()

◆ resize()

◆ setAudioInfo()

◆ setInput()

◆ setNotifyActive()

◆ setWriteBufferSize()

◆ write() [1/2]

◆ write() [2/2]

◆ writeSilence()

Member Data Documentation

◆ _timeout

◆ active

◆ buffer_size

◆ generator_ptr

◆ info

◆ is_notify_active

◆ notify_vector

◆ source_not_defined_error

◆ tmp_in

◆ tmp_out

◆ write_buffer_size