[vlc-commits] xdg-shell: add Kwin SSD support
Rémi Denis-Courmont
git at videolan.org
Thu Feb 2 21:14:03 CET 2017
vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Thu Feb 2 22:03:28 2017 +0200| [86a971b18a22b8ed6ec56d5a38213105ed72a310] | committer: Rémi Denis-Courmont
xdg-shell: add Kwin SSD support
This adds support for the KDE-specific server-side decorations protocol.
Server-side decoration are required by all non-embedded video window
plugins in VLC. Inventing VLC-specific decoration just for this purpose
would not make sense.
Any display server can implement the protocol. But in practice, this
probably does not work with display servers other than Kwin. (It
definitely does not work with Weston; I have not tried other servers.)
> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=86a971b18a22b8ed6ec56d5a38213105ed72a310
---
modules/video_output/Makefile.am | 10 ++-
modules/video_output/wayland/server-decoration.xml | 94 ++++++++++++++++++++++
modules/video_output/wayland/xdg-shell.c | 30 +++++++
3 files changed, 133 insertions(+), 1 deletion(-)
diff --git a/modules/video_output/Makefile.am b/modules/video_output/Makefile.am
index 3ae9387..dc0de50 100644
--- a/modules/video_output/Makefile.am
+++ b/modules/video_output/Makefile.am
@@ -147,7 +147,9 @@ libwl_shell_plugin_la_LIBADD = $(WAYLAND_CLIENT_LIBS) $(LIBPTHREAD)
libxdg_shell_plugin_la_SOURCES = video_output/wayland/xdg-shell.c
nodist_libxdg_shell_plugin_la_SOURCES = \
video_output/wayland/xdg-shell-client-protocol.h \
- video_output/wayland/xdg-shell-protocol.c
+ video_output/wayland/xdg-shell-protocol.c \
+ video_output/wayland/server-decoration-client-protocol.h \
+ video_output/wayland/server-decoration-protocol.c
libxdg_shell_plugin_la_CPPFLAGS = $(AM_CPPFLAGS) \
-I$(builddir)/video_output/wayland
libxdg_shell_plugin_la_CFLAGS = $(WAYLAND_CLIENT_CFLAGS)
@@ -161,6 +163,12 @@ video_output/wayland/xdg-shell-protocol.c: \
$(WAYLAND_PROTOCOLS)/unstable/xdg-shell/xdg-shell-unstable-v5.xml
$(AM_V_GEN)$(WAYLAND_SCANNER) code $< $@
+video_output/wayland/server-decoration-client-protocol.h: \
+ video_output/wayland/server-decoration.xml
+
+video_output/wayland/server-decoration-protocol.c: \
+ video_output/wayland/server-decoration.xml
+
libegl_wl_plugin_la_SOURCES = video_output/opengl/egl.c
libegl_wl_plugin_la_CPPFLAGS = $(AM_CPPFLAGS) -DUSE_PLATFORM_WAYLAND=1
libegl_wl_plugin_la_CFLAGS = $(AM_CFLAGS) $(EGL_CFLAGS) $(WAYLAND_EGL_CFLAGS)
diff --git a/modules/video_output/wayland/server-decoration.xml b/modules/video_output/wayland/server-decoration.xml
new file mode 100644
index 0000000..8bc106c
--- /dev/null
+++ b/modules/video_output/wayland/server-decoration.xml
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<protocol name="server_decoration">
+ <copyright><![CDATA[
+ Copyright (C) 2015 Martin Gräßlin
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 2.1 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+ ]]></copyright>
+ <interface name="org_kde_kwin_server_decoration_manager" version="1">
+ <description summary="Server side window decoration manager">
+ This interface allows to coordinate whether the server should create
+ a server-side window decoration around a wl_surface representing a
+ shell surface (wl_shell_surface or similar). By announcing support
+ for this interface the server indicates that it supports server
+ side decorations.
+ </description>
+ <request name="create">
+ <description summary="Create a server-side decoration object for a given surface">
+ When a client creates a server-side decoration object it indicates
+ that it supports the protocol. The client is supposed to tell the
+ server whether it wants server-side decorations or will provide
+ client-side decorations.
+
+ If the client does not create a server-side decoration object for
+ a surface the server interprets this as lack of support for this
+ protocol and considers it as client-side decorated. Nevertheless a
+ client-side decorated surface should use this protocol to indicate
+ to the server that it does not want a server-side deco.
+ </description>
+ <arg name="id" type="new_id" interface="org_kde_kwin_server_decoration"/>
+ <arg name="surface" type="object" interface="wl_surface"/>
+ </request>
+ <enum name="mode">
+ <description summary="Possible values to use in request_mode and the event mode."/>
+ <entry name="None" value="0" summary="Undecorated: The surface is not decorated at all, neither server nor client-side. An example is a popup surface which should not be decorated."/>
+ <entry name="Client" value="1" summary="Client-side decoration: The decoration is part of the surface and the client."/>
+ <entry name="Server" value="2" summary="Server-side decoration: The server embeds the surface into a decoration frame."/>
+ </enum>
+ <event name="default_mode">
+ <description summary="The default mode used on the server">
+ This event is emitted directly after binding the interface. It contains
+ the default mode for the decoration. When a new server decoration object
+ is created this new object will be in the default mode until the first
+ request_mode is requested.
+
+ The server may change the default mode at any time.
+ </description>
+ <arg name="mode" type="uint" summary="The default decoration mode applied to newly created server decorations."/>
+ </event>
+ </interface>
+ <interface name="org_kde_kwin_server_decoration" version="1">
+ <request name="release" type="destructor">
+ <description summary="release the server decoration object"/>
+ </request>
+ <enum name="mode">
+ <description summary="Possible values to use in request_mode and the event mode."/>
+ <entry name="None" value="0" summary="Undecorated: The surface is not decorated at all, neither server nor client-side. An example is a popup surface which should not be decorated."/>
+ <entry name="Client" value="1" summary="Client-side decoration: The decoration is part of the surface and the client."/>
+ <entry name="Server" value="2" summary="Server-side decoration: The server embeds the surface into a decoration frame."/>
+ </enum>
+ <request name="request_mode">
+ <description summary="The decoration mode the surface wants to use."/>
+ <arg name="mode" type="uint" summary="The mode this surface wants to use."/>
+ </request>
+ <event name="mode">
+ <description summary="The new decoration mode applied by the server">
+ This event is emitted directly after the decoration is created and
+ represents the base decoration policy by the server. E.g. a server
+ which wants all surfaces to be client-side decorated will send Client,
+ a server which wants server-side decoration will send Server.
+
+ The client can request a different mode through the decoration request.
+ The server will acknowledge this by another event with the same mode. So
+ even if a server prefers server-side decoration it's possible to force a
+ client-side decoration.
+
+ The server may emit this event at any time. In this case the client can
+ again request a different mode. It's the responsibility of the server to
+ prevent a feedback loop.
+ </description>
+ <arg name="mode" type="uint" summary="The decoration mode applied to the surface by the server."/>
+ </event>
+ </interface>
+</protocol>
diff --git a/modules/video_output/wayland/xdg-shell.c b/modules/video_output/wayland/xdg-shell.c
index 4c42154..eb669f6 100644
--- a/modules/video_output/wayland/xdg-shell.c
+++ b/modules/video_output/wayland/xdg-shell.c
@@ -32,6 +32,7 @@
#include <wayland-client.h>
#include "xdg-shell-client-protocol.h"
+#include "server-decoration-client-protocol.h"
#include <vlc_common.h>
#include <vlc_plugin.h>
@@ -44,6 +45,8 @@ struct vout_window_sys_t
struct wl_compositor *compositor;
struct xdg_shell *shell;
struct xdg_surface *surface;
+ struct org_kde_kwin_server_decoration_manager *deco_manager;
+ struct org_kde_kwin_server_decoration *deco;
vlc_thread_t thread;
};
@@ -201,6 +204,10 @@ static void registry_global_cb(void *data, struct wl_registry *registry,
else
if (!strcmp(iface, "xdg_shell"))
sys->shell = wl_registry_bind(registry, name, &xdg_shell_interface, 1);
+ else
+ if (!strcmp(iface, "org_kde_kwin_server_decoration_manager"))
+ sys->deco_manager = wl_registry_bind(registry, name,
+ &org_kde_kwin_server_decoration_manager_interface, 1);
}
static void registry_global_remove_cb(void *data, struct wl_registry *registry,
@@ -234,6 +241,8 @@ static int Open(vout_window_t *wnd, const vout_window_cfg_t *cfg)
sys->compositor = NULL;
sys->shell = NULL;
sys->surface = NULL;
+ sys->deco_manager = NULL;
+ sys->deco = NULL;
wnd->sys = sys;
/* Connect to the display server */
@@ -293,6 +302,19 @@ static int Open(vout_window_t *wnd, const vout_window_cfg_t *cfg)
cfg->width, cfg->height);
vout_window_ReportSize(wnd, cfg->width, cfg->height);
+ const uint_fast32_t deco_mode =
+ var_InheritBool(wnd, "video-deco")
+ ? ORG_KDE_KWIN_SERVER_DECORATION_MODE_SERVER
+ : ORG_KDE_KWIN_SERVER_DECORATION_MODE_CLIENT;
+
+ if (sys->deco_manager != NULL)
+ sys->deco = org_kde_kwin_server_decoration_manager_create(
+ sys->deco_manager, surface);
+ if (sys->deco != NULL)
+ org_kde_kwin_server_decoration_request_mode(sys->deco, deco_mode);
+ else if (deco_mode == ORG_KDE_KWIN_SERVER_DECORATION_MODE_SERVER)
+ msg_Err(wnd, "server-side decoration not supported");
+
//if (var_InheritBool (wnd, "keyboard-events"))
// do_something();
@@ -311,6 +333,10 @@ static int Open(vout_window_t *wnd, const vout_window_cfg_t *cfg)
return VLC_SUCCESS;
error:
+ if (sys->deco != NULL)
+ org_kde_kwin_server_decoration_destroy(sys->deco);
+ if (sys->deco_manager != NULL)
+ org_kde_kwin_server_decoration_manager_destroy(sys->deco_manager);
if (sys->surface != NULL)
xdg_surface_destroy(sys->surface);
if (sys->shell != NULL)
@@ -332,6 +358,10 @@ static void Close(vout_window_t *wnd)
vlc_cancel(sys->thread);
vlc_join(sys->thread, NULL);
+ if (sys->deco != NULL)
+ org_kde_kwin_server_decoration_destroy(sys->deco);
+ if (sys->deco_manager != NULL)
+ org_kde_kwin_server_decoration_manager_destroy(sys->deco_manager);
xdg_surface_destroy(sys->surface);
wl_surface_destroy(wnd->handle.wl);
xdg_shell_destroy(sys->shell);
More information about the vlc-commits
mailing list