arduino-audio-tools
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
GGWaveDecoder Class Reference

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

#include <CodecGGWave.h>

Inheritance diagram for GGWaveDecoder:
AudioDecoder AudioWriter AudioInfoSource AudioInfoSupport

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 ()
 provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
 
void begin ()
 
virtual bool begin (AudioInfo info) override
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
void end ()
 
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. More...
 
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
 
Printp_print = nullptr
 
int playload_len = 16
 
Vector< ggwave_ProtocolId > protocols
 
Printpt_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

Member Function Documentation

◆ setProtocols()

void setProtocols ( ggwave_ProtocolId  protocolsArray[N])
inline

Activate multiple protocols.

Parameters
protocol

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