MP3DecoderHelix Class Reference

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

#include <CodecMP3Helix.h>

Inheritance diagram for MP3DecoderHelix:

Public Member Functions
	MP3DecoderHelix ()
	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.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
void	addNotifyAudioChange (AudioInfoSupport &bi) override
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
MP3FrameInfo	audioInfoEx ()
virtual AudioInfo	audioInfoOut ()
virtual AudioInfo	audioInfoOut ()
virtual bool	begin (AudioInfo info) override
bool	begin () override
	Starts the processing.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
libhelix::MP3DecoderHelix *	driver ()
void	end () override
	Releases the reserved memory.
Print *	getOutput ()
Print *	getOutput ()
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual bool	isResultPCM ()
	Returns true to indicate that the decoding result is PCM data.
virtual bool	isResultPCM ()
	Returns true to indicate that the decoding result is PCM data.
size_t	maxFrameSize ()
size_t	maxPCMSize ()
const char *	mime () override
	Provides the mime type of the data that is expected by this decoder.
	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.
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	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.
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	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).
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	notifyAudioChange (AudioInfo info)
void	writeBlocking (Print *out, uint8_t *data, size_t len)
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/codec-helix This is basically just a simple wrapper to provide AudioInfo and AudioInfoSupport.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

MP3DecoderHelix() [1/3]

MP3DecoderHelix ( )

inline

MP3DecoderHelix() [2/3]

MP3DecoderHelix ( Print & out_stream )

inline

Construct a new MP3DecoderMini object.

Parameters

out_stream

MP3DecoderHelix() [3/3]

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

~MP3DecoderHelix()

~MP3DecoderHelix ( )

inline

Destroy the MP3DecoderMini object.

Member Function Documentation

addNotifyAudioChange() [1/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

addNotifyAudioChange() [2/2]

void addNotifyAudioChange ( AudioInfoSupport & bi )

inlineoverride

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

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtual

provides the actual input AudioInfo

Reimplemented from AudioDecoder.

audioInfoEx()

MP3FrameInfo audioInfoEx ( )

inline

audioInfoOut() [1/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

audioInfoOut() [2/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

begin() [1/2]

virtual bool begin ( AudioInfo info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

begin() [2/2]

bool begin ( )

inlineoverridevirtual

Starts the processing.

Reimplemented from AudioDecoder.

clearNotifyAudioChange() [1/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

clearNotifyAudioChange() [2/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

driver()

libhelix::MP3DecoderHelix * driver ( )

inline

end()

void end ( )

inlineoverridevirtual

Releases the reserved memory.

Reimplemented from AudioDecoder.

getOutput() [1/2]

Print * getOutput ( )

inlineinherited

getOutput() [2/2]

Print * getOutput ( )

inlineinherited

infoCallback()

void infoCallback ( MP3FrameInfo & i, void * ref )

inlinestatic

notifies the subscriber about a change

isNotifyActive() [1/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

isNotifyActive() [2/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

isResultPCM() [1/2]

virtual bool isResultPCM ( )

inlinevirtualinherited

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

Reimplemented in ContainerM4A, CopyDecoder, and DecoderNetworkFormat.

isResultPCM() [2/2]

virtual bool isResultPCM ( )

inlinevirtualinherited

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

Reimplemented in ContainerM4A, CopyDecoder, and DecoderNetworkFormat.

maxFrameSize()

size_t maxFrameSize ( )

inline

Provides the maximum frame size - this is allocated on the heap and you can reduce the heap size my minimizing this value

maxPCMSize()

size_t maxPCMSize ( )

inline

Provides the maximum pwm buffer size - this is allocated on the heap and you can reduce the heap size my minimizing this value

mime()

const char * mime ( )

inlineoverridevirtual

Provides the mime type of the data that is expected by this decoder.

Implements AudioDecoder.

notifyAudioChange() [1/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

notifyAudioChange() [2/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

operator bool()

operator bool ( )

inlineoverridevirtual

checks if the class is active

Implements AudioWriter.

removeNotifyAudioChange() [1/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

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

removeNotifyAudioChange() [2/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

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

setAudioInfo() [1/2]

void setAudioInfo ( AudioInfo from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

setAudioInfo() [2/2]

void setAudioInfo ( AudioInfo from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

setCodecConfig() [1/2]

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.

setCodecConfig() [2/2]

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.

setMaxFrameSize()

void setMaxFrameSize ( size_t len )

inline

Define your optimized maximum frame size.

setMaxPCMSize()

void setMaxPCMSize ( size_t len )

inline

Define your optimized maximum pwm buffer size.

setNotifyActive() [1/2]

void setNotifyActive ( bool flag )

inlineinherited

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

setNotifyActive() [2/2]

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.

setOutput() [2/3]

virtual void setOutput ( AudioStream & out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

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.

writeBlocking() [1/2]

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

inlineprotectedinherited

writeBlocking() [2/2]

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

mp3

libhelix::MP3DecoderHelix* mp3 = nullptr

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/CodecMP3Helix.h