Decoder for LC3. Depends on https://github.com/pschatzmann/arduino-liblc3. More...

#include <CodecLC3.h>

Inheritance diagram for LC3Decoder:

Public Member Functions
	LC3Decoder (AudioInfo info, int dt_us=7500, uint16_t inputByteCount=40)

	LC3Decoder (int dt_us=7500, uint16_t inputByteCount=40)

virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.

AudioInfo	audioInfo () override
	provides the actual input AudioInfo

virtual AudioInfo	audioInfoOut ()

virtual bool	begin ()

virtual bool	begin (AudioInfo info) override

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

virtual void	end ()

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

void	notifyAudioChange (AudioInfo info)

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

Protected Attributes
bool	active = false

unsigned	dec_size

int	dt_us

AudioInfo	info

Vector< uint8_t >	input_buffer

uint16_t	input_byte_count = 20

size_t	input_pos = 0

bool	is_notify_active = true

lc3_decoder_t	lc3_decoder = nullptr

Vector< uint8_t >	lc3_decoder_memory

Vector< AudioInfoSupport * >	notify_vector

uint16_t	num_frames

Vector< uint16_t >	output_buffer

Print *	p_print = nullptr

lc3_pcm_format	pcm_format

Detailed Description

Decoder for LC3. Depends on https://github.com/pschatzmann/arduino-liblc3.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ LC3Decoder() [1/2]

LC3Decoder	(	AudioInfo	info,
		int	dt_us = `7500`,
		uint16_t	inputByteCount = `40`
	)

inline

◆ LC3Decoder() [2/2]

LC3Decoder	(	int	dt_us = `7500`,
		uint16_t	inputByteCount = `40`
	)

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]

virtual bool begin ( )

inlinevirtual

Reimplemented from AudioDecoder.

◆ begin() [2/2]

virtual bool begin ( AudioInfo info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

Reimplemented in DecoderBasic, and OggContainerDecoder.

◆ checkValues()

bool checkValues ( )

inlineprotected

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ end()

virtual void end ( )

inlinevirtual

Reimplemented from AudioDecoder.

◆ 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

Member Data Documentation

◆ active

bool active = false

protected

◆ dec_size

unsigned dec_size

protected

◆ dt_us

int dt_us

protected

◆ id

int id

inherited

custom id to be used by application

◆ info

AudioInfo info

protectedinherited

◆ input_buffer

Vector<uint8_t> input_buffer

protected

◆ input_byte_count

uint16_t input_byte_count = 20

protected

◆ input_pos

size_t input_pos = 0

protected

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ lc3_decoder

lc3_decoder_t lc3_decoder = nullptr

protected

◆ lc3_decoder_memory

Vector<uint8_t> lc3_decoder_memory

protected

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ num_frames

uint16_t num_frames

protected

◆ output_buffer

Vector<uint16_t> output_buffer

protected

◆ p_print

Print* p_print = nullptr

protected

◆ pcm_format

lc3_pcm_format pcm_format

protected

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

src/AudioTools/AudioCodecs/CodecLC3.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LC3Decoder() [1/2]

◆ LC3Decoder() [2/2]

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ begin() [1/2]

◆ begin() [2/2]

◆ checkValues()

◆ clearNotifyAudioChange()

◆ end()

◆ getOutput()

◆ isNotifyActive()

◆ isResultPCM()

◆ notifyAudioChange()

◆ operator bool()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setCodecConfig()

◆ setNotifyActive()

◆ setOutput() [1/3]

◆ setOutput() [2/3]

◆ setOutput() [3/3]

◆ write()

◆ writeBlocking()

Member Data Documentation

◆ active

◆ dec_size

◆ dt_us

◆ id

◆ info

◆ input_buffer

◆ input_byte_count

◆ input_pos

◆ is_notify_active

◆ lc3_decoder

◆ lc3_decoder_memory

◆ notify_vector

◆ num_frames

◆ output_buffer

◆ p_print

◆ pcm_format