Support for AudioContextOptions latencyHint.

third_party/WebKit/Source/modules/webaudio/BaseAudioContextTest.cpp

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "modules/webaudio/BaseAudioContext.h"
 
 #include "core/dom/Document.h"
 #include "core/dom/DocumentUserGestureToken.h"
 #include "core/frame/FrameOwner.h"
 #include "core/frame/FrameTypes.h"
 #include "core/frame/FrameView.h"
 #include "core/frame/Settings.h"
 #include "core/loader/DocumentLoader.h"
 #include "core/loader/EmptyClients.h"
 #include "core/testing/DummyPageHolder.h"
 #include "platform/UserGestureIndicator.h"
 #include "platform/testing/HistogramTester.h"
 #include "platform/testing/TestingPlatformSupport.h"
 #include "public/platform/WebAudioDevice.h"
+#include "public/platform/WebAudioLatencyHint.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace blink {
 
 namespace {
 
 const char* const kCrossOriginMetric = "WebAudio.Autoplay.CrossOrigin";
+const WebAudioLatencyHint kLatencyHintInteractive(
+    WebAudioLatencyHint::CategoryInteractive);
 
 class MockCrossOriginFrameLoaderClient final : public EmptyFrameLoaderClient {
  public:
   static MockCrossOriginFrameLoaderClient* create(Frame* parent) {
     return new MockCrossOriginFrameLoaderClient(parent);
   }
 
   DEFINE_INLINE_VIRTUAL_TRACE() {
     visitor->trace(m_parent);
     EmptyFrameLoaderClient::trace(visitor);
   }
 
   Frame* parent() const override { return m_parent.get(); }
   Frame* top() const override { return m_parent.get(); }
 
  private:
   explicit MockCrossOriginFrameLoaderClient(Frame* parent) : m_parent(parent) {}
 
   Member<Frame> m_parent;
 };
 
 class MockWebAudioDevice : public WebAudioDevice {
  public:
-  explicit MockWebAudioDevice(double sampleRate) : m_sampleRate(sampleRate) {}
+  explicit MockWebAudioDevice(double sampleRate, int framesPerBuffer)
+      : m_sampleRate(sampleRate), m_framesPerBuffer(framesPerBuffer) {}
   ~MockWebAudioDevice() override = default;
 
   void start() override {}
   void stop() override {}
   double sampleRate() override { return m_sampleRate; }
+  int framesPerBuffer() override { return m_framesPerBuffer; }
 
  private:
   double m_sampleRate;
+  int m_framesPerBuffer;
 };
 
 class BaseAudioContextTestPlatform : public TestingPlatformSupport {
  public:
-  WebAudioDevice* createAudioDevice(size_t bufferSize,
-                                    unsigned numberOfInputChannels,
+  WebAudioDevice* createAudioDevice(unsigned numberOfInputChannels,
                                     unsigned numberOfChannels,
-                                    double sampleRate,
+                                    const WebAudioLatencyHint& latencyHint,
                                     WebAudioDevice::RenderCallback*,
                                     const WebString& deviceId,
                                     const WebSecurityOrigin&) override {
-    return new MockWebAudioDevice(sampleRate);
+    return new MockWebAudioDevice(audioHardwareSampleRate(),
+                                  audioHardwareBufferSize());
   }
 
   double audioHardwareSampleRate() override { return 44100; }
+  size_t audioHardwareBufferSize() override { return 128; }
 };
 
 }  // anonymous namespace
 
 class BaseAudioContextTest : public ::testing::Test {
  protected:
   using AutoplayStatus = BaseAudioContext::AutoplayStatus;
 
   void SetUp() override {
     m_dummyPageHolder = DummyPageHolder::create();
@@ skipping 46 matching lines @@
 
   Persistent<LocalFrame> m_childFrame;
   Persistent<DocumentLoader> m_childDocumentLoader;
 
   BaseAudioContextTestPlatform m_testPlatform;
 };
 
 TEST_F(BaseAudioContextTest, AutoplayMetrics_NoRestriction) {
   HistogramTester histogramTester;
 
-  BaseAudioContext* audioContext =
-      BaseAudioContext::create(document(), ASSERT_NO_EXCEPTION);
+  BaseAudioContext* audioContext = BaseAudioContext::create(
+      document(), kLatencyHintInteractive, ASSERT_NO_EXCEPTION);
   recordAutoplayStatus(audioContext);
 
   histogramTester.expectTotalCount(kCrossOriginMetric, 0);
 }
 
 TEST_F(BaseAudioContextTest, AutoplayMetrics_CreateNoGesture) {
   HistogramTester histogramTester;
   createChildFrame();
   childDocument().settings()->setMediaPlaybackRequiresUserGesture(true);
 
-  BaseAudioContext* audioContext =
-      BaseAudioContext::create(childDocument(), ASSERT_NO_EXCEPTION);
+  BaseAudioContext* audioContext = BaseAudioContext::create(
+      childDocument(), kLatencyHintInteractive, ASSERT_NO_EXCEPTION);
   recordAutoplayStatus(audioContext);
 
   histogramTester.expectBucketCount(kCrossOriginMetric,
                                     AutoplayStatus::AutoplayStatusFailed, 1);
   histogramTester.expectTotalCount(kCrossOriginMetric, 1);
 }
 
 TEST_F(BaseAudioContextTest, AutoplayMetrics_CallResumeNoGesture) {
   HistogramTester histogramTester;
   createChildFrame();
   childDocument().settings()->setMediaPlaybackRequiresUserGesture(true);
 
   ScriptState::Scope scope(getScriptStateFrom(childDocument()));
 
-  BaseAudioContext* audioContext =
-      BaseAudioContext::create(childDocument(), ASSERT_NO_EXCEPTION);
+  BaseAudioContext* audioContext = BaseAudioContext::create(
+      childDocument(), kLatencyHintInteractive, ASSERT_NO_EXCEPTION);
   audioContext->resumeContext(getScriptStateFrom(childDocument()));
   rejectPendingResolvers(audioContext);
   recordAutoplayStatus(audioContext);
 
   histogramTester.expectBucketCount(kCrossOriginMetric,
                                     AutoplayStatus::AutoplayStatusFailed, 1);
   histogramTester.expectTotalCount(kCrossOriginMetric, 1);
 }
 
 TEST_F(BaseAudioContextTest, AutoplayMetrics_CreateGesture) {
   HistogramTester histogramTester;
   createChildFrame();
   childDocument().settings()->setMediaPlaybackRequiresUserGesture(true);
 
   UserGestureIndicator userGestureScope(DocumentUserGestureToken::create(
       &childDocument(), UserGestureToken::NewGesture));
 
-  BaseAudioContext* audioContext =
-      BaseAudioContext::create(childDocument(), ASSERT_NO_EXCEPTION);
+  BaseAudioContext* audioContext = BaseAudioContext::create(
+      childDocument(), kLatencyHintInteractive, ASSERT_NO_EXCEPTION);
   recordAutoplayStatus(audioContext);
 
   histogramTester.expectBucketCount(kCrossOriginMetric,
                                     AutoplayStatus::AutoplayStatusSucceeded, 1);
   histogramTester.expectTotalCount(kCrossOriginMetric, 1);
 }
 
 TEST_F(BaseAudioContextTest, AutoplayMetrics_CallResumeGesture) {
   HistogramTester histogramTester;
   createChildFrame();
   childDocument().settings()->setMediaPlaybackRequiresUserGesture(true);
 
   ScriptState::Scope scope(getScriptStateFrom(childDocument()));
 
-  BaseAudioContext* audioContext =
-      BaseAudioContext::create(childDocument(), ASSERT_NO_EXCEPTION);
+  BaseAudioContext* audioContext = BaseAudioContext::create(
+      childDocument(), kLatencyHintInteractive, ASSERT_NO_EXCEPTION);
 
   UserGestureIndicator userGestureScope(DocumentUserGestureToken::create(
       &childDocument(), UserGestureToken::NewGesture));
 
   audioContext->resumeContext(getScriptStateFrom(childDocument()));
   rejectPendingResolvers(audioContext);
   recordAutoplayStatus(audioContext);
 
   histogramTester.expectBucketCount(kCrossOriginMetric,
                                     AutoplayStatus::AutoplayStatusSucceeded, 1);
   histogramTester.expectTotalCount(kCrossOriginMetric, 1);
 }
 
 TEST_F(BaseAudioContextTest, AutoplayMetrics_NodeStartNoGesture) {
   HistogramTester histogramTester;
   createChildFrame();
   childDocument().settings()->setMediaPlaybackRequiresUserGesture(true);
 
-  BaseAudioContext* audioContext =
-      BaseAudioContext::create(childDocument(), ASSERT_NO_EXCEPTION);
+  BaseAudioContext* audioContext = BaseAudioContext::create(
+      childDocument(), kLatencyHintInteractive, ASSERT_NO_EXCEPTION);
   audioContext->maybeRecordStartAttempt();
   recordAutoplayStatus(audioContext);
 
   histogramTester.expectBucketCount(kCrossOriginMetric,
                                     AutoplayStatus::AutoplayStatusFailed, 1);
   histogramTester.expectTotalCount(kCrossOriginMetric, 1);
 }
 
 TEST_F(BaseAudioContextTest, AutoplayMetrics_NodeStartGesture) {
   HistogramTester histogramTester;
   createChildFrame();
   childDocument().settings()->setMediaPlaybackRequiresUserGesture(true);
 
-  BaseAudioContext* audioContext =
-      BaseAudioContext::create(childDocument(), ASSERT_NO_EXCEPTION);
+  BaseAudioContext* audioContext = BaseAudioContext::create(
+      childDocument(), kLatencyHintInteractive, ASSERT_NO_EXCEPTION);
 
   UserGestureIndicator userGestureScope(DocumentUserGestureToken::create(
       &childDocument(), UserGestureToken::NewGesture));
   audioContext->maybeRecordStartAttempt();
   recordAutoplayStatus(audioContext);
 
   histogramTester.expectBucketCount(
       kCrossOriginMetric, AutoplayStatus::AutoplayStatusFailedWithStart, 1);
   histogramTester.expectTotalCount(kCrossOriginMetric, 1);
 }
 
 TEST_F(BaseAudioContextTest, AutoplayMetrics_NodeStartNoGestureThenSuccess) {
   HistogramTester histogramTester;
   createChildFrame();
   childDocument().settings()->setMediaPlaybackRequiresUserGesture(true);
 
   ScriptState::Scope scope(getScriptStateFrom(childDocument()));
 
-  BaseAudioContext* audioContext =
-      BaseAudioContext::create(childDocument(), ASSERT_NO_EXCEPTION);
+  BaseAudioContext* audioContext = BaseAudioContext::create(
+      childDocument(), kLatencyHintInteractive, ASSERT_NO_EXCEPTION);
   audioContext->maybeRecordStartAttempt();
 
   UserGestureIndicator userGestureScope(DocumentUserGestureToken::create(
       &childDocument(), UserGestureToken::NewGesture));
   audioContext->resumeContext(getScriptStateFrom(childDocument()));
   rejectPendingResolvers(audioContext);
   recordAutoplayStatus(audioContext);
 
   histogramTester.expectBucketCount(kCrossOriginMetric,
                                     AutoplayStatus::AutoplayStatusSucceeded, 1);
   histogramTester.expectTotalCount(kCrossOriginMetric, 1);
 }
 
 TEST_F(BaseAudioContextTest, AutoplayMetrics_NodeStartGestureThenSucces) {
   HistogramTester histogramTester;
   createChildFrame();
   childDocument().settings()->setMediaPlaybackRequiresUserGesture(true);
 
   ScriptState::Scope scope(getScriptStateFrom(childDocument()));
 
-  BaseAudioContext* audioContext =
-      BaseAudioContext::create(childDocument(), ASSERT_NO_EXCEPTION);
+  BaseAudioContext* audioContext = BaseAudioContext::create(
+      childDocument(), kLatencyHintInteractive, ASSERT_NO_EXCEPTION);

[o1ka, 2016/11/30 11:46:26]

We need some unit tests for other latency hints as well.

[Andrew MacPherson, 2016/12/01 12:11:56]

I created AudioContextTest.cpp and added a basic test to just confirm that the
WebAudioDevice's buffer size values are being correctly passed to the
AudioContext, let me know if more is needed. Note that I also had to add
MODULES_EXPORT to the AudioContext class in order to make its symbols visible to
the unit tests binary.

 
   UserGestureIndicator userGestureScope(DocumentUserGestureToken::create(
       &childDocument(), UserGestureToken::NewGesture));
   audioContext->maybeRecordStartAttempt();
   audioContext->resumeContext(getScriptStateFrom(childDocument()));
   rejectPendingResolvers(audioContext);
   recordAutoplayStatus(audioContext);
 
   histogramTester.expectBucketCount(kCrossOriginMetric,
                                     AutoplayStatus::AutoplayStatusSucceeded, 1);
   histogramTester.expectTotalCount(kCrossOriginMetric, 1);
 }
 
 }  // namespace blink