Implementing promise-based commit for driving OffscreenCanvas animations

third_party/WebKit/Source/platform/graphics/OffscreenCanvasFrameDispatcherImpl.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 "platform/graphics/OffscreenCanvasFrameDispatcherImpl.h"
 
 #include "cc/output/compositor_frame.h"
 #include "cc/quads/texture_draw_quad.h"
 #include "gpu/command_buffer/client/gles2_interface.h"
 #include "platform/CrossThreadFunctional.h"
 #include "platform/Histogram.h"
 #include "platform/WebTaskRunner.h"
 #include "platform/graphics/OffscreenCanvasPlaceholder.h"
 #include "platform/graphics/gpu/SharedGpuContext.h"
 #include "public/platform/InterfaceProvider.h"
 #include "public/platform/Platform.h"
 #include "public/platform/WebGraphicsContext3DProvider.h"
 #include "public/platform/modules/offscreencanvas/offscreen_canvas_surface.mojom-blink.h"
 #include "third_party/khronos/GLES2/gl2.h"
 #include "third_party/khronos/GLES2/gl2ext.h"
 #include "third_party/skia/include/core/SkColor.h"
 #include "third_party/skia/include/core/SkImage.h"
 #include "ui/gfx/geometry/rect.h"
 #include "ui/gfx/transform.h"
 #include "wtf/typed_arrays/ArrayBuffer.h"
 #include "wtf/typed_arrays/Uint8Array.h"
 
 namespace blink {
 
+// This constant specifies the maximum number of pixel buffer that are allowed
+// to co-exist at a given time. The minimum number is 2 (double buffered).
+// larger numbers can help maintain a steadier frame rates, but they increase
+// latency.
+const int kMaximumOffscreenCanvasBufferCount = 3;
+
 OffscreenCanvasFrameDispatcherImpl::OffscreenCanvasFrameDispatcherImpl(
+    OffscreenCanvasFrameDispatcherClient* client,
     uint32_t clientId,
     uint32_t sinkId,
     int canvasId,
     int width,
     int height)
-    : m_frameSinkId(cc::FrameSinkId(clientId, sinkId)),
+    : OffscreenCanvasFrameDispatcher(client),
+      m_frameSinkId(cc::FrameSinkId(clientId, sinkId)),
       m_width(width),
       m_height(height),
       m_changeSizeForNextCommit(false),
       m_nextResourceId(1u),
       m_binding(this),
       m_placeholderCanvasId(canvasId) {
   m_currentLocalFrameId = m_surfaceIdAllocator.GenerateId();
   DCHECK(!m_sink.is_bound());
   mojom::blink::OffscreenCanvasCompositorFrameSinkProviderPtr provider;
   Platform::current()->interfaceProvider()->getInterface(
       mojo::MakeRequest(&provider));
   provider->CreateCompositorFrameSink(m_frameSinkId,
                                       m_binding.CreateInterfacePtrAndBind(),
                                       mojo::MakeRequest(&m_sink));
 }
 
+OffscreenCanvasFrameDispatcherImpl::~OffscreenCanvasFrameDispatcherImpl() {
+  m_syntheticBeginFrameTask.cancel();
+}
+
 void OffscreenCanvasFrameDispatcherImpl::setTransferableResourceToSharedBitmap(
     cc::TransferableResource& resource,
     RefPtr<StaticBitmapImage> image) {
   std::unique_ptr<cc::SharedBitmap> bitmap =
       Platform::current()->allocateSharedBitmap(IntSize(m_width, m_height));
   if (!bitmap)
     return;
   unsigned char* pixels = bitmap->pixels();
   DCHECK(pixels);
   SkImageInfo imageInfo = SkImageInfo::Make(
@@ skipping 108 matching lines @@
   }
 }
 
 }  // namespace
 
 void OffscreenCanvasFrameDispatcherImpl::dispatchFrame(
     RefPtr<StaticBitmapImage> image,
     double commitStartTime,
     bool isWebGLSoftwareRendering /* This flag is true when WebGL's commit is
     called on SwiftShader. */) {
-  if (!image)
-    return;
-  if (!verifyImageSize(image->size()))
+  if (!image || !verifyImageSize(image->size()))
     return;
   cc::CompositorFrame frame;
   // TODO(crbug.com/652931): update the device_scale_factor
   frame.metadata.device_scale_factor = 1.0f;
 
   const gfx::Rect bounds(m_width, m_height);
   const int renderPassId = 1;
   std::unique_ptr<cc::RenderPass> pass = cc::RenderPass::Create();
   pass->SetNew(renderPassId, bounds, bounds, gfx::Transform());
   pass->has_transparent_background = false;
@@ skipping 162 matching lines @@
       break;
     case OffscreenCanvasCommitTypeCount:
       NOTREACHED();
   }
 
   if (m_changeSizeForNextCommit) {
     m_currentLocalFrameId = m_surfaceIdAllocator.GenerateId();
     m_changeSizeForNextCommit = false;
   }
   m_sink->SubmitCompositorFrame(m_currentLocalFrameId, std::move(frame));
