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
URLStreamBufferedT< T > Class Template Referenceabstract
Arduino Audio Tools » Communications » Http

URLStream implementation for the ESP32 based on a separate FreeRTOS task: the. More...

#include <URLStreamBufferedT.h>

Inheritance diagram for URLStreamBufferedT< T >:
AbstractURLStream AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 URLStreamBufferedT (const char *network, const char *password, int readBufferSize=DEFAULT_BUFFER_SIZE)
 
 URLStreamBufferedT (int readBufferSize=DEFAULT_BUFFER_SIZE)
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
void addRequestHeader (const char *key, const char *value) override
 Adds/Updates a request header.
 
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 
virtual int available ()
 
int availableForWrite () override
 Writes are not supported.
 
virtual bool begin ()
 
bool begin (const char *urlStr, const char *acceptMime=nullptr, MethodID action=GET, const char *reqMime="", const char *reqData="")
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
virtual int contentLength ()=0
 Provides the reported data size from the http reply.
 
void end ()
 
virtual void flush ()
 
const char * getReplyHeader (const char *key) override
 Provides reply header info.
 
HttpRequest & httpRequest ()
 provides access to the HttpRequest
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual operator bool ()
 
virtual int peek ()
 
virtual int read ()
 
virtual size_t readBytes (uint8_t *data, size_t len)
 
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.
 
void setBufferSize (int bufferSize, int bufferCount)
 Defines the buffer that holds the with encoded data.
 
void setCACert (const char *cert)
 Define the Root PEM Certificate for SSL.
 
void setClient (Client &client) override
 (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)
 
void setPassword (const char *password) override
 Sets the password that will be used for logging in (when calling begin)
 
void setPowerSave (bool ps) override
 ESP32 only: PowerSave off (= default setting) is much faster.
 
void setSSID (const char *ssid) override
 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
 
BufferedTaskStream taskStream
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 
T urlStream
 

Detailed Description

template<class T>
class audio_tools::URLStreamBufferedT< T >

URLStream implementation for the ESP32 based on a separate FreeRTOS task: the.

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

template<class T >
void addRequestHeader ( const char *  key,
const char *  value 
)
inlineoverridevirtual

Adds/Updates a request header.

Implements AbstractURLStream.

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

template<class T >
virtual int available ( )
inlinevirtual

Reimplemented from BaseStream.

◆ availableForWrite()

int availableForWrite ( )
inlineoverridevirtualinherited

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]

template<class T >
bool begin ( const char *  urlStr,
const char *  acceptMime = nullptr,
MethodID  action = GET,
const char *  reqMime = "",
const char *  reqData = "" 
)
inlinevirtual

Implements AbstractURLStream.

◆ contentLength()

virtual int contentLength ( )
pure virtualinherited

Provides the reported data size from the http reply.

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

◆ end()

template<class T >
void end ( )
inlinevirtual

Implements AbstractURLStream.

◆ flush()

template<class T >
virtual void flush ( )
inlinevirtual

Reimplemented from BaseStream.

◆ getReplyHeader()

template<class T >
const char * getReplyHeader ( const char *  key)
inlineoverridevirtual

Provides reply header info.

Implements AbstractURLStream.

◆ httpRequest()

template<class T >
HttpRequest & httpRequest ( )
inlinevirtual

provides access to the HttpRequest

Implements AbstractURLStream.

◆ operator bool()

virtual operator bool ( )
inlinevirtualinherited

Reimplemented in A2DPStream, Pipeline, I2SStream, and MemoryStream.

◆ readBytes()

template<class T >
virtual size_t readBytes ( uint8_t *  data,
size_t  len 
)
inlinevirtual

Reimplemented from AudioStream.

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

template<class T >
void setCACert ( const char *  cert)
inlinevirtual

Define the Root PEM Certificate for SSL.

Implements AbstractURLStream.

◆ setClient()

template<class T >
void setClient ( Client &  client)
inlineoverridevirtual

(Re-)defines the client

Implements AbstractURLStream.

◆ setConnectionClose()

virtual void setConnectionClose ( bool  flag)
pure virtualinherited

Add Connection: close to request header.

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

◆ setMetadataCallback()

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

Reimplemented in ICYStreamT< T >.

◆ setPassword()

template<class T >
void setPassword ( const char *  password)
inlineoverridevirtual

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

Implements AbstractURLStream.

◆ setPowerSave()

template<class T >
void setPowerSave ( bool  ps)
inlineoverridevirtual

ESP32 only: PowerSave off (= default setting) is much faster.

Implements AbstractURLStream.

◆ setSSID()

template<class T >
void setSSID ( const char *  ssid)
inlineoverridevirtual

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

Implements AbstractURLStream.

◆ totalRead()

virtual size_t totalRead ( )
pure virtualinherited

Total amout of data that was consumed so far.

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

◆ urlStr()

virtual const char * urlStr ( )
pure virtualinherited

Provides the url as string.

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

◆ waitForData()

virtual bool waitForData ( int  timeout)
pure virtualinherited

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