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 "DisplayRefreshMonitor.h"
34#endif
35#include "Timer.h"
36#endif
37#include "PlatformScreen.h"
38#include <wtf/RefCounted.h>
39#include <wtf/RefPtr.h>
40#include <wtf/Vector.h>
41
42namespace WebCore {
43
44class Document;
45class RequestAnimationFrameCallback;
46
47class ScriptedAnimationController : public RefCounted<ScriptedAnimationController>
48#if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
49    , public DisplayRefreshMonitorClient
50#endif
51{
52public:
53    static PassRefPtr<ScriptedAnimationController> create(Document* document, PlatformDisplayID displayID)
54    {
55        return adoptRef(new ScriptedAnimationController(document, displayID));
56    }
57    ~ScriptedAnimationController();
58    void clearDocumentPointer() { m_document = 0; }
59
60    typedef int CallbackId;
61
62    CallbackId registerCallback(PassRefPtr<RequestAnimationFrameCallback>);
63    void cancelCallback(CallbackId);
64    void serviceScriptedAnimations(double monotonicTimeNow);
65
66    void suspend();
67    void resume();
68    void setThrottled(bool);
69
70    void windowScreenDidChange(PlatformDisplayID);
71
72private:
73    ScriptedAnimationController(Document*, PlatformDisplayID);
74
75    typedef Vector<RefPtr<RequestAnimationFrameCallback> > CallbackList;
76    CallbackList m_callbacks;
77
78    Document* m_document;
79    CallbackId m_nextCallbackId;
80    int m_suspendCount;
81
82    void scheduleAnimation();
83
84#if USE(REQUEST_ANIMATION_FRAME_TIMER)
85    void animationTimerFired(Timer<ScriptedAnimationController>*);
86    Timer<ScriptedAnimationController> m_animationTimer;
87    double m_lastAnimationFrameTimeMonotonic;
88
89#if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
90    // Override for DisplayRefreshMonitorClient
91    virtual void displayRefreshFired(double timestamp);
92
93    bool m_isUsingTimer;
94    bool m_isThrottled;
95#endif
96#endif
97};
98
99}
100
101#endif // ENABLE(REQUEST_ANIMATION_FRAME)
102
103#endif // ScriptedAnimationController_h
104