+
+  // TODO(crbug.com/674744): Get BeginFrame to fire on its own.
+  scheduleSyntheticBeginFrame();
+}
+
+void OffscreenCanvasFrameDispatcherImpl::scheduleSyntheticBeginFrame() {
+  m_syntheticBeginFrameTask =
+      Platform::current()
+          ->currentThread()
+          ->getWebTaskRunner()
+          ->postDelayedCancellableTask(
+              BLINK_FROM_HERE,
+              WTF::bind(&OffscreenCanvasFrameDispatcherImpl::OnBeginFrame,
+                        WTF::unretained(this), cc::BeginFrameArgs()),
+              16);
 }
 
 void OffscreenCanvasFrameDispatcherImpl::DidReceiveCompositorFrameAck() {
   // TODO(fsamuel): Implement this.
 }
 
 void OffscreenCanvasFrameDispatcherImpl::OnBeginFrame(
-    const cc::BeginFrameArgs& beginFrameArgs) {}
+    const cc::BeginFrameArgs& beginFrameArgs) {
+  if (!client())
+    return;
+  unsigned framesInFlight = m_cachedImages.size() + m_sharedBitmaps.size() +
+                            m_cachedTextureIds.size();
+
+  // Limit the rate of compositor commits.
+  if (framesInFlight < kMaximumOffscreenCanvasBufferCount) {
+    client()->beginFrame();
+  } else {
+    // TODO(crbug.com/674744): Get BeginFrame to fire on its own.
+    // The following call is to reschedule the frame in cases where we encounter
+    // a backlog.
+    scheduleSyntheticBeginFrame();
+  }
+}
 
 void OffscreenCanvasFrameDispatcherImpl::ReclaimResources(
     const cc::ReturnedResourceArray& resources) {
   for (const auto& resource : resources) {
     RefPtr<StaticBitmapImage> image = m_cachedImages.get(resource.id);
     if (image)
       image->updateSyncToken(resource.sync_token);
     reclaimResource(resource.id);
   }
 }
 
 void OffscreenCanvasFrameDispatcherImpl::WillDrawSurface() {
   // TODO(fsamuel, staraz): Implement this.
-  NOTIMPLEMENTED();
 }
 
 void OffscreenCanvasFrameDispatcherImpl::reclaimResource(unsigned resourceId) {
   // An image resource needs to be returned by both the
   // CompositorFrameSink and the HTMLCanvasElement. These
   // events can happen in any order.  The first of the two
   // to return a given resource will result in the spare
   // resource lock being lifted, and the second will delete
   // the resource for real.
   if (m_spareResourceLocks.contains(resourceId)) {
@@ skipping 14 matching lines @@
 
 void OffscreenCanvasFrameDispatcherImpl::reshape(int width, int height) {
   if (m_width != width || m_height != height) {
     m_width = width;
     m_height = height;
     m_changeSizeForNextCommit = true;
   }
 }
 
 }  // namespace blink