a41aad4d8429268b2208a50c8a4258e78bcabe73
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / cc / CCDelayBasedTimeSource.h
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 #ifndef CCDelayBasedTimeSource_h
26 #define CCDelayBasedTimeSource_h
27
28 #include "cc/CCTimeSource.h"
29 #include "cc/CCTimer.h"
30
31 #include <wtf/PassRefPtr.h>
32
33 namespace WebCore {
34
35 class CCThread;
36
37 // This timer implements a time source that achieves the specified interval
38 // in face of millisecond-precision delayed callbacks and random queueing delays.
39 class CCDelayBasedTimeSource : public CCTimeSource, CCTimerClient {
40 public:
41     static PassRefPtr<CCDelayBasedTimeSource> create(double intervalMs, CCThread*);
42
43     virtual ~CCDelayBasedTimeSource() { }
44
45     virtual void setClient(CCTimeSourceClient* client) { m_client = client; }
46
47     virtual void setActive(bool);
48     virtual bool active() const { return m_state != STATE_INACTIVE; }
49
50     // CCTimerClient implementation.
51     virtual void onTimerFired();
52
53     // Virtual for testing.
54     virtual double monotonicallyIncreasingTimeMs() const;
55
56 protected:
57     CCDelayBasedTimeSource(double intervalMs, CCThread*);
58     void postNextTickTask(double nowMs);
59
60     enum State {
61         STATE_INACTIVE,
62         STATE_STARTING,
63         STATE_ACTIVE,
64     };
65     CCTimeSourceClient* m_client;
66     bool m_hasTickTarget;
67     double m_intervalMs;
68     double m_tickTarget;
69     State m_state;
70     CCThread* m_thread;
71     CCTimer m_timer;
72 };
73
74 }
75 #endif // CCDelayBasedTimeSource_h