Home | History | Annotate | Download | only in webaudio 
      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/Vector.h"
     36 
     37 namespace blink {
     38 
     39 class HRTFDatabaseLoader;
     40 class PannerNode;
     41 
     42 // AudioListener maintains the state of the listener in the audio scene as defined in the OpenAL specification.
     43 
     44 class AudioListener : public GarbageCollectedFinalized<AudioListener>, public ScriptWrappable {
     45     DEFINE_WRAPPERTYPEINFO();
     46 public:
     47     static AudioListener* create()
     48     {
     49         return new AudioListener();
     50     }
     51     virtual ~AudioListener();
     52 
     53     // Position
     54     void setPosition(float x, float y, float z) { setPosition(FloatPoint3D(x, y, z)); }
     55     const FloatPoint3D& position() const { return m_position; }
     56 
     57     // Orientation and Up-vector
     58     void setOrientation(float x, float y, float z, float upX, float upY, float upZ)
     59     {
     60         setOrientation(FloatPoint3D(x, y, z));
     61         setUpVector(FloatPoint3D(upX, upY, upZ));
     62     }
     63     const FloatPoint3D& orientation() const { return m_orientation; }
     64     const FloatPoint3D& upVector() const { return m_upVector; }
     65 
     66     // Velocity
     67     void setVelocity(float x, float y, float z) { setVelocity(FloatPoint3D(x, y, z)); }
     68     const FloatPoint3D& velocity() const { return m_velocity; }
     69 
     70     // Doppler factor
     71     void setDopplerFactor(double);
     72     double dopplerFactor() const { return m_dopplerFactor; }
     73 
     74     // Speed of sound
     75     void setSpeedOfSound(double);
     76     double speedOfSound() const { return m_speedOfSound; }
     77 
     78     Mutex& listenerLock() { return m_listenerLock; }
     79     void addPanner(PannerNode*);
     80     void removePanner(PannerNode*);
     81 
     82     // HRTF DB loader
     83     HRTFDatabaseLoader* hrtfDatabaseLoader() { return m_hrtfDatabaseLoader.get(); }
     84     void createAndLoadHRTFDatabaseLoader(float);
     85     bool isHRTFDatabaseLoaded();
     86     void waitForHRTFDatabaseLoaderThreadCompletion();
     87 
     88     void trace(Visitor*);
     89 
     90 private:
     91     AudioListener();
     92 
     93     void setPosition(const FloatPoint3D&);
     94     void setOrientation(const FloatPoint3D&);
     95     void setUpVector(const FloatPoint3D&);
     96     void setVelocity(const FloatPoint3D&);
     97 
     98     void markPannersAsDirty(unsigned);
     99 
    100     FloatPoint3D m_position;
    101     FloatPoint3D m_orientation;
    102     FloatPoint3D m_upVector;
    103     FloatPoint3D m_velocity;
    104     double m_dopplerFactor;
    105     double m_speedOfSound;
    106 
    107     // Synchronize a panner's process() with setting of the state of the listener.
    108     mutable Mutex m_listenerLock;
    109     // List for pannerNodes in context. This is updated only in the main thread,
    110     // and can be referred in audio thread.
    111     HeapVector<Member<PannerNode> > m_panners;
    112     // HRTF DB loader for panner node.
    113     Member<HRTFDatabaseLoader> m_hrtfDatabaseLoader;
    114 };
    115 
    116 } // namespace blink
    117 
    118 #endif // AudioListener_h
    119