script/dom/
mediastream.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use dom_struct::dom_struct;
6use js::rust::HandleObject;
7use servo_media::streams::MediaStreamType;
8use servo_media::streams::registry::MediaStreamId;
9
10use crate::dom::bindings::cell::{DomRefCell, Ref};
11use crate::dom::bindings::codegen::Bindings::MediaStreamBinding::MediaStreamMethods;
12use crate::dom::bindings::error::Fallible;
13use crate::dom::bindings::reflector::{DomGlobal, reflect_dom_object_with_proto};
14use crate::dom::bindings::root::{Dom, DomRoot};
15use crate::dom::bindings::str::DOMString;
16use crate::dom::eventtarget::EventTarget;
17use crate::dom::globalscope::GlobalScope;
18use crate::dom::mediastreamtrack::MediaStreamTrack;
19use crate::dom::window::Window;
20use crate::script_runtime::CanGc;
21
22#[dom_struct]
23pub(crate) struct MediaStream {
24    eventtarget: EventTarget,
25    tracks: DomRefCell<Vec<Dom<MediaStreamTrack>>>,
26}
27
28impl MediaStream {
29    pub(crate) fn new_inherited() -> MediaStream {
30        MediaStream {
31            eventtarget: EventTarget::new_inherited(),
32            tracks: DomRefCell::new(vec![]),
33        }
34    }
35
36    pub(crate) fn new(global: &GlobalScope, can_gc: CanGc) -> DomRoot<MediaStream> {
37        Self::new_with_proto(global, None, can_gc)
38    }
39
40    fn new_with_proto(
41        global: &GlobalScope,
42        proto: Option<HandleObject>,
43        can_gc: CanGc,
44    ) -> DomRoot<MediaStream> {
45        reflect_dom_object_with_proto(
46            Box::new(MediaStream::new_inherited()),
47            global,
48            proto,
49            can_gc,
50        )
51    }
52
53    pub(crate) fn new_single(
54        global: &GlobalScope,
55        id: MediaStreamId,
56        ty: MediaStreamType,
57        can_gc: CanGc,
58    ) -> DomRoot<MediaStream> {
59        let this = Self::new(global, can_gc);
60        let track = MediaStreamTrack::new(global, id, ty, can_gc);
61        this.AddTrack(&track);
62        this
63    }
64
65    pub(crate) fn get_tracks(&self) -> Ref<'_, [Dom<MediaStreamTrack>]> {
66        Ref::map(self.tracks.borrow(), |tracks| &**tracks)
67    }
68
69    pub(crate) fn add_track(&self, track: &MediaStreamTrack) {
70        self.tracks.borrow_mut().push(Dom::from_ref(track))
71    }
72}
73
74impl MediaStreamMethods<crate::DomTypeHolder> for MediaStream {
75    /// <https://w3c.github.io/mediacapture-main/#dom-mediastream-constructor>
76    fn Constructor(
77        global: &Window,
78        proto: Option<HandleObject>,
79        can_gc: CanGc,
80    ) -> Fallible<DomRoot<MediaStream>> {
81        Ok(MediaStream::new_with_proto(&global.global(), proto, can_gc))
82    }
83
84    /// <https://w3c.github.io/mediacapture-main/#dom-mediastream-constructor>
85    fn Constructor_(
86        _: &Window,
87        proto: Option<HandleObject>,
88        can_gc: CanGc,
89        stream: &MediaStream,
90    ) -> Fallible<DomRoot<MediaStream>> {
91        Ok(stream.clone_with_proto(proto, can_gc))
92    }
93
94    /// <https://w3c.github.io/mediacapture-main/#dom-mediastream-constructor>
95    fn Constructor__(
96        global: &Window,
97        proto: Option<HandleObject>,
98        can_gc: CanGc,
99        tracks: Vec<DomRoot<MediaStreamTrack>>,
100    ) -> Fallible<DomRoot<MediaStream>> {
101        let new = MediaStream::new_with_proto(&global.global(), proto, can_gc);
102        for track in tracks {
103            // this is quadratic, but shouldn't matter much
104            // if this becomes a problem we can use a hash map
105            new.AddTrack(&track)
106        }
107        Ok(new)
108    }
109
110    /// <https://w3c.github.io/mediacapture-main/#dom-mediastream-gettracks>
111    fn GetTracks(&self) -> Vec<DomRoot<MediaStreamTrack>> {
112        self.tracks
113            .borrow()
114            .iter()
115            .map(|x| DomRoot::from_ref(&**x))
116            .collect()
117    }
118
119    /// <https://w3c.github.io/mediacapture-main/#dom-mediastream-getaudiotracks>
120    fn GetAudioTracks(&self) -> Vec<DomRoot<MediaStreamTrack>> {
121        self.tracks
122            .borrow()
123            .iter()
124            .filter(|x| x.ty() == MediaStreamType::Audio)
125            .map(|x| DomRoot::from_ref(&**x))
126            .collect()
127    }
128
129    /// <https://w3c.github.io/mediacapture-main/#dom-mediastream-getvideotracks>
130    fn GetVideoTracks(&self) -> Vec<DomRoot<MediaStreamTrack>> {
131        self.tracks
132            .borrow()
133            .iter()
134            .filter(|x| x.ty() == MediaStreamType::Video)
135            .map(|x| DomRoot::from_ref(&**x))
136            .collect()
137    }
138
139    /// <https://w3c.github.io/mediacapture-main/#dom-mediastream-gettrackbyid>
140    fn GetTrackById(&self, id: DOMString) -> Option<DomRoot<MediaStreamTrack>> {
141        self.tracks
142            .borrow()
143            .iter()
144            .find(|x| x.id().id().to_string() == *id)
145            .map(|x| DomRoot::from_ref(&**x))
146    }
147
148    /// <https://w3c.github.io/mediacapture-main/#dom-mediastream-addtrack>
149    fn AddTrack(&self, track: &MediaStreamTrack) {
150        let existing = self.tracks.borrow().iter().any(|x| x == &track);
151
152        if existing {
153            return;
154        }
155        self.add_track(track)
156    }
157
158    /// <https://w3c.github.io/mediacapture-main/#dom-mediastream-removetrack>
159    fn RemoveTrack(&self, track: &MediaStreamTrack) {
160        self.tracks.borrow_mut().retain(|x| *x != track);
161    }
162
163    /// <https://w3c.github.io/mediacapture-main/#dom-mediastream-clone>
164    fn Clone(&self, can_gc: CanGc) -> DomRoot<MediaStream> {
165        self.clone_with_proto(None, can_gc)
166    }
167}
168
169impl MediaStream {
170    fn clone_with_proto(&self, proto: Option<HandleObject>, can_gc: CanGc) -> DomRoot<MediaStream> {
171        let new = MediaStream::new_with_proto(&self.global(), proto, can_gc);
172        for track in &*self.tracks.borrow() {
173            new.add_track(track)
174        }
175        new
176    }
177}