cc: Emulate BeginFrame in OutputSurfaces that don't support it natively

cc/output/output_surface.cc

 // Copyright (c) 2013 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 "cc/output/output_surface.h"
 
 #include <set>
 #include <string>
 #include <vector>
 
+#include "base/debug/trace_event.h"
 #include "base/logging.h"
 #include "base/string_util.h"
 #include "base/strings/string_split.h"
 #include "cc/output/output_surface_client.h"
+#include "cc/scheduler/delay_based_time_source.h"
 #include "third_party/WebKit/public/platform/WebGraphicsContext3D.h"
 #include "third_party/khronos/GLES2/gl2.h"
 #include "third_party/khronos/GLES2/gl2ext.h"
 #include "ui/gfx/rect.h"
 #include "ui/gfx/size.h"
 
 using std::set;
 using std::string;
 using std::vector;
 
 namespace cc {
 
 class OutputSurfaceCallbacks
     : public WebKit::WebGraphicsContext3D::
         WebGraphicsSwapBuffersCompleteCallbackCHROMIUM,
       public WebKit::WebGraphicsContext3D::WebGraphicsContextLostCallback {
  public:
-  explicit OutputSurfaceCallbacks(OutputSurfaceClient* client)
+  explicit OutputSurfaceCallbacks(OutputSurface* client)
       : client_(client) {}
 
   // WK:WGC3D::WGSwapBuffersCompleteCallbackCHROMIUM implementation.
   virtual void onSwapBuffersComplete() { client_->OnSwapBuffersComplete(); }
 
   // WK:WGC3D::WGContextLostCallback implementation.
   virtual void onContextLost() { client_->DidLoseOutputSurface(); }
 
  private:
-  OutputSurfaceClient* client_;
+  OutputSurface* client_;
 };
 
 OutputSurface::OutputSurface(
     scoped_ptr<WebKit::WebGraphicsContext3D> context3d)
     : client_(NULL),
       context3d_(context3d.Pass()),
-      has_gl_discard_backbuffer_(false) {
+      has_gl_discard_backbuffer_(false),
+      pending_begin_frames_(0) {
 }
 
 OutputSurface::OutputSurface(
     scoped_ptr<cc::SoftwareOutputDevice> software_device)
     : client_(NULL),
       software_device_(software_device.Pass()),
-      has_gl_discard_backbuffer_(false) {
+      has_gl_discard_backbuffer_(false),
+      pending_begin_frames_(0) {
 }
 
 OutputSurface::OutputSurface(
     scoped_ptr<WebKit::WebGraphicsContext3D> context3d,
     scoped_ptr<cc::SoftwareOutputDevice> software_device)
     : client_(NULL),
       context3d_(context3d.Pass()),
       software_device_(software_device.Pass()),
-      has_gl_discard_backbuffer_(false) {
+      has_gl_discard_backbuffer_(false),
+      pending_begin_frames_(0) {
+}
+
+void OutputSurface::InitializeBeginFrameEmulation(
+    Thread* thread,
+    bool throttle_frame_production,
+    base::TimeDelta interval,
+    int max_frames_pending,
+    bool swap_buffers_complete_supported) {
+  DCHECK(!frame_rate_controller_);
+  if (throttle_frame_production){
+    frame_rate_controller_.reset(
+        new FrameRateController(
+            DelayBasedTimeSource::Create(interval, thread)));
+  } else {
+    frame_rate_controller_.reset(new FrameRateController(thread));
+  }
+
+  frame_rate_controller_->SetClient(this);
+  frame_rate_controller_->SetSwapBuffersCompleteSupported(
+      swap_buffers_complete_supported);
+  frame_rate_controller_->SetMaxFramesPending(max_frames_pending);
+}
+
+void OutputSurface::OnVSyncParametersChanged(base::TimeTicks timebase,
+                                             base::TimeDelta interval) {
+  TRACE_EVENT2("cc", "OutputSurface::OnVSyncParametersChanged",
+               "timebase", (timebase - base::TimeTicks()).InSecondsF(),
+               "interval", interval.InSecondsF());
+  frame_rate_controller_->SetTimebaseAndInterval(timebase, interval);
+}
+
+void OutputSurface::FrameRateControllerTick(bool throttled) {
+  if (!throttled)
+    BeginFrame(frame_rate_controller_->LastTickTime());
+}
+
+// Forwarded to OutputSurfaceClient
+void OutputSurface::SetNeedsRedrawRect(gfx::Rect damage_rect) {
+  TRACE_EVENT0("cc", "OutputSurface::SetNeedsRedrawRect");
+  client_->SetNeedsRedrawRect(damage_rect);
+}
+
+void OutputSurface::SetNeedsBeginFrame(bool enable) {
+  frame_rate_controller_->SetActive(enable);
+}
+
+void OutputSurface::BeginFrame(base::TimeTicks frame_time) {
+  // TODO(brianderson): Remove this early return once Android has
+  // Browser-side throttling.
+  //if (pending_begin_frames_ >= frame_rate_controller_->MaxFramesPending())

[brianderson, 2013/06/01 04:30:29]

This should be uncommented and tested on Android.

[Sami, 2013/06/03 17:30:33]

Do you have an idea what we'd need in the browser to implement throttling -- and
where it'd go? Maybe it's simpler just to implement that so this code can go
away immediately.

[brianderson, 2013/06/03 18:51:40]

Daniel is working on a patch to do that here:
https://codereview.chromium.org/16290002/

We could combine our patches or have his go in right after this one.

+  //  return;
+  TRACE_EVENT0("cc", "OutputSurface::BeginFrame");
+  pending_begin_frames_++;
+  frame_rate_controller_->WillSwapBuffers();
+  client_->BeginFrame(frame_time);
+}
+
+void OutputSurface::OnSendFrameToParentCompositorAck(
+    const CompositorFrameAck& ack) {
+  TRACE_EVENT0("cc", "OutputSurface::OnSendFrameToParentCompositorAck");
+  client_->OnSendFrameToParentCompositorAck(ack);
+}
+
+void OutputSurface::OnSwapBuffersComplete() {
+  TRACE_EVENT0("cc", "OutputSurface::OnSwapBuffersComplete");
+  pending_begin_frames_--;
+  client_->OnSwapBuffersComplete();
+  frame_rate_controller_->DidSwapBuffersComplete();
+}
+
+void OutputSurface::DidLoseOutputSurface() {
+  TRACE_EVENT0("cc", "OutputSurface::DidLoseOutputSurface");
+  pending_begin_frames_ = 0;
+  client_->DidLoseOutputSurface();
 }
 
 OutputSurface::~OutputSurface() {
+  if (frame_rate_controller_)
+    frame_rate_controller_->SetActive(false);
 }
 
 bool OutputSurface::ForcedDrawToSoftwareDevice() const {
   return false;
 }
 
-bool OutputSurface::BindToClient(
-    cc::OutputSurfaceClient* client) {
+bool OutputSurface::BindToClient(cc::OutputSurfaceClient* client) {
   DCHECK(client);
   if (context3d_ && !context3d_->makeContextCurrent())
     return false;
   client_ = client;
   if (!context3d_)
     return true;
   string extensions_string = UTF16ToASCII(context3d_->getString(GL_EXTENSIONS));
   vector<string> extensions_list;
   base::SplitString(extensions_string, ' ', &extensions_list);
   set<string> extensions(extensions_list.begin(), extensions_list.end());
 
   has_gl_discard_backbuffer_ =
       extensions.count("GL_CHROMIUM_discard_backbuffer") > 0;
 
-  callbacks_.reset(new OutputSurfaceCallbacks(client_));
+  callbacks_.reset(new OutputSurfaceCallbacks(this));
   context3d_->setSwapBuffersCompleteCallbackCHROMIUM(callbacks_.get());
   context3d_->setContextLostCallback(callbacks_.get());
 
   return true;
 }
 
 void OutputSurface::SendFrameToParentCompositor(CompositorFrame* frame) {
   NOTIMPLEMENTED();
 }
 
@@ skipping 27 matching lines @@
 }
 
 void OutputSurface::PostSubBuffer(gfx::Rect rect,
                                   const ui::LatencyInfo& latency_info) {
   DCHECK(context3d_);
   context3d_->postSubBufferCHROMIUM(
       rect.x(), rect.y(), rect.width(), rect.height());
 }
 
 }  // namespace cc