1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
//! Implementation of the `MediaTrack` with a `Recv` direction.
mod component;
use std::cell::{Cell, RefCell};
use futures::channel::mpsc;
use medea_client_api_proto as proto;
use proto::{ConnectionMode, TrackId};
use crate::{
media::{
track::remote, MediaDirection, MediaKind, RecvConstraints,
TrackConstraints,
},
peer::{
media::media_exchange_state, MediaConnections, MediaStateControllable,
PeerEvent, TrackEvent,
},
platform, utils,
};
use super::TransceiverSide;
#[doc(inline)]
pub use self::component::{Component, State};
/// Representation of a [`remote::Track`] that is being received from some
/// remote peer. It may have two states: `waiting` and `receiving`.
///
/// We can save related [`platform::Transceiver`] and the actual
/// [`remote::Track`] only when [`remote::Track`] data arrives.
#[derive(Debug)]
pub struct Receiver {
/// ID of this [`remote::Track`].
track_id: TrackId,
/// Indicator whether this [`Receiver`] is working in a [P2P mesh] or [SFU]
/// mode.
///
/// [P2P mesh]: https://webrtcglossary.com/mesh
/// [SFU]: https://webrtcglossary.com/sfu
connection_mode: ConnectionMode,
/// Constraints of this [`remote::Track`].
caps: TrackConstraints,
/// ID of the member sending this [`remote::Track`].
sender_id: proto::MemberId,
/// [`Transceiver`] associated with this [`remote::Track`].
///
/// [`Transceiver`]: platform::Transceiver
transceiver: RefCell<Option<platform::Transceiver>>,
/// [MID] of the associated [`Transceiver`].
///
/// [`Transceiver`]: platform::Transceiver
/// [MID]: https://w3.org/TR/webrtc#dom-rtptransceiver-mid
mid: RefCell<Option<String>>,
/// Actual [`remote::Track`] represented by this [`Receiver`].
track: RefCell<Option<remote::Track>>,
/// Indicator whether the actual [`remote::Track`] is updated with the
/// current [`Receiver`]'s state.
is_track_notified: Cell<bool>,
/// Indicator whether this [`remote::Track`] is enabled generally.
enabled_general: Cell<bool>,
/// Indicator whether this [`remote::Track`] is enabled individually.
enabled_individual: Cell<bool>,
/// Current general [`MediaDirection`] of this [`Receiver`].
media_direction: Cell<MediaDirection>,
/// Indicator whether this [`remote::Track`] is muted.
muted: Cell<bool>,
/// Channel for sending [`PeerEvent`]s to the remote peer.
peer_events_sender: mpsc::UnboundedSender<PeerEvent>,
/// Channel for sending [`TrackEvent`]s to the actual [`remote::Track`].
track_events_sender: mpsc::UnboundedSender<TrackEvent>,
}
impl Receiver {
/// Creates a new [`platform::Transceiver`] if provided `mid` is [`None`],
/// otherwise creates a [`Receiver`] without a [`platform::Transceiver`]. It
/// will be injected when a [`remote::Track`] will arrive.
///
/// Created [`platform::Transceiver`] direction is set to
/// [`TransceiverDirection::INACTIVE`][1] if `enabled_individual` is
/// `false`.
///
/// `track` field in the created [`Receiver`] will be `None`, since
/// [`Receiver`] must be created before the actual [`remote::Track`] data
/// arrives.
///
/// [1]: platform::TransceiverDirection::INACTIVE
pub async fn new(
state: &State,
media_connections: &MediaConnections,
track_events_sender: mpsc::UnboundedSender<TrackEvent>,
recv_constraints: &RecvConstraints,
connection_mode: ConnectionMode,
) -> Self {
let caps = TrackConstraints::from(state.media_type());
let kind = MediaKind::from(&caps);
#[allow(clippy::if_then_some_else_none)]
let transceiver = if state.mid().is_none() {
// Try to find send transceiver that can be used as `sendrecv`.
let sender = media_connections
.0
.borrow()
.senders
.values()
.find(|sndr| {
sndr.caps().media_kind() == caps.media_kind()
&& sndr.caps().media_source_kind()
== caps.media_source_kind()
})
.map(utils::component::Component::obj);
let trnsvr = if let Some(s) = sender {
s.transceiver()
} else {
let new_transceiver =
media_connections.0.borrow().add_transceiver(
kind,
platform::TransceiverDirection::INACTIVE,
);
new_transceiver.await
};
trnsvr
.set_recv(match connection_mode {
ConnectionMode::Mesh => state.enabled_individual(),
ConnectionMode::Sfu => true,
})
.await;
Some(trnsvr)
} else {
None
};
let peer_events_sender =
media_connections.0.borrow().peer_events_sender.clone();
let this = Self {
track_id: state.track_id(),
connection_mode,
caps,
sender_id: state.sender_id().clone(),
transceiver: RefCell::new(transceiver),
mid: RefCell::new(state.mid().map(ToString::to_string)),
track: RefCell::new(None),
is_track_notified: Cell::new(false),
peer_events_sender,
enabled_general: Cell::new(state.enabled_individual()),
enabled_individual: Cell::new(state.enabled_general()),
muted: Cell::new(state.muted()),
media_direction: Cell::new(state.media_direction()),
track_events_sender,
};
let enabled_in_cons = match &state.media_type() {
proto::MediaType::Audio(_) => recv_constraints.is_audio_enabled(),
proto::MediaType::Video(_) => {
recv_constraints.is_video_device_enabled()
|| recv_constraints.is_video_display_enabled()
}
};
if !enabled_in_cons {
state
.media_exchange_state_controller()
.transition_to(enabled_in_cons.into());
}
this
}
/// Returns [`TrackConstraints`] of this [`Receiver`].
#[must_use]
pub const fn caps(&self) -> &TrackConstraints {
&self.caps
}
/// Returns [`mid`] of this [`Receiver`].
///
/// [`mid`]: https://w3.org/TR/webrtc/#dom-rtptransceiver-mid
#[must_use]
pub fn mid(&self) -> Option<String> {
if self.mid.borrow().is_none() && self.transceiver.borrow().is_some() {
if let Some(transceiver) =
self.transceiver.borrow().as_ref().cloned()
{
drop(self.mid.replace(Some(transceiver.mid()?)));
}
}
self.mid.borrow().clone()
}
/// Indicates whether this [`Receiver`] receives media data.
pub async fn is_receiving(&self) -> bool {
let transceiver = self.transceiver.borrow().clone();
let is_recv_direction = if let Some(trcv) = transceiver {
trcv.has_direction(platform::TransceiverDirection::RECV)
.await
} else {
false
};
self.enabled_individual.get() && is_recv_direction
}
/// Sends [`TrackEvent::MediaExchangeIntention`] with the provided
/// [`media_exchange_state`].
pub fn send_media_exchange_state_intention(
&self,
state: media_exchange_state::Transition,
) {
_ = self.track_events_sender.unbounded_send(
TrackEvent::MediaExchangeIntention {
id: self.track_id,
enabled: matches!(
state,
media_exchange_state::Transition::Enabling(_)
),
},
);
}
/// Adds the provided [`platform::MediaStreamTrack`] and
/// [`platform::Transceiver`] to this [`Receiver`].
///
/// Sets [`platform::MediaStreamTrack::enabled`] same as
/// `enabled_individual` of this [`Receiver`].
pub async fn set_remote_track(
&self,
transceiver: platform::Transceiver,
new_track: platform::MediaStreamTrack,
) {
if let Some(old_track) = self.track.borrow().as_ref() {
if old_track.id() == new_track.id() {
return;
}
}
self.set_transceiver(transceiver);
let new_track = remote::Track::new(
new_track,
self.caps.media_source_kind(),
self.muted.get(),
self.media_direction.get(),
);
// It's OK to `.clone()` here, as the `Transceiver` represents a pointer
// to a garbage-collectable memory on each platform.
let trnscvr = self.transceiver.borrow().as_ref().cloned();
if let Some(t) = trnscvr {
t.set_recv(match self.connection_mode {
ConnectionMode::Mesh => self.enabled_individual.get(),
ConnectionMode::Sfu => true,
})
.await;
}
if let Some(prev_track) = self.track.replace(Some(new_track)) {
prev_track.stop().await;
};
self.maybe_notify_track().await;
}
/// Updates [`MediaDirection`] of this [`Receiver`].
pub fn set_media_direction(&self, direction: MediaDirection) {
self.media_direction.set(direction);
if let Some(track) = self.track.borrow().as_ref().cloned() {
track.set_media_direction(direction);
}
}
/// Replaces [`Receiver`]'s [`platform::Transceiver`] with the provided
/// [`platform::Transceiver`].
///
/// Doesn't update [`platform::TransceiverDirection`] of the
/// [`platform::Transceiver`].
///
/// No-op if provided with the same [`platform::Transceiver`] as already
/// exists in this [`Receiver`].
pub fn set_transceiver(&self, transceiver: platform::Transceiver) {
if self.transceiver.borrow().is_none()
&& self.mid.borrow().as_ref() == transceiver.mid().as_ref()
{
drop(self.transceiver.replace(Some(transceiver)));
}
}
/// Returns a [`platform::Transceiver`] of this [`Receiver`].
///
/// Returns [`None`] if this [`Receiver`] doesn't have a
/// [`platform::Transceiver`].
pub fn transceiver(&self) -> Option<platform::Transceiver> {
self.transceiver.borrow().clone()
}
/// Emits [`PeerEvent::NewRemoteTrack`] if [`Receiver`] is receiving media
/// and has not notified yet.
async fn maybe_notify_track(&self) {
if self.is_track_notified.get() {
return;
}
if !self.is_receiving().await {
return;
}
if let Some(track) = self.track.borrow().as_ref() {
drop(self.peer_events_sender.unbounded_send(
PeerEvent::NewRemoteTrack {
sender_id: self.sender_id.clone(),
track: track.clone(),
},
));
self.is_track_notified.set(true);
}
}
}
#[cfg(feature = "mockable")]
#[allow(clippy::multiple_inherent_impl)]
impl Receiver {
/// Returns the current `enabled_general` status of this [`Receiver`].
#[must_use]
pub fn enabled_general(&self) -> bool {
self.enabled_general.get()
}
/// Returns the current `media_direction` status of this [`Receiver`].
#[must_use]
pub fn direction(&self) -> MediaDirection {
self.media_direction.get()
}
}
impl Drop for Receiver {
fn drop(&mut self) {
let transceiver = self.transceiver.borrow_mut().take();
if let Some(transceiver) = transceiver {
platform::spawn(async move {
if !transceiver.is_stopped() {
transceiver.set_recv(false).await;
}
});
}
if let Some(recv_track) = self.track.borrow_mut().take() {
platform::spawn(recv_track.stop());
}
}
}