Abstract Base class for all URLStream implementations. More...

#include <AbstractURLStream.h>

Inheritance diagram for AbstractURLStream:

Public Member Functions
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.

virtual void	addRequestHeader (const char header, const char value)=0
	Adds/Updates a request header.

virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo

virtual AudioInfo	audioInfoOut ()

virtual int	available () override

int	availableForWrite () override
	Writes are not supported.

virtual bool	begin ()

virtual bool	begin (const char urlStr, const char acceptMime=nullptr, MethodID action=GET, const char reqMime="", const char reqData="")=0

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

virtual int	contentLength ()=0
	Provides the reported data size from the http reply.

virtual void	end () override=0

virtual void	flush () override

virtual const char *	getReplyHeader (const char *header)=0
	Provides reply header information.

virtual HttpRequest &	httpRequest ()=0
	provides access to the HttpRequest

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

const char *	mime () override
	Provides the MIME type for the current stream.

virtual	operator bool ()

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

virtual void	setAudioInfo (AudioInfo newInfo) override
	Defines the input AudioInfo.

virtual void	setCACert (const char *cert)=0
	Define the Root PEM Certificate for SSL.

virtual void	setClient (Client &clientPar)=0
	(Re-)defines the client

virtual void	setConnectionClose (bool flag)=0
	Add Connection: close to request header.

virtual bool	setMetadataCallback (void(fn)(MetaDataType info, const char str, int len))

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

virtual void	setPassword (const char *password)=0
	Sets the password that will be used for logging in (when calling begin)

virtual void	setPowerSave (bool ps)=0

virtual void	setSSID (const char *ssid)=0
	Sets the ssid that will be used for logging in (when calling begin)

void	setWriteBufferSize (int size)

virtual size_t	totalRead ()=0
	Total amout of data that was consumed so far.

virtual const char *	urlStr ()=0
	Provides the url as string.

virtual bool	waitForData (int timeout)=0

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

AudioInfo	info

bool	is_notify_active = true

Vector< AudioInfoSupport * >	notify_vector

RingBuffer< uint8_t >	tmp_in {0}

RingBuffer< uint8_t >	tmp_out {0}

int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

Abstract Base class for all URLStream implementations.

Author: Phil Schatzmann

Copyright: GPLv3

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.

◆ addRequestHeader()

virtual void addRequestHeader	(	const char *	header,
		const char *	value
	)

pure virtual

Adds/Updates a request header.

Implemented in HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, and URLStreamESP32.

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

virtual int available ( )

inlineoverridevirtualinherited

Reimplemented from Stream.

Reimplemented in AudioKitStream, AudioLoRa, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, VBANStream, AudioStreamWrapper, LoRaStream, FaustStream< DSP >, AudioFFTBase, AudioMP34DT05, I2SCodecStream, MiniAudioStream, StdioStream, TfLiteAudioStream, A2DPStream, ESPNowStream, HammingFEC< bytecount, block_t >, HLSStreamT< URLStream >, HttpRequest, ICYStreamT< T >, URLStream, BufferedTaskStream, ReedSolomonFEC< bytecount, additional_bytes >, UDPStream, AnalogAudioArduino, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, ReformatBaseStream, TimedStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, ConverterStream< T >, MeasuringStream, ProgressStream, Throttle, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, CatStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, FadeStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, Pipeline, Pipeline::ModifyingStreamAdapter, VolumeStream, FileLoopT< FileType >, FileLoopT< File >, AudioBLEClient, AudioBLEClient, AudioBLEServer, and AudioBLEServer.

◆ availableForWrite()

int availableForWrite ( )

inlineoverridevirtual

Writes are not supported.

Reimplemented from BaseStream.

Reimplemented in URLStreamESP32.

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

◆ begin() [2/2]

virtual bool begin	(	const char *	urlStr,
		const char *	acceptMime = `nullptr`,
		MethodID	action = `GET`,
		const char *	reqMime = `""`,
		const char *	reqData = `""`
	)

pure virtual

Implemented in HLSStreamT< URLStream >, URLStreamESP32, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, ICYStreamT< T >, and URLStream.

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ contentLength()

virtual int contentLength ( )

pure virtual

Provides the reported data size from the http reply.

Implemented in HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, and URLStreamESP32.

◆ end()

virtual void end ( )

overridepure virtual

Reimplemented from BaseStream.

Implemented in URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, and URLStreamESP32.

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

◆ getReplyHeader()

virtual const char * getReplyHeader ( const char * header )

pure virtual

Provides reply header information.

Implemented in HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, and URLStreamESP32.

◆ httpRequest()

virtual HttpRequest & httpRequest ( )

pure virtual

provides access to the HttpRequest

Implemented in URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, and URLStreamESP32.

◆ isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ mime()

const char * mime ( )

inlineoverridevirtual

Provides the MIME type for the current stream.

Implements MimeSource.

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

