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