93c128bc85a77a732b19a2dffdb72362b5f92a61
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / cc / CCSingleThreadProxy.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 CCSingleThreadProxy_h
26 #define CCSingleThreadProxy_h
27
28 #include "cc/CCAnimationEvents.h"
29 #include "cc/CCLayerTreeHostImpl.h"
30 #include "cc/CCProxy.h"
31 #include <limits>
32 #include <wtf/OwnPtr.h>
33
34 namespace WebCore {
35
36 class CCLayerTreeHost;
37 class CCSingleThreadProxyAnimationTimer;
38
39 class CCSingleThreadProxy : public CCProxy, CCLayerTreeHostImplClient {
40 public:
41     static PassOwnPtr<CCProxy> create(CCLayerTreeHost*);
42     virtual ~CCSingleThreadProxy();
43
44     // CCProxy implementation
45     virtual bool compositeAndReadback(void *pixels, const IntRect&) OVERRIDE;
46     virtual void startPageScaleAnimation(const IntSize& targetPosition, bool useAnchor, float scale, double duration) OVERRIDE;
47     virtual CCGraphicsContext* context() OVERRIDE;
48     virtual void finishAllRendering() OVERRIDE;
49     virtual bool isStarted() const OVERRIDE;
50     virtual bool initializeContext() OVERRIDE;
51     virtual void setSurfaceReady() OVERRIDE;
52     virtual bool initializeLayerRenderer() OVERRIDE;
53     virtual bool recreateContext() OVERRIDE;
54     virtual int compositorIdentifier() const OVERRIDE { return m_compositorIdentifier; }
55     virtual const LayerRendererCapabilities& layerRendererCapabilities() const OVERRIDE;
56     virtual void loseContext() OVERRIDE;
57     virtual void setNeedsAnimate() OVERRIDE;
58     virtual void setNeedsCommit() OVERRIDE;
59     virtual void setNeedsForcedCommit() OVERRIDE;
60     virtual void setNeedsRedraw() OVERRIDE;
61     virtual bool commitRequested() const OVERRIDE;
62     virtual void didAddAnimation() OVERRIDE;
63     virtual void start() OVERRIDE;
64     virtual void stop() OVERRIDE;
65     virtual size_t maxPartialTextureUpdates() const OVERRIDE { return std::numeric_limits<size_t>::max(); }
66     virtual void acquireLayerTextures() OVERRIDE { }
67     virtual void setFontAtlas(PassOwnPtr<CCFontAtlas>) OVERRIDE;
68     virtual void forceSerializeOnSwapBuffers() OVERRIDE;
69
70     // CCLayerTreeHostImplClient implementation
71     virtual void didLoseContextOnImplThread() OVERRIDE { }
72     virtual void onSwapBuffersCompleteOnImplThread() OVERRIDE { ASSERT_NOT_REACHED(); }
73     virtual void setNeedsRedrawOnImplThread() OVERRIDE { m_layerTreeHost->scheduleComposite(); }
74     virtual void setNeedsCommitOnImplThread() OVERRIDE { m_layerTreeHost->scheduleComposite(); }
75     virtual void postAnimationEventsToMainThreadOnImplThread(PassOwnPtr<CCAnimationEventsVector>, double wallClockTime) OVERRIDE;
76     virtual void postSetContentsMemoryAllocationLimitBytesToMainThreadOnImplThread(size_t) OVERRIDE;
77
78     // Called by the legacy path where RenderWidget does the scheduling.
79     void compositeImmediately();
80
81     // Measured in seconds.
82     static double animationTimerDelay();
83
84 private:
85     friend class CCSingleThreadProxyAnimationTimer;
86
87     explicit CCSingleThreadProxy(CCLayerTreeHost*);
88
89     bool commitAndComposite();
90     void doCommit(CCTextureUpdater&);
91     bool doComposite();
92     void didSwapFrame();
93
94     // Accessed on main thread only.
95     CCLayerTreeHost* m_layerTreeHost;
96     bool m_contextLost;
97     int m_compositorIdentifier;
98
99     // Holds on to the context between initializeContext() and initializeLayerRenderer() calls. Shouldn't
100     // be used for anything else.
101     RefPtr<CCGraphicsContext> m_contextBeforeInitialization;
102
103     OwnPtr<CCSingleThreadProxyAnimationTimer> m_animationTimer;
104
105     // Used on the CCThread, but checked on main thread during initialization/shutdown.
106     OwnPtr<CCLayerTreeHostImpl> m_layerTreeHostImpl;
107     bool m_layerRendererInitialized;
108     LayerRendererCapabilities m_layerRendererCapabilitiesForMainThread;
109
110     bool m_nextFrameIsNewlyCommittedFrame;
111 };
112
113 // For use in the single-threaded case. In debug builds, it pretends that the
114 // code is running on the thread to satisfy assertion checks.
115 class DebugScopedSetImplThread {
116 public:
117     DebugScopedSetImplThread()
118     {
119 #if !ASSERT_DISABLED
120         CCProxy::setCurrentThreadIsImplThread(true);
121 #endif
122     }
123     ~DebugScopedSetImplThread()
124     {
125 #if !ASSERT_DISABLED
126         CCProxy::setCurrentThreadIsImplThread(false);
127 #endif
128     }
129 };
130
131 // For use in the single-threaded case. In debug builds, it pretends that the
132 // code is running on the main thread to satisfy assertion checks.
133 class DebugScopedSetMainThread {
134 public:
135     DebugScopedSetMainThread()
136     {
137 #if !ASSERT_DISABLED
138         CCProxy::setCurrentThreadIsImplThread(false);
139 #endif
140     }
141     ~DebugScopedSetMainThread()
142     {
143 #if !ASSERT_DISABLED
144         CCProxy::setCurrentThreadIsImplThread(true);
145 #endif
146     }
147 };
148
149 } // namespace WebCore
150
151 #endif