RendererCompositorFrameSink should receive BeginFrame messages

content/renderer/gpu/renderer_compositor_frame_sink.cc

 // Copyright (c) 2012 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/renderer/gpu/renderer_compositor_frame_sink.h"
 
 #include <utility>
 
 #include "base/command_line.h"
 #include "base/location.h"
@@ skipping 11 matching lines @@
 #include "gpu/command_buffer/client/gles2_interface.h"
 #include "gpu/ipc/client/command_buffer_proxy_impl.h"
 #include "ipc/ipc_sync_channel.h"
 #include "services/ui/public/cpp/gpu/context_provider_command_buffer.h"
 
 namespace content {
 
 RendererCompositorFrameSink::RendererCompositorFrameSink(
     int32_t routing_id,
     uint32_t compositor_frame_sink_id,
-    std::unique_ptr<cc::BeginFrameSource> begin_frame_source,
+    std::unique_ptr<cc::SyntheticBeginFrameSource> synthetic_begin_frame_source,
     scoped_refptr<cc::ContextProvider> context_provider,
     scoped_refptr<cc::ContextProvider> worker_context_provider,
     gpu::GpuMemoryBufferManager* gpu_memory_buffer_manager,
     cc::SharedBitmapManager* shared_bitmap_manager,
     scoped_refptr<FrameSwapMessageQueue> swap_frame_message_queue)
     : CompositorFrameSink(std::move(context_provider),
                           std::move(worker_context_provider),
                           gpu_memory_buffer_manager,
                           shared_bitmap_manager),
       compositor_frame_sink_id_(compositor_frame_sink_id),
       compositor_frame_sink_filter_(
           RenderThreadImpl::current()->compositor_message_filter()),
       message_sender_(RenderThreadImpl::current()->sync_message_filter()),
       frame_swap_message_queue_(swap_frame_message_queue),
-      begin_frame_source_(std::move(begin_frame_source)),
+      synthetic_begin_frame_source_(std::move(synthetic_begin_frame_source)),
+      external_begin_frame_source_(
+          synthetic_begin_frame_source_
+              ? nullptr
+              : base::MakeUnique<cc::ExternalBeginFrameSource>(this)),
       routing_id_(routing_id) {
   DCHECK(compositor_frame_sink_filter_);
   DCHECK(frame_swap_message_queue_);
   DCHECK(message_sender_);
-  DCHECK(begin_frame_source_);
   thread_checker_.DetachFromThread();
 }
 
 RendererCompositorFrameSink::RendererCompositorFrameSink(
     int32_t routing_id,
     uint32_t compositor_frame_sink_id,
-    std::unique_ptr<cc::BeginFrameSource> begin_frame_source,
+    std::unique_ptr<cc::SyntheticBeginFrameSource> synthetic_begin_frame_source,
     scoped_refptr<cc::VulkanContextProvider> vulkan_context_provider,
     scoped_refptr<FrameSwapMessageQueue> swap_frame_message_queue)
     : CompositorFrameSink(std::move(vulkan_context_provider)),
       compositor_frame_sink_id_(compositor_frame_sink_id),
       compositor_frame_sink_filter_(
           RenderThreadImpl::current()->compositor_message_filter()),
       message_sender_(RenderThreadImpl::current()->sync_message_filter()),
       frame_swap_message_queue_(swap_frame_message_queue),
-      begin_frame_source_(std::move(begin_frame_source)),
+      synthetic_begin_frame_source_(std::move(synthetic_begin_frame_source)),
+      external_begin_frame_source_(
+          synthetic_begin_frame_source_
+              ? nullptr
+              : base::MakeUnique<cc::ExternalBeginFrameSource>(this)),
       routing_id_(routing_id) {
   DCHECK(compositor_frame_sink_filter_);
   DCHECK(frame_swap_message_queue_);
   DCHECK(message_sender_);
-  DCHECK(begin_frame_source_);
   thread_checker_.DetachFromThread();
 }
 
 RendererCompositorFrameSink::~RendererCompositorFrameSink() {
   // TODO(crbug.com/702764): If not detached then IPC messages would crash
   // after this class is destroyed.
   CHECK(!bound_);
 }
 
 bool RendererCompositorFrameSink::BindToClient(
     cc::CompositorFrameSinkClient* client) {
   DCHECK(thread_checker_.CalledOnValidThread());
   if (!cc::CompositorFrameSink::BindToClient(client))
     return false;
 
-  DCHECK(begin_frame_source_);
-  client_->SetBeginFrameSource(begin_frame_source_.get());
+  if (synthetic_begin_frame_source_)
+    client_->SetBeginFrameSource(synthetic_begin_frame_source_.get());
+  else
+    client_->SetBeginFrameSource(external_begin_frame_source_.get());
 
   compositor_frame_sink_proxy_ = new RendererCompositorFrameSinkProxy(this);
   compositor_frame_sink_filter_handler_ =
       base::Bind(&RendererCompositorFrameSinkProxy::OnMessageReceived,
                  compositor_frame_sink_proxy_);
   compositor_frame_sink_filter_->AddHandlerOnCompositorThread(
       routing_id_, compositor_frame_sink_filter_handler_);
   bound_ = true;
   return true;
 }
 
 void RendererCompositorFrameSink::DetachFromClient() {
   DCHECK(thread_checker_.CalledOnValidThread());
   client_->SetBeginFrameSource(nullptr);
   // Destroy the begin frame source on the same thread it was bound on.
   // The CompositorFrameSink itself is destroyed on the main thread.
-  begin_frame_source_ = nullptr;
+  external_begin_frame_source_ = nullptr;
+  synthetic_begin_frame_source_ = nullptr;
   compositor_frame_sink_proxy_->ClearCompositorFrameSink();
   compositor_frame_sink_filter_->RemoveHandlerOnCompositorThread(
       routing_id_, compositor_frame_sink_filter_handler_);
 
   cc::CompositorFrameSink::DetachFromClient();
   bound_ = false;
 }
 
 void RendererCompositorFrameSink::SubmitCompositorFrame(
     cc::CompositorFrame frame) {
@@ skipping 17 matching lines @@
         messages_to_deliver_with_frame));
     // ~send_message_scope.
   }
 }
 
 void RendererCompositorFrameSink::OnMessageReceived(
     const IPC::Message& message) {
   DCHECK(thread_checker_.CalledOnValidThread());
   IPC_BEGIN_MESSAGE_MAP(RendererCompositorFrameSink, message)
     IPC_MESSAGE_HANDLER(ViewMsg_ReclaimCompositorResources,
-                        OnReclaimCompositorResources);
+                        OnReclaimCompositorResources)
+    IPC_MESSAGE_HANDLER(ViewMsg_SetBeginFramePaused,
+                        OnSetBeginFrameSourcePaused)
+    IPC_MESSAGE_HANDLER(ViewMsg_BeginFrame, OnBeginFrame)

