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

#include <CodecADPCM.h>

Inheritance diagram for ADPCMDecoder:

Public Member Functions
	ADPCMDecoder ()=default

	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

Constructor & Destructor Documentation

◆ ADPCMDecoder() [1/2]

ADPCMDecoder ( )

default

◆ ADPCMDecoder() [2/2]

ADPCMDecoder	(	AVCodecID	id,
		int	blockSize = `ADAPCM_DEFAULT_BLOCK_SIZE`
	)

inline

◆ ~ADPCMDecoder()

~ADPCMDecoder ( )

inline

Destructor.

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

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

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

◆ 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 MP3EncoderShine, PureDataStream, PWMAudioOutput< PWMDriverT >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

◆ begin() [1/2]

bool begin ( )

inlineoverridevirtual

Implements AudioWriter.

◆ begin() [2/2]

virtual bool begin ( AudioInfo info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

Reimplemented in DecoderBasic, and OggContainerDecoder.

◆ blockSize()

int blockSize ( )

inline

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

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ decode()

virtual bool decode ( uint8_t byte )

inlineprotectedvirtual

◆ end()

void end ( )

inlineoverridevirtual

Implements AudioWriter.

◆ flush()

void flush ( )

inline

◆ frameSize()

int frameSize ( )

inline

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

◆ getOutput()

Print * getOutput ( )

inlineinherited

◆ isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ isResultPCM()

virtual bool isResultPCM ( )

inlinevirtualinherited

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

Reimplemented in CopyDecoder, DecoderNetworkFormat, and ContainerM4A.

◆ notifyAudioChange()

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool()

operator bool ( )

inlineoverridevirtual

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

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in DecoderALAC, CodecChain, DSFDecoder, DecoderL8, OpusAudioDecoder, OpusMultiStreamAudioDecoder, CodecNOP, G729Decoder, 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, and MultiDecoder.

◆ setId()

void setId ( AVCodecID id )

inline

◆ setImplementation()

void setImplementation ( )

inlineprotected

change the decoder implementation

◆ setNotifyActive()

void setNotifyActive ( bool flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active)

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

◆ writeBlocking()

void writeBlocking	(	Print *	out,
		uint8_t *	data,
		size_t	len
	)

inlineprotectedinherited

Member Data Documentation

◆ adpcm_block

Vector<uint8_t> adpcm_block

protected

◆ block_size

int block_size = ADAPCM_DEFAULT_BLOCK_SIZE

protected

◆ codec_id

AVCodecID codec_id = AV_CODEC_ID_ADPCM_MS

protected

◆ current_byte

int current_byte = 0

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

◆ is_started

bool is_started = false

protected

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ p_decoder

adpcm_ffmpeg::ADPCMDecoder* p_decoder = nullptr

protected

◆ p_print

Print* p_print = nullptr

protected

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

src/AudioTools/AudioCodecs/CodecADPCM.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ADPCMDecoder() [1/2]

◆ ADPCMDecoder() [2/2]

◆ ~ADPCMDecoder()

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ begin() [1/2]

◆ begin() [2/2]

◆ blockSize()

◆ clearNotifyAudioChange()

◆ decode()

◆ end()

◆ flush()

◆ frameSize()

◆ getOutput()

◆ isNotifyActive()

◆ isResultPCM()

◆ notifyAudioChange()

◆ operator bool()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setBlockSize()

◆ setCodecConfig()

◆ setId()

◆ setImplementation()

◆ setNotifyActive()

◆ setOutput() [1/3]

◆ setOutput() [2/3]

◆ setOutput() [3/3]

◆ write()

◆ writeBlocking()

Member Data Documentation

◆ adpcm_block

◆ block_size

◆ codec_id

◆ current_byte

◆ id

◆ info

◆ is_notify_active

◆ is_started

◆ notify_vector

◆ p_decoder

◆ p_print