HammingFEC< bytecount, block_t > Class Template Reference

Hamming forware error correction. Inspired by https://github.com/nasserkessas/hamming-codes. More...

#include <HammingFEC.h>

Inheritance diagram for HammingFEC< bytecount, block_t >:

Public Member Functions
	HammingFEC (Print &print)
	HammingFEC (Stream &stream)
int	available () override
int	availableForWrite () override
virtual bool	begin ()
virtual void	end ()
virtual void	flush () override
	operator bool ()
size_t	readBytes (uint8_t *data, size_t len) override
void	setWriteBufferSize (int size)
size_t	write (const uint8_t *data, size_t len) override
virtual size_t	write (uint8_t ch) override

Protected Member Functions
bool	decode (block_t input[], int len)
int	encode (uint8_t *input, int len)
int	encodedSize ()
bool	getBit (block_t b, int i)
int	getBlocks ()
bool	getCharBit (uint8_t b, int i)
int	inList (uint8_t **list, uint8_t *testString, int listLen)
block_t	modifyBit (block_t n, int p, bool b)
uint8_t	modifyCharBit (uint8_t n, int p, bool b)
int	multipleXor (int *indicies, int len)
void	refillReadBuffer ()
block_t	toggleBit (block_t b, int i)

Protected Attributes
int	_timeout = 10
SingleBuffer< uint8_t >	encoded {encodedSize()}
Print *	p_print = nullptr
Stream *	p_stream = nullptr
SingleBuffer< uint8_t >	raw {bytecount}
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

template<int bytecount, class block_t>
class audio_tools::HammingFEC< bytecount, block_t >

Hamming forware error correction. Inspired by https://github.com/nasserkessas/hamming-codes.

Hamming<1024,uint16_t> hamming; // block_ts of 1k with block_tsize 16bits = 31.25% redundency

Block size (bits) Redundant bits Redundancy percentage 4 3 75% 8 4 50% 16 5 31.25% 32 6 18.75% 64 7 10.94%

Member Function Documentation

available()

template<int bytecount, class block_t >

int available ( )

inlineoverridevirtual

Reimplemented from BaseStream.

availableForWrite()

template<int bytecount, class block_t >

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin()

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in AudioOutputWithCallback, SPDIFOutput, VS1053Stream, WM8960Stream, ESPNowStream, TimerCallbackAudioStream, FrequencyDetectorAutoCorrelation, GoertzelStream, AudioFFTBase, HLSStreamT< URLStream >, AnalogAudioArduino, AnalogAudioStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, FormatConverterStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, and Pipeline.

end()

virtual void end ( )

inlinevirtualinherited

Reimplemented in FaustStream< DSP >, I2SCodecStream, VS1053Stream, WM8960Stream, ESPNowStream, I2SStream, TimerCallbackAudioStream, AudioFFTBase, AudioKitStream, HLSStreamT< URLStream >, AnalogAudioStream, HttpRequest, ICYStreamT< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMixer< T >, InputMerge< T >, QueueStream< T >, QueueStream< uint8_t >, and Pipeline.

flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.

readBytes()

template<int bytecount, class block_t >

size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtual

Implements BaseStream.

write() [1/2]

template<int bytecount, class block_t >

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

Implements BaseStream.

write() [2/2]

virtual size_t write ( uint8_t  ch )

inlineoverridevirtualinherited

Reimplemented in BufferedTaskStream, and BufferedStream.

---

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

• src/AudioTools/Communication/HammingFEC.h