MP3DecoderMAD Class Reference

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

#include <CodecMP3MAD.h>

Inheritance diagram for MP3DecoderMAD:

Public Member Functions
	MP3DecoderMAD ()
	MP3DecoderMAD (libmad::MP3DataCallback dataCallback, libmad::MP3InfoCallback infoCB=nullptr)
	MP3DecoderMAD (Print &mad_output_streamput, libmad::MP3InfoCallback infoCB=nullptr)
	~MP3DecoderMAD ()
virtual void	addNotifyAudioChange (AudioInfoSupport &bi) override
	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 ()
bool	begin () override
	Starts the processing.
virtual bool	begin (AudioInfo info) override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
libmad::MP3DecoderMAD *	driver ()
void	end () override
	Releases the reserved memory.
Print *	getOutput ()
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 () override
	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.
void	setAudioInfo (AudioInfo from) override
	for most decoders this is not needed
virtual bool	setCodecConfig (const uint8_t *data, size_t len)
	Some decoders need e.g. a magic cookie to provide the relevant info for decoding.
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) override
	Defines where the decoded result is written to.
size_t	write (const uint8_t *data, size_t len) override
	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
Print *	p_print = nullptr

Detailed Description

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

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

MP3DecoderMAD() [1/3]

MP3DecoderMAD ( )

inline

MP3DecoderMAD() [2/3]

MP3DecoderMAD ( libmad::MP3DataCallback  dataCallback, libmad::MP3InfoCallback  infoCB = nullptr  )

inline

MP3DecoderMAD() [3/3]

MP3DecoderMAD ( Print &  mad_output_streamput, libmad::MP3InfoCallback  infoCB = nullptr  )

inline

~MP3DecoderMAD()

~MP3DecoderMAD ( )

inline

Member Function Documentation

addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlineoverridevirtual

Adds target to be notified about audio changes.

Reimplemented from AudioInfoSource.

audioChangeCallback()

static void audioChangeCallback ( libmad::MadAudioInfo &  info )

inlinestatic

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtual

provides the actual input AudioInfo

Reimplemented from AudioDecoder.

audioInfoEx()

libmad::MadAudioInfo audioInfoEx ( )

inline

Provides the last valid audio information.

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, ResampleStream, and ResampleStreamT< TInterpolator >.

begin() [1/2]

bool begin ( )

inlineoverridevirtual

Starts the processing.

Reimplemented from AudioDecoder.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

Reimplemented in DecoderBasic, and OggContainerDecoder.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

driver()

libmad::MP3DecoderMAD * driver ( )

inline

end()

void end ( )

inlineoverridevirtual

Releases the reserved memory.

Reimplemented from AudioDecoder.

getOutput()

Print * getOutput ( )

inlineinherited

isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

isResultPCM()

virtual bool isResultPCM ( )

inlinevirtualinherited

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

Reimplemented in CopyDecoder, DecoderNetworkFormat, and ContainerM4A.

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

operator bool()

operator bool ( )

inlineoverridevirtual

Returns true as long as we are processing data.

Implements AudioWriter.

removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

setAudioDataCallback()

void setAudioDataCallback ( libmad::MP3DataCallback  cb )

inline

Defines the callback which receives the decoded data.

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in DecoderALAC, CodecChain, DSFDecoder, DecoderL8, OpusAudioDecoder, CodecNOP, and G7xxDecoder.

setCodecConfig()

virtual bool setCodecConfig ( const uint8_t *  data, size_t  len  )

inlinevirtualinherited

Some decoders need e.g. a magic cookie to provide the relevant info for decoding.

Reimplemented in DecoderALAC, and MultiDecoder.

setInfoCallback()

void setInfoCallback ( libmad::MP3InfoCallback  cb )

inline

Defines the callback which receives the Info changes.

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active)

setOutput() [1/3]

virtual void setOutput ( AudioOutput &  out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in ADTSDecoder, CodecChain, MTSDecoder, MTSDecoderTSDemux, and MetaDataFilterDecoder.

setOutput() [2/3]

virtual void setOutput ( AudioStream &  out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in ADTSDecoder, CodecChain, MTSDecoder, MTSDecoderTSDemux, and MetaDataFilterDecoder.

setOutput() [3/3]

void setOutput ( Print &  out_stream )

inlineoverridevirtual

Defines where the decoded result is written to.

Reimplemented from AudioDecoder.

write() [1/2]

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

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

Implements AudioWriter.

write() [2/2]

size_t write ( void *  data, size_t  len  )

inline

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

writeBlocking()

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

inlineprotectedinherited

Member Data Documentation

id

int id

inherited

custom id to be used by application

info

AudioInfo info

protectedinherited

is_notify_active

bool is_notify_active = true

protectedinherited

mad

libmad::MP3DecoderMAD* mad

protected

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

p_print

Print* p_print = nullptr

protectedinherited

---

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

• src/AudioTools/AudioCodecs/CodecMP3MAD.h