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

Converts any AudioDecoder to a StreamingDecoder. More...

#include <AudioCodecsBase.h>

Inheritance diagram for StreamingDecoderAdapter:
StreamingDecoder AudioInfoSource

Public Member Functions

 StreamingDecoderAdapter (AudioDecoder &decoder, int copySize=DEFAULT_BUFFER_SIZE)
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
AudioInfo audioInfo () override
 Provides the last available MP3FrameInfo.
 
bool begin () override
 Starts the processing.
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
virtual bool copy ()
 Process a single read operation - to be called in the loop.
 
void end () override
 Releases the reserved memory.
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual operator bool ()
 checks if the class is active
 
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
 
void resize (int bufferSize)
 Adjust the buffer size: the existing content of the buffer is lost!
 
void setInput (Stream &inStream)
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
virtual void setOutput (AudioOutput &out_stream)
 Defines the output streams and register to be notified.
 
virtual void setOutput (AudioStream &out_stream)
 Defines the output streams and register to be notified.
 
void setOutput (Print &out_stream) override
 Defines the output Stream.
 

Protected Member Functions

void notifyAudioChange (AudioInfo info)
 
size_t readBytes (uint8_t *data, size_t len) override
 

Protected Attributes

Vector< uint8_tbuffer {0}
 
bool is_notify_active = true
 
Vector< AudioInfoSupport * > notify_vector
 
AudioDecoderp_decoder = nullptr
 
Streamp_input = nullptr
 
Printp_print = nullptr
 

Detailed Description

Converts any AudioDecoder to a StreamingDecoder.

Author
Phil Schatzmann

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport bi)
inlinevirtualinherited

◆ audioInfo()

AudioInfo audioInfo ( )
inlineoverridevirtual

Provides the last available MP3FrameInfo.

Implements StreamingDecoder.

◆ begin()

bool begin ( )
inlineoverridevirtual

Starts the processing.

Implements StreamingDecoder.

◆ copy()

virtual bool copy ( )
inlinevirtual

Process a single read operation - to be called in the loop.

Implements StreamingDecoder.

◆ end()

void end ( )
inlineoverridevirtual

Releases the reserved memory.

Implements StreamingDecoder.

◆ operator bool()

virtual operator bool ( )
inlinevirtual

checks if the class is active

Implements StreamingDecoder.

◆ readBytes()

size_t readBytes ( uint8_t data,
size_t  len 
)
inlineoverrideprotectedvirtual

Implements StreamingDecoder.

◆ setInput()

void setInput ( Stream inStream)
inlineinherited

Stream Interface: Decode directly by taking data from the stream. This is more efficient then feeding the decoder with write: just call copy() in the loop

◆ setOutput()

void setOutput ( Print out_stream)
inlineoverridevirtual

Defines the output Stream.

Reimplemented from StreamingDecoder.


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