dvb-si 3.1.1

//! MPE-IFEC section — ETSI TS 102 772 v1.1.1 §5.2 (table_id 0x7A).
//!
//! Carries Inter-burst FEC (IFEC) data for DVB-SH / IP datacast. Syntax per
//! "Table 2 — MPE-IFEC section" (`dvb-si/docs/ts_102_772_mpe_ifec.md`, §5.2,
//! PDF p. 17):
//!
//! ```text
//! MPE-IFEC_section() {
//!   table_id                  8   (0x7A)
//!   section_syntax_indicator  1
//!   private_indicator         1
//!   reserved                  2
//!   section_length           12
//!   burst_number              8
//!   IFEC_burst_size           8
//!   reserved                  2
//!   version                   5
//!   current_next_indicator    1
//!   section_number            8
//!   last_section_number       8
//!   real_time_parameters()   32
//!   for (i=0; i<Nmax; i++) { IFEC_data_byte 8 }
//!   CRC_32                   32
//! }
//! ```
//!
//! Unlike MPE-FEC, this section DOES carry a 5-bit `version` (byte 5), and the
//! byte-3/4 slot is `burst_number(8)` + `IFEC_burst_size(8)` rather than a
//! 16-bit identifier. The `real_time_parameters()` block (32 bits) has the SAME
//! bit-packing as MPE-FEC's but DIFFERENT field semantics per "Table 3"
//! (§5.3, PDF p. 18): `delta_t(12)` | `mpe_boundary(1)` | `frame_boundary(1)`
//! | `prev_burst_size(18)`. The doc deliberately keeps a local copy of the
//! struct (no shared module) — a coordinator may dedup later if warranted.
//!
//! MPE-IFEC is a private section (byte-1 bit 6 = `private_indicator`), handled
//! with the [`crate::tables::cit`] idiom. `ifec_data` is a borrowed raw slice.
//! No well-known PID — carriage is descriptor-signalled, so `PID = 0x0000`
//! follows the [`crate::tables::dsmcc`] precedent.

use crate::error::{Error, Result};
use crate::traits::Table;
use dvb_common::{Parse, Serialize};

/// table_id for the MPE-IFEC section.
pub const TABLE_ID: u8 = 0x7A;

/// MPE-IFEC has no well-known PID — its carriage is signalled via descriptors.
/// `0x0000` follows the DSM-CC precedent.
pub const PID: u16 = 0x0000;

/// Bytes 0-2: table_id (1) + flags + section_length (2).
const HEADER_LEN: usize = 3;

/// Bytes 3-7: burst_number(1) + IFEC_burst_size(1) + reserved/version/cni(1)
/// + section_number(1) + last_section_number(1).
const EXTENSION_HEADER_LEN: usize = 5;

/// Bytes 8-11: the 32-bit `real_time_parameters()`.
const RTP_LEN: usize = 4;

/// Bytes occupied by the trailing CRC-32 field.
const CRC_LEN: usize = 4;

/// Minimum total encoded length: header + extension + RTP + CRC.
const MIN_LEN: usize = HEADER_LEN + EXTENSION_HEADER_LEN + RTP_LEN + CRC_LEN;

/// Time-slicing / MPE-IFEC real-time parameters (TS 102 772 §5.3, Table 3).
///
/// 32 bits: `delta_t(12)` | `mpe_boundary(1)` | `frame_boundary(1)`
/// | `prev_burst_size(18)`. Same bit layout as the MPE-FEC variant but the
/// final two fields are `mpe_boundary` / `prev_burst_size`, not
/// `table_boundary` / `address`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
pub struct RealTimeParameters {
    /// 12-bit `delta_t` — time until the start of the next burst.
    pub delta_t: u16,
    /// `mpe_boundary` flag.
    pub mpe_boundary: bool,
    /// `frame_boundary` flag.
    pub frame_boundary: bool,
    /// 18-bit `prev_burst_size`.
    pub prev_burst_size: u32,
}

