File: vsync_tick_provider.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (105 lines) | stat: -rw-r--r-- 4,077 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_PEERCONNECTION_VSYNC_TICK_PROVIDER_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_PEERCONNECTION_VSYNC_TICK_PROVIDER_H_

#include <memory>
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/functional/callback_forward.h"
#include "base/memory/raw_ref.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/task/sequenced_task_runner.h"
#include "base/thread_annotations.h"
#include "base/time/time.h"
#include "third_party/blink/renderer/platform/peerconnection/vsync_provider.h"
#include "third_party/webrtc_overrides/metronome_source.h"
#include "third_party/webrtc_overrides/timer_based_tick_provider.h"

namespace blink {

// Tick provider that normally generates ticks based on callbacks from VSync
// notifications requested from a VSyncProvider. If VSyncs cease to be reported
// (such as when the tab is occluded), ticks are instead provided by a supplied
// default tick provider. When VSyncs are found to be reported again, the class
// switches back to be driven by them.
//
// After construction, all access including destruction must happen on the
// `sequence` specified on construction.
class PLATFORM_EXPORT VSyncTickProvider : public MetronomeSource::TickProvider {
 public:
  // The VSync frequency is at least 30 Hz under RTC conferencing in Chromium,
  // but can be higher depending on animation complexity on the web page.
  static constexpr base::TimeDelta kVSyncTickPeriod = base::Hertz(30);

  // Create using a begin frame provider.
  static scoped_refptr<VSyncTickProvider> Create(
      VSyncProvider& vsync_provider,
      scoped_refptr<base::SequencedTaskRunner> sequence,
      scoped_refptr<MetronomeSource::TickProvider> default_tick_provider);
  ~VSyncTickProvider() override;

  // TickProvider overrides.
  void RequestCallOnNextTick(base::OnceClosure callback) override;
  base::TimeDelta TickPeriod() override;

 private:
  VSyncTickProvider(
      VSyncProvider& vsync_provider,
      scoped_refptr<base::SequencedTaskRunner> sequence,
      scoped_refptr<MetronomeSource::TickProvider> default_tick_provider);
  void Initialize();

  // Requests a callback to OnVSync.
  void ScheduleVSync();

  // Requests a callback to OnTick.
  void ScheduleDefaultTick();

  // Called on tick from the default provider.
  void OnDefaultTick();

  // Called on vsync from the vsync provider.
  void OnVSync();

  // Processes a tick, i.e. calls out to the requested callback, if present.
  void MaybeCalloutToClient();

  // Called on tab visibility changes from the vsync provider.
  void OnTabVisibilityChange(bool visible);

  enum class State {
    // The provider is driven by the default provider.
    kDrivenByDefault,
    // The provider is switching to be driven by vsyncs, but is still awaiting a
    // first vsync callback from the provider and drives using default callbacks
    // until then.
    kAwaitingVSync,
    // The provider is driven solely by vsyncs.
    kDrivenByVSync
  };

  const raw_ref<VSyncProvider> vsync_provider_;
  const scoped_refptr<base::SequencedTaskRunner> sequence_;
  SEQUENCE_CHECKER(sequence_checker_);

  // The default tick provider, used when the tab is occluded.
  const scoped_refptr<MetronomeSource::TickProvider> default_tick_provider_
      GUARDED_BY_CONTEXT(sequence_checker_);

  // The currently scheduled tick callback.
  WTF::Vector<base::OnceClosure> tick_callbacks_
      GUARDED_BY_CONTEXT(sequence_checker_);

  // The state of this tick provider.
  State state_ GUARDED_BY_CONTEXT(sequence_checker_) = State::kDrivenByDefault;

  // Weak factory used to cancel old installed callbacks.
  base::WeakPtrFactory<VSyncTickProvider> weak_tick_factory_{this};
  base::WeakPtrFactory<VSyncTickProvider> weak_factory_{this};
};
}  // namespace blink
#endif  // THIRD_PARTY_BLINK_RENDERER_PLATFORM_PEERCONNECTION_VSYNC_TICK_PROVIDER_H_