DecoderHelix Class Reference

MP3 and AAC Decoder using libhelix: https://github.com/pschatzmann/arduino-libhelix. We dynamically create a MP3 or AAC decoder dependent on the provided audio format. In addition WAV files are also supported. More...

#include <CodecHelix.h>

Inheritance diagram for DecoderHelix:

Public Member Functions
void	addDecoder (AudioDecoder &decoder, const char *mime)
	Adds a decoder that will be selected by it's mime type.
void	addDecoder (AudioDecoder &decoder, const char *mime, bool(*check)(uint8_t *data, size_t len))
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
bool	begin () override
	Enables the automatic mime type determination.
virtual bool	begin (AudioInfo info) override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end () override
	closes the actual decoder
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.
virtual	operator bool () override
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
bool	selectDecoder (const char *mime)
void	setAudioInfo (AudioInfo from) override
	for most decoders this is not needed
void	setMimeSource (AbstractURLStream &url)
	Defines url stream from which we determine the mime type from the reply header.
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.
size_t	write (const uint8_t *data, size_t len) override

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
AACDecoderHelix	aac
struct audio_tools::MultiDecoder::DecoderInfo	actual_decoder
Vector< DecoderInfo >	decoders {0}
AudioInfo	info
bool	is_first = true
bool	is_notify_active = true
MimeDetector	mime_detector
MP3DecoderHelix	mp3
CodecNOP	nop
Vector< AudioInfoSupport * >	notify_vector
Print *	p_print = nullptr
AbstractURLStream *	p_url_stream = nullptr
WAVDecoder	wav

Detailed Description

MP3 and AAC Decoder using libhelix: https://github.com/pschatzmann/arduino-libhelix. We dynamically create a MP3 or AAC decoder dependent on the provided audio format. In addition WAV files are also supported.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

addDecoder()

void addDecoder ( AudioDecoder &  decoder, const char *  mime, bool(*)(uint8_t *data, size_t len)  check  )

inlineinherited

Adds a decoder that will be selected by it's mime type and defines the mime checking logic

addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, GGWaveDecoder, DecoderBasic, MP3DecoderHelix, MP3DecoderMAD, OpusAudioDecoder, WAVDecoder, WavIMADecoder, and OggContainerDecoder.

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 ( )

inlineoverridevirtualinherited

Enables the automatic mime type determination.

Reimplemented from AudioDecoder.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

end()

void end ( )

inlineoverridevirtualinherited

closes the actual decoder

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()

virtual operator bool ( )

inlineoverridevirtualinherited

Implements AudioWriter.

selectDecoder()

bool selectDecoder ( const char *  mime )

inlineinherited

selects the actual decoder by mime type - this is usually called automatically from the determined mime type

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]

virtual void setOutput ( Print &  out_stream )

inlineoverridevirtualinherited

Defines where the decoded result is written to.

Reimplemented from AudioDecoder.

write()

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtualinherited

Implements AudioWriter.

---

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

• src/AudioTools/AudioCodecs/CodecHelix.h