add rle

Author: Rain Liu

src/extended_report/mod.rs

@@ -2,8 +2,8 @@
 mod extended_report_test;
 
 pub mod dlrr;
-pub mod prt; /*
-             pub mod rle;
+pub mod prt;
+pub mod rle; /*
              pub mod rrt;
              pub mod ssr;
              pub mod vm;*/

src/extended_report/prt.rs

@@ -1,6 +1,6 @@
 use super::*;
 
-const PACKET_RECEIPT_TIMES_REPORT_BLOCK_MIN_LENGTH: u16 = 9;
+const PRT_REPORT_BLOCK_MIN_LENGTH: u16 = 9;
 
 /// PacketReceiptTimesReportBlock represents a Packet Receipt Times
 /// report block, as described in RFC 3611 section 4.3.
@@ -58,9 +58,7 @@ impl Packet for PacketReceiptTimesReportBlock {
     }
 
     fn raw_size(&self) -> usize {
-        XR_HEADER_LENGTH
-            + PACKET_RECEIPT_TIMES_REPORT_BLOCK_MIN_LENGTH as usize
-            + self.receipt_time.len() * 4
+        XR_HEADER_LENGTH + PRT_REPORT_BLOCK_MIN_LENGTH as usize + self.receipt_time.len() * 4
     }
 
     fn as_any(&self) -> &(dyn Any + Send + Sync) {
@@ -119,8 +117,8 @@ impl Unmarshal for PacketReceiptTimesReportBlock {
 
         let xr_header = XRHeader::unmarshal(raw_packet)?;
 
-        if xr_header.block_length < PACKET_RECEIPT_TIMES_REPORT_BLOCK_MIN_LENGTH
-            || (xr_header.block_length - PACKET_RECEIPT_TIMES_REPORT_BLOCK_MIN_LENGTH) % 4 != 0
+        if xr_header.block_length < PRT_REPORT_BLOCK_MIN_LENGTH
+            || (xr_header.block_length - PRT_REPORT_BLOCK_MIN_LENGTH) % 4 != 0
             || raw_packet.remaining() < xr_header.block_length as usize
         {
             return Err(error::Error::PacketTooShort.into());
@@ -131,7 +129,7 @@ impl Unmarshal for PacketReceiptTimesReportBlock {
         let begin_seq = raw_packet.get_u16();
         let end_seq = raw_packet.get_u16();
 
-        let remaining = xr_header.block_length - PACKET_RECEIPT_TIMES_REPORT_BLOCK_MIN_LENGTH;
+        let remaining = xr_header.block_length - PRT_REPORT_BLOCK_MIN_LENGTH;
         let mut receipt_time = vec![];
         for _ in 0..remaining / 4 {
             receipt_time.push(raw_packet.get_u32());

src/extended_report/rle.rs

@@ -1,5 +1,7 @@
 use super::*;
 
+const RLE_REPORT_BLOCK_MIN_LENGTH: u16 = 9;
+
 /// ChunkType enumerates the three kinds of chunks described in RFC 3611 section 4.1.
 #[derive(Debug, Copy, Clone, PartialEq)]
 pub enum ChunkType {
@@ -46,7 +48,6 @@ impl fmt::Display for Chunk {
             }
             ChunkType::BitVector => write!(f, "[BitVector {:#b}", self.value()),
             ChunkType::TerminatingNull => write!(f, "[TerminatingNull]"),
-            //_ => write!(f, "[{:#x}]", self.0),
         }
     }
 }
@@ -78,7 +79,6 @@ impl Chunk {
             ChunkType::RunLength => self.0 & 0x3FFF,
             ChunkType::BitVector => self.0 & 0x7FFF,
             ChunkType::TerminatingNull => 0,
-            //_ => self.0,
         }
     }
 }
@@ -103,107 +103,141 @@ impl Chunk {
 /// |          chunk n-1            |             chunk n           |
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 #[derive(Debug, Default, PartialEq, Clone)]
-pub struct RleReportBlock {
-    pub xr_header: XRHeader,
+pub struct RLEReportBlock {
+    pub is_loss_rle: bool,
     pub t: u8,
     pub ssrc: u32,
     pub begin_seq: u16,
     pub end_seq: u16,
     pub chunks: Vec<Chunk>,
 }
 
-impl RleReportBlock {
-    fn raw_size(&self) -> usize {
-        4 + 1 + 4 + 2 + 2 + self.chunks.len() * 2
-    }
-}
-
 /// LossRLEReportBlock is used to report information about packet
 /// losses, as described in RFC 3611, section 4.1
-#[derive(Debug, Default, PartialEq, Clone)]
-pub struct LossRLEReportBlock(pub RleReportBlock);
+/// make sure to set is_loss_rle = true
+pub type LossRLEReportBlock = RLEReportBlock;
 
-impl fmt::Display for LossRLEReportBlock {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{:?}", self)
+/// DuplicateRLEReportBlock is used to report information about packet
+/// duplication, as described in RFC 3611, section 4.1
+/// make sure to set is_loss_rle = false
+pub type DuplicateRLEReportBlock = RLEReportBlock;
+
+impl RLEReportBlock {
+    pub fn xr_header(&self) -> XRHeader {
+        XRHeader {
+            block_type: if self.is_loss_rle {
+                BlockType::LossRLE
+            } else {
+                BlockType::DuplicateRLE
+            },
+            type_specific: self.t & 0x0F,
+            block_length: (self.raw_size() / 4 - 1) as u16,
+        }
     }
 }
 
-impl ReportBlock for LossRLEReportBlock {
-    /// destination_ssrc returns an array of ssrc values that this report block refers to.
-    fn destination_ssrc(&self) -> Vec<u32> {
-        vec![self.0.ssrc]
+impl fmt::Display for RLEReportBlock {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "{:?}", self)
     }
+}
 
-    fn setup_block_header(&mut self) {
-        self.0.xr_header.block_type = ReportBlockType::LossRLE;
-        self.0.xr_header.type_specific = self.0.t & 0x0F;
-        self.0.xr_header.block_length = (self.0.raw_size() / 4 - 1) as u16;
+impl Packet for RLEReportBlock {
+    fn header(&self) -> Header {
+        Header::default()
     }
 
-    fn unpack_block_header(&mut self) {
-        self.0.t = (self.0.xr_header.type_specific) & 0x0F;
+    /// destination_ssrc returns an array of ssrc values that this report block refers to.
+    fn destination_ssrc(&self) -> Vec<u32> {
+        vec![self.ssrc]
     }
 
     fn raw_size(&self) -> usize {
-        self.0.raw_size()
+        XR_HEADER_LENGTH + RLE_REPORT_BLOCK_MIN_LENGTH as usize + self.chunks.len() * 2
     }
 
     fn as_any(&self) -> &(dyn Any + Send + Sync) {
         self
     }
-    fn equal(&self, other: &(dyn ReportBlock + Send + Sync)) -> bool {
+    fn equal(&self, other: &(dyn Packet + Send + Sync)) -> bool {
         other
             .as_any()
-            .downcast_ref::<LossRLEReportBlock>()
+            .downcast_ref::<RLEReportBlock>()
             .map_or(false, |a| self == a)
     }
-    fn cloned(&self) -> Box<dyn ReportBlock + Send + Sync> {
+    fn cloned(&self) -> Box<dyn Packet + Send + Sync> {
         Box::new(self.clone())
     }
 }
 
-/// DuplicateRLEReportBlock is used to report information about packet
-/// duplication, as described in RFC 3611, section 4.1
-#[derive(Debug, Default, PartialEq, Clone)]
-pub struct DuplicateRLEReportBlock(pub RleReportBlock);
-
-impl fmt::Display for DuplicateRLEReportBlock {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{:?}", self)
+impl MarshalSize for RLEReportBlock {
+    fn marshal_size(&self) -> usize {
+        self.raw_size()
     }
 }
 
-impl ReportBlock for DuplicateRLEReportBlock {
-    /// destination_ssrc returns an array of ssrc values that this report block refers to.
-    fn destination_ssrc(&self) -> Vec<u32> {
-        vec![self.0.ssrc]
-    }
+impl Marshal for RLEReportBlock {
+    /// marshal_to encodes the RleReportBlock in binary
+    fn marshal_to(&self, mut buf: &mut [u8]) -> Result<usize> {
+        if buf.remaining_mut() < self.marshal_size() {
+            return Err(error::Error::BufferTooShort.into());
+        }
 
-    fn setup_block_header(&mut self) {
-        self.0.xr_header.block_type = ReportBlockType::DuplicateRLE;
-        self.0.xr_header.type_specific = self.0.t & 0x0F;
-        self.0.xr_header.block_length = (self.0.raw_size() / 4 - 1) as u16;
-    }
+        let h = self.xr_header();
+        let n = h.marshal_to(buf)?;
+        buf = &mut buf[n..];
 
-    fn unpack_block_header(&mut self) {
-        self.0.t = (self.0.xr_header.type_specific) & 0x0F;
-    }
+        buf.put_u8(self.t);
+        buf.put_u32(self.ssrc);
+        buf.put_u16(self.begin_seq);
+        buf.put_u16(self.end_seq);
+        for chunk in &self.chunks {
+            buf.put_u16(chunk.0);
+        }
 
-    fn raw_size(&self) -> usize {
-        self.0.raw_size()
+        Ok(self.marshal_size())
     }
+}
 
-    fn as_any(&self) -> &(dyn Any + Send + Sync) {
-        self
-    }
-    fn equal(&self, other: &(dyn ReportBlock + Send + Sync)) -> bool {
-        other
-            .as_any()
-            .downcast_ref::<DuplicateRLEReportBlock>()
-            .map_or(false, |a| self == a)
-    }
-    fn cloned(&self) -> Box<dyn ReportBlock + Send + Sync> {
-        Box::new(self.clone())
+impl Unmarshal for RLEReportBlock {
+    /// Unmarshal decodes the RleReportBlock from binary
+    fn unmarshal<B>(raw_packet: &mut B) -> Result<Self>
+    where
+        Self: Sized,
+        B: Buf,
+    {
+        if raw_packet.remaining() < XR_HEADER_LENGTH {
+            return Err(error::Error::PacketTooShort.into());
+        }
+
+        let xr_header = XRHeader::unmarshal(raw_packet)?;
+
+        if xr_header.block_length < RLE_REPORT_BLOCK_MIN_LENGTH
+            || (xr_header.block_length - RLE_REPORT_BLOCK_MIN_LENGTH) % 2 != 0
+            || raw_packet.remaining() < xr_header.block_length as usize
+        {
+            return Err(error::Error::PacketTooShort.into());
+        }
+
+        let is_loss_rle = xr_header.block_type == BlockType::LossRLE;
+        let t = raw_packet.get_u8();
+        let ssrc = raw_packet.get_u32();
+        let begin_seq = raw_packet.get_u16();
+        let end_seq = raw_packet.get_u16();
+
+        let remaining = xr_header.block_length - RLE_REPORT_BLOCK_MIN_LENGTH;
+        let mut chunks = vec![];
+        for _ in 0..remaining / 2 {
+            chunks.push(Chunk(raw_packet.get_u16()));
+        }
+
+        Ok(RLEReportBlock {
+            is_loss_rle,
+            t,
+            ssrc,
+            begin_seq,
+            end_seq,
+            chunks,
+        })
     }
 }