BufferedStream Class Reference

The Arduino Stream supports operations on single characters. This is usually not the best way to push audio information, but we will support it anyway - by using a buffer. On reads: if the buffer is empty it gets refilled. More...

#include <AudioStreams.h>

Inheritance diagram for BufferedStream:

Public Member Functions
	BufferedStream (Print &out, size_t buffer_size=1024)
	BufferedStream (size_t buffer_size)
	BufferedStream (size_t buffer_size, Print &out)
	BufferedStream (size_t buffer_size, Stream &io)
	BufferedStream (Stream &io, size_t buffer_size=1024)
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 ()
int	available () override
	Returns the available bytes.
virtual int	availableForWrite () override
virtual bool	begin ()
void	clear ()
	Clears all the data in the buffer.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	end ()
void	flush () override
	empties the buffer
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual	operator bool ()
int	peek () override
	peeks a byte - to be avoided
size_t	peekBytes (uint8_t *data, size_t len)
	Provides data w/o consuming.
int	read () override
	reads a byte - to be avoided
size_t	readBytes (uint8_t *data, size_t len) override
	Use this method !!
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 size)
	Resize the buffer.
virtual void	setAudioInfo (AudioInfo newInfo) override
	Defines the input AudioInfo.
void	setMinUnbufferedReadSize (size_t size)
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
void	setOutput (Print &out) override
	Defines/Changes the output target.
void	setStream (Print &out)
void	setStream (Stream &io) override
	Defines/Changes the input & output.
void	setWriteBufferSize (int size)
size_t	write (const uint8_t *data, size_t len) override
	Use this method: write an array.
size_t	write (uint8_t c) override
	writes a byte to the buffer
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)
virtual size_t	readExt (uint8_t *data, size_t len)
void	refill ()
	refills the buffer with data from the source
void	refill (size_t len)
	refill only if not enough data
void	refillReadBuffer ()
	Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()
virtual size_t	writeExt (const uint8_t *data, size_t len)

Protected Attributes
int	_timeout = 10
SingleBuffer< uint8_t >	buffer {0}
AudioInfo	info
bool	is_notify_active = true
size_t	minReadBufferSize = 1024
Vector< AudioInfoSupport * >	notify_vector
Stream *	p_in = nullptr
Print *	p_out = nullptr
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

The Arduino Stream supports operations on single characters. This is usually not the best way to push audio information, but we will support it anyway - by using a buffer. On reads: if the buffer is empty it gets refilled.

• for writes if it is full it gets flushed.

  Author

  Phil Schatzmann

  Copyright

  GPLv3

Constructor & Destructor Documentation

BufferedStream() [1/5]

BufferedStream ( size_t  buffer_size )

inline

BufferedStream() [2/5]

BufferedStream ( Print &  out, size_t  buffer_size = 1024  )

inline

BufferedStream() [3/5]

BufferedStream ( Stream &  io, size_t  buffer_size = 1024  )

inline

BufferedStream() [4/5]

BufferedStream ( size_t  buffer_size, Print &  out  )

inline

BufferedStream() [5/5]

BufferedStream ( size_t  buffer_size, Stream &  io  )

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

int available ( )

inlineoverridevirtual

Returns the available bytes.

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

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in AudioOutputWithCallback, AudioMP34DT05, I2SCodecStream, MozziStream, PureDataStream, SPDIFOutput, VS1053Stream, WM8960Stream, AdaptiveResamplingStream, AudioLoRa, ESPNowStream, VBANStream, AudioEffectStreamT< T >, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, AudioStreamWrapper, TimerCallbackAudioStream, FrequencyDetectorAutoCorrelation, GoertzelStream, ResampleStreamT< TInterpolator >, FileLoopT< FileType >, FileLoopT< File >, LoRaStream, EncodedAudioStream, AudioBoardStream, AudioFFTBase, AudioKitStream, MiniAudioStream, PortAudioStream, StdioStream, HLSStreamT< URLStream >, AnalogAudioArduino, AnalogAudioStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, MeasuringStream, ProgressStream, Throttle, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, VolumeMeter, AudioInputMonitor, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, CatStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, Pipeline, Pipeline::ModifyingStreamAdapter, ResampleStream, VolumeStream, and EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >.

clear()

void clear ( )

inline

Clears all the data in the buffer.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

end()

virtual void end ( )

inlinevirtualinherited

