cc/scheduler/scheduler.h

   1 // Copyright 2011 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CC_SCHEDULER_SCHEDULER_H_
   6 #define CC_SCHEDULER_SCHEDULER_H_
   7
   8 #include <deque>
   9 #include <string>
  10
  11 #include "base/basictypes.h"
  12 #include "base/cancelable_callback.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/time/time.h"
  15 #include "cc/base/cc_export.h"
  16 #include "cc/output/begin_frame_args.h"
  17 #include "cc/output/vsync_parameter_observer.h"
  18 #include "cc/scheduler/begin_frame_source.h"
  19 #include "cc/scheduler/delay_based_time_source.h"
  20 #include "cc/scheduler/draw_result.h"
  21 #include "cc/scheduler/scheduler_settings.h"
  22 #include "cc/scheduler/scheduler_state_machine.h"
  23
  24 namespace base {
  25 namespace trace_event {
  26 class ConvertableToTraceFormat;
  27 }
  28 class SingleThreadTaskRunner;
  29 }
  30
  31 namespace cc {
  32
  33 class SchedulerClient {
  34  public:
  35   virtual void WillBeginImplFrame(const BeginFrameArgs& args) = 0;
  36   virtual void ScheduledActionSendBeginMainFrame() = 0;
  37   virtual DrawResult ScheduledActionDrawAndSwapIfPossible() = 0;
  38   virtual DrawResult ScheduledActionDrawAndSwapForced() = 0;
  39   virtual void ScheduledActionAnimate() = 0;
  40   virtual void ScheduledActionCommit() = 0;
  41   virtual void ScheduledActionActivateSyncTree() = 0;
  42   virtual void ScheduledActionBeginOutputSurfaceCreation() = 0;
  43   virtual void ScheduledActionPrepareTiles() = 0;
  44   virtual void ScheduledActionInvalidateOutputSurface() = 0;
  45   virtual void DidAnticipatedDrawTimeChange(base::TimeTicks time) = 0;
  46   virtual base::TimeDelta DrawDurationEstimate() = 0;
  47   virtual base::TimeDelta BeginMainFrameToCommitDurationEstimate() = 0;
  48   virtual base::TimeDelta CommitToActivateDurationEstimate() = 0;
  49   // TODO(sunnyps): Rename DidBeginImplFrameDeadline to DidFinishImplFrame.
  50   virtual void DidBeginImplFrameDeadline() = 0;
  51   virtual void SendBeginFramesToChildren(const BeginFrameArgs& args) = 0;
  52   virtual void SendBeginMainFrameNotExpectedSoon() = 0;
  53
  54  protected:
  55   virtual ~SchedulerClient() {}
  56 };
  57
  58 class Scheduler;
  59 // This class exists to allow tests to override the frame source construction.
  60 // A virtual method can't be used as this needs to happen in the constructor
  61 // (see C++ FAQ / Section 23 - http://goo.gl/fnrwom for why).
  62 // This class exists solely long enough to construct the frame sources.
  63 class CC_EXPORT SchedulerFrameSourcesConstructor {
  64  public:
  65   virtual ~SchedulerFrameSourcesConstructor() {}
  66   virtual BeginFrameSource* ConstructPrimaryFrameSource(Scheduler* scheduler);
  67   virtual BeginFrameSource* ConstructBackgroundFrameSource(
  68       Scheduler* scheduler);
  69   virtual BeginFrameSource* ConstructUnthrottledFrameSource(
  70       Scheduler* scheduler);
  71
  72  protected:
  73   SchedulerFrameSourcesConstructor() {}
  74
  75   friend class Scheduler;
  76 };
  77
  78 class CC_EXPORT Scheduler : public BeginFrameObserverMixIn {
  79  public:
  80   static scoped_ptr<Scheduler> Create(
  81       SchedulerClient* client,
  82       const SchedulerSettings& scheduler_settings,
  83       int layer_tree_host_id,
  84       const scoped_refptr<base::SingleThreadTaskRunner>& task_runner,
  85       scoped_ptr<BeginFrameSource> external_begin_frame_source) {
  86     SchedulerFrameSourcesConstructor frame_sources_constructor;
  87     return make_scoped_ptr(new Scheduler(client,
  88                                          scheduler_settings,
  89                                          layer_tree_host_id,
  90                                          task_runner,
  91                                          external_begin_frame_source.Pass(),
  92                                          &frame_sources_constructor));
  93   }
  94
  95   ~Scheduler() override;
  96
  97   // BeginFrameObserverMixin
  98   bool OnBeginFrameMixInDelegate(const BeginFrameArgs& args) override;
  99
 100   void OnDrawForOutputSurface();
 101
 102   const SchedulerSettings& settings() const { return settings_; }
 103
 104   void CommitVSyncParameters(base::TimeTicks timebase,
 105                              base::TimeDelta interval);
 106   void SetEstimatedParentDrawTime(base::TimeDelta draw_time);
 107
 108   void SetCanStart();
 109
 110   void SetVisible(bool visible);
 111   void SetCanDraw(bool can_draw);
 112   void NotifyReadyToActivate();
 113   void NotifyReadyToDraw();
 114   void SetThrottleFrameProduction(bool throttle);
 115
 116   void SetNeedsCommit();
 117
 118   void SetNeedsRedraw();
 119
 120   void SetNeedsAnimate();
 121
 122   void SetNeedsPrepareTiles();
 123
 124   void SetWaitForReadyToDraw();
 125
 126   void SetMaxSwapsPending(int max);
 127   void DidSwapBuffers();
 128   void DidSwapBuffersComplete();
 129
 130   void SetImplLatencyTakesPriority(bool impl_latency_takes_priority);
 131
 132   void NotifyReadyToCommit();
 133   void BeginMainFrameAborted(CommitEarlyOutReason reason);
 134
 135   void DidPrepareTiles();
 136   void DidLoseOutputSurface();
 137   void DidCreateAndInitializeOutputSurface();
 138
 139   // Tests do not want to shut down until all possible BeginMainFrames have
 140   // occured to prevent flakiness.
 141   bool MainFrameForTestingWillHappen() const {
 142     return state_machine_.CommitPending() ||
 143            state_machine_.CouldSendBeginMainFrame();
 144   }
 145
 146   bool CommitPending() const { return state_machine_.CommitPending(); }
 147   bool RedrawPending() const { return state_machine_.RedrawPending(); }
 148   bool PrepareTilesPending() const {
 149     return state_machine_.PrepareTilesPending();
 150   }
 151   bool MainThreadIsInHighLatencyMode() const {
 152     return state_machine_.MainThreadIsInHighLatencyMode();
 153   }
 154   bool BeginImplFrameDeadlinePending() const {
 155     return !begin_impl_frame_deadline_task_.IsCancelled();
 156   }
 157
 158   base::TimeTicks AnticipatedDrawTime() const;
 159
 160   void NotifyBeginMainFrameStarted();
 161
 162   base::TimeTicks LastBeginImplFrameTime();
 163
 164   void SetDeferCommits(bool defer_commits);
 165
 166   scoped_refptr<base::trace_event::ConvertableToTraceFormat> AsValue() const;
 167   void AsValueInto(base::trace_event::TracedValue* value) const override;
 168
 169   void SetContinuousPainting(bool continuous_painting) {
 170     state_machine_.SetContinuousPainting(continuous_painting);
 171   }
 172
 173   void SetChildrenNeedBeginFrames(bool children_need_begin_frames);
 174
 175   void SetAuthoritativeVSyncInterval(const base::TimeDelta& interval);
 176
 177  protected:
 178   Scheduler(SchedulerClient* client,
 179             const SchedulerSettings& scheduler_settings,
 180             int layer_tree_host_id,
 181             const scoped_refptr<base::SingleThreadTaskRunner>& task_runner,
 182             scoped_ptr<BeginFrameSource> external_begin_frame_source,
 183             SchedulerFrameSourcesConstructor* frame_sources_constructor);
 184
 185   // virtual for testing - Don't call these in the constructor or
 186   // destructor!
 187   virtual base::TimeTicks Now() const;
 188
 189   scoped_ptr<BeginFrameSourceMultiplexer> frame_source_;
 190   BeginFrameSource* primary_frame_source_;
 191   BeginFrameSource* background_frame_source_;
 192   BeginFrameSource* unthrottled_frame_source_;
 193
 194   // Storage when frame sources are internal
 195   scoped_ptr<BeginFrameSource> primary_frame_source_internal_;
 196   scoped_ptr<SyntheticBeginFrameSource> background_frame_source_internal_;
 197   scoped_ptr<BeginFrameSource> unthrottled_frame_source_internal_;
 198
 199   VSyncParameterObserver* vsync_observer_;
 200   base::TimeDelta authoritative_vsync_interval_;
 201   base::TimeTicks last_vsync_timebase_;
 202
 203   bool throttle_frame_production_;
 204
 205   const SchedulerSettings settings_;
 206   SchedulerClient* client_;
 207   int layer_tree_host_id_;
 208   scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
 209
 210   base::TimeDelta estimated_parent_draw_time_;
 211
 212   std::deque<BeginFrameArgs> begin_retro_frame_args_;
 213   BeginFrameArgs begin_impl_frame_args_;
 214   SchedulerStateMachine::BeginImplFrameDeadlineMode
 215       begin_impl_frame_deadline_mode_;
 216
 217   base::Closure begin_retro_frame_closure_;
 218   base::Closure begin_impl_frame_deadline_closure_;
 219   base::Closure advance_commit_state_closure_;
 220   base::CancelableClosure begin_retro_frame_task_;
 221   base::CancelableClosure begin_impl_frame_deadline_task_;
 222   base::CancelableClosure advance_commit_state_task_;
 223
 224   SchedulerStateMachine state_machine_;
 225   bool inside_process_scheduled_actions_;
 226   SchedulerStateMachine::Action inside_action_;
 227
 228  private:
 229   void ScheduleBeginImplFrameDeadline();
 230   void ScheduleBeginImplFrameDeadlineIfNeeded();
 231   void SetupNextBeginFrameIfNeeded();
 232   void PostBeginRetroFrameIfNeeded();
 233   void SetupPollingMechanisms();
 234   void DrawAndSwapIfPossible();
 235   void ProcessScheduledActions();
 236   bool CanCommitAndActivateBeforeDeadline() const;
 237   void AdvanceCommitStateIfPossible();
 238   bool IsBeginMainFrameSentOrStarted() const;
 239   void BeginRetroFrame();
 240   void BeginImplFrameWithDeadline(const BeginFrameArgs& args);
 241   void BeginImplFrameSynchronous(const BeginFrameArgs& args);
 242   void BeginImplFrame(const BeginFrameArgs& args);
 243   void FinishImplFrame();
 244   void OnBeginImplFrameDeadline();
 245   void PollToAdvanceCommitState();
 246   void UpdateActiveFrameSource();
 247
 248   base::TimeDelta EstimatedParentDrawTime() {
 249     return estimated_parent_draw_time_;
 250   }
 251
 252   bool IsInsideAction(SchedulerStateMachine::Action action) {
 253     return inside_action_ == action;
 254   }
 255
 256   base::WeakPtrFactory<Scheduler> weak_factory_;
 257
 258   friend class SchedulerFrameSourcesConstructor;
 259   friend class TestSchedulerFrameSourcesConstructor;
 260
 261   DISALLOW_COPY_AND_ASSIGN(Scheduler);
 262 };
 263
 264 }  // namespace cc
 265
 266 #endif  // CC_SCHEDULER_SCHEDULER_H_