wayland: implement session management#17732
Open
mahkoh wants to merge 1 commit intompv-player:masterfrom
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Implements Wayland session management support (xdg-session-management-v1) so mpv’s Wayland window can participate in compositor-managed sessions, with a new --wayland-session option to select a human-readable session name persisted under the user state directory.
Changes:
- Add xdg-session-management-v1 integration to the Wayland VO (create/restore session + persist session id to disk).
- Introduce
--wayland-sessionVO option and plumb it into option structs/defaults. - Extend Meson Wayland-protocol generation to include wayland-protocols 1.48 and document the new option/change.
Reviewed changes
Copilot reviewed 4 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| video/out/wayland_common.h | Store xdg session objects in Wayland VO state (guarded by HAVE_WAYLAND_PROTOCOLS_1_48). |
| video/out/wayland_common.c | Bind xdg-session-manager, create/restore sessions, and persist session ids under the state dir. |
| video/out/meson.build | Add wayland-protocols 1.48 feature detection and generate xdg-session-management protocol code. |
| options/options.h | Add wayland_session field to VO options struct. |
| options/options.c | Register --wayland-session and set default to empty string. |
| DOCS/man/options.rst | Document new --wayland-session option. |
| DOCS/interface-changes/wayland-session.txt | Record interface change for the new option/behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
DOCS/man/options.rst
Outdated
| This only has an effect if ``--video-sync=display-...`` is being used. | ||
|
|
||
| ``--wayland-session=<string>`` | ||
| Set the wayland session name for window restoration (default: ``). |
There was a problem hiding this comment.
The default value in the option documentation is missing closing quotes/backticks (it currently renders as default: ``)). This should document the empty-string default correctly (e.g. default: "").
Suggested change
| Set the wayland session name for window restoration (default: ``). | |
| Set the wayland session name for window restoration (default: ``""``). |
Contributor
Author
daf7f16 to
0552713
Compare
If the compositor supports session management, the mpv window is always added to a session. The user can manage multiple sessions my using `--wayland-session=<human-readable-name>`. Human-readable names are mapped to session ids via files under `~/.local/state/mpv/sessions`. The file name is computed as a hash of XDG_CURRENT_DESKTOP and the human-readable name. If multiple mpv instances are started with the same session name, the latter mpv instance takes over the session. Upon session restoration, the mpv window is restored by the compositor according to its state from the previous session. What that entails is compositor policy.
0552713 to
8b1d0c6
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

If the compositor supports session management, the mpv window is always added to a session. The user can manage multiple sessions my using
--wayland-session=<human-readable-name>. Human-readable names are mapped to session ids via files under~/.local/state/mpv/sessions. The file name is computed as a hash of XDG_CURRENT_DESKTOP and the human-readable name.If multiple mpv instances are started with the same session name, the latter mpv instance takes over the session.
Upon session restoration, the mpv window is restored by the compositor according to its state from the previous session. What that entails is compositor policy.