Abstract base class for IR protocol encoding and decoding. More...

#include <Codec.h>

Inheritance diagram for pulsewire::Codec:

[legend]

Collaboration diagram for pulsewire::Codec:

[legend]

Public Member Functions
	Codec (Preamble &preambleDetector)

virtual void	init (Preamble &detector, uint32_t shortPulseUs=600, uint32_t longPulseUs=1200, uint32_t toleranceUs=200)

virtual bool	begin (uint32_t bitFrequencyHz)
	initialization method for codecs that require setup before use (e.g., loading PIO programs, configuring state machines).

virtual void	reset ()
	Reset the internal state of the codec.

void	setPreamble (Preamble &preamble)
	Set the Preamble Detector object.

Preamble &	getPreamble ()
	Get the preamble detector associated with this codec.

virtual size_t	getEdgeCount () const =0
	Get the number of protocol symbols (bits, pulses, etc.) per encoded byte.

void	setFrameSize (uint16_t size)
	Set the Frame Size.

uint16_t	getFrameSize () const
	Get the configured frame size.

virtual int	getEndOfFrameDelayUs ()=0

virtual bool	getIdleLevel () const
	Provides the initial ldle state (low or hith)

virtual CodecEnum	getCodecType () const =0

const char *	name () const
	Get the name of the codec type as a string (e.g., "PulseDistance", "Manchester").

virtual bool	decodeEdge (uint32_t durationUs, bool level, uint8_t &result)=0
	Edge-based decoding for protocol-agnostic RX drivers.

size_t	encodePreamble (Vector< OutputEdge > &output)

virtual size_t	encode (uint8_t byte, Vector< OutputEdge > &output)=0
	Fill output vector with protocol-specific OutputSpec(s) for a byte.

virtual size_t	flushEncoder (Vector< OutputEdge > &output)
	Flush any pending encoder state at end of frame.

Protected Member Functions
virtual void	encodeByte (uint8_t byte, std::vector< bool > &bits) const
	Encode a byte to protocol bitstream. Default implementation encodes to raw bits (MSB first), but can be overridden by protocols that require different bit formatting (e.g., Manchester). The output bits are stored in.

Protected Attributes
CustomPreambleUs	_defaultPreamble

Preamble *	_preamble = &_defaultPreamble

uint16_t	_bitFrequencyHz = 0

uint32_t	_bitPeriodUs = 0

Vector< OutputEdge >	_decodeEdgeStream

volatile bool	_inFrame = false

uint16_t	_frameSize = 0

Friends
class	RecorderCodec

Detailed Description

Abstract base class for IR protocol encoding and decoding.

Provides a unified interface for encoding bytes to protocol-specific bitstreams, edge-based decoding for protocol-agnostic drivers, and protocol symbol count. Derived classes implement protocol-specific logic (e.g., Manchester, pulse-distance).

Definition at line 53 of file Codec.h.

Constructor & Destructor Documentation

◆ Codec()

pulsewire::Codec::Codec ( Preamble & preambleDetector )

inline

Definition at line 59 of file Codec.h.

Member Function Documentation

◆ begin()

virtual bool pulsewire::Codec::begin ( uint32_t bitFrequencyHz )

inlinevirtual

initialization method for codecs that require setup before use (e.g., loading PIO programs, configuring state machines).

Reimplemented in pulsewire::RecorderCodec, pulsewire::DifferentialManchesterCodec, pulsewire::ManchesterCodec, pulsewire::PulseDistanceCodec, and pulsewire::PulseWidthCodec.

Definition at line 70 of file Codec.h.

◆ decodeEdge()

virtual bool pulsewire::Codec::decodeEdge	(	uint32_t	durationUs,
		bool	level,
		uint8_t &	result
	)

pure virtual

Edge-based decoding for protocol-agnostic RX drivers.

Called on each signal edge (duration since last edge, new level, minUs, maxUs). The codec maintains its own state and assembles frames internally.

Parameters

