AudioStream class that can define a start and (an optional) stop time Usually it is used to wrap an Audio Sink (e.g. I2SStream), but wrapping an Audio Source is supported as well. Only wrap classes which represent PCM data! More...

#include <AudioIO.h>

Inheritance diagram for TimedStream:

Public Member Functions
	TimedStream ()=default

	TimedStream (AudioOutput &o, long startSeconds=0, long endSeconds=-1)

	TimedStream (AudioStream &io, long startSeconds=0, long endSeconds=-1)

	TimedStream (Print &o, long startSeconds=0, long endSeconds=-1)

	TimedStream (Stream &io, long startSeconds=0, long endSeconds=-1)

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
	Provides the available bytes until the end time has reached.

int	availableForWrite () override

bool	begin () override

bool	begin (AudioInfo info)

int	bytesPerSecond ()
	Calculates the bytes per second from the AudioInfo.

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

virtual void	end ()

virtual void	flush () override

bool	isActive ()
	Returns true if we are not past the end time;.

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

bool	isPlaying ()
	Returns true if we are in a valid time range and are still playing sound.

	operator bool () override

size_t	readBytes (uint8_t *data, size_t len) 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 info) override
	Updates the AudioInfo in the current object and in the source or target.

void	setCompressionRatio (float ratio)

void	setEndMs (uint32_t ms)
	Defines the (optional) end time in milliseconds.

void	setEndSec (uint32_t endSeconds)

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

void	setOutput (AudioOutput &out)

void	setOutput (Print &out) override
	Defines/Changes the output target.

void	setStartMs (uint32_t ms)
	Defines the start time in milliseconds.

void	setStartSec (uint32_t startSeconds)

void	setStream (AudioOutput &out)

void	setStream (AudioStream &stream)

void	setStream (Stream &stream) override
	Defines/Changes the input & output.

void	setWriteBufferSize (int size)

size_t	size ()

size_t	write (const uint8_t *data, size_t len) override
	Plays only data for the indiated start and end time.

virtual size_t	write (uint8_t ch) override

virtual void	writeSilence (size_t len)
	Writes len bytes of silence (=0).

Protected Member Functions
void	calculateByteLimits ()

void	consumeBytes (uint32_t len)

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

float	compression_ratio = 1.0

uint32_t	current_bytes = 0

uint32_t	end_bytes = UINT32_MAX

uint32_t	end_ms = UINT32_MAX

AudioInfo	info

bool	is_notify_active = true

Vector< AudioInfoSupport * >	notify_vector

AudioInfoSupport *	p_info = nullptr

Print *	p_print = nullptr

Stream *	p_stream = nullptr

uint32_t	start_bytes = 0

uint32_t	start_ms = 0

RingBuffer< uint8_t >	tmp_in {0}

RingBuffer< uint8_t >	tmp_out {0}

int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

AudioStream class that can define a start and (an optional) stop time Usually it is used to wrap an Audio Sink (e.g. I2SStream), but wrapping an Audio Source is supported as well. Only wrap classes which represent PCM data!

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ TimedStream() [1/5]

TimedStream ( )

default

◆ TimedStream() [2/5]

TimedStream	(	AudioStream &	io,
		long	startSeconds = `0`,
		long	endSeconds = `-1`
	)

inline

◆ TimedStream() [3/5]

TimedStream	(	AudioOutput &	o,
		long	startSeconds = `0`,
		long	endSeconds = `-1`
	)

inline

◆ TimedStream() [4/5]

TimedStream	(	Stream &	io,
		long	startSeconds = `0`,
		long	endSeconds = `-1`
	)

inline

◆ TimedStream() [5/5]

TimedStream	(	Print &	o,
		long	startSeconds = `0`,
		long	endSeconds = `-1`
	)

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

Provides the available bytes until the end time has reached.

Reimplemented from BaseStream.

◆ availableForWrite()

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

◆ begin() [1/2]

bool begin ( )

inlineoverridevirtual

Reimplemented from BaseStream.

◆ begin() [2/2]

bool begin ( AudioInfo info )

inline

◆ bytesPerSecond()

int bytesPerSecond ( )

inline

Calculates the bytes per second from the AudioInfo.

◆ calculateByteLimits()

void calculateByteLimits ( )

inlineprotected

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ consumeBytes()

void consumeBytes ( uint32_t len )

inlineprotected

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

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.

◆ isActive()

bool isActive ( )

inline

Returns true if we are not past the end time;.

◆ isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ isPlaying()

bool isPlaying ( )

inline

Returns true if we are in a valid time range and are still playing sound.

◆ not_supported()

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

inlineprotectedvirtualinherited

◆ notifyAudioChange()

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool()

operator bool ( )

inlineoverridevirtual

Reimplemented from AudioStream.

◆ readBytes()

size_t readBytes	(	uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

Provides only data for the indicated start and end time. Only supported for data which does not contain any heder information: so PCM, mp3 should work!

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

◆ setAudioInfo()

void setAudioInfo ( AudioInfo info )

inlineoverridevirtual

Updates the AudioInfo in the current object and in the source or target.

Reimplemented from AudioStream.

◆ setCompressionRatio()

void setCompressionRatio ( float ratio )

inline

Experimental: if used on mp3 you can set the compression ratio e.g. to 11 which will be used to approximate the time

void setStream ( AudioStream & stream )

inline

◆ setStream() [3/3]

void setStream ( Stream & in )

inlineoverridevirtual

Defines/Changes the input & output.

Implements ModifyingStream.

◆ setWriteBufferSize()

void setWriteBufferSize ( int size )

inlineinherited

◆ size()

size_t size ( )

inline

◆ write() [1/2]

size_t write	(	const uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

Plays only data for the indiated start and end time.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TimedStream() [1/5]

◆ TimedStream() [2/5]

◆ TimedStream() [3/5]

◆ TimedStream() [4/5]

◆ TimedStream() [5/5]

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ available()

◆ availableForWrite()

◆ begin() [1/2]

◆ begin() [2/2]

◆ bytesPerSecond()

◆ calculateByteLimits()

◆ clearNotifyAudioChange()

◆ consumeBytes()

◆ end()

◆ flush()

◆ isActive()

◆ isNotifyActive()

◆ isPlaying()

◆ not_supported()

◆ notifyAudioChange()

◆ operator bool()

◆ readBytes()

◆ readSilence()

◆ refillReadBuffer()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setCompressionRatio()

◆ setEndMs()

◆ setEndSec()

◆ setNotifyActive()

◆ setOutput() [1/2]

◆ setOutput() [2/2]

◆ setStartMs()

◆ setStartSec()

◆ setStream() [1/3]

◆ setStream() [2/3]

◆ setStream() [3/3]

◆ setWriteBufferSize()

◆ size()

◆ write() [1/2]

◆ write() [2/2]

◆ writeSilence()

Member Data Documentation

◆ _timeout

◆ compression_ratio

◆ current_bytes

◆ end_bytes

◆ end_ms

◆ info

◆ is_notify_active

◆ notify_vector

◆ p_info

◆ p_print

◆ p_stream

◆ start_bytes

◆ start_ms

◆ tmp_in

◆ tmp_out

◆ write_buffer_size