[Fady Samuel, 2017/03/24 21:30:31]

Where was this handled previously?

[Saman Sami, 2017/03/24 21:37:16]

Here
https://cs.chromium.org/chromium/src/content/renderer/gpu/compositor_external...
We used to pass a CompositorExternalBeginFrameSource to
RendererCompositorFrameSink instead of having a cc::ExternalBeginFrameSource in
RendererCompositorFrameSink.

   IPC_END_MESSAGE_MAP()
 }
 
 void RendererCompositorFrameSink::OnReclaimCompositorResources(
     uint32_t compositor_frame_sink_id,
     bool is_swap_ack,
     const cc::ReturnedResourceArray& resources) {
   // Ignore message if it's a stale one coming from a different output surface
   // (e.g. after a lost context).
   if (compositor_frame_sink_id != compositor_frame_sink_id_)
     return;
   client_->ReclaimResources(resources);
   if (is_swap_ack)
     client_->DidReceiveCompositorFrameAck();
 }
 
+void RendererCompositorFrameSink::OnSetBeginFrameSourcePaused(bool paused) {
+  if (external_begin_frame_source_)
+    external_begin_frame_source_->OnSetBeginFrameSourcePaused(paused);
+}
+
+void RendererCompositorFrameSink::OnBeginFrame(const cc::BeginFrameArgs& args) {
+  if (external_begin_frame_source_)
+    external_begin_frame_source_->OnBeginFrame(args);
+}
+
 bool RendererCompositorFrameSink::Send(IPC::Message* message) {
   return message_sender_->Send(message);
 }
 
 bool RendererCompositorFrameSink::ShouldAllocateNewLocalSurfaceId(
     const cc::CompositorFrame& frame) {
   cc::RenderPass* root_pass = frame.render_pass_list.back().get();
   gfx::Size frame_size = root_pass->output_rect.size();
 
   // Once the proposal in crbug.com/689754 is implemented, the LocalSurfaceId
@@ skipping 31 matching lines @@
   current_frame_data_.bottom_controls_height =
       frame.metadata.bottom_controls_height;
   current_frame_data_.bottom_controls_shown_ratio =
       frame.metadata.bottom_controls_shown_ratio;
   current_frame_data_.viewport_selection = frame.metadata.selection;
   current_frame_data_.has_transparent_background =
       root_pass->has_transparent_background;
 #endif
 }
 
+void RendererCompositorFrameSink::OnNeedsBeginFrames(bool needs_begin_frames) {
+  Send(new ViewHostMsg_SetNeedsBeginFrames(routing_id_, needs_begin_frames));
+}
+
+void RendererCompositorFrameSink::OnDidFinishFrame(
+    const cc::BeginFrameAck& ack) {
+  DCHECK_LE(cc::BeginFrameArgs::kStartingFrameNumber, ack.sequence_number);
+  // If there was damage, ViewHostMsg_SwapCompositorFrame includes the ack.
+  if (!ack.has_damage)
+    Send(new ViewHostMsg_BeginFrameDidNotSwap(routing_id_, ack));
+}
+
 }  // namespace content