impl RealTimeParameters {
    /// Decode the 4-byte real_time_parameters block.
    fn from_bytes(b: [u8; RTP_LEN]) -> Self {
        // delta_t(12) = b[0] | top 4 bits of b[1]
        let delta_t = ((b[0] as u16) << 4) | ((b[1] >> 4) as u16);
        let mpe_boundary = (b[1] & 0x08) != 0;
        let frame_boundary = (b[1] & 0x04) != 0;
        // prev_burst_size(18) = bottom 2 bits of b[1] | b[2] | b[3]
        let prev_burst_size = (((b[1] & 0x03) as u32) << 16) | ((b[2] as u32) << 8) | (b[3] as u32);
        RealTimeParameters {
            delta_t,
            mpe_boundary,
            frame_boundary,
            prev_burst_size,
        }
    }

    /// Encode into the 4-byte real_time_parameters block.
    fn to_bytes(self) -> [u8; RTP_LEN] {
        let dt = self.delta_t & 0x0FFF;
        let pbs = self.prev_burst_size & 0x0003_FFFF;
        [
            (dt >> 4) as u8,
            (((dt & 0x0F) as u8) << 4)
                | (u8::from(self.mpe_boundary) << 3)
                | (u8::from(self.frame_boundary) << 2)
                | ((pbs >> 16) as u8 & 0x03),
            ((pbs >> 8) & 0xFF) as u8,
            (pbs & 0xFF) as u8,
        ]
    }
}

/// MPE-IFEC section (ETSI TS 102 772 v1.1.1 §5.2).
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[cfg_attr(feature = "yoke", derive(yoke::Yokeable))]
pub struct MpeIfec<'a> {
    /// `private_indicator` bit from byte 1 (MPE-IFEC is a private section).
    pub private_indicator: bool,
    /// `burst_number` (byte 3) — the IFEC burst this section belongs to.
    pub burst_number: u8,
    /// `IFEC_burst_size` (byte 4) — number of application data tables in the
    /// burst.
    pub ifec_burst_size: u8,
    /// 5-bit `version` (byte 5).
    pub version: u8,
    /// `current_next_indicator` bit.
    pub current_next_indicator: bool,
    /// section_number in the sub-table sequence.
    pub section_number: u8,
    /// last_section_number in the sub-table sequence.
    pub last_section_number: u8,
    /// The decoded real-time parameters block.
    pub real_time_parameters: RealTimeParameters,
    /// Raw IFEC data bytes (everything between the real_time_parameters block
    /// and the CRC-32 trailer).
    pub ifec_data: &'a [u8],
}

impl<'a> Parse<'a> for MpeIfec<'a> {
    type Error = crate::error::Error;

    fn parse(bytes: &'a [u8]) -> Result<Self> {
        if bytes.len() < MIN_LEN {
            return Err(Error::BufferTooShort {
                need: MIN_LEN,
                have: bytes.len(),
                what: "MpeIfec",
            });
        }

        if bytes[0] != TABLE_ID {
            return Err(Error::UnexpectedTableId {
                table_id: bytes[0],
                what: "MpeIfec",
                expected: &[TABLE_ID],
            });
        }

        let section_length = (((bytes[1] & 0x0F) as usize) << 8) | bytes[2] as usize;
        let total = HEADER_LEN + section_length;
        if bytes.len() < total {
            return Err(Error::SectionLengthOverflow {
                declared: section_length,
                available: bytes.len() - HEADER_LEN,
            });
        }

        let private_indicator = (bytes[1] & 0x40) != 0;
        let burst_number = bytes[3];
        let ifec_burst_size = bytes[4];
        // byte 5: reserved(2) | version(5) | current_next_indicator(1)
        let version = (bytes[5] >> 1) & 0x1F;
        let current_next_indicator = (bytes[5] & 0x01) != 0;
        let section_number = bytes[6];
        let last_section_number = bytes[7];

        let rtp_start = HEADER_LEN + EXTENSION_HEADER_LEN;
        let real_time_parameters = RealTimeParameters::from_bytes([
            bytes[rtp_start],
            bytes[rtp_start + 1],
            bytes[rtp_start + 2],
            bytes[rtp_start + 3],
        ]);

        let data_start = rtp_start + RTP_LEN;
        let data_end = total - CRC_LEN;
        let ifec_data = &bytes[data_start..data_end];

        Ok(MpeIfec {
            private_indicator,
            burst_number,
            ifec_burst_size,
            version,
            current_next_indicator,
            section_number,
            last_section_number,
            real_time_parameters,
            ifec_data,
        })
    }
}

