cc: Make separate interface for BeginFrame ipc from OutputSurface

content/browser/android/in_process/synchronous_compositor_impl.cc

 // Copyright 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 "content/browser/android/in_process/synchronous_compositor_impl.h"
 
+#include "base/auto_reset.h"
 #include "base/lazy_instance.h"
 #include "base/message_loop/message_loop.h"
 #include "cc/input/input_handler.h"
+#include "content/browser/android/in_process/synchronous_compositor_external_begin_frame_source.h"
 #include "content/browser/android/in_process/synchronous_compositor_factory_impl.h"
 #include "content/browser/android/in_process/synchronous_input_event_filter.h"
 #include "content/browser/renderer_host/render_widget_host_view_android.h"
 #include "content/common/input/did_overscroll_params.h"
 #include "content/public/browser/android/synchronous_compositor_client.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/render_view_host.h"
 #include "ui/gl/gl_surface.h"
 
@@ skipping 38 matching lines @@
 }
 
 SynchronousCompositorImpl* SynchronousCompositorImpl::FromRoutingID(
     int routing_id) {
   return FromID(GetInProcessRendererId(), routing_id);
 }
 
 SynchronousCompositorImpl::SynchronousCompositorImpl(WebContents* contents)
     : compositor_client_(NULL),
       output_surface_(NULL),
+      begin_frame_source_(nullptr),
       contents_(contents),
       input_handler_(NULL),
+      invoking_composite_(false),
       weak_ptr_factory_(this) {
   DCHECK(contents);
 }
 
 SynchronousCompositorImpl::~SynchronousCompositorImpl() {
   if (compositor_client_)
     compositor_client_->DidDestroyCompositor(this);
+  if (begin_frame_source_)
+    begin_frame_source_->SetCompositor(nullptr);
   SetInputHandler(NULL);
 }
 
 void SynchronousCompositorImpl::SetClient(
     SynchronousCompositorClient* compositor_client) {
   DCHECK(CalledOnValidThread());
   compositor_client_ = compositor_client;
 }
 
 // static
 void SynchronousCompositor::SetGpuService(
     scoped_refptr<gpu::InProcessCommandBuffer::Service> service) {
   g_factory.Get().SetDeferredGpuService(service);
 }
 
 // static
 void SynchronousCompositor::SetRecordFullDocument(bool record_full_document) {
   g_factory.Get().SetRecordFullDocument(record_full_document);
 }
 
