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

#include <CodecOpusOgg.h>

Inheritance diagram for AudioDecoder:

Public Member Functions
	AudioDecoder ()=default
	AudioDecoder ()=default
	AudioDecoder (AudioDecoder const &)=delete
	AudioDecoder (AudioDecoder const &)=delete
virtual	~AudioDecoder ()=default
virtual	~AudioDecoder ()=default
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual AudioInfo	audioInfoOut ()
bool	begin () override
bool	begin () override
virtual bool	begin (AudioInfo info) override
virtual bool	begin (AudioInfo info) override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end () override
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.
virtual const char *	mime ()=0
	Provides the mime type of the data that is expected by this decoder.
virtual const char *	mime ()=0
	Provides the mime type of the data that is expected by this decoder.
virtual	operator bool ()=0
virtual	operator bool ()=0
AudioDecoder &	operator= (AudioDecoder const &)=delete
AudioDecoder &	operator= (AudioDecoder const &)=delete
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).
virtual void	setOutput (AudioOutput &out_stream)
	Defines where the decoded result is written to.
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 (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 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
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	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
Vector< AudioInfoSupport * >	notify_vector
Print *	p_print = nullptr

Detailed Description

Decoding of encoded audio into PCM data.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ AudioDecoder() [1/4]

AudioDecoder ( )

default

◆ ~AudioDecoder() [1/2]

virtual ~AudioDecoder ( )

virtualdefault

◆ AudioDecoder() [2/4]

AudioDecoder ( AudioDecoder const & )

delete

◆ AudioDecoder() [3/4]

AudioDecoder ( )

default

◆ ~AudioDecoder() [2/2]

virtual ~AudioDecoder ( )

virtualdefault

◆ AudioDecoder() [4/4]

AudioDecoder ( AudioDecoder const & )

delete

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]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ audioInfo() [1/2]

AudioInfo audioInfo ( )

inlineoverridevirtual

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, CodecNOP, CodecNOP, DecoderBasic, DSFDecoder, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, OpusAudioDecoder, OpusMultiStreamAudioDecoder, VorbisDecoder, VorbisDecoder, WAVDecoder, and WavIMADecoder.

◆ audioInfo() [2/2]

AudioInfo audioInfo ( )

inlineoverridevirtual

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, CodecNOP, CodecNOP, DecoderBasic, DSFDecoder, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, OpusAudioDecoder, OpusMultiStreamAudioDecoder, VorbisDecoder, VorbisDecoder, WAVDecoder, and WavIMADecoder.

◆ 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/4]

bool begin ( )

inlineoverridevirtual

◆ begin() [2/4]

bool begin ( )

inlineoverridevirtual

◆ begin() [3/4]

virtual bool begin ( AudioInfo info )

inlineoverridevirtual

Reimplemented from AudioWriter.

◆ begin() [4/4]

virtual bool begin ( AudioInfo info )

inlineoverridevirtual

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

◆ end() [1/2]

void end ( )

inlineoverridevirtual

◆ end() [2/2]

void end ( )

inlineoverridevirtual

◆ getOutput() [1/2]

Print * getOutput ( )

inline

◆ getOutput() [2/2]

Print * getOutput ( )

inline

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

inlinevirtual

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

Reimplemented in ContainerM4A, CopyDecoder, and DecoderNetworkFormat.

◆ isResultPCM() [2/2]

virtual bool isResultPCM ( )

inlinevirtual

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

Reimplemented in ContainerM4A, CopyDecoder, and DecoderNetworkFormat.

◆ mime() [1/2]

virtual const char * mime ( )

pure virtual

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

Implemented in AACDecoderFAAD2, AACDecoderFAAD, AACDecoderFDK, AACDecoderHelix, AC3AudioDecoder, ADPCMDecoder, ADPCMDecoderXQ, ADTSDecoder, AMRNBDecoder, AMRWBDecoder, APTXDecoder, CodecNOP, CodecNOP, BinaryContainerDecoder, Codec2Decoder, CodecChain, CodecNOP, ContainerM4A, CopyDecoder, DecoderAdapter, DecoderALAC, DecoderBase64, DecoderBasic, DecoderFloat, DecoderL16, DecoderL8, DecoderNetworkFormat, Demuxer, DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, DSFDecoder, FLACDecoderFoxen, G722Decoder, G729Decoder, G7xxDecoder, GSMDecoder, ILBCDecoder, LC3Decoder, MetaDataFilterDecoder, MP2Decoder, MP3DecoderHelix, MP3DecoderMAD, MP3DecoderMini, MTSDecoder, MTSDecoderTSDemux, MultiDecoder, MultiVideoDemuxer, OggContainerDecoder, OpusAudioDecoder, OpusMultiStreamAudioDecoder, OSCContainerDecoder, SBCDecoder, VorbisDecoder, VorbisDecoder, WAVDecoder, and WavIMADecoder.

◆ mime() [2/2]

virtual const char * mime ( )

pure virtual

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

