script/dom/audio/
stereopannernode.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::rust::HandleObject;
7use servo_media::audio::node::{AudioNodeInit, AudioNodeType};
8use servo_media::audio::param::ParamType;
9use servo_media::audio::stereo_panner::StereoPannerOptions as ServoMediaStereoPannerOptions;
10
11use crate::conversions::Convert;
12use crate::dom::audio::audionode::AudioNodeOptionsHelper;
13use crate::dom::audio::audioparam::AudioParam;
14use crate::dom::audio::audioscheduledsourcenode::AudioScheduledSourceNode;
15use crate::dom::audio::baseaudiocontext::BaseAudioContext;
16use crate::dom::bindings::codegen::Bindings::AudioNodeBinding::{
17    ChannelCountMode, ChannelInterpretation,
18};
19use crate::dom::bindings::codegen::Bindings::AudioParamBinding::AutomationRate;
20use crate::dom::bindings::codegen::Bindings::StereoPannerNodeBinding::{
21    StereoPannerNodeMethods, StereoPannerOptions,
22};
23use crate::dom::bindings::error::{Error, Fallible};
24use crate::dom::bindings::reflector::reflect_dom_object_with_proto;
25use crate::dom::bindings::root::{Dom, DomRoot};
26use crate::dom::window::Window;
27use crate::script_runtime::CanGc;
28
29#[dom_struct]
30pub(crate) struct StereoPannerNode {
31    source_node: AudioScheduledSourceNode,
32    pan: Dom<AudioParam>,
33}
34
35impl StereoPannerNode {
36    #[cfg_attr(crown, allow(crown::unrooted_must_root))]
37    pub(crate) fn new_inherited(
38        window: &Window,
39        context: &BaseAudioContext,
40        options: &StereoPannerOptions,
41    ) -> Fallible<StereoPannerNode> {
42        let node_options = options.parent.unwrap_or(
43            2,
44            ChannelCountMode::Clamped_max,
45            ChannelInterpretation::Speakers,
46        );
47        if node_options.mode == ChannelCountMode::Max {
48            return Err(Error::NotSupported);
49        }
50        if node_options.count > 2 || node_options.count == 0 {
51            return Err(Error::NotSupported);
52        }
53        let pan = *options.pan;
54        let source_node = AudioScheduledSourceNode::new_inherited(
55            AudioNodeInit::StereoPannerNode(options.convert()),
56            context,
57            node_options,
58            1, /* inputs */
59            1, /* outputs */
60        )?;
61        let node_id = source_node.node().node_id();
62        let pan = AudioParam::new(
63            window,
64            context,
65            node_id,
66            AudioNodeType::StereoPannerNode,
67            ParamType::Pan,
68            AutomationRate::A_rate,
69            pan,
70            -1.,
71            1.,
72            CanGc::note(),
73        );
74
75        Ok(StereoPannerNode {
76            source_node,
77            pan: Dom::from_ref(&pan),
78        })
79    }
80
81    pub(crate) fn new(
82        window: &Window,
83        context: &BaseAudioContext,
84        options: &StereoPannerOptions,
85        can_gc: CanGc,
86    ) -> Fallible<DomRoot<StereoPannerNode>> {
87        Self::new_with_proto(window, None, context, options, can_gc)
88    }
89
90    #[cfg_attr(crown, allow(crown::unrooted_must_root))]
91    fn new_with_proto(
92        window: &Window,
93        proto: Option<HandleObject>,
94        context: &BaseAudioContext,
95        options: &StereoPannerOptions,
96        can_gc: CanGc,
97    ) -> Fallible<DomRoot<StereoPannerNode>> {
98        let node = StereoPannerNode::new_inherited(window, context, options)?;
99        Ok(reflect_dom_object_with_proto(
100            Box::new(node),
101            window,
102            proto,
103            can_gc,
104        ))
105    }
106}
107
108impl StereoPannerNodeMethods<crate::DomTypeHolder> for StereoPannerNode {
109    // https://webaudio.github.io/web-audio-api/#dom-stereopannernode-stereopannernode
110    fn Constructor(
111        window: &Window,
112        proto: Option<HandleObject>,
113        can_gc: CanGc,
114        context: &BaseAudioContext,
115        options: &StereoPannerOptions,
116    ) -> Fallible<DomRoot<StereoPannerNode>> {
117        StereoPannerNode::new_with_proto(window, proto, context, options, can_gc)
118    }
119
120    // https://webaudio.github.io/web-audio-api/#dom-stereopannernode-pan
121    fn Pan(&self) -> DomRoot<AudioParam> {
122        DomRoot::from_ref(&self.pan)
123    }
124}
125
126impl Convert<ServoMediaStereoPannerOptions> for StereoPannerOptions {
127    fn convert(self) -> ServoMediaStereoPannerOptions {
128        ServoMediaStereoPannerOptions { pan: *self.pan }
129    }
130}