Add logic to cache elements of panner node from calculation with own attributes and AudioListener

Source/modules/webaudio/PannerNode.cpp

Index: Source/modules/webaudio/PannerNode.cpp
diff --git a/Source/modules/webaudio/PannerNode.cpp b/Source/modules/webaudio/PannerNode.cpp
index b4279c9567eb9897f98d206d81e4b94745153993..73be7ca5acb9979fb78b2f968c66ed859470d103 100644
--- a/Source/modules/webaudio/PannerNode.cpp
+++ b/Source/modules/webaudio/PannerNode.cpp
@@ -53,9 +53,9 @@ PannerNode::PannerNode(AudioContext* context, float sampleRate)
     , m_position(0, 0, 0)
     , m_orientation(1, 0, 0)
     , m_velocity(0, 0, 0)
-    , m_cachedPosition(0, 0, 0)
-    , m_cachedOrientation(1, 0, 0)
-    , m_cachedVelocity(0, 0, 0)
+    , m_isAzimuthElevationDirty(true)
+    , m_isDistanceConeGainDirty(true)
+    , m_isDopplerRateDirty(true)
     , m_lastGain(-1.0)
     , m_cachedAzimuth(0)
     , m_cachedElevation(0)
@@ -76,8 +76,6 @@ PannerNode::PannerNode(AudioContext* context, float sampleRate)
     m_channelCountMode = ClampedMax;
     m_channelInterpretation = AudioBus::Speakers;
 
-    m_cachedListener = AudioListener::create();
-
     setNodeType(NodeTypePanner);
 
     initialize();
@@ -123,7 +121,9 @@ void PannerNode::process(size_t framesToProcess)
 
     // The audio thread can't block on this lock, so we call tryLock() instead.
     MutexTryLocker tryLocker(m_processLock);
-    if (tryLocker.locked()) {
+    MutexTryLocker tryListenerLocker(listener()->listenerLock());
+
+    if (tryLocker.locked() && tryListenerLocker.locked()) {
         // HRTFDatabase should be loaded before proceeding for offline audio context when the panning model is HRTF.
         if (m_panningModel == HRTF && !m_hrtfDatabaseLoader->isLoaded()) {
             if (context()->isOfflineContext()) {
@@ -150,14 +150,9 @@ void PannerNode::process(size_t framesToProcess)
 
         // Apply gain in-place with de-zippering.
         destination->copyWithGainFrom(*destination, &m_lastGain, totalGain);
-
-        // Update the cached listener in case listener has moved.
-        updateCachedListener();
-        // Now update the cached source location in case the source has changed.
-        updateCachedSourceLocationInfo();
     } else {
         // Too bad - The tryLock() failed.
-        // We must be in the middle of changing the panning model, the distance model, or the source's location information.
+        // We must be in the middle of changing the properties of the panner or the listener.
         destination->zero();
     }
 }
@@ -168,6 +163,7 @@ void PannerNode::initialize()
         return;
 
     m_panner = Panner::create(m_panningModel, sampleRate(), m_hrtfDatabaseLoader.get());
+    listener()->addPanner(this);
 
     AudioNode::initialize();
 }
@@ -178,6 +174,8 @@ void PannerNode::uninitialize()
         return;
 
     m_panner.clear();
+    listener()->removePanner(this);
+
     AudioNode::uninitialize();
 }
 
