Make RTCRtpTransceiver (Sender, Receiver) spec-compliant (#377)

Author: rogurotus

examples/examples/broadcast/broadcast.rs

@@ -115,7 +115,7 @@ async fn main() -> Result<()> {
 
     // Allow us to receive 1 video track
     peer_connection
-        .add_transceiver_from_kind(RTPCodecType::Video, &[])
+        .add_transceiver_from_kind(RTPCodecType::Video, None)
         .await?;
 
     let (local_track_chan_tx, mut local_track_chan_rx) =

examples/examples/rtp-forwarder/rtp-forwarder.rs

@@ -137,10 +137,10 @@ async fn main() -> Result<()> {
 
     // Allow us to receive 1 audio track, and 1 video track
     peer_connection
-        .add_transceiver_from_kind(RTPCodecType::Audio, &[])
+        .add_transceiver_from_kind(RTPCodecType::Audio, None)
         .await?;
     peer_connection
-        .add_transceiver_from_kind(RTPCodecType::Video, &[])
+        .add_transceiver_from_kind(RTPCodecType::Video, None)
         .await?;
 
     // Prepare udp conns

examples/examples/save-to-disk-h264/save-to-disk-h264.rs

@@ -191,10 +191,10 @@ async fn main() -> Result<()> {
 
     // Allow us to receive 1 audio track, and 1 video track
     peer_connection
-        .add_transceiver_from_kind(RTPCodecType::Audio, &[])
+        .add_transceiver_from_kind(RTPCodecType::Audio, None)
         .await?;
     peer_connection
-        .add_transceiver_from_kind(RTPCodecType::Video, &[])
+        .add_transceiver_from_kind(RTPCodecType::Video, None)
         .await?;
 
     let notify_tx = Arc::new(Notify::new());

examples/examples/save-to-disk-vpx/save-to-disk-vpx.rs

@@ -216,10 +216,10 @@ async fn main() -> Result<()> {
 
     // Allow us to receive 1 audio track, and 1 video track
     peer_connection
-        .add_transceiver_from_kind(RTPCodecType::Audio, &[])
+        .add_transceiver_from_kind(RTPCodecType::Audio, None)
         .await?;
     peer_connection
-        .add_transceiver_from_kind(RTPCodecType::Video, &[])
+        .add_transceiver_from_kind(RTPCodecType::Video, None)
         .await?;
 
     let notify_tx = Arc::new(Notify::new());

webrtc/CHANGELOG.md

@@ -11,6 +11,24 @@
 
 * Change `RTCPeerConnection::on_track` callback signature to `|track: Arc<TrackRemote>, receiver: Arc<RTCRtpReceiver>, transceiver: Arc<RTCRtpTransceiver>|` [#355](https://github.com/webrtc-rs/webrtc/pull/355).
 
+* Change `RTCRtpSender::new` signature to `|receive_mtu: usize, track: Option<Arc<dyn TrackLocal + Send + Sync>>, transport: Arc<RTCDtlsTransport>, media_engine: Arc<MediaEngine>, interceptor: Arc<dyn Interceptor + Send + Sync>, start_paused: bool,|` [#377](https://github.com/webrtc-rs/webrtc/pull/377).
+
+* Change `API::new_rtp_sender` signature to `|&self, track: Option<Arc<dyn TrackLocal + Send + Sync>>, transport: Arc<RTCDtlsTransport>, interceptor: Arc<dyn Interceptor + Send + Sync>,|` [#377](https://github.com/webrtc-rs/webrtc/pull/377).
+
+* Change `RTCRtpTransceiver::sender` signature to `|&self| -> Arc<RTCRtpSender>` [#377](https://github.com/webrtc-rs/webrtc/pull/377).
+
+* Change `RTCRtpTransceiver::set_sender_track` signature to `|self: &Arc<Self>, sender: Arc<RTCRtpSender>, track: Option<Arc<dyn TrackLocal + Send + Sync>>,|` [#377](https://github.com/webrtc-rs/webrtc/pull/377).
+
+* Change `RTCRtpTransceiver::set_sender` signature to `|self: &Arc<Self>, s: Arc<RTCRtpSender>|` [#377](https://github.com/webrtc-rs/webrtc/pull/377).
+
+* Change `RTCRtpTransceiver::receiver` signature to `|&self| -> Arc<RTCRtpReceiver>` [#377](https://github.com/webrtc-rs/webrtc/pull/377).
+
+* Change `RTCRtpTransceiver::set_receiver` signature to `|&self, r: Arc<RTCRtpReceiver>|` [#377](https://github.com/webrtc-rs/webrtc/pull/377).
+
+* Change `RTCPeerConnection::add_transceiver_from_kind` signature to `|&self, kind: RTPCodecType, init: Option<RTCRtpTransceiverInit>,|`, `RTCRtpTransceiver::RTCRtpSender` сreated without a track [#377](https://github.com/webrtc-rs/webrtc/pull/377).
+
+* Change `RTCPeerConnection::add_transceiver_from_track` signature to `|&self, track: Arc<dyn TrackLocal + Send + Sync>, init: Option<RTCRtpTransceiverInit>,|` [#377](https://github.com/webrtc-rs/webrtc/pull/377).
+
 * Change `RTCPeerConnection::mid` return signature to `Option<String>` [#375](https://github.com/webrtc-rs/webrtc/pull/375).
 
 ## v0.6.0

webrtc/src/api/media_engine/media_engine_test.rs

@@ -12,7 +12,7 @@ async fn test_opus_case() -> Result<()> {
     let api = APIBuilder::new().with_media_engine(m).build();
 
     let pc = api.new_peer_connection(RTCConfiguration::default()).await?;
-    pc.add_transceiver_from_kind(RTPCodecType::Audio, &[])
+    pc.add_transceiver_from_kind(RTPCodecType::Audio, None)
         .await?;
 
     let offer = pc.create_offer(None).await?;
@@ -32,7 +32,7 @@ async fn test_video_case() -> Result<()> {
     let api = APIBuilder::new().with_media_engine(m).build();
 
     let pc = api.new_peer_connection(RTCConfiguration::default()).await?;
-    pc.add_transceiver_from_kind(RTPCodecType::Video, &[])
+    pc.add_transceiver_from_kind(RTPCodecType::Video, None)
         .await?;
 
     let offer = pc.create_offer(None).await?;

webrtc/src/api/mod.rs

@@ -154,7 +154,7 @@ impl API {
     /// new_rtp_sender constructs a new RTPSender
     pub async fn new_rtp_sender(
         &self,
-        track: Arc<dyn TrackLocal + Send + Sync>,
+        track: Option<Arc<dyn TrackLocal + Send + Sync>>,
         transport: Arc<RTCDtlsTransport>,
         interceptor: Arc<dyn Interceptor + Send + Sync>,
     ) -> RTCRtpSender {

webrtc/src/api/setting_engine/setting_engine_test.rs

@@ -161,7 +161,7 @@ async fn test_setting_engine_set_disable_media_engine_copy() -> Result<()> {
         let (mut offerer, mut answerer) = new_pair(&api).await?;
 
         offerer
-            .add_transceiver_from_kind(RTPCodecType::Video, &[])
+            .add_transceiver_from_kind(RTPCodecType::Video, None)
             .await?;
 
         signal_pair(&mut offerer, &mut answerer).await?;
@@ -244,7 +244,7 @@ async fn test_setting_engine_set_disable_media_engine_copy() -> Result<()> {
         let (mut offerer, mut answerer) = new_pair(&api).await?;
 
         offerer
-            .add_transceiver_from_kind(RTPCodecType::Video, &[])
+            .add_transceiver_from_kind(RTPCodecType::Video, None)
             .await?;
 
         signal_pair(&mut offerer, &mut answerer).await?;

webrtc/src/peer_connection/mod.rs

@@ -64,7 +64,6 @@ use crate::sctp_transport::sctp_transport_capabilities::SCTPTransportCapabilitie
 use crate::sctp_transport::sctp_transport_state::RTCSctpTransportState;
 use crate::sctp_transport::RTCSctpTransport;
 use crate::stats::StatsReport;
-use crate::track::track_local::track_local_static_sample::TrackLocalStaticSample;
 use crate::track::track_local::TrackLocal;
 use crate::track::track_remote::TrackRemote;
 
@@ -470,17 +469,7 @@ impl RTCPeerConnection {
                                 None => return true, // doesn't contain a single a=msid line
                             };
 
-                            let sender = match t.sender().await {
-                                Some(s) => s.clone(),
-                                None => {
-                                    log::warn!(
-                                        "RtpSender missing for transeceiver with sending direction {} for mid {:?}",
-                                        t.direction(),
-                                        mid
-                                    );
-                                    continue;
-                                }
-                            };
+                            let sender = t.sender().await;
                             // (...)or the number of MSIDs from the a=msid lines in this m= section,
                             // or the MSID values themselves, differ from what is in
                             // transceiver.sender.[[AssociatedMediaStreamIds]], return true.
@@ -1372,23 +1361,38 @@ impl RTCPeerConnection {
                                 t.set_mid(mid_value.to_owned())?;
                             }
                         } else {
+                            let local_direction =
+                                if direction == RTCRtpTransceiverDirection::Recvonly {
+                                    RTCRtpTransceiverDirection::Sendonly
+                                } else {
+                                    RTCRtpTransceiverDirection::Recvonly
+                                };
+
+                            let receive_mtu = self.internal.setting_engine.get_receive_mtu();
+
                             let receiver = Arc::new(RTCRtpReceiver::new(
-                                self.internal.setting_engine.get_receive_mtu(),
+                                receive_mtu,
                                 kind,
                                 Arc::clone(&self.internal.dtls_transport),
                                 Arc::clone(&self.internal.media_engine),
                                 Arc::clone(&self.interceptor),
                             ));
 
-                            let local_direction =
-                                if direction == RTCRtpTransceiverDirection::Recvonly {
-                                    RTCRtpTransceiverDirection::Sendonly
-                                } else {
-                                    RTCRtpTransceiverDirection::Recvonly
-                                };
+                            let sender = Arc::new(
+                                RTCRtpSender::new(
+                                    receive_mtu,
+                                    None,
+                                    Arc::clone(&self.internal.dtls_transport),
+                                    Arc::clone(&self.internal.media_engine),
+                                    Arc::clone(&self.interceptor),
+                                    false,
+                                )
+                                .await,
+                            );
+
                             let t = RTCRtpTransceiver::new(
-                                Some(receiver),
-                                None,
+                                receiver,
+                                sender,
                                 local_direction,
                                 kind,
                                 vec![],
@@ -1581,10 +1585,9 @@ impl RTCPeerConnection {
     pub(crate) async fn start_rtp_senders(&self) -> Result<()> {
         let current_transceivers = self.internal.rtp_transceivers.lock().await;
         for transceiver in &*current_transceivers {
-            if let Some(sender) = transceiver.sender().await {
-                if sender.is_negotiated() && !sender.has_sent().await {
-                    sender.send(&sender.get_parameters().await).await?;
-                }
+            let sender = transceiver.sender().await;
+            if sender.is_negotiated() && !sender.has_sent().await {
+                sender.send(&sender.get_parameters().await).await?;
             }
         }
 
@@ -1640,9 +1643,8 @@ impl RTCPeerConnection {
         let mut senders = vec![];
         let rtp_transceivers = self.internal.rtp_transceivers.lock().await;
         for transceiver in &*rtp_transceivers {
-            if let Some(sender) = transceiver.sender().await {
-                senders.push(sender);
-            }
+            let sender = transceiver.sender().await;
+            senders.push(sender);
         }
         senders
     }
@@ -1652,9 +1654,7 @@ impl RTCPeerConnection {
         let mut receivers = vec![];
         let rtp_transceivers = self.internal.rtp_transceivers.lock().await;
         for transceiver in &*rtp_transceivers {
-            if let Some(receiver) = transceiver.receiver().await {
-                receivers.push(receiver);
-            }
+            receivers.push(transceiver.receiver().await);
         }
         receivers
     }
@@ -1677,34 +1677,22 @@ impl RTCPeerConnection {
         {
             let rtp_transceivers = self.internal.rtp_transceivers.lock().await;
             for t in &*rtp_transceivers {
-                if !t.stopped.load(Ordering::SeqCst)
-                    && t.kind == track.kind()
-                    && t.sender().await.is_none()
-                {
-                    let sender = Arc::new(
-                        RTCRtpSender::new(
-                            self.internal.setting_engine.get_receive_mtu(),
-                            Arc::clone(&track),
-                            Arc::clone(&self.internal.dtls_transport),
-                            Arc::clone(&self.internal.media_engine),
-                            Arc::clone(&self.interceptor),
-                            false, // adding a track sets a send direction.
-                        )
-                        .await,
-                    );
-
-                    if let Err(err) = t
-                        .set_sender_track(Some(Arc::clone(&sender)), Some(Arc::clone(&track)))
-                        .await
-                    {
-                        let _ = sender.stop().await;
-                        t.set_sender(None).await;
-                        return Err(err);
-                    }
+                if !t.stopped.load(Ordering::SeqCst) && t.kind == track.kind() {
+                    let sender = t.sender().await;
+                    if sender.track().await.is_none() {
+                        if let Err(err) = sender.replace_track(Some(track)).await {
+                            let _ = sender.stop().await;
+                            return Err(err);
+                        }
 
-                    self.internal.trigger_negotiation_needed().await;
+                        t.set_direction_internal(RTCRtpTransceiverDirection::from_send_recv(
+                            true,
+                            t.direction().has_recv(),
+                        ));
 
-                    return Ok(sender);
+                        self.internal.trigger_negotiation_needed().await;
+                        return Ok(sender);
+                    }
                 }
             }
         }
@@ -1717,10 +1705,7 @@ impl RTCPeerConnection {
             .add_rtp_transceiver(Arc::clone(&transceiver))
             .await;
 
-        match transceiver.sender().await {
-            Some(sender) => Ok(sender),
-            None => Err(Error::ErrRTPSenderNil),
-        }
+        Ok(transceiver.sender().await)
     }
 
     /// remove_track removes a Track from the PeerConnection
@@ -1733,11 +1718,12 @@ impl RTCPeerConnection {
         {
             let rtp_transceivers = self.internal.rtp_transceivers.lock().await;
             for t in &*rtp_transceivers {
-                if let Some(s) = t.sender().await {
-                    if s.id == sender.id {
-                        transceiver = Some(t.clone());
-                        break;
+                if t.sender().await.id == sender.id {
+                    if sender.track().await.is_none() {
+                        return Ok(());
                     }
+                    transceiver = Some(t.clone());
+                    break;
                 }
             }
         }
@@ -1766,26 +1752,24 @@ impl RTCPeerConnection {
     pub async fn add_transceiver_from_kind(
         &self,
         kind: RTPCodecType,
-        init: &[RTCRtpTransceiverInit],
+        init: Option<RTCRtpTransceiverInit>,
     ) -> Result<Arc<RTCRtpTransceiver>> {
         self.internal.add_transceiver_from_kind(kind, init).await
     }
 
     /// add_transceiver_from_track Create a new RtpTransceiver(SendRecv or SendOnly) and add it to the set of transceivers.
-    pub async fn add_transceiver_from_track<'a>(
-        &'a self,
+    pub async fn add_transceiver_from_track(
+        &self,
         track: Arc<dyn TrackLocal + Send + Sync>,
-        init: &'a [RTCRtpTransceiverInit],
+        init: Option<RTCRtpTransceiverInit>,
     ) -> Result<Arc<RTCRtpTransceiver>> {
         if self.internal.is_closed.load(Ordering::SeqCst) {
             return Err(Error::ErrConnectionClosed);
         }
 
-        let direction = match init.len() {
-            0 => RTCRtpTransceiverDirection::Sendrecv,
-            1 => init[0].direction,
-            _ => return Err(Error::ErrPeerConnAddTransceiverFromTrackOnlyAcceptsOne),
-        };
+        let direction = init
+            .map(|init| init.direction)
+            .unwrap_or(RTCRtpTransceiverDirection::Sendrecv);
 
         let t = self
             .internal