Documentation fixes

packet/src/buffer_rx.rs

@@ -32,6 +32,7 @@ struct Entry {
 }
 
 impl RtpMeta {
+    #[doc(hidden)]
     pub fn new(received: Instant, time: MediaTime, seq_no: SeqNo, header: RtpHeader) -> Self {
         RtpMeta {
             received,

rtp/src/ext.rs

@@ -695,11 +695,16 @@ impl fmt::Debug for Extensions {
     }
 }
 
+/// How the video is rotated.
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum VideoOrientation {
+    /// Not rotated.
     Deg0 = 0,
+    /// 90 degress clockwise.
     Deg90 = 3,
+    /// Upside down.
     Deg180 = 2,
+    /// 90 degrees counter clockwise.
     Deg270 = 1,
 }
 

rtp/src/header.rs

@@ -3,6 +3,7 @@
 use crate::ext::{ExtensionValues, Extensions};
 use crate::{Pt, SeqNo, Ssrc};
 
+/// Parsed header from an RTP packet.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct RtpHeader {
     pub version: u8,
@@ -20,6 +21,7 @@ pub struct RtpHeader {
 }
 
 impl RtpHeader {
+    #[doc(hidden)]
     pub fn write_to(&self, buf: &mut [u8], exts: &Extensions) -> usize {
         buf[0] = 0b10_0_0_0000
             | if self.has_padding { 1 << 5 } else { 0 }
@@ -51,6 +53,7 @@ impl RtpHeader {
         16 + ext_len
     }
 
+    #[doc(hidden)]
     pub fn pad_packet(
         buf: &mut [u8],
         header_len: usize,
@@ -76,6 +79,7 @@ impl RtpHeader {
         pad
     }
 
+    #[doc(hidden)]
     pub fn parse(buf: &[u8], exts: &Extensions) -> Option<RtpHeader> {
         let orig_len = buf.len();
         if buf.len() < 12 {
@@ -182,25 +186,29 @@ impl RtpHeader {
     }
 
     /// For RTX the original sequence number is inserted before the RTP payload.
+    #[doc(hidden)]
     pub fn read_original_sequence_number(buf: &[u8], seq_no: &mut u16) -> usize {
         *seq_no = u16::from_be_bytes([buf[0], buf[1]]);
         2
     }
 
     /// For RTX the original sequence number is inserted before the RTP payload.
+    #[doc(hidden)]
     pub fn write_original_sequence_number(buf: &mut [u8], seq_no: SeqNo) -> usize {
         let seq_u16 = (*seq_no) as u16;
         buf[0..2].copy_from_slice(&seq_u16.to_be_bytes());
         2
     }
 
+    #[doc(hidden)]
     pub fn is_rtx_null_packet(buf: &[u8]) -> bool {
         buf[0..10] == [0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
     }
 
     /// Sequencer number of this RTP header given the previous number.
     ///
     /// The logic detects wrap-arounds of the 16-bit RTP sequence number.
+    #[doc(hidden)]
     pub fn sequence_number(&self, previous: Option<SeqNo>) -> SeqNo {
         let e_seq = extend_seq(previous.map(|v| *v), self.sequence_number);
         e_seq.into()

str0m/Cargo.toml

@@ -12,8 +12,8 @@ serde = "1"
 #
 dtls = { path = "../dtls", package = "str0m-dtls", version = "0.0.1" }
 ice = { path = "../ice", package = "str0m-ice", version = "0.0.1" }
-net_ = { package = "str0m-net", path = "../net", version = "0.0.1" }
-rtp = { path = "../rtp", package = "str0m-rtp", version = "0.0.1" }
+net_ = { path = "../net", package = "str0m-net", pversion = "0.0.1" }
+rtp_ = { path = "../rtp", package = "str0m-rtp", version = "0.0.1" }
 sdp = { path = "../sdp", package = "str0m-sdp", version = "0.0.1" }
 packet = { path = "../packet", package = "str0m-packet", version = "0.0.1" }
 sctp = { path = "../sctp", package = "str0m-sctp", version = "0.0.1" }

str0m/src/change.rs

@@ -1,7 +1,7 @@
 use std::ops::Deref;
 
 use net_::Id;
-use rtp::{ChannelId, Direction, Extensions, Mid, Ssrc};
+use rtp_::{ChannelId, Direction, Extensions, Mid, Ssrc};
 use sctp::{DcepOpen, ReliabilityType};
 use sdp::{MediaLine, Msid, Offer};
 

str0m/src/channel.rs

@@ -2,7 +2,7 @@
 
 use std::fmt;
 
-pub use rtp::ChannelId;
+pub use rtp_::ChannelId;
 
 use crate::{Rtc, RtcError};
 

str0m/src/lib.rs

@@ -66,7 +66,7 @@ use dtls::{Dtls, DtlsEvent, Fingerprint};
 use ice::IceAgent;
 use ice::IceAgentEvent;
 use net_::DatagramRecv;
-use rtp::InstantExt;
+use rtp_::{InstantExt, Ssrc};
 use sctp::{RtcSctp, SctpEvent};
 use sdp::{Sdp, Setup};
 use stats::{MediaEgressStats, MediaIngressStats, PeerStats, Stats, StatsEvent};
@@ -88,7 +88,7 @@ pub mod error {
     pub use ice::IceError;
     pub use net_::NetError;
     pub use packet::PacketError;
-    pub use rtp::RtpError;
+    pub use rtp_::RtpError;
     pub use sctp::{ProtoError, SctpError};
     pub use sdp::SdpError;
 }
@@ -99,7 +99,7 @@ use channel::{Channel, ChannelData, ChannelId};
 pub mod media;
 use media::{CodecConfig, Direction, KeyframeRequest, Media};
 use media::{KeyframeRequestKind, MediaChanged, MediaData};
-use media::{MLine, MediaAdded, Mid, Pt, Rid, Ssrc};
+use media::{MLine, MediaAdded, Mid, Pt, Rid};
 
 mod change;
 pub use change::ChangeSet;

str0m/src/media/app.rs

@@ -1,4 +1,4 @@
-use rtp::Mid;
+use rtp_::Mid;
 use sdp::MediaLine;
 
 /// m=application m-line. There can only be one of these in the SDP.

str0m/src/media/codec.rs

@@ -2,7 +2,7 @@ use std::collections::HashMap;
 
 use sdp::{CodecSpec, PayloadParams as SdpPayloadParams};
 
-use rtp::Pt;
+use rtp_::Pt;
 use sdp::{Codec, FormatParams};
 
 use super::MediaKind;

str0m/src/media/event.rs

@@ -1,7 +1,7 @@
 use std::time::Instant;
 
-pub use packet::RtpMeta;
-pub use rtp::{Direction, ExtensionValues, MediaTime, Mid, Pt, Rid, Ssrc};
+use packet::RtpMeta;
+use rtp_::{Direction, ExtensionValues, MediaTime, Mid, Pt, Rid};
 pub use sdp::{Codec, FormatParams};
 
 use sdp::Simulcast as SdpSimulcast;

str0m/src/media/mline.rs

@@ -3,12 +3,12 @@ use std::time::{Duration, Instant};
 
 use net_::{Id, DATAGRAM_MTU};
 use packet::{DepacketizingBuffer, Packetized, PacketizedMeta, PacketizingBuffer};
-use rtp::{Extensions, Fir, FirEntry, NackEntry, Pli, Rtcp};
-use rtp::{RtcpFb, RtpHeader, SdesType};
-use rtp::{SeqNo, SRTP_BLOCK_SIZE, SRTP_OVERHEAD};
+use rtp_::{Extensions, Fir, FirEntry, NackEntry, Pli, Rtcp};
+use rtp_::{RtcpFb, RtpHeader, SdesType};
+use rtp_::{SeqNo, SRTP_BLOCK_SIZE, SRTP_OVERHEAD};
 
 pub use packet::RtpMeta;
-pub use rtp::{Direction, ExtensionValues, MediaTime, Mid, Pt, Rid, Ssrc};
+pub use rtp_::{Direction, ExtensionValues, MediaTime, Mid, Pt, Rid, Ssrc};
 pub use sdp::{Codec, FormatParams};
 
 use sdp::{MediaLine, MediaType, Msid, Simulcast as SdpSimulcast};

str0m/src/media/mod.rs

@@ -2,10 +2,9 @@
 
 use std::time::Instant;
 
-use rtp::VideoOrientation;
+pub use rtp_::VideoOrientation;
 
-pub use packet::RtpMeta;
-pub use rtp::{Direction, ExtensionValues, MediaTime, Mid, Pt, Rid, Ssrc};
+pub use rtp_::{Direction, ExtensionValues, MediaTime, Mid, Pt, Rid};
 pub use sdp::{Codec, FormatParams};
 
 use crate::{Rtc, RtcError};
@@ -28,6 +27,12 @@ mod register;
 mod mline;
 pub(crate) use mline::{MLine, Source};
 
+/// Half internal structures regarding RTP level.
+pub mod rtp {
+    pub use packet::RtpMeta;
+    pub use rtp_::{ExtensionValues, RtpHeader, SeqNo, Ssrc};
+}
+
 /// Audio or video media. An m-line in the SDP.
 ///
 /// Instances of [`Media`] are obtained via [`Rtc::media()`][crate::Rtc::media()]. The instance

str0m/src/media/receiver.rs

@@ -1,6 +1,6 @@
 use std::time::Instant;
 
-use rtp::{
+use rtp_::{
     DlrrItem, ExtendedReport, InstantExt, MediaTime, Mid, Nack, ReceiverReport, ReportBlock,
     ReportList, Rid, Rrtr, RtpHeader, SenderInfo, SeqNo, Ssrc,
 };

str0m/src/media/register.rs

@@ -1,6 +1,6 @@
 use std::time::Instant;
 
-use rtp::{Nack, NackEntry, ReceptionReport, ReportList, SeqNo};
+use rtp_::{Nack, NackEntry, ReceptionReport, ReportList, SeqNo};
 
 const MAX_DROPOUT: u64 = 3000;
 const MAX_MISORDER: u64 = 100;

str0m/src/media/sender.rs

@@ -1,10 +1,10 @@
 use std::time::Instant;
 
-use rtp::{
+use rtp_::{
     extend_seq, Descriptions, InstantExt, MediaTime, Mid, ReceptionReport, ReportList, Rid, Sdes,
     SdesType, SenderInfo,
 };
-use rtp::{SenderReport, SeqNo, Ssrc};
+use rtp_::{SenderReport, SeqNo, Ssrc};
 
 use crate::{
     stats::{MediaEgressStats, StatsSnapshot},
@@ -218,7 +218,7 @@ impl SenderSource {
         }
     }
 
-    pub fn update_clocks(&mut self, rtp_time: rtp::MediaTime, wallclock: Instant) {
+    pub fn update_clocks(&mut self, rtp_time: MediaTime, wallclock: Instant) {
         self.rtp_and_wallclock = Some((rtp_time, wallclock));
     }
 }

str0m/src/session.rs

@@ -4,10 +4,10 @@ use std::time::{Duration, Instant};
 use dtls::KeyingMaterial;
 use net_::{DatagramSend, DATAGRAM_MTU, DATAGRAM_MTU_WARN};
 use packet::RtpMeta;
-use rtp::SRTCP_OVERHEAD;
-use rtp::{extend_seq, RtpHeader, SessionId, TwccRecvRegister, TwccSendRegister};
-use rtp::{Extensions, MediaTime, Mid, Rtcp, RtcpFb};
-use rtp::{SrtpContext, SrtpKey, Ssrc};
+use rtp_::SRTCP_OVERHEAD;
+use rtp_::{extend_seq, RtpHeader, SessionId, TwccRecvRegister, TwccSendRegister};
+use rtp_::{Extensions, MediaTime, Mid, Rtcp, RtcpFb};
+use rtp_::{SrtpContext, SrtpKey, Ssrc};
 
 use crate::media::{App, CodecConfig, MediaAdded, MediaChanged, Source};
 use crate::session_sdp::AsMediaLine;

str0m/src/session_sdp.rs

@@ -1,6 +1,6 @@
 use dtls::Fingerprint;
 use ice::{Candidate, IceCreds};
-use rtp::{Extension, Mid};
+use rtp_::{Extension, Mid};
 use sdp::{Answer, MediaAttribute, MediaLine, MediaType, SimulcastGroups, SimulcastOption};
 use sdp::{Offer, Proto, Sdp, SessionAttribute, Setup};
 

str0m/src/stats.rs

@@ -6,7 +6,7 @@ use std::{
 };
 
 use crate::Mid;
-use rtp::Rid;
+use rtp_::Rid;
 
 pub(crate) struct Stats {
     last_now: Instant,