arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AudioOutputWithCallback Class Referenceabstract

ESP8266Audio AudioOutput class which stores the data in a temporary buffer. The buffer can be consumed e.g. by a callback function by calling read(); Dependencies: ESP8266Audio Library Dependencies: ESP32-A2DP Library. More...

#include <AudioESP8266.h>

Inheritance diagram for AudioOutputWithCallback:
AudioOutput BufferedStream Print AudioInfoSupport AudioInfoSource ModifyingStream AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 AudioOutputWithCallback (int bufferSize, int bufferCount)
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 
int available () override
 Returns the available bytes.
 
virtual int availableForWrite () override
 
virtual int availableForWrite () override
 
virtual bool begin ()
 Activates the output.
 
virtual bool begin (AudioInfo info)
 
void clear ()
 Clears all the data in the buffer.
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
virtual bool ConsumeSample (int16_t sample[2])
 puts the sample into a buffer
 
virtual void end ()
 
virtual void end ()
 
virtual void flush ()
 
void flush () override
 empties the buffer
 
virtual bool isDeletable ()
 If true we need to release the related memory in the destructor.
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual operator bool ()
 
virtual operator bool ()
 
int peek () override
 peeks a byte - to be avoided
 
size_t peekBytes (uint8_t *data, size_t len)
 Provides data w/o consuming.
 
int read () override
 reads a byte - to be avoided
 
size_t read (Frame *src, size_t len)
 Provides the data from the internal buffer to the callback.
 
size_t readBytes (uint8_t *data, size_t len) override
 Use this method !!
 
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 resize (int size)
 Resize the buffer.
 
virtual void setAudioInfo (AudioInfo newInfo) override
 Defines the input AudioInfo.
 
virtual void setAudioInfo (AudioInfo newInfo) override
 Defines the input AudioInfo.
 
void setMinUnbufferedReadSize (size_t size)
 Defines the minimum direct unbuffered read size to the original source (default is 1024)
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
void setOutput (Print &out) override
 Defines/Changes the output target.
 
void setStream (Print &out)
 
void setStream (Stream &io) override
 Defines/Changes the input & output.
 
void setWriteBufferSize (int size)
 
virtual bool stop ()
 stops the processing
 
size_t write (const uint8_t *data, size_t len) override
 Use this method: write an array.
 
virtual size_t write (const uint8_t *data, size_t len) override=0
 
size_t write (uint8_t c) override
 writes a byte to the buffer
 
virtual size_t write (uint8_t ch) override
 
virtual void writeSilence (size_t len)
 
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 notifyAudioChange (AudioInfo info)
 
virtual size_t readExt (uint8_t *data, size_t len)
 
void refill ()
 refills the buffer with data from the source
 
void refill (size_t len)
 refill only if not enough data
 
void refillReadBuffer ()
 
virtual size_t writeExt (const uint8_t *data, size_t len)
 

Protected Attributes

int _timeout = 10
 
int _timeout = 10
 
bool active
 
SingleBuffer< uint8_t > buffer {0}
 
NBuffer< Frame > * callback_buffer_ptr
 
AudioInfo cfg
 
AudioInfo info
 
bool is_active = false
 
bool is_notify_active = true
 
bool is_notify_active = true
 
size_t minReadBufferSize = 1024
 
Vector< AudioInfoSupport * > notify_vector
 
Vector< AudioInfoSupport * > notify_vector
 
Streamp_in = nullptr
 
Printp_out = nullptr
 
SingleBuffer< uint8_t > tmp {MAX_SINGLE_CHARS}
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 
int tmpPos = 0
 
int write_buffer_size = MAX_SINGLE_CHARS
 

Detailed Description

ESP8266Audio AudioOutput class which stores the data in a temporary buffer. The buffer can be consumed e.g. by a callback function by calling read(); Dependencies: ESP8266Audio Library Dependencies: ESP32-A2DP Library.

Author
Phil Schatzmann

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport bi)
inlinevirtualinherited

◆ audioInfo() [1/2]

virtual AudioInfo audioInfo ( )
inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterPrintToAudioOutput, EncodedAudioOutput, and AdapterAudioStreamToAudioOutput.

◆ audioInfo() [2/2]

virtual AudioInfo audioInfo ( )
inlineoverridevirtualinherited

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

◆ available()

int available ( )
inlineoverridevirtualinherited

Returns the available bytes.

Reimplemented from BaseStream.

◆ availableForWrite() [1/2]

virtual int availableForWrite ( )
inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in RTSPOutput.

◆ availableForWrite() [2/2]

virtual int availableForWrite ( )
inlineoverridevirtualinherited

◆ begin() [1/2]

virtual bool begin ( )
inlinevirtual

Activates the output.

Reimplemented from AudioOutput.

◆ begin() [2/2]

virtual bool begin ( AudioInfo  info)
inlinevirtualinherited

◆ end() [1/2]

virtual void end ( )
inlinevirtualinherited

◆ end() [2/2]

virtual void end ( )
inlinevirtualinherited

◆ flush() [1/2]

virtual void flush ( )
inlinevirtualinherited

Reimplemented from Print.

◆ flush() [2/2]

void flush ( )
inlineoverridevirtualinherited

empties the buffer

Reimplemented from BaseStream.

◆ isDeletable()

virtual bool isDeletable ( )
inlinevirtualinherited

If true we need to release the related memory in the destructor.

Reimplemented in AdapterPrintToAudioOutput, and AdapterAudioStreamToAudioOutput.

◆ operator bool() [1/2]

virtual operator bool ( )
inlinevirtualinherited

Reimplemented in RTSPOutput, and EncodedAudioOutput.

◆ operator bool() [2/2]

virtual operator bool ( )
inlinevirtualinherited

◆ readBytes()

size_t readBytes ( uint8_t *  data,
size_t  len 
)
inlineoverridevirtualinherited

Use this method !!

Reimplemented from AudioStream.

◆ readExt()

virtual size_t readExt ( uint8_t *  data,
size_t  len 
)
inlineprotectedvirtual

Reimplemented from BufferedStream.

◆ setAudioInfo() [1/2]

virtual void setAudioInfo ( AudioInfo  info)
inlineoverridevirtualinherited

◆ setAudioInfo() [2/2]

virtual void setAudioInfo ( AudioInfo  info)
inlineoverridevirtualinherited

◆ setOutput()

void setOutput ( Print out)
inlineoverridevirtualinherited

Defines/Changes the output target.

Implements ModifyingStream.

◆ setStream()

void setStream ( Stream in)
inlineoverridevirtualinherited

Defines/Changes the input & output.

Implements ModifyingStream.

◆ write() [1/3]

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

Use this method: write an array.

Reimplemented from AudioStream.

◆ write() [2/3]

virtual size_t write ( const uint8_t *  data,
size_t  len 
)
overridepure virtualinherited

◆ write() [3/3]

size_t write ( uint8_t  c)
inlineoverridevirtualinherited

writes a byte to the buffer

Reimplemented from BaseStream.

◆ writeExt()

virtual size_t writeExt ( const uint8_t *  data,
size_t  len 
)
inlineprotectedvirtual

Reimplemented from BufferedStream.

◆ writeSilence()

virtual void writeSilence ( size_t  len)
inlinevirtualinherited

Writes n 0 values (= silence)

Parameters
len

The documentation for this class was generated from the following file: