headers.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017 Roc Streaming authors
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
//! @file roc_fec/headers.h
//! @brief FECFRAME headers.
 
#ifndef ROC_FEC_HEADERS_H_
#define ROC_FEC_HEADERS_H_
 
#include "roc_core/attributes.h"
#include "roc_core/endian.h"
#include "roc_core/panic.h"
#include "roc_core/stddefs.h"
#include "roc_packet/fec.h"
 
namespace roc {
namespace fec {
 
//! FEC Payload ID type.
enum PayloadID_Type {
    Source, //!< Source packet header of footer.
    Repair  //!< Source packet header of footer.
};
 
//! FEC Payload ID position.
enum PayloadID_Pos {
    Header, //!< PayloadID comes before payload.
    Footer  //!< PayloadID comes after payload.
};
 
//! LDPC-Staircase Source FEC Payload ID.
//!
//! RFC 6816 5.1.2: "Explicit Source FEC Payload ID"
//!
//! @code
//!    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)    |
//!   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//! @endcode
ROC_ATTR_PACKED_BEGIN class LDPC_Source_PayloadID {
private:
    //! Source block number.
    uint16_t sbn_;
 
    //! Encoding symbol ID.
    uint16_t esi_;
 
    //! Source block length.
    uint16_t k_;
 
public:
    //! Get FEC scheme to which these packets belong to.
    static packet::FecScheme fec_scheme() {
        return packet::FEC_LDPC_Staircase;
    }
 
    //! Clear header.
    void clear() {
        memset(this, 0, sizeof(*this));
    }
 
    //! Get source block number.
    uint16_t sbn() const {
        return core::ntoh16u(sbn_);
    }
 
    //! Set source block number.
    void set_sbn(uint16_t val) {
        sbn_ = core::hton16u(val);
    }
 
    //! Get encoding symbol ID.
    uint16_t esi() const {
        return core::ntoh16u(esi_);
    }
 
    //! Set encoding symbol ID.
    void set_esi(uint16_t val) {
        esi_ = core::hton16u(val);
    }
 
    //! Get source block length.
    uint16_t k() const {
        return core::ntoh16u(k_);
    }
 
    //! Set source block length.
    void set_k(uint16_t val) {
        k_ = core::hton16u(val);
    }
 
    //! Get number encoding symbols.
    uint16_t n() const {
        return 0;
    }
 
    //! Set number encoding symbols.
    void set_n(uint16_t) {
    }
} ROC_ATTR_PACKED_END;
 
//! LDPC-Staircase Repair FEC Payload ID.
//!
//! RFC 6816 5.1.3: "Repair FEC Payload ID"
//!
//! @code
//!    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)    |  Number Encoding Symbols (n)  |
//!   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//! @endcode
ROC_ATTR_PACKED_BEGIN class LDPC_Repair_PayloadID {
private:
    //! Source block number.
    uint16_t sbn_;
 
    //! Encoding symbol ID.
    uint16_t esi_;
 
    //! Source block length.
    uint16_t k_;
 
    //! Number encoding symbols.
    uint16_t n_;
 
public:
    //! Get FEC scheme to which these packets belong to.
    static packet::FecScheme fec_scheme() {
        return packet::FEC_LDPC_Staircase;
    }
 
    //! Clear header.
    void clear() {
        memset(this, 0, sizeof(*this));
    }
 
    //! Get source block number.
    uint16_t sbn() const {
        return core::ntoh16u(sbn_);
    }
 
    //! Set source block number.
    void set_sbn(uint16_t val) {
        sbn_ = core::hton16u(val);
    }
 
    //! Get encoding symbol ID.
    uint16_t esi() const {
        return core::ntoh16u(esi_);
    }
 
    //! Set encoding symbol ID.
    void set_esi(uint16_t val) {
        esi_ = core::hton16u(val);
    }
 
    //! Get source block length.
    uint16_t k() const {
        return core::ntoh16u(k_);
    }
 
    //! Set source block length.
    void set_k(uint16_t val) {
        k_ = core::hton16u(val);
    }
 
    //! Get number encoding symbols.
    uint16_t n() const {
        return core::ntoh16u(n_);
    }
 
    //! Set number encoding symbols.
    void set_n(uint16_t val) {
        n_ = core::hton16u(val);
    }
} ROC_ATTR_PACKED_END;
 
//! Reed-Solomon Source or Repair Payload ID (for m=8).
//!
//! RFC 5510 5.1: "FEC Payload ID"
//!
//! @code
//!    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)    |
//!   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//! @endcode
ROC_ATTR_PACKED_BEGIN class RS8M_PayloadID {
private:
    //! Source block number.
    uint8_t sbn_[3];
 
    //! Encoding symbol ID.
    uint8_t esi_;
 
    //! Source block length.
    uint16_t k_;
 
public:
    //! Get FEC scheme to which these packets belong to.
    static packet::FecScheme fec_scheme() {
        return packet::FEC_ReedSolomon_M8;
    }
 
    //! Clear header.
    void clear() {
        memset(this, 0, sizeof(*this));
    }
 
    //! Get source block number.
    uint32_t sbn() const {
        return (uint32_t(sbn_[0]) << 16) | (uint32_t(sbn_[1]) << 8) | uint32_t(sbn_[2]);
    }
 
    //! Set source block number.
    void set_sbn(uint32_t val) {
        roc_panic_if((val >> 24) != 0);
        sbn_[0] = uint8_t((val >> 16) & 0xff);
        sbn_[1] = uint8_t((val >> 8) & 0xff);
        sbn_[2] = uint8_t(val & 0xff);
    }
 
    //! Get encoding symbol ID.
    uint8_t esi() const {
        return esi_;
    }
 
    //! Set encoding symbol ID.
    void set_esi(uint16_t val) {
        roc_panic_if((val >> 8) != 0);
        esi_ = (uint8_t)val;
    }
 
    //! Get source block length.
    uint16_t k() const {
        return core::ntoh16u(k_);
    }
 
    //! Set source block length.
    void set_k(uint16_t val) {
        k_ = core::hton16u(val);
    }
 
    //! Get number encoding symbols.
    uint16_t n() const {
        return 255;
    }
 
    //! Set number encoding symbols.
    void set_n(uint16_t) {
    }
} ROC_ATTR_PACKED_END;
 
} // namespace fec
} // namespace roc
 
#endif // ROC_FEC_HEADERS_H_