Add BeginFrameObserverProxy

content/browser/compositor/delegated_frame_host.h

 // Copyright 2014 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.
 
 #ifndef CONTENT_BROWSER_COMPOSITOR_DELEGATED_FRAME_HOST_H_
 #define CONTENT_BROWSER_COMPOSITOR_DELEGATED_FRAME_HOST_H_
 
 #include "cc/layers/delegated_frame_provider.h"
 #include "cc/layers/delegated_frame_resource_collection.h"
 #include "cc/output/copy_output_result.h"
 #include "cc/surfaces/surface_factory_client.h"
 #include "content/browser/compositor/image_transport_factory.h"
 #include "content/browser/compositor/owned_mailbox.h"
 #include "content/browser/renderer_host/delegated_frame_evictor.h"
 #include "content/browser/renderer_host/dip_util.h"
 #include "content/browser/renderer_host/render_widget_host_impl.h"
 #include "content/browser/renderer_host/render_widget_host_view_base.h"
 #include "content/public/browser/render_process_host.h"
 #include "ui/compositor/compositor.h"
 #include "ui/compositor/compositor_observer.h"
 #include "ui/compositor/compositor_vsync_manager.h"
 #include "ui/compositor/layer.h"
 #include "ui/compositor/layer_owner_delegate.h"
 #include "ui/gfx/geometry/rect_conversions.h"
 
 namespace cc {
 class SurfaceFactory;
 enum class SurfaceDrawStatus;
+struct BeginFrameArgs;
 }
 
 namespace media {
 class VideoFrame;
 }
 
 namespace content {
 
 class DelegatedFrameHost;
 class ReadbackYUVInterface;
@@ skipping 19 matching lines @@
       int output_surface_id,
       const cc::CompositorFrameAck& ack) = 0;
   virtual void DelegatedFrameHostSendReclaimCompositorResources(
       int output_surface_id,
       const cc::CompositorFrameAck& ack) = 0;
   virtual void DelegatedFrameHostOnLostCompositorResources() = 0;
 
   virtual void DelegatedFrameHostUpdateVSyncParameters(
       const base::TimeTicks& timebase,
       const base::TimeDelta& interval) = 0;
+  virtual void DelegatedFrameHostSendBeginFrame(
+      const cc::BeginFrameArgs& args) = 0;
 };
 
 // The DelegatedFrameHost is used to host all of the RenderWidgetHostView state
 // and functionality that is associated with delegated frames being sent from
 // the RenderWidget. The DelegatedFrameHost will push these changes through to
 // the ui::Compositor associated with its DelegatedFrameHostClient.
 class CONTENT_EXPORT DelegatedFrameHost
     : public ui::CompositorObserver,
