Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::fec::LDPC_Source_PayloadID Class Reference

LDPC-Staircase Source FEC Payload ID. More...

#include <headers.h>

Public Member Functions

void clear ()
 Clear header. More...
 
uint16_t sbn () const
 Get source block number. More...
 
void set_sbn (uint16_t val)
 Set source block number. More...
 
uint16_t esi () const
 Get encoding symbol ID. More...
 
void set_esi (uint16_t val)
 Set encoding symbol ID. More...
 
uint16_t k () const
 Get source block length. More...
 
void set_k (uint16_t val)
 Set source block length. More...
 
uint16_t n () const
 Get number encoding symbols. More...
 
void set_n (uint16_t)
 Set number encoding symbols. More...
 

Static Public Member Functions

static packet::FecScheme fec_scheme ()
 Get FEC scheme to which these packets belong to. More...
 

Detailed Description

LDPC-Staircase Source FEC Payload ID.

RFC 6816 5.1.2: "Explicit Source FEC Payload ID"

0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Source Block Number (SBN) | Encoding Symbol ID (ESI) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Source Block Length (k) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
uint16_t k() const
Get source block length.
Definition: headers.h:92
@ Source
Source packet header of footer.
Definition: headers.h:26

Definition at line 49 of file headers.h.

Member Function Documentation

◆ clear()

void roc::fec::LDPC_Source_PayloadID::clear ( )
inline

Clear header.

Definition at line 67 of file headers.h.

◆ esi()

uint16_t roc::fec::LDPC_Source_PayloadID::esi ( ) const
inline

Get encoding symbol ID.

Definition at line 82 of file headers.h.

◆ fec_scheme()

static packet::FecScheme roc::fec::LDPC_Source_PayloadID::fec_scheme ( )
inlinestatic

Get FEC scheme to which these packets belong to.

Definition at line 62 of file headers.h.

◆ k()

uint16_t roc::fec::LDPC_Source_PayloadID::k ( ) const
inline

Get source block length.

Definition at line 92 of file headers.h.

◆ n()

uint16_t roc::fec::LDPC_Source_PayloadID::n ( ) const
inline

Get number encoding symbols.

Definition at line 102 of file headers.h.

◆ sbn()

uint16_t roc::fec::LDPC_Source_PayloadID::sbn ( ) const
inline

Get source block number.

Definition at line 72 of file headers.h.

◆ set_esi()

void roc::fec::LDPC_Source_PayloadID::set_esi ( uint16_t  val)
inline

Set encoding symbol ID.

Definition at line 87 of file headers.h.

◆ set_k()

void roc::fec::LDPC_Source_PayloadID::set_k ( uint16_t  val)
inline

Set source block length.

Definition at line 97 of file headers.h.

◆ set_n()

void roc::fec::LDPC_Source_PayloadID::set_n ( uint16_t  )
inline

Set number encoding symbols.

Definition at line 107 of file headers.h.

◆ set_sbn()

void roc::fec::LDPC_Source_PayloadID::set_sbn ( uint16_t  val)
inline

Set source block number.

Definition at line 77 of file headers.h.


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