cosmic-comp/src/wayland/handlers/screencopy.rs
Victoria Brekenfeld e73ebd4413 stacking: header
2023-06-30 15:15:21 +02:00

1332 lines
46 KiB
Rust

use std::{
borrow::Borrow,
cell::RefCell,
collections::HashSet,
ops::{Deref, DerefMut},
};
use anyhow::anyhow;
use calloop::LoopHandle;
use cosmic_protocols::screencopy::v1::server::zcosmic_screencopy_session_v1::{
FailureReason, InputType,
};
use smithay::{
backend::{
allocator::dmabuf::Dmabuf,
drm::DrmNode,
egl::EGLDevice,
renderer::{
buffer_dimensions, buffer_type,
damage::{Error as DTError, OutputDamageTracker, OutputNoMode},
element::{
surface::WaylandSurfaceRenderElement, AsRenderElements, RenderElement,
RenderElementStates,
},
gles::{Capability, GlesError, GlesRenderbuffer, GlesRenderer},
Bind, Blit, BufferType, ExportMem, ImportAll, ImportMem, Offscreen, Renderer,
},
},
desktop::{layer_map_for_output, space::SpaceElement},
output::Output,
reexports::wayland_server::{
protocol::{wl_buffer::WlBuffer, wl_shm::Format as ShmFormat, wl_surface::WlSurface},
Resource,
},
utils::{IsAlive, Logical, Physical, Rectangle, Scale, Transform},
wayland::{
dmabuf::get_dmabuf,
seat::WaylandFocus,
shm::{shm_format_to_fourcc, with_buffer_contents, with_buffer_contents_mut},
},
xwayland::XWaylandClientData,
};
use tracing::warn;
use crate::{
backend::render::{
cursor,
element::{AsGlowRenderer, CosmicElement},
render_output, render_workspace, CursorMode, CLEAR_COLOR,
},
shell::{
element::{stack::CosmicStackRenderElement, window::CosmicWindowRenderElement},
CosmicMappedRenderElement, CosmicSurface, WorkspaceRenderElement,
},
state::{BackendData, ClientState, Common, Data, State},
utils::prelude::OutputExt,
wayland::protocols::{
screencopy::{
delegate_screencopy, BufferInfo, BufferParams, CursorMode as ScreencopyCursorMode,
CursorSession, ScreencopyHandler, Session, SessionType,
},
workspace::WorkspaceHandle,
},
};
use super::data_device::get_dnd_icon;
pub const WORKSPACE_OVERVIEW_NAMESPACE: &str = "cosmic-workspace-overview";
pub type PendingScreencopyBuffers = RefCell<Vec<(Session, BufferParams)>>;
#[derive(Debug, Default)]
pub struct ScreencopySessions(pub RefCell<Vec<DropableSession>>);
#[derive(Debug)]
pub struct DropableSession(Session, FailureReason);
impl Deref for DropableSession {
type Target = Session;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl DerefMut for DropableSession {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
impl Drop for DropableSession {
fn drop(&mut self) {
self.0.failed(self.1);
}
}
impl PartialEq<Session> for DropableSession {
fn eq(&self, other: &Session) -> bool {
&self.0 == other
}
}
pub type SessionDT = RefCell<OutputDamageTracker>;
impl ScreencopyHandler for State {
fn capture_output(&mut self, output: Output, session: Session) -> Vec<BufferInfo> {
let formats = match formats_for_output(&output, &mut self.backend) {
Ok(formats) => formats,
Err(reason) => {
session.failed(reason);
return Vec::new();
}
};
for seat in self.common.seats() {
if let Some(pointer) = seat.get_pointer() {
if output
.geometry()
.contains(pointer.current_location().to_i32_round())
{
session.cursor_enter(seat, InputType::Pointer);
}
}
}
session
.user_data()
.insert_if_missing(|| SessionDT::new(OutputDamageTracker::from_output(&output)));
output
.user_data()
.insert_if_missing(ScreencopySessions::default);
output
.user_data()
.get::<ScreencopySessions>()
.unwrap()
.0
.borrow_mut()
.push(DropableSession(session, FailureReason::InvalidOutput));
formats
}
fn capture_workspace(
&mut self,
handle: WorkspaceHandle,
output: Output,
session: Session,
) -> Vec<BufferInfo> {
let formats = match formats_for_output(&output, &mut self.backend) {
Ok(formats) => formats,
Err(reason) => {
session.failed(reason);
return Vec::new();
}
};
let workspace = match self.common.shell.space_for_handle_mut(&handle) {
Some(workspace) => workspace,
None => {
session.failed(FailureReason::InvalidWorkspace);
return Vec::new();
}
};
session
.user_data()
.insert_if_missing(|| SessionDT::new(OutputDamageTracker::from_output(&output)));
workspace
.screencopy_sessions
.push(DropableSession(session, FailureReason::InvalidWorkspace));
formats
}
fn capture_toplevel(&mut self, toplevel: CosmicSurface, session: Session) -> Vec<BufferInfo> {
let Some(surface) = toplevel.wl_surface() else { return Vec::new() };
let size = toplevel.geometry().size.to_buffer(1, Transform::Normal);
let mut _kms_renderer = None;
let renderer = match self.backend {
BackendData::Kms(ref mut kms) => {
let node = self
.common
.display_handle
.get_client(surface.id())
.ok()
.and_then(|client| {
// Lets check the global drm-node the client got either through default-feedback or wl_drm
if let Some(normal_client) = client.get_data::<ClientState>() {
return normal_client.drm_node.clone();
}
// last but not least all xwayland-surfaces should also share a single node
if let Some(xwayland_client) = client.get_data::<XWaylandClientData>() {
return xwayland_client.user_data().get::<DrmNode>().cloned();
}
None
})
.unwrap_or(kms.primary.clone());
_kms_renderer = Some(kms.api.single_renderer(&node).unwrap());
_kms_renderer.as_mut().unwrap().as_mut()
}
BackendData::Winit(ref mut winit) => winit.backend.renderer(),
BackendData::X11(ref mut x11) => &mut x11.renderer,
_ => unreachable!(),
};
let mut formats = vec![
BufferInfo::Shm {
format: ShmFormat::Abgr8888,
size,
stride: size.w as u32 * 4,
},
BufferInfo::Shm {
format: ShmFormat::Xbgr8888,
size,
stride: size.w as u32 * 4,
},
];
if (renderer as &dyn Borrow<GlesRenderer>)
.borrow()
.capabilities()
.contains(&Capability::ColorTransformations)
{
formats.extend([
BufferInfo::Shm {
format: ShmFormat::Abgr2101010,
size,
stride: size.w as u32 * 4,
},
BufferInfo::Shm {
format: ShmFormat::Xbgr2101010,
size,
stride: size.w as u32 * 4,
},
]);
}
if let Some(node) = EGLDevice::device_for_display(renderer.egl_context().display())
.ok()
.and_then(|device| device.try_get_render_node().ok().flatten())
{
formats.extend(
renderer
.egl_context()
.dmabuf_render_formats()
.iter()
.map(|format| format.code)
.collect::<HashSet<_>>()
.into_iter()
.map(|format| BufferInfo::Dmabuf { node, format, size }),
);
}
let size = toplevel.geometry().size.to_physical(1);
session.user_data().insert_if_missing(|| {
SessionDT::new(OutputDamageTracker::new(size, 1.0, Transform::Normal))
});
toplevel
.user_data()
.insert_if_missing(ScreencopySessions::default);
toplevel
.user_data()
.get::<ScreencopySessions>()
.unwrap()
.0
.borrow_mut()
.push(DropableSession(session, FailureReason::InvalidToplevel));
formats
}
fn capture_cursor(&mut self, _session: CursorSession) -> Vec<BufferInfo> {
unimplemented!("We don't advertise the capture cursor mode")
}
fn buffer_attached(&mut self, session: Session, params: BufferParams, on_damage: bool) {
// verify buffer size
let buffer_size = match buffer_dimensions(&params.buffer) {
Some(size) => size.to_logical(1, Transform::Normal),
None => {
warn!("Error during screencopy session: Buffer has no size");
session.failed(FailureReason::InvalidBuffer);
return;
}
};
match session.session_type() {
SessionType::Output(output) | SessionType::Workspace(output, _) => {
let mode = match output.current_mode() {
Some(mode) => mode,
None => {
warn!("Error during screencopy session: Output has no mode");
session.failed(FailureReason::InvalidOutput);
return;
}
}
.size;
if buffer_size.to_physical(1) != mode {
warn!("Error during screencopy session: Buffer size doesn't match");
session.failed(FailureReason::InvalidSize);
return;
}
}
SessionType::Window(window) => {
let geometry = window.geometry();
if buffer_size != geometry.size {
warn!("Error during screencopy session: Buffer size doesn't match");
session.failed(FailureReason::InvalidSize);
return;
}
}
_ => {}
};
if !matches!(
buffer_type(&params.buffer),
Some(BufferType::Shm) | Some(BufferType::Dma)
) {
warn!("Error during screencopy session: Buffer is neither shm or dma");
session.failed(FailureReason::InvalidBuffer);
return;
}
if let Some(BufferType::Shm) = buffer_type(&params.buffer) {
if with_buffer_contents(&params.buffer, |_, _, info| {
info.format != ShmFormat::Abgr8888
&& info.format != ShmFormat::Xbgr8888
&& info.format != ShmFormat::Abgr2101010
&& info.format != ShmFormat::Xbgr2101010
})
.unwrap()
{
warn!("Error during screencopy session: Invalid shm buffer format");
session.failed(FailureReason::InvalidBuffer);
return;
}
}
if on_damage {
match session.session_type() {
SessionType::Output(output) => {
output
.user_data()
.insert_if_missing(PendingScreencopyBuffers::default);
output
.user_data()
.get::<PendingScreencopyBuffers>()
.unwrap()
.borrow_mut()
.push((session, params));
}
SessionType::Workspace(_output, handle) => {
match self.common.shell.space_for_handle_mut(&handle) {
Some(workspace) => workspace.pending_buffers.push((session, params)),
None => session.failed(FailureReason::InvalidWorkspace),
};
}
SessionType::Window(window) => {
window
.user_data()
.insert_if_missing(PendingScreencopyBuffers::default);
window
.user_data()
.get::<PendingScreencopyBuffers>()
.unwrap()
.borrow_mut()
.push((session, params));
}
_ => unreachable!(),
};
} else {
let buffer = params.buffer.clone();
let result = match session.session_type() {
SessionType::Output(output) => {
render_output_to_buffer(self, &session, params, &output)
}
SessionType::Workspace(output, handle) => {
render_workspace_to_buffer(
self,
&session,
params,
&output,
(handle, 0), /* TODO: hack, we should have the index */
)
}
SessionType::Window(window) => {
render_window_to_buffer(self, &session, params, &window)
}
_ => unreachable!("Session types not supported"),
};
match result {
Ok(false) => {
// client didn't wanna wait for damage, so it gets empty damage
session.commit_buffer(
match session.session_type() {
SessionType::Output(output) | SessionType::Workspace(output, _) => {
output.current_transform()
}
_ => Transform::Normal,
},
Vec::new(),
None,
);
buffer.release();
}
Ok(true) => {} // success
Err((reason, err)) => {
warn!(?err, "Error during screencopy session");
session.failed(reason);
}
}
}
}
fn cursor_session_destroyed(&mut self, _session: CursorSession) {
unreachable!("We currently don't support cursor sessions");
}
fn session_destroyed(&mut self, session: Session) {
match session.session_type() {
SessionType::Output(output) => {
if let Some(pending_buffers) = output.user_data().get::<PendingScreencopyBuffers>()
{
pending_buffers.borrow_mut().retain(|(s, _)| s != &session);
}
if let Some(sessions) = output.user_data().get::<ScreencopySessions>() {
sessions.0.borrow_mut().retain(|s| s != &session);
}
}
SessionType::Workspace(_, handle) => {
if let Some(workspace) = self.common.shell.space_for_handle_mut(&handle) {
workspace.pending_buffers.retain(|(s, _)| s != &session);
workspace.screencopy_sessions.retain(|s| s != &session);
}
}
SessionType::Window(window) => {
if let Some(pending_buffers) = window.user_data().get::<PendingScreencopyBuffers>()
{
pending_buffers.borrow_mut().retain(|(s, _)| s != &session);
}
if let Some(sessions) = window.user_data().get::<ScreencopySessions>() {
sessions.0.borrow_mut().retain(|s| s != &session);
}
}
_ => {}
}
}
}
fn formats_for_output(
output: &Output,
backend: &mut BackendData,
) -> Result<Vec<BufferInfo>, FailureReason> {
let mode = match output.current_mode() {
Some(mode) => mode.size.to_logical(1).to_buffer(1, Transform::Normal),
None => {
return Err(FailureReason::InvalidOutput);
}
};
let mut _kms_renderer = None;
let renderer = match backend {
BackendData::Kms(ref mut kms) => {
let node = kms.target_node_for_output(&output).unwrap_or(kms.primary);
_kms_renderer = Some(kms.api.single_renderer(&node).unwrap());
_kms_renderer.as_mut().unwrap().as_mut()
}
BackendData::Winit(ref mut winit) => winit.backend.renderer(),
BackendData::X11(ref mut x11) => &mut x11.renderer,
_ => unreachable!(),
};
let mut formats = vec![
BufferInfo::Shm {
format: ShmFormat::Abgr8888,
size: mode,
stride: mode.w as u32 * 4,
},
BufferInfo::Shm {
format: ShmFormat::Xbgr8888,
size: mode,
stride: mode.w as u32 * 4,
},
];
if (renderer as &dyn Borrow<GlesRenderer>)
.borrow()
.capabilities()
.contains(&Capability::ColorTransformations)
{
formats.extend([
BufferInfo::Shm {
format: ShmFormat::Abgr2101010,
size: mode,
stride: mode.w as u32 * 4,
},
BufferInfo::Shm {
format: ShmFormat::Xbgr2101010,
size: mode,
stride: mode.w as u32 * 4,
},
]);
}
if let Some(node) = EGLDevice::device_for_display(renderer.egl_context().display())
.ok()
.and_then(|device| device.try_get_render_node().ok().flatten())
{
formats.extend(
renderer
.egl_context()
.dmabuf_render_formats()
.iter()
.map(|format| format.code)
.collect::<HashSet<_>>()
.into_iter()
.map(|format| BufferInfo::Dmabuf {
node,
format,
size: mode,
}),
);
}
Ok(formats)
}
fn node_from_params(
params: &BufferParams,
backend: &BackendData,
output: Option<&Output>,
) -> Option<DrmNode> {
match buffer_type(&params.buffer) {
Some(BufferType::Dma) if params.node.is_some() => params.node.clone(),
Some(BufferType::Shm) | Some(BufferType::Dma) => match backend {
BackendData::Kms(kms) => Some(
output
.and_then(|output| kms.target_node_for_output(output))
.unwrap_or(kms.primary),
),
_ => None,
},
_ => unreachable!(),
}
}
fn submit_buffer<R>(
session: &Session,
buffer: &WlBuffer,
renderer: &mut R,
transform: Transform,
damage: Vec<Rectangle<i32, Physical>>,
) -> Result<(), <R as Renderer>::Error>
where
R: ExportMem,
{
if matches!(buffer_type(buffer), Some(BufferType::Shm)) {
let buffer_size = buffer_dimensions(buffer).unwrap();
with_buffer_contents_mut(buffer, |ptr, len, data| {
let offset = data.offset as i32;
let width = data.width as i32;
let height = data.height as i32;
let stride = data.stride as i32;
let format = shm_format_to_fourcc(data.format)
.expect("We should be able to convert all hardcoded shm screencopy formats");
// number of bytes per pixel
// TODO: compute from data.format
let pixelsize = 4i32;
// ensure consistency, the SHM handler of smithay should ensure this
assert!((offset + (height - 1) * stride + width * pixelsize) as usize <= len);
let mapping = renderer
.copy_framebuffer(Rectangle::from_loc_and_size((0, 0), buffer_size), format)?;
let gl_data = renderer.map_texture(&mapping)?;
assert!((width * height * pixelsize) as usize <= gl_data.len());
for i in 0..height {
unsafe {
std::ptr::copy_nonoverlapping::<u8>(
gl_data.as_ptr().offset((width * pixelsize * i) as isize),
ptr.offset((offset + stride * i) as isize),
(width * pixelsize) as usize,
);
}
}
Ok(())
})
.unwrap()?;
}
session.commit_buffer(transform, damage, None);
buffer.release();
Ok(())
}
pub fn render_session<F, R>(
node: Option<DrmNode>,
renderer: &mut R,
session: &Session,
params: &BufferParams,
transform: Transform,
render_fn: F,
) -> Result<bool, DTError<R>>
where
R: ExportMem,
F: FnOnce(
Option<&DrmNode>,
&WlBuffer,
&mut R,
&mut OutputDamageTracker,
usize,
)
-> Result<(Option<Vec<Rectangle<i32, Physical>>>, RenderElementStates), DTError<R>>,
{
#[cfg(feature = "debug")]
puffin::profile_function!();
let mut dt = session.user_data().get::<SessionDT>().unwrap().borrow_mut();
let res = render_fn(
node.as_ref(),
&params.buffer,
renderer,
&mut *dt,
params.age as usize,
)?;
if let (Some(damage), _) = res {
submit_buffer(session, &params.buffer, renderer, transform, damage)
.map_err(DTError::Rendering)?;
Ok(true)
} else {
Ok(false)
}
}
pub fn render_output_to_buffer(
state: &mut State,
session: &Session,
params: BufferParams,
output: &Output,
) -> Result<bool, (FailureReason, anyhow::Error)> {
let mode = output
.current_mode()
.map(|mode| mode.size.to_logical(1).to_buffer(1, Transform::Normal));
let buffer_size = buffer_dimensions(&params.buffer).unwrap();
if mode != Some(buffer_size) {
return Err((FailureReason::InvalidSize, anyhow!("Output changed mode")));
}
fn render_fn<R>(
node: Option<&DrmNode>,
buffer: &WlBuffer,
renderer: &mut R,
dt: &mut OutputDamageTracker,
age: usize,
common: &mut Common,
session: &Session,
output: &Output,
) -> Result<(Option<Vec<Rectangle<i32, Physical>>>, RenderElementStates), DTError<R>>
where
R: Renderer
+ ImportAll
+ ImportMem
+ ExportMem
+ Bind<Dmabuf>
+ Offscreen<GlesRenderbuffer>
+ Blit<Dmabuf>
+ AsGlowRenderer,
<R as Renderer>::TextureId: Clone + 'static,
<R as Renderer>::Error: From<GlesError>,
CosmicElement<R>: RenderElement<R>,
CosmicMappedRenderElement<R>: RenderElement<R>,
CosmicWindowRenderElement<R>: RenderElement<R>,
CosmicStackRenderElement<R>: RenderElement<R>,
WorkspaceRenderElement<R>: RenderElement<R>,
{
let cursor_mode = match session.cursor_mode() {
ScreencopyCursorMode::Embedded => CursorMode::All,
ScreencopyCursorMode::Captured(_) | ScreencopyCursorMode::None => CursorMode::None,
};
if let Ok(dmabuf) = get_dmabuf(buffer) {
render_output::<_, _, GlesRenderbuffer, Dmabuf>(
node,
renderer,
dmabuf,
dt,
age,
common,
&output,
cursor_mode,
None,
None,
)
} else {
let size = buffer_dimensions(buffer).unwrap();
let format =
with_buffer_contents(buffer, |_, _, data| shm_format_to_fourcc(data.format))
.map_err(|_| DTError::OutputNoMode(OutputNoMode))? // eh, we have to do some error
.expect("We should be able to convert all hardcoded shm screencopy formats");
let render_buffer =
Offscreen::<GlesRenderbuffer>::create_buffer(renderer, format, size)
.map_err(DTError::Rendering)?;
render_output::<_, _, GlesRenderbuffer, Dmabuf>(
node,
renderer,
render_buffer,
dt,
age,
common,
&output,
cursor_mode,
None,
None,
)
}
}
let common = &mut state.common;
let node = node_from_params(&params, &mut state.backend, Some(output));
match &mut state.backend {
BackendData::Kms(kms) => {
let mut multirenderer = kms
.api
.single_renderer(node.as_ref().unwrap())
.map_err(|err| (FailureReason::Unspec, err.into()))?;
render_session::<_, _>(
node,
&mut multirenderer,
session,
&params,
output.current_transform(),
|node, buffer, renderer, dt, age| {
render_fn(node, buffer, renderer, dt, age, common, session, output)
},
)
.map_err(|err| match err {
DTError::OutputNoMode(x) => (FailureReason::Unspec, x.into()),
DTError::Rendering(x) => (FailureReason::Unspec, x.into()),
})
}
BackendData::Winit(winit) => render_session::<_, _>(
node,
winit.backend.renderer(),
session,
&params,
output.current_transform(),
|node, buffer, renderer, dt, age| {
render_fn(node, buffer, renderer, dt, age, common, session, output)
},
)
.map_err(|err| (FailureReason::Unspec, err.into())),
BackendData::X11(x11) => render_session::<_, _>(
node,
&mut x11.renderer,
session,
&params,
output.current_transform(),
|node, buffer, renderer, dt, age| {
render_fn(node, buffer, renderer, dt, age, common, session, output)
},
)
.map_err(|err| (FailureReason::Unspec, err.into())),
_ => unreachable!(),
}
}
pub fn render_workspace_to_buffer(
state: &mut State,
session: &Session,
params: BufferParams,
output: &Output,
handle: (WorkspaceHandle, usize),
) -> Result<bool, (FailureReason, anyhow::Error)> {
let mode = output
.current_mode()
.map(|mode| mode.size.to_logical(1).to_buffer(1, Transform::Normal));
let buffer_size = buffer_dimensions(&params.buffer).unwrap();
if mode != Some(buffer_size) {
return Err((FailureReason::InvalidSize, anyhow!("Output changed mode")));
}
fn render_fn<R>(
node: Option<&DrmNode>,
buffer: &WlBuffer,
renderer: &mut R,
dt: &mut OutputDamageTracker,
age: usize,
common: &mut Common,
session: &Session,
output: &Output,
handle: (WorkspaceHandle, usize),
) -> Result<(Option<Vec<Rectangle<i32, Physical>>>, RenderElementStates), DTError<R>>
where
R: Renderer
+ ImportAll
+ ImportMem
+ ExportMem
+ Bind<Dmabuf>
+ Offscreen<GlesRenderbuffer>
+ Blit<Dmabuf>
+ AsGlowRenderer,
<R as Renderer>::TextureId: Clone + 'static,
<R as Renderer>::Error: From<GlesError>,
CosmicElement<R>: RenderElement<R>,
CosmicMappedRenderElement<R>: RenderElement<R>,
CosmicWindowRenderElement<R>: RenderElement<R>,
CosmicStackRenderElement<R>: RenderElement<R>,
WorkspaceRenderElement<R>: RenderElement<R>,
{
let cursor_mode = match session.cursor_mode() {
ScreencopyCursorMode::Embedded => CursorMode::All,
ScreencopyCursorMode::Captured(_) | ScreencopyCursorMode::None => CursorMode::None,
};
if let Ok(dmabuf) = get_dmabuf(buffer) {
render_workspace::<_, _, GlesRenderbuffer, Dmabuf>(
node,
renderer,
dmabuf,
dt,
age,
common,
&output,
None,
handle,
cursor_mode,
None,
None,
true,
)
} else {
let size = buffer_dimensions(buffer).unwrap();
let format =
with_buffer_contents(buffer, |_, _, data| shm_format_to_fourcc(data.format))
.map_err(|_| DTError::OutputNoMode(OutputNoMode))? // eh, we have to do some error
.expect("We should be able to convert all hardcoded shm screencopy formats");
let render_buffer =
Offscreen::<GlesRenderbuffer>::create_buffer(renderer, format, size)
.map_err(DTError::Rendering)?;
render_workspace::<_, _, GlesRenderbuffer, Dmabuf>(
node,
renderer,
render_buffer,
dt,
age,
common,
&output,
None,
handle,
cursor_mode,
None,
None,
true,
)
}
}
let node = node_from_params(&params, &mut state.backend, Some(output));
let common = &mut state.common;
match &mut state.backend {
BackendData::Kms(kms) => {
let mut multirenderer = kms
.api
.single_renderer(node.as_ref().unwrap())
.map_err(|err| (FailureReason::Unspec, err.into()))?;
render_session::<_, _>(
node,
&mut multirenderer,
session,
&params,
output.current_transform(),
|node, buffer, renderer, dt, age| {
render_fn(
node, buffer, renderer, dt, age, common, session, output, handle,
)
},
)
.map_err(|err| match err {
DTError::OutputNoMode(x) => (FailureReason::Unspec, x.into()),
DTError::Rendering(x) => (FailureReason::Unspec, x.into()),
})
}
BackendData::Winit(winit) => render_session::<_, _>(
node,
winit.backend.renderer(),
session,
&params,
output.current_transform(),
|node, buffer, renderer, dt, age| {
render_fn(
node, buffer, renderer, dt, age, common, session, output, handle,
)
},
)
.map_err(|err| (FailureReason::Unspec, err.into())),
BackendData::X11(x11) => render_session::<_, _>(
node,
&mut x11.renderer,
session,
&params,
output.current_transform(),
|node, buffer, renderer, dt, age| {
render_fn(
node, buffer, renderer, dt, age, common, session, output, handle,
)
},
)
.map_err(|err| (FailureReason::Unspec, err.into())),
_ => unreachable!(),
}
}
smithay::render_elements! {
pub WindowCaptureElement<R> where R: ImportAll;
WaylandElement=WaylandSurfaceRenderElement<R>,
CursorElement=cursor::CursorRenderElement<R>,
}
pub fn render_window_to_buffer(
state: &mut State,
session: &Session,
params: BufferParams,
window: &CosmicSurface,
) -> Result<bool, (FailureReason, anyhow::Error)> {
#[cfg(feature = "debug")]
puffin::profile_function!();
let geometry = window.geometry();
let buffer_size = buffer_dimensions(&params.buffer).unwrap();
if buffer_size != geometry.size.to_buffer(1, Transform::Normal) {
return Err((FailureReason::InvalidSize, anyhow!("Window changed size")));
}
fn render_fn<R>(
buffer: &WlBuffer,
renderer: &mut R,
dt: &mut OutputDamageTracker,
age: usize,
session: &Session,
common: &mut Common,
window: &CosmicSurface,
geometry: Rectangle<i32, Logical>,
) -> Result<(Option<Vec<Rectangle<i32, Physical>>>, RenderElementStates), DTError<R>>
where
R: Renderer
+ ImportAll
+ ImportMem
+ ExportMem
+ Bind<Dmabuf>
+ Offscreen<GlesRenderbuffer>
+ Blit<Dmabuf>
+ AsGlowRenderer,
<R as Renderer>::TextureId: Clone + 'static,
<R as Renderer>::Error: From<GlesError>,
CosmicElement<R>: RenderElement<R>,
CosmicMappedRenderElement<R>: RenderElement<R>,
{
// TODO cursor elements!
let mut elements = AsRenderElements::<R>::render_elements::<WindowCaptureElement<R>>(
window,
renderer,
(-geometry.loc.x, -geometry.loc.y).into(),
Scale::from(1.0),
1.0,
);
for seat in common.seats() {
if let Some(location) = {
// we need to find the mapped element in that case
if let Some(mapped) = common.shell.element_for_surface(&window) {
mapped.cursor_position(seat).and_then(|mut p| {
p -= mapped.active_window_offset().to_f64();
if p.x < 0. || p.y < 0. {
None
} else {
Some(p)
}
})
} else {
None
}
} {
if session.cursor_mode() == ScreencopyCursorMode::Embedded {
elements.extend(
cursor::draw_cursor(
renderer,
seat,
location,
1.0.into(),
common.clock.now(),
true,
)
.into_iter()
.map(WindowCaptureElement::from),
);
}
if let Some(wl_surface) = get_dnd_icon(seat) {
elements.extend(
cursor::draw_dnd_icon(renderer, &wl_surface, location.to_i32_round(), 1.0)
.into_iter()
.map(WindowCaptureElement::from),
);
}
}
}
if let Ok(dmabuf) = get_dmabuf(buffer) {
renderer.bind(dmabuf).map_err(DTError::Rendering)?;
} else {
let size = buffer_dimensions(buffer).unwrap();
let format =
with_buffer_contents(buffer, |_, _, data| shm_format_to_fourcc(data.format))
.map_err(|_| DTError::OutputNoMode(OutputNoMode))? // eh, we have to do some error
.expect("We should be able to convert all hardcoded shm screencopy formats");
let render_buffer =
Offscreen::<GlesRenderbuffer>::create_buffer(renderer, format, size)
.map_err(DTError::Rendering)?;
renderer.bind(render_buffer).map_err(DTError::Rendering)?;
}
dt.render_output(renderer, age, &elements, CLEAR_COLOR)
}
let node = node_from_params(&params, &mut state.backend, None);
let common = &mut state.common;
match &mut state.backend {
BackendData::Kms(kms) => {
let mut multirenderer = kms
.api
.single_renderer(node.as_ref().unwrap())
.map_err(|err| (FailureReason::Unspec, err.into()))?;
render_session::<_, _>(
node,
&mut multirenderer,
session,
&params,
Transform::Normal,
|_node, buffer, renderer, dt, age| {
render_fn(buffer, renderer, dt, age, session, common, window, geometry)
},
)
.map_err(|err| match err {
DTError::OutputNoMode(x) => (FailureReason::Unspec, x.into()),
DTError::Rendering(x) => (FailureReason::Unspec, x.into()),
})
}
BackendData::Winit(winit) => render_session::<_, _>(
node,
winit.backend.renderer(),
session,
&params,
Transform::Normal,
|_node, buffer, renderer, dt, age| {
render_fn(buffer, renderer, dt, age, session, common, window, geometry)
},
)
.map_err(|err| (FailureReason::Unspec, err.into())),
BackendData::X11(x11) => render_session::<_, _>(
node,
&mut x11.renderer,
session,
&params,
Transform::Normal,
|_node, buffer, renderer, dt, age| {
render_fn(buffer, renderer, dt, age, session, common, window, geometry)
},
)
.map_err(|err| (FailureReason::Unspec, err.into())),
_ => unreachable!(),
}
}
impl Common {
pub fn still_pending(&mut self, session: Session, params: BufferParams) {
match session.session_type() {
SessionType::Output(output) => {
if output
.user_data()
.get::<ScreencopySessions>()
.map_or(false, |sessions| {
sessions.0.borrow().iter().any(|s| &*s == &session)
})
{
output
.user_data()
.get::<PendingScreencopyBuffers>()
.unwrap()
.borrow_mut()
.push((session, params));
}
}
SessionType::Workspace(_output, handle) => {
if let Some(space) = self.shell.space_for_handle_mut(&handle) {
if space.screencopy_sessions.iter().any(|s| s == &session) {
space.pending_buffers.push((session, params));
}
}
}
SessionType::Window(window) => {
if window
.user_data()
.get::<ScreencopySessions>()
.map_or(false, |sessions| {
sessions.0.borrow().iter().any(|s| &*s == &session)
})
{
window
.user_data()
.get::<PendingScreencopyBuffers>()
.unwrap()
.borrow_mut()
.push((session, params));
}
}
_ => {}
}
}
}
pub trait UserdataExt {
fn sessions(&self) -> Vec<Session>;
fn pending_buffers(
&self,
) -> std::iter::Flatten<std::option::IntoIter<std::vec::IntoIter<(Session, BufferParams)>>>;
}
impl UserdataExt for Output {
fn sessions(&self) -> Vec<Session> {
self.user_data()
.get::<ScreencopySessions>()
.map_or(Vec::new(), |sessions| {
sessions.0.borrow().iter().map(|s| s.0.clone()).collect()
})
}
fn pending_buffers(
&self,
) -> std::iter::Flatten<std::option::IntoIter<std::vec::IntoIter<(Session, BufferParams)>>>
{
self.user_data()
.get::<PendingScreencopyBuffers>()
.map(|pending| pending.borrow_mut().split_off(0).into_iter())
.into_iter()
.flatten()
}
}
impl UserdataExt for CosmicSurface {
fn sessions(&self) -> Vec<Session> {
self.user_data()
.get::<ScreencopySessions>()
.map_or(Vec::new(), |sessions| {
sessions.0.borrow().iter().map(|s| s.0.clone()).collect()
})
}
fn pending_buffers(
&self,
) -> std::iter::Flatten<std::option::IntoIter<std::vec::IntoIter<(Session, BufferParams)>>>
{
self.user_data()
.get::<PendingScreencopyBuffers>()
.map(|pending| pending.borrow_mut().split_off(0).into_iter())
.into_iter()
.flatten()
}
}
impl State {
pub fn schedule_window_session(&mut self, surface: &WlSurface) {
if let Some(element) = surface
.wl_surface()
.and_then(|surface| self.common.shell.element_for_wl_surface(&surface).cloned())
{
let active = element.active_window();
if active.wl_surface().as_ref() == Some(surface) {
for (session, params) in active.pending_buffers() {
let window = active.clone();
self.common.event_loop_handle.insert_idle(move |data| {
if !session.alive() {
return;
}
match render_window_to_buffer(
&mut data.state,
&session,
params.clone(),
&window,
) {
// rendering yielded no damage, buffer is still pending
Ok(false) => data.state.common.still_pending(session, params),
Ok(true) => {} // success
Err((reason, err)) => {
warn!(?err, "Screencopy session failed");
session.failed(reason);
}
}
});
}
}
}
}
pub fn workspace_session_for_output(
&mut self,
output: &Output,
) -> Option<Vec<(Session, BufferParams)>> {
let workspace = self.common.shell.active_space_mut(output);
let mut pending_buffers = std::mem::take(&mut workspace.pending_buffers);
let mut i = 0;
while i < pending_buffers.len() {
let layer_map = layer_map_for_output(&output);
if layer_map
.layers()
.any(|s| s.namespace() == WORKSPACE_OVERVIEW_NAMESPACE)
{
let (session, params) = pending_buffers.remove(i);
schedule_offscreen_workspace_session(
&self.common.event_loop_handle,
session,
params,
output.clone(),
workspace.handle.clone(),
);
} else {
i += 1;
}
}
if !pending_buffers.is_empty() {
Some(pending_buffers)
} else {
None
}
}
pub fn schedule_workspace_sessions(
&mut self,
surface: &WlSurface,
) -> Option<Vec<(Session, BufferParams)>> {
// here we store additional workspace_sessions, we should handle, when rendering the corresponding output anyway
let mut output_sessions: Option<Vec<(Session, BufferParams)>> = None;
// lets check which workspaces this surface belongs to
let active_spaces = self
.common
.shell
.outputs()
.map(|o| (o.clone(), self.common.shell.active_space(o).handle.clone()))
.collect::<Vec<_>>();
for (handle, output) in self.common.shell.workspaces_for_surface(surface) {
let workspace = self.common.shell.space_for_handle_mut(&handle).unwrap();
if !workspace.pending_buffers.is_empty() {
// TODO: replace with drain_filter....
let mut i = 0;
while i < workspace.pending_buffers.len() {
if let SessionType::Workspace(o, w) =
workspace.pending_buffers[i].0.session_type()
{
let layer_map = layer_map_for_output(&o);
if active_spaces.contains(&(o.clone(), w))
&& !layer_map
.layers()
.any(|s| s.namespace() == WORKSPACE_OVERVIEW_NAMESPACE)
{
// surface is on an active workspace/output combo, add to workspace_sessions
let (session, params) = workspace.pending_buffers.remove(i);
output_sessions
.get_or_insert_with(Vec::new)
.push((session, params));
} else if handle == w && output == o {
// surface is visible on an offscreen workspace session, schedule a new render
let (session, params) = workspace.pending_buffers.remove(i);
schedule_offscreen_workspace_session(
&self.common.event_loop_handle,
session,
params,
output.clone(),
handle,
);
} else {
i += 1;
}
} else {
unreachable!();
}
}
}
}
output_sessions
}
}
pub fn schedule_offscreen_workspace_session(
event_loop_handle: &LoopHandle<'static, Data>,
session: Session,
params: BufferParams,
output: Output,
handle: WorkspaceHandle,
) {
event_loop_handle.insert_idle(move |data| {
if !session.alive() {
return;
}
if !data.state.common.shell.outputs.contains(&output) {
return;
}
match render_workspace_to_buffer(
&mut data.state,
&session,
params.clone(),
&output,
(handle, 0), /* TODO: Hack, we should know the idx */
) {
Ok(false) => {
// rendering yielded no new damage, buffer still pending
data.state.common.still_pending(session, params);
}
Ok(true) => {}
Err((reason, err)) => {
warn!(?err, "Screencopy session failed.");
session.failed(reason);
}
}
});
}
delegate_screencopy!(State);