Stream which can be used to manage fade in and fade out. Before you read or write data you need to call setAudioInfo() to provide the bits_per_sample and channels. More...

#include <Fade.h>

Inheritance diagram for FadeStream:

Public Member Functions
	FadeStream ()=default

	FadeStream (Print &out)

	FadeStream (Stream &io)

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

int	availableForWrite () override

virtual bool	begin ()

bool	begin (AudioInfo info)

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

virtual void	end ()

virtual void	flush () override

bool	isFadeComplete ()

bool	isFadeInActive ()

bool	isFadeOutActive ()

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

virtual	operator bool ()

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
	Defines the input AudioInfo.

void	setFadeInActive (bool flag)

void	setFadeOutActive (bool flag)

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

virtual void	setOutput (AudioOutput &out)
	Defines/Changes the output target and registers for audio change notifications.

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

void	setOutput (Stream &io)
	same as setStream

virtual void	setStream (AudioStream &io)
	Defines/Changes the input & output and registers for audio change notifications.

void	setStream (Print &out)
	same as setOutput

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

virtual size_t	write (uint8_t ch) override

void	writeEnd (Print &print, int steps=200)
	If you can not provide any more samples we bring the last sample slowy back to 0.

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 = false

const char *	error_msg = "setAudioInfo not called"

Fade	fade

LastSampleFader	fade_last

AudioInfo	info

bool	is_notify_active = true

Vector< AudioInfoSupport * >	notify_vector

Stream *	p_io = 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

Stream which can be used to manage fade in and fade out. Before you read or write data you need to call setAudioInfo() to provide the bits_per_sample and channels.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ FadeStream() [1/3]

FadeStream ( )

default

◆ FadeStream() [2/3]

FadeStream ( Print & out )

inline

◆ FadeStream() [3/3]

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

Reimplemented from BaseStream.

◆ availableForWrite()

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

◆ begin() [1/2]

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

◆ begin() [2/2]

bool begin ( AudioInfo info )

inline

◆ 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, SPIAudioSlave, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3BandsPerChannel, ReformatBaseStream, AdapterAudioOutputToAudioStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMixer< T, SumT >, 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 >, ReformatBaseStream, AudioStreamWrapper, ResampleStream, EncodedAudioStream, URLStream, BufferedTaskStream, I2SStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and BufferedStream.

◆ isFadeComplete()

bool isFadeComplete ( )

inline

◆ isFadeInActive()

bool isFadeInActive ( )

inline

◆ isFadeOutActive()

bool isFadeOutActive ( )

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

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in A2DPStream, ICYStreamT< T >, AudioBLEStream, AudioFFTBase, PortAudioStream, URLStream, I2SStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and Pipeline.

◆ readBytes()

size_t readBytes	(	uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

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

Defines the input AudioInfo.

Reimplemented from AudioStream.

◆ setFadeInActive()

void setFadeInActive ( bool flag )

inline

◆ setFadeOutActive()

void setFadeOutActive ( bool flag )

inline

◆ setNotifyActive()

void setNotifyActive ( bool flag )

inlineinherited

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

◆ setOutput() [1/3]

virtual void setOutput ( AudioOutput & out )

inlinevirtualinherited

Defines/Changes the output target and registers for audio change notifications.

Reimplemented in TimedStream, VolumeMeter, AudioInputMonitor, ReformatBaseStream, FormatConverterStream, and EncodedAudioStream.

◆ setOutput() [2/3]

void setOutput ( Print & out )

inlineoverridevirtual

Defines/Changes the output target.

Implements ModifyingStream.

◆ setOutput() [3/3]

void setOutput ( Stream & io )

inline

same as setStream

◆ setStream() [1/3]

virtual void setStream ( AudioStream & io )

inlinevirtualinherited

Defines/Changes the input & output and registers for audio change notifications.

Reimplemented in VolumeMeter, AudioInputMonitor, FormatConverterStream, ReformatBaseStream, TimedStream, and EncodedAudioStream.

◆ setStream() [2/3]

void setStream ( Print & out )

inline

same as setOutput

◆ setStream() [3/3]

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

Reimplemented from AudioStream.

◆ write() [2/2]

virtual size_t write ( uint8_t ch )

inlineoverridevirtualinherited

Reimplemented in MemoryStream, AudioStreamWrapper, BufferedTaskStream, RingBufferStream, BufferedStream, and URLStream.

◆ writeEnd()

void writeEnd	(	Print &	print,
		int	steps = `200`
	)

inline

If you can not provide any more samples we bring the last sample slowy back to 0.

◆ writeSilence()

virtual void writeSilence ( size_t len )

inlinevirtualinherited

Writes len bytes of silence (=0).

Member Data Documentation

◆ _timeout

int _timeout = 10

protectedinherited

◆ active

bool active = false

protected

◆ error_msg

const char* error_msg = "setAudioInfo not called"

protected

◆ fade

Fade fade

protected

◆ fade_last

LastSampleFader fade_last

protected

◆ info

AudioInfo info

protectedinherited

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ p_io

Stream* p_io = 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/Fade.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FadeStream() [1/3]

◆ FadeStream() [2/3]

◆ FadeStream() [3/3]

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ available()

◆ availableForWrite()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clearNotifyAudioChange()

◆ end()

◆ flush()

◆ isFadeComplete()

◆ isFadeInActive()

◆ isFadeOutActive()

◆ isNotifyActive()

◆ not_supported()

◆ notifyAudioChange()

◆ operator bool()

◆ readBytes()

◆ readSilence()

◆ refillReadBuffer()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setFadeInActive()

◆ setFadeOutActive()

◆ setNotifyActive()

◆ setOutput() [1/3]

◆ setOutput() [2/3]

◆ setOutput() [3/3]

◆ setStream() [1/3]

◆ setStream() [2/3]

◆ setStream() [3/3]

◆ setWriteBufferSize()

◆ write() [1/2]

◆ write() [2/2]

◆ writeEnd()

◆ writeSilence()

Member Data Documentation

◆ _timeout

◆ active

◆ error_msg

◆ fade

◆ fade_last

◆ info

◆ is_notify_active

◆ notify_vector

◆ p_io

◆ p_out

◆ tmp_in

◆ tmp_out

◆ write_buffer_size