AACDecoderFDK Class Reference

Audio Decoder which decodes AAC into a PCM stream This is basically just a wrapper using https://github.com/pschatzmann/codec-fdk-aac which uses AudioInfo and provides the handlig of AudioInfo changes. More...

#include <CodecAACFDK.h>

Inheritance diagram for AACDecoderFDK:

Public Member Functions
	AACDecoderFDK (int output_buffer_size=FDK_OUT_BUFFER_DEFAULT_SIZE)
	AACDecoderFDK (Print &out_stream, int output_buffer_size=2048)
virtual	~AACDecoderFDK ()
void	addNotifyAudioChange (AudioInfoSupport &bi) override
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
CStreamInfo	audioInfoEx ()
virtual AudioInfo	audioInfoOut ()
virtual AudioInfo	audioInfoOut ()
bool	begin () override
bool	begin (TRANSPORT_TYPE transportType, UINT nrOfLayers)
virtual bool	begin (AudioInfo info) override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
AAC_DECODER_ERROR	configure (uint8_t *conf, const uint32_t &length)
	Explicitly configure the decoder by passing a raw AudioSpecificConfig (ASC) or a StreamMuxConfig (SMC), contained in a binary buffer. This is required for MPEG-4 and Raw Packets file format bitstreams as well as for LATM bitstreams with no in-band SMC. If the transport format is LATM with or without LOAS, configuration is assumed to be an SMC, for all other file formats an ASC.
aac_fdk::AACDecoderFDK *	driver ()
void	end () override
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.
const char *	mime () override
	Provides the mime type of the data that is expected by this decoder.
virtual	operator bool () override
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	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void	setOutput (Print &out_stream) override
	Defines the output stream.
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 size_t	write (const uint8_t *data, size_t len) override

Static Public Member Functions
static void	audioChangeCallback (CStreamInfo &info)

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
aac_fdk::AACDecoderFDK *	dec =nullptr
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
Print *	p_print = nullptr

Detailed Description

Audio Decoder which decodes AAC into a PCM stream This is basically just a wrapper using https://github.com/pschatzmann/codec-fdk-aac which uses AudioInfo and provides the handlig of AudioInfo changes.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AACDecoderFDK() [1/2]

AACDecoderFDK ( int output_buffer_size = FDK_OUT_BUFFER_DEFAULT_SIZE )

inline

AACDecoderFDK() [2/2]

AACDecoderFDK ( Print & out_stream, int output_buffer_size = 2048 )

inline

~AACDecoderFDK()

virtual ~AACDecoderFDK ( )

inlinevirtual

Member Function Documentation

addNotifyAudioChange() [1/2]

void addNotifyAudioChange ( AudioInfoSupport & bi )

inlineoverride

addNotifyAudioChange() [2/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

audioChangeCallback()

void audioChangeCallback ( CStreamInfo & info )

inlinestatic

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtual

provides the actual input AudioInfo

Implements AudioInfoSupport.

audioInfoEx()

CStreamInfo 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/3]

bool begin ( )

inlineoverridevirtual

Implements AudioWriter.

begin() [2/3]

bool begin ( TRANSPORT_TYPE transportType, UINT nrOfLayers )

inline

begin() [3/3]

virtual bool begin ( AudioInfo info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

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

configure()

AAC_DECODER_ERROR configure ( uint8_t * conf, const uint32_t & length )

inline

Explicitly configure the decoder by passing a raw AudioSpecificConfig (ASC) or a StreamMuxConfig (SMC), contained in a binary buffer. This is required for MPEG-4 and Raw Packets file format bitstreams as well as for LATM bitstreams with no in-band SMC. If the transport format is LATM with or without LOAS, configuration is assumed to be an SMC, for all other file formats an ASC.

driver()

aac_fdk::AACDecoderFDK * driver ( )

inline

end()

void end ( )

inlineoverridevirtual

Implements AudioWriter.

getOutput() [1/2]

Print * getOutput ( )

inlineinherited

getOutput() [2/2]

Print * getOutput ( )

inlineinherited

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.

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

virtual operator bool ( )

inlineoverridevirtual

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.

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]

void setOutput ( Print & out_stream )

inlineoverridevirtual

Defines the output stream.

Reimplemented from AudioDecoder.

setOutput() [2/3]

virtual void setOutput ( AudioOutput & out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

setOutput() [3/3]

virtual void setOutput ( AudioStream & out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

write()

virtual size_t write ( const uint8_t * data, size_t len )

inlineoverridevirtual

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

dec

aac_fdk::AACDecoderFDK* dec =nullptr

protected

id

int id

inherited

custom id to be used by application

info

AudioInfo info

protectedinherited

is_notify_active

bool is_notify_active = true

protectedinherited

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