146 capture and log xdg logical box (#157)

* 138 add xdg-output-unstable-v1 and listen to output events * 138 handle zxdg-output lifecycle * 138 iwyu tweaking * 138 output logical size / position * 138 validate logical size / position * 147 bind and name the output managers * 147 validate logical size after success * 147 disambiguate names * 147 disambiguate names * 147 tidy * 147 remove debug logs and scale validation
alex-courtis · Feb 13, 2024 · 884090a · 884090a
1 parent 6939b6d
commit 884090a
Show file tree

Hide file tree

Showing 16 changed files with 535 additions and 62 deletions.
diff --git a/bld/vg.supp b/bld/vg.supp
@@ -24,6 +24,24 @@
    fun:main
 }
 
+{
+   g_object_new_valist - from evdev
+   Memcheck:Leak
+   match-leak-kinds: reachable
+   ...
+   fun:g_object_new_valist
+   fun:g_object_new
+   ...
+}
+{
+   evdev_device_create
+   Memcheck:Leak
+   match-leak-kinds: reachable
+   ...
+   fun:evdev_device_create
+   fun:device_added
+}
+
 {
    glib-g_malloc
    Memcheck:Leak

diff --git a/inc/displ.h b/inc/displ.h
@@ -2,7 +2,11 @@
 #define DISPL_H
 
 #include <stdint.h>
-#include <stdbool.h>
+
+// IWYU pragma: begin_keep
+#include "wlr-output-management-unstable-v1.h"
+#include "xdg-output-unstable-v1.h"
+// IWYU pragma: end_keep
 
 enum ConfigState {
 	IDLE = 0,
@@ -14,17 +18,21 @@ enum ConfigState {
 
 struct Displ {
 	// global
-	struct wl_display *display;
 	struct wl_registry *registry;
-	uint32_t name;
-
-	// output manager
-	struct zwlr_output_manager_v1 *output_manager;
-	uint32_t serial;
-	char *interface;
-	uint32_t output_manager_version;
+	struct wl_display *display;
 
-	bool have_fractional_scale_v1;
+	// wlroots output manager
+	struct zwlr_output_manager_v1 *zwlr_output_manager;
+	uint32_t zwlr_output_manager_name;
+	uint32_t zwlr_output_manager_version;
+	char *zwlr_output_manager_interface;
+	uint32_t zwlr_output_manager_serial;
+
+	// wayland output manager
+	struct zxdg_output_manager_v1 *zxdg_output_manager;
+	uint32_t zxdg_output_manager_name;
+	uint32_t zxdg_output_manager_version;
+	char *zxdg_output_manager_interface;
 
 	enum ConfigState config_state;
 };

diff --git a/inc/listeners.h b/inc/listeners.h
@@ -4,15 +4,16 @@
 #define ZWLR_OUTPUT_MANAGER_V1_VERSION 4
 #define ZWLR_OUTPUT_MANAGER_V1_VERSION_MIN 2
 
-// data
 const struct wl_registry_listener *registry_listener(void);
-const struct zwlr_output_manager_v1_listener *output_manager_listener(void);
-const struct zwlr_output_head_v1_listener *head_listener(void);
-const struct zwlr_output_head_v1_listener *head_listener_min(void);
-const struct zwlr_output_mode_v1_listener *mode_listener(void);
 
-// config
-const struct zwlr_output_configuration_v1_listener *output_configuration_listener(void);
+const struct zwlr_output_manager_v1_listener *zwlr_output_manager_listener(void);
+const struct zwlr_output_head_v1_listener *zwlr_output_head_listener(void);
+const struct zwlr_output_head_v1_listener *zwlr_output_head_listener_min(void);
+const struct zwlr_output_mode_v1_listener *zwlr_output_mode_listener(void);
+
+const struct zwlr_output_configuration_v1_listener *zwlr_output_configuration_listener(void);
+
+const struct zxdg_output_v1_listener *zxdg_output_listener(void);
 
 #endif // LISTENERS_H
 
diff --git a/inc/output.h b/inc/output.h
@@ -0,0 +1,38 @@
+#ifndef OUTPUT_H
+#define OUTPUT_H
+
+#include <stdint.h>
+#include <wayland-client-protocol.h>
+
+#include "xdg-output-unstable-v1.h"
+
+struct Output {
+	struct wl_output *wl_output;
+	uint32_t wl_output_name;
+
+	struct zxdg_output_v1 *zxdg_output;
+
+	// wlr-output-management-unstable-v1.xml states that the names and descriptions must match hence we can map them
+	char *name;
+	char *description;
+
+	int32_t logical_x;
+	int32_t logical_y;
+	int32_t logical_width;
+	int32_t logical_height;
+};
+
+// instantiate a new output and create an xdg output listener, appending to outputs
+// NULL on failure to retrieve xdg output
+struct Output *output_init(struct wl_output *wl_output, const uint32_t wl_output_name, struct zxdg_output_manager_v1 *zxdg_output_manager);
+
+// output matching (head) name
+const struct Output *output_for_name(const char *name);
+
+// destroy all outputs, clearing outputs
+void output_destroy_all(void);
+
+// destroy an output matching name, removing from outputs
+void output_destroy_by_wl_output_name(const uint32_t wl_output_name);
+
+#endif // OUTPUT_H
diff --git a/pro/xdg-output-unstable-v1.xml b/pro/xdg-output-unstable-v1.xml
@@ -0,0 +1,222 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<protocol name="xdg_output_unstable_v1">
+
+  <copyright>
+    Copyright © 2017 Red Hat Inc.
+
+    Permission is hereby granted, free of charge, to any person obtaining a
+    copy of this software and associated documentation files (the "Software"),
+    to deal in the Software without restriction, including without limitation
+    the rights to use, copy, modify, merge, publish, distribute, sublicense,
+    and/or sell copies of the Software, and to permit persons to whom the
+    Software is furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice (including the next
+    paragraph) shall be included in all copies or substantial portions of the
+    Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+    DEALINGS IN THE SOFTWARE.
+  </copyright>
+
+  <description summary="Protocol to describe output regions">
+    This protocol aims at describing outputs in a way which is more in line
+    with the concept of an output on desktop oriented systems.
+
+    Some information are more specific to the concept of an output for
+    a desktop oriented system and may not make sense in other applications,
+    such as IVI systems for example.
+
+    Typically, the global compositor space on a desktop system is made of
+    a contiguous or overlapping set of rectangular regions.
+
+    The logical_position and logical_size events defined in this protocol
+    might provide information identical to their counterparts already
+    available from wl_output, in which case the information provided by this
+    protocol should be preferred to their equivalent in wl_output. The goal is
+    to move the desktop specific concepts (such as output location within the
+    global compositor space, etc.) out of the core wl_output protocol.
+
+    Warning! The protocol described in this file is experimental and
+    backward incompatible changes may be made. Backward compatible
+    changes may be added together with the corresponding interface
+    version bump.
+    Backward incompatible changes are done by bumping the version
+    number in the protocol and interface names and resetting the
+    interface version. Once the protocol is to be declared stable,
+    the 'z' prefix and the version number in the protocol and
+    interface names are removed and the interface version number is
+    reset.
+  </description>
+
+  <interface name="zxdg_output_manager_v1" version="3">
+    <description summary="manage xdg_output objects">
+      A global factory interface for xdg_output objects.
+    </description>
+
+    <request name="destroy" type="destructor">
+      <description summary="destroy the xdg_output_manager object">
+	Using this request a client can tell the server that it is not
+	going to use the xdg_output_manager object anymore.
+
+	Any objects already created through this instance are not affected.
+      </description>
+    </request>
+
+    <request name="get_xdg_output">
+      <description summary="create an xdg output from a wl_output">
+	This creates a new xdg_output object for the given wl_output.
+      </description>
+      <arg name="id" type="new_id" interface="zxdg_output_v1"/>
+      <arg name="output" type="object" interface="wl_output"/>
+    </request>
+  </interface>
+
+  <interface name="zxdg_output_v1" version="3">
+    <description summary="compositor logical output region">
+      An xdg_output describes part of the compositor geometry.
+
+      This typically corresponds to a monitor that displays part of the
+      compositor space.
+
+      For objects version 3 onwards, after all xdg_output properties have been
+      sent (when the object is created and when properties are updated), a
+      wl_output.done event is sent. This allows changes to the output
+      properties to be seen as atomic, even if they happen via multiple events.
+    </description>
+
+    <request name="destroy" type="destructor">
+      <description summary="destroy the xdg_output object">
+	Using this request a client can tell the server that it is not
+	going to use the xdg_output object anymore.
+      </description>
+    </request>
+
+    <event name="logical_position">
+      <description summary="position of the output within the global compositor space">
+	The position event describes the location of the wl_output within
+	the global compositor space.
+
+	The logical_position event is sent after creating an xdg_output
+	(see xdg_output_manager.get_xdg_output) and whenever the location
+	of the output changes within the global compositor space.
+      </description>
+      <arg name="x" type="int"
+	   summary="x position within the global compositor space"/>
+      <arg name="y" type="int"
+	   summary="y position within the global compositor space"/>
+    </event>
+
+    <event name="logical_size">
+      <description summary="size of the output in the global compositor space">
+	The logical_size event describes the size of the output in the
+	global compositor space.
+
+	Most regular Wayland clients should not pay attention to the
+	logical size and would rather rely on xdg_shell interfaces.
+
+	Some clients such as Xwayland, however, need this to configure
+	their surfaces in the global compositor space as the compositor
+	may apply a different scale from what is advertised by the output
+	scaling property (to achieve fractional scaling, for example).
+
+	For example, for a wl_output mode 3840×2160 and a scale factor 2:
+
+	- A compositor not scaling the monitor viewport in its compositing space
+	  will advertise a logical size of 3840×2160,
+
+	- A compositor scaling the monitor viewport with scale factor 2 will
+	  advertise a logical size of 1920×1080,
+
+	- A compositor scaling the monitor viewport using a fractional scale of
+	  1.5 will advertise a logical size of 2560×1440.
+
+	For example, for a wl_output mode 1920×1080 and a 90 degree rotation,
+	the compositor will advertise a logical size of 1080x1920.
+
+	The logical_size event is sent after creating an xdg_output
+	(see xdg_output_manager.get_xdg_output) and whenever the logical
+	size of the output changes, either as a result of a change in the
+	applied scale or because of a change in the corresponding output
+	mode(see wl_output.mode) or transform (see wl_output.transform).
+      </description>
+      <arg name="width" type="int"
+	   summary="width in global compositor space"/>
+      <arg name="height" type="int"
+	   summary="height in global compositor space"/>
+    </event>
+
+    <event name="done">
+      <description summary="all information about the output have been sent">
+	This event is sent after all other properties of an xdg_output
+	have been sent.
+
+	This allows changes to the xdg_output properties to be seen as
+	atomic, even if they happen via multiple events.
+
+	For objects version 3 onwards, this event is deprecated. Compositors
+	are not required to send it anymore and must send wl_output.done
+	instead.
+      </description>
+    </event>
+
+    <!-- Version 2 additions -->
+
+    <event name="name" since="2">
+      <description summary="name of this output">
+	Many compositors will assign names to their outputs, show them to the
+	user, allow them to be configured by name, etc. The client may wish to
+	know this name as well to offer the user similar behaviors.
+
+	The naming convention is compositor defined, but limited to
+	alphanumeric characters and dashes (-). Each name is unique among all
+	wl_output globals, but if a wl_output global is destroyed the same name
+	may be reused later. The names will also remain consistent across
+	sessions with the same hardware and software configuration.
+
+	Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc. However, do
+	not assume that the name is a reflection of an underlying DRM
+	connector, X11 connection, etc.
+
+	The name event is sent after creating an xdg_output (see
+	xdg_output_manager.get_xdg_output). This event is only sent once per
+	xdg_output, and the name does not change over the lifetime of the
+	wl_output global.
+
+        This event is deprecated, instead clients should use wl_output.name.
+        Compositors must still support this event.
+      </description>
+      <arg name="name" type="string" summary="output name"/>
+    </event>
+
+    <event name="description" since="2">
+      <description summary="human-readable description of this output">
+	Many compositors can produce human-readable descriptions of their
+	outputs.  The client may wish to know this description as well, to
+	communicate the user for various purposes.
+
+	The description is a UTF-8 string with no convention defined for its
+	contents. Examples might include 'Foocorp 11" Display' or 'Virtual X11
+	output via :1'.
+
+	The description event is sent after creating an xdg_output (see
+	xdg_output_manager.get_xdg_output) and whenever the description
+	changes. The description is optional, and may not be sent at all.
+
+	For objects of version 2 and lower, this event is only sent once per
+	xdg_output, and the description does not change over the lifetime of
+	the wl_output global.
+
+	This event is deprecated, instead clients should use
+	wl_output.description. Compositors must still support this event.
+      </description>
+      <arg name="description" type="string" summary="output description"/>
+    </event>
+
+  </interface>
+</protocol>