1/*
2 * Copyright (C) 2011 Google 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. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14 *  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16 *  DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17 *  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18 *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 *  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 */
25
26#ifndef ScriptedAnimationController_h
27#define ScriptedAnimationController_h
28
29#if ENABLE(REQUEST_ANIMATION_FRAME)
30#include "DOMTimeStamp.h"
31#if USE(REQUEST_ANIMATION_FRAME_TIMER)
32#if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
33#include "Chrome.h"
34#include "ChromeClient.h"
35#include "DisplayRefreshMonitorClient.h"
36#endif
37#include "Timer.h"
38#endif
39#include "PlatformScreen.h"
40#include <wtf/RefCounted.h>
41#include <wtf/RefPtr.h>
42#include <wtf/Vector.h>
43
44namespace WebCore {
45
46class Document;
47class RequestAnimationFrameCallback;
48
49class ScriptedAnimationController : public RefCounted<ScriptedAnimationController>
50#if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
51    , public DisplayRefreshMonitorClient
52#endif
53{
54public:
55    static PassRefPtr<ScriptedAnimationController> create(Document* document, PlatformDisplayID displayID)
56    {
57        return adoptRef(new ScriptedAnimationController(document, displayID));
58    }
59    ~ScriptedAnimationController();
60    void clearDocumentPointer() { m_document = 0; }
61
62    typedef int CallbackId;
63
64    CallbackId registerCallback(PassRefPtr<RequestAnimationFrameCallback>);
65    void cancelCallback(CallbackId);
66    void serviceScriptedAnimations(double monotonicTimeNow);
67
68    void suspend();
69    void resume();
70    void setThrottled(bool);
71
72    void windowScreenDidChange(PlatformDisplayID);
73
74private:
75    ScriptedAnimationController(Document*, PlatformDisplayID);
76
77    typedef Vector<RefPtr<RequestAnimationFrameCallback>> CallbackList;
78    CallbackList m_callbacks;
79
80    Document* m_document;
81    CallbackId m_nextCallbackId;
82    int m_suspendCount;
83
84    void scheduleAnimation();
85
86#if USE(REQUEST_ANIMATION_FRAME_TIMER)
87    void animationTimerFired(Timer<ScriptedAnimationController>&);
88    Timer<ScriptedAnimationController> m_animationTimer;
89    double m_lastAnimationFrameTimeMonotonic;
90
91#if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
92    // Override for DisplayRefreshMonitorClient
93    virtual void displayRefreshFired(double timestamp) override;
94    virtual PassRefPtr<DisplayRefreshMonitor> createDisplayRefreshMonitor(PlatformDisplayID) const override;
95
96    bool m_isUsingTimer;
97    bool m_isThrottled;
98#endif
99#endif
100};
101
102}
103
104#endif // ENABLE(REQUEST_ANIMATION_FRAME)
105
106#endif // ScriptedAnimationController_h
107