Add base class to get WeakPtrFactory member and avoid some boilerplate code
[WebKit-https.git] / Source / WebKit / UIProcess / gtk / WaylandCompositor.h
1 /*
2  * Copyright (C) 2016 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 COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if PLATFORM(WAYLAND) && USE(EGL)
29
30 #include "WebPageProxy.h"
31 #include <WebCore/RefPtrCairo.h>
32 #include <WebCore/WlUniquePtr.h>
33 #include <gtk/gtk.h>
34 #include <wayland-server.h>
35 #include <wtf/HashMap.h>
36 #include <wtf/NeverDestroyed.h>
37 #include <wtf/Noncopyable.h>
38 #include <wtf/WeakPtr.h>
39 #include <wtf/glib/GRefPtr.h>
40 #include <wtf/text/WTFString.h>
41
42 typedef void *EGLImageKHR;
43
44 namespace WebCore {
45 class GLContext;
46 }
47
48 namespace WebKit {
49
50 class WebPageProxy;
51
52 class WaylandCompositor {
53     WTF_MAKE_NONCOPYABLE(WaylandCompositor);
54     friend NeverDestroyed<WaylandCompositor>;
55 public:
56     static WaylandCompositor& singleton();
57
58     class Buffer : public CanMakeWeakPtr<Buffer> {
59         WTF_MAKE_NONCOPYABLE(Buffer); WTF_MAKE_FAST_ALLOCATED;
60     public:
61         static Buffer* getOrCreate(struct wl_resource*);
62         ~Buffer();
63
64         void use();
65         void unuse();
66
67         EGLImageKHR createImage() const;
68         WebCore::IntSize size() const;
69
70     private:
71         Buffer(struct wl_resource*);
72         static void destroyListenerCallback(struct wl_listener*, void*);
73
74         struct wl_resource* m_resource { nullptr };
75         struct wl_listener m_destroyListener;
76         uint32_t m_busyCount { 0 };
77     };
78
79     class Surface {
80         WTF_MAKE_NONCOPYABLE(Surface); WTF_MAKE_FAST_ALLOCATED;
81     public:
82         Surface();
83         ~Surface();
84
85         void attachBuffer(struct wl_resource*);
86         void requestFrame(struct wl_resource*);
87         void commit();
88
89         void setWebPage(WebPageProxy*);
90         bool prepareTextureForPainting(unsigned&, WebCore::IntSize&);
91
92     private:
93         void flushFrameCallbacks();
94         void flushPendingFrameCallbacks();
95         void makePendingBufferCurrent();
96
97         WeakPtr<Buffer> m_buffer;
98         WeakPtr<Buffer> m_pendingBuffer;
99         unsigned m_texture;
100         EGLImageKHR m_image;
101         WebCore::IntSize m_imageSize;
102         Vector<wl_resource*> m_pendingFrameCallbackList;
103         Vector<wl_resource*> m_frameCallbackList;
104         WebPageProxy* m_webPage { nullptr };
105         unsigned m_tickCallbackID { 0 };
106     };
107
108     bool isRunning() const { return !!m_display; }
109     String displayName() const { return m_displayName; }
110
111     void bindSurfaceToWebPage(Surface*, uint64_t pageID);
112     void registerWebPage(WebPageProxy&);
113     void unregisterWebPage(WebPageProxy&);
114     void willDestroySurface(Surface*);
115
116     bool getTexture(WebPageProxy&, unsigned&, WebCore::IntSize&);
117
118 private:
119     WaylandCompositor();
120
121     bool initializeEGL();
122
123     String m_displayName;
124
125     struct DisplayDeleter {
126         void operator() (struct wl_display* display) { wl_display_destroy(display); }
127     };
128     std::unique_ptr<struct wl_display, DisplayDeleter> m_display;
129
130     WebCore::WlUniquePtr<struct wl_global> m_compositorGlobal;
131     WebCore::WlUniquePtr<struct wl_global> m_webkitgtkGlobal;
132     GRefPtr<GSource> m_eventSource;
133     std::unique_ptr<WebCore::GLContext> m_eglContext;
134     HashMap<WebPageProxy*, Surface*> m_pageMap;
135 };
136
137 } // namespace WebKit
138
139 #endif // PLATFORM(WAYLAND) && USE(EGL)