use core::slice; use serde::{Deserialize, Serialize}; use std::{ f32::consts::PI, ops::Add, ptr, sync::Arc, time::{Duration, Instant}, }; use vulkano::{ command_buffer::CommandBufferUsage, image::{sampler::Filter, view::ImageView, Image}, pipeline::graphics::color_blend::AttachmentBlend, }; use wlx_capture::{ frame::{ DrmFormat, MouseMeta, WlxFrame, DRM_FORMAT_ABGR8888, DRM_FORMAT_ARGB8888, DRM_FORMAT_XBGR8888, DRM_FORMAT_XRGB8888, }, WlxCapture, }; #[cfg(feature = "wayland")] use { crate::config::AStrMapExt, crate::config_io, std::{error::Error, ops::Deref, path::PathBuf}, wlx_capture::{ pipewire::{pipewire_select_screen, PipewireCapture}, wayland::{wayland_client::protocol::wl_output, WlxClient, WlxOutput}, wlr_dmabuf::WlrDmabufCapture, wlr_screencopy::WlrScreencopyCapture, }, }; #[cfg(feature = "x11")] use wlx_capture::xshm::{XshmCapture, XshmScreen}; use glam::{vec2, vec3a, Affine2, Quat, Vec2, Vec3}; use crate::{ backend::{ input::{Haptics, InteractionHandler, PointerHit, PointerMode}, overlay::{OverlayRenderer, OverlayState, SplitOverlayBackend}, }, config::{def_pw_tokens, PwTokenMap}, graphics::{fourcc_to_vk, WlxCommandBuffer, WlxPipeline, WlxPipelineLegacy}, hid::{MOUSE_LEFT, MOUSE_MIDDLE, MOUSE_RIGHT}, state::{AppSession, AppState, ScreenMeta}, }; #[cfg(feature = "wayland")] pub(crate) type WlxClientAlias = wlx_capture::wayland::WlxClient; #[cfg(not(feature = "wayland"))] pub(crate) type WlxClientAlias = (); const CURSOR_SIZE: f32 = 16. / 1440.; static DRM_FORMATS: once_cell::sync::OnceCell> = once_cell::sync::OnceCell::new(); pub struct ScreenInteractionHandler { next_scroll: Instant, next_move: Instant, mouse_transform: Affine2, } impl ScreenInteractionHandler { fn new(pos: Vec2, size: Vec2, transform: Transform) -> ScreenInteractionHandler { let transform = match transform { Transform::_90 | Transform::Flipped90 => Affine2::from_cols( vec2(0., size.y), vec2(-size.x, 0.), vec2(pos.x + size.x, pos.y), ), Transform::_180 | Transform::Flipped180 => Affine2::from_cols( vec2(-size.x, 0.), vec2(0., -size.y), vec2(pos.x + size.x, pos.y + size.y), ), Transform::_270 | Transform::Flipped270 => Affine2::from_cols( vec2(0., -size.y), vec2(size.x, 0.), vec2(pos.x, pos.y + size.y), ), _ => Affine2::from_cols(vec2(size.x, 0.), vec2(0., size.y), pos), }; ScreenInteractionHandler { next_scroll: Instant::now(), next_move: Instant::now(), mouse_transform: transform, } } } impl InteractionHandler for ScreenInteractionHandler { fn on_hover(&mut self, app: &mut AppState, hit: &PointerHit) -> Option { #[cfg(debug_assertions)] log::trace!("Hover: {:?}", hit.uv); if self.next_move < Instant::now() && (!app.session.config.focus_follows_mouse_mode || app.input_state.pointers[hit.pointer].now.move_mouse) { let pos = self.mouse_transform.transform_point2(hit.uv); app.hid_provider.mouse_move(pos); } None } fn on_pointer(&mut self, app: &mut AppState, hit: &PointerHit, pressed: bool) { let btn = match hit.mode { PointerMode::Right => MOUSE_RIGHT, PointerMode::Middle => MOUSE_MIDDLE, _ => MOUSE_LEFT, }; if pressed { self.next_move = Instant::now() + Duration::from_millis(app.session.config.click_freeze_time_ms as u64); } app.hid_provider.send_button(btn, pressed); let pos = self.mouse_transform.transform_point2(hit.uv); app.hid_provider.mouse_move(pos); } fn on_scroll(&mut self, app: &mut AppState, hit: &PointerHit, delta: f32) { if self.next_scroll > Instant::now() { return; } let max_millis = if matches!(hit.mode, PointerMode::Right) { 50.0 } else { 100.0 }; let millis = (1. - delta.abs()) * max_millis; self.next_scroll = Instant::now().add(Duration::from_millis(millis as _)); app.hid_provider.wheel(if delta < 0. { -1 } else { 1 }) } fn on_left(&mut self, _app: &mut AppState, _hand: usize) {} } #[derive(Clone)] struct ScreenPipeline { view: Arc, mouse: Option>, pipeline: Arc>, extentf: [f32; 2], } impl ScreenPipeline { fn new(extent: &[u32; 3], app: &mut AppState) -> anyhow::Result { let texture = app.graphics .render_texture(extent[0], extent[1], app.graphics.native_format)?; let view = ImageView::new_default(texture)?; let Ok(shaders) = app.graphics.shared_shaders.read() else { return Err(anyhow::anyhow!("Could not lock shared shaders for reading")); }; let pipeline = app.graphics.create_pipeline( view.clone(), shaders.get("vert_common").unwrap().clone(), // want panic shaders.get("frag_screen").unwrap().clone(), // want panic app.graphics.native_format, Some(AttachmentBlend::default()), )?; let extentf = [extent[0] as f32, extent[1] as f32]; Ok(ScreenPipeline { view, mouse: None, pipeline, extentf, }) } fn ensure_mouse_initialized(&mut self, uploads: &mut WlxCommandBuffer) -> anyhow::Result<()> { if self.mouse.is_some() { return Ok(()); } #[rustfmt::skip] let mouse_bytes = [ 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff, ]; let mouse_tex = uploads.texture2d(4, 4, vulkano::format::Format::R8G8B8A8_UNORM, &mouse_bytes)?; self.mouse = Some(ImageView::new_default(mouse_tex)?); Ok(()) } fn render( &mut self, image: Arc, mouse: Option<&MouseMeta>, app: &mut AppState, ) -> anyhow::Result<()> { let mut cmd = app .graphics .create_command_buffer(CommandBufferUsage::OneTimeSubmit)?; let view = ImageView::new_default(image)?; let set0 = self.pipeline.uniform_sampler(0, view, Filter::Linear)?; let pass = self.pipeline.create_pass( self.extentf, app.graphics.quad_verts.clone(), app.graphics.quad_indices.clone(), vec![set0], )?; cmd.begin_render_pass(&self.pipeline)?; cmd.run_ref(&pass)?; if let (Some(mouse), Some(mouse_view)) = (mouse, self.mouse.clone()) { let size = CURSOR_SIZE * self.extentf[1]; let half_size = size * 0.5; let vertex_buffer = app.graphics.upload_verts( self.extentf[0], self.extentf[1], mouse.x * self.extentf[0] - half_size, mouse.y * self.extentf[1] - half_size, size, size, )?; let set0 = self .pipeline .uniform_sampler(0, mouse_view.clone(), Filter::Nearest)?; let pass = self.pipeline.create_pass( self.extentf, vertex_buffer, app.graphics.quad_indices.clone(), vec![set0], )?; cmd.run_ref(&pass)?; } cmd.end_render_pass()?; cmd.build_and_execute_now() } } pub struct ScreenRenderer { name: Arc, capture: Box, pipeline: Option, last_view: Option>, extent: [u32; 3], } impl ScreenRenderer { #[cfg(feature = "wayland")] pub fn new_raw(name: Arc, capture: Box) -> ScreenRenderer { ScreenRenderer { name, capture, pipeline: None, last_view: None, extent: [0; 3], } } #[cfg(feature = "wayland")] pub fn new_wlr_dmabuf(output: &WlxOutput) -> Option { let client = WlxClient::new()?; let capture = WlrDmabufCapture::new(client, output.id); Some(ScreenRenderer { name: output.name.clone(), capture: Box::new(capture), pipeline: None, last_view: None, extent: extent_from_res(output.size), }) } #[cfg(feature = "wayland")] pub fn new_wlr_screencopy(output: &WlxOutput) -> Option { let client = WlxClient::new()?; let capture = WlrScreencopyCapture::new(client, output.id); Some(ScreenRenderer { name: output.name.clone(), capture: Box::new(capture), pipeline: None, last_view: None, extent: extent_from_res(output.size), }) } #[cfg(feature = "wayland")] pub fn new_pw( output: &WlxOutput, token: Option<&str>, session: &AppSession, ) -> anyhow::Result<( ScreenRenderer, Option, /* pipewire restore token */ )> { let name = output.name.clone(); let embed_mouse = !session.config.double_cursor_fix; let select_screen_result = futures::executor::block_on(pipewire_select_screen(token, embed_mouse, true, true))?; let capture = PipewireCapture::new(name, select_screen_result.node_id, 60); Ok(( ScreenRenderer { name: output.name.clone(), capture: Box::new(capture), pipeline: None, last_view: None, extent: extent_from_res(output.size), }, select_screen_result.restore_token, )) } #[cfg(feature = "x11")] pub fn new_xshm(screen: Arc) -> ScreenRenderer { let capture = XshmCapture::new(screen.clone()); ScreenRenderer { name: screen.name.clone(), capture: Box::new(capture), pipeline: None, last_view: None, extent: extent_from_res((screen.monitor.width(), screen.monitor.height())), } } } impl OverlayRenderer for ScreenRenderer { fn init(&mut self, _app: &mut AppState) -> anyhow::Result<()> { Ok(()) } fn render(&mut self, app: &mut AppState) -> anyhow::Result<()> { if !self.capture.is_ready() { let supports_dmabuf = self.capture.supports_dmbuf(); let allow_dmabuf = &*app.session.config.capture_method != "pw_fallback" && &*app.session.config.capture_method != "screencopy"; let drm_formats = DRM_FORMATS.get_or_init({ let graphics = app.graphics.clone(); move || { if !supports_dmabuf { log::info!("Capture method does not support DMA-buf"); return vec![]; } if !allow_dmabuf { log::info!("Not using DMA-buf capture due to pw_fallback"); return vec![]; } log::warn!("Using DMA-buf capture. If screens are blank for you, switch to SHM using:"); log::warn!("echo 'capture_method: pw_fallback' > ~/.config/wlxoverlay/conf.d/pw_fallback.yaml"); let possible_formats = [ DRM_FORMAT_ABGR8888.into(), DRM_FORMAT_XBGR8888.into(), DRM_FORMAT_ARGB8888.into(), DRM_FORMAT_XRGB8888.into(), ]; let mut final_formats = vec![]; for &f in &possible_formats { let Ok(vk_fmt) = fourcc_to_vk(f) else { continue; }; let Ok(props) = graphics.device.physical_device().format_properties(vk_fmt) else { continue; }; final_formats.push(DrmFormat { fourcc: f, modifiers: props .drm_format_modifier_properties .iter() // important bit: only allow single-plane .filter(|m| m.drm_format_modifier_plane_count == 1) .map(|m| m.drm_format_modifier) .collect(), }) } final_formats } }); self.capture.init(drm_formats); self.capture.request_new_frame(); }; for frame in self.capture.receive().into_iter() { match frame { WlxFrame::Dmabuf(frame) => { if !frame.is_valid() { log::error!("Invalid frame"); continue; } match app.graphics.dmabuf_texture(frame) { Ok(new) => { let view = ImageView::new_default(new.clone())?; self.last_view = Some(view); } Err(e) => { log::error!( "{}: Failed to create DMA-buf texture: {}", self.name, e.to_string() ); } } } WlxFrame::MemFd(frame) => { let mut upload = app .graphics .create_command_buffer(CommandBufferUsage::OneTimeSubmit)?; let Some(fd) = frame.plane.fd else { log::error!("No fd"); continue; }; log::debug!("{}: New MemFd frame", self.name); let format = fourcc_to_vk(frame.format.fourcc)?; let len = frame.plane.stride as usize * frame.format.height as usize; let offset = frame.plane.offset as i64; let map = unsafe { libc::mmap( ptr::null_mut(), len, libc::PROT_READ, libc::MAP_SHARED, fd, offset, ) } as *const u8; let data = unsafe { slice::from_raw_parts(map, len) }; let image = upload.texture2d(frame.format.width, frame.format.height, format, data)?; upload.build_and_execute_now()?; unsafe { libc::munmap(map as *mut _, len) }; self.last_view = Some(ImageView::new_default(image)?); self.capture.request_new_frame(); } WlxFrame::MemPtr(frame) => { log::debug!("{}: New MemPtr frame", self.name); let mut upload = app .graphics .create_command_buffer(CommandBufferUsage::OneTimeSubmit)?; let format = fourcc_to_vk(frame.format.fourcc)?; let data = unsafe { slice::from_raw_parts(frame.ptr as *const u8, frame.size) }; let image = upload.texture2d(frame.format.width, frame.format.height, format, data)?; let pipeline = Some(match self.pipeline { Some(ref mut p) => p, _ => { let mut pipeline = ScreenPipeline::new(&self.extent, app)?; self.last_view = Some(pipeline.view.clone()); pipeline.ensure_mouse_initialized(&mut upload)?; self.pipeline = Some(pipeline); self.pipeline.as_mut().unwrap() // safe } }); upload.build_and_execute_now()?; if let Some(pipeline) = pipeline { pipeline.render(image, frame.mouse.as_ref(), app)?; } else { let view = ImageView::new_default(image)?; self.last_view = Some(view); } self.capture.request_new_frame(); } }; } Ok(()) } fn pause(&mut self, _app: &mut AppState) -> anyhow::Result<()> { self.capture.pause(); Ok(()) } fn resume(&mut self, _app: &mut AppState) -> anyhow::Result<()> { self.capture.resume(); Ok(()) } fn view(&mut self) -> Option> { self.last_view.clone() } } #[cfg(feature = "wayland")] pub fn create_screen_renderer_wl( output: &WlxOutput, has_wlr_dmabuf: bool, has_wlr_screencopy: bool, pw_token_store: &mut PwTokenMap, session: &AppSession, ) -> Option { let mut capture: Option = None; if (&*session.config.capture_method == "auto" || &*session.config.capture_method == "dmabuf") && has_wlr_dmabuf { log::info!("{}: Using Wlr DMA-Buf", &output.name); capture = ScreenRenderer::new_wlr_dmabuf(output); } if &*session.config.capture_method == "screencopy" && has_wlr_screencopy { log::info!("{}: Using Wlr Screencopy Wl-SHM", &output.name); capture = ScreenRenderer::new_wlr_screencopy(output); } if capture.is_none() { log::info!("{}: Using Pipewire capture", &output.name); let display_name = output.name.deref(); // Find existing token by display let token = pw_token_store.arc_get(display_name).map(|s| s.as_str()); if let Some(t) = token { log::info!( "Found existing Pipewire token for display {}: {}", display_name, t ); } match ScreenRenderer::new_pw(output, token, session) { Ok((renderer, restore_token)) => { capture = Some(renderer); if let Some(token) = restore_token { if pw_token_store.arc_ins(display_name.into(), token.clone()) { log::info!("Adding Pipewire token {}", token); } } } Err(e) => { log::warn!( "{}: Failed to create Pipewire capture: {:?}", &output.name, e ); } } } capture } pub fn create_screen_interaction( logical_pos: Vec2, logical_size: Vec2, transform: Transform, ) -> ScreenInteractionHandler { ScreenInteractionHandler::new(logical_pos, logical_size, transform) } fn create_screen_state( name: Arc, res: (i32, i32), transform: Transform, session: &AppSession, ) -> OverlayState { let angle = if session.config.upright_screen_fix { match transform { Transform::_90 | Transform::Flipped90 => PI / 2., Transform::_180 | Transform::Flipped180 => PI, Transform::_270 | Transform::Flipped270 => -PI / 2., _ => 0., } } else { 0. }; let center = Vec2 { x: 0.5, y: 0.5 }; let interaction_transform = match transform { Transform::_90 | Transform::Flipped90 => Affine2::from_cols( Vec2::NEG_Y * (res.0 as f32 / res.1 as f32), Vec2::NEG_X, center, ), Transform::_180 | Transform::Flipped180 => Affine2::from_cols( Vec2::NEG_X, Vec2::NEG_Y * (-res.0 as f32 / res.1 as f32), center, ), Transform::_270 | Transform::Flipped270 => { Affine2::from_cols(Vec2::Y * (res.0 as f32 / res.1 as f32), Vec2::X, center) } _ => Affine2::from_cols(Vec2::X, Vec2::Y * (-res.0 as f32 / res.1 as f32), center), }; OverlayState { name: name.clone(), grabbable: true, recenter: true, interactable: true, spawn_scale: 1.5 * session.config.desktop_view_scale, spawn_point: vec3a(0., 0.5, -1.), spawn_rotation: Quat::from_axis_angle(Vec3::Z, angle), interaction_transform, ..Default::default() } } #[derive(Deserialize, Serialize, Default)] pub struct TokenConf { #[serde(default = "def_pw_tokens")] pub pw_tokens: PwTokenMap, } #[cfg(feature = "wayland")] fn get_pw_token_path() -> PathBuf { let mut path = config_io::get_conf_d_path(); path.push("pw_tokens.yaml"); path } #[cfg(feature = "wayland")] pub fn save_pw_token_config(tokens: PwTokenMap) -> Result<(), Box> { let conf = TokenConf { pw_tokens: tokens }; let yaml = serde_yaml::to_string(&conf)?; std::fs::write(get_pw_token_path(), yaml)?; Ok(()) } #[cfg(feature = "wayland")] pub fn load_pw_token_config() -> Result> { let yaml = std::fs::read_to_string(get_pw_token_path())?; let conf: TokenConf = serde_yaml::from_str(yaml.as_str())?; Ok(conf.pw_tokens) } pub(crate) struct ScreenCreateData { pub screens: Vec<(ScreenMeta, OverlayState, Box)>, } #[cfg(not(feature = "wayland"))] pub fn create_screens_wayland( _wl: &mut WlxClientAlias, _app: &AppState, ) -> anyhow::Result { anyhow::bail!("Wayland support not enabled") } #[cfg(feature = "wayland")] pub fn create_screens_wayland( wl: &mut WlxClientAlias, app: &mut AppState, ) -> anyhow::Result { use crate::config::AStrMap; let mut screens = vec![]; // Load existing Pipewire tokens from file let mut pw_tokens: PwTokenMap = if let Ok(conf) = load_pw_token_config() { conf } else { AStrMap::new() }; let pw_tokens_copy = pw_tokens.clone(); let has_wlr_dmabuf = wl.maybe_wlr_dmabuf_mgr.is_some(); let has_wlr_screencopy = wl.maybe_wlr_screencopy_mgr.is_some(); for (id, output) in wl.outputs.iter() { if app.screens.iter().any(|s| s.name == output.name) { continue; } log::info!( "{}: Init screen of res {:?}, logical {:?} at {:?}", output.name, output.size, output.logical_size, output.logical_pos, ); if let Some(renderer) = create_screen_renderer_wl( output, has_wlr_dmabuf, has_wlr_screencopy, &mut pw_tokens, &app.session, ) { let logical_pos = vec2(output.logical_pos.0 as f32, output.logical_pos.1 as f32); let logical_size = vec2(output.logical_size.0 as f32, output.logical_size.1 as f32); let transform = output.transform.into(); let interaction = create_screen_interaction(logical_pos, logical_size, transform); let state = create_screen_state(output.name.clone(), output.size, transform, &app.session); let meta = ScreenMeta { name: wl.outputs[id].name.clone(), id: state.id, native_handle: *id, }; let backend = Box::new(SplitOverlayBackend { renderer: Box::new(renderer), interaction: Box::new(interaction), }); screens.push((meta, state, backend)); } } if pw_tokens_copy != pw_tokens { // Token list changed, re-create token config file if let Err(err) = save_pw_token_config(pw_tokens) { log::error!("Failed to save Pipewire token config: {}", err); } } let extent = wl.get_desktop_extent(); let origin = wl.get_desktop_origin(); app.hid_provider .set_desktop_extent(vec2(extent.0 as f32, extent.1 as f32)); app.hid_provider .set_desktop_origin(vec2(origin.0 as f32, origin.1 as f32)); Ok(ScreenCreateData { screens }) } #[cfg(not(feature = "x11"))] pub fn create_screens_x11(_app: &mut AppState) -> anyhow::Result { anyhow::bail!("X11 support not enabled") } #[cfg(feature = "x11")] pub fn create_screens_x11(app: &mut AppState) -> anyhow::Result { use anyhow::bail; let mut extent = vec2(0., 0.); let monitors = match XshmCapture::get_monitors() { Ok(m) => m, Err(e) => { bail!(e.to_string()); } }; let screens = monitors .into_iter() .map(|s| { extent.x = extent.x.max((s.monitor.x() + s.monitor.width()) as f32); extent.y = extent.y.max((s.monitor.y() + s.monitor.height()) as f32); let size = (s.monitor.width(), s.monitor.height()); let pos = (s.monitor.x(), s.monitor.y()); let renderer = ScreenRenderer::new_xshm(s.clone()); log::info!( "{}: Init screen of res {:?} at {:?}", s.name.clone(), size, pos, ); let interaction = create_screen_interaction( vec2(s.monitor.x() as f32, s.monitor.y() as f32), vec2(size.0 as f32, size.1 as f32), Transform::Normal, ); let state = create_screen_state(s.name.clone(), size, Transform::Normal, &app.session); let meta = ScreenMeta { name: s.name.clone(), id: state.id, native_handle: 0, }; let backend = Box::new(SplitOverlayBackend { renderer: Box::new(renderer), interaction: Box::new(interaction), }); (meta, state, backend) }) .collect(); app.hid_provider.set_desktop_extent(extent); Ok(ScreenCreateData { screens }) } #[allow(unused)] #[derive(Clone, Copy)] pub enum Transform { Normal, _90, _180, _270, Flipped90, Flipped180, Flipped270, } #[cfg(feature = "wayland")] impl From for Transform { fn from(t: wl_output::Transform) -> Transform { match t { wl_output::Transform::Normal => Transform::Normal, wl_output::Transform::_90 => Transform::_90, wl_output::Transform::_180 => Transform::_180, wl_output::Transform::_270 => Transform::_270, wl_output::Transform::Flipped => Transform::Flipped180, wl_output::Transform::Flipped90 => Transform::Flipped90, wl_output::Transform::Flipped180 => Transform::Flipped180, wl_output::Transform::Flipped270 => Transform::Flipped270, _ => Transform::Normal, } } } fn extent_from_res(res: (i32, i32)) -> [u32; 3] { // screens above a certain resolution will have severe aliasing // TODO make dynamic. maybe don't go above HMD resolution? let w = res.0.min(2560) as u32; let h = (res.1 as f32 / res.0 as f32 * w as f32) as u32; [w, h, 1] }