src/third_party/WebKit/Source/modules/webaudio/AudioListener.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  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef AudioListener_h
  30 #define AudioListener_h
  31
  32 #include "bindings/core/v8/ScriptWrappable.h"
  33 #include "platform/geometry/FloatPoint3D.h"
  34 #include "platform/heap/Handle.h"
  35 #include "wtf/PassRefPtr.h"
  36 #include "wtf/RefCounted.h"
  37 #include "wtf/Vector.h"
  38
  39 namespace blink {
  40
  41 class HRTFDatabaseLoader;
  42 class PannerNode;
  43
  44 // AudioListener maintains the state of the listener in the audio scene as defined in the OpenAL specification.
  45
  46 class AudioListener : public RefCountedWillBeGarbageCollectedFinalized<AudioListener>, public ScriptWrappable {
  47 public:
  48     static PassRefPtrWillBeRawPtr<AudioListener> create()
  49     {
  50         return adoptRefWillBeNoop(new AudioListener());
  51     }
  52     virtual ~AudioListener();
  53
  54     // Position
  55     void setPosition(float x, float y, float z) { setPosition(FloatPoint3D(x, y, z)); }
  56     const FloatPoint3D& position() const { return m_position; }
  57
  58     // Orientation and Up-vector
  59     void setOrientation(float x, float y, float z, float upX, float upY, float upZ)
  60     {
  61         setOrientation(FloatPoint3D(x, y, z));
  62         setUpVector(FloatPoint3D(upX, upY, upZ));
  63     }
  64     const FloatPoint3D& orientation() const { return m_orientation; }
  65     const FloatPoint3D& upVector() const { return m_upVector; }
  66
  67     // Velocity
  68     void setVelocity(float x, float y, float z) { setVelocity(FloatPoint3D(x, y, z)); }
  69     const FloatPoint3D& velocity() const { return m_velocity; }
  70
  71     // Doppler factor
  72     void setDopplerFactor(double);
  73     double dopplerFactor() const { return m_dopplerFactor; }
  74
  75     // Speed of sound
  76     void setSpeedOfSound(double);
  77     double speedOfSound() const { return m_speedOfSound; }
  78
  79     Mutex& listenerLock() { return m_listenerLock; }
  80     void addPanner(PannerNode*);
  81     void removePanner(PannerNode*);
  82
  83     // HRTF DB loader
  84     HRTFDatabaseLoader* hrtfDatabaseLoader() { return m_hrtfDatabaseLoader.get(); }
  85     void createAndLoadHRTFDatabaseLoader(float);
  86     bool isHRTFDatabaseLoaded();
  87     void waitForHRTFDatabaseLoaderThreadCompletion();
  88
  89     void trace(Visitor*);
  90
  91 private:
  92     AudioListener();
  93
  94     void setPosition(const FloatPoint3D&);
  95     void setOrientation(const FloatPoint3D&);
  96     void setUpVector(const FloatPoint3D&);
  97     void setVelocity(const FloatPoint3D&);
  98
  99     void markPannersAsDirty(unsigned);
 100
 101     FloatPoint3D m_position;
 102     FloatPoint3D m_orientation;
 103     FloatPoint3D m_upVector;
 104     FloatPoint3D m_velocity;
 105     double m_dopplerFactor;
 106     double m_speedOfSound;
 107
 108     // Synchronize a panner's process() with setting of the state of the listener.
 109     mutable Mutex m_listenerLock;
 110     // List for pannerNodes in context. This is updated only in the main thread,
 111     // and can be referred in audio thread.
 112     WillBeHeapVector<RawPtrWillBeMember<PannerNode> > m_panners;
 113     // HRTF DB loader for panner node.
 114     RefPtr<HRTFDatabaseLoader> m_hrtfDatabaseLoader;
 115 };
 116
 117 } // namespace blink
 118
 119 #endif // AudioListener_h