GSMEncoder Class Reference

Encoder for GSM - Depends on https://github.com/pschatzmann/arduino-libgsm. Inspired by gsmenc.c. More...

#include <CodecGSM.h>

Inheritance diagram for GSMEncoder:

Public Member Functions
	GSMEncoder (bool scaling=true)
AudioInfo	audioInfo ()
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
bool	begin ()
virtual bool	begin (AudioInfo info)
virtual 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.
virtual void	setOutput (Print &out_stream)
virtual size_t	write (const uint8_t *data, size_t len)

Protected Member Functions
void	processByte (uint8_t byte)
void	scaleValues (Vector< uint8_t > &vector)
void	toBigEndian (Vector< uint8_t > &vector)
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
int	buffer_pos = 0
AudioInfo	info
Vector< uint8_t >	input_buffer
bool	is_active = false
Print *	p_print = nullptr
Vector< uint8_t >	result_buffer
bool	scaling_active
gsm	v_gsm

Detailed Description

Encoder for GSM - Depends on https://github.com/pschatzmann/arduino-libgsm. Inspired by gsmenc.c.

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]

bool begin ( )

inlinevirtual

Implements AudioWriter.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

Reimplemented in AACEncoderFDK.

end()

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

virtual void setOutput ( Print &  out_stream )

inlinevirtual

Implements AudioWriter.

write()

virtual 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/CodecGSM.h