tinymodem::ModemDecoder Class Reference

Common API of the demodulators (FSKDecoder, MFSKDecoder): PCM audio data is written to the decoder and the decoded data is written to the output. Status messages (### CARRIER and ### NOCARRIER) are written to the status output. More...

#include <ModemBase.h>

Inheritance diagram for tinymodem::ModemDecoder:

Collaboration diagram for tinymodem::ModemDecoder:

Public Member Functions
void	setStatusOutput (Print &out)
	Defines the output for the ### CARRIER / ### NOCARRIER messages.
void	setQuiet (bool quiet)
	Suppresses the status messages.
virtual bool	isCarrier ()=0
	true while a carrier is detected
virtual bool	isFinished ()=0
	true if the decoding was stopped (rx_one)
virtual void	flush ()=0
	Processes all buffered samples (e.g. at the end of the input).
const char *	mime () override

Protected Member Functions
void	status (const char *fmt,...)

Protected Attributes
Print *	p_status = nullptr
bool	is_quiet = false

Detailed Description

Common API of the demodulators (FSKDecoder, MFSKDecoder): PCM audio data is written to the decoder and the decoded data is written to the output. Status messages (### CARRIER and ### NOCARRIER) are written to the status output.

Copyright

GPLv3

Member Function Documentation

flush()

virtual void tinymodem::ModemDecoder::flush ( )

pure virtual

Processes all buffered samples (e.g. at the end of the input).

Implemented in tinymodem::AX25Decoder, tinymodem::CSSDecoder, tinymodem::DTMFDecoder, tinymodem::FSKDecoder, tinymodem::GGWaveDecoder, tinymodem::MFSKDecoder, tinymodem::MorseDecoder, tinymodem::OFDMDecoder, tinymodem::OliviaDecoder, and tinymodem::PSKDecoder.

isCarrier()

virtual bool tinymodem::ModemDecoder::isCarrier ( )

pure virtual

true while a carrier is detected

Implemented in tinymodem::AX25Decoder, tinymodem::CSSDecoder, tinymodem::DTMFDecoder, tinymodem::FSKDecoder, tinymodem::GGWaveDecoder, tinymodem::MFSKDecoder, tinymodem::MorseDecoder, tinymodem::OFDMDecoder, tinymodem::OliviaDecoder, and tinymodem::PSKDecoder.

isFinished()

virtual bool tinymodem::ModemDecoder::isFinished ( )

pure virtual

true if the decoding was stopped (rx_one)

Implemented in tinymodem::AX25Decoder, tinymodem::CSSDecoder, tinymodem::DTMFDecoder, tinymodem::FSKDecoder, tinymodem::GGWaveDecoder, tinymodem::MFSKDecoder, tinymodem::MorseDecoder, tinymodem::OFDMDecoder, tinymodem::OliviaDecoder, and tinymodem::PSKDecoder.

mime()

const char * tinymodem::ModemDecoder::mime ( )

inlineoverride

setQuiet()

void tinymodem::ModemDecoder::setQuiet ( bool quiet )

inline

Suppresses the status messages.

setStatusOutput()

void tinymodem::ModemDecoder::setStatusOutput ( Print & out )

inline

Defines the output for the ### CARRIER / ### NOCARRIER messages.

status()

void tinymodem::ModemDecoder::status ( const char * fmt, ... )

inlineprotected

Member Data Documentation

is_quiet

bool tinymodem::ModemDecoder::is_quiet = false

protected

p_status

Print* tinymodem::ModemDecoder::p_status = nullptr

protected

---

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

• src/modem/ModemBase.h