AACDecoderHelix Class Reference

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

#include <CodecAACHelix.h>

Inheritance diagram for AACDecoderHelix:

Public Member Functions
	AACDecoderHelix (Print &out_stream)
	Construct a new AACDecoderMini object.
	AACDecoderHelix (Print &out_stream, AudioInfoSupport &bi)
	Construct a new AACDecoderMini object. The decoded output will go to the print object.
	~AACDecoderHelix ()
	Destroy the AACDecoderMini object.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual _AACFrameInfo	audioInfoEx ()
virtual AudioInfo	audioInfoOut ()
bool	begin () override
	Starts the processing.
virtual bool	begin (AudioInfo info) override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	end () override
	Releases the reserved memory.
void	flush ()
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 ()
size_t	maxPCMSize ()
virtual	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 info) override
	Defines the input AudioInfo.
void	setAudioInfoNotifications (bool active)
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)
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 the output Stream.
size_t	write (const uint8_t *data, size_t len) override
	Write AAC data to decoder.

Static Public Member Functions
static void	infoCallback (_AACFrameInfo &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
libhelix::AACDecoderHelix *	aac = nullptr
AudioInfo	info
bool	info_notifications_active = true
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
Print *	p_print = nullptr

Detailed Description

AAC 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

AACDecoderHelix() [1/2]

AACDecoderHelix ( Print &  out_stream )

inline

Construct a new AACDecoderMini object.

Parameters

out_stream

AACDecoderHelix() [2/2]

AACDecoderHelix ( Print &  out_stream, AudioInfoSupport &  bi  )

inline

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

Parameters

out_stream
bi

Member Function Documentation

addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtual

provides the actual input AudioInfo

Implements AudioInfoSupport.

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.

Implements AudioWriter.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

end()

virtual void end ( )

inlineoverridevirtual

Releases the reserved memory.

Implements AudioWriter.

isResultPCM()

virtual bool isResultPCM ( )

inlinevirtualinherited

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

Reimplemented in CopyDecoder, DecoderNetworkFormat, and ContainerM4A.

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

operator bool()

virtual operator bool ( )

inlineoverridevirtual

checks if the class is active

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 >.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineoverridevirtual

Defines the input AudioInfo.

Implements AudioWriter.

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.

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]

virtual void setOutput ( Print &  out_stream )

inlineoverridevirtual

Defines the output Stream.

Reimplemented from AudioDecoder.

write()

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

Write AAC data to decoder.

Implements AudioWriter.

---

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

• src/AudioTools/AudioCodecs/CodecAACHelix.h