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 () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
bool	begin ()
virtual bool	begin (AudioInfo info)
virtual void	end ()
virtual uint32_t	frameDurationUs ()
	Optional rtsp function: provide the frame duration in microseconds.
virtual const char *	mime ()
	Provides the mime type of the encoded result.
	operator bool ()
virtual uint16_t	samplesPerFrame ()
	Optional rtsp function: provide samples per the frame.
void	setAudioInfo (AudioInfo from) override
	Defines the sample rate, number of channels and bits per sample.
virtual void	setOutput (Print &out_stream)
	Default output assignment (encoders may override to store Print reference)
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

Constructor & Destructor Documentation

GSMEncoder()

GSMEncoder ( bool  scaling = true )

inline

Member Function Documentation

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, MP3EncoderShine, BinaryContainerEncoder, and MP3ParserEncoder.

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 MP3EncoderShine, PureDataStream, PWMAudioOutput< PWMDriverT >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

begin() [1/2]

bool begin ( )

inlinevirtual

Implements AudioWriter.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

Reimplemented in OpusOggEncoder, OggContainerEncoder, DecoderBasic, AudioDecoder, AACEncoderFDK, AACEncoderVO, OggContainerDecoder, and MetaDataFilterEncoder.

end()

virtual void end ( )

inlinevirtual

Implements AudioWriter.

frameDurationUs()

virtual uint32_t frameDurationUs ( )

inlinevirtualinherited

Optional rtsp function: provide the frame duration in microseconds.

Reimplemented in ADPCMEncoder, MP3EncoderShine, OpusOggEncoder, MP3ParserEncoder, and MetaDataFilterEncoder.

mime()

virtual const char * mime ( )

inlinevirtual

Provides the mime type of the encoded result.

Implements AudioEncoder.

operator bool()

operator bool ( )

inlinevirtual

Implements AudioWriter.

processByte()

void processByte ( uint8_t  byte )

inlineprotected

samplesPerFrame()

virtual uint16_t samplesPerFrame ( )

inlinevirtualinherited

Optional rtsp function: provide samples per the frame.

Reimplemented in OpusAudioEncoder, OpusMultiStreamAudioEncoder, MP3EncoderShine, MP3ParserEncoder, and MetaDataFilterEncoder.

scaleValues()

void scaleValues ( Vector< uint8_t > &  vector )

inlineprotected

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtualinherited

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

Implements AudioWriter.

Reimplemented in MP3EncoderLAME, EncoderBasic, CodecChain, DSFEncoder, FLACEncoder, MP3EncoderShine, OpusAudioEncoder, OpusMultiStreamAudioEncoder, WAVEncoder, CodecNOP, G7xxEncoder, G729Encoder, BinaryContainerEncoder, OggContainerEncoder, OSCContainerEncoder, and MetaDataFilterEncoder.

setOutput()

virtual void setOutput ( Print &  out_stream )

inlinevirtual

Default output assignment (encoders may override to store Print reference)

Reimplemented from AudioEncoder.

toBigEndian()

void toBigEndian ( Vector< uint8_t > &  vector )

inlineprotected

write()

virtual size_t write ( const uint8_t *  data, size_t  len  )

inlinevirtual

Implements AudioWriter.

writeBlocking()

void writeBlocking ( Print *  out, uint8_t *  data, size_t  len  )

inlineprotectedinherited

Member Data Documentation

buffer_pos

int buffer_pos = 0

protected

info

AudioInfo info

protectedinherited

input_buffer

Vector<uint8_t> input_buffer

protected

is_active

bool is_active = false

protected

p_print

Print* p_print = nullptr

protected

result_buffer

Vector<uint8_t> result_buffer

protected

scaling_active

bool scaling_active

protected

v_gsm

gsm v_gsm

protected

---

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

• src/AudioTools/AudioCodecs/CodecGSM.h