GGWaveEncoder Class Reference

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

#include <CodecGGWave.h>

Inheritance diagram for GGWaveEncoder:

Public Member Functions
	GGWaveEncoder (Print &out_stream)
AudioInfo	audioInfo ()
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
void	begin ()
virtual bool	begin (AudioInfo info)
void	end ()
virtual const char *	mime ()
	Provides the mime type of the encoded result.
	operator bool ()
void	setAudioInfo (AudioInfo from) override
	Defines the sample rate, number of channels and bits per sample.
void	setOutput (Print &out_stream)
void	setPayloadLen (int len)
void	setProtocol (ggwave_ProtocolId protocol)
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)

Protected Member Functions
virtual void	play (int freq, int ms)
virtual void	silence (int samples)
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
bool	active = false
GGWave	ggwave
AudioInfo	info
int	playload_len = 16
ggwave_ProtocolId	protocolId = GGWAVE_PROTOCOL_AUDIBLE_FAST
Print *	pt_print =nullptr
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 = 256
FastSineGenerator< int16_t >	sine_wave
int	volume = GGWave::kDefaultVolume

Detailed Description

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

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

audioInfo()

AudioInfo audioInfo ( )

inlinevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, and BinaryContainerEncoder.

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

Implements AudioWriter.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

Reimplemented in AACEncoderFDK.

end()

void end ( )

inlinevirtual

Implements AudioWriter.

mime()

virtual const char * mime ( )

inlinevirtual

Provides the mime type of the encoded result.

Implements AudioEncoder.

operator bool()

operator bool ( )

inlinevirtual

Implements AudioWriter.

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtualinherited

Defines the sample rate, number of channels and bits per sample.

Implements AudioWriter.

Reimplemented in MP3EncoderLAME, EncoderBasic, FLACEncoder, OpusAudioEncoder, WAVEncoder, CodecNOP, G7xxEncoder, BinaryContainerEncoder, and OggContainerEncoder.

setOutput()

void setOutput ( Print &  out_stream )

inlinevirtual

Implements AudioWriter.

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