impl Serialize for MpeIfec<'_> {
    type Error = crate::error::Error;

    fn serialized_len(&self) -> usize {
        HEADER_LEN + EXTENSION_HEADER_LEN + RTP_LEN + self.ifec_data.len() + CRC_LEN
    }

    fn serialize_into(&self, buf: &mut [u8]) -> Result<usize> {
        let len = self.serialized_len();
        if buf.len() < len {
            return Err(Error::OutputBufferTooSmall {
                need: len,
                have: buf.len(),
            });
        }

        let section_length = (len - HEADER_LEN) as u16;

        // Byte 0: table_id.
        buf[0] = TABLE_ID;
        // Byte 1: section_syntax_indicator(1)=1 | private_indicator(1)
        //         | reserved(2)=11 | section_length[11:8](4).
        buf[1] = 0x80
            | (u8::from(self.private_indicator) << 6)
            | 0x30
            | ((section_length >> 8) as u8 & 0x0F);
        buf[2] = (section_length & 0xFF) as u8;

        // Extension header.
        buf[3] = self.burst_number;
        buf[4] = self.ifec_burst_size;
        // reserved(2)=11 | version(5) | current_next_indicator(1)
        buf[5] = 0xC0 | ((self.version & 0x1F) << 1) | u8::from(self.current_next_indicator);
        buf[6] = self.section_number;
        buf[7] = self.last_section_number;

        // real_time_parameters.
        let rtp_start = HEADER_LEN + EXTENSION_HEADER_LEN;
        buf[rtp_start..rtp_start + RTP_LEN].copy_from_slice(&self.real_time_parameters.to_bytes());

        // ifec_data.
        let data_start = rtp_start + RTP_LEN;
        let data_end = data_start + self.ifec_data.len();
        buf[data_start..data_end].copy_from_slice(self.ifec_data);

        // CRC-32 over everything up to (but not including) the CRC slot.
        let crc = dvb_common::crc32_mpeg2::compute(&buf[..data_end]);
        buf[data_end..len].copy_from_slice(&crc.to_be_bytes());

        Ok(len)
    }
}

impl<'a> Table<'a> for MpeIfec<'a> {
    const TABLE_ID: u8 = TABLE_ID;
    const PID: u16 = PID;
}

impl<'a> crate::traits::TableDef<'a> for MpeIfec<'a> {
    const TABLE_ID_RANGES: &'static [(u8, u8)] = &[(TABLE_ID, TABLE_ID)];
    const NAME: &'static str = "MPE_IFEC";
}

#[cfg(test)]
mod tests {
    use super::*;

    #[allow(clippy::too_many_arguments)]
    fn build_mpe_ifec(
        burst_number: u8,
        ifec_burst_size: u8,
        version: u8,
        current_next: bool,
        section_number: u8,
        last_section_number: u8,
        rtp: RealTimeParameters,
        ifec_data: &[u8],
    ) -> Vec<u8> {
        let s = MpeIfec {
            private_indicator: true,
            burst_number,
            ifec_burst_size,
            version,
            current_next_indicator: current_next,
            section_number,
            last_section_number,
            real_time_parameters: rtp,
            ifec_data,
        };
        let mut buf = vec![0u8; s.serialized_len()];
        s.serialize_into(&mut buf).unwrap();
        buf
    }

    fn sample_rtp() -> RealTimeParameters {
        RealTimeParameters {
            delta_t: 0x0ABC,
            mpe_boundary: true,
            frame_boundary: false,
            prev_burst_size: 0x0001_2345,
        }
    }

    #[test]
    fn parse_happy_path() {
        let ifec = [0x11u8, 0x22, 0x33, 0x44];
        let bytes = build_mpe_ifec(5, 16, 9, true, 1, 3, sample_rtp(), &ifec);
        let s = MpeIfec::parse(&bytes).unwrap();
        assert!(s.private_indicator);
        assert_eq!(s.burst_number, 5);
        assert_eq!(s.ifec_burst_size, 16);
        assert_eq!(s.version, 9);
        assert!(s.current_next_indicator);
        assert_eq!(s.section_number, 1);
        assert_eq!(s.last_section_number, 3);
        assert_eq!(s.real_time_parameters, sample_rtp());
        assert_eq!(s.ifec_data, &ifec[..]);
    }