Implemented in AACDecoderFAAD2, AACDecoderFAAD, AACDecoderFDK, AACDecoderHelix, AC3AudioDecoder, ADPCMDecoder, ADPCMDecoderXQ, ADTSDecoder, AMRNBDecoder, AMRWBDecoder, APTXDecoder, CodecNOP, CodecNOP, BinaryContainerDecoder, Codec2Decoder, CodecChain, CodecNOP, ContainerM4A, CopyDecoder, DecoderAdapter, DecoderALAC, DecoderBase64, DecoderBasic, DecoderFloat, DecoderL16, DecoderL8, DecoderNetworkFormat, Demuxer, DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, DSFDecoder, FLACDecoderFoxen, G722Decoder, G729Decoder, G7xxDecoder, GSMDecoder, ILBCDecoder, LC3Decoder, MetaDataFilterDecoder, MP2Decoder, MP3DecoderHelix, MP3DecoderMAD, MP3DecoderMini, MTSDecoder, MTSDecoderTSDemux, MultiDecoder, MultiVideoDemuxer, OggContainerDecoder, OpusAudioDecoder, OpusMultiStreamAudioDecoder, OSCContainerDecoder, SBCDecoder, VorbisDecoder, VorbisDecoder, WAVDecoder, and WavIMADecoder.

◆ notifyAudioChange() [1/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ notifyAudioChange() [2/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool() [1/2]

virtual operator bool ( )

pure virtualinherited

Implemented in AACDecoderFAAD2, AACDecoderFAAD, AACDecoderFDK, AACDecoderHelix, AACEncoderFAAC, AACEncoderFDK, AACEncoderVO, AC3AudioDecoder, ADPCMDecoder, ADPCMDecoderXQ, ADPCMEncoder, ADPCMEncoderXQ, ADTSDecoder, AMRNBDecoder, AMRWBDecoder, APTXDecoder, APTXEncoder, CodecNOP, CodecNOP, BinaryContainerDecoder, BinaryContainerEncoder, Codec2Decoder, Codec2Encoder, CodecChain, CodecNOP, ContainerM4A, CopyDecoder, CopyEncoder, DecoderAdapter, DecoderALAC, DecoderBase64, DecoderBasic, DecoderFloat, DecoderL16, DecoderL8, DecoderNetworkFormat, DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, DSFDecoder, DSFEncoder, EncoderALAC, EncoderBase64, EncoderBasic, EncoderFloat, EncoderL16, EncoderL8, EncoderNetworkFormat, FLACDecoderFoxen, FLACEncoder, G722Decoder, G722Encoder, G729Decoder, G729Encoder, G7xxDecoder, G7xxEncoder, GSMDecoder, GSMEncoder, H264RtpEncoder, ILBCDecoder, ILBCEncoder, JPEGRtpEncoder, LC3Decoder, LC3Encoder, MetaDataFilterDecoder, MetaDataFilterEncoder, MP2Decoder, MP3DecoderHelix, MP3DecoderMAD, MP3DecoderMini, MP3EncoderLAME, MP3EncoderShine, MP3ParserEncoder, MTSDecoder, MTSDecoderTSDemux, MultiDecoder, MultiVideoDemuxer, OggContainerDecoder, OggContainerEncoder, OpusAudioDecoder, OpusAudioEncoder, OpusMultiStreamAudioDecoder, OpusMultiStreamAudioEncoder, OSCContainerDecoder, OSCContainerEncoder, SBCDecoder, SBCEncoder, VorbisDecoder, VorbisDecoder, WAVDecoder, WAVEncoder, and WavIMADecoder.

◆ operator bool() [2/2]

virtual operator bool ( )

pure virtualinherited

Implemented in AACDecoderFAAD2, AACDecoderFAAD, AACDecoderFDK, AACDecoderHelix, AACEncoderFAAC, AACEncoderFDK, AACEncoderVO, AC3AudioDecoder, ADPCMDecoder, ADPCMDecoderXQ, ADPCMEncoder, ADPCMEncoderXQ, ADTSDecoder, AMRNBDecoder, AMRWBDecoder, APTXDecoder, APTXEncoder, CodecNOP, CodecNOP, BinaryContainerDecoder, BinaryContainerEncoder, Codec2Decoder, Codec2Encoder, CodecChain, CodecNOP, ContainerM4A, CopyDecoder, CopyEncoder, DecoderAdapter, DecoderALAC, DecoderBase64, DecoderBasic, DecoderFloat, DecoderL16, DecoderL8, DecoderNetworkFormat, DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, DSFDecoder, DSFEncoder, EncoderALAC, EncoderBase64, EncoderBasic, EncoderFloat, EncoderL16, EncoderL8, EncoderNetworkFormat, FLACDecoderFoxen, FLACEncoder, G722Decoder, G722Encoder, G729Decoder, G729Encoder, G7xxDecoder, G7xxEncoder, GSMDecoder, GSMEncoder, H264RtpEncoder, ILBCDecoder, ILBCEncoder, JPEGRtpEncoder, LC3Decoder, LC3Encoder, MetaDataFilterDecoder, MetaDataFilterEncoder, MP2Decoder, MP3DecoderHelix, MP3DecoderMAD, MP3DecoderMini, MP3EncoderLAME, MP3EncoderShine, MP3ParserEncoder, MTSDecoder, MTSDecoderTSDemux, MultiDecoder, MultiVideoDemuxer, OggContainerDecoder, OggContainerEncoder, OpusAudioDecoder, OpusAudioEncoder, OpusMultiStreamAudioDecoder, OpusMultiStreamAudioEncoder, OSCContainerDecoder, OSCContainerEncoder, SBCDecoder, SBCEncoder, VorbisDecoder, VorbisDecoder, WAVDecoder, WAVEncoder, and WavIMADecoder.

◆ operator=() [1/2]

AudioDecoder & operator= ( AudioDecoder const & )

delete

◆ operator=() [2/2]

AudioDecoder & operator= ( AudioDecoder const & )

delete

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

inlineoverridevirtual

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

◆ setAudioInfo() [2/2]

void setAudioInfo ( AudioInfo from )

inlineoverridevirtual

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 )

inlinevirtual

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 )

inlinevirtual

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