Added transport of on-screen visibility to qt-compositor via wayland

qt-compositor now has the ability to inform a client of not being visible on-screen.
This is mainly used to stop rendering and processing on the client-app side if the
window is occluded by another fullscreen window.

diff --git a/src/qt-compositor/compositor_api/waylandsurface.cpp b/src/qt-compositor/compositor_api/waylandsurface.cpp
index 90d9734..3f0e48f 100644 (file)
--- a/src/qt-compositor/compositor_api/waylandsurface.cpp
+++ b/src/qt-compositor/compositor_api/waylandsurface.cpp
@@ -123,3 +123,8 @@ void WaylandSurface::setInputFocus()
     d->surface->setInputFocus();
 }
 
+void WaylandSurface::sendOnScreenVisibilityChange(bool visible)
+{
+    Q_D(WaylandSurface);
+    d->surface->sendOnScreenVisibilityChange(visible);
+}

diff --git a/src/qt-compositor/compositor_api/waylandsurface.h b/src/qt-compositor/compositor_api/waylandsurface.h
index 7ce59af..26bd82f 100644 (file)
--- a/src/qt-compositor/compositor_api/waylandsurface.h
+++ b/src/qt-compositor/compositor_api/waylandsurface.h
@@ -89,6 +89,8 @@ public:
     void sendKeyPressEvent(uint code);
     void sendKeyReleaseEvent(uint code);
 
+    void sendOnScreenVisibilityChange(bool visible);
+
     void frameFinished();
     void setInputFocus();
 

diff --git a/src/qt-compositor/compositor_api/waylandsurfaceitem.cpp b/src/qt-compositor/compositor_api/waylandsurfaceitem.cpp
index 9ce0dc1..a84a604 100644 (file)
--- a/src/qt-compositor/compositor_api/waylandsurfaceitem.cpp
+++ b/src/qt-compositor/compositor_api/waylandsurfaceitem.cpp
@@ -73,6 +73,7 @@ WaylandSurfaceItem::WaylandSurfaceItem(QSGItem *parent)
     , m_surface(0)
     , m_texture(0)
     , m_paintEnabled(true)
+
 {
 }
 
@@ -102,6 +103,7 @@ void WaylandSurfaceItem::init(WaylandSurface *surface)
     connect(surface, SIGNAL(destroyed(QObject *)), this, SLOT(surfaceDestroyed(QObject *)));
     connect(this, SIGNAL(textureChanged()), this, SLOT(update()));
     connect(surface, SIGNAL(damaged(const QRect &)), this, SLOT(surfaceDamaged(const QRect &)));
+
 }
 
 WaylandSurfaceItem::~WaylandSurfaceItem()
@@ -229,7 +231,11 @@ void WaylandSurfaceItem::setClientRenderingEnabled(bool enabled)
 {
     if (m_clientRenderingEnabled != enabled) {
         m_clientRenderingEnabled = enabled;
-        //qDebug() << "CLIENT RENDERING ENABLED: " << enabled;
-        emit clientRenderingEnabledChanged();
+
+        if (m_surface) {
+            m_surface->sendOnScreenVisibilityChange(enabled);
+        }
+
+        emit clientRenderingEnabledChanged();       
     }
 }

diff --git a/src/qt-compositor/qt-compositor.pri b/src/qt-compositor/qt-compositor.pri
index 7f5f5d4..ee143e3 100644 (file)
--- a/src/qt-compositor/qt-compositor.pri
+++ b/src/qt-compositor/qt-compositor.pri
@@ -1,4 +1,6 @@
 INCLUDEPATH += $$PWD
