Codec2Decoder Class Reference

Decoder for Codec2. Depends on https://github.com/pschatzmann/arduino-libcodec2. More...

#include <CodecCodec2.h>

Inheritance diagram for Codec2Decoder:

Public Member Functions
	Codec2Decoder (int bps=3200)
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
virtual AudioInfo	audioInfo ()
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
	provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
virtual bool	begin ()
virtual bool	begin (AudioInfo info) override
int	bitsPerSecond ()
int	bytesCompressed ()
int	bytesUncompressed ()
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.
virtual void	setAudioInfo (AudioInfo from) override
	for most decoders this is not needed
virtual void	setBitsPerSecond (int bps)
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.
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
void	notifyAudioChange (AudioInfo info)
void	processByte (uint8_t byte)
	Build decoding buffer and decode when frame is full.
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
int	bits_per_second = 0
AudioInfo	info
Vector< uint8_t >	input_buffer
int	input_pos = 0
bool	is_active = false
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
struct CODEC2 *	p_codec2
Print *	p_print = nullptr
Vector< uint8_t >	result_buffer

Detailed Description

Decoder for Codec2. Depends on https://github.com/pschatzmann/arduino-libcodec2.

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

audioInfo()

virtual AudioInfo audioInfo ( )

inlinevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, GGWaveDecoder, AACDecoderFDK, AACDecoderHelix, 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]

virtual bool begin ( )

inlinevirtual

Reimplemented from AudioDecoder.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

end()

virtual void end ( )

inlinevirtual

Reimplemented from AudioDecoder.

isResultPCM()

virtual bool isResultPCM ( )

inlinevirtualinherited

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

Reimplemented in CopyDecoder, and GGWaveDecoder.

operator bool()

operator bool ( )

inlinevirtual

Implements AudioWriter.

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

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

setBitsPerSecond()

virtual void setBitsPerSecond ( int  bps )

inlinevirtual

sets bits per second: 3200, 2400, 1600, 1400, 1300, 1200, 700 and 450 bit/s

setOutput() [1/3]

virtual void setOutput ( AudioOutput &  out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in MetaDataFilterDecoder.

setOutput() [2/3]

virtual void setOutput ( AudioStream &  out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in MetaDataFilterDecoder.

setOutput() [3/3]

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

inlineoverridevirtual

Implements AudioWriter.

---

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

• src/AudioTools/AudioCodecs/CodecCodec2.h