APTXDecoder Class Reference

Decoder for OpenAptx. Depends on https://github.com/pschatzmann/libopenaptx. More...

#include <CodecAPTX.h>

Inheritance diagram for APTXDecoder:

Public Member Functions
	APTXDecoder (bool isHd=false)
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 ()
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
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)
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	checkPrefix (const void *input_buffer, size_t length)
	Checks the prefix of the received data.
void	checkSync (bool synced, bool dropped, bool &is_ok)
	Checks the syncronization.
void	notifyAudioChange (AudioInfo info)
void	writeBlocking (Print *out, uint8_t *data, size_t len)
void	writeData (size_t written, bool &is_ok)
	Converts the data to 16 bit and writes it to final output.

Protected Attributes
struct aptx_context *	ctx = nullptr
AudioInfo	info
bool	is_first_write = true
bool	is_hd
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
Vector< uint8_t >	output_buffer
Print *	p_print = nullptr
size_t	processed
bool	syncing
size_t	written

Detailed Description

Decoder for OpenAptx. Depends on https://github.com/pschatzmann/libopenaptx.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

APTXDecoder()

APTXDecoder ( bool  isHd = false )

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.

checkPrefix()

bool checkPrefix ( const void *  input_buffer, size_t  length  )

inlineprotected

Checks the prefix of the received data.

checkSync()

void checkSync ( bool  synced, bool  dropped, bool &  is_ok  )

inlineprotected

Checks the syncronization.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

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

inlinevirtual

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.

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.

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

writeData()

void writeData ( size_t  written, bool &  is_ok  )

inlineprotected

Converts the data to 16 bit and writes it to final output.

Member Data Documentation

ctx

struct aptx_context* ctx = nullptr

protected

id

int id

inherited

custom id to be used by application

info

AudioInfo info

protectedinherited

is_first_write

bool is_first_write = true

protected

is_hd

bool is_hd

protected

is_notify_active

bool is_notify_active = true

protectedinherited

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

output_buffer

Vector<uint8_t> output_buffer

protected

p_print

Print* p_print = nullptr

protected

processed

size_t processed

protected

syncing

bool syncing

protected

written

size_t written

protected

---

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

• src/AudioTools/AudioCodecs/CodecAPTX.h