durationUs	Time in microseconds since last edge.
level	New logic level after the edge (true = HIGH, false = LOW).
frameBuffer	Output buffer for decoded frame (if available).
frameBufferSize	Size of frameBuffer (bytes).
frameLen	Set to decoded frame length if a frame is available.

Returns: True if a complete frame is decoded and available in frameBuffer.

Implemented in pulsewire::ManchesterCodec, pulsewire::MillerCodec, pulsewire::NRZCodec, pulsewire::PulseDistanceCodec, pulsewire::PulseWidthCodec, pulsewire::RecorderCodec, and pulsewire::RZCodec.

◆ encode()

virtual size_t pulsewire::Codec::encode	(	uint8_t	byte,
		Vector< OutputEdge > &	output
	)

pure virtual

Fill output vector with protocol-specific OutputSpec(s) for a byte.

Encodes the byte to protocol bits and appends OutputSpec(s) for each bit.

Parameters

byte	The byte to encode.
output	Vector to append OutputSpec(s).

Returns: Number of OutputSpec entries added.

Implemented in pulsewire::ManchesterCodec, pulsewire::MillerCodec, pulsewire::NRZCodec, pulsewire::PulseDistanceCodec, pulsewire::PulseWidthCodec, pulsewire::RecorderCodec, and pulsewire::RZCodec.

◆ encodeByte()

virtual void pulsewire::Codec::encodeByte	(	uint8_t	byte,
		std::vector< bool > &	bits
	)		const

inlineprotectedvirtual

Encode a byte to protocol bitstream. Default implementation encodes to raw bits (MSB first), but can be overridden by protocols that require different bit formatting (e.g., Manchester). The output bits are stored in.

Parameters

byte	The input byte to encode.
bits	Output buffer for encoded bits (protocol-specific format).

Definition at line 204 of file Codec.h.

◆ encodePreamble()

size_t pulsewire::Codec::encodePreamble ( Vector< OutputEdge > & output )

inline

Definition at line 157 of file Codec.h.

◆ flushEncoder()

virtual size_t pulsewire::Codec::flushEncoder ( Vector< OutputEdge > & output )

inlinevirtual

Flush any pending encoder state at end of frame.

Some codecs (e.g., Miller) accumulate pending duration that must be output at the end of the frame. This method outputs any remaining pending state. Default implementation does nothing.

Parameters

output Vector to append OutputSpec(s).

Returns: Number of OutputSpec entries added.

Reimplemented in pulsewire::MillerCodec.

Definition at line 185 of file Codec.h.

◆ getCodecType()

virtual CodecEnum pulsewire::Codec::getCodecType ( ) const

pure virtual

Get the codec type (e.g., PulseDistance, Manchester) for this Codec instance.

Implemented in pulsewire::DifferentialManchesterCodec, pulsewire::ManchesterCodec, pulsewire::MillerCodec, pulsewire::NRZCodec, pulsewire::PulseDistanceCodec, pulsewire::PulseWidthCodec, pulsewire::RecorderCodec, and pulsewire::RZCodec.

◆ getEdgeCount()

virtual size_t pulsewire::Codec::getEdgeCount ( ) const

pure virtual

Get the number of protocol symbols (bits, pulses, etc.) per encoded byte.

Returns: Number of protocol symbols per byte.

Implemented in pulsewire::RecorderCodec, pulsewire::ManchesterCodec, pulsewire::MillerCodec, pulsewire::NRZCodec, pulsewire::PulseDistanceCodec, pulsewire::PulseWidthCodec, and pulsewire::RZCodec.

◆ getEndOfFrameDelayUs()

virtual int pulsewire::Codec::getEndOfFrameDelayUs ( )

pure virtual

Provide the end of frame delay in microseconds for this protocol, used by RX driver to

Implemented in pulsewire::ManchesterCodec, pulsewire::MillerCodec, pulsewire::NRZCodec, pulsewire::PulseDistanceCodec, pulsewire::PulseWidthCodec, pulsewire::RecorderCodec, and pulsewire::RZCodec.

◆ getFrameSize()

uint16_t pulsewire::Codec::getFrameSize ( ) const

inline

Get the configured frame size.

