FLACDecoderFoxen Class Reference

Foxen FLAC Decoder using https://github.com/astoeckel/libfoxenflac Unlike FLACDecoder which is a streaming decoder, this is a simple AudioDecoder implementation. More...

#include <CodecFLACFoxen.h>

Inheritance diagram for FLACDecoderFoxen:

Public Member Functions
	FLACDecoderFoxen ()=default
	FLACDecoderFoxen (int maxBlockSize, int maxChannels, bool convertTo16Bits=true, bool releaseOnEnd=false)
	Default Constructor.
	~FLACDecoderFoxen ()
	Destructor - calls end();.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual AudioInfo	audioInfoOut ()
virtual bool	begin (AudioInfo info) override
bool	begin ()
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end ()
void	flush ()
Print *	getOutput ()
Print *	getOutput ()
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual bool	isResultPCM ()
	Returns true to indicate that the decoding result is PCM data.
virtual bool	isResultPCM ()
	Returns true to indicate that the decoding result is PCM data.
const char *	mime () override
	Provides the mime type of the data that is expected by this decoder.
	operator bool () override
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
void	set32Bit (bool flag)
	Select between 16 and 32 bit output: the default is 16 bits.
void	setAudioInfo (AudioInfo from) override
	for most decoders this is not needed
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.
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	setInBufferSize (int size)
	Defines the input buffer size (default is 2k).
void	setMaxBlockSize (int size)
	Defines the maximum FLAC blocksize: drives the buffer allocation.