    #[test]
    fn parse_empty_ifec_data() {
        let bytes = build_mpe_ifec(0, 0, 0, false, 0, 0, sample_rtp(), &[]);
        let s = MpeIfec::parse(&bytes).unwrap();
        assert_eq!(s.burst_number, 0);
        assert_eq!(s.version, 0);
        assert!(!s.current_next_indicator);
        assert!(s.ifec_data.is_empty());
        assert_eq!(s.real_time_parameters, sample_rtp());
    }

    #[test]
    fn rtp_bit_packing_round_trips_extremes() {
        let rtp = RealTimeParameters {
            delta_t: 0x0FFF,
            mpe_boundary: false,
            frame_boundary: true,
            prev_burst_size: 0x0003_FFFF,
        };
        assert_eq!(RealTimeParameters::from_bytes(rtp.to_bytes()), rtp);
    }

    #[test]
    fn parse_rejects_wrong_tag() {
        let mut bytes = build_mpe_ifec(0, 0, 0, true, 0, 0, sample_rtp(), &[]);
        bytes[0] = 0x70; // not 0x7A
        assert!(matches!(
            MpeIfec::parse(&bytes).unwrap_err(),
            Error::UnexpectedTableId { table_id: 0x70, .. }
        ));
    }

    #[test]
    fn parse_rejects_short_buffer() {
        assert!(matches!(
            MpeIfec::parse(&[0x7A, 0x80]).unwrap_err(),
            Error::BufferTooShort { .. }
        ));
    }

    #[test]
    fn parse_rejects_section_length_overflow() {
        let mut bytes = build_mpe_ifec(0, 0, 0, true, 0, 0, sample_rtp(), &[]);
        let fake_sl: u16 = (bytes.len() as u16) + 100 - HEADER_LEN as u16;
        bytes[1] = (bytes[1] & 0xF0) | ((fake_sl >> 8) as u8 & 0x0F);
        bytes[2] = (fake_sl & 0xFF) as u8;
        assert!(matches!(
            MpeIfec::parse(&bytes).unwrap_err(),
            Error::SectionLengthOverflow { .. }
        ));
    }

    #[test]
    fn serialize_round_trip() {
        let ifec = [0xDEu8, 0xAD, 0xBE, 0xEF, 0x00];
        let original = MpeIfec {
            private_indicator: false,
            burst_number: 200,
            ifec_burst_size: 32,
            version: 31,
            current_next_indicator: false,
            section_number: 2,
            last_section_number: 4,
            real_time_parameters: sample_rtp(),
            ifec_data: &ifec,
        };
        let mut buf = vec![0u8; original.serialized_len()];
        original.serialize_into(&mut buf).unwrap();
        assert_eq!(MpeIfec::parse(&buf).unwrap(), original);
    }

    #[test]
    fn serialize_rejects_output_buffer_too_small() {
        let s = MpeIfec {
            private_indicator: false,
            burst_number: 0,
            ifec_burst_size: 0,
            version: 0,
            current_next_indicator: true,
            section_number: 0,
            last_section_number: 0,
            real_time_parameters: sample_rtp(),
            ifec_data: &[],
        };
        let mut buf = vec![0u8; 2];
        assert!(matches!(
            s.serialize_into(&mut buf).unwrap_err(),
            Error::OutputBufferTooSmall { .. }
        ));
    }

    #[test]
    fn table_trait_constants() {
        assert_eq!(<MpeIfec as Table>::TABLE_ID, 0x7A);
        assert_eq!(<MpeIfec as Table>::PID, 0x0000);
    }

    #[cfg(feature = "serde")]
    #[test]
    fn serde_json_serializes_fields() {
        // Serialize-only: assert serialization yields valid, field-bearing JSON.
        let ifec = [0x01u8, 0x02];
        let bytes = build_mpe_ifec(7, 8, 3, true, 0, 0, sample_rtp(), &ifec);
        let s = MpeIfec::parse(&bytes).unwrap();
        let v: serde_json::Value = serde_json::to_value(&s).unwrap();
        assert_eq!(v["burst_number"], 7);
        assert_eq!(v["ifec_burst_size"], 8);
        assert_eq!(v["version"], 3);
        assert_eq!(v["ifec_data"], serde_json::json!([0x01, 0x02]));
        assert_eq!(v["real_time_parameters"]["prev_burst_size"], 0x0001_2345);
        assert_eq!(v["real_time_parameters"]["mpe_boundary"], true);
    }
}