Decoder for ADPCM-XQ. Depends on https://github.com/pschatzmann/arduino-adpcm-xq. More...

#include <CodecADPCMXQ.h>

Inheritance diagram for ADPCMDecoderXQ:

Public Member Functions
	ADPCMDecoderXQ ()

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.

	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	setBlockSizePower (int pow)
	set bocksizes as 2^pow: range from 8 to 15

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	setLookahead (int value)
	Set look ahead bytes from 0 to 8.

void	setNoiseShaping (ADPCMNoiseShaping ns)
	Defines the noise shaping.

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)
	Defines where the decoded result is written to.

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

Public Attributes
int	id
	custom id to be used by application

Protected Member Functions
bool	decode (int this_block_adpcm_samples)

void	notifyAudioChange (AudioInfo info)

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

Protected Attributes
Vector< uint8_t >	adpcm_block

void *	adpcm_cnxt = nullptr

int	block_size = 0

int	block_size_pow2 = 0

int	current_byte = 0

AudioInfo	info

int32_t	initial_deltas [2] = {0}

bool	is_notify_active = true

int	lookahead = 0

int	noise_shaping = (int) NOISE_SHAPING_OFF

Vector< AudioInfoSupport * >	notify_vector

Print *	p_print = nullptr

Vector< int16_t >	pcm_block

int	samples_per_block = 0

Detailed Description

Decoder for ADPCM-XQ. Depends on https://github.com/pschatzmann/arduino-adpcm-xq.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ ADPCMDecoderXQ()

ADPCMDecoderXQ ( )

inline

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.

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ decode()

bool decode ( int this_block_adpcm_samples )

inlineprotected

◆ end()

void end ( )

inlineoverridevirtual

Implements AudioWriter.

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

◆ setBlockSizePower()

void setBlockSizePower ( int pow )

inline

set bocksizes as 2^pow: range from 8 to 15

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

◆ setLookahead()

void setLookahead ( int value )

inline

Set look ahead bytes from 0 to 8.

◆ setNoiseShaping()

void setNoiseShaping ( ADPCMNoiseShaping ns )

inline

Defines the noise shaping.

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

inlinevirtual

Defines where the decoded result is written to.

Reimplemented from AudioDecoder.

◆ write()

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

inlinevirtual

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

◆ adpcm_cnxt

void* adpcm_cnxt = nullptr

protected

◆ block_size

int block_size = 0

protected

◆ block_size_pow2

int block_size_pow2 = 0

protected

◆ current_byte

int current_byte = 0

protected

◆ id

int id

inherited

custom id to be used by application

◆ info

AudioInfo info

protectedinherited

◆ initial_deltas

int32_t initial_deltas[2] = {0}

protected

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ lookahead

int lookahead = 0

protected

◆ noise_shaping

int noise_shaping = (int) NOISE_SHAPING_OFF

protected

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ p_print

Print* p_print = nullptr

protected

◆ pcm_block

Vector<int16_t> pcm_block

protected

◆ samples_per_block

int samples_per_block = 0

protected

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

src/AudioTools/AudioCodecs/CodecADPCMXQ.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ADPCMDecoderXQ()

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clearNotifyAudioChange()

◆ decode()

◆ end()

◆ getOutput()

◆ isNotifyActive()

◆ isResultPCM()

◆ notifyAudioChange()

◆ operator bool()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setBlockSizePower()

◆ setCodecConfig()

◆ setLookahead()

◆ setNoiseShaping()

◆ setNotifyActive()

◆ setOutput() [1/3]

◆ setOutput() [2/3]

◆ setOutput() [3/3]

◆ write()

◆ writeBlocking()

Member Data Documentation

◆ adpcm_block

◆ adpcm_cnxt

◆ block_size

◆ block_size_pow2

◆ current_byte

◆ id

◆ info

◆ initial_deltas

◆ is_notify_active

◆ lookahead

◆ noise_shaping

◆ notify_vector

◆ p_print

◆ pcm_block

◆ samples_per_block