Merge branch 'wlr_mirror_v1' into 'master'

wlr_mirror: adds mirroring of variable source on a single destination output

See merge request wlroots/wlroots!3421

include/wlr/types/wlr_mirror.h

@@ -0,0 +1,111 @@
+/*
+ * This an unstable interface of wlroots. No guarantees are made regarding the
+ * future consistency of this API.
+ */
+#ifndef WLR_USE_UNSTABLE
+#error "Add -DWLR_USE_UNSTABLE to enable unstable wlroots features"
+#endif
+
+#ifndef WLR_TYPES_WLR_MIRROR_H
+#define WLR_TYPES_WLR_MIRROR_H
+
+#include <wayland-client-protocol.h>
+#include <wayland-server-core.h>
+#include <wlr/util/addon.h>
+#include <wlr/util/box.h>
+
+/**
+ * Allows mirroring: rendering some contents of one output (the src) on another
+ * output (the dst). dst is fixed for the duration of the session, src may vary.
+ *
+ * Content will be scaled to fit the width or height of dst.
+ *
+ * On output_srcs precommit, wlr_mirror::ready is emitted. The compositor may
+ * call wlr_mirror_request_ to request to render a frame on dst.
+ *
+ * Compositor must not render on dst for the duration of the session.
+ *
+ * Multiple sessions may run concurrently and one session may mirror another.
+ *
+ * Session will end:
+ *   disable/destroy of dst or all srcs
+ *   wlr_mirror_request_box called with box outside of src
+ *   wlr_mirror_destroy
+ */
+
+/**
+ * Immutable over session.
+ */
+struct wlr_mirror_params {
+	/**
+	 * Render the src cursor on dst.
+	 */
+	bool overlay_cursor;
+
+	/**
+	 * srcs to send wlr_mirror::events::ready
+	 */
+	struct wl_array output_srcs;
+
+	/**
+	 * dst, will have mirror_dst set for the duration of the session.
+	 */
+	struct wlr_output *output_dst;
+};
+
+struct wlr_mirror_state;
+struct wlr_mirror {
+	struct {
+		/**
+		 * Ready to render a frame. Handler should call wlr_mirror_request_
+		 * Emitted at precommit, passes potential src.
+		 */
+		struct wl_signal ready;
+
+		/**
+		 * Mirror session is over.
+		 */
+		struct wl_signal destroy;
+	} events;
+
+	// private state
+	struct wlr_mirror_state *state;
+};
+
+/**
+ * Create a mirror session.
+ *
+ * Compositor must stop rendering on dst immediately after this.
+ */
+struct wlr_mirror *wlr_mirror_create(struct wlr_mirror_params *params);
+
+/**
+ * Destroy a mirror session.
+ *
+ * Compositor may resume rendering on dst.
+ */
+void wlr_mirror_destroy(struct wlr_mirror *mirror);
+
+/**
+ * Request a blank frame on dst.
+ *
+ * Should be invoked during the wlr_mirror::events::ready handler.
+ */
+void wlr_mirror_request_blank(struct wlr_mirror *mirror);
+
+/**
+ * Request a frame to render a box within src on dst. box is in output local
+ * coordinates, with respect to its transformation.
+ *
+ * Should be invoked during the wlr_mirror::events::ready handler.
+ */
+void wlr_mirror_request_box(struct wlr_mirror *mirror,
+		struct wlr_output *output_src, struct wlr_box box);
+
+/**
+ * Output is in use as a dst by another mirror session.
+ */
+bool wlr_mirror_v1_output_is_dst(struct wlr_output *output);
+
+#endif
+

include/wlr/util/addon.h

@@ -41,4 +41,7 @@ void wlr_addon_finish(struct wlr_addon *addon);
 struct wlr_addon *wlr_addon_find(struct wlr_addon_set *set, const void *owner,
 	const struct wlr_addon_interface *impl);
 
+void wlr_addon_find_all(struct wl_array *all, struct wlr_addon_set *set,
+		const struct wlr_addon_interface *impl);
+
 #endif