1/*
2 * Copyright (C) 2010, Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1.  Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2.  Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16 * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24
25module audio {
26    interface [
27        Conditional=WEB_AUDIO,
28        GenerateConstructor,
29        GenerateToJS
30    ] AudioPannerNode : AudioNode {
31        // Panning model
32        const unsigned short EQUALPOWER = 0;
33        const unsigned short HRTF = 1;
34        const unsigned short SOUNDFIELD = 2;
35
36        // Default model for stereo is HRTF
37        attribute unsigned long panningModel; // FIXME: use unsigned short when glue generation supports it
38
39        // Uses a 3D cartesian coordinate system
40        void setPosition(in float x, in float y, in float z);
41        void setOrientation(in float x, in float y, in float z);
42        void setVelocity(in float x, in float y, in float z);
43
44        // Distance model
45        attribute unsigned long distanceModel; // FIXME: use unsigned short when glue generation supports it
46        attribute float refDistance;
47        attribute float maxDistance;
48        attribute float rolloffFactor;
49
50        // Directional sound cone
51        attribute float coneInnerAngle;
52        attribute float coneOuterAngle;
53        attribute float coneOuterGain;
54
55        // Dynamically calculated gain values
56        readonly attribute AudioGain coneGain;
57        readonly attribute AudioGain distanceGain;
58    };
59}
60