Implement StereoPannerNode for robust stereo panning

Source/platform/audio/Spatializer.h

-// Copyright (C) 2013 Google Inc. All rights reserved.
+// Copyright 2014 The Chromium Authors. All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without
 // modification, are permitted provided that the following conditions are
 // met:
 //
 //    * Redistributions of source code must retain the above copyright
 // notice, this list of conditions and the following disclaimer.
 //    * Redistributions in binary form must reproduce the above
 // copyright notice, this list of conditions and the following disclaimer
 // in the documentation and/or other materials provided with the
 // distribution.
 //    * Neither the name of Google Inc. nor the names of its
 // contributors may be used to endorse or promote products derived from
 // this software without specific prior written permission.
 //
 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-#ifndef GraphicsContextStateSaver_h
-#define GraphicsContextStateSaver_h
+#ifndef Spatializer_h
+#define Spatializer_h
 
 #include "platform/PlatformExport.h"
-#include "platform/graphics/GraphicsContext.h"
+#include "platform/heap/Handle.h"
 
 namespace blink {
 
-class PLATFORM_EXPORT GraphicsContextStateSaver {
-    WTF_MAKE_FAST_ALLOCATED;
+class AudioBus;
+
+// Abstract base class for spatializing a mono or stereo source.
+class PLATFORM_EXPORT Spatializer : public GarbageCollectedFinalized<Spatializer> {
 public:
-    GraphicsContextStateSaver(GraphicsContext& context, bool saveAndRestore = true)
-        : m_context(context)
-        , m_saveAndRestore(saveAndRestore)
-    {
-        if (m_saveAndRestore)
-            m_context.save();
-    }
+    enum {
+        PanningModelEqualPower = 0,
+        PanningModelHRTF = 1,
+        PanningModelSurround = 2

[Raymond Toy, 2014/11/11 19:41:47]

Are PanningModelHRTF and PanningModelSurround supported yet? If not, I would
remove these.

[hongchan, 2014/11/12 00:06:54]

Done.

+    };
 
-    ~GraphicsContextStateSaver()
-    {
-        if (m_saveAndRestore)
-            m_context.restore();
-    }
+    typedef unsigned PanningModel;
 
-    void save()
-    {
-        ASSERT(!m_saveAndRestore);
-        m_context.save();
-        m_saveAndRestore = true;
-    }
+    static Spatializer* create(PanningModel, float sampleRate);
 
-    void saveIfNeeded()
-    {
-        if (saved())
-            return;
-        save();
-    }
+    virtual ~Spatializer() { };
 
-    void restore()
-    {
-        ASSERT(m_saveAndRestore);
-        m_context.restore();
-        m_saveAndRestore = false;
-    }
+    // Handle sample-accurate panning by AudioParam automation.
+    virtual void panWithSampleAccurateValues(const AudioBus* inputBus, AudioBus* outputBuf, const float* panValues, size_t framesToProcess) = 0;
 
-    GraphicsContext* context() const { return &m_context; }
-    bool saved() const { return m_saveAndRestore; }
+    // Handle de-zippered panning to a target value.
+    virtual void panToTargetValue(const AudioBus* inputBus, AudioBus* outputBuf, float panValue, size_t framesToProcess) = 0;
 
-private:
-    GraphicsContext& m_context;
-    bool m_saveAndRestore;
+    virtual void reset() = 0;
+    virtual double tailTime() const = 0;
+    virtual double latencyTime() const = 0;
+
+    virtual void trace(Visitor*) { }
+
+protected:
+    Spatializer(PanningModel model) { }
 };
 
 } // namespace blink
 
-#endif // GraphicsContextStateSaver_h
+#endif // Spatializer_h