Add support for the frames() timing function
[WebKit-https.git] / Source / WebCore / platform / animation / TimingFunction.cpp
1 /*
2  * Copyright (C) 2015 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 #include "config.h"
27 #include "TimingFunction.h"
28
29 #include "SpringSolver.h"
30 #include "UnitBezier.h"
31 #include <wtf/text/TextStream.h>
32
33 namespace WebCore {
34
35 TextStream& operator<<(TextStream& ts, const TimingFunction& timingFunction)
36 {
37     switch (timingFunction.type()) {
38     case TimingFunction::LinearFunction:
39         ts << "linear";
40         break;
41     case TimingFunction::CubicBezierFunction: {
42         auto& function = static_cast<const CubicBezierTimingFunction&>(timingFunction);
43         ts << "cubic-bezier(" << function.x1() << ", " << function.y1() << ", " <<  function.x2() << ", " << function.y2() << ")";
44         break;
45     }
46     case TimingFunction::StepsFunction: {
47         auto& function = static_cast<const StepsTimingFunction&>(timingFunction);
48         ts << "steps(" << function.numberOfSteps() << ", " << (function.stepAtStart() ? "start" : "end") << ")";
49         break;
50     }
51     case TimingFunction::FramesFunction: {
52         auto& function = static_cast<const FramesTimingFunction&>(timingFunction);
53         ts << "frames(" << function.numberOfFrames() << ")";
54         break;
55     }
56     case TimingFunction::SpringFunction: {
57         auto& function = static_cast<const SpringTimingFunction&>(timingFunction);
58         ts << "spring(" << function.mass() << " " << function.stiffness() << " " <<  function.damping() << " " << function.initialVelocity() << ")";
59         break;
60     }
61     }
62     return ts;
63 }
64
65 double TimingFunction::transformTime(double inputTime, double duration) const
66 {
67     switch (m_type) {
68     case TimingFunction::CubicBezierFunction: {
69         auto& function = *static_cast<const CubicBezierTimingFunction*>(this);
70         // The epsilon value we pass to UnitBezier::solve given that the animation is going to run over |dur| seconds. The longer the
71         // animation, the more precision we need in the timing function result to avoid ugly discontinuities.
72         auto epsilon = 1.0 / (200.0 * duration);
73         return UnitBezier(function.x1(), function.y1(), function.x2(), function.y2()).solve(inputTime, epsilon);
74     }
75     case TimingFunction::StepsFunction: {
76         auto& function = *static_cast<const StepsTimingFunction*>(this);
77         auto numberOfSteps = function.numberOfSteps();
78         if (function.stepAtStart())
79             return std::min(1.0, (std::floor(numberOfSteps * inputTime) + 1) / numberOfSteps);
80         return std::floor(numberOfSteps * inputTime) / numberOfSteps;
81     }
82     case TimingFunction::FramesFunction: {
83         // https://drafts.csswg.org/css-timing/#frames-timing-functions
84         auto& function = *static_cast<const FramesTimingFunction*>(this);
85         auto numberOfFrames = function.numberOfFrames();
86         ASSERT(numberOfFrames > 1);
87         auto outputTime = std::floor(inputTime * numberOfFrames) / (numberOfFrames - 1);
88         if (inputTime <= 1 && outputTime > 1)
89             return 1;
90         return outputTime;
91     }
92     case TimingFunction::SpringFunction: {
93         auto& function = *static_cast<const SpringTimingFunction*>(this);
94         return SpringSolver(function.mass(), function.stiffness(), function.damping(), function.initialVelocity()).solve(inputTime * duration);
95     }
96     case TimingFunction::LinearFunction:
97         return inputTime;
98     }
99
100     ASSERT_NOT_REACHED();
101     return 0;
102 }
103
104 } // namespace WebCore