MP3DecoderHelix Class Reference

MP3 Decoder using libhelix: https://github.com/pschatzmann/arduino-libhelix This is basically just a simple wrapper to provide AudioInfo and AudioInfoSupport. More...

#include <CodecMP3Helix.h>

Inheritance diagram for MP3DecoderHelix:

Public Member Functions
	MP3DecoderHelix (Print &out_stream)
	Construct a new MP3DecoderMini object.
	MP3DecoderHelix (Print &out_stream, AudioInfoSupport &bi)
	Construct a new MP3DecoderMini object. The decoded output will go to the print object.
	~MP3DecoderHelix ()
	Destroy the MP3DecoderMini object.
void	addNotifyAudioChange (AudioInfoSupport &bi) override
	Defines the callback object to which the Audio information change is provided.
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
MP3FrameInfo	audioInfoEx ()
virtual AudioInfo	audioInfoOut ()
bool	begin () override
	Starts the processing.
virtual bool	begin (AudioInfo info) override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
libhelix::MP3DecoderHelix *	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.
size_t	maxFrameSize ()
	Provides the maximum frame size - this is allocated on the heap and you can reduce the heap size my minimizing this value.
size_t	maxPCMSize ()
	Provides the maximum pwm buffer size - this is allocated on the heap and you can reduce the heap size my minimizing this value.
	operator bool () override
	checks if the class is active
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
void	setAudioInfo (AudioInfo from) override
	for most decoders this is not needed
void	setMaxFrameSize (size_t len)
	Define your optimized maximum frame size.
void	setMaxPCMSize (size_t len)
	Define your optimized maximum pwm buffer size.
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 &outStream) override
	Defines the output Stream.
size_t	write (const uint8_t *data, size_t len) override
	Write mp3 data to decoder.

Static Public Member Functions
static void	infoCallback (MP3FrameInfo &i, void *ref)
	notifies the subscriber about a change

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
libhelix::MP3DecoderHelix *	mp3 =nullptr
Vector< AudioInfoSupport * >	notify_vector
Print *	p_print = nullptr

Detailed Description

MP3 Decoder using libhelix: https://github.com/pschatzmann/arduino-libhelix This is basically just a simple wrapper to provide AudioInfo and AudioInfoSupport.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

MP3DecoderHelix() [1/2]

MP3DecoderHelix ( Print &  out_stream )

inline

Construct a new MP3DecoderMini object.

Parameters

out_stream

MP3DecoderHelix() [2/2]

MP3DecoderHelix ( Print &  out_stream, AudioInfoSupport &  bi  )

inline

Construct a new MP3DecoderMini object. The decoded output will go to the print object.

Parameters

out_stream
bi

Member Function Documentation

addNotifyAudioChange()

void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlineoverridevirtual

Defines the callback object to which the Audio information change is provided.

Reimplemented from AudioInfoSource.

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtual

provides the actual input AudioInfo

Reimplemented from AudioDecoder.

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

begin() [1/2]

bool begin ( )

inlineoverridevirtual

Starts the processing.

Reimplemented from AudioDecoder.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

end()

void end ( )

inlineoverridevirtual

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, DecoderNetworkFormat, and GGWaveDecoder.

operator bool()

operator bool ( )

inlineoverridevirtual

checks if the class is active

Implements AudioWriter.

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

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

setOutput() [1/3]

virtual void setOutput ( AudioOutput &  out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in ADTSDecoder, 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, MTSDecoder, MTSDecoderTSDemux, and MetaDataFilterDecoder.

setOutput() [3/3]

void setOutput ( Print &  outStream )

inlineoverridevirtual

Defines the output Stream.

Reimplemented from AudioDecoder.

write()

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

Write mp3 data to decoder.

Implements AudioWriter.

---

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

• src/AudioTools/AudioCodecs/CodecMP3Helix.h