Reimplemented in FaustStream< DSP >, AudioMP34DT05, I2SCodecStream, MozziStream, PureDataStream, SPDIFOutput, VS1053Stream, WM8960Stream, AdaptiveResamplingStream, AudioLoRa, ESPNowStream, BufferedTaskStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, Equalizer3Bands, I2SStream, AudioStreamWrapper, TimerCallbackAudioStream, FormatConverterStream, GoertzelStream, FileLoopT< FileType >, FileLoopT< File >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, LoRaStream, EncodedAudioStream, AudioFFTBase, AudioKitStream, MiniAudioStream, PortAudioStream, StdioStream, A2DPStream, HLSStreamT< URLStream >, HttpRequest, ICYStreamT< T >, URLStream, URLStreamESP32, AnalogAudioArduino, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3BandsPerChannel, ReformatBaseStream, AdapterAudioOutputToAudioStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMixer< T >, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, ChannelFormatConverterStream, NumberFormatConverterStream, CatStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, Pipeline, Pipeline::ModifyingStreamAdapter, VolumeStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AbstractURLStream, and AudioBLEStream.

flush()

void flush ( )

inlineoverridevirtual

empties the buffer

Reimplemented from BaseStream.

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.

peek()

int peek ( )

inlineoverride

peeks a byte - to be avoided

peekBytes()

size_t peekBytes ( uint8_t *  data, size_t  len  )

inline

Provides data w/o consuming.

read()

int read ( )

inlineoverride

reads a byte - to be avoided

readBytes()

size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtual

Use this method !!

Reimplemented from AudioStream.

readExt()

virtual size_t readExt ( uint8_t *  data, size_t  len  )

inlineprotectedvirtual

Reimplemented in AudioOutputWithCallback, and TimerCallbackAudioStream.

readSilence()

virtual size_t readSilence ( uint8_t *  buffer, size_t  length  )

inlinevirtualinherited

Source to generate silence: just sets the buffer to 0.

refill() [1/2]

void refill ( )

inlineprotected

refills the buffer with data from the source

refill() [2/2]

void refill ( size_t  len )

inlineprotected

refill only if not enough data

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

void resize ( int  size )

inline

Resize the buffer.

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in VS1053Stream, WM8960Stream, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, VolumeStream, MiniAudioStream, PortAudioStream, I2SCodecStream, MozziStream, SPDIFOutput, AudioLoRa, AnalogAudioStream, I2SStream, TimerCallbackAudioStream, AudioBLEStream, LoRaStream, AudioFFTBase, AudioKitStream, VBANStream, AnalogAudioArduino, Equalizer3Bands, Equalizer3BandsPerChannel, AdapterAudioOutputToAudioStream, TimedStream, MeasuringStream, ProgressStream, CallbackStream, VolumeMeter, AudioInputMonitor, FormatConverterStream, FadeStream, GoertzelStream, Pipeline::ModifyingStreamAdapter, MDFEchoCancellationStream< Allocator >, EncodedAudioStream, PureDataStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

setMinUnbufferedReadSize()

void setMinUnbufferedReadSize ( size_t  size )

inline

Defines the minimum direct unbuffered read size to the original source (default is 1024)

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

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

setOutput()

void setOutput ( Print &  out )

inlineoverridevirtual

Defines/Changes the output target.

Implements ModifyingStream.

setStream() [1/2]

void setStream ( Print &  out )

inline

setStream() [2/2]

void setStream ( Stream &  in )

inlineoverridevirtual

Defines/Changes the input & output.

Implements ModifyingStream.

setWriteBufferSize()

void setWriteBufferSize ( int  size )

inlineinherited

write() [1/2]

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

Use this method: write an array.

Reimplemented from AudioStream.

write() [2/2]

size_t write ( uint8_t  c )

inlineoverridevirtual

writes a byte to the buffer

Reimplemented from BaseStream.

writeExt()

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

inlineprotectedvirtual

Reimplemented in AudioOutputWithCallback, and TimerCallbackAudioStream.

writeSilence()

virtual void writeSilence ( size_t  len )

inlinevirtualinherited

Writes len bytes of silence (=0).

Member Data Documentation

_timeout

int _timeout = 10

protectedinherited

buffer

SingleBuffer<uint8_t> buffer {0}

protected

info

AudioInfo info

protectedinherited

is_notify_active

bool is_notify_active = true

protectedinherited

minReadBufferSize

size_t minReadBufferSize = 1024

protected

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

p_in

Stream* p_in = nullptr

protected

p_out

Print* p_out = nullptr

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