ADPCMDecoder Class Reference

Decoder for ADPCM. Depends on https://github.com/pschatzmann/adpcm. More...

#include <CodecADPCM.h>

Inheritance diagram for ADPCMDecoder:

Public Member Functions
	ADPCMDecoder (AVCodecID id, int blockSize=ADAPCM_DEFAULT_BLOCK_SIZE)
	~ADPCMDecoder ()
	Destructor.
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
int	blockSize ()
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end () override
void	flush ()
int	frameSize ()
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.
	operator bool () override
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	setBlockSize (int blockSize) override
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	setId (AVCodecID id)
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) override

Public Attributes
int	id
	custom id to be used by application

Protected Member Functions
virtual bool	decode (uint8_t byte)
void	notifyAudioChange (AudioInfo info)
void	setImplementation ()
	change the decoder implementation
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
Vector< uint8_t >	adpcm_block
int	block_size = ADAPCM_DEFAULT_BLOCK_SIZE
AVCodecID	codec_id = AV_CODEC_ID_ADPCM_MS
int	current_byte = 0
AudioInfo	info
bool	is_notify_active = true
bool	is_started = false
Vector< AudioInfoSupport * >	notify_vector
adpcm_ffmpeg::ADPCMDecoder *	p_decoder = nullptr
Print *	p_print = nullptr

Detailed Description

Decoder for ADPCM. Depends on https://github.com/pschatzmann/adpcm.

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

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

inlineoverridevirtual

Implements AudioWriter.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

blockSize()

int blockSize ( )

inline

Provides the block size (= size of encoded frame) (only available after calling begin)

end()

void end ( )

inlineoverridevirtual

Implements AudioWriter.

frameSize()

int frameSize ( )

inline

Provides the frame size (size of decoded frame) (only available after calling begin)

isResultPCM()

virtual bool isResultPCM ( )

inlinevirtualinherited

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

Reimplemented in CopyDecoder, DecoderNetworkFormat, GGWaveDecoder, and ContainerM4A.

operator bool()

operator bool ( )

inlineoverridevirtual

Implements AudioWriter.

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in GGWaveDecoder, DecoderALAC, DecoderL8, OpusAudioDecoder, CodecNOP, and G7xxDecoder.

setBlockSize()

void setBlockSize ( int  blockSize )

inlineoverridevirtual

Implements AudioDecoderExt.

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.

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, ContainerM4A, and MetaDataFilterDecoder.

setOutput() [3/3]

virtual void setOutput ( Print &  out_stream )

inlineoverridevirtual

Defines where the decoded result is written to.

Reimplemented from AudioDecoder.

write()

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

inlineoverridevirtual

Implements AudioWriter.

---

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

• src/AudioTools/AudioCodecs/CodecADPCM.h