void	setMaxChannels (int ch)
	Defines the maximum number of channels: drives the buffer allocation.
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void	setOutBufferSize (int size)
virtual void	setOutput (AudioOutput &out_stream)
	Defines where the decoded result is written to.
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 (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 void	setOutput (Print &out_stream) override
	Defines where the decoded result is written to.
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
bool	decode ()
void	notifyAudioChange (AudioInfo info)
void	notifyAudioChange (AudioInfo info)
void	processMetadata ()
void	write16BitData (int out_len)
void	write32BitData (int out_len)
void	writeBlocking (Print *out, uint8_t *data, size_t len)
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
int	bits_eff = 0
fx_flac_t *	flac = nullptr
Vector< uint8_t >	foxen_data {0}
int	in_buffer_size = 1024 * 2
AudioInfo	info
bool	is_active = false
bool	is_convert_to_16 = true
bool	is_notify_active = true
bool	is_release_memory_on_end = false
bool	is_stop_on_error = true
int	max_block_size = 5 * 1024
int	max_channels = 2
Vector< AudioInfoSupport * >	notify_vector
Vector< int32_t >	out
int	out_buffer_size = 1024 * 4
Print *	p_print = nullptr
SingleBuffer< uint8_t >	write_buffer {0}

Detailed Description

Foxen FLAC Decoder using https://github.com/astoeckel/libfoxenflac Unlike FLACDecoder which is a streaming decoder, this is a simple AudioDecoder implementation.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

FLACDecoderFoxen() [1/2]

FLACDecoderFoxen ( )

default

FLACDecoderFoxen() [2/2]

FLACDecoderFoxen ( int maxBlockSize, int maxChannels, bool convertTo16Bits = true, bool releaseOnEnd = false )

inline

Default Constructor.

~FLACDecoderFoxen()

~FLACDecoderFoxen ( )

inline

Destructor - calls end();.

Member Function Documentation

addNotifyAudioChange() [1/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

addNotifyAudioChange() [2/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

audioInfo() [1/2]

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

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

audioInfo() [2/2]

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

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

audioInfoOut() [1/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

audioInfoOut() [2/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

begin() [1/2]

virtual bool begin ( AudioInfo info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

begin() [2/2]

bool begin ( )

inlinevirtual

Reimplemented from AudioDecoder.

clearNotifyAudioChange() [1/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

clearNotifyAudioChange() [2/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

decode()

bool decode ( )

inlineprotected

end()

void end ( )

inlinevirtual

Reimplemented from AudioDecoder.

flush()

void flush ( )

inline

getOutput() [1/2]

Print * getOutput ( )

inlineinherited

getOutput() [2/2]

Print * getOutput ( )

inlineinherited

isNotifyActive() [1/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

isNotifyActive() [2/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

isResultPCM() [1/2]

virtual bool isResultPCM ( )

inlinevirtualinherited

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

Reimplemented in ContainerM4A, CopyDecoder, and DecoderNetworkFormat.

isResultPCM() [2/2]

virtual bool isResultPCM ( )

inlinevirtualinherited

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

Reimplemented in ContainerM4A, CopyDecoder, and DecoderNetworkFormat.

mime()

const char * mime ( )

inlineoverridevirtual

Provides the mime type of the data that is expected by this decoder.

Implements AudioDecoder.

notifyAudioChange() [1/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

notifyAudioChange() [2/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

operator bool()

operator bool ( )

inlineoverridevirtual

Implements AudioWriter.

processMetadata()

void processMetadata ( )

inlineprotected

removeNotifyAudioChange() [1/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

removeNotifyAudioChange() [2/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

set32Bit()

void set32Bit ( bool flag )

inline

Select between 16 and 32 bit output: the default is 16 bits.

setAudioInfo() [1/2]

void setAudioInfo ( AudioInfo from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

setAudioInfo() [2/2]

void setAudioInfo ( AudioInfo from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

setCodecConfig() [1/2]

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.

setCodecConfig() [2/2]

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.

setInBufferSize()

void setInBufferSize ( int size )

inline

Defines the input buffer size (default is 2k).

setMaxBlockSize()

void setMaxBlockSize ( int size )

inline

Defines the maximum FLAC blocksize: drives the buffer allocation.

setMaxChannels()

void setMaxChannels ( int ch )

inline

Defines the maximum number of channels: drives the buffer allocation.

setNotifyActive() [1/2]

void setNotifyActive ( bool flag )

inlineinherited

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

setNotifyActive() [2/2]

void setNotifyActive ( bool flag )

inlineinherited

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

setOutBufferSize()

void setOutBufferSize ( int size )

inline

Defines the number of 32 bit samples for providing the result (default is 4k)

setOutput() [1/6]

virtual void setOutput ( AudioOutput & out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

setOutput() [2/6]

virtual void setOutput ( AudioOutput & out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

setOutput() [3/6]

virtual void setOutput ( AudioStream & out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

setOutput() [4/6]

virtual void setOutput ( AudioStream & out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

setOutput() [5/6]

virtual void setOutput ( Print & out_stream )

inlineoverridevirtualinherited

Defines where the decoded result is written to.

Implements AudioWriter.

Reimplemented in AACDecoderFDK, AACDecoderHelix, ADPCMDecoder, ADPCMDecoderXQ, ADTSDecoder, APTXDecoder, CodecNOP, CodecNOP, BinaryContainerDecoder, Codec2Decoder, CodecChain, CodecNOP, ContainerM4A, CopyDecoder, DecoderAdapter, DecoderBase64, DecoderBasic, DecoderFloat, DecoderL16, DecoderNetworkFormat, DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, G722Decoder, G729Decoder, G7xxDecoder, GSMDecoder, ILBCDecoder, LC3Decoder, MetaDataFilterDecoder, MP2Decoder, MP3DecoderHelix, MP3DecoderMAD, MP3DecoderMini, MTSDecoder, MTSDecoderTSDemux, MultiDecoder, MultiVideoDemuxer, OggContainerDecoder, OpusAudioDecoder, OpusMultiStreamAudioDecoder, OSCContainerDecoder, SBCDecoder, WAVDecoder, and WavIMADecoder.

setOutput() [6/6]

virtual void setOutput ( Print & out_stream )

inlineoverridevirtualinherited

Defines where the decoded result is written to.

Implements AudioWriter.

Reimplemented in AACDecoderFDK, AACDecoderHelix, ADPCMDecoder, ADPCMDecoderXQ, ADTSDecoder, APTXDecoder, CodecNOP, CodecNOP, BinaryContainerDecoder, Codec2Decoder, CodecChain, CodecNOP, ContainerM4A, CopyDecoder, DecoderAdapter, DecoderBase64, DecoderBasic, DecoderFloat, DecoderL16, DecoderNetworkFormat, DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, G722Decoder, G729Decoder, G7xxDecoder, GSMDecoder, ILBCDecoder, LC3Decoder, MetaDataFilterDecoder, MP2Decoder, MP3DecoderHelix, MP3DecoderMAD, MP3DecoderMini, MTSDecoder, MTSDecoderTSDemux, MultiDecoder, MultiVideoDemuxer, OggContainerDecoder, OpusAudioDecoder, OpusMultiStreamAudioDecoder, OSCContainerDecoder, SBCDecoder, WAVDecoder, and WavIMADecoder.

write()

size_t write ( const uint8_t * data, size_t len )

inlineoverridevirtual

Implements AudioWriter.

write16BitData()

void write16BitData ( int out_len )

inlineprotected

write32BitData()

void write32BitData ( int out_len )

inlineprotected

writeBlocking() [1/2]

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

inlineprotectedinherited

writeBlocking() [2/2]

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

inlineprotectedinherited

Member Data Documentation

bits_eff

int bits_eff = 0

protected

flac

fx_flac_t* flac = nullptr

protected

foxen_data

Vector<uint8_t> foxen_data {0}

protected

id

int id

inherited

custom id to be used by application

in_buffer_size

int in_buffer_size = 1024 * 2

protected

info

AudioInfo info

protectedinherited

is_active

bool is_active = false

protected

is_convert_to_16

bool is_convert_to_16 = true

protected

is_notify_active

bool is_notify_active = true

protectedinherited

is_release_memory_on_end

bool is_release_memory_on_end = false

protected

is_stop_on_error

bool is_stop_on_error = true

protected

max_block_size

int max_block_size = 5 * 1024

protected

max_channels

int max_channels = 2

protected

notify_vector

Vector< AudioInfoSupport * > notify_vector

protectedinherited

out

Vector<int32_t> out

protected

out_buffer_size

int out_buffer_size = 1024 * 4

protected

p_print

Print * p_print = nullptr

protectedinherited

write_buffer

SingleBuffer<uint8_t> write_buffer {0}

protected

---

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

• src/AudioTools/AudioCodecs/CodecFLACFoxen.h