[cc] Add and use BeginFrameAck for DidFinishFrame.

cc/scheduler/begin_frame_source.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 CC_SCHEDULER_BEGIN_FRAME_SOURCE_H_
 #define CC_SCHEDULER_BEGIN_FRAME_SOURCE_H_
 
 #include <stddef.h>
 #include <stdint.h>
 
@@ skipping 86 matching lines @@
 // processing has been finished and provide information about the time values
 // of the vsync times. *However*, these values can be heavily modified or even
 // plain made up (when no vsync signal is available or vsync throttling is
 // turned off). See the BeginFrameObserver for information about the guarantees
 // all BeginFrameSources *must* provide.
 class CC_EXPORT BeginFrameSource {
  public:
   BeginFrameSource();
   virtual ~BeginFrameSource() {}
 
-  // DidFinishFrame provides back pressure to a frame source about frame
-  // processing (rather than toggling SetNeedsBeginFrames every frame). It is
-  // used by systems like the BackToBackFrameSource to make sure only one frame
-  // is pending at a time.
+  // BeginFrameObservers use DidFinishFrame to acknowledge that they have
+  // completed handling a BeginFrame.
+  //
+  // The DisplayScheduler uses these acknowledgments to trigger an early
+  // deadline once all BeginFrameObservers have completed a frame.
+  //
+  // They also provide back pressure to a frame source about frame processing
+  // (rather than toggling SetNeedsBeginFrames every frame). For example, the
+  // BackToBackFrameSource uses them to make sure only one frame is pending at a
+  // time.
+  // TODO(eseckler): Use BeginFrameAcks in DisplayScheduler as described above.
   virtual void DidFinishFrame(BeginFrameObserver* obs,
-                              size_t remaining_frames) = 0;
+                              const BeginFrameAck& ack) = 0;
 
   // Add/Remove an observer from the source. When no observers are added the BFS
   // should shut down its timers, disable vsync, etc.
   virtual void AddObserver(BeginFrameObserver* obs) = 0;
   virtual void RemoveObserver(BeginFrameObserver* obs) = 0;
 
   // Returns false if the begin frame source will just continue to produce
   // begin frames without waiting.
   virtual bool IsThrottled() const = 0;
 
   // Returns an identifier for this BeginFrameSource. Guaranteed unique within a
   // process, but not across processes. This is used to create BeginFrames that
   // originate at this source. Note that BeginFrameSources may pass on
   // BeginFrames created by other sources, with different IDs.
   uint32_t source_id() const;
 
  private:
   uint32_t source_id_;
 };
 
 // A BeginFrameSource that does nothing.
 class CC_EXPORT StubBeginFrameSource : public BeginFrameSource {
  public:
   void DidFinishFrame(BeginFrameObserver* obs,
-                      size_t remaining_frames) override {}
+                      const BeginFrameAck& ack) override {}
   void AddObserver(BeginFrameObserver* obs) override {}
   void RemoveObserver(BeginFrameObserver* obs) override {}
   bool IsThrottled() const override;
 };
 
 // A frame source which ticks itself independently.
 class CC_EXPORT SyntheticBeginFrameSource : public BeginFrameSource {
  public:
   ~SyntheticBeginFrameSource() override;
 
   virtual void OnUpdateVSyncParameters(base::TimeTicks timebase,
                                        base::TimeDelta interval) = 0;
   // This overrides any past or future interval from updating vsync parameters.
   virtual void SetAuthoritativeVSyncInterval(base::TimeDelta interval) = 0;
 };
 
 // A frame source which calls BeginFrame (at the next possible time) as soon as
 // remaining frames reaches zero.
 class CC_EXPORT BackToBackBeginFrameSource : public SyntheticBeginFrameSource,
                                              public DelayBasedTimeSourceClient {
  public:
   explicit BackToBackBeginFrameSource(
       std::unique_ptr<DelayBasedTimeSource> time_source);
   ~BackToBackBeginFrameSource() override;
 
   // BeginFrameSource implementation.
   void AddObserver(BeginFrameObserver* obs) override;
   void RemoveObserver(BeginFrameObserver* obs) override;
   void DidFinishFrame(BeginFrameObserver* obs,
-                      size_t remaining_frames) override;
+                      const BeginFrameAck& ack) override;
   bool IsThrottled() const override;
 
   // SyntheticBeginFrameSource implementation.
   void OnUpdateVSyncParameters(base::TimeTicks timebase,
                                base::TimeDelta interval) override {}
   void SetAuthoritativeVSyncInterval(base::TimeDelta interval) override {}
 
   // DelayBasedTimeSourceClient implementation.
   void OnTimerTick() override;
 
@@ skipping 13 matching lines @@
                                              public DelayBasedTimeSourceClient {
  public:
   explicit DelayBasedBeginFrameSource(
       std::unique_ptr<DelayBasedTimeSource> time_source);
   ~DelayBasedBeginFrameSource() override;
 
   // BeginFrameSource implementation.
   void AddObserver(BeginFrameObserver* obs) override;
   void RemoveObserver(BeginFrameObserver* obs) override;
   void DidFinishFrame(BeginFrameObserver* obs,
-                      size_t remaining_frames) override {}
+                      const BeginFrameAck& ack) override {}
   bool IsThrottled() const override;
 
   // SyntheticBeginFrameSource implementation.
   void OnUpdateVSyncParameters(base::TimeTicks timebase,
                                base::TimeDelta interval) override;
   void SetAuthoritativeVSyncInterval(base::TimeDelta interval) override;
 
   // DelayBasedTimeSourceClient implementation.
   void OnTimerTick() override;
 
@@ skipping 24 matching lines @@
 class CC_EXPORT ExternalBeginFrameSource : public BeginFrameSource {
  public:
   // Client lifetime must be preserved by owner past the lifetime of this class.
   explicit ExternalBeginFrameSource(ExternalBeginFrameSourceClient* client);
   ~ExternalBeginFrameSource() override;
 
   // BeginFrameSource implementation.
   void AddObserver(BeginFrameObserver* obs) override;
   void RemoveObserver(BeginFrameObserver* obs) override;
   void DidFinishFrame(BeginFrameObserver* obs,
-                      size_t remaining_frames) override {}
+                      const BeginFrameAck& ack) override {}
   bool IsThrottled() const override;
 
   void OnSetBeginFrameSourcePaused(bool paused);
   void OnBeginFrame(const BeginFrameArgs& args);
 
  protected:
   BeginFrameArgs missed_begin_frame_args_;
   std::unordered_set<BeginFrameObserver*> observers_;
   ExternalBeginFrameSourceClient* client_;
   bool paused_ = false;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(ExternalBeginFrameSource);
 };
 
 }  // namespace cc
 
 #endif  // CC_SCHEDULER_BEGIN_FRAME_SOURCE_H_