script/dom/webvtt/
texttracklist.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::context::JSContext;
7use script_bindings::cell::DomRefCell;
8use script_bindings::reflector::reflect_dom_object_with_cx;
9
10use crate::dom::bindings::codegen::Bindings::TextTrackBinding::{TextTrackKind, TextTrackMethods};
11use crate::dom::bindings::codegen::Bindings::TextTrackListBinding::TextTrackListMethods;
12use crate::dom::bindings::codegen::UnionTypes::VideoTrackOrAudioTrackOrTextTrack;
13use crate::dom::bindings::inheritance::Castable;
14use crate::dom::bindings::refcounted::Trusted;
15use crate::dom::bindings::reflector::DomGlobal;
16use crate::dom::bindings::root::{Dom, DomRoot};
17use crate::dom::bindings::str::DOMString;
18use crate::dom::event::Event;
19use crate::dom::eventtarget::EventTarget;
20use crate::dom::html::htmlmediaelement::HTMLMediaElement;
21use crate::dom::texttrack::TextTrack;
22use crate::dom::trackevent::TrackEvent;
23use crate::dom::window::Window;
24
25#[dom_struct]
26pub(crate) struct TextTrackList {
27    eventtarget: EventTarget,
28    dom_tracks: DomRefCell<Vec<Dom<TextTrack>>>,
29}
30
31impl TextTrackList {
32    pub(crate) fn new_inherited(tracks: &[&TextTrack]) -> TextTrackList {
33        TextTrackList {
34            eventtarget: EventTarget::new_inherited(),
35            dom_tracks: DomRefCell::new(tracks.iter().map(|g| Dom::from_ref(&**g)).collect()),
36        }
37    }
38
39    pub(crate) fn new(
40        cx: &mut JSContext,
41        window: &Window,
42        tracks: &[&TextTrack],
43    ) -> DomRoot<TextTrackList> {
44        reflect_dom_object_with_cx(Box::new(TextTrackList::new_inherited(tracks)), window, cx)
45    }
46
47    pub(crate) fn item(&self, idx: usize) -> Option<DomRoot<TextTrack>> {
48        self.dom_tracks
49            .borrow()
50            .get(idx)
51            .map(|t| DomRoot::from_ref(&**t))
52    }
53
54    pub(crate) fn find(&self, track: &TextTrack) -> Option<usize> {
55        self.dom_tracks
56            .borrow()
57            .iter()
58            .enumerate()
59            .find(|(_, t)| **t == track)
60            .map(|(i, _)| i)
61    }
62
63    pub(crate) fn tracks_for_kinds(
64        &self,
65        text_track_kinds: Vec<TextTrackKind>,
66    ) -> Vec<DomRoot<TextTrack>> {
67        self.dom_tracks
68            .borrow()
69            .iter()
70            .filter(|track| text_track_kinds.contains(&track.Kind()))
71            .map(|track| DomRoot::from_ref(&**track))
72            .collect()
73    }
74
75    pub(crate) fn add(&self, media_element: &HTMLMediaElement, track: &TextTrack) {
76        // Only add a track if it does not exist in the list
77        if self.find(track).is_some() {
78            return;
79        }
80        self.dom_tracks.borrow_mut().push(Dom::from_ref(track));
81
82        track.add_track_list(self);
83        media_element.was_added_to_list_of_text_tracks();
84
85        let this = Trusted::new(self);
86        let track = Trusted::new(track);
87        self.global()
88            .task_manager()
89            .media_element_task_source()
90            .queue(task!(track_event_queue: move |cx| {
91                let this = this.root();
92                let track = track.root();
93
94                let event = TrackEvent::new(
95                    cx,
96                    this.global().as_window(),
97                    atom!("addtrack"),
98                    false,
99                    false,
100                    &Some(VideoTrackOrAudioTrackOrTextTrack::TextTrack(
101                        DomRoot::from_ref(&track)
102                    )),
103                );
104
105                event.upcast::<Event>().fire(cx, this.upcast::<EventTarget>());
106            }));
107    }
108
109    pub(crate) fn remove(&self, track: &TextTrack) {
110        let Some(idx) = self.find(track) else {
111            return;
112        };
113        self.dom_tracks.borrow_mut().remove(idx);
114        track.remove_track_list();
115
116        let this = Trusted::new(self);
117        let track = Trusted::new(track);
118        self.global()
119            .task_manager()
120            .media_element_task_source()
121            .queue(task!(track_event_queue: move |cx| {
122                let this = this.root();
123                let track = track.root();
124
125                let event = TrackEvent::new(
126                    cx,
127                    this.global().as_window(),
128                    atom!("removetrack"),
129                    false,
130                    false,
131                    &Some(VideoTrackOrAudioTrackOrTextTrack::TextTrack(
132                        DomRoot::from_ref(&track)
133                    )),
134                );
135
136                event.upcast::<Event>().fire(cx, this.upcast::<EventTarget>());
137            }));
138    }
139}
140
141impl TextTrackListMethods<crate::DomTypeHolder> for TextTrackList {
142    /// <https://html.spec.whatwg.org/multipage/#dom-texttracklist-length>
143    fn Length(&self) -> u32 {
144        self.dom_tracks.borrow().len() as u32
145    }
146
147    /// <https://html.spec.whatwg.org/multipage/#dom-texttracklist-item>
148    fn IndexedGetter(&self, idx: u32) -> Option<DomRoot<TextTrack>> {
149        self.item(idx as usize)
150    }
151
152    /// <https://html.spec.whatwg.org/multipage/#dom-texttracklist-gettrackbyid>
153    fn GetTrackById(&self, id: DOMString) -> Option<DomRoot<TextTrack>> {
154        let id_str = String::from(id);
155        self.dom_tracks
156            .borrow()
157            .iter()
158            .find(|track| track.id() == id_str)
159            .map(|t| DomRoot::from_ref(&**t))
160    }
161
162    // https://html.spec.whatwg.org/multipage/#handler-texttracklist-onchange
163    event_handler!(change, GetOnchange, SetOnchange);
164
165    // https://html.spec.whatwg.org/multipage/#handler-texttracklist-onaddtrack
166    event_handler!(addtrack, GetOnaddtrack, SetOnaddtrack);
167
168    // https://html.spec.whatwg.org/multipage/#handler-texttracklist-onremovetrack
169    event_handler!(removetrack, GetOnremovetrack, SetOnremovetrack);
170}
script/dom/webvtt/texttracklist.rs

script/dom/webvtt/
texttracklist.rs
