File: pending_animations.cc

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; 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,806; 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 (264 lines) | stat: -rw-r--r-- 10,870 bytes parent folder | download | duplicates (5)
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
/*
 * Copyright (C) 2013 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "third_party/blink/renderer/core/animation/pending_animations.h"

#include "base/auto_reset.h"
#include "third_party/blink/renderer/core/animation/document_timeline.h"
#include "third_party/blink/renderer/core/animation/keyframe_effect.h"
#include "third_party/blink/renderer/core/dom/document.h"
#include "third_party/blink/renderer/core/frame/local_frame_view.h"
#include "third_party/blink/renderer/core/page/page.h"
#include "third_party/blink/renderer/platform/instrumentation/tracing/trace_event.h"

namespace blink {

void PendingAnimations::Add(Animation* animation) {
  DCHECK(animation);
  DCHECK_EQ(pending_.Find(animation), kNotFound);
  pending_.push_back(animation);

  Document* document = animation->GetDocument();
  if (document->View())
    document->View()->ScheduleAnimation();

  bool visible = document->GetPage() && document->GetPage()->IsPageVisible();
  if (!visible && !timer_.IsActive()) {
    // Verify the timer is not activated in cycles.
    CHECK(!inside_timer_fired_);
    timer_.StartOneShot(base::TimeDelta(), FROM_HERE);
  }
}

bool PendingAnimations::Update(
    const PaintArtifactCompositor* paint_artifact_compositor,
    bool start_on_compositor) {
  HeapVector<Member<Animation>> waiting_for_start_time;
  bool started_synchronized_on_compositor = false;

  HeapVector<Member<Animation>> animations;
  HeapVector<Member<Animation>> deferred;
  animations.swap(pending_);
  int compositor_group = NextCompositorGroup();

  for (auto& animation : animations) {
    bool had_compositor_animation =
        animation->HasActiveAnimationsOnCompositor() ||
        animation->CompositorPendingCancel();
    // Animations with a start time or non-monotonic timeline do not participate
    // in compositor start-time grouping.
    bool has_monotonic_timeline =
        animation->TimelineInternal() &&
        animation->TimelineInternal()->IsMonotonicallyIncreasing();
    // Note, not setting a compositor group means animation events may be
    // dropped or mis-routed since they'll all target group 1. This doesn't
    // cause any issues currently, since blink::Animation only implements
    // NotifyAnimationStarted, but it would be an issue if Blink ever wanted to
    // handle the other events in CompositorAnimationDelegate.
    bool use_compositor_group =
        !animation->StartTimeInternal() && has_monotonic_timeline;
    if (animation->PreCommit(use_compositor_group ? compositor_group : 1,
                             paint_artifact_compositor, start_on_compositor)) {
      if (animation->HasActiveAnimationsOnCompositor() &&
          !had_compositor_animation && use_compositor_group) {
        started_synchronized_on_compositor = true;
      }

      if (!animation->TimelineInternal() ||
          !animation->TimelineInternal()->IsActive()) {
        continue;
      }

      if (animation->Playing() && !animation->StartTimeInternal()) {
        // Scroll timelines get their start time set during timeline validation
        // and do not need to be added to the list. Once the start time is set
        // they must be re-added to the pending animations.
        if (has_monotonic_timeline) {
          waiting_for_start_time.push_back(animation.Get());
        }
      } else if (animation->PendingInternal()) {
        DCHECK(animation->TimelineInternal()->IsActive() &&
               animation->TimelineInternal()->CurrentTime() &&
               animation->CurrentTimeInternal());
        // A pending animation that is not waiting on a start time does not need
        // to be synchronized with animations that are starting up. Nonetheless,
        // it needs to notify the animation to resolve the ready promise and
        // commit the pending state.
        animation->NotifyReady(
            animation->TimelineInternal()->CurrentTime().value());
      }
    } else if (animation->CurrentTimeInternal()) {
      // TODO(crbug.com/397451098): We shouldn't need to push these on a
      // deferred list for re-injection into the pending list. The start of the
      // animation on the compositor will trigger NotifyReady. Any change to the
      // animation that would affect the state of the animation must call
      // SetCompositorPending, which will add it back to the pending list.
      deferred.push_back(animation);
    }
  }

  // If any synchronized animations were started on the compositor, all
  // remaining synchronized animations need to wait for the synchronized
  // start time. Otherwise they may start immediately.
  if (started_synchronized_on_compositor) {
    FlushWaitingNonCompositedAnimations();
    waiting_for_compositor_animation_start_.AppendVector(
        waiting_for_start_time);
  } else {
    // Main-threaded animations previously held up for sync with the compositor
    // are no longer held up.
    for (auto& animation : waiting_for_start_time) {
      if (animation->HasActiveAnimationsOnCompositor()) {
        // A composited animation needs to continue waiting, otherwise the
        // start time on the compositor and main-thread will be misaligned.
        continue;
      }
      DCHECK(!animation->StartTimeInternal());
      DCHECK(animation->TimelineInternal()->IsActive() &&
             animation->TimelineInternal()->CurrentTime());
      animation->NotifyReady(
          animation->TimelineInternal()->CurrentTime().value());
    }
  }

  // FIXME: The postCommit should happen *after* the commit, not before.
  for (auto& animation : animations)
    animation->PostCommit();

  DCHECK(pending_.empty());
  DCHECK(start_on_compositor || deferred.empty());
  for (auto& animation : deferred) {
    animation->SetCompositorPending(
        Animation::CompositorPendingReason::kPendingUpdate);
  }
  DCHECK_EQ(pending_.size(), deferred.size());

  if (started_synchronized_on_compositor)
    return true;

  if (waiting_for_compositor_animation_start_.empty())
    return false;

  // Check if we're still waiting for any compositor animations to start.
  for (auto& animation : waiting_for_compositor_animation_start_) {
    if (animation->HasActiveAnimationsOnCompositor()) {
      return true;
    }
  }

  // If not, go ahead and start any animations that were waiting.
  NotifyCompositorAnimationStarted(
      base::TimeTicks::Now().since_origin().InSecondsF());

  DCHECK_EQ(pending_.size(), deferred.size());
  return false;
}

void PendingAnimations::NotifyCompositorAnimationStarted(
    double monotonic_animation_start_time,
    int compositor_group) {
  TRACE_EVENT0("blink", "PendingAnimations::notifyCompositorAnimationStarted");

  HeapVector<Member<Animation>> animations;
  animations.swap(waiting_for_compositor_animation_start_);

  for (auto animation : animations) {
    if (animation->StartTimeInternal() || !animation->PendingInternal() ||
        !animation->TimelineInternal() ||
        !animation->TimelineInternal()->IsActive()) {
      // Already started or no longer relevant.
      continue;
    }
    if (!animation->CurrentTimeInternal()) {
      // Waiting on a deferred start time.
      continue;
    }
    if (compositor_group && animation->CompositorGroup() != compositor_group) {
      // Still waiting.
      waiting_for_compositor_animation_start_.push_back(animation);
      continue;
    }
    if (!animation->TimelineInternal()->IsMonotonicallyIncreasing()) {
      animation->NotifyReady(
          animation->TimelineInternal()->CurrentTime().value());
    } else {
      animation->NotifyReady(
          ANIMATION_TIME_DELTA_FROM_SECONDS(monotonic_animation_start_time) -
          animation->TimelineInternal()->ZeroTime());
    }
  }
}

int PendingAnimations::NextCompositorGroup() {
  do {
    // Wrap around, skipping 0, 1.
    // * 0 is reserved for automatic assignment
    // * 1 is used for animations with a specified start time
    ++compositor_group_;
  } while (compositor_group_ == 0 || compositor_group_ == 1);

  return compositor_group_;
}

void PendingAnimations::FlushWaitingNonCompositedAnimations() {
  if (waiting_for_compositor_animation_start_.empty())
    return;

  // Start any main thread animations that were scheduled to wait on
  // compositor synchronization from a previous frame. Otherwise, a
  // continuous influx of new composited animations could delay the start
  // of non-composited animations indefinitely (crbug.com/666710).
  HeapVector<Member<Animation>> animations;
  animations.swap(waiting_for_compositor_animation_start_);
  for (auto& animation : animations) {
    if (animation->HasActiveAnimationsOnCompositor()) {
      waiting_for_compositor_animation_start_.push_back(animation);
    } else if (animation->TimelineInternal() &&
               animation->TimelineInternal()->IsActive() &&
               animation->TimelineInternal()->CurrentTime().has_value() &&
               animation->CurrentTimeInternal()) {
      animation->NotifyReady(
          animation->TimelineInternal()->CurrentTime().value());
    }
  }
}

void PendingAnimations::Trace(Visitor* visitor) const {
  visitor->Trace(pending_);
  visitor->Trace(waiting_for_compositor_animation_start_);
  visitor->Trace(timer_);
}

void PendingAnimations::TimerFired(TimerBase*) {
  base::AutoReset<bool> mark_inside(&inside_timer_fired_, true);
  Update(nullptr, false);
}

}  // namespace blink