/* 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 https://mozilla.org/MPL/2.0/. */ use std::cell::Cell; use std::collections::HashMap; use std::rc::Rc; use dom_struct::dom_struct; use js::rust::HandleObject; use servo_media::streams::registry::MediaStreamId; use servo_media::streams::MediaStreamType; use servo_media::webrtc::{ BundlePolicy, DataChannelEvent, DataChannelId, DataChannelState, GatheringState, IceCandidate, IceConnectionState, SdpType, SessionDescription, SignalingState, WebRtcController, WebRtcSignaller, }; use servo_media::ServoMedia; use crate::dom::bindings::cell::DomRefCell; use crate::dom::bindings::codegen::Bindings::RTCDataChannelBinding::RTCDataChannelInit; use crate::dom::bindings::codegen::Bindings::RTCIceCandidateBinding::RTCIceCandidateInit; use crate::dom::bindings::codegen::Bindings::RTCPeerConnectionBinding::{ RTCAnswerOptions, RTCBundlePolicy, RTCConfiguration, RTCIceConnectionState, RTCIceGatheringState, RTCOfferOptions, RTCPeerConnectionMethods, RTCRtpTransceiverInit, RTCSignalingState, }; use crate::dom::bindings::codegen::Bindings::RTCSessionDescriptionBinding::{ RTCSdpType, RTCSessionDescriptionInit, }; use crate::dom::bindings::codegen::UnionTypes::{MediaStreamTrackOrString, StringOrStringSequence}; use crate::dom::bindings::error::{Error, Fallible}; use crate::dom::bindings::inheritance::Castable; use crate::dom::bindings::refcounted::{Trusted, TrustedPromise}; use crate::dom::bindings::reflector::{reflect_dom_object_with_proto, DomObject}; use crate::dom::bindings::root::{Dom, DomRoot, MutNullableDom}; use crate::dom::bindings::str::USVString; use crate::dom::event::{Event, EventBubbles, EventCancelable}; use crate::dom::eventtarget::EventTarget; use crate::dom::globalscope::GlobalScope; use crate::dom::mediastream::MediaStream; use crate::dom::mediastreamtrack::MediaStreamTrack; use crate::dom::promise::Promise; use crate::dom::rtcdatachannel::RTCDataChannel; use crate::dom::rtcdatachannelevent::RTCDataChannelEvent; use crate::dom::rtcicecandidate::RTCIceCandidate; use crate::dom::rtcpeerconnectioniceevent::RTCPeerConnectionIceEvent; use crate::dom::rtcrtptransceiver::RTCRtpTransceiver; use crate::dom::rtcsessiondescription::RTCSessionDescription; use crate::dom::rtctrackevent::RTCTrackEvent; use crate::dom::window::Window; use crate::realms::{enter_realm, InRealm}; use crate::task::TaskCanceller; use crate::task_source::networking::NetworkingTaskSource; use crate::task_source::TaskSource; #[dom_struct] pub struct RTCPeerConnection { eventtarget: EventTarget, #[ignore_malloc_size_of = "defined in servo-media"] #[no_trace] controller: DomRefCell>, closed: Cell, // Helps track state changes between the time createOffer/createAnswer // is called and resolved offer_answer_generation: Cell, #[ignore_malloc_size_of = "promises are hard"] offer_promises: DomRefCell>>, #[ignore_malloc_size_of = "promises are hard"] answer_promises: DomRefCell>>, local_description: MutNullableDom, remote_description: MutNullableDom, gathering_state: Cell, ice_connection_state: Cell, signaling_state: Cell, #[ignore_malloc_size_of = "defined in servo-media"] data_channels: DomRefCell>>, } struct RTCSignaller { trusted: Trusted, task_source: NetworkingTaskSource, canceller: TaskCanceller, } impl WebRtcSignaller for RTCSignaller { fn on_ice_candidate(&self, _: &WebRtcController, candidate: IceCandidate) { let this = self.trusted.clone(); let _ = self.task_source.queue_with_canceller( task!(on_ice_candidate: move || { let this = this.root(); this.on_ice_candidate(candidate); }), &self.canceller, ); } fn on_negotiation_needed(&self, _: &WebRtcController) { let this = self.trusted.clone(); let _ = self.task_source.queue_with_canceller( task!(on_negotiation_needed: move || { let this = this.root(); this.on_negotiation_needed(); }), &self.canceller, ); } fn update_gathering_state(&self, state: GatheringState) { let this = self.trusted.clone(); let _ = self.task_source.queue_with_canceller( task!(update_gathering_state: move || { let this = this.root(); this.update_gathering_state(state); }), &self.canceller, ); } fn update_ice_connection_state(&self, state: IceConnectionState) { let this = self.trusted.clone(); let _ = self.task_source.queue_with_canceller( task!(update_ice_connection_state: move || { let this = this.root(); this.update_ice_connection_state(state); }), &self.canceller, ); } fn update_signaling_state(&self, state: SignalingState) { let this = self.trusted.clone(); let _ = self.task_source.queue_with_canceller( task!(update_signaling_state: move || { let this = this.root(); this.update_signaling_state(state); }), &self.canceller, ); } fn on_add_stream(&self, id: &MediaStreamId, ty: MediaStreamType) { let this = self.trusted.clone(); let id = *id; let _ = self.task_source.queue_with_canceller( task!(on_add_stream: move || { let this = this.root(); this.on_add_stream(id, ty); }), &self.canceller, ); } fn on_data_channel_event( &self, channel: DataChannelId, event: DataChannelEvent, _: &WebRtcController, ) { // XXX(ferjm) get label and options from channel properties. let this = self.trusted.clone(); let _ = self.task_source.queue_with_canceller( task!(on_data_channel_event: move || { let this = this.root(); let global = this.global(); let _ac = enter_realm(&*global); this.on_data_channel_event(channel, event); }), &self.canceller, ); } fn close(&self) { // do nothing } } impl RTCPeerConnection { pub fn new_inherited() -> RTCPeerConnection { RTCPeerConnection { eventtarget: EventTarget::new_inherited(), controller: DomRefCell::new(None), closed: Cell::new(false), offer_answer_generation: Cell::new(0), offer_promises: DomRefCell::new(vec![]), answer_promises: DomRefCell::new(vec![]), local_description: Default::default(), remote_description: Default::default(), gathering_state: Cell::new(RTCIceGatheringState::New), ice_connection_state: Cell::new(RTCIceConnectionState::New), signaling_state: Cell::new(RTCSignalingState::Stable), data_channels: DomRefCell::new(HashMap::new()), } } fn new( global: &GlobalScope, proto: Option, config: &RTCConfiguration, ) -> DomRoot { let this = reflect_dom_object_with_proto( Box::new(RTCPeerConnection::new_inherited()), global, proto, ); let signaller = this.make_signaller(); *this.controller.borrow_mut() = Some(ServoMedia::get().unwrap().create_webrtc(signaller)); if let Some(ref servers) = config.iceServers { if let Some(server) = servers.get(0) { let server = match server.urls { StringOrStringSequence::String(ref s) => Some(s.clone()), StringOrStringSequence::StringSequence(ref s) => s.get(0).cloned(), }; if let Some(server) = server { let policy = match config.bundlePolicy { RTCBundlePolicy::Balanced => BundlePolicy::Balanced, RTCBundlePolicy::Max_compat => BundlePolicy::MaxCompat, RTCBundlePolicy::Max_bundle => BundlePolicy::MaxBundle, }; this.controller .borrow() .as_ref() .unwrap() .configure(server.to_string(), policy); } } } this } #[allow(non_snake_case)] pub fn Constructor( window: &Window, proto: Option, config: &RTCConfiguration, ) -> Fallible> { Ok(RTCPeerConnection::new(&window.global(), proto, config)) } pub fn get_webrtc_controller(&self) -> &DomRefCell> { &self.controller } fn make_signaller(&self) -> Box { let trusted = Trusted::new(self); let (task_source, canceller) = self .global() .as_window() .task_manager() .networking_task_source_with_canceller(); Box::new(RTCSignaller { trusted, task_source, canceller, }) } fn on_ice_candidate(&self, candidate: IceCandidate) { if self.closed.get() { return; } let candidate = RTCIceCandidate::new( &self.global(), candidate.candidate.into(), None, Some(candidate.sdp_mline_index as u16), None, ); let event = RTCPeerConnectionIceEvent::new( &self.global(), atom!("icecandidate"), Some(&candidate), None, true, ); event.upcast::().fire(self.upcast()); } fn on_negotiation_needed(&self) { if self.closed.get() { return; } let event = Event::new( &self.global(), atom!("negotiationneeded"), EventBubbles::DoesNotBubble, EventCancelable::NotCancelable, ); event.upcast::().fire(self.upcast()); } fn on_add_stream(&self, id: MediaStreamId, ty: MediaStreamType) { if self.closed.get() { return; } let track = MediaStreamTrack::new(&self.global(), id, ty); let event = RTCTrackEvent::new(&self.global(), atom!("track"), false, false, &track); event.upcast::().fire(self.upcast()); } fn on_data_channel_event(&self, channel_id: DataChannelId, event: DataChannelEvent) { if self.closed.get() { return; } match event { DataChannelEvent::NewChannel => { let channel = RTCDataChannel::new( &self.global(), self, USVString::from("".to_owned()), &RTCDataChannelInit::empty(), Some(channel_id), ); let event = RTCDataChannelEvent::new( &self.global(), atom!("datachannel"), false, false, &channel, ); event.upcast::().fire(self.upcast()); }, _ => { let channel = if let Some(channel) = self.data_channels.borrow().get(&channel_id) { DomRoot::from_ref(&**channel) } else { warn!( "Got an event for an unregistered data channel {:?}", channel_id ); return; }; match event { DataChannelEvent::Open => channel.on_open(), DataChannelEvent::Close => channel.on_close(), DataChannelEvent::Error(error) => channel.on_error(error), DataChannelEvent::OnMessage(message) => channel.on_message(message), DataChannelEvent::StateChange(state) => channel.on_state_change(state), DataChannelEvent::NewChannel => unreachable!(), } }, }; } pub fn register_data_channel(&self, id: DataChannelId, channel: &RTCDataChannel) { if self .data_channels .borrow_mut() .insert(id, Dom::from_ref(channel)) .is_some() { warn!("Data channel already registered {:?}", id); } } pub fn unregister_data_channel(&self, id: &DataChannelId) { self.data_channels.borrow_mut().remove(id); } /// fn update_gathering_state(&self, state: GatheringState) { // step 1 if self.closed.get() { return; } // step 2 (state derivation already done by gstreamer) let state: RTCIceGatheringState = state.into(); // step 3 if state == self.gathering_state.get() { return; } // step 4 self.gathering_state.set(state); // step 5 let event = Event::new( &self.global(), atom!("icegatheringstatechange"), EventBubbles::DoesNotBubble, EventCancelable::NotCancelable, ); event.upcast::().fire(self.upcast()); // step 6 if state == RTCIceGatheringState::Complete { let event = RTCPeerConnectionIceEvent::new( &self.global(), atom!("icecandidate"), None, None, true, ); event.upcast::().fire(self.upcast()); } } /// fn update_ice_connection_state(&self, state: IceConnectionState) { // step 1 if self.closed.get() { return; } // step 2 (state derivation already done by gstreamer) let state: RTCIceConnectionState = state.into(); // step 3 if state == self.ice_connection_state.get() { return; } // step 4 self.ice_connection_state.set(state); // step 5 let event = Event::new( &self.global(), atom!("iceconnectionstatechange"), EventBubbles::DoesNotBubble, EventCancelable::NotCancelable, ); event.upcast::().fire(self.upcast()); } fn update_signaling_state(&self, state: SignalingState) { if self.closed.get() { return; } let state: RTCSignalingState = state.into(); if state == self.signaling_state.get() { return; } self.signaling_state.set(state); let event = Event::new( &self.global(), atom!("signalingstatechange"), EventBubbles::DoesNotBubble, EventCancelable::NotCancelable, ); event.upcast::().fire(self.upcast()); } fn create_offer(&self) { let generation = self.offer_answer_generation.get(); let (task_source, canceller) = self .global() .as_window() .task_manager() .networking_task_source_with_canceller(); let this = Trusted::new(self); self.controller .borrow_mut() .as_ref() .unwrap() .create_offer(Box::new(move |desc: SessionDescription| { let _ = task_source.queue_with_canceller( task!(offer_created: move || { let this = this.root(); if this.offer_answer_generation.get() != generation { // the state has changed since we last created the offer, // create a fresh one this.create_offer(); } else { let init: RTCSessionDescriptionInit = desc.into(); for promise in this.offer_promises.borrow_mut().drain(..) { promise.resolve_native(&init); } } }), &canceller, ); })); } fn create_answer(&self) { let generation = self.offer_answer_generation.get(); let (task_source, canceller) = self .global() .as_window() .task_manager() .networking_task_source_with_canceller(); let this = Trusted::new(self); self.controller .borrow_mut() .as_ref() .unwrap() .create_answer(Box::new(move |desc: SessionDescription| { let _ = task_source.queue_with_canceller( task!(answer_created: move || { let this = this.root(); if this.offer_answer_generation.get() != generation { // the state has changed since we last created the offer, // create a fresh one this.create_answer(); } else { let init: RTCSessionDescriptionInit = desc.into(); for promise in this.answer_promises.borrow_mut().drain(..) { promise.resolve_native(&init); } } }), &canceller, ); })); } } impl RTCPeerConnectionMethods for RTCPeerConnection { // https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-icecandidate event_handler!(icecandidate, GetOnicecandidate, SetOnicecandidate); // https://www.w3.org/TR/webrtc/#dom-rtcpeerconnection-ontrack event_handler!(track, GetOntrack, SetOntrack); // https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-iceconnectionstatechange event_handler!( iceconnectionstatechange, GetOniceconnectionstatechange, SetOniceconnectionstatechange ); // https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-icegatheringstatechange event_handler!( icegatheringstatechange, GetOnicegatheringstatechange, SetOnicegatheringstatechange ); // https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-onnegotiationneeded event_handler!( negotiationneeded, GetOnnegotiationneeded, SetOnnegotiationneeded ); // https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-signalingstatechange event_handler!( signalingstatechange, GetOnsignalingstatechange, SetOnsignalingstatechange ); // https://www.w3.org/TR/webrtc/#dom-rtcpeerconnection-ondatachannel event_handler!(datachannel, GetOndatachannel, SetOndatachannel); /// fn AddIceCandidate(&self, candidate: &RTCIceCandidateInit, comp: InRealm) -> Rc { let p = Promise::new_in_current_realm(comp); if candidate.sdpMid.is_none() && candidate.sdpMLineIndex.is_none() { p.reject_error(Error::Type(format!( "one of sdpMid and sdpMLineIndex must be set" ))); return p; } // XXXManishearth add support for sdpMid if candidate.sdpMLineIndex.is_none() { p.reject_error(Error::Type( "servo only supports sdpMLineIndex right now".to_string(), )); return p; } // XXXManishearth this should be enqueued // https://w3c.github.io/webrtc-pc/#enqueue-an-operation self.controller .borrow_mut() .as_ref() .unwrap() .add_ice_candidate(IceCandidate { sdp_mline_index: candidate.sdpMLineIndex.unwrap() as u32, candidate: candidate.candidate.to_string(), }); // XXXManishearth add_ice_candidate should have a callback p.resolve_native(&()); p } /// fn CreateOffer(&self, _options: &RTCOfferOptions, comp: InRealm) -> Rc { let p = Promise::new_in_current_realm(comp); if self.closed.get() { p.reject_error(Error::InvalidState); return p; } self.offer_promises.borrow_mut().push(p.clone()); self.create_offer(); p } /// fn CreateAnswer(&self, _options: &RTCAnswerOptions, comp: InRealm) -> Rc { let p = Promise::new_in_current_realm(comp); if self.closed.get() { p.reject_error(Error::InvalidState); return p; } self.answer_promises.borrow_mut().push(p.clone()); self.create_answer(); p } /// fn GetLocalDescription(&self) -> Option> { self.local_description.get() } /// fn GetRemoteDescription(&self) -> Option> { self.remote_description.get() } /// fn SetLocalDescription(&self, desc: &RTCSessionDescriptionInit, comp: InRealm) -> Rc { // XXXManishearth validate the current state let p = Promise::new_in_current_realm(comp); let this = Trusted::new(self); let desc: SessionDescription = desc.into(); let trusted_promise = TrustedPromise::new(p.clone()); let (task_source, canceller) = self .global() .as_window() .task_manager() .networking_task_source_with_canceller(); self.controller .borrow_mut() .as_ref() .unwrap() .set_local_description( desc.clone(), Box::new(move || { let _ = task_source.queue_with_canceller( task!(local_description_set: move || { // XXXManishearth spec actually asks for an intricate // dance between pending/current local/remote descriptions let this = this.root(); let desc = desc.into(); let desc = RTCSessionDescription::Constructor( this.global().as_window(), None, &desc, ).unwrap(); this.local_description.set(Some(&desc)); trusted_promise.root().resolve_native(&()) }), &canceller, ); }), ); p } /// fn SetRemoteDescription(&self, desc: &RTCSessionDescriptionInit, comp: InRealm) -> Rc { // XXXManishearth validate the current state let p = Promise::new_in_current_realm(comp); let this = Trusted::new(self); let desc: SessionDescription = desc.into(); let trusted_promise = TrustedPromise::new(p.clone()); let (task_source, canceller) = self .global() .as_window() .task_manager() .networking_task_source_with_canceller(); self.controller .borrow_mut() .as_ref() .unwrap() .set_remote_description( desc.clone(), Box::new(move || { let _ = task_source.queue_with_canceller( task!(remote_description_set: move || { // XXXManishearth spec actually asks for an intricate // dance between pending/current local/remote descriptions let this = this.root(); let desc = desc.into(); let desc = RTCSessionDescription::Constructor( this.global().as_window(), None, &desc, ).unwrap(); this.remote_description.set(Some(&desc)); trusted_promise.root().resolve_native(&()) }), &canceller, ); }), ); p } // https://w3c.github.io/webrtc-pc/#legacy-interface-extensions fn AddStream(&self, stream: &MediaStream) { for track in &*stream.get_tracks() { self.controller .borrow() .as_ref() .unwrap() .add_stream(&track.id()); } } /// fn IceGatheringState(&self) -> RTCIceGatheringState { self.gathering_state.get() } /// fn IceConnectionState(&self) -> RTCIceConnectionState { self.ice_connection_state.get() } /// fn SignalingState(&self) -> RTCSignalingState { self.signaling_state.get() } /// fn Close(&self) { // Step 1 if self.closed.get() { return; } // Step 2 self.closed.set(true); // Step 4 self.signaling_state.set(RTCSignalingState::Closed); // Step 5 handled by backend self.controller.borrow_mut().as_ref().unwrap().quit(); // Step 6 for (_, val) in self.data_channels.borrow().iter() { val.on_state_change(DataChannelState::Closed); } // Step 7-10 // (no current support for transports, etc) // Step 11 self.ice_connection_state.set(RTCIceConnectionState::Closed); // Step 11 // (no current support for connection state) } /// fn CreateDataChannel( &self, label: USVString, init: &RTCDataChannelInit, ) -> DomRoot { RTCDataChannel::new(&self.global(), self, label, init, None) } /// fn AddTransceiver( &self, _track_or_kind: MediaStreamTrackOrString, init: &RTCRtpTransceiverInit, ) -> DomRoot { RTCRtpTransceiver::new(&self.global(), init.direction) } } impl From for RTCSessionDescriptionInit { fn from(desc: SessionDescription) -> Self { let type_ = match desc.type_ { SdpType::Answer => RTCSdpType::Answer, SdpType::Offer => RTCSdpType::Offer, SdpType::Pranswer => RTCSdpType::Pranswer, SdpType::Rollback => RTCSdpType::Rollback, }; RTCSessionDescriptionInit { type_, sdp: desc.sdp.into(), } } } impl<'a> From<&'a RTCSessionDescriptionInit> for SessionDescription { fn from(desc: &'a RTCSessionDescriptionInit) -> Self { let type_ = match desc.type_ { RTCSdpType::Answer => SdpType::Answer, RTCSdpType::Offer => SdpType::Offer, RTCSdpType::Pranswer => SdpType::Pranswer, RTCSdpType::Rollback => SdpType::Rollback, }; SessionDescription { type_, sdp: desc.sdp.to_string(), } } } impl From for RTCIceGatheringState { fn from(state: GatheringState) -> Self { match state { GatheringState::New => RTCIceGatheringState::New, GatheringState::Gathering => RTCIceGatheringState::Gathering, GatheringState::Complete => RTCIceGatheringState::Complete, } } } impl From for RTCIceConnectionState { fn from(state: IceConnectionState) -> Self { match state { IceConnectionState::New => RTCIceConnectionState::New, IceConnectionState::Checking => RTCIceConnectionState::Checking, IceConnectionState::Connected => RTCIceConnectionState::Connected, IceConnectionState::Completed => RTCIceConnectionState::Completed, IceConnectionState::Disconnected => RTCIceConnectionState::Disconnected, IceConnectionState::Failed => RTCIceConnectionState::Failed, IceConnectionState::Closed => RTCIceConnectionState::Closed, } } } impl From for RTCSignalingState { fn from(state: SignalingState) -> Self { match state { SignalingState::Stable => RTCSignalingState::Stable, SignalingState::HaveLocalOffer => RTCSignalingState::Have_local_offer, SignalingState::HaveRemoteOffer => RTCSignalingState::Have_remote_offer, SignalingState::HaveLocalPranswer => RTCSignalingState::Have_local_pranswer, SignalingState::HaveRemotePranswer => RTCSignalingState::Have_remote_pranswer, SignalingState::Closed => RTCSignalingState::Closed, } } }