+      public ui::CompositorBeginFrameObserver,
       public ui::CompositorVSyncManager::Observer,
       public ui::LayerOwnerDelegate,
       public ImageTransportFactoryObserver,
       public DelegatedFrameEvictorClient,
       public cc::DelegatedFrameResourceCollectionClient,
       public cc::SurfaceFactoryClient,
       public base::SupportsWeakPtr<DelegatedFrameHost> {
  public:
-  DelegatedFrameHost(DelegatedFrameHostClient* client);
+  DelegatedFrameHost(DelegatedFrameHostClient* client,
+                     bool begin_frame_scheduling_enabled);
   ~DelegatedFrameHost() override;
 
   bool CanCopyToBitmap() const;
 
   // Public interface exposed to RenderWidgetHostView.
   void SwapDelegatedFrame(
       uint32 output_surface_id,
       scoped_ptr<cc::DelegatedFrameData> frame_data,
       float frame_device_scale_factor,
       const std::vector<ui::LatencyInfo>& latency_info);
@@ skipping 11 matching lines @@
   void CopyFromCompositingSurfaceToVideoFrame(
       const gfx::Rect& src_subrect,
       const scoped_refptr<media::VideoFrame>& target,
       const base::Callback<void(bool)>& callback);
   bool CanCopyToVideoFrame() const;
   bool CanSubscribeFrame() const;
   void BeginFrameSubscription(
       scoped_ptr<RenderWidgetHostViewFrameSubscriber> subscriber);
   void EndFrameSubscription();
   bool HasFrameSubscriber() const { return frame_subscriber_; }
+  void OnSetNeedsBeginFrames(bool needs_begin_frames);
 
   // Exposed for tests.
   cc::DelegatedFrameProvider* FrameProviderForTesting() const {
     return frame_provider_.get();
   }
   cc::SurfaceId SurfaceIdForTesting() const { return surface_id_; }
   void OnCompositingDidCommitForTesting(ui::Compositor* compositor) {
     OnCompositingDidCommit(compositor);
   }
   bool ReleasedFrontLockActiveForTesting() const {
@@ skipping 16 matching lines @@
                            DestroyedAfterCopyRequest);
 
   RenderWidgetHostViewFrameSubscriber* frame_subscriber() const {
     return frame_subscriber_.get();
   }
   bool ShouldCreateResizeLock();
   void LockResources();
   void UnlockResources();
   void RequestCopyOfOutput(scoped_ptr<cc::CopyOutputRequest> request);
 
+  void StartObservingBeginFrames();
+  void StopObservingBeginFrames();
+
   // Overridden from ui::CompositorObserver:
   void OnCompositingDidCommit(ui::Compositor* compositor) override;
   void OnCompositingStarted(ui::Compositor* compositor,
                             base::TimeTicks start_time) override;
   void OnCompositingEnded(ui::Compositor* compositor) override;
   void OnCompositingAborted(ui::Compositor* compositor) override;
   void OnCompositingLockStateChanged(ui::Compositor* compositor) override;
   void OnCompositingShuttingDown(ui::Compositor* compositor) override;
 
   // Overridden from ui::CompositorVSyncManager::Observer:
   void OnUpdateVSyncParameters(base::TimeTicks timebase,
                                base::TimeDelta interval) override;
 
+  // Overridden from ui::CompositorBeginFrameObserver:
+  void OnSendBeginFrame(const cc::BeginFrameArgs& args) override;
+
   // Overridden from ui::LayerOwnerObserver:
   void OnLayerRecreated(ui::Layer* old_layer, ui::Layer* new_layer) override;
 
   // Overridden from ImageTransportFactoryObserver:
   void OnLostResources() override;
 
   bool ShouldSkipFrame(gfx::Size size_in_dip) const;
 
   // Lazily grab a resize lock if the aura window size doesn't match the current
   // frame size, to give time to the renderer.
@@ skipping 63 matching lines @@
   // the next callback in the |frame_subscriber_callbacks_| queue.
   void DeliverResultForFrameSubscriber(bool success);
 
   DelegatedFrameHostClient* const client_;
   ui::Compositor* compositor_;
 
   // True if this renders into a Surface, false if it renders into a delegated
   // layer.
   bool use_surfaces_;
 
-  std::vector<base::Closure> on_compositing_did_commit_callbacks_;

[danakj, 2015/03/13 20:04:40]

unrelated move?

[simonhong, 2015/03/17 16:11:34]

Done.

-
   // The vsync manager we are observing for changes, if any.
   scoped_refptr<ui::CompositorVSyncManager> vsync_manager_;
 
+  std::vector<base::Closure> on_compositing_did_commit_callbacks_;
+
   // The current VSync timebase and interval. These are zero until the first
   // call to OnUpdateVSyncParameters().
   base::TimeTicks vsync_timebase_;
   base::TimeDelta vsync_interval_;
 
   // With delegated renderer, this is the last output surface, used to
   // disambiguate resources with the same id coming from different output
   // surfaces.
   uint32 last_output_surface_id_;
 
@@ skipping 67 matching lines @@
   // Callback used to pass the output request to the layer or to a function
   // specified by a test.
   base::Callback<void(scoped_ptr<cc::CopyOutputRequest>)>
       request_copy_of_output_callback_for_testing_;
 
   // YUV readback pipeline.
   scoped_ptr<content::ReadbackYUVInterface>
       yuv_readback_pipeline_;
 
   scoped_ptr<DelegatedFrameEvictor> delegated_frame_evictor_;
+
+  // True when unified BeginFrame scheduing is used.

[no sievers, 2015/03/13 20:30:54]

nit: typo "scheduling'

What's 'unified'?

[brianderson, 2015/03/13 20:53:52]

It's the concept of using a common code path for platforms to send the
BeginFrame message. Probably don't need to use the word "unified" in the code.

How about:

// True when BeginFrame messages are used.

[simonhong, 2015/03/17 16:11:34]

Done.

+  bool begin_frame_scheduling_enabled_;
+
+  // True when RenderWidget needs a BeginFrame.

[no sievers, 2015/03/13 20:30:54]

nit: you mean 'need BeginFrame messages' like var name and other function names?

[simonhong, 2015/03/17 16:11:34]

Done.

+  bool needs_begin_frames_;
+
+  // Pass |last_sent_begin_frame_args_| to compositor when |this| is added as a
+  // CompositorBeginFrameObserver. With this, Compositor can determine whether
+  // latest BeginFrameArgs can be used immediately or not.
+  cc::BeginFrameArgs last_sent_begin_frame_args_;
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_COMPOSITOR_DELEGATED_FRAME_HOST_H_