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

MP3 Decoder using https://github.com/pschatzmann/arduino-libmad. More...

#include <CodecMP3MAD.h>

Inheritance diagram for MP3DecoderMAD:
AudioDecoder AudioWriter AudioInfoSource AudioInfoSupport

Public Member Functions

 MP3DecoderMAD (libmad::MP3DataCallback dataCallback, libmad::MP3InfoCallback infoCB=nullptr)
 
 MP3DecoderMAD (Print &mad_output_streamput, libmad::MP3InfoCallback infoCB=nullptr)
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
libmad::MadAudioInfo audioInfoEx ()
 Provides the last valid audio information.
 
virtual AudioInfo audioInfoOut ()
 provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
 
bool begin ()
 Starts the processing.
 
virtual bool begin (AudioInfo info) override
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
libmad::MP3DecoderMAD * driver ()
 
void end ()
 Releases the reserved memory.
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual bool isResultPCM ()
 Returns true to indicate that the decoding result is PCM data.
 
 operator bool ()
 Returns true as long as we are processing data.
 
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
 
void setAudioDataCallback (libmad::MP3DataCallback cb)
 Defines the callback which receives the decoded data.
 
virtual void setAudioInfo (AudioInfo from) override
 for most decoders this is not needed
 
void setInfoCallback (libmad::MP3InfoCallback cb)
 Defines the callback which receives the Info changes.
 
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.
 
void setOutput (Print &out)
 Defines where the decoded result is written to.
 
size_t write (const uint8_t *data, size_t len)
 Makes the mp3 data available for decoding: however we recommend to provide the data via a callback or input stream.
 
size_t write (void *data, size_t len)
 Makes the mp3 data available for decoding: however we recommend to provide the data via a callback or input stream.
 

Static Public Member Functions

static void audioChangeCallback (libmad::MadAudioInfo &info)
 

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
 
libmad::MP3DecoderMAD * mad
 
Vector< AudioInfoSupport * > notify_vector
 
Printp_print = nullptr
 

Detailed Description

MP3 Decoder using https://github.com/pschatzmann/arduino-libmad.

Author
Phil Schatzmann

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport bi)
inlinevirtual

Adds target to be notified about audio changes.

Reimplemented from AudioInfoSource.

◆ audioInfo()

AudioInfo audioInfo ( )
inlineoverridevirtual

provides the actual input AudioInfo

Reimplemented from AudioDecoder.

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

◆ begin() [1/2]

bool begin ( )
inlinevirtual

Starts the processing.

Reimplemented from AudioDecoder.

◆ begin() [2/2]

virtual bool begin ( AudioInfo  info)
inlineoverridevirtualinherited

Reimplemented from AudioWriter.

◆ end()

void end ( )
inlinevirtual

Releases the reserved memory.

Reimplemented from AudioDecoder.

◆ isResultPCM()

virtual bool isResultPCM ( )
inlinevirtualinherited

Returns true to indicate that the decoding result is PCM data.

Reimplemented in CopyDecoder, and GGWaveDecoder.

◆ operator bool()

operator bool ( )
inlinevirtual

Returns true as long as we are processing data.

Implements AudioWriter.

◆ setAudioInfo()

virtual void setAudioInfo ( AudioInfo  from)
inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in GGWaveDecoder, DecoderL8, OpusAudioDecoder, CodecNOP, AACDecoderHelix, and G7xxDecoder.

◆ setOutput() [1/3]

virtual void setOutput ( AudioOutput out_stream)
inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in MetaDataFilterDecoder.

◆ setOutput() [2/3]

virtual void setOutput ( AudioStream out_stream)
inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in MetaDataFilterDecoder.

◆ setOutput() [3/3]

void setOutput ( Print out_stream)
inlinevirtual

Defines where the decoded result is written to.

Reimplemented from AudioDecoder.

◆ write()

size_t write ( const uint8_t data,
size_t  len 
)
inlinevirtual

Makes the mp3 data available for decoding: however we recommend to provide the data via a callback or input stream.

Implements AudioWriter.


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