virtual size_t readBytes	(	uint8_t *	data,
		size_t	len
	)

inlineoverridevirtualinherited

Implements BaseStream.

Reimplemented in LMSEchoCancellationStream< T >, MDFEchoCancellationStream< Allocator >, MozziStream, PureDataStream, AudioLoRa, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, AudioStreamWrapper, LoRaStream, EncodedAudioStream, FaustStream< DSP >, AudioFFTBase, AudioKitStream, AudioMP34DT05, I2SCodecStream, MiniAudioStream, PortAudioStream, TfLiteAudioStream, A2DPStream, AdaptiveResamplingStream, HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, BufferedTaskStream, URLStreamESP32, VBANStream, AnalogAudioArduino, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, ReformatBaseStream, TimedStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, ConverterStream< T >, MeasuringStream, ProgressStream, Throttle, InputMixer< T >, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, VolumeMeter, AudioInputMonitor, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FadeStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GoertzelStream, Pipeline, VolumeStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, WM8960Stream, AnalogDriverESP32V1::IO16Bit, and AnalogDriverESP32V2::IO16Bit.

◆ 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

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

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

◆ setCACert()

virtual void setCACert ( const char * cert )

pure virtual

Define the Root PEM Certificate for SSL.

Implemented in ICYStreamT< T >, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, HLSStreamT< URLStream >, URLStream, and URLStreamESP32.

◆ setClient()

virtual void setClient ( Client & clientPar )

pure virtual

(Re-)defines the client

Implemented in ICYStreamT< T >, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamESP32, HLSStreamT< URLStream >, and URLStream.

◆ setConnectionClose()

virtual void setConnectionClose ( bool flag )

pure virtual

Add Connection: close to request header.

Implemented in URLStream, HLSStreamT< URLStream >, ICYStreamT< T >, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, and URLStreamESP32.

◆ setMetadataCallback()

virtual bool setMetadataCallback ( void(*)(MetaDataType info, const char *str, int len) fn )

inlinevirtual

Reimplemented in ICYStreamBuffered, and ICYStreamT< T >.

◆ setNotifyActive()

void setNotifyActive ( bool flag )

inlineinherited

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

◆ setPassword()

virtual void setPassword ( const char * password )

pure virtual

Sets the password that will be used for logging in (when calling begin)

Implemented in URLStreamESP32, HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, URLStreamBufferedT< T >, and URLStreamBufferedT< ICYStream >.

◆ setPowerSave()

virtual void setPowerSave ( bool ps )

pure virtual

if set to true, it activates the power save mode which comes at the cost of performance! - By default this is deactivated. ESP32 Only!

Implemented in ICYStreamT< T >, HLSStreamT< URLStream >, URLStreamESP32, URLStream, URLStreamBufferedT< T >, and URLStreamBufferedT< ICYStream >.

◆ setSSID()

virtual void setSSID ( const char * ssid )

pure virtual

Sets the ssid that will be used for logging in (when calling begin)

Implemented in URLStreamESP32, HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, URLStreamBufferedT< T >, and URLStreamBufferedT< ICYStream >.

◆ setWriteBufferSize()

void setWriteBufferSize ( int size )

inlineinherited

◆ totalRead()

virtual size_t totalRead ( )

pure virtual

Total amout of data that was consumed so far.

Implemented in HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, and URLStreamESP32.

◆ urlStr()

virtual const char * urlStr ( )

pure virtual

Provides the url as string.

Implemented in HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, and URLStreamESP32.

◆ waitForData()

virtual bool waitForData ( int timeout )

pure virtual

Waits the indicated time for the data to be available waits for some data - returns false if the request has failed

Implemented in HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, and URLStreamESP32.

◆ 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

◆ info

AudioInfo info

protectedinherited

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ 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/Communication/HTTP/AbstractURLStream.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addNotifyAudioChange()

◆ addRequestHeader()

◆ audioInfo()

◆ audioInfoOut()

◆ available()

◆ availableForWrite()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clearNotifyAudioChange()

◆ contentLength()

◆ end()

◆ flush()

◆ getReplyHeader()

◆ httpRequest()

◆ isNotifyActive()

◆ mime()

◆ not_supported()

◆ notifyAudioChange()

◆ operator bool()

◆ readBytes()

◆ readSilence()

◆ refillReadBuffer()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setCACert()

◆ setClient()

◆ setConnectionClose()

◆ setMetadataCallback()

◆ setNotifyActive()

◆ setPassword()

◆ setPowerSave()

◆ setSSID()

◆ setWriteBufferSize()

◆ totalRead()

◆ urlStr()

◆ waitForData()

◆ write() [1/2]

◆ write() [2/2]

◆ writeSilence()

Member Data Documentation

◆ _timeout

◆ info

◆ is_notify_active

◆ notify_vector

◆ tmp_in

◆ tmp_out

◆ write_buffer_size