GGWaveDecoder Class Reference

GGWaveDecoder: Translates audio into text Codec using https://github.com/ggerganov/ggwave-arduino. More...

#include <CodecGGWave.h>

Inheritance diagram for GGWaveDecoder:

Public Member Functions
	GGWaveDecoder (Print &out_stream)
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
AudioInfo	audioInfo ()
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
void	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.
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 ai)
	for most decoders this is not needed
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.
void	setPayloadLen (int len)
template<int N>
void	setProtocols (ggwave_ProtocolId protocolsArray[N])
	Activate multiple protocols.
void	setSampleByteSize (int size)
void	setSamplesFormatInput (ggwave_SampleFormat fmt)
void	setSamplesFromatOutput (ggwave_SampleFormat fmt)
void	setSamplesPerFrame (int samples)
size_t	write (const uint8_t *data, size_t len)

Public Attributes
int	id
	custom id to be used by application

Protected Member Functions
void	decode ()
void	notifyAudioChange (AudioInfo info)
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
bool	active = false
GGWave::TxRxData	data
GGWave	ggwave
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
Print *	p_print = nullptr
int	playload_len = 16
Vector< ggwave_ProtocolId >	protocols
Print *	pt_print =nullptr
SingleBuffer< uint8_t >	receive_buffer {0}
int	sample_byte_size = 2
ggwave_SampleFormat	samples_format_input = GGWAVE_SAMPLE_FORMAT_I16
ggwave_SampleFormat	samples_format_output = GGWAVE_SAMPLE_FORMAT_U8
int	samples_per_frame = 0

Detailed Description

GGWaveDecoder: Translates audio into text Codec using https://github.com/ggerganov/ggwave-arduino.

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

AudioInfo audioInfo ( )

inlinevirtual

provides the actual input AudioInfo

Reimplemented from AudioDecoder.

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]

void begin ( )

inlinevirtual

Reimplemented from AudioDecoder.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

end()

void end ( )

inlinevirtual

Reimplemented from AudioDecoder.

isResultPCM()

virtual bool isResultPCM ( )

inlinevirtual

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

Reimplemented from AudioDecoder.

operator bool()

operator bool ( )

inlinevirtual

Implements AudioWriter.

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlinevirtual

for most decoders this is not needed

Reimplemented from AudioDecoder.

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]

virtual void setOutput ( Print &  out_stream )

inlinevirtual

Defines where the decoded result is written to.

Reimplemented from AudioDecoder.

setProtocols()

template<int N>

void setProtocols ( ggwave_ProtocolId  protocolsArray[N] )

inline

Activate multiple protocols.

Parameters

protocol

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/Sandbox/CodecGGWave.h