1e880f516030bbf655b9132e06b470c572caefa8
[WebKit-https.git] / Source / WebCore / animation / DocumentTimeline.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "AnimationTimeline.h"
29 #include "DocumentTimelineOptions.h"
30 #include "GenericTaskQueue.h"
31 #include "Timer.h"
32 #include <wtf/Ref.h>
33
34 namespace WebCore {
35
36 class AnimationPlaybackEvent;
37 class RenderElement;
38
39 class DocumentTimeline final : public AnimationTimeline
40 {
41 public:
42     static Ref<DocumentTimeline> create(Document&);
43     static Ref<DocumentTimeline> create(Document&, DocumentTimelineOptions&&);
44     ~DocumentTimeline();
45
46     Vector<RefPtr<WebAnimation>> getAnimations() const;
47
48     Document* document() const { return m_document.get(); }
49
50     Optional<Seconds> currentTime() override;
51
52     void animationTimingDidChange(WebAnimation&) override;
53     void removeAnimation(WebAnimation&) override;
54     void animationWasAddedToElement(WebAnimation&, Element&) final;
55     void animationWasRemovedFromElement(WebAnimation&, Element&) final;
56
57     // If possible, compute the visual extent of any transform animation on the given renderer
58     // using the given rect, returning the result in the rect. Return false if there is some
59     // transform animation but we were unable to cheaply compute its effect on the extent.
60     bool computeExtentOfAnimation(RenderElement&, LayoutRect&) const;
61     std::unique_ptr<RenderStyle> animatedStyleForRenderer(RenderElement& renderer);
62     bool isRunningAnimationOnRenderer(RenderElement&, CSSPropertyID) const;
63     bool isRunningAcceleratedAnimationOnRenderer(RenderElement&, CSSPropertyID) const;
64     void animationAcceleratedRunningStateDidChange(WebAnimation&);
65     void applyPendingAcceleratedAnimations();
66     bool runningAnimationsForElementAreAllAccelerated(Element&) const;
67     bool resolveAnimationsForElement(Element&, RenderStyle&);
68     void detachFromDocument();
69
70     void enqueueAnimationPlaybackEvent(AnimationPlaybackEvent&);
71
72 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
73     void documentAnimationSchedulerDidFire();
74 #endif
75
76     void updateThrottlingState();
77     WEBCORE_EXPORT Seconds animationInterval() const;
78     WEBCORE_EXPORT void suspendAnimations();
79     WEBCORE_EXPORT void resumeAnimations();
80     WEBCORE_EXPORT bool animationsAreSuspended();
81     WEBCORE_EXPORT unsigned numberOfActiveAnimationsForTesting() const;
82     WEBCORE_EXPORT Vector<std::pair<String, double>> acceleratedAnimationsForElement(Element&) const;    
83     WEBCORE_EXPORT unsigned numberOfAnimationTimelineInvalidationsForTesting() const;
84
85 private:
86     DocumentTimeline(Document&, Seconds);
87
88     Seconds liveCurrentTime() const;
89     void cacheCurrentTime(Seconds);
90     void scheduleAnimationResolutionIfNeeded();
91     void scheduleInvalidationTaskIfNeeded();
92     void performInvalidationTask();
93     void animationScheduleTimerFired();
94     void scheduleAnimationResolution();
95     void unscheduleAnimationResolution();
96     void updateAnimationsAndSendEvents();
97     void performEventDispatchTask();
98     void maybeClearCachedCurrentTime();
99     void updateListOfElementsWithRunningAcceleratedAnimationsForElement(Element&);
100     void transitionDidComplete(RefPtr<CSSTransition>);
101     void scheduleNextTick();
102
103     RefPtr<Document> m_document;
104     Seconds m_originTime;
105     bool m_isSuspended { false };
106     bool m_waitingOnVMIdle { false };
107     bool m_isUpdatingAnimations { false };
108     Optional<Seconds> m_cachedCurrentTime;
109     GenericTaskQueue<Timer> m_currentTimeClearingTaskQueue;
110     HashSet<RefPtr<WebAnimation>> m_acceleratedAnimationsPendingRunningStateChange;
111     Vector<Ref<AnimationPlaybackEvent>> m_pendingAnimationEvents;
112     unsigned m_numberOfAnimationTimelineInvalidationsForTesting { 0 };
113     HashSet<Element*> m_elementsWithRunningAcceleratedAnimations;
114     Timer m_tickScheduleTimer;
115
116 #if !USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
117     void animationResolutionTimerFired();
118     Timer m_animationResolutionTimer;
119 #endif
120 };
121
122 } // namespace WebCore
123
124 SPECIALIZE_TYPE_TRAITS_ANIMATION_TIMELINE(DocumentTimeline, isDocumentTimeline())