BinaryContainerDecoder Class Reference

Decodes the provided data from the DAT and CFG segments. More...

#include <ContainerBinary.h>

Inheritance diagram for BinaryContainerDecoder:

Public Member Functions
	BinaryContainerDecoder (AudioDecoder &decoder)
	BinaryContainerDecoder (AudioDecoder *decoder)
void	addErrorHandler (void(*error_handler)(BinaryContainerEncoderError error, BinaryContainerDecoder *source, void *ref))
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 ()
virtual bool	begin (AudioInfo info) override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end ()
Print *	getOutput ()
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
	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
void	setDecoder (AudioDecoder *decoder)
void	setIgnoreWriteErrors (bool flag)
	If set to true we do not expect a retry to write the missing data but continue just with the next. (Default is true);.
void	setMetaCallback (void(*callback)(uint8_t *, int, void *))
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.
void	setOutput (Print &outStream)
	Defines where the decoded result is written to.
void	setReference (void *ref)
	Provide additional information for callback.
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	isValidHeader ()
void	nextRecord ()
void	notifyAudioChange (AudioInfo info)
size_t	output (uint8_t *data, size_t len)
bool	parseBuffer ()
uint8_t	peekBufferValue ()
bool	processData ()
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
SingleBuffer< uint8_t >	buffer {0}
void(*	error_handler )(BinaryContainerEncoderError error, BinaryContainerDecoder *source, void *ref) = nullptr
CommonHeader	header
const size_t	header_size = sizeof(header)
bool	ignore_write_errors = true
AudioInfo	info
bool	is_first = true
bool	is_notify_active = true
void(*	meta_callback )(uint8_t *data, int len, void *ref) = nullptr
Vector< AudioInfoSupport * >	notify_vector
AudioDecoder *	p_codec = nullptr
Print *	p_out = nullptr
Print *	p_print = nullptr
void *	reference = nullptr

Detailed Description

Decodes the provided data from the DAT and CFG segments.

Author

Phil Schatzmann

Copyright

GPLv3

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, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, GGWaveDecoder, DecoderBasic, MP3DecoderHelix, MP3DecoderMAD, OpusAudioDecoder, WAVDecoder, WavIMADecoder, and OggContainerDecoder.

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

begin() [1/2]

bool begin ( )

inlinevirtual

Reimplemented from AudioDecoder.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

end()

void end ( )

inlinevirtual

Reimplemented from AudioDecoder.

operator bool()

operator bool ( )

inlinevirtual

Implements AudioWriter.

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in GGWaveDecoder, DecoderL8, OpusAudioDecoder, CodecNOP, and G7xxDecoder.

setOutput() [1/3]

virtual void setOutput ( AudioOutput &  out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in ADTSDecoder, 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, MTSDecoder, MTSDecoderTSDemux, and MetaDataFilterDecoder.

setOutput() [3/3]

void setOutput ( Print &  out_stream )

inlinevirtual

Defines where the decoded result is written to.

Reimplemented from AudioDecoder.

write()

size_t write ( const uint8_t *  data, size_t  len  )

inlinevirtual

Implements AudioWriter.

---

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

• src/AudioTools/AudioCodecs/ContainerBinary.h