AudioPannerNode should raise exception when distanceModel is set incorrectly
[WebKit-https.git] / Source / WebCore / Modules / webaudio / AudioPannerNode.h
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
25 #ifndef AudioPannerNode_h
26 #define AudioPannerNode_h
27
28 #include "AudioBus.h"
29 #include "AudioGain.h"
30 #include "AudioListener.h"
31 #include "AudioNode.h"
32 #include "Cone.h"
33 #include "Distance.h"
34 #include "FloatPoint3D.h"
35 #include "Panner.h"
36 #include <wtf/OwnPtr.h>
37
38 namespace WebCore {
39
40 // AudioPannerNode is an AudioNode with one input and one output.
41 // It positions a sound in 3D space, with the exact effect dependent on the panning model.
42 // It has a position and an orientation in 3D space which is relative to the position and orientation of the context's AudioListener.
43 // A distance effect will attenuate the gain as the position moves away from the listener.
44 // A cone effect will attenuate the gain as the orientation moves away from the listener.
45 // All of these effects follow the OpenAL specification very closely.
46
47 class AudioPannerNode : public AudioNode {
48 public:
49     // These must be defined as in the .idl file and must match those in the Panner class.
50     enum {
51         EQUALPOWER = 0,
52         HRTF = 1,
53         SOUNDFIELD = 2,
54     };
55
56     // These must be defined as in the .idl file and must match those
57     // in the DistanceEffect class.
58     enum {
59         LINEAR_DISTANCE = 0,
60         INVERSE_DISTANCE = 1,
61         EXPONENTIAL_DISTANCE = 2,
62     };
63     
64     static PassRefPtr<AudioPannerNode> create(AudioContext* context, float sampleRate)
65     {
66         return adoptRef(new AudioPannerNode(context, sampleRate));
67     }
68
69     virtual ~AudioPannerNode();
70
71     // AudioNode
72     virtual void process(size_t framesToProcess);
73     virtual void pullInputs(size_t framesToProcess);
74     virtual void reset();
75     virtual void initialize();
76     virtual void uninitialize();
77
78     // Listener
79     AudioListener* listener();
80
81     // Panning model
82     unsigned short panningModel() const { return m_panningModel; }
83     void setPanningModel(unsigned short, ExceptionCode&);
84
85     // Position
86     FloatPoint3D position() const { return m_position; }
87     void setPosition(float x, float y, float z) { m_position = FloatPoint3D(x, y, z); }
88
89     // Orientation
90     FloatPoint3D orientation() const { return m_position; }
91     void setOrientation(float x, float y, float z) { m_orientation = FloatPoint3D(x, y, z); }
92
93     // Velocity
94     FloatPoint3D velocity() const { return m_velocity; }
95     void setVelocity(float x, float y, float z) { m_velocity = FloatPoint3D(x, y, z); }
96
97     // Distance parameters
98     unsigned short distanceModel() { return m_distanceEffect.model(); }
99     void setDistanceModel(unsigned short, ExceptionCode&);
100
101     float refDistance() { return static_cast<float>(m_distanceEffect.refDistance()); }
102     void setRefDistance(float refDistance) { m_distanceEffect.setRefDistance(refDistance); }
103
104     float maxDistance() { return static_cast<float>(m_distanceEffect.maxDistance()); }
105     void setMaxDistance(float maxDistance) { m_distanceEffect.setMaxDistance(maxDistance); }
106
107     float rolloffFactor() { return static_cast<float>(m_distanceEffect.rolloffFactor()); }
108     void setRolloffFactor(float rolloffFactor) { m_distanceEffect.setRolloffFactor(rolloffFactor); }
109
110     // Sound cones - angles in degrees
111     float coneInnerAngle() const { return static_cast<float>(m_coneEffect.innerAngle()); }
112     void setConeInnerAngle(float angle) { m_coneEffect.setInnerAngle(angle); }
113
114     float coneOuterAngle() const { return static_cast<float>(m_coneEffect.outerAngle()); }
115     void setConeOuterAngle(float angle) { m_coneEffect.setOuterAngle(angle); }
116
117     float coneOuterGain() const { return static_cast<float>(m_coneEffect.outerGain()); }
118     void setConeOuterGain(float angle) { m_coneEffect.setOuterGain(angle); }
119
120     void getAzimuthElevation(double* outAzimuth, double* outElevation);
121     float dopplerRate();
122
123     // Accessors for dynamically calculated gain values.
124     AudioGain* distanceGain() { return m_distanceGain.get(); }                                        
125     AudioGain* coneGain() { return m_coneGain.get(); }                                        
126
127     virtual double tailTime() const OVERRIDE { return m_panner ? m_panner->tailTime() : 0; }
128     virtual double latencyTime() const OVERRIDE { return m_panner ? m_panner->latencyTime() : 0; }
129
130 private:
131     AudioPannerNode(AudioContext*, float sampleRate);
132
133     // Returns the combined distance and cone gain attenuation.
134     float distanceConeGain();
135
136     // Notifies any AudioBufferSourceNodes connected to us either directly or indirectly about our existence.
137     // This is in order to handle the pitch change necessary for the doppler shift.
138     void notifyAudioSourcesConnectedToNode(AudioNode*);
139
140     OwnPtr<Panner> m_panner;
141     unsigned m_panningModel;
142
143     FloatPoint3D m_position;
144     FloatPoint3D m_orientation;
145     FloatPoint3D m_velocity;
146
147     // Gain
148     RefPtr<AudioGain> m_distanceGain;
149     RefPtr<AudioGain> m_coneGain;
150     DistanceEffect m_distanceEffect;
151     ConeEffect m_coneEffect;
152     float m_lastGain;
153
154     unsigned m_connectionCount;
155 };
156
157 } // namespace WebCore
158
159 #endif // AudioPannerNode_h