2 * Copyright (C) 2013 Google Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
14 * * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef DocumentTimeline_h
32 #define DocumentTimeline_h
34 #include "core/animation/AnimationEffect.h"
35 #include "core/animation/AnimationPlayer.h"
36 #include "core/dom/Element.h"
37 #include "core/events/Event.h"
38 #include "platform/Timer.h"
39 #include "wtf/RefCounted.h"
40 #include "wtf/RefPtr.h"
41 #include "wtf/Vector.h"
48 // DocumentTimeline is constructed and owned by Document, and tied to its lifecycle.
49 class DocumentTimeline : public RefCounted<DocumentTimeline> {
51 class PlatformTiming {
54 // Calls DocumentTimeline's wake() method after duration seconds.
55 virtual void wakeAfter(double duration) = 0;
56 virtual void cancelWake() = 0;
57 virtual void serviceOnNextFrame() = 0;
58 virtual ~PlatformTiming() { }
62 static PassRefPtr<DocumentTimeline> create(Document*, PassOwnPtr<PlatformTiming> = nullptr);
65 void serviceAnimations(TimingUpdateReason);
67 // Creates a player attached to this timeline, but without a start time.
68 AnimationPlayer* createAnimationPlayer(TimedItem*);
69 AnimationPlayer* play(TimedItem*);
71 void playerDestroyed(AnimationPlayer* player)
73 ASSERT(m_players.contains(player));
74 m_players.remove(player);
77 // Called from setReadyState() in Document.cpp to set m_zeroTime to
78 // performance.timing.domInteractive
79 void setZeroTime(double);
80 bool hasStarted() const { return !isNull(m_zeroTime); }
81 bool hasPendingUpdates() const { return !m_playersNeedingUpdate.isEmpty(); }
82 double zeroTime() const { return m_zeroTime; }
83 double currentTime(bool& isNull);
85 double currentTimeInternal(bool& isNull);
86 double currentTimeInternal();
87 double effectiveTime();
88 void pauseAnimationsForTesting(double);
89 size_t numberOfActiveAnimationsForTesting() const;
91 void setOutdatedAnimationPlayer(AnimationPlayer*);
92 bool hasOutdatedAnimationPlayer() const;
94 Document* document() { return m_document; }
95 void detachFromDocument();
99 DocumentTimeline(Document*, PassOwnPtr<PlatformTiming>);
103 Document* m_document;
104 // AnimationPlayers which will be updated on the next frame
105 // i.e. current, in effect, or had timing changed
106 HashSet<RefPtr<AnimationPlayer> > m_playersNeedingUpdate;
107 HashSet<AnimationPlayer*> m_players;
109 friend class SMILTimeContainer;
110 static const double s_minimumDelay;
112 OwnPtr<PlatformTiming> m_timing;
114 class DocumentTimelineTiming FINAL : public PlatformTiming {
116 DocumentTimelineTiming(DocumentTimeline* documentTimeline)
117 : m_timeline(documentTimeline)
118 , m_timer(this, &DocumentTimelineTiming::timerFired)
123 virtual void wakeAfter(double duration) OVERRIDE;
124 virtual void cancelWake() OVERRIDE;
125 virtual void serviceOnNextFrame() OVERRIDE;
127 void timerFired(Timer<DocumentTimelineTiming>*) { m_timeline->wake(); }
130 DocumentTimeline* m_timeline;
131 Timer<DocumentTimelineTiming> m_timer;
135 friend class AnimationDocumentTimelineTest;