script/dom/audio/
audiotracklist.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::audio::audiotrack::AudioTrack;
10use crate::dom::bindings::codegen::Bindings::AudioTrackListBinding::AudioTrackListMethods;
11use crate::dom::bindings::inheritance::Castable;
12use crate::dom::bindings::refcounted::Trusted;
13use crate::dom::bindings::reflector::DomGlobal;
14use crate::dom::bindings::root::{Dom, DomRoot};
15use crate::dom::bindings::str::DOMString;
16use crate::dom::eventtarget::EventTarget;
17use crate::dom::html::htmlmediaelement::HTMLMediaElement;
18use crate::dom::window::Window;
19use crate::script_runtime::CanGc;
20
21#[dom_struct]
22pub(crate) struct AudioTrackList {
23    eventtarget: EventTarget,
24    tracks: DomRefCell<Vec<Dom<AudioTrack>>>,
25    media_element: Option<Dom<HTMLMediaElement>>,
26}
27
28impl AudioTrackList {
29    pub(crate) fn new_inherited(
30        tracks: &[&AudioTrack],
31        media_element: Option<&HTMLMediaElement>,
32    ) -> AudioTrackList {
33        AudioTrackList {
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: &[&AudioTrack],
43        media_element: Option<&HTMLMediaElement>,
44        can_gc: CanGc,
45    ) -> DomRoot<AudioTrackList> {
46        reflect_dom_object(
47            Box::new(AudioTrackList::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: &AudioTrack) -> Option<usize> {
58        self.tracks.borrow().iter().position(|t| &**t == track)
59    }
60
61    pub(crate) fn item(&self, idx: usize) -> Option<DomRoot<AudioTrack>> {
62        self.tracks
63            .borrow()
64            .get(idx)
65            .map(|track| DomRoot::from_ref(&**track))
66    }
67
68    pub(crate) fn enabled_index(&self) -> Option<usize> {
69        self.tracks
70            .borrow()
71            .iter()
72            .position(|track| track.enabled())
73    }
74
75    pub(crate) fn set_enabled(&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 enabled status is the same as the new status, return early.
82        if track.enabled() == value {
83            return;
84        }
85        // Set the tracks enabled status.
86        track.set_enabled(value);
87        if let Some(media_element) = self.media_element.as_ref() {
88            media_element.set_audio_track(idx, value);
89        }
90
91        // Queue a task to fire an event named change.
92        let global = &self.global();
93        let this = Trusted::new(self);
94        let task_source = global.task_manager().media_element_task_source();
95        task_source.queue(task!(media_track_change: move |cx| {
96            let this = this.root();
97            this.upcast::<EventTarget>().fire_event(cx, atom!("change"));
98        }));
99    }
100
101    pub(crate) fn add(&self, track: &AudioTrack) {
102        self.tracks.borrow_mut().push(Dom::from_ref(track));
103        track.add_track_list(self);
104    }
105
106    pub(crate) fn clear(&self) {
107        self.tracks
108            .borrow()
109            .iter()
110            .for_each(|t| t.remove_track_list());
111        self.tracks.borrow_mut().clear();
112    }
113}
114
115impl AudioTrackListMethods<crate::DomTypeHolder> for AudioTrackList {
116    /// <https://html.spec.whatwg.org/multipage/#dom-audiotracklist-length>
117    fn Length(&self) -> u32 {
118        self.len() as u32
119    }
120
121    /// <https://html.spec.whatwg.org/multipage/#dom-tracklist-item>
122    fn IndexedGetter(&self, idx: u32) -> Option<DomRoot<AudioTrack>> {
123        self.item(idx as usize)
124    }
125
126    /// <https://html.spec.whatwg.org/multipage/#dom-audiotracklist-gettrackbyid>
127    fn GetTrackById(&self, id: DOMString) -> Option<DomRoot<AudioTrack>> {
128        self.tracks
129            .borrow()
130            .iter()
131            .find(|track| track.id() == id)
132            .map(|track| DomRoot::from_ref(&**track))
133    }
134
135    // https://html.spec.whatwg.org/multipage/#handler-tracklist-onchange
136    event_handler!(change, GetOnchange, SetOnchange);
137
138    // https://html.spec.whatwg.org/multipage/#handler-tracklist-onaddtrack
139    event_handler!(addtrack, GetOnaddtrack, SetOnaddtrack);
140
141    // https://html.spec.whatwg.org/multipage/#handler-tracklist-onremovetrack
142    event_handler!(removetrack, GetOnremovetrack, SetOnremovetrack);
143}
script/dom/audio/audiotracklist.rs

script/dom/audio/
audiotracklist.rs
