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

Reed-Solomon Source or Repair Payload ID (for m=8). More...

#include <headers.h>

Public Member Functions

void clear ()
 Clear header. More...
 
uint32_t sbn () const
 Get source block number. More...
 
void set_sbn (uint32_t val)
 Set source block number. More...
 
uint8_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

Reed-Solomon Source or Repair Payload ID (for m=8).

RFC 5510 5.1: "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 (24 bits) | Enc. Symb. ID |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Source Block Length (k) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
uint16_t k() const
Get source block length.
Definition: headers.h:250
@ Source
Source packet header of footer.
Definition: headers.h:26

Definition at line 203 of file headers.h.

Member Function Documentation

◆ clear()

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

Clear header.

Definition at line 221 of file headers.h.

◆ esi()

uint8_t roc::fec::RS8M_PayloadID::esi ( ) const
inline

Get encoding symbol ID.

Definition at line 239 of file headers.h.

◆ fec_scheme()

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

Get FEC scheme to which these packets belong to.

Definition at line 216 of file headers.h.

◆ k()

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

Get source block length.

Definition at line 250 of file headers.h.

◆ n()

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

Get number encoding symbols.

Definition at line 260 of file headers.h.

◆ sbn()

uint32_t roc::fec::RS8M_PayloadID::sbn ( ) const
inline

Get source block number.

Definition at line 226 of file headers.h.

◆ set_esi()

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

Set encoding symbol ID.

Definition at line 244 of file headers.h.

◆ set_k()

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

Set source block length.

Definition at line 255 of file headers.h.

◆ set_n()

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

Set number encoding symbols.

Definition at line 265 of file headers.h.

◆ set_sbn()

void roc::fec::RS8M_PayloadID::set_sbn ( uint32_t  val)
inline

Set source block number.

Definition at line 231 of file headers.h.


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