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