6643b00c1073f4a17b1d363c33ac5f01f8fe5822
[WebKit-https.git] / Source / WebKit2 / Shared / CoordinatedGraphics / threadedcompositor / ThreadedCompositor.h
1 /*
2  * Copyright (C) 2014 Igalia S.L.
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''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef ThreadedCompositor_h
27 #define ThreadedCompositor_h
28
29 #if USE(COORDINATED_GRAPHICS_THREADED)
30
31 #include "CoordinatedGraphicsScene.h"
32 #include "SimpleViewportController.h"
33 #include <WebCore/GLContext.h>
34 #include <WebCore/IntSize.h>
35 #include <WebCore/TransformationMatrix.h>
36 #include <wtf/FastMalloc.h>
37 #include <wtf/Noncopyable.h>
38 #include <wtf/ThreadSafeRefCounted.h>
39 #include <wtf/Threading.h>
40
41 namespace WebCore {
42 struct CoordinatedGraphicsState;
43 }
44
45 namespace WebKit {
46 class CoordinatedGraphicsScene;
47 class CoordinatedGraphicsSceneClient;
48
49 class CompositingRunLoop;
50
51 class ThreadedCompositor : public SimpleViewportController::Client, public CoordinatedGraphicsSceneClient, public ThreadSafeRefCounted<ThreadedCompositor> {
52     WTF_MAKE_NONCOPYABLE(ThreadedCompositor);
53     WTF_MAKE_FAST_ALLOCATED;
54 public:
55     class Client {
56     public:
57         virtual void setVisibleContentsRect(const WebCore::FloatRect&, const WebCore::FloatPoint&, float) = 0;
58         virtual void purgeBackingStores() = 0;
59         virtual void renderNextFrame() = 0;
60         virtual void commitScrollOffset(uint32_t layerID, const WebCore::IntSize& offset) = 0;
61     };
62
63     static Ref<ThreadedCompositor> create(Client*);
64     virtual ~ThreadedCompositor();
65
66     void setNeedsDisplay();
67
68     void setNativeSurfaceHandleForCompositing(uint64_t);
69
70     void updateSceneState(const WebCore::CoordinatedGraphicsState&);
71
72     void didChangeViewportSize(const WebCore::IntSize&);
73     void didChangeViewportAttribute(const WebCore::ViewportAttributes&);
74     void didChangeContentsSize(const WebCore::IntSize&);
75     void scrollTo(const WebCore::IntPoint&);
76     void scrollBy(const WebCore::IntSize&);
77
78 private:
79     ThreadedCompositor(Client*);
80
81     // CoordinatedGraphicsSceneClient
82     virtual void purgeBackingStores() override;
83     virtual void renderNextFrame() override;
84     virtual void updateViewport() override;
85     virtual void commitScrollOffset(uint32_t layerID, const WebCore::IntSize& offset) override;
86
87     void renderLayerTree();
88     void scheduleDisplayImmediately();
89     virtual void didChangeVisibleRect() override;
90
91     bool ensureGLContext();
92     WebCore::GLContext* glContext();
93     SimpleViewportController* viewportController() { return m_viewportController.get(); }
94
95     void callOnCompositingThread(std::function<void()>);
96     void createCompositingThread();
97     void runCompositingThread();
98     void terminateCompositingThread();
99     static void compositingThreadEntry(void*);
100
101     Client* m_client;
102     RefPtr<CoordinatedGraphicsScene> m_scene;
103     std::unique_ptr<SimpleViewportController> m_viewportController;
104
105     std::unique_ptr<WebCore::GLContext> m_context;
106
107     WebCore::IntSize m_viewportSize;
108     uint64_t m_nativeSurfaceHandle;
109
110     std::unique_ptr<CompositingRunLoop> m_compositingRunLoop;
111
112     ThreadIdentifier m_threadIdentifier;
113     ThreadCondition m_initializeRunLoopCondition;
114     DeprecatedMutex m_initializeRunLoopConditionMutex;
115     ThreadCondition m_terminateRunLoopCondition;
116     DeprecatedMutex m_terminateRunLoopConditionMutex;
117 };
118
119 } // namespace WebKit
120
121 #endif
122
123 #endif // ThreadedCompositor_h