@@ -189,7 +187,7 @@ AudioListener* PannerNode::listener()
 String PannerNode::panningModel() const
 {
     switch (m_panningModel) {
-    case EQUALPOWER:
+    case EqualPower:
         return "equalpower";
     case HRTF:
         return "HRTF";
@@ -202,7 +200,7 @@ String PannerNode::panningModel() const
 void PannerNode::setPanningModel(const String& model)
 {
     if (model == "equalpower")
-        setPanningModel(EQUALPOWER);
+        setPanningModel(EqualPower);
     else if (model == "HRTF")
         setPanningModel(HRTF);
 }
@@ -210,12 +208,11 @@ void PannerNode::setPanningModel(const String& model)
 bool PannerNode::setPanningModel(unsigned model)
 {
     switch (model) {
-    case EQUALPOWER:
+    case EqualPower:
     case HRTF:
         if (!m_panner.get() || model != m_panningModel) {
             // This synchronizes with process().
             MutexLocker processLocker(m_processLock);
-

[Raymond Toy, 2014/04/21 16:48:26]

Question:  If you didn't delete this line (and you shouldn't), can you keep the
original uppercase panning model enums?

[KhNo, 2014/04/21 17:29:01]

That was for making code consensus before calling mutex lock with others since
only here has empty line. If you want let empty line, I will.

As you know, I added new enum, but there is webkit style checker error. So it
also changed for code consensus. It can be changed if it is fine that new added
enum only has different style enum in header. If you want it, I will change back
to original uppercase style for two enum type, panningmodel and distancemodel.

[Raymond Toy, 2014/04/22 00:57:49]

I leave it up to you. It's just that I don't like CLs that change parts of the
code that aren't really related to the CL itself.

[KhNo, 2014/04/22 06:20:09]

Definitely, you're right. It is good for others. I will seperate it.

             OwnPtr<Panner> newPanner = Panner::create(model, sampleRate(), m_hrtfDatabaseLoader.get());
             m_panner = newPanner.release();
             m_panningModel = model;
@@ -228,45 +225,6 @@ bool PannerNode::setPanningModel(unsigned model)
     return true;
 }
 
-void PannerNode::setPosition(float x, float y, float z)
-{
-    FloatPoint3D position = FloatPoint3D(x, y, z);
-
-    if (m_position == position)
-        return;
-
-    // This synchronizes with process().
-    MutexLocker processLocker(m_processLock);
-
-    m_position = position;
-}
-
-void PannerNode::setOrientation(float x, float y, float z)
-{
-    FloatPoint3D orientation = FloatPoint3D(x, y, z);
-
-    if (m_orientation == orientation)
-        return;
-
-    // This synchronizes with process().
-    MutexLocker processLocker(m_processLock);
-
-    m_orientation = orientation;
-}
-
-void PannerNode::setVelocity(float x, float y, float z)
-{
-    FloatPoint3D velocity = FloatPoint3D(x, y, z);
-
-    if (m_velocity == velocity)
-        return;
-
-    // This synchronizes with process().
-    MutexLocker processLocker(m_processLock);
-
-    m_velocity = velocity;
-}
-
 String PannerNode::distanceModel() const
 {
     switch (const_cast<PannerNode*>(this)->m_distanceEffect.model()) {
@@ -312,6 +270,111 @@ bool PannerNode::setDistanceModel(unsigned model)
     return true;
 }
 
+void PannerNode::setRefDistance(double distance)
+{
+    if (refDistance() == distance)
+        return;
+
+    // This synchronizes with process().
+    MutexLocker processLocker(m_processLock);
+    m_distanceEffect.setRefDistance(distance);
+    markPannerAsDirty(PannerNode::DistanceConeGainDirty);
+}
+
+void PannerNode::setMaxDistance(double distance)
+{
+    if (maxDistance() == distance)
+        return;
+
+    // This synchronizes with process().
+    MutexLocker processLocker(m_processLock);
+    m_distanceEffect.setMaxDistance(distance);
+    markPannerAsDirty(PannerNode::DistanceConeGainDirty);
+}
+
+void PannerNode::setRolloffFactor(double factor)
+{
+    if (rolloffFactor() == factor)
+        return;
+
+    // This synchronizes with process().
+    MutexLocker processLocker(m_processLock);
+    m_distanceEffect.setRolloffFactor(factor);
+    markPannerAsDirty(PannerNode::DistanceConeGainDirty);
+}
+
+void PannerNode::setConeInnerAngle(double angle)
+{
+    if (coneInnerAngle() == angle)
+        return;
+
+    // This synchronizes with process().
+    MutexLocker processLocker(m_processLock);
+    m_coneEffect.setInnerAngle(angle);
+    markPannerAsDirty(PannerNode::DistanceConeGainDirty);
+}
+
+void PannerNode::setConeOuterAngle(double angle)
+{
+    if (coneOuterAngle() == angle)
+        return;
+
+    // This synchronizes with process().
+    MutexLocker processLocker(m_processLock);
+    m_coneEffect.setOuterAngle(angle);
+    markPannerAsDirty(PannerNode::DistanceConeGainDirty);
+}
+
+void PannerNode::setConeOuterGain(double angle)
+{
+    if (coneOuterGain() == angle)
+        return;
+
+    // This synchronizes with process().
+    MutexLocker processLocker(m_processLock);
+    m_coneEffect.setOuterGain(angle);
+    markPannerAsDirty(PannerNode::DistanceConeGainDirty);
+}
+
+void PannerNode::setPosition(float x, float y, float z)
+{
+    FloatPoint3D position = FloatPoint3D(x, y, z);
+
+    if (m_position == position)
+        return;
+
+    // This synchronizes with process().
+    MutexLocker processLocker(m_processLock);
+    m_position = position;
+    markPannerAsDirty(PannerNode::AzimuthElevationDirty | PannerNode::DistanceConeGainDirty | PannerNode::DopplerRateDirty);
+}
+
+void PannerNode::setOrientation(float x, float y, float z)
+{
+    FloatPoint3D orientation = FloatPoint3D(x, y, z);
+
+    if (m_orientation == orientation)
+        return;
+
+    // This synchronizes with process().
+    MutexLocker processLocker(m_processLock);
+    m_orientation = orientation;
+    markPannerAsDirty(PannerNode::DistanceConeGainDirty);
+}
+
+void PannerNode::setVelocity(float x, float y, float z)
+{
+    FloatPoint3D velocity = FloatPoint3D(x, y, z);
+
+    if (m_velocity == velocity)
+        return;
+
+    // This synchronizes with process().
+    MutexLocker processLocker(m_processLock);
+    m_velocity = velocity;
+    markPannerAsDirty(PannerNode::DopplerRateDirty);
+}
+
 void PannerNode::calculateAzimuthElevation(double* outAzimuth, double* outElevation)
 {
     double azimuth = 0.0;
@@ -435,8 +498,10 @@ void PannerNode::azimuthElevation(double* outAzimuth, double* outElevation)
 {
     ASSERT(context()->isAudioThread());
 
-    if (isAzimuthElevationDirty())
+    if (isAzimuthElevationDirty()) {
         calculateAzimuthElevation(&m_cachedAzimuth, &m_cachedElevation);
+        m_isAzimuthElevationDirty = false;
+    }
 
     *outAzimuth = m_cachedAzimuth;
     *outElevation = m_cachedElevation;
@@ -446,8 +511,10 @@ double PannerNode::dopplerRate()
 {
     ASSERT(context()->isAudioThread());
 
-    if (isDopplerRateDirty())
+    if (isDopplerRateDirty()) {
         m_cachedDopplerRate = calculateDopplerRate();
+        m_isDopplerRateDirty = false;
+    }
 
     return m_cachedDopplerRate;
 }
@@ -456,51 +523,24 @@ float PannerNode::distanceConeGain()
 {
     ASSERT(context()->isAudioThread());
 
-    if (isDistanceConeGainDirty())
+    if (isDistanceConeGainDirty()) {
         m_cachedDistanceConeGain = calculateDistanceConeGain();
+        m_isDistanceConeGainDirty = false;
+    }
 
     return m_cachedDistanceConeGain;
 }
 
-bool PannerNode::isAzimuthElevationDirty()
-{
-    // Do a quick test and return if possible.
-    if (m_cachedPosition != m_position)
-        return true;
-
-    if (m_cachedListener->position() != listener()->position()
-        || m_cachedListener->orientation() != listener()->orientation()
-        || m_cachedListener->upVector() != listener()->upVector())
-        return true;
-
-    return false;
-}
-
-bool PannerNode::isDistanceConeGainDirty()
+void PannerNode::markPannerAsDirty(unsigned dirty)
 {
-    // Do a quick test and return if possible.
-    if (m_cachedPosition != m_position || m_cachedOrientation != m_orientation)
-        return true;
+    if (dirty & PannerNode::AzimuthElevationDirty)
+        m_isAzimuthElevationDirty = true;
 
-    if (m_cachedListener->position() != listener()->position())
-        return true;
+    if (dirty & PannerNode::DistanceConeGainDirty)
+        m_isDistanceConeGainDirty = true;
 
-    return false;
-}
-
-bool PannerNode::isDopplerRateDirty()
-{
-    // Do a quick test and return if possible.
-    if (m_cachedPosition != m_position || m_cachedVelocity != m_velocity)
-        return true;
-
-    if (m_cachedListener->position() != listener()->position()
-        || m_cachedListener->velocity() != listener()->velocity()
-        || m_cachedListener->dopplerFactor() != listener()->dopplerFactor()
-        || m_cachedListener->speedOfSound() != listener()->speedOfSound())
-        return true;
-
-    return false;
+    if (dirty & PannerNode::DopplerRateDirty)
+        m_isDopplerRateDirty = true;
 }
 
 void PannerNode::notifyAudioSourcesConnectedToNode(AudioNode* node, HashMap<AudioNode*, bool>& visitedNodes)
@@ -535,27 +575,6 @@ void PannerNode::notifyAudioSourcesConnectedToNode(AudioNode* node, HashMap<Audi
     }
 }
 
-void PannerNode::updateCachedListener()
-{
-    ASSERT(context()->isAudioThread());
-
-    m_cachedListener->setPosition(listener()->position());
-    m_cachedListener->setOrientation(listener()->orientation());
-    m_cachedListener->setUpVector(listener()->upVector());
-    m_cachedListener->setVelocity(listener()->velocity());
-    m_cachedListener->setDopplerFactor(listener()->dopplerFactor());
-    m_cachedListener->setSpeedOfSound(listener()->speedOfSound());
-}
-
-void PannerNode::updateCachedSourceLocationInfo()
-{
-    ASSERT(context()->isAudioThread());
-
-    m_cachedPosition = m_position;
-    m_cachedOrientation = m_orientation;
-    m_cachedVelocity = m_velocity;
-}
-
 } // namespace WebCore
 
 #endif // ENABLE(WEB_AUDIO)