Android: Move scheduling logic to CompositorImpl

content/browser/renderer_host/compositor_impl_android.h

 // 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.
 
 #ifndef CONTENT_BROWSER_RENDERER_HOST_COMPOSITOR_IMPL_ANDROID_H_
 #define CONTENT_BROWSER_RENDERER_HOST_COMPOSITOR_IMPL_ANDROID_H_
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/containers/scoped_ptr_hash_map.h"
 #include "base/memory/scoped_ptr.h"
+#include "base/memory/weak_ptr.h"
 #include "cc/resources/ui_resource_client.h"
 #include "cc/trees/layer_tree_host_client.h"
 #include "cc/trees/layer_tree_host_single_thread_client.h"
 #include "content/browser/renderer_host/image_transport_factory_android.h"
 #include "content/common/content_export.h"
 #include "content/public/browser/android/compositor.h"
 #include "third_party/khronos/GLES2/gl2.h"
 #include "ui/base/android/window_android_compositor.h"
 
 class SkBitmap;
@@ skipping 34 matching lines @@
   // Compositor implementation.
   virtual void SetRootLayer(scoped_refptr<cc::Layer> root) OVERRIDE;
   virtual void SetWindowSurface(ANativeWindow* window) OVERRIDE;
   virtual void SetSurface(jobject surface) OVERRIDE;
   virtual void SetVisible(bool visible) OVERRIDE;
   virtual void setDeviceScaleFactor(float factor) OVERRIDE;
   virtual void SetWindowBounds(const gfx::Size& size) OVERRIDE;
   virtual void SetHasTransparentBackground(bool flag) OVERRIDE;
   virtual bool CompositeAndReadback(
       void *pixels, const gfx::Rect& rect) OVERRIDE;
-  virtual void Composite() OVERRIDE;
+  virtual void SetNeedsComposite() OVERRIDE;
   virtual cc::UIResourceId GenerateUIResource(const SkBitmap& bitmap,
                                               bool is_transient) OVERRIDE;
   virtual cc::UIResourceId GenerateCompressedUIResource(const gfx::Size& size,
                                                         void* pixels,
                                                         bool is_transient)
       OVERRIDE;
   virtual void DeleteUIResource(cc::UIResourceId resource_id) OVERRIDE;
 
   // LayerTreeHostClient implementation.
   virtual void WillBeginMainFrame(int frame_id) OVERRIDE {}
   virtual void DidBeginMainFrame() OVERRIDE {}
   virtual void Animate(base::TimeTicks frame_begin_time) OVERRIDE {}
-  virtual void Layout() OVERRIDE {}
+  virtual void Layout() OVERRIDE;
   virtual void ApplyScrollAndScale(const gfx::Vector2d& scroll_delta,
                                    float page_scale) OVERRIDE {}
   virtual scoped_ptr<cc::OutputSurface> CreateOutputSurface(bool fallback)
       OVERRIDE;
   virtual void DidInitializeOutputSurface() OVERRIDE {}
   virtual void WillCommit() OVERRIDE {}
   virtual void DidCommit() OVERRIDE;
   virtual void DidCommitAndDrawFrame() OVERRIDE {}
   virtual void DidCompleteSwapBuffers() OVERRIDE;
 
   // LayerTreeHostSingleThreadClient implementation.
   virtual void ScheduleComposite() OVERRIDE;
   virtual void ScheduleAnimation() OVERRIDE;
   virtual void DidPostSwapBuffers() OVERRIDE;
   virtual void DidAbortSwapBuffers() OVERRIDE;
 
   // ImageTransportFactoryAndroidObserver implementation.
   virtual void OnLostResources() OVERRIDE;
 
   // WindowAndroidCompositor implementation.
   virtual void AttachLayerForReadback(scoped_refptr<cc::Layer> layer) OVERRIDE;
+  virtual void OnVSync(base::TimeTicks frame_time,
+                       base::TimeDelta vsync_period) OVERRIDE;
 
  private:
+  void PostComposite(base::TimeDelta delay);
+  void Composite(bool is_vsync);

[Sami, 2014/05/09 13:21:14]

Mind making this an enum -- CompositingTrigger or something? I'm allergic to
opaque bool parameters :)

[no sievers, 2014/05/09 22:53:44]

Done.

   cc::UIResourceId GenerateUIResourceFromUIResourceBitmap(
       const cc::UIResourceBitmap& bitmap,
       bool is_transient);
 
   scoped_refptr<cc::Layer> root_layer_;
   scoped_ptr<cc::LayerTreeHost> host_;
 
   gfx::Size size_;
   bool has_transparent_background_;
   float device_scale_factor_;
 
   ANativeWindow* window_;
   int surface_id_;
 
   CompositorClient* client_;
 
   typedef base::ScopedPtrHashMap<cc::UIResourceId, cc::UIResourceClient>
       UIResourceMap;
   UIResourceMap ui_resource_map_;
 
   gfx::NativeWindow root_window_;
 
+  // Used locally to track whether a call to LTH::Composite() did result in
+  // a posted SwapBuffers().
+  bool did_post_swapbuffers_;
+
+  // Used locally to inhibit ScheduleComposite() during Layout().
+  bool ignore_schedule_composite_;
+
+  // Whether we need to composite in general because of any invalidation or
+  // explicit request.
+  bool needs_composite_;
+
+  // When SetNeedsComposite() is getting called, we will try to schedule

[Sami, 2014/05/09 13:21:14]

This explanation should probably go next to SetNeedsComposite. ScheduleComposite
could also use a comment about what the difference between the two is.

[no sievers, 2014/05/09 22:53:44]

ScheduleComposite is the LTHClient implementation. I've made the whole derived
implementation private and added comments inside both functions.

Compositor::SetNeedsComposite() has a general comment about when it should be
called in the public header.

+  // regularly during vsync.
+  bool should_composite_on_vsync_;
+
+  // Whether we composited immediately outside of a vsync callback since
+  // the last tick.
+  bool did_composite_outside_vsync_;

[Sami, 2014/05/09 13:21:14]

Would something did_composite_during_this_frame_ be simpler? No matter why we
composite, we only want to do it once per frame.

[no sievers, 2014/05/09 22:53:44]

Done.

+
+  // The number of SwapBuffer calls that have not returned and ACK'd from
+  // the GPU thread.
+  unsigned int pending_swapbuffers_;
+
+  base::TimeDelta vsync_period_;
+
+  base::WeakPtrFactory<CompositorImpl> weak_factory_;
+
   DISALLOW_COPY_AND_ASSIGN(CompositorImpl);
 };
 
 } // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_COMPOSITOR_IMPL_ANDROID_H_