+DEFINES += QT_WAYLAND_WINDOWMANAGER_SUPPORT
+
 use_pkgconfig {
     QMAKE_CXXFLAGS += $$system(pkg-config --cflags wayland-server)
     #for some reason this is not included in the cflags line

diff --git a/src/qt-compositor/wayland_wrapper/wlsurface.cpp b/src/qt-compositor/wayland_wrapper/wlsurface.cpp
index 225b7ab..76862cc 100644 (file)
--- a/src/qt-compositor/wayland_wrapper/wlsurface.cpp
+++ b/src/qt-compositor/wayland_wrapper/wlsurface.cpp
@@ -56,6 +56,10 @@
 #include <QtGui/QPlatformGLContext>
 #endif
 
+#ifdef QT_WAYLAND_WINDOWMANAGER_SUPPORT
+#include "waylandwindowmanagerintegration.h"
+#endif
+
 namespace Wayland {
 
 class SurfacePrivate
@@ -69,6 +73,7 @@ public:
         , processId(0)
         , surfaceBuffer(0)
         , surfaceType(WaylandSurface::Invalid)
+
     {
 #ifdef QT_COMPOSITOR_WAYLAND_GL
         texture_id = 0;
@@ -353,3 +358,11 @@ void Surface::setInputFocus()
 }
 
 }
+
+void Wayland::Surface::sendOnScreenVisibilityChange(bool visible)
+{
+#ifdef QT_WAYLAND_WINDOWMANAGER_SUPPORT
+    Q_D(Surface);
+    WindowManagerServerIntegration::instance()->changeScreenVisibility(d->client, visible ? 1 : 0);
+#endif
+}

diff --git a/src/qt-compositor/wayland_wrapper/wlsurface.h b/src/qt-compositor/wayland_wrapper/wlsurface.h
index cc5dad7..3ee5c7f 100644 (file)
--- a/src/qt-compositor/wayland_wrapper/wlsurface.h
+++ b/src/qt-compositor/wayland_wrapper/wlsurface.h
@@ -94,6 +94,8 @@ public:
     void frameFinished();
     void setInputFocus();
 
+    void sendOnScreenVisibilityChange(bool visible);
+
     WaylandSurface *handle() const;
     wl_client *clientHandle() const;
     qint64 processId() const;

diff --git a/src/qt-compositor/windowmanagerprotocol/wayland-windowmanager-protocol.c b/src/qt-compositor/windowmanagerprotocol/wayland-windowmanager-protocol.c
index b753b16..e759b3a 100644 (file)
--- a/src/qt-compositor/windowmanagerprotocol/wayland-windowmanager-protocol.c
+++ b/src/qt-compositor/windowmanagerprotocol/wayland-windowmanager-protocol.c
@@ -26,13 +26,17 @@
 #include "wayland-util.h"
 
 static const struct wl_message wl_windowmanager_requests[] = {
-        { "map_client_to_process", "u" },
-        { "authenticate_with_token", "s" },
+       { "map_client_to_process", "u", NULL },
+       { "authenticate_with_token", "s", NULL },
+};
+
+static const struct wl_message wl_windowmanager_events[] = {
+       { "client_onscreen_visibility", "i", NULL },
 };
 
 WL_EXPORT const struct wl_interface wl_windowmanager_interface = {
-        "wl_windowmanager", 1,
-        ARRAY_LENGTH(wl_windowmanager_requests), wl_windowmanager_requests,
-        0, NULL,
+       "wl_windowmanager", 1,
+       ARRAY_LENGTH(wl_windowmanager_requests), wl_windowmanager_requests,
+       ARRAY_LENGTH(wl_windowmanager_events), wl_windowmanager_events,
 };
 

diff --git a/src/qt-compositor/windowmanagerprotocol/wayland-windowmanager-server-protocol.h b/src/qt-compositor/windowmanagerprotocol/wayland-windowmanager-server-protocol.h
index 8738146..a0f4e3a 100644 (file)
--- a/src/qt-compositor/windowmanagerprotocol/wayland-windowmanager-server-protocol.h
+++ b/src/qt-compositor/windowmanagerprotocol/wayland-windowmanager-server-protocol.h
@@ -39,14 +39,16 @@ struct wl_windowmanager;
 extern const struct wl_interface wl_windowmanager_interface;
 
 struct wl_windowmanager_interface {
-        void (*map_client_to_process)(struct wl_client *client,
-                                      struct wl_windowmanager *windowmanager,
-                                      uint32_t processid);
-        void (*authenticate_with_token)(struct wl_client *client,
-                                        struct wl_windowmanager *windowmanager,
-                                        const char *wl_authentication_token);
+       void (*map_client_to_process)(struct wl_client *client,
+                                     struct wl_windowmanager *wl_windowmanager,
+                                     uint32_t processid);
+       void (*authenticate_with_token)(struct wl_client *client,
+                                       struct wl_windowmanager *wl_windowmanager,
+                                       const char *processid);
 };
 
+#define WL_WINDOWMANAGER_CLIENT_ONSCREEN_VISIBILITY    0
+
 #ifdef  __cplusplus
 }
 #endif

