ReedSolomonFEC< bytecount, additional_bytes > Class Template Reference

Forward error correction using Reed-Solomon: write is encoding and readBytes does the decoding. More...

#include <ReedSolomonFEC.h>

Inheritance diagram for ReedSolomonFEC< bytecount, additional_bytes >:

Public Member Functions
	ReedSolomonFEC (Print &print)
	ReedSolomonFEC (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
size_t	write (const uint8_t *data, size_t len) override
virtual size_t	write (uint8_t ch) override

Protected Member Functions
void	refillReadBuffer ()

Protected Attributes
int	_timeout = 10
SingleBuffer< uint8_t >	encoded {bytecount+additional_bytes}
Print *	p_print = nullptr
Stream *	p_stream = nullptr
SingleBuffer< uint8_t >	raw {bytecount}
RS::ReedSolomon< bytecount, additional_bytes >	rs
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}

Detailed Description

template<int bytecount, int additional_bytes>
class audio_tools::ReedSolomonFEC< bytecount, additional_bytes >

Forward error correction using Reed-Solomon: write is encoding and readBytes does the decoding.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

available()

template<int bytecount, int additional_bytes>

int available ( )

inlineoverridevirtual

Reimplemented from BaseStream.

availableForWrite()

template<int bytecount, int additional_bytes>

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin()

virtual bool begin ( )

inlinevirtualinherited

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

end()

virtual void end ( )

inlinevirtualinherited

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

flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.

readBytes()

template<int bytecount, int additional_bytes>

size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtual

Implements BaseStream.

write() [1/2]

template<int bytecount, int additional_bytes>

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/ReedSolomonFEC.h