//! GNOME/Mutter virtual-display backend via Mutter's *direct* D-Bus APIs (the same path //! gnome-remote-desktop uses for headless sessions — not the xdg portal, which needs an //! interactive grant): //! //! 1. `org.gnome.Mutter.RemoteDesktop.CreateSession()` → a remote-desktop session (read its //! `SessionId`). The cast is anchored to it, and it's also the future input path. //! 2. `org.gnome.Mutter.ScreenCast.CreateSession({"remote-desktop-session-id": id})`. //! 3. `ScreenCast.Session.RecordVirtual({"cursor-mode": embedded})` → Mutter creates a **virtual //! monitor** and returns a Stream object. //! 4. `RemoteDesktop.Session.Start()` → the Stream signals `PipeWireStreamAdded(node_id)`. //! //! The virtual monitor's *size* follows the PipeWire format negotiation — Mutter adapts it to //! what the consumer asks for — so the client's exact WxH is plumbed into our consumer's format //! pod as the preferred size ([`VirtualOutput::preferred_mode`]) rather than passed here. //! Sessions die with the D-Bus connection, so a keepalive thread owns it (RAII teardown). //! //! Requires a running Mutter (`gnome-shell` session, or `gnome-shell --headless` for the //! headless host) on the session bus. GNOME is detected via `XDG_CURRENT_DESKTOP=GNOME` or //! forced with `PUNKTFUNK_COMPOSITOR=mutter`. use super::{Mode, VirtualDisplay, VirtualOutput}; use anyhow::{anyhow, bail, Context, Result}; use ashpd::zbus; use futures_util::StreamExt; use std::collections::{HashMap, HashSet}; use std::sync::atomic::{AtomicBool, Ordering}; use std::sync::mpsc::Sender; use std::sync::Arc; use std::thread; use std::time::{Duration, Instant}; use zbus::zvariant::{OwnedObjectPath, OwnedValue, Value}; const BUS_RD: &str = "org.gnome.Mutter.RemoteDesktop"; const BUS_SC: &str = "org.gnome.Mutter.ScreenCast"; const BUS_DC: &str = "org.gnome.Mutter.DisplayConfig"; /// `ApplyMonitorsConfig` method: 1 = temporary (auto-reverts on the next monitor change — /// e.g. when our virtual output is torn down — so we never persist a layout to monitors.xml). const APPLY_TEMPORARY: u32 = 1; /// Mutter cursor mode: render the cursor into the stream (matches the KWin/gamescope backends). const CURSOR_EMBEDDED: u32 = 1; /// The Mutter virtual-display driver. Each [`create`](VirtualDisplay::create) spins up a /// keepalive thread owning the D-Bus sessions behind the virtual monitor. pub struct MutterDisplay; impl MutterDisplay { pub fn new() -> Result { Ok(MutterDisplay) } } /// Mutter is usable when the host runs inside a GNOME session (its `RecordVirtual` D-Bus API /// drives the *live* compositor). Cheap signal: `XDG_CURRENT_DESKTOP` names GNOME — same basis /// as [`super::detect`], avoiding a blocking D-Bus round-trip on the enumeration path. pub fn is_available() -> bool { std::env::var("XDG_CURRENT_DESKTOP") .map(|d| d.to_ascii_uppercase().contains("GNOME")) .unwrap_or(false) } impl VirtualDisplay for MutterDisplay { fn name(&self) -> &'static str { "mutter" } fn create(&mut self, mode: Mode) -> Result { let (setup_tx, setup_rx) = std::sync::mpsc::channel::>(); let stop = Arc::new(AtomicBool::new(false)); let stop_thread = stop.clone(); thread::Builder::new() .name("punktfunk-mutter-vout".into()) .spawn(move || session_thread(setup_tx, stop_thread, mode)) .context("spawn Mutter virtual-output thread")?; let node_id = match setup_rx.recv_timeout(Duration::from_secs(20)) { Ok(Ok(v)) => v, Ok(Err(e)) => bail!("Mutter virtual monitor failed: {e}"), Err(_) => bail!("timed out creating the Mutter virtual monitor"), }; tracing::info!( node_id, w = mode.width, h = mode.height, "Mutter virtual monitor ready" ); Ok(VirtualOutput { node_id, remote_fd: None, preferred_mode: Some((mode.width, mode.height, mode.refresh_hz)), keepalive: Box::new(StopGuard(stop)), }) } } /// Dropping this ends the keepalive thread, closing the D-Bus connection — Mutter then tears /// the remote-desktop + screencast sessions (and the virtual monitor) down. struct StopGuard(Arc); impl Drop for StopGuard { fn drop(&mut self) { self.0.store(true, Ordering::Relaxed); } } /// Keepalive thread: run the D-Bus handshake on a private tokio runtime, report the PipeWire /// node id, then hold the connection until stopped. fn session_thread(setup_tx: Sender>, stop: Arc, mode: Mode) { let rt = match tokio::runtime::Builder::new_multi_thread() .worker_threads(1) .enable_all() .build() { Ok(rt) => rt, Err(e) => { let _ = setup_tx.send(Err(format!("build tokio runtime: {e}"))); return; } }; rt.block_on(async move { // Opt-in: snapshot the monitor layout BEFORE the virtual output exists, so we can tell the // new (virtual) connector apart and restore the layout on teardown. Best-effort. let dc_pre = if virtual_primary_enabled() { match display_config().await { Ok(dc) => match get_state(&dc).await { Ok(state) => Some((dc, state)), Err(e) => { tracing::warn!("mutter: GetCurrentState (pre) failed ({e:#}); leaving displays as-is"); None } }, Err(e) => { tracing::warn!("mutter: DisplayConfig unavailable ({e:#}); leaving displays as-is"); None } } } else { None }; let session = match connect(mode).await { Ok(s) => s, Err(e) => { let _ = setup_tx.send(Err(format!("{e:#}"))); return; } }; let _ = setup_tx.send(Ok(session.node_id)); // Make the freshly-created virtual output the PRIMARY monitor so the GNOME shell + new // windows land on the surface we stream. Without this, on a host that also has a physical // monitor attached, the virtual output is an empty extended desktop — you stream only the // wallpaper. Best-effort: any failure just logs and streaming continues unchanged. if let Some((dc, pre)) = &dc_pre { match make_virtual_primary(dc, mode, pre).await { Ok(()) => tracing::info!("mutter: virtual output set as the primary monitor"), Err(e) => tracing::warn!( "mutter: could not set the virtual output primary ({e:#}); streaming continues — the desktop may render on the physical monitor" ), } } // Park, keeping `session` (and its zbus connection) alive until told to stop. while !stop.load(Ordering::Relaxed) { tokio::time::sleep(Duration::from_millis(200)).await; } // Tear down: STOP the screencast so Mutter removes the virtual output. We deliberately do NOT // re-assert the physical layout with our own ApplyMonitorsConfig. Issuing a monitor reconfig // while the just-removed high-refresh virtual output is still tearing down SIGSEGVs gnome-shell // on Mutter 50 + NVIDIA — observed live on home-worker-3: the teardown ApplyMonitorsConfig // returned "recipient disconnected from message bus" because the shell crashed mid-call, after // which GDM's crash-loop guard dropped to the greeter and wedged EVERY subsequent reconnect. // make_virtual_primary applied an APPLY_TEMPORARY config; Mutter reverts that on its own once // the virtual output disappears and our DisplayConfig connection (`dc_pre`) closes — so we just // drop it here and let the revert happen Mutter-side, never touching the layout ourselves. let _ = session.rd_session.call_method("Stop", &()).await; drop(dc_pre); }); } /// The live session objects (held for the stream's lifetime) + the PipeWire node id. struct MutterSession { rd_session: zbus::Proxy<'static>, _sc_session: zbus::Proxy<'static>, _conn: zbus::Connection, node_id: u32, } /// Run the four-step handshake (see module docs). async fn connect(mode: Mode) -> Result { let conn = zbus::Connection::session() .await .context("connect session D-Bus")?; // 1. RemoteDesktop session (the anchor; also the future input path). let rd = zbus::Proxy::new( &conn, BUS_RD, "/org/gnome/Mutter/RemoteDesktop", "org.gnome.Mutter.RemoteDesktop", ) .await .context("RemoteDesktop proxy (is gnome-shell / `gnome-shell --headless` running?)")?; let rd_path: OwnedObjectPath = rd .call("CreateSession", &()) .await .context("RemoteDesktop.CreateSession")?; let rd_session = zbus::Proxy::new( &conn, BUS_RD, rd_path, "org.gnome.Mutter.RemoteDesktop.Session", ) .await?; let session_id: String = rd_session .get_property("SessionId") .await .context("read SessionId")?; // 2. ScreenCast session anchored to it. let sc = zbus::Proxy::new( &conn, BUS_SC, "/org/gnome/Mutter/ScreenCast", "org.gnome.Mutter.ScreenCast", ) .await .context("ScreenCast proxy")?; let mut props: HashMap<&str, Value> = HashMap::new(); props.insert("remote-desktop-session-id", Value::from(session_id)); let sc_path: OwnedObjectPath = sc .call("CreateSession", &(props,)) .await .context("ScreenCast.CreateSession")?; let sc_session = zbus::Proxy::new( &conn, BUS_SC, sc_path, "org.gnome.Mutter.ScreenCast.Session", ) .await?; // 3. The virtual monitor. By DEFAULT we let Mutter derive the refresh from the PipeWire // framerate (it defaults the virtual monitor to 60 Hz) — universally safe. // PUNKTFUNK_MUTTER_VIRTUAL_REFRESH=1 pins the client's exact WxH@Hz via RecordVirtual's "modes" // (explicit size + refresh-rate; Mutter ≥ 47) for true >60 Hz — validated at 5120×1440@240 on // Mutter 50 + NVIDIA. (A high-refresh virtual CRTC used to SIGSEGV gnome-shell on teardown; the // stop-screencast-before-any-monitor-reconfig teardown below avoids that.) let mut rec: HashMap<&str, Value> = HashMap::new(); rec.insert("cursor-mode", Value::from(CURSOR_EMBEDDED)); if virtual_refresh_enabled() && mode.refresh_hz > 60 { let mut vmode: HashMap<&str, Value> = HashMap::new(); vmode.insert("size", Value::from((mode.width, mode.height))); vmode.insert("refresh-rate", Value::from(mode.refresh_hz as f64)); vmode.insert("is-preferred", Value::from(true)); rec.insert("modes", Value::from(vec![vmode])); } let stream_path: OwnedObjectPath = sc_session .call("RecordVirtual", &(rec,)) .await .context("Session.RecordVirtual")?; let stream = zbus::Proxy::new( &conn, BUS_SC, stream_path, "org.gnome.Mutter.ScreenCast.Stream", ) .await?; // 4. Subscribe to the node-id signal BEFORE starting, then start the (combined) session. let mut added = stream .receive_signal("PipeWireStreamAdded") .await .context("subscribe PipeWireStreamAdded")?; rd_session .call_method("Start", &()) .await .context("RemoteDesktop.Session.Start")?; let msg = tokio::time::timeout(Duration::from_secs(10), added.next()) .await .map_err(|_| anyhow!("PipeWireStreamAdded did not arrive within 10s"))? .ok_or_else(|| anyhow!("signal stream ended before PipeWireStreamAdded"))?; let (node_id,): (u32,) = msg .body() .deserialize() .context("PipeWireStreamAdded body")?; Ok(MutterSession { rd_session, _sc_session: sc_session, _conn: conn, node_id, }) } // --------------------------------------------------------------------------------------------- // Optional: make the per-session virtual output the PRIMARY monitor (PUNKTFUNK_MUTTER_VIRTUAL_PRIMARY). // // `RecordVirtual` adds the virtual monitor as an *extended* desktop. On a headless host that's the // only display, so the shell + windows live there. But when a physical monitor is attached, GNOME // keeps it primary and the virtual output is an empty extension — the stream shows only the // wallpaper. We fix that by promoting the virtual output to primary (physical kept on, secondary) // via `org.gnome.Mutter.DisplayConfig.ApplyMonitorsConfig`, and restore on teardown. // --------------------------------------------------------------------------------------------- /// `org.gnome.Mutter.DisplayConfig.GetCurrentState` reply shapes (see the interface XML): /// monitors: `a((ssss)a(siiddada{sv})a{sv})` /// logical_monitors: `a(iiduba(ssss)a{sv})` type MonitorSpec = (String, String, String, String); // connector, vendor, product, serial type DbusMode = ( String, i32, i32, f64, f64, Vec, HashMap, ); type MonitorInfo = (MonitorSpec, Vec, HashMap); type LogicalMonitor = ( i32, i32, f64, u32, bool, Vec, HashMap, ); type CurrentState = ( u32, Vec, Vec, HashMap, ); /// `ApplyMonitorsConfig` logical-monitor shape: `(iiduba(ssa{sv}))`, monitor = `(ssa{sv})`. type ApplyMon = (String, String, HashMap>); // connector, mode_id, props type ApplyLogical = (i32, i32, f64, u32, bool, Vec); fn virtual_primary_enabled() -> bool { std::env::var("PUNKTFUNK_MUTTER_VIRTUAL_PRIMARY") .map(|v| { matches!( v.trim().to_ascii_lowercase().as_str(), "1" | "true" | "yes" | "on" ) }) .unwrap_or(false) } /// Opt-in: pin the virtual output to the client's exact refresh via RecordVirtual "modes" (true /// above-60 Hz). Off by default — Mutter-derived 60 Hz is safe on every host; high-refresh virtual /// CRTCs are validated on Mutter 50 + NVIDIA but behaviour can vary, so it stays opt-in. (The /// teardown SIGSEGV that first motivated this gate is fixed by stopping the screencast before any /// monitor-config change.) fn virtual_refresh_enabled() -> bool { std::env::var("PUNKTFUNK_MUTTER_VIRTUAL_REFRESH") .map(|v| { matches!( v.trim().to_ascii_lowercase().as_str(), "1" | "true" | "yes" | "on" ) }) .unwrap_or(false) } /// A DisplayConfig proxy on its own session-bus connection (owned, so it stays alive for the /// session — independent of the RemoteDesktop/ScreenCast connection). async fn display_config() -> Result> { let conn = zbus::Connection::session() .await .context("connect session D-Bus (DisplayConfig)")?; zbus::Proxy::new( &conn, BUS_DC, "/org/gnome/Mutter/DisplayConfig", "org.gnome.Mutter.DisplayConfig", ) .await .context("DisplayConfig proxy") } async fn get_state(dc: &zbus::Proxy<'_>) -> Result { dc.call("GetCurrentState", &()) .await .context("DisplayConfig.GetCurrentState") } fn connectors(state: &CurrentState) -> HashSet { state.1.iter().map(|m| m.0 .0.clone()).collect() } fn mode_flag(md: &DbusMode, key: &str) -> bool { matches!(md.6.get(key).map(|v| &**v), Some(&Value::Bool(true))) } /// The current (else preferred, else first) mode of `connector` → (mode_id, width, height). fn current_mode(state: &CurrentState, connector: &str) -> Option<(String, i32, i32)> { let mon = state.1.iter().find(|m| m.0 .0 == connector)?; let pick = mon .1 .iter() .find(|md| mode_flag(md, "is-current")) .or_else(|| mon.1.iter().find(|md| mode_flag(md, "is-preferred"))) .or_else(|| mon.1.first())?; Some((pick.0.clone(), pick.1, pick.2)) } /// Wait for the virtual output to appear in DisplayConfig (its size follows PipeWire negotiation, /// which lands shortly after the node id), then make it the SOLE primary output (physicals /// disabled for the session) so the cursor, windows, and keyboard focus stay on the streamed /// surface. Restored on teardown. async fn make_virtual_primary(dc: &zbus::Proxy<'_>, mode: Mode, pre: &CurrentState) -> Result<()> { let pre_conns = connectors(pre); let deadline = Instant::now() + Duration::from_secs(6); loop { let state = get_state(dc).await?; // The virtual connector = present now, absent in the pre-snapshot. let virt = state .1 .iter() .map(|m| m.0 .0.clone()) .find(|c| !pre_conns.contains(c)); if let Some(vconn) = virt { // Prefer the mode matching the client's WxH; fall back to whatever is current. let vmode = state .1 .iter() .find(|m| m.0 .0 == vconn) .and_then(|m| { m.1.iter() .find(|md| md.1 == mode.width as i32 && md.2 == mode.height as i32) .map(|md| md.0.clone()) }) .or_else(|| current_mode(&state, &vconn).map(|(id, _, _)| id)); let Some(vmode) = vmode else { bail!("virtual monitor {vconn} has no usable mode yet"); }; let config = build_primary_config(&vconn, &vmode); let _: () = dc .call( "ApplyMonitorsConfig", &( state.0, APPLY_TEMPORARY, config, HashMap::>::new(), ), ) .await .context("DisplayConfig.ApplyMonitorsConfig (set virtual primary)")?; return Ok(()); } if Instant::now() >= deadline { bail!("the virtual monitor did not appear in DisplayConfig within 6s"); } tokio::time::sleep(Duration::from_millis(250)).await; } } /// The virtual output as the SOLE, primary monitor — physical outputs are omitted, so Mutter /// disables them for the session. This confines the cursor, windows, and keyboard focus to the /// streamed surface; keeping the physical enabled as a *secondary* monitor instead lets relative /// pointer motion and window focus wander onto it (invisible to the client — the cursor seems to /// vanish). The physical layout is restored on teardown. fn build_primary_config(vconn: &str, vmode: &str) -> Vec { vec![( 0, 0, 1.0, 0, true, vec![(vconn.to_string(), vmode.to_string(), HashMap::new())], )] }