script/dom/media/
videotracklist.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 script_bindings::cell::DomRefCell;
7use script_bindings::reflector::reflect_dom_object;
8
9use crate::dom::bindings::codegen::Bindings::VideoTrackListBinding::VideoTrackListMethods;
10use crate::dom::bindings::inheritance::Castable;
11use crate::dom::bindings::refcounted::Trusted;
12use crate::dom::bindings::reflector::DomGlobal;
13use crate::dom::bindings::root::{Dom, DomRoot};
14use crate::dom::bindings::str::DOMString;
15use crate::dom::eventtarget::EventTarget;
16use crate::dom::html::htmlmediaelement::HTMLMediaElement;
17use crate::dom::videotrack::VideoTrack;
18use crate::dom::window::Window;
19use crate::script_runtime::CanGc;
20
21#[dom_struct]
22pub(crate) struct VideoTrackList {
23    eventtarget: EventTarget,
24    tracks: DomRefCell<Vec<Dom<VideoTrack>>>,
25    media_element: Option<Dom<HTMLMediaElement>>,
26}
27
28impl VideoTrackList {
29    pub(crate) fn new_inherited(
30        tracks: &[&VideoTrack],
31        media_element: Option<&HTMLMediaElement>,
32    ) -> VideoTrackList {
33        VideoTrackList {
34            eventtarget: EventTarget::new_inherited(),
35            tracks: DomRefCell::new(tracks.iter().map(|track| Dom::from_ref(&**track)).collect()),
36            media_element: media_element.map(Dom::from_ref),
37        }
38    }
39
40    pub(crate) fn new(
41        window: &Window,
42        tracks: &[&VideoTrack],
43        media_element: Option<&HTMLMediaElement>,
44        can_gc: CanGc,
45    ) -> DomRoot<VideoTrackList> {
46        reflect_dom_object(
47            Box::new(VideoTrackList::new_inherited(tracks, media_element)),
48            window,
49            can_gc,
50        )
51    }
52
53    pub(crate) fn len(&self) -> usize {
54        self.tracks.borrow().len()
55    }
56
57    pub(crate) fn find(&self, track: &VideoTrack) -> Option<usize> {
58        self.tracks.borrow().iter().position(|t| &**t == track)
59    }
60
61    pub(crate) fn item(&self, idx: usize) -> Option<DomRoot<VideoTrack>> {
62        self.tracks
63            .borrow()
64            .get(idx)
65            .map(|track| DomRoot::from_ref(&**track))
66    }
67
68    pub(crate) fn selected_index(&self) -> Option<usize> {
69        self.tracks
70            .borrow()
71            .iter()
72            .position(|track| track.selected())
73    }
74
75    pub(crate) fn set_selected(&self, idx: usize, value: bool) {
76        let track = match self.item(idx) {
77            Some(t) => t,
78            None => return,
79        };
80
81        // If the chosen tracks selected status is the same as the new status, return early.
82        if track.selected() == value {
83            return;
84        }
85
86        if let Some(current) = self.selected_index() {
87            self.tracks.borrow()[current].set_selected(false);
88        }
89
90        track.set_selected(value);
91        if let Some(media_element) = self.media_element.as_ref() {
92            media_element.set_video_track(idx, value);
93        }
94
95        let this = Trusted::new(self);
96        self.global()
97            .task_manager()
98            .media_element_task_source()
99            .queue(task!(media_track_change: move |cx| {
100                let this = this.root();
101                this.upcast::<EventTarget>().fire_event(cx, atom!("change"));
102            }));
103    }
104
105    pub(crate) fn add(&self, track: &VideoTrack) {
106        self.tracks.borrow_mut().push(Dom::from_ref(track));
107        if track.selected() &&
108            let Some(idx) = self.selected_index()
109        {
110            self.set_selected(idx, false);
111        }
112        track.add_track_list(self);
113    }
114
115    pub(crate) fn clear(&self) {
116        self.tracks
117            .borrow()
118            .iter()
119            .for_each(|t| t.remove_track_list());
120        self.tracks.borrow_mut().clear();
121    }
122}
123
124impl VideoTrackListMethods<crate::DomTypeHolder> for VideoTrackList {
125    /// <https://html.spec.whatwg.org/multipage/#dom-videotracklist-length>
126    fn Length(&self) -> u32 {
127        self.len() as u32
128    }
129
130    /// <https://html.spec.whatwg.org/multipage/#dom-tracklist-item>
131    fn IndexedGetter(&self, idx: u32) -> Option<DomRoot<VideoTrack>> {
132        self.item(idx as usize)
133    }
134
135    /// <https://html.spec.whatwg.org/multipage/#dom-videotracklist-gettrackbyid>
136    fn GetTrackById(&self, id: DOMString) -> Option<DomRoot<VideoTrack>> {
137        self.tracks
138            .borrow()
139            .iter()
140            .find(|track| track.id() == id)
141            .map(|track| DomRoot::from_ref(&**track))
142    }
143
144    /// <https://html.spec.whatwg.org/multipage/#dom-videotrack-selected>
145    fn SelectedIndex(&self) -> i32 {
146        if let Some(idx) = self.selected_index() {
147            return idx as i32;
148        }
149        -1
150    }
151
152    // https://html.spec.whatwg.org/multipage/#handler-tracklist-onchange
153    event_handler!(change, GetOnchange, SetOnchange);
154
155    // https://html.spec.whatwg.org/multipage/#handler-tracklist-onaddtrack
156    event_handler!(addtrack, GetOnaddtrack, SetOnaddtrack);
157
158    // https://html.spec.whatwg.org/multipage/#handler-tracklist-onremovetrack
159    event_handler!(removetrack, GetOnremovetrack, SetOnremovetrack);
160}
script/dom/media/videotracklist.rs

script/dom/media/
videotracklist.rs
