From 2a0f171340964804f1e18663ca0248876b0c0e1f Mon Sep 17 00:00:00 2001 From: Alex Bryan Date: Sat, 27 Feb 2021 23:15:02 -0500 Subject: [PATCH 1/2] Added initial wlr-output-management-unstable-v1 support Was able to use wlr-randr to arrange my monitors correctly. TODO: test w/ kanshi and handle output_manager->events.test event --- include/labwc.h | 8 + .../wlr-output-management-unstable-v1.xml | 554 ++++++++++++++++++ src/output.c | 114 ++++ 3 files changed, 676 insertions(+) create mode 100644 protocols/wlr-output-management-unstable-v1.xml diff --git a/include/labwc.h b/include/labwc.h index 09021b7e..cba5bd70 100644 --- a/include/labwc.h +++ b/include/labwc.h @@ -20,6 +20,7 @@ #include #include #include +#include #include #include #include @@ -114,6 +115,11 @@ struct server { struct wl_listener new_output; struct wlr_output_layout *output_layout; + struct wl_listener output_layout_change; + struct wlr_output_manager_v1 *output_manager; + struct wl_listener output_manager_apply; + struct wlr_output_configuration_v1 *pending_output_config; + /* Set when in cycle (alt-tab) mode */ struct view *cycle_view; @@ -304,6 +310,8 @@ void output_init(struct server *server); void output_damage_surface(struct output *output, struct wlr_surface *surface, double lx, double ly, bool whole); +void output_manager_init(struct server *server); + void damage_all_outputs(struct server *server); void damage_view_whole(struct view *view); void damage_view_part(struct view *view); diff --git a/protocols/wlr-output-management-unstable-v1.xml b/protocols/wlr-output-management-unstable-v1.xml new file mode 100644 index 00000000..cadc45fb --- /dev/null +++ b/protocols/wlr-output-management-unstable-v1.xml @@ -0,0 +1,554 @@ + + + + Copyright © 2019 Purism SPC + + Permission to use, copy, modify, distribute, and sell this + software and its documentation for any purpose is hereby granted + without fee, provided that the above copyright notice appear in + all copies and that both that copyright notice and this permission + notice appear in supporting documentation, and that the name of + the copyright holders not be used in advertising or publicity + pertaining to distribution of the software without specific, + written prior permission. The copyright holders make no + representations about the suitability of this software for any + purpose. It is provided "as is" without express or implied + warranty. + + THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS + SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND + FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY + SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN + AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, + ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF + THIS SOFTWARE. + + + + This protocol exposes interfaces to obtain and modify output device + configuration. + + 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. + + + + + This interface is a manager that allows reading and writing the current + output device configuration. + + Output devices that display pixels (e.g. a physical monitor or a virtual + output in a window) are represented as heads. Heads cannot be created nor + destroyed by the client, but they can be enabled or disabled and their + properties can be changed. Each head may have one or more available modes. + + Whenever a head appears (e.g. a monitor is plugged in), it will be + advertised via the head event. Immediately after the output manager is + bound, all current heads are advertised. + + Whenever a head's properties change, the relevant wlr_output_head events + will be sent. Not all head properties will be sent: only properties that + have changed need to. + + Whenever a head disappears (e.g. a monitor is unplugged), a + wlr_output_head.finished event will be sent. + + After one or more heads appear, change or disappear, the done event will + be sent. It carries a serial which can be used in a create_configuration + request to update heads properties. + + The information obtained from this protocol should only be used for output + configuration purposes. This protocol is not designed to be a generic + output property advertisement protocol for regular clients. Instead, + protocols such as xdg-output should be used. + + + + + This event introduces a new head. This happens whenever a new head + appears (e.g. a monitor is plugged in) or after the output manager is + bound. + + + + + + + This event is sent after all information has been sent after binding to + the output manager object and after any subsequent changes. This applies + to child head and mode objects as well. In other words, this event is + sent whenever a head or mode is created or destroyed and whenever one of + their properties has been changed. Not all state is re-sent each time + the current configuration changes: only the actual changes are sent. + + This allows changes to the output configuration to be seen as atomic, + even if they happen via multiple events. + + A serial is sent to be used in a future create_configuration request. + + + + + + + Create a new output configuration object. This allows to update head + properties. + + + + + + + + Indicates the client no longer wishes to receive events for output + configuration changes. However the compositor may emit further events, + until the finished event is emitted. + + The client must not send any more requests after this one. + + + + + + This event indicates that the compositor is done sending manager events. + The compositor will destroy the object immediately after sending this + event, so it will become invalid and the client should release any + resources associated with it. + + + + + + + A head is an output device. The difference between a wl_output object and + a head is that heads are advertised even if they are turned off. A head + object only advertises properties and cannot be used directly to change + them. + + A head has some read-only properties: modes, name, description and + physical_size. These cannot be changed by clients. + + Other properties can be updated via a wlr_output_configuration object. + + Properties sent via this interface are applied atomically via the + wlr_output_manager.done event. No guarantees are made regarding the order + in which properties are sent. + + + + + This event describes the head name. + + The naming convention is compositor defined, but limited to alphanumeric + characters and dashes (-). Each name is unique among all wlr_output_head + objects, but if a wlr_output_head object 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. + + If the compositor implements the xdg-output protocol and this head is + enabled, the xdg_output.name event must report the same name. + + The name event is sent after a wlr_output_head object is created. This + event is only sent once per object, and the name does not change over + the lifetime of the wlr_output_head object. + + + + + + + This event describes a human-readable description of the head. + + 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'. However, do not assume that the name is a reflection of + the make, model, serial of the underlying DRM connector or the display + name of the underlying X11 connection, etc. + + If the compositor implements xdg-output and this head is enabled, + the xdg_output.description must report the same description. + + The description event is sent after a wlr_output_head object is created. + This event is only sent once per object, and the description does not + change over the lifetime of the wlr_output_head object. + + + + + + + This event describes the physical size of the head. This event is only + sent if the head has a physical size (e.g. is not a projector or a + virtual device). + + + + + + + + This event introduces a mode for this head. It is sent once per + supported mode. + + + + + + + This event describes whether the head is enabled. A disabled head is not + mapped to a region of the global compositor space. + + When a head is disabled, some properties (current_mode, position, + transform and scale) are irrelevant. + + + + + + + This event describes the mode currently in use for this head. It is only + sent if the output is enabled. + + + + + + + This events describes the position of the head in the global compositor + space. It is only sent if the output is enabled. + + + + + + + + This event describes the transformation currently applied to the head. + It is only sent if the output is enabled. + + + + + + + This events describes the scale of the head in the global compositor + space. It is only sent if the output is enabled. + + + + + + + The compositor will destroy the object immediately after sending this + event, so it will become invalid and the client should release any + resources associated with it. + + + + + + + This event describes the manufacturer of the head. + + This must report the same make as the wl_output interface does in its + geometry event. + + Together with the model and serial_number events the purpose is to + allow clients to recognize heads from previous sessions and for example + load head-specific configurations back. + + It is not guaranteed this event will be ever sent. A reason for that + can be that the compositor does not have information about the make of + the head or the definition of a make is not sensible in the current + setup, for example in a virtual session. Clients can still try to + identify the head by available information from other events but should + be aware that there is an increased risk of false positives. + + It is not recommended to display the make string in UI to users. For + that the string provided by the description event should be preferred. + + + + + + + This event describes the model of the head. + + This must report the same model as the wl_output interface does in its + geometry event. + + Together with the make and serial_number events the purpose is to + allow clients to recognize heads from previous sessions and for example + load head-specific configurations back. + + It is not guaranteed this event will be ever sent. A reason for that + can be that the compositor does not have information about the model of + the head or the definition of a model is not sensible in the current + setup, for example in a virtual session. Clients can still try to + identify the head by available information from other events but should + be aware that there is an increased risk of false positives. + + It is not recommended to display the model string in UI to users. For + that the string provided by the description event should be preferred. + + + + + + + This event describes the serial number of the head. + + Together with the make and model events the purpose is to allow clients + to recognize heads from previous sessions and for example load head- + specific configurations back. + + It is not guaranteed this event will be ever sent. A reason for that + can be that the compositor does not have information about the serial + number of the head or the definition of a serial number is not sensible + in the current setup. Clients can still try to identify the head by + available information from other events but should be aware that there + is an increased risk of false positives. + + It is not recommended to display the serial_number string in UI to + users. For that the string provided by the description event should be + preferred. + + + + + + + + This object describes an output mode. + + Some heads don't support output modes, in which case modes won't be + advertised. + + Properties sent via this interface are applied atomically via the + wlr_output_manager.done event. No guarantees are made regarding the order + in which properties are sent. + + + + + This event describes the mode size. The size is given in physical + hardware units of the output device. This is not necessarily the same as + the output size in the global compositor space. For instance, the output + may be scaled or transformed. + + + + + + + + This event describes the mode's fixed vertical refresh rate. It is only + sent if the mode has a fixed refresh rate. + + + + + + + This event advertises this mode as preferred. + + + + + + The compositor will destroy the object immediately after sending this + event, so it will become invalid and the client should release any + resources associated with it. + + + + + + + This object is used by the client to describe a full output configuration. + + First, the client needs to setup the output configuration. Each head can + be either enabled (and configured) or disabled. It is a protocol error to + send two enable_head or disable_head requests with the same head. It is a + protocol error to omit a head in a configuration. + + Then, the client can apply or test the configuration. The compositor will + then reply with a succeeded, failed or cancelled event. Finally the client + should destroy the configuration object. + + + + + + + + + + + Enable a head. This request creates a head configuration object that can + be used to change the head's properties. + + + + + + + + Disable a head. + + + + + + + Apply the new output configuration. + + In case the configuration is successfully applied, there is no guarantee + that the new output state matches completely the requested + configuration. For instance, a compositor might round the scale if it + doesn't support fractional scaling. + + After this request has been sent, the compositor must respond with an + succeeded, failed or cancelled event. Sending a request that isn't the + destructor is a protocol error. + + + + + + Test the new output configuration. The configuration won't be applied, + but will only be validated. + + Even if the compositor succeeds to test a configuration, applying it may + fail. + + After this request has been sent, the compositor must respond with an + succeeded, failed or cancelled event. Sending a request that isn't the + destructor is a protocol error. + + + + + + Sent after the compositor has successfully applied the changes or + tested them. + + Upon receiving this event, the client should destroy this object. + + If the current configuration has changed, events to describe the changes + will be sent followed by a wlr_output_manager.done event. + + + + + + Sent if the compositor rejects the changes or failed to apply them. The + compositor should revert any changes made by the apply request that + triggered this event. + + Upon receiving this event, the client should destroy this object. + + + + + + Sent if the compositor cancels the configuration because the state of an + output changed and the client has outdated information (e.g. after an + output has been hotplugged). + + The client can create a new configuration with a newer serial and try + again. + + Upon receiving this event, the client should destroy this object. + + + + + + Using this request a client can tell the compositor that it is not going + to use the configuration object anymore. Any changes to the outputs + that have not been applied will be discarded. + + This request also destroys wlr_output_configuration_head objects created + via this object. + + + + + + + This object is used by the client to update a single head's configuration. + + It is a protocol error to set the same property twice. + + + + + + + + + + + + + This request sets the head's mode. + + + + + + + This request assigns a custom mode to the head. The size is given in + physical hardware units of the output device. If set to zero, the + refresh rate is unspecified. + + It is a protocol error to set both a mode and a custom mode. + + + + + + + + + This request sets the head's position in the global compositor space. + + + + + + + + This request sets the head's transform. + + + + + + + This request sets the head's scale. + + + + + diff --git a/src/output.c b/src/output.c index fbf3d7be..1fcb8831 100644 --- a/src/output.c +++ b/src/output.c @@ -838,4 +838,118 @@ output_init(struct server *server) server->output_layout); wl_list_init(&server->outputs); + + output_manager_init(server); +} + +static void output_config_apply(struct server *server, + struct wlr_output_configuration_v1 *config) +{ + server->pending_output_config = config; + + struct wlr_output_configuration_head_v1 *head; + wl_list_for_each(head, &config->heads, link) { + struct wlr_output *o = head->state.output; + bool need_to_add = head->state.enabled && !o->enabled; + if(need_to_add) { + wlr_output_layout_add_auto(server->output_layout, o); + } + + bool need_to_remove = !head->state.enabled && o->enabled; + if(need_to_remove) { + wlr_output_layout_remove(server->output_layout, o); + } + + wlr_output_enable(o, head->state.enabled); + if(head->state.enabled){ + if(head->state.mode){ + wlr_output_set_mode(o, head->state.mode); + } else { + int32_t width = head->state.custom_mode.width; + int32_t height = head->state.custom_mode.height; + int32_t refresh = head->state.custom_mode.refresh; + wlr_output_set_custom_mode(o, width, height, refresh); + } + wlr_output_layout_move(server->output_layout, o, head->state.x, + head->state.y); + wlr_output_set_scale(o, head->state.scale); + wlr_output_set_transform(o, head->state.transform); + } + wlr_output_commit(o); + } + + server->pending_output_config = NULL; +} +static void handle_output_manager_apply(struct wl_listener *listener, void* data) +{ + struct server *server = wl_container_of(listener, server, output_manager_apply); + struct wlr_output_configuration_v1 *config = data; + output_config_apply(server, config); + wlr_output_configuration_v1_send_succeeded(config); + wlr_output_configuration_v1_destroy(config); +} + +/* + * Take the way outputs are currently configured/layed out and turn that into + * a struct that we send to clients via the wlr_output_configuration v1 + * interface + */ +static struct wlr_output_configuration_v1 *create_output_config(struct server *server) +{ + struct wlr_output_configuration_v1 *config = wlr_output_configuration_v1_create(); + if(config == NULL) { + warn("wlr_output_configuration_v1_create() returned NULL"); + return NULL; + } + + struct output *output; + wl_list_for_each(output, &server->outputs, link) { + struct wlr_output_configuration_head_v1 *head + = wlr_output_configuration_head_v1_create(config, + output->wlr_output); + if(head == NULL) { + warn("wlr_output_configuration_head_v1_create() returned NULL"); + wlr_output_configuration_v1_destroy(config); + return NULL; + } + + struct wlr_box *box = wlr_output_layout_get_box(server->output_layout, + output->wlr_output); + if(box != NULL) { + head->state.x = box->x; + head->state.y = box->y; + } else { + warn("%s: failed to get box for output", __func__); + } + } + + return config; +} + +static void handle_output_layout_change(struct wl_listener *listener, void *data) { + struct server *server = wl_container_of(listener, server, output_layout_change); + + bool done_changing = server->pending_output_config == NULL; + if(done_changing) { + struct wlr_output_configuration_v1 *config = create_output_config(server); + if(config != NULL) { + wlr_output_manager_v1_set_configuration(server->output_manager, config); + } else { + warn("wlr_output_manager_v1_set_configuration returned NULL"); + } + } +} + +void output_manager_init(struct server *server) +{ + info("calling %s", __func__); + server->output_manager = wlr_output_manager_v1_create(server->wl_display); + + server->output_layout_change.notify = handle_output_layout_change; + wl_signal_add(&server->output_layout->events.change, + &server->output_layout_change); + + server->output_manager_apply.notify = handle_output_manager_apply; + wl_signal_add(&server->output_manager->events.apply, + &server->output_manager_apply); } From 50137e0bbe4d130dd5d0c7125c50c0ab505ab5d3 Mon Sep 17 00:00:00 2001 From: Alex Bryan Date: Sun, 28 Feb 2021 00:08:47 -0500 Subject: [PATCH 2/2] Add placeholder output-config verification Added a placeholder function to verify an output configuration that we've received from a client via output-management-v1. Currently we just assume the config is valid and teturn true, but we should really look at the config before applying it --- src/output.c | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/src/output.c b/src/output.c index 1fcb8831..0f782923 100644 --- a/src/output.c +++ b/src/output.c @@ -880,12 +880,26 @@ static void output_config_apply(struct server *server, server->pending_output_config = NULL; } + +static bool verify_output_config_v1(const struct wlr_output_configuration_v1 *config) +{ + //TODO implement + return true; +} + static void handle_output_manager_apply(struct wl_listener *listener, void* data) { struct server *server = wl_container_of(listener, server, output_manager_apply); struct wlr_output_configuration_v1 *config = data; - output_config_apply(server, config); - wlr_output_configuration_v1_send_succeeded(config); + + bool config_is_good = verify_output_config_v1(config); + + if(config_is_good) { + output_config_apply(server, config); + wlr_output_configuration_v1_send_succeeded(config); + } else { + wlr_output_configuration_v1_send_failed(config); + } wlr_output_configuration_v1_destroy(config); }