+void SynchronousCompositorImpl::SetExternalBeginFrameSource(
+    SynchronousCompositorExternalBeginFrameSource* begin_frame_source) {
+  begin_frame_source_ = begin_frame_source;

[boliu, 2014/10/31 16:48:21]

It's a bit awkard to DCHECK this, and so let's split this out into
DidInitializeBeginFrameSource and DidDestroyBFS:

DidInititalize(BFS* bfs) {
  DCHECK(!begin_frame_source_);
  DCHECK(!output_surface_);
  DCHECK(bfs);
  begin_frame_source_ = bfs;
  begin_frame_source_->SetCompositor(this);
}

DidDestroy(BFS* bfs) {
  DCHECK(!begin_frame_source_);
  DCHECK_EQ(begin_frame_source_, bfs);
  bfs->SetCompositor(nullptr);
  begin_frame_source_ = nullptr;

  if (output_surface_)
     output_surface_->SetBeginFrameSource(nullptr);
  
  // These 3 lines should probably be a helper function.
  if (compositor_client_)
    compositor_client_->DidDestroyCompositor(this);
  compositor_client_ = nullptr;
}

[simonhong, 2014/11/01 02:13:06]

Done.

+  if (begin_frame_source_)
+    begin_frame_source_->SetCompositor(this);
+}
+
 bool SynchronousCompositorImpl::InitializeHwDraw() {
   DCHECK(CalledOnValidThread());
   DCHECK(output_surface_);
 
   scoped_refptr<cc::ContextProvider> onscreen_context =
       g_factory.Get().CreateOnscreenContextProviderForCompositorThread();
 
   bool success = output_surface_->InitializeHwDraw(onscreen_context);
 
   if (success)
@@ skipping 10 matching lines @@
 
 scoped_ptr<cc::CompositorFrame> SynchronousCompositorImpl::DemandDrawHw(
     gfx::Size surface_size,
     const gfx::Transform& transform,
     gfx::Rect viewport,
     gfx::Rect clip,
     gfx::Rect viewport_rect_for_tile_priority,
     const gfx::Transform& transform_for_tile_priority) {
   DCHECK(CalledOnValidThread());
   DCHECK(output_surface_);
+  DCHECK(!invoking_composite_);
+  DCHECK(compositor_client_);
+  DCHECK(begin_frame_source_);
 
+  base::AutoReset<bool> invoking_composite_resetter(&invoking_composite_,
+                                                    true);
   scoped_ptr<cc::CompositorFrame> frame =
       output_surface_->DemandDrawHw(surface_size,
                                     transform,
                                     viewport,
                                     clip,
                                     viewport_rect_for_tile_priority,
                                     transform_for_tile_priority);
   if (frame.get())
     UpdateFrameMetaData(frame->metadata);
 
+  compositor_client_->SetContinuousInvalidate(
+      begin_frame_source_->NeedsBeginFrames());
+
   return frame.Pass();
 }
 
 void SynchronousCompositorImpl::ReturnResources(
     const cc::CompositorFrameAck& frame_ack) {
   DCHECK(CalledOnValidThread());
   output_surface_->ReturnResources(frame_ack);
 }
 
 bool SynchronousCompositorImpl::DemandDrawSw(SkCanvas* canvas) {
   DCHECK(CalledOnValidThread());
   DCHECK(output_surface_);
+  DCHECK(!invoking_composite_);
+  DCHECK(compositor_client_);
+  DCHECK(begin_frame_source_);
 
-  scoped_ptr<cc::CompositorFrame> frame = output_surface_->DemandDrawSw(canvas);
+  base::AutoReset<bool> invoking_composite_resetter(&invoking_composite_,
+                                                    true);
+  scoped_ptr<cc::CompositorFrame> frame =
+      output_surface_->DemandDrawSw(canvas);
   if (frame.get())
     UpdateFrameMetaData(frame->metadata);
+
+  compositor_client_->SetContinuousInvalidate(
+      begin_frame_source_->NeedsBeginFrames());
+
   return !!frame.get();
 }
 
 void SynchronousCompositorImpl::UpdateFrameMetaData(
     const cc::CompositorFrameMetadata& frame_metadata) {
   RenderWidgetHostViewAndroid* rwhv = static_cast<RenderWidgetHostViewAndroid*>(
       contents_->GetRenderWidgetHostView());
   if (rwhv)
     rwhv->SynchronousFrameMetadata(frame_metadata);
   DeliverMessages();
 }
 
 void SynchronousCompositorImpl::SetMemoryPolicy(size_t bytes_limit) {
   DCHECK(CalledOnValidThread());
   DCHECK(output_surface_);
 
   output_surface_->SetMemoryPolicy(bytes_limit);
 }
 
 void SynchronousCompositorImpl::DidChangeRootLayerScrollOffset() {
   if (input_handler_)
     input_handler_->OnRootLayerDelegatedScrollOffsetChanged();
 }
 
 void SynchronousCompositorImpl::DidBindOutputSurface(
-      SynchronousCompositorOutputSurface* output_surface) {
+    SynchronousCompositorOutputSurface* output_surface) {
   DCHECK(CalledOnValidThread());

[boliu, 2014/10/31 16:48:21]

You actually do want DCHECK(begin_frame_source_); then :)
Also should add a DCHECK(output_surface); that should have been here already.

[simonhong, 2014/11/01 02:13:06]

Done.

   output_surface_ = output_surface;
   if (compositor_client_)
     compositor_client_->DidInitializeCompositor(this);
+
+  output_surface_->SetBeginFrameSource(begin_frame_source_);
 }
 
 void SynchronousCompositorImpl::DidDestroySynchronousOutputSurface(
-       SynchronousCompositorOutputSurface* output_surface) {
+    SynchronousCompositorOutputSurface* output_surface) {
   DCHECK(CalledOnValidThread());
 
   // Allow for transient hand-over when two output surfaces may refer to
   // a single delegate.
   if (output_surface_ == output_surface) {
     output_surface_ = NULL;

[boliu, 2014/10/31 16:48:21]

output_surface_->SetBeginFrameSource(nullptr);

[simonhong, 2014/11/01 02:13:06]

Done.

     if (compositor_client_)
       compositor_client_->DidDestroyCompositor(this);
     compositor_client_ = NULL;
+
+    DCHECK(begin_frame_source_);

[boliu, 2014/10/31 16:48:21]

Don't assume particular destruction order either. You can just remove this new
block I think.

[simonhong, 2014/11/01 02:13:06]

Done.

+    begin_frame_source_->SetCompositor(nullptr);
+    begin_frame_source_ = nullptr;
   }
 }
 
 void SynchronousCompositorImpl::SetInputHandler(
     cc::InputHandler* input_handler) {
   DCHECK(CalledOnValidThread());
 
   if (input_handler_)
     input_handler_->SetRootLayerScrollOffsetDelegate(NULL);
 
@@ skipping 12 matching lines @@
   }
 }
 
 void SynchronousCompositorImpl::DidStopFlinging() {
   RenderWidgetHostViewAndroid* rwhv = static_cast<RenderWidgetHostViewAndroid*>(
       contents_->GetRenderWidgetHostView());
   if (rwhv)
     rwhv->DidStopFlinging();
 }
 
-void SynchronousCompositorImpl::SetContinuousInvalidate(bool enable) {
+void SynchronousCompositorImpl::SetContinuousInvalidate(

[boliu, 2014/10/31 16:48:21]

Prefer only have one way to get "needs_begin_frames". So make this
"NeedsBeginFrameChanged()" with the parameter removed, and then just ask BFS for
the value below.

[simonhong, 2014/11/01 02:13:06]

Done.

+    bool needs_begin_frames) const {
   DCHECK(CalledOnValidThread());
+  if (invoking_composite_)
+    return;
+
   if (compositor_client_)
-    compositor_client_->SetContinuousInvalidate(enable);
+    compositor_client_->SetContinuousInvalidate(needs_begin_frames);
 }
 
 InputEventAckState SynchronousCompositorImpl::HandleInputEvent(
     const blink::WebInputEvent& input_event) {
   DCHECK(CalledOnValidThread());
   return g_factory.Get().synchronous_input_event_filter()->HandleInputEvent(
       contents_->GetRoutingID(), input_event);
 }
 
 void SynchronousCompositorImpl::DeliverMessages() {
@@ skipping 66 matching lines @@
     g_factory.Get();  // Ensure it's initialized.
     SynchronousCompositorImpl::CreateForWebContents(contents);
   }
   if (SynchronousCompositorImpl* instance =
       SynchronousCompositorImpl::FromWebContents(contents)) {
     instance->SetClient(client);
   }
 }
 
 }  // namespace content