fb8b21d55eae4c3ff1fa529f82a61c6c57187f07
[WebKit.git] / Source / WebCore / page / animation / KeyframeAnimation.cpp
1 /*
2  * Copyright (C) 2007, 2012 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "KeyframeAnimation.h"
31
32 #include "AnimationControllerPrivate.h"
33 #include "CSSPropertyNames.h"
34 #include "CSSStyleSelector.h"
35 #include "CompositeAnimation.h"
36 #include "EventNames.h"
37 #include "RenderLayer.h"
38 #include "RenderLayerBacking.h"
39 #include "RenderStyle.h"
40 #include <wtf/UnusedParam.h>
41
42 using namespace std;
43
44 namespace WebCore {
45
46 KeyframeAnimation::KeyframeAnimation(const Animation* animation, RenderObject* renderer, int index, CompositeAnimation* compAnim, RenderStyle* unanimatedStyle)
47     : AnimationBase(animation, renderer, compAnim)
48     , m_keyframes(renderer, animation->name())
49     , m_index(index)
50     , m_startEventDispatched(false)
51     , m_unanimatedStyle(unanimatedStyle)
52 {
53     // Get the keyframe RenderStyles
54     if (m_object && m_object->node() && m_object->node()->isElementNode())
55         m_object->document()->styleSelector()->keyframeStylesForAnimation(static_cast<Element*>(m_object->node()), unanimatedStyle, m_keyframes);
56
57     // Update the m_transformFunctionListValid flag based on whether the function lists in the keyframes match.
58     validateTransformFunctionList();
59 #if ENABLE(CSS_FILTERS)
60     checkForMatchingFilterFunctionLists();
61 #endif
62 }
63
64 KeyframeAnimation::~KeyframeAnimation()
65 {
66     // Make sure to tell the renderer that we are ending. This will make sure any accelerated animations are removed.
67     if (!postActive())
68         endAnimation();
69 }
70
71 static const Animation* getAnimationFromStyleByName(const RenderStyle* style, const AtomicString& name)
72 {
73     if (!style->animations())
74         return 0;
75
76     for (size_t i = 0; i < style->animations()->size(); i++) {
77         if (name == style->animations()->animation(i)->name())
78             return style->animations()->animation(i);
79     }
80
81     return 0;
82 }
83
84 void KeyframeAnimation::fetchIntervalEndpointsForProperty(CSSPropertyID property, const RenderStyle*& fromStyle, const RenderStyle*& toStyle, double& prog) const
85 {
86     // Find the first key
87     double elapsedTime = getElapsedTime();
88     if (m_animation->duration() && m_animation->iterationCount() != Animation::IterationCountInfinite)
89         elapsedTime = min(elapsedTime, m_animation->duration() * m_animation->iterationCount());
90
91     const double fractionalTime = this->fractionalTime(1, elapsedTime, 0);
92
93     size_t numKeyframes = m_keyframes.size();
94     if (!numKeyframes)
95         return;
96     
97     ASSERT(!m_keyframes[0].key());
98     ASSERT(m_keyframes[m_keyframes.size() - 1].key() == 1);
99     
100     int prevIndex = -1;
101     int nextIndex = -1;
102     
103     // FIXME: with a lot of keys, this linear search will be slow. We could binary search.
104     for (size_t i = 0; i < numKeyframes; ++i) {
105         const KeyframeValue& currKeyFrame = m_keyframes[i];
106
107         if (!currKeyFrame.containsProperty(property))
108             continue;
109
110         if (fractionalTime < currKeyFrame.key()) {
111             nextIndex = i;
112             break;
113         }
114         
115         prevIndex = i;
116     }
117
118     double scale = 1;
119     double offset = 0;
120
121     if (prevIndex == -1)
122         prevIndex = 0;
123
124     if (nextIndex == -1)
125         nextIndex = m_keyframes.size() - 1;
126
127     const KeyframeValue& prevKeyframe = m_keyframes[prevIndex];
128     const KeyframeValue& nextKeyframe = m_keyframes[nextIndex];
129
130     fromStyle = prevKeyframe.style();
131     toStyle = nextKeyframe.style();
132     
133     offset = prevKeyframe.key();
134     scale = 1.0 / (nextKeyframe.key() - prevKeyframe.key());
135
136     const TimingFunction* timingFunction = 0;
137     if (const Animation* matchedAnimation = getAnimationFromStyleByName(fromStyle, name()))
138         timingFunction = matchedAnimation->timingFunction().get();
139
140     prog = progress(scale, offset, timingFunction);
141 }
142
143 void KeyframeAnimation::animate(CompositeAnimation*, RenderObject*, const RenderStyle*, RenderStyle* targetStyle, RefPtr<RenderStyle>& animatedStyle)
144 {
145     // Fire the start timeout if needed
146     fireAnimationEventsIfNeeded();
147     
148     // If we have not yet started, we will not have a valid start time, so just start the animation if needed.
149     if (isNew() && m_animation->playState() == AnimPlayStatePlaying)
150         updateStateMachine(AnimationStateInputStartAnimation, -1);
151
152     // If we get this far and the animation is done, it means we are cleaning up a just finished animation.
153     // If so, we need to send back the targetStyle.
154     if (postActive()) {
155         if (!animatedStyle)
156             animatedStyle = const_cast<RenderStyle*>(targetStyle);
157         return;
158     }
159
160     // If we are waiting for the start timer, we don't want to change the style yet.
161     // Special case 1 - if the delay time is 0, then we do want to set the first frame of the
162     // animation right away. This avoids a flash when the animation starts.
163     // Special case 2 - if there is a backwards fill mode, then we want to continue
164     // through to the style blend so that we get the fromStyle.
165     if (waitingToStart() && m_animation->delay() > 0 && !m_animation->fillsBackwards())
166         return;
167     
168     // If we have no keyframes, don't animate.
169     if (!m_keyframes.size()) {
170         updateStateMachine(AnimationStateInputEndAnimation, -1);
171         return;
172     }
173
174     // Run a cycle of animation.
175     // We know we will need a new render style, so make one if needed.
176     if (!animatedStyle)
177         animatedStyle = RenderStyle::clone(targetStyle);
178
179     // FIXME: we need to be more efficient about determining which keyframes we are animating between.
180     // We should cache the last pair or something.
181     HashSet<CSSPropertyID>::const_iterator endProperties = m_keyframes.endProperties();
182     for (HashSet<CSSPropertyID>::const_iterator it = m_keyframes.beginProperties(); it != endProperties; ++it) {
183         // Get the from/to styles and progress between
184         const RenderStyle* fromStyle = 0;
185         const RenderStyle* toStyle = 0;
186         double progress = 0.0;
187         fetchIntervalEndpointsForProperty(*it, fromStyle, toStyle, progress);
188     
189         bool needsAnim = blendProperties(this, *it, animatedStyle.get(), fromStyle, toStyle, progress);
190         if (needsAnim)
191             setAnimating();
192         else {
193 #if USE(ACCELERATED_COMPOSITING)
194             // If we are running an accelerated animation, set a flag in the style
195             // to indicate it. This can be used to make sure we get an updated
196             // style for hit testing, etc.
197             animatedStyle->setIsRunningAcceleratedAnimation();
198 #endif
199         }
200     }
201 }
202
203 void KeyframeAnimation::getAnimatedStyle(RefPtr<RenderStyle>& animatedStyle)
204 {
205     // If we're in the delay phase and we're not backwards filling, tell the caller
206     // to use the current style.
207     if (waitingToStart() && m_animation->delay() > 0 && !m_animation->fillsBackwards())
208         return;
209
210     if (!m_keyframes.size())
211         return;
212
213     if (!animatedStyle)
214         animatedStyle = RenderStyle::clone(m_object->style());
215
216     HashSet<CSSPropertyID>::const_iterator endProperties = m_keyframes.endProperties();
217     for (HashSet<CSSPropertyID>::const_iterator it = m_keyframes.beginProperties(); it != endProperties; ++it) {
218         // Get the from/to styles and progress between
219         const RenderStyle* fromStyle = 0;
220         const RenderStyle* toStyle = 0;
221         double progress = 0.0;
222         fetchIntervalEndpointsForProperty(*it, fromStyle, toStyle, progress);
223
224         blendProperties(this, *it, animatedStyle.get(), fromStyle, toStyle, progress);
225     }
226 }
227
228 bool KeyframeAnimation::hasAnimationForProperty(CSSPropertyID property) const
229 {
230     return m_keyframes.containsProperty(property);
231 }
232
233 bool KeyframeAnimation::startAnimation(double timeOffset)
234 {
235 #if USE(ACCELERATED_COMPOSITING)
236     if (m_object && m_object->hasLayer()) {
237         RenderLayer* layer = toRenderBoxModelObject(m_object)->layer();
238         if (layer->isComposited())
239             return layer->backing()->startAnimation(timeOffset, m_animation.get(), m_keyframes);
240     }
241 #else
242     UNUSED_PARAM(timeOffset);
243 #endif
244     return false;
245 }
246
247 void KeyframeAnimation::pauseAnimation(double timeOffset)
248 {
249     if (!m_object)
250         return;
251
252 #if USE(ACCELERATED_COMPOSITING)
253     if (m_object->hasLayer()) {
254         RenderLayer* layer = toRenderBoxModelObject(m_object)->layer();
255         if (layer->isComposited())
256             layer->backing()->animationPaused(timeOffset, m_keyframes.animationName());
257     }
258 #else
259     UNUSED_PARAM(timeOffset);
260 #endif
261     // Restore the original (unanimated) style
262     if (!paused())
263         setNeedsStyleRecalc(m_object->node());
264 }
265
266 void KeyframeAnimation::endAnimation()
267 {
268     if (!m_object)
269         return;
270
271 #if USE(ACCELERATED_COMPOSITING)
272     if (m_object->hasLayer()) {
273         RenderLayer* layer = toRenderBoxModelObject(m_object)->layer();
274         if (layer->isComposited())
275             layer->backing()->animationFinished(m_keyframes.animationName());
276     }
277 #endif
278     // Restore the original (unanimated) style
279     if (!paused())
280         setNeedsStyleRecalc(m_object->node());
281 }
282
283 bool KeyframeAnimation::shouldSendEventForListener(Document::ListenerType listenerType) const
284 {
285     return m_object->document()->hasListenerType(listenerType);
286 }
287
288 void KeyframeAnimation::onAnimationStart(double elapsedTime)
289 {
290     sendAnimationEvent(eventNames().webkitAnimationStartEvent, elapsedTime);
291 }
292
293 void KeyframeAnimation::onAnimationIteration(double elapsedTime)
294 {
295     sendAnimationEvent(eventNames().webkitAnimationIterationEvent, elapsedTime);
296 }
297
298 void KeyframeAnimation::onAnimationEnd(double elapsedTime)
299 {
300     sendAnimationEvent(eventNames().webkitAnimationEndEvent, elapsedTime);
301     // End the animation if we don't fill forwards. Forward filling
302     // animations are ended properly in the class destructor.
303     if (!m_animation->fillsForwards())
304         endAnimation();
305 }
306
307 bool KeyframeAnimation::sendAnimationEvent(const AtomicString& eventType, double elapsedTime)
308 {
309     Document::ListenerType listenerType;
310     if (eventType == eventNames().webkitAnimationIterationEvent)
311         listenerType = Document::ANIMATIONITERATION_LISTENER;
312     else if (eventType == eventNames().webkitAnimationEndEvent)
313         listenerType = Document::ANIMATIONEND_LISTENER;
314     else {
315         ASSERT(eventType == eventNames().webkitAnimationStartEvent);
316         if (m_startEventDispatched)
317             return false;
318         m_startEventDispatched = true;
319         listenerType = Document::ANIMATIONSTART_LISTENER;
320     }
321
322     if (shouldSendEventForListener(listenerType)) {
323         // Dispatch the event
324         RefPtr<Element> element;
325         if (m_object->node() && m_object->node()->isElementNode())
326             element = static_cast<Element*>(m_object->node());
327
328         ASSERT(!element || (element->document() && !element->document()->inPageCache()));
329         if (!element)
330             return false;
331
332         // Schedule event handling
333         m_compAnim->animationController()->addEventToDispatch(element, eventType, m_keyframes.animationName(), elapsedTime);
334
335         // Restore the original (unanimated) style
336         if (eventType == eventNames().webkitAnimationEndEvent && element->renderer())
337             setNeedsStyleRecalc(element.get());
338
339         return true; // Did dispatch an event
340     }
341
342     return false; // Did not dispatch an event
343 }
344
345 void KeyframeAnimation::overrideAnimations()
346 {
347     // This will override implicit animations that match the properties in the keyframe animation
348     HashSet<CSSPropertyID>::const_iterator end = m_keyframes.endProperties();
349     for (HashSet<CSSPropertyID>::const_iterator it = m_keyframes.beginProperties(); it != end; ++it)
350         compositeAnimation()->overrideImplicitAnimations(*it);
351 }
352
353 void KeyframeAnimation::resumeOverriddenAnimations()
354 {
355     // This will resume overridden implicit animations
356     HashSet<CSSPropertyID>::const_iterator end = m_keyframes.endProperties();
357     for (HashSet<CSSPropertyID>::const_iterator it = m_keyframes.beginProperties(); it != end; ++it)
358         compositeAnimation()->resumeOverriddenImplicitAnimations(*it);
359 }
360
361 bool KeyframeAnimation::affectsProperty(CSSPropertyID property) const
362 {
363     return m_keyframes.containsProperty(property);
364 }
365
366 void KeyframeAnimation::validateTransformFunctionList()
367 {
368     m_transformFunctionListValid = false;
369     
370     if (m_keyframes.size() < 2 || !m_keyframes.containsProperty(CSSPropertyWebkitTransform))
371         return;
372
373     // Empty transforms match anything, so find the first non-empty entry as the reference
374     size_t numKeyframes = m_keyframes.size();
375     size_t firstNonEmptyTransformKeyframeIndex = numKeyframes;
376
377     for (size_t i = 0; i < numKeyframes; ++i) {
378         const KeyframeValue& currentKeyframe = m_keyframes[i];
379         if (currentKeyframe.style()->transform().operations().size()) {
380             firstNonEmptyTransformKeyframeIndex = i;
381             break;
382         }
383     }
384     
385     if (firstNonEmptyTransformKeyframeIndex == numKeyframes)
386         return;
387         
388     const TransformOperations* firstVal = &m_keyframes[firstNonEmptyTransformKeyframeIndex].style()->transform();
389     
390     // See if the keyframes are valid
391     for (size_t i = firstNonEmptyTransformKeyframeIndex + 1; i < numKeyframes; ++i) {
392         const KeyframeValue& currentKeyframe = m_keyframes[i];
393         const TransformOperations* val = &currentKeyframe.style()->transform();
394         
395         // An emtpy transform list matches anything.
396         if (val->operations().isEmpty())
397             continue;
398         
399         if (!firstVal->operationsMatch(*val))
400             return;
401     }
402
403     // Keyframes are valid
404     m_transformFunctionListValid = true;
405 }
406
407 #if ENABLE(CSS_FILTERS)
408 void KeyframeAnimation::checkForMatchingFilterFunctionLists()
409 {
410     m_filterFunctionListsMatch = false;
411
412     if (m_keyframes.size() < 2 || !m_keyframes.containsProperty(CSSPropertyWebkitFilter))
413         return;
414
415     // Empty filters match anything, so find the first non-empty entry as the reference
416     size_t numKeyframes = m_keyframes.size();
417     size_t firstNonEmptyFilterKeyframeIndex = numKeyframes;
418
419     for (size_t i = 0; i < numKeyframes; ++i) {
420         const KeyframeValue& currentKeyframe = m_keyframes[i];
421         if (currentKeyframe.style()->filter().operations().size()) {
422             firstNonEmptyFilterKeyframeIndex = i;
423             break;
424         }
425     }
426     
427     if (firstNonEmptyFilterKeyframeIndex == numKeyframes)
428         return;
429         
430     const FilterOperations* firstVal = &m_keyframes[firstNonEmptyFilterKeyframeIndex].style()->filter();
431     
432     for (size_t i = firstNonEmptyFilterKeyframeIndex + 1; i < numKeyframes; ++i) {
433         const KeyframeValue& currentKeyframe = m_keyframes[i];
434         const FilterOperations* val = &currentKeyframe.style()->filter();
435         
436         // An emtpy filter list matches anything.
437         if (val->operations().isEmpty())
438             continue;
439         
440         if (!firstVal->operationsMatch(*val))
441             return;
442     }
443     
444     m_filterFunctionListsMatch = true;
445 }
446 #endif
447
448 double KeyframeAnimation::timeToNextService()
449 {
450     double t = AnimationBase::timeToNextService();
451 #if USE(ACCELERATED_COMPOSITING)
452     if (t != 0 || preActive())
453         return t;
454         
455     // A return value of 0 means we need service. But if we only have accelerated animations we 
456     // only need service at the end of the transition
457     HashSet<CSSPropertyID>::const_iterator endProperties = m_keyframes.endProperties();
458     bool acceleratedPropertiesOnly = true;
459     
460     for (HashSet<CSSPropertyID>::const_iterator it = m_keyframes.beginProperties(); it != endProperties; ++it) {
461         if (!animationOfPropertyIsAccelerated(*it) || !isAccelerated()) {
462             acceleratedPropertiesOnly = false;
463             break;
464         }
465     }
466
467     if (acceleratedPropertiesOnly) {
468         bool isLooping;
469         getTimeToNextEvent(t, isLooping);
470     }
471 #endif
472     return t;
473 }
474
475 } // namespace WebCore