forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathkeyframe_effect.cc
1074 lines (944 loc) · 39.7 KB
/
keyframe_effect.cc
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2017 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.
#include "cc/animation/keyframe_effect.h"
#include <algorithm>
#include <memory>
#include <string>
#include <utility>
#include "base/containers/cxx20_erase.h"
#include "base/time/time.h"
#include "cc/animation/animation.h"
#include "cc/animation/animation_host.h"
#include "cc/animation/animation_timeline.h"
#include "cc/animation/scroll_offset_animation_curve.h"
#include "cc/trees/property_animation_state.h"
#include "ui/gfx/animation/keyframe/animation_curve.h"
#include "ui/gfx/animation/keyframe/target_property.h"
#include "ui/gfx/transform_operations.h"
namespace cc {
namespace {
bool NeedsFinishedEvent(KeyframeModel* keyframe_model) {
// The controlling instance (i.e., impl instance), sends the finish event and
// does not need to receive it.
if (keyframe_model->is_controlling_instance())
return false;
return !keyframe_model->received_finished_event();
}
// Returns indices for keyframe_models that have matching group id.
std::vector<size_t> FindAnimationsWithSameGroupId(
const std::vector<std::unique_ptr<gfx::KeyframeModel>>& keyframe_models,
int group_id) {
std::vector<size_t> group;
for (size_t i = 0; i < keyframe_models.size(); ++i) {
auto* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_models[i].get());
if (cc_keyframe_model->group() != group_id)
continue;
group.push_back(i);
}
return group;
}
} // namespace
KeyframeEffect::KeyframeEffect(Animation* animation)
: animation_(animation),
element_animations_(),
needs_to_start_keyframe_models_(false),
scroll_offset_animation_was_interrupted_(false),
is_ticking_(false),
needs_push_properties_(false) {}
KeyframeEffect::~KeyframeEffect() {
DCHECK(!has_bound_element_animations());
}
void KeyframeEffect::SetNeedsPushProperties() {
needs_push_properties_ = true;
// TODO(smcgruer): We only need the below calls when needs_push_properties_
// goes from false to true - see http://crbug.com/764405
DCHECK(element_animations());
element_animations()->SetNeedsPushProperties();
animation_->SetNeedsPushProperties();
}
void KeyframeEffect::BindElementAnimations(
ElementAnimations* element_animations) {
DCHECK(element_animations);
DCHECK(!element_animations_);
element_animations_ = element_animations;
DCHECK(element_id_);
DCHECK(element_id_ == element_animations->element_id());
if (has_any_keyframe_model())
KeyframeModelAdded();
SetNeedsPushProperties();
}
void KeyframeEffect::UnbindElementAnimations() {
SetNeedsPushProperties();
element_animations_ = nullptr;
}
void KeyframeEffect::AttachElement(ElementId element_id) {
DCHECK(!element_id_);
DCHECK(element_id);
element_id_ = element_id;
}
void KeyframeEffect::DetachElement() {
DCHECK(element_id_);
element_id_ = ElementId();
}
void KeyframeEffect::Tick(base::TimeTicks monotonic_time) {
DCHECK(has_bound_element_animations());
if (!element_animations_->has_element_in_any_list())
return;
if (needs_to_start_keyframe_models_)
StartKeyframeModels(monotonic_time);
for (auto& keyframe_model : keyframe_models()) {
TickKeyframeModel(monotonic_time, keyframe_model.get());
}
last_tick_time_ = monotonic_time;
element_animations_->UpdateClientAnimationState();
}
void KeyframeEffect::RemoveFromTicking() {
is_ticking_ = false;
// Resetting last_tick_time_ here ensures that calling ::UpdateState
// before ::Animate doesn't start a keyframe model.
last_tick_time_ = absl::nullopt;
animation_->RemoveFromTicking();
}
void KeyframeEffect::UpdateState(bool start_ready_keyframe_models,
AnimationEvents* events) {
DCHECK(has_bound_element_animations());
// Animate hasn't been called, this happens if an element has been added
// between the Commit and Draw phases.
if (last_tick_time_ == absl::nullopt)
start_ready_keyframe_models = false;
if (start_ready_keyframe_models)
PromoteStartedKeyframeModels(events);
auto last_tick_time = last_tick_time_.value_or(base::TimeTicks());
MarkFinishedKeyframeModels(last_tick_time);
MarkKeyframeModelsForDeletion(last_tick_time, events);
PurgeKeyframeModelsMarkedForDeletion(/* impl_only */ true);
if (start_ready_keyframe_models) {
if (needs_to_start_keyframe_models_) {
StartKeyframeModels(last_tick_time);
PromoteStartedKeyframeModels(events);
}
}
if (!element_animations()->has_element_in_any_list())
RemoveFromTicking();
}
void KeyframeEffect::UpdateTickingState() {
if (animation_->has_animation_host()) {
bool was_ticking = is_ticking_;
is_ticking_ = HasNonDeletedKeyframeModel() &&
element_animations_->has_element_in_any_list();
if (is_ticking_ && !was_ticking) {
animation_->AddToTicking();
} else if (!is_ticking_ && was_ticking) {
RemoveFromTicking();
}
}
}
void KeyframeEffect::Pause(base::TimeDelta pause_offset,
PauseCondition pause_condition) {
bool did_pause = false;
for (auto& keyframe_model : keyframe_models()) {
// TODO(crbug.com/1076012): KeyframeEffect is paused with local time for
// scroll-linked animations. To make sure the start event of a keyframe
// model is sent to blink, we should not set its run state to PAUSED until
// such event is sent. This should be revisited once KeyframeEffect is able
// to tick scroll-linked keyframe models directly.
if (pause_condition == PauseCondition::kAfterStart &&
(keyframe_model->run_state() ==
gfx::KeyframeModel::WAITING_FOR_TARGET_AVAILABILITY ||
keyframe_model->run_state() == gfx::KeyframeModel::STARTING))
continue;
keyframe_model->Pause(pause_offset);
did_pause = true;
}
if (!did_pause || !has_bound_element_animations())
return;
animation_->SetNeedsCommit();
SetNeedsPushProperties();
}
void KeyframeEffect::AddKeyframeModel(
std::unique_ptr<gfx::KeyframeModel> keyframe_model) {
KeyframeModel* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_model.get());
DCHECK(!cc_keyframe_model->is_impl_only() ||
keyframe_model->TargetProperty() == TargetProperty::SCROLL_OFFSET);
// This is to make sure that keyframe models in the same group, i.e., start
// together, don't animate the same property.
DCHECK(std::none_of(keyframe_models().begin(), keyframe_models().end(),
[&](const auto& existing_keyframe_model) {
auto* cc_existing_keyframe_model =
KeyframeModel::ToCcKeyframeModel(
existing_keyframe_model.get());
return keyframe_model->TargetProperty() ==
existing_keyframe_model->TargetProperty() &&
cc_keyframe_model->group() ==
cc_existing_keyframe_model->group();
}));
if (keyframe_model->TargetProperty() == TargetProperty::SCROLL_OFFSET) {
// We should never have more than one scroll offset animation queued on the
// same scrolling element as this would result in multiple automated
// scrolls.
DCHECK(std::none_of(
keyframe_models().begin(), keyframe_models().end(),
[&](const auto& existing_keyframe_model) {
auto* cc_existing_keyframe_model =
KeyframeModel::ToCcKeyframeModel(existing_keyframe_model.get());
return cc_existing_keyframe_model->TargetProperty() ==
TargetProperty::SCROLL_OFFSET &&
!cc_existing_keyframe_model->is_finished() &&
(!cc_existing_keyframe_model->is_controlling_instance() ||
cc_existing_keyframe_model->affects_pending_elements());
}));
}
gfx::KeyframeEffect::AddKeyframeModel(std::move(keyframe_model));
if (has_bound_element_animations()) {
KeyframeModelAdded();
SetNeedsPushProperties();
}
}
void KeyframeEffect::PauseKeyframeModel(int keyframe_model_id,
base::TimeDelta time_offset) {
for (auto& keyframe_model : keyframe_models()) {
if (keyframe_model->id() == keyframe_model_id) {
keyframe_model->Pause(time_offset);
}
}
if (has_bound_element_animations()) {
animation_->SetNeedsCommit();
SetNeedsPushProperties();
}
}
void KeyframeEffect::AbortKeyframeModel(int keyframe_model_id) {
if (gfx::KeyframeModel* keyframe_model =
GetKeyframeModelById(keyframe_model_id)) {
if (!keyframe_model->is_finished()) {
keyframe_model->SetRunState(gfx::KeyframeModel::ABORTED,
last_tick_time_.value_or(base::TimeTicks()));
if (has_bound_element_animations())
element_animations_->UpdateClientAnimationState();
}
}
if (has_bound_element_animations()) {
animation_->SetNeedsCommit();
SetNeedsPushProperties();
}
}
void KeyframeEffect::AbortKeyframeModelsWithProperty(
TargetProperty::Type target_property,
bool needs_completion) {
if (needs_completion)
DCHECK(target_property == TargetProperty::SCROLL_OFFSET);
bool aborted_keyframe_model = false;
for (auto& keyframe_model : keyframe_models()) {
if (keyframe_model->TargetProperty() == target_property &&
!keyframe_model->is_finished()) {
// Currently only impl-only scroll offset KeyframeModels can be completed
// on the main thread.
if (needs_completion &&
KeyframeModel::ToCcKeyframeModel(keyframe_model.get())
->is_impl_only()) {
keyframe_model->SetRunState(
gfx::KeyframeModel::ABORTED_BUT_NEEDS_COMPLETION,
last_tick_time_.value_or(base::TimeTicks()));
} else {
keyframe_model->SetRunState(
gfx::KeyframeModel::ABORTED,
last_tick_time_.value_or(base::TimeTicks()));
}
aborted_keyframe_model = true;
}
}
if (has_bound_element_animations()) {
if (aborted_keyframe_model)
element_animations_->UpdateClientAnimationState();
animation_->SetNeedsCommit();
SetNeedsPushProperties();
}
}
void KeyframeEffect::ActivateKeyframeModels() {
DCHECK(has_bound_element_animations());
bool keyframe_model_activated = false;
for (auto& keyframe_model : keyframe_models()) {
auto* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_model.get());
if (cc_keyframe_model->affects_active_elements() !=
cc_keyframe_model->affects_pending_elements()) {
keyframe_model_activated = true;
}
cc_keyframe_model->set_affects_active_elements(
cc_keyframe_model->affects_pending_elements());
}
if (keyframe_model_activated)
element_animations_->UpdateClientAnimationState();
scroll_offset_animation_was_interrupted_ = false;
}
void KeyframeEffect::KeyframeModelAdded() {
DCHECK(has_bound_element_animations());
animation_->SetNeedsCommit();
needs_to_start_keyframe_models_ = true;
UpdateTickingState();
for (auto& keyframe_model : keyframe_models()) {
element_animations_->AttachToCurve(keyframe_model->curve());
}
element_animations_->UpdateClientAnimationState();
}
bool KeyframeEffect::DispatchAnimationEventToKeyframeModel(
const AnimationEvent& event) {
DCHECK(!event.is_impl_only);
KeyframeModel* keyframe_model = KeyframeModel::ToCcKeyframeModel(
GetKeyframeModelById(event.uid.model_id));
bool dispatched = false;
switch (event.type) {
case AnimationEvent::STARTED:
if (keyframe_model && keyframe_model->needs_synchronized_start_time()) {
keyframe_model->set_needs_synchronized_start_time(false);
if (!keyframe_model->has_set_start_time())
keyframe_model->set_start_time(event.monotonic_time);
dispatched = true;
}
break;
case AnimationEvent::FINISHED:
if (keyframe_model) {
keyframe_model->set_received_finished_event(true);
dispatched = true;
} else {
// This is for the case when a keyframe_model is already removed on main
// thread, but the impl version of it sent a finished event and is now
// waiting for deletion. We would need to delete that keyframe_model
// during push properties.
SetNeedsPushProperties();
}
break;
case AnimationEvent::ABORTED:
if (keyframe_model) {
keyframe_model->SetRunState(gfx::KeyframeModel::ABORTED,
event.monotonic_time);
keyframe_model->set_received_finished_event(true);
dispatched = true;
ElementAnimations* element_animations =
animation_->animation_host()
->GetElementAnimationsForElementId(element_id())
.get();
if (element_animations)
element_animations->UpdateClientAnimationState();
}
break;
case AnimationEvent::TAKEOVER:
// TODO(crbug.com/1018213): Routing TAKEOVER events is broken.
// We need to purge KeyframeModels marked for deletion on CT.
SetNeedsPushProperties();
dispatched = true;
break;
case AnimationEvent::TIME_UPDATED:
// TIME_UPDATED events are used to synchronize effect time between cc and
// main thread worklet animations. Keyframe models are not involved in
// this process.
NOTREACHED();
break;
}
return dispatched;
}
bool KeyframeEffect::HasTickingKeyframeModel() const {
for (const auto& keyframe_model : keyframe_models()) {
if (!keyframe_model->is_finished())
return true;
}
return false;
}
bool KeyframeEffect::AffectsCustomProperty() const {
for (const auto& it : keyframe_models())
if (it->TargetProperty() == TargetProperty::CSS_CUSTOM_PROPERTY)
return true;
return false;
}
bool KeyframeEffect::HasNonDeletedKeyframeModel() const {
for (const auto& keyframe_model : keyframe_models()) {
if (keyframe_model->run_state() != gfx::KeyframeModel::WAITING_FOR_DELETION)
return true;
}
return false;
}
bool KeyframeEffect::AnimationsPreserveAxisAlignment() const {
for (const auto& keyframe_model : keyframe_models()) {
if (keyframe_model->is_finished())
continue;
if (!keyframe_model->curve()->PreservesAxisAlignment())
return false;
}
return true;
}
float KeyframeEffect::MaximumScale(ElementListType list_type) const {
float maximum_scale = kInvalidScale;
for (const auto& keyframe_model : keyframe_models()) {
if (keyframe_model->is_finished())
continue;
auto* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_model.get());
if ((list_type == ElementListType::ACTIVE &&
!cc_keyframe_model->affects_active_elements()) ||
(list_type == ElementListType::PENDING &&
!cc_keyframe_model->affects_pending_elements()))
continue;
float curve_maximum_scale = kInvalidScale;
if (keyframe_model->curve()->MaximumScale(&curve_maximum_scale))
maximum_scale = std::max(maximum_scale, curve_maximum_scale);
}
return maximum_scale;
}
bool KeyframeEffect::IsPotentiallyAnimatingProperty(
TargetProperty::Type target_property,
ElementListType list_type) const {
for (const auto& keyframe_model : keyframe_models()) {
if (!keyframe_model->is_finished() &&
keyframe_model->TargetProperty() == target_property) {
auto* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_model.get());
if ((list_type == ElementListType::ACTIVE &&
cc_keyframe_model->affects_active_elements()) ||
(list_type == ElementListType::PENDING &&
cc_keyframe_model->affects_pending_elements()))
return true;
}
}
return false;
}
bool KeyframeEffect::IsCurrentlyAnimatingProperty(
TargetProperty::Type target_property,
ElementListType list_type) const {
for (const auto& keyframe_model : keyframe_models()) {
auto* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_model.get());
if (!keyframe_model->is_finished() &&
cc_keyframe_model->InEffect(
last_tick_time_.value_or(base::TimeTicks())) &&
keyframe_model->TargetProperty() == target_property) {
if ((list_type == ElementListType::ACTIVE &&
cc_keyframe_model->affects_active_elements()) ||
(list_type == ElementListType::PENDING &&
cc_keyframe_model->affects_pending_elements()))
return true;
}
}
return false;
}
void KeyframeEffect::GetPropertyAnimationState(
PropertyAnimationState* pending_state,
PropertyAnimationState* active_state) const {
pending_state->Clear();
active_state->Clear();
for (const auto& keyframe_model : keyframe_models()) {
if (!keyframe_model->is_finished()) {
auto* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_model.get());
bool in_effect = cc_keyframe_model->InEffect(
last_tick_time_.value_or(base::TimeTicks()));
bool active = cc_keyframe_model->affects_active_elements();
bool pending = cc_keyframe_model->affects_pending_elements();
int property = keyframe_model->TargetProperty();
if (pending)
pending_state->potentially_animating[property] = true;
if (pending && in_effect)
pending_state->currently_running[property] = true;
if (active)
active_state->potentially_animating[property] = true;
if (active && in_effect)
active_state->currently_running[property] = true;
}
}
}
void KeyframeEffect::MarkAbortedKeyframeModelsForDeletion(
KeyframeEffect* keyframe_effect_impl) {
bool keyframe_model_aborted = false;
auto& keyframe_models_impl = keyframe_effect_impl->keyframe_models();
for (const auto& keyframe_model_impl : keyframe_models_impl) {
// If the keyframe_model has been aborted on the main thread, mark it for
// deletion.
if (gfx::KeyframeModel* keyframe_model =
GetKeyframeModelById(keyframe_model_impl->id())) {
if (keyframe_model->run_state() == gfx::KeyframeModel::ABORTED) {
keyframe_model_impl->SetRunState(
gfx::KeyframeModel::WAITING_FOR_DELETION,
keyframe_effect_impl->last_tick_time_.value_or(base::TimeTicks()));
keyframe_model->SetRunState(
gfx::KeyframeModel::WAITING_FOR_DELETION,
last_tick_time_.value_or(base::TimeTicks()));
keyframe_model_aborted = true;
}
}
}
if (has_bound_element_animations() && keyframe_model_aborted)
element_animations_->SetNeedsPushProperties();
}
void KeyframeEffect::PurgeKeyframeModelsMarkedForDeletion(bool impl_only) {
base::EraseIf(keyframe_models(), [impl_only](const auto& keyframe_model) {
return keyframe_model->run_state() ==
gfx::KeyframeModel::WAITING_FOR_DELETION &&
(!impl_only || KeyframeModel::ToCcKeyframeModel(keyframe_model.get())
->is_impl_only());
});
}
void KeyframeEffect::PurgeDeletedKeyframeModels() {
base::EraseIf(keyframe_models(), [](const auto& keyframe_model) {
return keyframe_model->run_state() ==
gfx::KeyframeModel::WAITING_FOR_DELETION &&
!KeyframeModel::ToCcKeyframeModel(keyframe_model.get())
->affects_pending_elements();
});
}
void KeyframeEffect::PushNewKeyframeModelsToImplThread(
KeyframeEffect* keyframe_effect_impl) const {
// Any new KeyframeModels owned by the main thread's Animation are
// cloned and added to the impl thread's Animation.
for (const auto& keyframe_model : keyframe_models()) {
// If the keyframe_model is finished, do not copy it over to impl since the
// impl instance, if there was one, was just removed in
// |RemoveKeyframeModelsCompletedOnMainThread|.
if (keyframe_model->is_finished())
continue;
// If the keyframe_model is already running on the impl thread, there is no
// need to copy it over.
if (keyframe_effect_impl->GetKeyframeModelById(keyframe_model->id()))
continue;
if (keyframe_model->TargetProperty() == TargetProperty::SCROLL_OFFSET &&
!ScrollOffsetAnimationCurve::ToScrollOffsetAnimationCurve(
keyframe_model->curve())
->HasSetInitialValue()) {
gfx::ScrollOffset current_scroll_offset;
if (keyframe_effect_impl->HasElementInActiveList()) {
current_scroll_offset =
keyframe_effect_impl->ScrollOffsetForAnimation();
} else {
// The owning layer isn't yet in the active tree, so the main thread
// scroll offset will be up to date.
current_scroll_offset = ScrollOffsetForAnimation();
}
ScrollOffsetAnimationCurve* curve =
ScrollOffsetAnimationCurve::ToScrollOffsetAnimationCurve(
keyframe_model->curve());
curve->SetInitialValue(current_scroll_offset);
}
// The new keyframe_model should be set to run as soon as possible.
gfx::KeyframeModel::RunState initial_run_state =
gfx::KeyframeModel::WAITING_FOR_TARGET_AVAILABILITY;
std::unique_ptr<KeyframeModel> to_add(
KeyframeModel::ToCcKeyframeModel(keyframe_model.get())
->CreateImplInstance(initial_run_state));
DCHECK(!to_add->needs_synchronized_start_time());
to_add->set_affects_active_elements(false);
keyframe_effect_impl->AddKeyframeModel(std::move(to_add));
}
}
namespace {
bool IsCompleted(gfx::KeyframeModel* keyframe_model,
const KeyframeEffect* main_thread_keyframe_effect) {
if (KeyframeModel::ToCcKeyframeModel(keyframe_model)->is_impl_only()) {
return (keyframe_model->run_state() ==
gfx::KeyframeModel::WAITING_FOR_DELETION);
} else {
gfx::KeyframeModel* main_thread_keyframe_model =
main_thread_keyframe_effect->GetKeyframeModelById(keyframe_model->id());
return !main_thread_keyframe_model ||
main_thread_keyframe_model->is_finished();
}
}
} // namespace
void KeyframeEffect::RemoveKeyframeModelsCompletedOnMainThread(
KeyframeEffect* keyframe_effect_impl) const {
bool keyframe_model_completed = false;
// Animations removed on the main thread should no longer affect pending
// elements, and should stop affecting active elements after the next call
// to ActivateKeyframeEffects. If already WAITING_FOR_DELETION, they can be
// removed immediately.
for (auto& keyframe_model : keyframe_effect_impl->keyframe_models()) {
if (IsCompleted(keyframe_model.get(), this)) {
KeyframeModel::ToCcKeyframeModel(keyframe_model.get())
->set_affects_pending_elements(false);
keyframe_model_completed = true;
}
}
keyframe_effect_impl->PurgeDeletedKeyframeModels();
if (has_bound_element_animations() && keyframe_model_completed)
element_animations_->SetNeedsPushProperties();
}
void KeyframeEffect::PushPropertiesTo(KeyframeEffect* keyframe_effect_impl) {
if (!needs_push_properties_)
return;
needs_push_properties_ = false;
// Synchronize the keyframe_model target between main and impl side.
if (element_id_ != keyframe_effect_impl->element_id_) {
// We have to detach/attach via the Animation as it may need to inform
// the host as well.
if (keyframe_effect_impl->has_attached_element())
keyframe_effect_impl->animation_->DetachElement();
if (element_id_) {
if (element_id_.GetStableId() == ElementId::kReservedElementId)
keyframe_effect_impl->animation_->AttachNoElement();
else
keyframe_effect_impl->animation_->AttachElement(element_id_);
}
}
keyframe_effect_impl->scroll_offset_animation_was_interrupted_ =
scroll_offset_animation_was_interrupted_;
scroll_offset_animation_was_interrupted_ = false;
// If neither main nor impl have any KeyframeModels, there is nothing further
// to synchronize.
if (!has_any_keyframe_model() &&
!keyframe_effect_impl->has_any_keyframe_model())
return;
// Synchronize the main-thread and impl-side keyframe model lists, removing
// aborted KeyframeModels and pushing any new animations.
MarkAbortedKeyframeModelsForDeletion(keyframe_effect_impl);
PurgeKeyframeModelsMarkedForDeletion(/* impl_only */ false);
RemoveKeyframeModelsCompletedOnMainThread(keyframe_effect_impl);
PushNewKeyframeModelsToImplThread(keyframe_effect_impl);
// Now that the keyframe model lists are synchronized, push the properties for
// the individual KeyframeModels.
for (const auto& keyframe_model : keyframe_models()) {
KeyframeModel* current_impl = KeyframeModel::ToCcKeyframeModel(
keyframe_effect_impl->GetKeyframeModelById(keyframe_model->id()));
if (current_impl)
KeyframeModel::ToCcKeyframeModel(keyframe_model.get())
->PushPropertiesTo(current_impl);
}
keyframe_effect_impl->UpdateTickingState();
}
std::string KeyframeEffect::KeyframeModelsToString() const {
std::string str;
for (size_t i = 0; i < keyframe_models().size(); i++) {
if (i > 0)
str.append(", ");
str.append(KeyframeModel::ToCcKeyframeModel(keyframe_models()[i].get())
->ToString());
}
return str;
}
base::TimeDelta KeyframeEffect::MinimumTickInterval() const {
base::TimeDelta min_interval = base::TimeDelta::Max();
for (const auto& model : keyframe_models()) {
base::TimeDelta interval = model->curve()->TickInterval();
if (interval.is_zero())
return interval;
if (interval < min_interval)
min_interval = interval;
}
return min_interval;
}
void KeyframeEffect::RemoveKeyframeModelRange(
typename KeyframeModels::iterator to_remove_begin,
typename KeyframeModels::iterator to_remove_end) {
bool keyframe_model_removed = false;
for (auto it = to_remove_begin; it != to_remove_end; ++it) {
if ((*it)->TargetProperty() == TargetProperty::SCROLL_OFFSET) {
if (has_bound_element_animations())
scroll_offset_animation_was_interrupted_ = true;
} else if (!(*it)->is_finished()) {
keyframe_model_removed = true;
}
}
gfx::KeyframeEffect::RemoveKeyframeModelRange(to_remove_begin, to_remove_end);
if (has_bound_element_animations()) {
UpdateTickingState();
if (keyframe_model_removed)
element_animations_->UpdateClientAnimationState();
animation_->SetNeedsCommit();
SetNeedsPushProperties();
}
}
void KeyframeEffect::StartKeyframeModels(base::TimeTicks monotonic_time) {
DCHECK(needs_to_start_keyframe_models_);
needs_to_start_keyframe_models_ = false;
// First collect running properties affecting each type of element.
gfx::TargetProperties blocked_properties_for_active_elements;
gfx::TargetProperties blocked_properties_for_pending_elements;
std::vector<size_t> keyframe_models_waiting_for_target;
keyframe_models_waiting_for_target.reserve(keyframe_models().size());
for (size_t i = 0; i < keyframe_models().size(); ++i) {
auto* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_models()[i].get());
if (cc_keyframe_model->run_state() == gfx::KeyframeModel::STARTING ||
cc_keyframe_model->run_state() == gfx::KeyframeModel::RUNNING) {
int property = cc_keyframe_model->TargetProperty();
if (cc_keyframe_model->affects_active_elements()) {
blocked_properties_for_active_elements[property] = true;
}
if (cc_keyframe_model->affects_pending_elements()) {
blocked_properties_for_pending_elements[property] = true;
}
} else if (cc_keyframe_model->run_state() ==
gfx::KeyframeModel::WAITING_FOR_TARGET_AVAILABILITY) {
keyframe_models_waiting_for_target.push_back(i);
}
}
for (size_t i = 0; i < keyframe_models_waiting_for_target.size(); ++i) {
// Collect all properties for KeyframeModels with the same group id (they
// should all also be in the list of KeyframeModels).
size_t keyframe_model_index = keyframe_models_waiting_for_target[i];
KeyframeModel* keyframe_model_waiting_for_target =
KeyframeModel::ToCcKeyframeModel(
keyframe_models()[keyframe_model_index].get());
// Check for the run state again even though the keyframe_model was waiting
// for target because it might have changed the run state while handling
// previous keyframe_model in this loop (if they belong to same group).
if (keyframe_model_waiting_for_target->run_state() ==
gfx::KeyframeModel::WAITING_FOR_TARGET_AVAILABILITY) {
gfx::TargetProperties enqueued_properties;
bool affects_active_elements =
keyframe_model_waiting_for_target->affects_active_elements();
bool affects_pending_elements =
keyframe_model_waiting_for_target->affects_pending_elements();
enqueued_properties[keyframe_model_waiting_for_target->TargetProperty()] =
true;
for (size_t j = keyframe_model_index + 1; j < keyframe_models().size();
++j) {
auto* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_models()[j].get());
if (keyframe_model_waiting_for_target->group() ==
cc_keyframe_model->group()) {
enqueued_properties[cc_keyframe_model->TargetProperty()] = true;
affects_active_elements |=
cc_keyframe_model->affects_active_elements();
affects_pending_elements |=
cc_keyframe_model->affects_pending_elements();
}
}
// Check to see if intersection of the list of properties affected by
// the group and the list of currently blocked properties is null, taking
// into account the type(s) of elements affected by the group. In any
// case, the group's target properties need to be added to the lists of
// blocked properties.
bool null_intersection = true;
for (int property = TargetProperty::FIRST_TARGET_PROPERTY;
property <= TargetProperty::LAST_TARGET_PROPERTY; ++property) {
if (enqueued_properties[property]) {
if (affects_active_elements) {
if (blocked_properties_for_active_elements[property])
null_intersection = false;
else
blocked_properties_for_active_elements[property] = true;
}
if (affects_pending_elements) {
if (blocked_properties_for_pending_elements[property])
null_intersection = false;
else
blocked_properties_for_pending_elements[property] = true;
}
}
}
// If the intersection is null, then we are free to start the
// KeyframeModels in the group.
if (null_intersection) {
keyframe_model_waiting_for_target->SetRunState(
gfx::KeyframeModel::STARTING, monotonic_time);
for (size_t j = keyframe_model_index + 1; j < keyframe_models().size();
++j) {
auto* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_models()[j].get());
if (keyframe_model_waiting_for_target->group() ==
cc_keyframe_model->group()) {
cc_keyframe_model->SetRunState(gfx::KeyframeModel::STARTING,
monotonic_time);
}
}
} else {
needs_to_start_keyframe_models_ = true;
}
}
}
}
void KeyframeEffect::PromoteStartedKeyframeModels(AnimationEvents* events) {
for (auto& keyframe_model : keyframe_models()) {
if (keyframe_model->run_state() == gfx::KeyframeModel::STARTING &&
KeyframeModel::ToCcKeyframeModel(keyframe_model.get())
->affects_active_elements()) {
auto* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_model.get());
cc_keyframe_model->SetRunState(
gfx::KeyframeModel::RUNNING,
last_tick_time_.value_or(base::TimeTicks()));
if (!cc_keyframe_model->has_set_start_time() &&
!cc_keyframe_model->needs_synchronized_start_time())
cc_keyframe_model->set_start_time(
last_tick_time_.value_or(base::TimeTicks()));
base::TimeTicks start_time;
if (cc_keyframe_model->has_set_start_time())
start_time = cc_keyframe_model->start_time();
else
start_time = last_tick_time_.value_or(base::TimeTicks());
GenerateEvent(events, *cc_keyframe_model, AnimationEvent::STARTED,
start_time);
}
}
}
void KeyframeEffect::MarkKeyframeModelsForDeletion(
base::TimeTicks monotonic_time,
AnimationEvents* events) {
bool marked_keyframe_model_for_deletion = false;
auto MarkForDeletion = [&](KeyframeModel* keyframe_model) {
keyframe_model->SetRunState(gfx::KeyframeModel::WAITING_FOR_DELETION,
monotonic_time);
marked_keyframe_model_for_deletion = true;
};
// Non-aborted KeyframeModels are marked for deletion after a corresponding
// AnimationEvent::FINISHED event is sent or received. This means that if
// we don't have an events vector, we must ensure that non-aborted
// KeyframeModels have received a finished event before marking them for
// deletion.
for (auto& keyframe_model : keyframe_models()) {
KeyframeModel* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_model.get());
if (cc_keyframe_model->run_state() == gfx::KeyframeModel::ABORTED) {
GenerateEvent(events, *cc_keyframe_model, AnimationEvent::ABORTED,
monotonic_time);
// If this is the controlling instance or it has already received finish
// event, keyframe model can be marked for deletion.
if (!NeedsFinishedEvent(cc_keyframe_model))
MarkForDeletion(cc_keyframe_model);
continue;
}
// If this is an aborted controlling instance that need completion on the
// main thread, generate takeover event.
if (cc_keyframe_model->is_controlling_instance() &&
cc_keyframe_model->run_state() ==
gfx::KeyframeModel::ABORTED_BUT_NEEDS_COMPLETION) {
GenerateTakeoverEventForScrollAnimation(events, *cc_keyframe_model,
monotonic_time);
// Remove the keyframe model from the impl thread.
MarkForDeletion(cc_keyframe_model);
continue;
}
if (cc_keyframe_model->run_state() != gfx::KeyframeModel::FINISHED)
continue;
// Since deleting an animation on the main thread leads to its deletion
// on the impl thread, we only mark a FINISHED main thread animation for
// deletion once it has received a FINISHED event from the impl thread.
if (NeedsFinishedEvent(cc_keyframe_model))
continue;
// If a keyframe model is finished, and not already marked for deletion,
// find out if all other keyframe models in the same group are also
// finished.
std::vector<size_t> keyframe_models_in_same_group =
FindAnimationsWithSameGroupId(keyframe_models(),
cc_keyframe_model->group());
bool a_keyframe_model_in_same_group_is_not_finished = std::any_of(
keyframe_models_in_same_group.cbegin(),
keyframe_models_in_same_group.cend(), [&](size_t index) {
auto* keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_models()[index].get());
return !keyframe_model->is_finished() ||
(keyframe_model->run_state() == gfx::KeyframeModel::FINISHED &&
NeedsFinishedEvent(keyframe_model));
});
if (a_keyframe_model_in_same_group_is_not_finished)
continue;
// Now remove all the keyframe models which belong to the same group and are
// not yet aborted. These will be set to WAITING_FOR_DELETION which also
// ensures we don't try to delete them again.
for (size_t j = 0; j < keyframe_models_in_same_group.size(); ++j) {
KeyframeModel* same_group_keyframe_model =
KeyframeModel::ToCcKeyframeModel(
keyframe_models()[keyframe_models_in_same_group[j]].get());
// Skip any keyframe model in this group which is already processed.
if (same_group_keyframe_model->run_state() ==
gfx::KeyframeModel::WAITING_FOR_DELETION ||
same_group_keyframe_model->run_state() == gfx::KeyframeModel::ABORTED)
continue;
GenerateEvent(events, *same_group_keyframe_model,
AnimationEvent::FINISHED, monotonic_time);
MarkForDeletion(same_group_keyframe_model);
}
}
// We need to purge KeyframeModels marked for deletion, which happens in
// PushPropertiesTo().
if (marked_keyframe_model_for_deletion)
SetNeedsPushProperties();
}
void KeyframeEffect::MarkFinishedKeyframeModels(
base::TimeTicks monotonic_time) {
DCHECK(has_bound_element_animations());
bool keyframe_model_finished = false;
for (auto& keyframe_model : keyframe_models()) {
if (!keyframe_model->is_finished() &&
keyframe_model->IsFinishedAt(monotonic_time)) {
keyframe_model->SetRunState(gfx::KeyframeModel::FINISHED, monotonic_time);
keyframe_model_finished = true;
SetNeedsPushProperties();
}
auto* cc_keyframe_model =
KeyframeModel::ToCcKeyframeModel(keyframe_model.get());
if (!cc_keyframe_model->affects_active_elements() &&
!cc_keyframe_model->affects_pending_elements()) {
switch (keyframe_model->run_state()) {
case gfx::KeyframeModel::WAITING_FOR_TARGET_AVAILABILITY:
case gfx::KeyframeModel::STARTING:
case gfx::KeyframeModel::RUNNING:
case gfx::KeyframeModel::PAUSED:
keyframe_model->SetRunState(gfx::KeyframeModel::FINISHED,
monotonic_time);
keyframe_model_finished = true;