AudioDecoder Class Reference

Decoding of encoded audio into PCM data. More...

#include <AudioCodecsBase.h>

Inheritance diagram for AudioDecoder:

Public Member Functions
	AudioDecoder (AudioDecoder const &)=delete
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
virtual bool	begin (AudioInfo info) override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end () override
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 ()=0
AudioDecoder &	operator= (AudioDecoder const &)=delete
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	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.
virtual size_t	write (const uint8_t *data, size_t len)=0

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

Detailed Description

Decoding of encoded audio into PCM data.

Author

Phil Schatzmann

Copyright

GPLv3

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, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtual

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

inlineoverridevirtual

Implements AudioWriter.

Reimplemented in MP3DecoderMini, MP3DecoderHelix, MP3DecoderMAD, MTSDecoder, ContainerMP4, and MultiDecoder.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlineoverridevirtual

Reimplemented from AudioWriter.

end()

void end ( )

inlineoverridevirtual

Implements AudioWriter.

Reimplemented in MP3DecoderMini, MP3DecoderHelix, MP3DecoderMAD, MTSDecoder, ContainerMP4, and MultiDecoder.

isResultPCM()

virtual bool isResultPCM ( )

inlinevirtual

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

Reimplemented in CopyDecoder, DecoderNetworkFormat, and GGWaveDecoder.

operator bool()

virtual operator bool ( )

pure virtualinherited

Implemented in AACDecoderFAAD, MP3DecoderMini, AACDecoderHelix, ADTSDecoder, MP3DecoderHelix, and MP3DecoderMAD.

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtual

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 )

inlinevirtual

Defines where the decoded result is written to.

Reimplemented in ADTSDecoder, MTSDecoder, MTSDecoderTSDemux, and MetaDataFilterDecoder.

setOutput() [2/3]

virtual void setOutput ( AudioStream &  out_stream )

inlinevirtual

Defines where the decoded result is written to.

Reimplemented in ADTSDecoder, MTSDecoder, MTSDecoderTSDemux, and MetaDataFilterDecoder.

setOutput() [3/3]

virtual void setOutput ( Print &  out_stream )

inlineoverridevirtual

Defines where the decoded result is written to.

Implements AudioWriter.

Reimplemented in DecoderBase64, MP3DecoderMAD, DecoderAdapter, CodecNOP, ADPCMDecoderXQ, APTXDecoder, Codec2Decoder, CopyDecoder, G722Decoder, GSMDecoder, ILBCDecoder, LC3Decoder, DecoderNetworkFormat, SBCDecoder, WavIMADecoder, GGWaveDecoder, AACDecoderFDK, AACDecoderHelix, ADPCMDecoder, ADTSDecoder, DecoderBasic, DecoderFloat, G7xxDecoder, DecoderL16, MTSDecoder, OpusAudioDecoder, MTSDecoderTSDemux, WAVDecoder, AVIDecoder, MultiDecoder, MetaDataFilterDecoder, MP3DecoderMini, BinaryContainerDecoder, OSCContainerDecoder, MP3DecoderHelix, and OggContainerDecoder.

write()

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

pure virtualinherited

Implemented in AACDecoderFAAD, MP3DecoderMini, BinaryContainerEncoder, OSCContainerEncoder, AACDecoderHelix, ADTSDecoder, EncoderBase64, FLACEncoder, DecoderFloat, EncoderFloat, EncoderL16, EncoderL8, MP3DecoderHelix, MP3DecoderMAD, OpusAudioEncoder, WAVEncoder, ContainerMP4, OggContainerEncoder, and EncoderBasic.

---

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

• src/AudioTools/AudioCodecs/AudioCodecsBase.h