arduino-audio-tools
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Modules Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AbstractURLStream Class Referenceabstract
Arduino Audio Tools » Communications » Http

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

#include <AbstractURLStream.h>

Inheritance diagram for AbstractURLStream:
AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print HLSStreamT< URLStream > ICYStreamT< T > URLStream URLStreamBufferedT< T > URLStreamESP32

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

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, MP3DecoderMAD, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, MP3DecoderHelix, OggContainerDecoder, 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 >, URLStream, ICYStreamT< T >, URLStreamBufferedT< T >, and URLStreamESP32.

◆ audioInfo()

virtual AudioInfo audioInfo ( )
inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, 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, and ResampleStream.

◆ available()

virtual int available ( )
inlineoverridevirtualinherited

Reimplemented from Stream.

Reimplemented in AudioKitStream, A2DPStream, AudioFFTBase, HLSStreamT< URLStream >, I2SCodecStream, TfLiteAudioStream, UDPStream, ICYStreamT< T >, BufferedTaskStream, I2SStream, TimedStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, ConverterStream< T >, InputMerge< T >, Pipeline::ModifyingStreamAdapter, and VolumeStream.

◆ availableForWrite()

int availableForWrite ( )
inlineoverridevirtual

Writes are not supported.

Reimplemented from BaseStream.

Reimplemented in URLStreamESP32.

◆ begin() [1/2]

virtual bool begin ( )
inlinevirtualinherited

Reimplemented in AudioOutputWithCallback, HLSStreamT< URLStream >, SPDIFOutput, VS1053Stream, WM8960Stream, ESPNowStream, TimerCallbackAudioStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, AudioFFTBase, AnalogAudioArduino, AnalogAudioStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, FormatConverterStream, and Pipeline.

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

◆ contentLength()

virtual int contentLength ( )
pure virtual

Provides the reported data size from the http reply.

Implemented in HLSStreamT< URLStream >, URLStream, and URLStreamESP32.

◆ end()

virtual void end ( )
overridepure virtual

Reimplemented from BaseStream.

Implemented in HLSStreamT< URLStream >, and ICYStreamT< T >.

◆ flush()

virtual void flush ( )
inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.

◆ getReplyHeader()

virtual const char * getReplyHeader ( const char *  header)
pure virtual

Provides reply header information.

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

◆ httpRequest()

virtual HttpRequest & httpRequest ( )
pure virtual

provides access to the HttpRequest

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

◆ operator bool()

virtual operator bool ( )
inlinevirtualinherited

Reimplemented in A2DPStream, Pipeline, I2SStream, and MemoryStream.

◆ readBytes()

virtual size_t readBytes ( uint8_t *  data,
size_t  len 
)
inlineoverridevirtualinherited

Implements BaseStream.

Reimplemented in MozziStream, A2DPStream, FaustStream< DSP >, AudioFFTBase, AudioKitStream, HLSStreamT< URLStream >, I2SCodecStream, TfLiteAudioStream, AnalogAudioArduino, AudioEffectStreamT< T >, Equalizer3Bands, ICYStreamT< T >, BufferedTaskStream, I2SStream, TimedStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, MeasuringStream, ProgressStream, InputMixer< T >, InputMerge< T >, VolumeStream, and AnalogDriverESP32V2::IO16Bit.

◆ setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info)
inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

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

◆ setCACert()

virtual void setCACert ( const char *  cert)
pure virtual

Define the Root PEM Certificate for SSL.

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

◆ setClient()

virtual void setClient ( Client &  clientPar)
pure virtual

(Re-)defines the client

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

◆ setConnectionClose()

virtual void setConnectionClose ( bool  flag)
pure virtual

Add Connection: close to request header.

Implemented in URLStream, HLSStreamT< URLStream >, and URLStreamESP32.

◆ setMetadataCallback()

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

Reimplemented in ICYStreamT< T >.

◆ setPassword()

virtual void setPassword ( const char *  password)
pure virtual

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

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

◆ 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 >, URLStream, URLStreamESP32, and URLStreamBufferedT< T >.

◆ setSSID()

virtual void setSSID ( const char *  ssid)
pure virtual

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

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

◆ totalRead()

virtual size_t totalRead ( )
pure virtual

Total amout of data that was consumed so far.

Implemented in HLSStreamT< URLStream >, URLStream, and URLStreamESP32.

◆ urlStr()

virtual const char * urlStr ( )
pure virtual

Provides the url as string.

Implemented in HLSStreamT< URLStream >, URLStream, 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 >, URLStream, and URLStreamESP32.

◆ write() [1/2]

virtual size_t write ( const uint8_t *  data,
size_t  len 
)
inlineoverridevirtualinherited

Implements BaseStream.

Reimplemented in I2SCodecStream, MozziStream, SPDIFOutput, I2SStream, A2DPStream, FaustStream< DSP >, AudioFFTBase, TfLiteAudioStream, VS1053Stream, AnalogAudioStream, AudioEffectStreamT< T >, BufferedTaskStream, TimedStream, BufferedStream, MeasuringStream, ProgressStream, VolumeStream, TfLiteAudioStreamBase, and AnalogDriverESP32V2::IO16Bit.

◆ write() [2/2]

virtual size_t write ( uint8_t  ch)
inlineoverridevirtualinherited

Reimplemented in BufferedTaskStream, and BufferedStream.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8