[Web Animations] Enqueue and dispatch animation events
[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 "GenericTaskQueue.h"
30 #include "PlatformScreen.h"
31 #include "Timer.h"
32 #include <wtf/Ref.h>
33
34 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
35 #include "DisplayRefreshMonitorClient.h"
36 #endif
37
38 namespace WebCore {
39
40 class AnimationPlaybackEvent;
41 class RenderElement;
42
43 class DocumentTimeline final : public AnimationTimeline
44 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
45     , public DisplayRefreshMonitorClient
46 #endif
47 {
48 public:
49     static Ref<DocumentTimeline> create(Document&, PlatformDisplayID);
50     ~DocumentTimeline();
51
52     std::optional<Seconds> currentTime() override;
53     void pause() override;
54
55     void animationTimingModelDidChange() override;
56     void windowScreenDidChange(PlatformDisplayID);
57
58     std::unique_ptr<RenderStyle> animatedStyleForRenderer(RenderElement& renderer);
59     void animationAcceleratedRunningStateDidChange(WebAnimation&);
60     bool runningAnimationsForElementAreAllAccelerated(Element&);
61     void detachFromDocument();
62
63     void enqueueAnimationPlaybackEvent(AnimationPlaybackEvent&);
64
65 private:
66     DocumentTimeline(Document&, PlatformDisplayID);
67
68     void scheduleInvalidationTaskIfNeeded();
69     void performInvalidationTask();
70     void updateAnimationSchedule();
71     void animationScheduleTimerFired();
72     void scheduleAnimationResolution();
73     void updateAnimations();
74     void performEventDispatchTask();
75
76     RefPtr<Document> m_document;
77     bool m_paused { false };
78     std::optional<Seconds> m_cachedCurrentTime;
79     GenericTaskQueue<Timer> m_invalidationTaskQueue;
80     GenericTaskQueue<Timer> m_eventDispatchTaskQueue;
81     bool m_needsUpdateAnimationSchedule { false };
82     Timer m_animationScheduleTimer;
83     HashSet<RefPtr<WebAnimation>> m_acceleratedAnimationsPendingRunningStateChange;
84     Vector<Ref<AnimationPlaybackEvent>> m_pendingAnimationEvents;
85
86 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
87     // Override for DisplayRefreshMonitorClient
88     void displayRefreshFired() override;
89     RefPtr<DisplayRefreshMonitor> createDisplayRefreshMonitor(PlatformDisplayID) const override;
90 #else
91     void animationResolutionTimerFired();
92     Timer m_animationResolutionTimer;
93 #endif
94 };
95
96 } // namespace WebCore
97
98 SPECIALIZE_TYPE_TRAITS_ANIMATION_TIMELINE(DocumentTimeline, isDocumentTimeline())