Use "= default" to denote default constructor or destructor
[WebKit-https.git] / Source / WebCore / platform / ScrollAnimationSmooth.cpp
1 /*
2  * Copyright (C) 2016 Igalia S.L.
3  * Copyright (C) 2015 Apple Inc. All rights reserved.
4  * Copyright (c) 2011, Google Inc. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
17  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
19  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
25  * THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #include "config.h"
29 #include "ScrollAnimationSmooth.h"
30
31 #if ENABLE(SMOOTH_SCROLLING)
32
33 #include "FloatPoint.h"
34 #include "ScrollableArea.h"
35 #include <wtf/CurrentTime.h>
36
37 namespace WebCore {
38
39 static const double frameRate = 60;
40 static const Seconds tickTime = 1_s / frameRate;
41 static const Seconds minimumTimerInterval { 1_ms };
42
43 ScrollAnimationSmooth::ScrollAnimationSmooth(ScrollableArea& scrollableArea, const FloatPoint& position, WTF::Function<void (FloatPoint&&)>&& notifyPositionChangedFunction)
44     : ScrollAnimation(scrollableArea)
45     , m_notifyPositionChangedFunction(WTFMove(notifyPositionChangedFunction))
46     , m_horizontalData(position.x(), scrollableArea.visibleWidth())
47     , m_verticalData(position.y(), scrollableArea.visibleHeight())
48     , m_animationTimer(*this, &ScrollAnimationSmooth::animationTimerFired)
49 {
50 }
51
52 bool ScrollAnimationSmooth::scroll(ScrollbarOrientation orientation, ScrollGranularity granularity, float step, float multiplier)
53 {
54     float minScrollPosition;
55     float maxScrollPosition;
56     if (orientation == HorizontalScrollbar) {
57         minScrollPosition = m_scrollableArea.minimumScrollPosition().x();
58         maxScrollPosition = m_scrollableArea.maximumScrollPosition().x();
59     } else {
60         minScrollPosition = m_scrollableArea.minimumScrollPosition().y();
61         maxScrollPosition = m_scrollableArea.maximumScrollPosition().y();
62     }
63     bool needToScroll = updatePerAxisData(orientation == HorizontalScrollbar ? m_horizontalData : m_verticalData, granularity, step * multiplier, minScrollPosition, maxScrollPosition);
64     if (needToScroll && !animationTimerActive()) {
65         m_startTime = orientation == HorizontalScrollbar ? m_horizontalData.startTime : m_verticalData.startTime;
66         animationTimerFired();
67     }
68     return needToScroll;
69 }
70
71 void ScrollAnimationSmooth::stop()
72 {
73     m_animationTimer.stop();
74 }
75
76 void ScrollAnimationSmooth::updateVisibleLengths()
77 {
78     m_horizontalData.visibleLength = m_scrollableArea.visibleWidth();
79     m_verticalData.visibleLength = m_scrollableArea.visibleHeight();
80 }
81
82 void ScrollAnimationSmooth::setCurrentPosition(const FloatPoint& position)
83 {
84     stop();
85     m_horizontalData = PerAxisData(position.x(), m_horizontalData.visibleLength);
86     m_verticalData = PerAxisData(position.y(), m_verticalData.visibleLength);
87 }
88
89 ScrollAnimationSmooth::~ScrollAnimationSmooth() = default;
90
91 static inline double curveAt(ScrollAnimationSmooth::Curve curve, double t)
92 {
93     switch (curve) {
94     case ScrollAnimationSmooth::Curve::Linear:
95         return t;
96     case ScrollAnimationSmooth::Curve::Quadratic:
97         return t * t;
98     case ScrollAnimationSmooth::Curve::Cubic:
99         return t * t * t;
100     case ScrollAnimationSmooth::Curve::Quartic:
101         return t * t * t * t;
102     case ScrollAnimationSmooth::Curve::Bounce:
103         // Time base is chosen to keep the bounce points simpler:
104         // 1 (half bounce coming in) + 1 + .5 + .25
105         static const double timeBase = 2.75;
106         static const double timeBaseSquared = timeBase * timeBase;
107         if (t < 1 / timeBase)
108             return timeBaseSquared * t * t;
109         if (t < 2 / timeBase) {
110             // Invert a [-.5,.5] quadratic parabola, center it in [1,2].
111             double t1 = t - 1.5 / timeBase;
112             const double parabolaAtEdge = 1 - .5 * .5;
113             return timeBaseSquared * t1 * t1 + parabolaAtEdge;
114         }
115         if (t < 2.5 / timeBase) {
116             // Invert a [-.25,.25] quadratic parabola, center it in [2,2.5].
117             double t2 = t - 2.25 / timeBase;
118             const double parabolaAtEdge = 1 - .25 * .25;
119             return timeBaseSquared * t2 * t2 + parabolaAtEdge;
120         }
121         // Invert a [-.125,.125] quadratic parabola, center it in [2.5,2.75].
122         const double parabolaAtEdge = 1 - .125 * .125;
123         t -= 2.625 / timeBase;
124         return timeBaseSquared * t * t + parabolaAtEdge;
125     }
126     ASSERT_NOT_REACHED();
127     return 0;
128 }
129
130 static inline double attackCurve(ScrollAnimationSmooth::Curve curve, double deltaTime, double curveT, double startPosition, double attackPosition)
131 {
132     double t = deltaTime / curveT;
133     double positionFactor = curveAt(curve, t);
134     return startPosition + positionFactor * (attackPosition - startPosition);
135 }
136
137 static inline double releaseCurve(ScrollAnimationSmooth::Curve curve, double deltaTime, double curveT, double releasePosition, double desiredPosition)
138 {
139     double t = deltaTime / curveT;
140     double positionFactor = 1 - curveAt(curve, 1 - t);
141     return releasePosition + (positionFactor * (desiredPosition - releasePosition));
142 }
143
144 static inline double coastCurve(ScrollAnimationSmooth::Curve curve, double factor)
145 {
146     return 1 - curveAt(curve, 1 - factor);
147 }
148
149 static inline double curveIntegralAt(ScrollAnimationSmooth::Curve curve, double t)
150 {
151     switch (curve) {
152     case ScrollAnimationSmooth::Curve::Linear:
153         return t * t / 2;
154     case ScrollAnimationSmooth::Curve::Quadratic:
155         return t * t * t / 3;
156     case ScrollAnimationSmooth::Curve::Cubic:
157         return t * t * t * t / 4;
158     case ScrollAnimationSmooth::Curve::Quartic:
159         return t * t * t * t * t / 5;
160     case ScrollAnimationSmooth::Curve::Bounce:
161         static const double timeBase = 2.75;
162         static const double timeBaseSquared = timeBase * timeBase;
163         static const double timeBaseSquaredOverThree = timeBaseSquared / 3;
164         double area;
165         double t1 = std::min(t, 1 / timeBase);
166         area = timeBaseSquaredOverThree * t1 * t1 * t1;
167         if (t < 1 / timeBase)
168             return area;
169
170         t1 = std::min(t - 1 / timeBase, 1 / timeBase);
171         // The integral of timeBaseSquared * (t1 - .5 / timeBase) * (t1 - .5 / timeBase) + parabolaAtEdge
172         static const double secondInnerOffset = timeBaseSquared * .5 / timeBase;
173         double bounceArea = t1 * (t1 * (timeBaseSquaredOverThree * t1 - secondInnerOffset) + 1);
174         area += bounceArea;
175         if (t < 2 / timeBase)
176             return area;
177
178         t1 = std::min(t - 2 / timeBase, 0.5 / timeBase);
179         // The integral of timeBaseSquared * (t1 - .25 / timeBase) * (t1 - .25 / timeBase) + parabolaAtEdge
180         static const double thirdInnerOffset = timeBaseSquared * .25 / timeBase;
181         bounceArea =  t1 * (t1 * (timeBaseSquaredOverThree * t1 - thirdInnerOffset) + 1);
182         area += bounceArea;
183         if (t < 2.5 / timeBase)
184             return area;
185
186         t1 = t - 2.5 / timeBase;
187         // The integral of timeBaseSquared * (t1 - .125 / timeBase) * (t1 - .125 / timeBase) + parabolaAtEdge
188         static const double fourthInnerOffset = timeBaseSquared * .125 / timeBase;
189         bounceArea = t1 * (t1 * (timeBaseSquaredOverThree * t1 - fourthInnerOffset) + 1);
190         area += bounceArea;
191         return area;
192     }
193     ASSERT_NOT_REACHED();
194     return 0;
195 }
196
197 static inline double attackArea(ScrollAnimationSmooth::Curve curve, double startT, double endT)
198 {
199     double startValue = curveIntegralAt(curve, startT);
200     double endValue = curveIntegralAt(curve, endT);
201     return endValue - startValue;
202 }
203
204 static inline double releaseArea(ScrollAnimationSmooth::Curve curve, double startT, double endT)
205 {
206     double startValue = curveIntegralAt(curve, 1 - endT);
207     double endValue = curveIntegralAt(curve, 1 - startT);
208     return endValue - startValue;
209 }
210
211 static inline void getAnimationParametersForGranularity(ScrollGranularity granularity, Seconds& animationTime, Seconds& repeatMinimumSustainTime, Seconds& attackTime, Seconds& releaseTime, ScrollAnimationSmooth::Curve& coastTimeCurve, Seconds& maximumCoastTime)
212 {
213     switch (granularity) {
214     case ScrollByDocument:
215         animationTime = tickTime * 10;
216         repeatMinimumSustainTime = tickTime * 10;
217         attackTime = tickTime * 10;
218         releaseTime = tickTime * 10;
219         coastTimeCurve = ScrollAnimationSmooth::Curve::Linear;
220         maximumCoastTime = 1_s;
221         break;
222     case ScrollByLine:
223         animationTime = tickTime * 10;
224         repeatMinimumSustainTime = tickTime * 7;
225         attackTime = tickTime * 3;
226         releaseTime = tickTime * 3;
227         coastTimeCurve = ScrollAnimationSmooth::Curve::Linear;
228         maximumCoastTime = 1_s;
229         break;
230     case ScrollByPage:
231         animationTime = tickTime * 15;
232         repeatMinimumSustainTime = tickTime * 10;
233         attackTime = tickTime * 5;
234         releaseTime = tickTime * 5;
235         coastTimeCurve = ScrollAnimationSmooth::Curve::Linear;
236         maximumCoastTime = 1_s;
237         break;
238     case ScrollByPixel:
239         animationTime = tickTime * 11;
240         repeatMinimumSustainTime = tickTime * 2;
241         attackTime = tickTime * 3;
242         releaseTime = tickTime * 3;
243         coastTimeCurve = ScrollAnimationSmooth::Curve::Quadratic;
244         maximumCoastTime = 1250_ms;
245         break;
246     default:
247         ASSERT_NOT_REACHED();
248     }
249 }
250
251 bool ScrollAnimationSmooth::updatePerAxisData(PerAxisData& data, ScrollGranularity granularity, float delta, float minScrollPosition, float maxScrollPosition)
252 {
253     if (!data.startTime || !delta || (delta < 0) != (data.desiredPosition - data.currentPosition < 0)) {
254         data.desiredPosition = data.currentPosition;
255         data.startTime = { };
256     }
257     float newPosition = data.desiredPosition + delta;
258
259     newPosition = std::max(std::min(newPosition, maxScrollPosition), minScrollPosition);
260
261     if (newPosition == data.desiredPosition)
262         return false;
263
264     Seconds animationTime, repeatMinimumSustainTime, attackTime, releaseTime, maximumCoastTime;
265     Curve coastTimeCurve;
266     getAnimationParametersForGranularity(granularity, animationTime, repeatMinimumSustainTime, attackTime, releaseTime, coastTimeCurve, maximumCoastTime);
267
268     data.desiredPosition = newPosition;
269     if (!data.startTime)
270         data.attackTime = attackTime;
271     data.animationTime = animationTime;
272     data.releaseTime = releaseTime;
273
274     // Prioritize our way out of over constraint.
275     if (data.attackTime + data.releaseTime > data.animationTime) {
276         if (data.releaseTime > data.animationTime)
277             data.releaseTime = data.animationTime;
278         data.attackTime = data.animationTime - data.releaseTime;
279     }
280
281     if (!data.startTime) {
282         // FIXME: This should be the time from the event that got us here.
283         data.startTime = MonotonicTime::now() - tickTime / 2.;
284         data.startPosition = data.currentPosition;
285         data.lastAnimationTime = data.startTime;
286     }
287     data.startVelocity = data.currentVelocity;
288
289     double remainingDelta = data.desiredPosition - data.currentPosition;
290     double attackAreaLeft = 0;
291     Seconds deltaTime = data.lastAnimationTime - data.startTime;
292     Seconds attackTimeLeft = std::max(0_s, data.attackTime - deltaTime);
293     Seconds timeLeft = data.animationTime - deltaTime;
294     Seconds minTimeLeft = data.releaseTime + std::min(repeatMinimumSustainTime, data.animationTime - data.releaseTime - attackTimeLeft);
295     if (timeLeft < minTimeLeft) {
296         data.animationTime = deltaTime + minTimeLeft;
297         timeLeft = minTimeLeft;
298     }
299
300     if (maximumCoastTime > (repeatMinimumSustainTime + releaseTime)) {
301         double targetMaxCoastVelocity = data.visibleLength * .25 * frameRate;
302         // This needs to be as minimal as possible while not being intrusive to page up/down.
303         double minCoastDelta = data.visibleLength;
304
305         if (fabs(remainingDelta) > minCoastDelta) {
306             double maxCoastDelta = maximumCoastTime.value() * targetMaxCoastVelocity;
307             double coastFactor = std::min(1., (fabs(remainingDelta) - minCoastDelta) / (maxCoastDelta - minCoastDelta));
308
309             // We could play with the curve here - linear seems a little soft. Initial testing makes me want to feed into the sustain time more aggressively.
310             Seconds coastMinTimeLeft = std::min(maximumCoastTime, minTimeLeft + (maximumCoastTime - minTimeLeft) * coastCurve(coastTimeCurve, coastFactor));
311
312             if (Seconds additionalTime = std::max(0_s, coastMinTimeLeft - minTimeLeft)) {
313                 Seconds additionalReleaseTime = std::min(additionalTime, additionalTime * (releaseTime / (releaseTime + repeatMinimumSustainTime)));
314                 data.releaseTime = releaseTime + additionalReleaseTime;
315                 data.animationTime = deltaTime + coastMinTimeLeft;
316                 timeLeft = coastMinTimeLeft;
317             }
318         }
319     }
320
321     Seconds releaseTimeLeft = std::min(timeLeft, data.releaseTime);
322     Seconds sustainTimeLeft = std::max(0_s, timeLeft - releaseTimeLeft - attackTimeLeft);
323     if (attackTimeLeft) {
324         double attackSpot = deltaTime / data.attackTime;
325         attackAreaLeft = attackArea(Curve::Cubic, attackSpot, 1) * data.attackTime.value();
326     }
327
328     double releaseSpot = (data.releaseTime - releaseTimeLeft) / data.releaseTime;
329     double releaseAreaLeft = releaseArea(Curve::Cubic, releaseSpot, 1) * data.releaseTime.value();
330
331     data.desiredVelocity = remainingDelta / (attackAreaLeft + sustainTimeLeft.value() + releaseAreaLeft);
332     data.releasePosition = data.desiredPosition - data.desiredVelocity * releaseAreaLeft;
333     if (attackAreaLeft)
334         data.attackPosition = data.startPosition + data.desiredVelocity * attackAreaLeft;
335     else
336         data.attackPosition = data.releasePosition - (data.animationTime - data.releaseTime - data.attackTime).value() * data.desiredVelocity;
337
338     if (sustainTimeLeft) {
339         double roundOff = data.releasePosition - ((attackAreaLeft ? data.attackPosition : data.currentPosition) + data.desiredVelocity * sustainTimeLeft.value());
340         data.desiredVelocity += roundOff / sustainTimeLeft.value();
341     }
342
343     return true;
344 }
345
346 bool ScrollAnimationSmooth::animateScroll(PerAxisData& data, MonotonicTime currentTime)
347 {
348     if (!data.startTime)
349         return false;
350
351     Seconds lastScrollInterval = currentTime - data.lastAnimationTime;
352     if (lastScrollInterval < minimumTimerInterval)
353         return true;
354
355     data.lastAnimationTime = currentTime;
356
357     Seconds deltaTime = currentTime - data.startTime;
358     double newPosition = data.currentPosition;
359
360     if (deltaTime > data.animationTime) {
361         data = PerAxisData(data.desiredPosition, data.visibleLength);
362         return false;
363     }
364     if (deltaTime < data.attackTime)
365         newPosition = attackCurve(Curve::Cubic, deltaTime.value(), data.attackTime.value(), data.startPosition, data.attackPosition);
366     else if (deltaTime < (data.animationTime - data.releaseTime))
367         newPosition = data.attackPosition + (deltaTime - data.attackTime).value() * data.desiredVelocity;
368     else {
369         // release is based on targeting the exact final position.
370         Seconds releaseDeltaT = deltaTime - (data.animationTime - data.releaseTime);
371         newPosition = releaseCurve(Curve::Cubic, releaseDeltaT.value(), data.releaseTime.value(), data.releasePosition, data.desiredPosition);
372     }
373
374     // Normalize velocity to a per second amount. Could be used to check for jank.
375     if (lastScrollInterval > 0_s)
376         data.currentVelocity = (newPosition - data.currentPosition) / lastScrollInterval.value();
377     data.currentPosition = newPosition;
378
379     return true;
380 }
381
382 void ScrollAnimationSmooth::animationTimerFired()
383 {
384     MonotonicTime currentTime = MonotonicTime::now();
385     Seconds deltaToNextFrame = 1_s * ceil((currentTime - m_startTime).value() * frameRate) / frameRate - (currentTime - m_startTime);
386     currentTime += deltaToNextFrame;
387
388     bool continueAnimation = false;
389     if (animateScroll(m_horizontalData, currentTime))
390         continueAnimation = true;
391     if (animateScroll(m_verticalData, currentTime))
392         continueAnimation = true;
393
394     if (continueAnimation)
395         startNextTimer(std::max(minimumTimerInterval, deltaToNextFrame));
396
397     m_notifyPositionChangedFunction(FloatPoint(m_horizontalData.currentPosition, m_verticalData.currentPosition));
398 }
399
400 void ScrollAnimationSmooth::startNextTimer(Seconds delay)
401 {
402     m_animationTimer.startOneShot(delay);
403 }
404
405 bool ScrollAnimationSmooth::animationTimerActive() const
406 {
407     return m_animationTimer.isActive();
408 }
409
410 } // namespace WebCore
411
412 #endif // ENABLE(SMOOTH_SCROLLING)