arduino-audio-tools
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
AudioDecoder Class Referenceabstract

Docoding of encoded audio into PCM data. More...

#include <AudioEncoded.h>

Inheritance diagram for AudioDecoder:
AudioWriter AudioInfoSource AudioInfoSupport AACDecoderFAAD AACDecoderFDK AACDecoderHelix ADPCMDecoderXQ ADTSDecoder APTXDecoder AudioDecoderExt Codec2Decoder CodecNOP ContainerDecoder CopyDecoder DecoderAdapter DecoderBase64 DecoderBasic DecoderFloat DecoderHelix DecoderL16 DecoderL8 G722Decoder G7xxDecoder GSMDecoder ILBCDecoder LC3Decoder MP3DecoderHelix MP3DecoderMAD MP3DecoderMini MTSDecoder MTSDecoder OpusAudioDecoder SBCDecoder WAVDecoder WavIMADecoder

Public Member Functions

 AudioDecoder (AudioDecoder const &)=delete
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
virtual AudioInfo audioInfo ()
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
 
bool begin () override
 
virtual bool begin (AudioInfo info) override
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
void end () override
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual bool isResultPCM ()
 If true, the decoding result is PCM data.
 
virtual operator bool ()=0
 
AudioDecoderoperator= (AudioDecoder const &)=delete
 
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
 
virtual void setAudioInfo (AudioInfo from) override
 for most decoders this is not needed
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
virtual void setOutput (AudioOutput &out_stream)
 Defines where the decoded result is written to.
 
virtual void setOutput (AudioStream &out_stream)
 Defines where the decoded result is written to.
 
virtual void setOutput (Print &out_stream) override
 Defines where the decoded result is written to.
 
virtual size_t write (const void *in_ptr, size_t in_size)=0
 

Public Attributes

int id
 custom id to be used by application
 

Protected Member Functions

void notifyAudioChange (AudioInfo info)
 
void writeBlocking (Print *out, uint8_t *data, size_t len)
 

Protected Attributes

AudioInfo info
 
bool is_notify_active = true
 
Vector< AudioInfoSupport * > notify_vector
 
Printp_print = nullptr
 

Detailed Description

Docoding of encoded audio into PCM data.

Author
Phil Schatzmann

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