Definition at line 120 of file Codec.h.

◆ getIdleLevel()

virtual bool pulsewire::Codec::getIdleLevel ( ) const

inlinevirtual

Provides the initial ldle state (low or hith)

Reimplemented in pulsewire::DifferentialManchesterCodec, pulsewire::MillerCodec, pulsewire::NRZCodec, and pulsewire::RZCodec.

Definition at line 127 of file Codec.h.

◆ getPreamble()

Preamble & pulsewire::Codec::getPreamble ( )

inline

Get the preamble detector associated with this codec.

Returns: Reference to the Preamble instance used for preamble detection.

Definition at line 100 of file Codec.h.

◆ init()

virtual void pulsewire::Codec::init	(	Preamble &	detector,
		uint32_t	shortPulseUs = `600`,
		uint32_t	longPulseUs = `1200`,
		uint32_t	toleranceUs = `200`
	)

inlinevirtual

Used by IRTransceiver to initialize codec with protocol-specific parameters

Reimplemented in pulsewire::PulseWidthCodec, pulsewire::PulseDistanceCodec, and pulsewire::RecorderCodec.

Definition at line 63 of file Codec.h.

◆ name()

const char * pulsewire::Codec::name ( ) const

inline

Get the name of the codec type as a string (e.g., "PulseDistance", "Manchester").

Definition at line 135 of file Codec.h.

◆ reset()

virtual void pulsewire::Codec::reset ( )

inlinevirtual

Reset the internal state of the codec.

Reimplemented in pulsewire::DifferentialManchesterCodec, pulsewire::MillerCodec, pulsewire::NRZCodec, and pulsewire::RZCodec.

Definition at line 84 of file Codec.h.

◆ setFrameSize()

void pulsewire::Codec::setFrameSize ( uint16_t size )

inline

Set the Frame Size.

Parameters

size

Definition at line 114 of file Codec.h.

◆ setPreamble()

void pulsewire::Codec::setPreamble ( Preamble & preamble )

inline

Set the Preamble Detector object.

Parameters

preamble

Definition at line 94 of file Codec.h.

Friends And Related Symbol Documentation

◆ RecorderCodec

friend class RecorderCodec

friend

Definition at line 54 of file Codec.h.

Field Documentation

◆ _bitFrequencyHz

uint16_t pulsewire::Codec::_bitFrequencyHz = 0

protected

Definition at line 190 of file Codec.h.

◆ _bitPeriodUs

uint32_t pulsewire::Codec::_bitPeriodUs = 0

protected

Definition at line 191 of file Codec.h.

◆ _decodeEdgeStream

Vector<OutputEdge> pulsewire::Codec::_decodeEdgeStream

protected

Definition at line 192 of file Codec.h.

◆ _defaultPreamble

CustomPreambleUs pulsewire::Codec::_defaultPreamble

protected

Definition at line 188 of file Codec.h.

◆ _frameSize

uint16_t pulsewire::Codec::_frameSize = 0

protected

Definition at line 194 of file Codec.h.

◆ _inFrame

volatile bool pulsewire::Codec::_inFrame = false

protected

Definition at line 193 of file Codec.h.

◆ _preamble

Preamble* pulsewire::Codec::_preamble = &_defaultPreamble

protected

Definition at line 189 of file Codec.h.

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

src/pulse/codecs/Codec.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Codec()

Member Function Documentation

◆ begin()

◆ decodeEdge()

◆ encode()

◆ encodeByte()

◆ encodePreamble()

◆ flushEncoder()

◆ getCodecType()

◆ getEdgeCount()

◆ getEndOfFrameDelayUs()

◆ getFrameSize()

◆ getIdleLevel()

◆ getPreamble()

◆ init()

◆ name()

◆ reset()

◆ setFrameSize()

◆ setPreamble()

Friends And Related Symbol Documentation

◆ RecorderCodec

Field Documentation

◆ _bitFrequencyHz

◆ _bitPeriodUs

◆ _decodeEdgeStream

◆ _defaultPreamble

◆ _frameSize

◆ _inFrame

◆ _preamble