diff --git a/src/qt-compositor/windowmanagerprotocol/waylandwindowmanagerintegration.cpp b/src/qt-compositor/windowmanagerprotocol/waylandwindowmanagerintegration.cpp
index 5783959..fa6d4b6 100644 (file)
--- a/src/qt-compositor/windowmanagerprotocol/waylandwindowmanagerintegration.cpp
+++ b/src/qt-compositor/windowmanagerprotocol/waylandwindowmanagerintegration.cpp
@@ -71,6 +71,11 @@ public:
         WindowManagerServerIntegration::instance()->authenticateWithToken(client, authenticationToken);
     }
 
+    void changeScreenVisibility(wl_client *client, int visible)
+    {
+        WindowManagerServerIntegration::instance()->changeScreenVisibility(client, visible);
+    }
+
 };
 
 void map_client_to_process(wl_client *client, struct wl_windowmanager *windowMgr, uint32_t processId)
@@ -123,6 +128,16 @@ void WindowManagerServerIntegration::authenticateWithToken(wl_client *client, co
     m_managedClients.insert(client, managedClient);
 }
 
+void WindowManagerServerIntegration::changeScreenVisibility(wl_client *client, int visible)
+{
+    m_managedClients[client]->m_isVisibleOnScreen = visible != 0;
+
+    qDebug() << Q_FUNC_INFO << visible;
+    wl_client_post_event(client, m_windowManagerObject->base(),
+                         WL_WINDOWMANAGER_CLIENT_ONSCREEN_VISIBILITY, visible);
+}
+
+
 WaylandManagedClient *WindowManagerServerIntegration::managedClient(wl_client *client) const
 {
     return m_managedClients.value(client, 0);

diff --git a/src/qt-compositor/windowmanagerprotocol/waylandwindowmanagerintegration.h b/src/qt-compositor/windowmanagerprotocol/waylandwindowmanagerintegration.h
index b3e90af..65eb3f3 100644 (file)
--- a/src/qt-compositor/windowmanagerprotocol/waylandwindowmanagerintegration.h
+++ b/src/qt-compositor/windowmanagerprotocol/waylandwindowmanagerintegration.h
@@ -66,6 +66,7 @@ public:
 
     WaylandManagedClient *managedClient(wl_client *client) const;
 
+    void changeScreenVisibility(wl_client *client, int visible);
 private:
     void mapClientToProcess(wl_client *client, uint32_t processId);
     void authenticateWithToken(wl_client *client, const char *token);
@@ -85,10 +86,12 @@ public:
     WaylandManagedClient();
     qint64 processId() const;
     QByteArray authenticationToken() const;
+    bool isVisibleOnScreen() const { return m_isVisibleOnScreen; }
 
 private:
     qint64 m_processId;
     QByteArray m_authenticationToken;
+    bool m_isVisibleOnScreen;
 
     friend class WindowManagerServerIntegration;
 };

diff --git a/src/qt-compositor/windowmanagerprotocol/windowmanager.xml b/src/qt-compositor/windowmanagerprotocol/windowmanager.xml
index f29c337..2d76ae0 100644 (file)
--- a/src/qt-compositor/windowmanagerprotocol/windowmanager.xml
+++ b/src/qt-compositor/windowmanagerprotocol/windowmanager.xml
@@ -13,6 +13,15 @@
         <request name="map_client_to_process">
             <arg name="processid" type="uint" />
         </request>
-    </interface>
+        <request name="authenticate_with_token">
+            <arg name="processid" type="string" />
+        </request>
 
+       <!-- informs the client that it is visible/not visible on screen and can therfore stop / need to start rendering.
+            The client need to implement the handling of this by itself. This means, we cannot enforce the client to obey,
+            but we can encourage it to do so. -->
+        <event name="client_onscreen_visibility">
+           <arg name="visible" type="int"/>
+       </event>
+    </interface>
 </protocol>