[cc] Track observer status in ExternalBeginFrameSource.

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 212 matching lines @@
   std::unique_ptr<DelayBasedTimeSource> time_source_;
   std::unordered_set<BeginFrameObserver*> observers_;
   base::TimeTicks last_timebase_;
   base::TimeDelta authoritative_interval_;
   BeginFrameArgs current_begin_frame_args_;
   uint64_t next_sequence_number_;
 
   DISALLOW_COPY_AND_ASSIGN(DelayBasedBeginFrameSource);
 };
 
+// Helper class that tracks outstanding acknowledgments from
+// BeginFrameObservers.
+class CC_EXPORT BeginFrameObserverAckTracker {
+ public:
+  BeginFrameObserverAckTracker();
+  virtual ~BeginFrameObserverAckTracker();
+
+  // The BeginFrameSource uses these methods to notify us when a BeginFrame was
+  // started and sent to a specific observer, an observer finished a frame, or
+  // an observer was added/removed.
+  void OnBeginFrame(const BeginFrameArgs& args);
+  void OnObserverBeginFrame(BeginFrameObserver* obs,
+                            const BeginFrameArgs& args);
+  void OnObserverFinishedFrame(BeginFrameObserver* obs,
+                               const BeginFrameAck& ack);
+  void OnObserverAdded(BeginFrameObserver* obs);
+  void OnObserverRemoved(BeginFrameObserver* obs);
+
+  // Returns |true| if all the source's observers completed the current frame.
+  bool AllObserversFinishedFrame() const;
+
+  // Returns |true| if any observer had damage during the current frame.
+  bool AnyObserversHadDamage() const;
+
+  // Return the sequence number of the latest frame that all active observers
+  // have confirmed.
+  uint64_t LatestConfirmedSequenceNumber() const;
+
+ private:
+  void SourceChanged(const BeginFrameArgs& args);
+
+  uint32_t current_source_id_;
+  uint64_t current_sequence_number_;
+  std::set<BeginFrameObserver*> observers_;

[Sami, 2017/02/10 14:14:28]

nit: unordered_set for both of these?
edit: Ah, I guess this is required by base::STLIncludes. Nevermind then.

[brianderson, 2017/02/15 20:21:36]

Probably would be good to add a comment explaining why order matters.

[enne (OOO), 2017/02/15 23:12:25]

Maybe flat_set instead? (And SmallMap instead of unordered_map?) How many
observers do you expect to have?

[Eric Seckler, 2017/02/17 19:10:01]

All of these collections are likely very small. Done.

+  std::set<BeginFrameObserver*> finished_observers_;
+  bool observers_had_damage_;
+  std::unordered_map<BeginFrameObserver*, uint64_t>
+      latest_confirmed_sequence_numbers_;
+};
+
 class CC_EXPORT ExternalBeginFrameSourceClient {
  public:
   // Only called when changed.  Assumed false by default.
   virtual void OnNeedsBeginFrames(bool needs_begin_frames) = 0;
+  // Called when all observers have completed a frame.
+  virtual void OnDidFinishFrame(const BeginFrameAck& ack) = 0;
 };
 
 // A BeginFrameSource that is only ticked manually.  Usually the endpoint
 // of messages from some other thread/process that send OnBeginFrame and
 // receive SetNeedsBeginFrame messages.  This turns such messages back into
 // an observable BeginFrameSource.
 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,
-                      const BeginFrameAck& ack) override {}
+                      const BeginFrameAck& ack) override;
   bool IsThrottled() const override;
 
   void OnSetBeginFrameSourcePaused(bool paused);
   void OnBeginFrame(const BeginFrameArgs& args);
 
  protected:
+  void MaybeFinishFrame();
+  void FinishFrame();
+
   BeginFrameArgs missed_begin_frame_args_;
   std::unordered_set<BeginFrameObserver*> observers_;
   ExternalBeginFrameSourceClient* client_;
   bool paused_ = false;
+  bool frame_active_ = false;
+  BeginFrameObserverAckTracker ack_tracker_;

[brianderson, 2017/02/15 20:21:36]

Are there any instances of the ExternalBeginFrameSource where this is useful?

Seems like it would be more useful to add it to the BeginFrameSource(s) used by
cc::Display.

 
  private:
   DISALLOW_COPY_AND_ASSIGN(ExternalBeginFrameSource);
 };
 
 }  // namespace cc
 
 #endif  // CC_SCHEDULER_BEGIN_FRAME_SOURCE_H_