🔒 Repository is read-only – file editing is disabled.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684
#[cfg(feature = "backend_drm")]
use crate::wayland::drm_syncobj::{DrmSyncPoint, DrmSyncobjCachedState};
use crate::{
backend::renderer::{
buffer_dimensions, buffer_has_alpha, element::RenderElement, ContextId, ErasedContextId, ImportAll,
Renderer, Texture,
},
utils::{Buffer as BufferCoord, Coordinate, Logical, Physical, Point, Rectangle, Scale, Size, Transform},
wayland::{
compositor::{
self, add_destruction_hook, is_sync_subsurface, with_surface_tree_downward,
with_surface_tree_upward, BufferAssignment, Damage, RectangleKind, SubsurfaceCachedState,
SurfaceAttributes, SurfaceData, TraversalAction,
},
viewporter,
},
};
use std::{
any::Any,
collections::{hash_map::Entry, HashMap},
sync::{Arc, Mutex},
};
use super::{CommitCounter, DamageBag, DamageSet, DamageSnapshot, SurfaceView};
use tracing::{error, instrument, warn};
use wayland_server::protocol::{wl_buffer::WlBuffer, wl_surface::WlSurface};
/// Type stored in WlSurface states data_map
///
/// ```rs
/// compositor::with_states(surface, |states| {
/// let data = states.data_map.get::<RendererSurfaceStateUserData>();
/// });
/// ```
pub type RendererSurfaceStateUserData = Mutex<RendererSurfaceState>;
/// Surface state for rendering related data
#[derive(Default, Debug)]
pub struct RendererSurfaceState {
pub(crate) buffer_dimensions: Option<Size<i32, BufferCoord>>,
pub(crate) buffer_scale: i32,
pub(crate) buffer_transform: Transform,
pub(crate) buffer_has_alpha: Option<bool>,
pub(crate) buffer: Option<Buffer>,
pub(crate) damage: DamageBag<i32, BufferCoord>,
pub(crate) renderer_seen: HashMap<ErasedContextId, CommitCounter>,
pub(crate) textures: HashMap<ErasedContextId, Box<dyn Any>>,
pub(crate) surface_view: Option<SurfaceView>,
pub(crate) opaque_regions: Vec<Rectangle<i32, Logical>>,
}
/// SAFETY: Only thing unsafe here is the `Box<dyn Any>`, which are the textures.
/// Those are guarded by our Renderers handling thread-safety and the `ContextId`.
/// Theoretically a renderer could be thread-safe, but its texture type isn't, but that is **very** theoretical.
unsafe impl Send for RendererSurfaceState {}
unsafe impl Sync for RendererSurfaceState {}
#[derive(Debug)]
struct InnerBuffer {
buffer: WlBuffer,
#[cfg(feature = "backend_drm")]
acquire_point: Option<DrmSyncPoint>,
#[cfg(feature = "backend_drm")]
release_point: Option<DrmSyncPoint>,
}
impl Drop for InnerBuffer {
#[inline]
fn drop(&mut self) {
self.buffer.release();
#[cfg(feature = "backend_drm")]
if let Some(release_point) = &self.release_point {
if let Err(err) = release_point.signal() {
tracing::error!("Failed to signal syncobj release point: {}", err);
}
}
}
}
/// A wayland buffer
#[derive(Debug, Clone)]
pub struct Buffer {
inner: Arc<InnerBuffer>,
}
impl Buffer {
/// Create a buffer with implicit sync
pub fn with_implicit(buffer: WlBuffer) -> Self {
Self {
inner: Arc::new(InnerBuffer {
buffer,
#[cfg(feature = "backend_drm")]
acquire_point: None,
#[cfg(feature = "backend_drm")]
release_point: None,
}),
}
}
/// Create a buffer with explicit acquire and release sync points
#[cfg(feature = "backend_drm")]
pub fn with_explicit(buffer: WlBuffer, acquire_point: DrmSyncPoint, release_point: DrmSyncPoint) -> Self {
Self {
inner: Arc::new(InnerBuffer {
buffer,
acquire_point: Some(acquire_point),
release_point: Some(release_point),
}),
}
}
#[cfg(feature = "backend_drm")]
#[allow(dead_code)]
pub(crate) fn acquire_point(&self) -> Option<&DrmSyncPoint> {
self.inner.acquire_point.as_ref()
}
}
impl std::ops::Deref for Buffer {
type Target = WlBuffer;
#[inline]
fn deref(&self) -> &Self::Target {
&self.inner.buffer
}
}
impl PartialEq<WlBuffer> for Buffer {
#[inline]
fn eq(&self, other: &WlBuffer) -> bool {
self.inner.buffer == *other
}
}
impl PartialEq<WlBuffer> for &Buffer {
#[inline]
fn eq(&self, other: &WlBuffer) -> bool {
self.inner.buffer == *other
}
}
impl RendererSurfaceState {
#[profiling::function]
pub(crate) fn update_buffer(&mut self, states: &SurfaceData) {
#[cfg(feature = "backend_drm")]
let mut guard = states.cached_state.get::<DrmSyncobjCachedState>();
#[cfg(feature = "backend_drm")]
let syncobj_state = guard.current();
let mut guard = states.cached_state.get::<SurfaceAttributes>();
let attrs = guard.current();
let new_buffer = matches!(attrs.buffer, Some(BufferAssignment::NewBuffer(_)));
match attrs.buffer.take() {
Some(BufferAssignment::NewBuffer(buffer)) => {
self.buffer_dimensions = buffer_dimensions(&buffer);
if self.buffer_dimensions.is_none() {
// This results in us rendering nothing (can happen e.g. for failed egl-buffer-calls),
// but it is better than crashing the compositor for a bad buffer
self.reset();
return;
}
self.buffer_has_alpha = buffer_has_alpha(&buffer);
self.buffer_scale = attrs.buffer_scale;
self.buffer_transform = attrs.buffer_transform.into();
if !self.buffer.as_ref().is_some_and(|b| b == buffer) {
self.buffer = Some(Buffer {
inner: Arc::new(InnerBuffer {
buffer,
#[cfg(feature = "backend_drm")]
acquire_point: syncobj_state.acquire_point.take(),
#[cfg(feature = "backend_drm")]
release_point: syncobj_state.release_point.take(),
}),
});
}
self.textures.clear();
}
Some(BufferAssignment::Removed) => {
self.reset();
return;
}
None => {}
};
let Some(buffer_dimensions) = self.buffer_dimensions else {
// nothing to be done without a buffer
return;
};
let surface_size = buffer_dimensions.to_logical(self.buffer_scale, self.buffer_transform);
let surface_view = SurfaceView::from_states(states, surface_size, attrs.client_scale);
let surface_view_changed = self.surface_view.replace(surface_view) != Some(surface_view);
// if we received a new buffer also process the attached damage
if new_buffer {
let buffer_damage = attrs.damage.drain(..).flat_map(|dmg| {
match dmg {
Damage::Buffer(rect) => rect,
Damage::Surface(rect) => surface_view.rect_to_local(rect).to_i32_up().to_buffer(
self.buffer_scale,
self.buffer_transform,
&surface_size,
),
}
.intersection(Rectangle::from_size(buffer_dimensions))
});
self.damage.add(buffer_damage);
}
// if the buffer or our view changed rebuild our opaque regions
if new_buffer || surface_view_changed {
self.opaque_regions.clear();
if !self.buffer_has_alpha.unwrap_or(true) {
self.opaque_regions.push(Rectangle::from_size(surface_view.dst))
} else if let Some(region_attributes) = &attrs.opaque_region {
let opaque_regions = region_attributes
.rects
.iter()
.map(|(kind, rect)| {
let dest_size = surface_view.dst;
let rect_constrained_loc = rect.loc.constrain(Rectangle::from_size(dest_size));
let rect_clamped_size = rect
.size
.clamp((0, 0), (dest_size.to_point() - rect_constrained_loc).to_size());
let rect = Rectangle::new(rect_constrained_loc, rect_clamped_size);
(kind, rect)
})
.fold(
std::mem::take(&mut self.opaque_regions),
|mut new_regions, (kind, rect)| {
match kind {
RectangleKind::Add => {
let added_regions = rect.subtract_rects(
new_regions
.iter()
.filter(|region| region.overlaps_or_touches(rect))
.copied(),
);
new_regions.extend(added_regions);
}
RectangleKind::Subtract => {
new_regions =
Rectangle::subtract_rects_many_in_place(new_regions, [rect]);
}
}
new_regions
},
);
self.opaque_regions = opaque_regions;
}
}
}
/// Get the current commit position of this surface
///
/// The position should be saved after calling [`damage_since`](RendererSurfaceState::damage_since) and
/// provided as the commit in the next call.
pub fn current_commit(&self) -> CommitCounter {
self.damage.current_commit()
}
/// Gets the damage since the last commit
///
/// If either the commit is `None` or the commit is too old
/// the whole buffer will be returned as damage.
pub fn damage_since(&self, commit: Option<CommitCounter>) -> DamageSet<i32, BufferCoord> {
self.damage.damage_since(commit).unwrap_or_else(|| {
self.buffer_dimensions
.as_ref()
.map(|size| DamageSet::from_slice(&[Rectangle::from_size(*size)]))
.unwrap_or_default()
})
}
/// Gets the current damage of this surface
pub fn damage(&self) -> DamageSnapshot<i32, BufferCoord> {
self.damage.snapshot()
}
/// Returns the logical size of the current attached buffer
pub fn buffer_size(&self) -> Option<Size<i32, Logical>> {
self.buffer_dimensions
.as_ref()
.map(|dim| dim.to_logical(self.buffer_scale, self.buffer_transform))
}
/// Returns the scale of the current attached buffer
pub fn buffer_scale(&self) -> i32 {
self.buffer_scale
}
/// Returns the transform of the current attached buffer
pub fn buffer_transform(&self) -> Transform {
self.buffer_transform
}
/// Returns the logical size of the surface.
///
/// Note: The surface size may not be equal to the buffer size in case
/// a viewport has been attached to the surface.
pub fn surface_size(&self) -> Option<Size<i32, Logical>> {
self.surface_view.map(|view| view.dst)
}
/// Get the attached buffer.
/// Can be used to check if surface is mapped
pub fn buffer(&self) -> Option<&Buffer> {
self.buffer.as_ref()
}
/// Gets a reference to the texture for the specified renderer context
pub fn texture<T>(&self, id: ContextId<T>) -> Option<&T>
where
T: Texture + 'static,
{
self.textures.get(&id.erased()).and_then(|e| e.downcast_ref())
}
/// Gets the opaque regions of this surface
pub fn opaque_regions(&self) -> Option<&[Rectangle<i32, Logical>]> {
// If the surface is unmapped there can be no opaque regions
self.surface_size()?;
// To make it easier for upstream, but to no re-allocate a
// new vec if the opaque regions change for return None
// on empty regions
if self.opaque_regions.is_empty() {
return None;
}
Some(&self.opaque_regions[..])
}
/// Gets the [`SurfaceView`] of this surface
pub fn view(&self) -> Option<SurfaceView> {
self.surface_view
}
fn reset(&mut self) {
self.buffer_dimensions = None;
self.buffer = None;
self.textures.clear();
self.damage.reset();
self.surface_view = None;
self.buffer_has_alpha = None;
self.opaque_regions.clear();
}
}
/// Handler to let smithay take over buffer management.
///
/// Needs to be called first on the commit-callback of
/// [`crate::wayland::compositor::CompositorHandler::commit`].
///
/// Consumes the buffer of [`SurfaceAttributes`], the buffer will
/// not be accessible anymore, but [`draw_render_elements`] and other
/// `draw_*` helpers of the [desktop module](`crate::desktop`) will
/// become usable for surfaces handled this way.
#[profiling::function]
pub fn on_commit_buffer_handler<D: 'static>(surface: &WlSurface) {
if !is_sync_subsurface(surface) {
let mut new_surfaces = Vec::new();
with_surface_tree_upward(
surface,
(),
|_, _, _| TraversalAction::DoChildren(()),
|surf, states, _| {
if states
.data_map
.insert_if_missing_threadsafe(|| Mutex::new(RendererSurfaceState::default()))
{
new_surfaces.push(surf.clone());
}
let mut data = states
.data_map
.get::<RendererSurfaceStateUserData>()
.unwrap()
.lock()
.unwrap();
data.update_buffer(states);
},
|_, _, _| true,
);
for surf in &new_surfaces {
add_destruction_hook(surf, |_: &mut D, surface| {
// We reset the state on destruction before the user_data is dropped
// to prevent a deadlock which can happen if we try to send a buffer
// release during drop. This also enables us to free resources earlier
// like the stored textures
compositor::with_states(surface, |data| {
if let Some(mut state) = data
.data_map
.get::<RendererSurfaceStateUserData>()
.map(|s| s.lock().unwrap())
{
state.reset();
}
});
});
}
}
}
impl SurfaceView {
fn from_states(states: &SurfaceData, surface_size: Size<i32, Logical>, client_scale: f64) -> SurfaceView {
viewporter::ensure_viewport_valid(states, surface_size);
let mut viewport_state = states.cached_state.get::<viewporter::ViewportCachedState>();
let viewport = viewport_state.current();
let src = viewport
.src
.unwrap_or_else(|| Rectangle::from_size(surface_size.to_f64()));
let dst = viewport.size().unwrap_or(
surface_size
.to_f64()
.to_client(1.)
.to_logical(client_scale)
.to_i32_round(),
);
let offset = if states.role == Some("subsurface") {
states
.cached_state
.get::<SubsurfaceCachedState>()
.current()
.location
} else {
Default::default()
};
SurfaceView { src, dst, offset }
}
pub(crate) fn rect_to_global<N>(&self, rect: Rectangle<N, Logical>) -> Rectangle<f64, Logical>
where
N: Coordinate,
{
let scale = self.scale();
let mut rect = rect.to_f64();
rect.loc -= self.src.loc;
rect.upscale(scale)
}
pub(crate) fn rect_to_local<N>(&self, rect: Rectangle<N, Logical>) -> Rectangle<f64, Logical>
where
N: Coordinate,
{
let scale = self.scale();
let mut rect = rect.to_f64().downscale(scale);
rect.loc += self.src.loc;
rect
}
fn scale(&self) -> Scale<f64> {
Scale::from((
self.dst.w as f64 / self.src.size.w,
self.dst.h as f64 / self.src.size.h,
))
}
}
/// Access the buffer related states associated to this surface
///
/// Calls [`compositor::with_states`] internally.
///
/// Returns `None`, if there never was a commit processed through `on_commit_buffer_handler`.
pub fn with_renderer_surface_state<F, T>(surface: &WlSurface, cb: F) -> Option<T>
where
F: FnOnce(&mut RendererSurfaceState) -> T,
{
compositor::with_states(surface, |states| {
let data = states.data_map.get::<RendererSurfaceStateUserData>()?;
Some(cb(&mut data.lock().unwrap()))
})
}
/// Imports buffers of a surface using a given [`Renderer`]
///
/// This (or `import_surface_tree`) need to be called before`draw_render_elements`, if used later.
///
/// Note: This will do nothing, if you are not using
/// [`crate::backend::renderer::utils::on_commit_buffer_handler`]
/// to let smithay handle buffer management.
#[instrument(level = "trace", skip_all)]
#[profiling::function]
pub fn import_surface<R>(renderer: &mut R, states: &SurfaceData) -> Result<(), R::Error>
where
R: Renderer + ImportAll,
R::TextureId: 'static,
{
if let Some(data) = states.data_map.get::<RendererSurfaceStateUserData>() {
let context_id = renderer.context_id().erased();
let mut data_ref = data.lock().unwrap();
let data = &mut *data_ref;
let last_commit = data.renderer_seen.get(&context_id);
let buffer_damage = data.damage_since(last_commit.copied());
if let Entry::Vacant(e) = data.textures.entry(context_id.clone()) {
if let Some(buffer) = data.buffer.as_ref() {
// There is no point in importing a single pixel buffer
if matches!(
crate::backend::renderer::buffer_type(buffer),
Some(crate::backend::renderer::BufferType::SinglePixel)
) {
return Ok(());
}
match renderer.import_buffer(buffer, Some(states), &buffer_damage) {
Some(Ok(m)) => {
e.insert(Box::new(m));
data.renderer_seen.insert(context_id, data.current_commit());
}
Some(Err(err)) => {
warn!("Error loading buffer: {}", err);
return Err(err);
}
None => {
error!("Unknown buffer format for: {:?}", buffer);
}
}
}
}
}
Ok(())
}
/// Imports buffers of a surface and its subsurfaces using a given [`Renderer`].
///
/// This (or `import_surface`) need to be called before `draw_render_elements`, if used later.
///
/// Note: This will do nothing, if you are not using
/// [`crate::backend::renderer::utils::on_commit_buffer_handler`]
/// to let smithay handle buffer management.
#[instrument(level = "trace", skip_all)]
#[profiling::function]
pub fn import_surface_tree<R>(renderer: &mut R, surface: &WlSurface) -> Result<(), R::Error>
where
R: Renderer + ImportAll,
R::TextureId: 'static,
{
let scale = 1.0;
let location: Point<f64, Physical> = (0.0, 0.0).into();
let mut result = Ok(());
with_surface_tree_downward(
surface,
location,
|_surface, states, location| {
let mut location = *location;
// Import a new buffer if necessary
if let Err(err) = import_surface(renderer, states) {
result = Err(err);
}
if let Some(data) = states.data_map.get::<RendererSurfaceStateUserData>() {
let mut data_ref = data.lock().unwrap();
let data = &mut *data_ref;
// Now, should we be drawn ?
if data.textures.contains_key(&renderer.context_id().erased()) {
// if yes, also process the children
let surface_view = data.surface_view.unwrap();
location += surface_view.offset.to_f64().to_physical(scale);
TraversalAction::DoChildren(location)
} else {
// we are not displayed, so our children are neither
TraversalAction::SkipChildren
}
} else {
// we are not displayed, so our children are neither
TraversalAction::SkipChildren
}
},
|_, _, _| {},
|_, _, _| true,
);
result
}
/// Draws the render elements using a given [`Renderer`] and [`Frame`](crate::backend::renderer::Frame)
///
/// - `scale` needs to be equivalent to the fractional scale the rendered result should have.
/// - `location` is the position the surface should be drawn at.
/// - `damage` is the set of regions that should be drawn relative to the same origin as the location.
///
/// Note: This element will render nothing, if you are not using
/// [`crate::backend::renderer::utils::on_commit_buffer_handler`]
/// to let smithay handle buffer management.
#[instrument(level = "trace", skip(frame, scale, elements))]
#[profiling::function]
pub fn draw_render_elements<R, S, E>(
frame: &mut R::Frame<'_, '_>,
scale: S,
elements: &[E],
damage: &[Rectangle<i32, Physical>],
) -> Result<Option<Vec<Rectangle<i32, Physical>>>, R::Error>
where
R: Renderer,
R::TextureId: 'static,
S: Into<Scale<f64>>,
E: RenderElement<R>,
{
let scale = scale.into();
let mut render_elements: Vec<&E> = Vec::with_capacity(elements.len());
let mut opaque_regions: Vec<Rectangle<i32, Physical>> = Vec::new();
let mut render_damage: Vec<Rectangle<i32, Physical>> = Vec::with_capacity(damage.len());
for element in elements {
let element_geometry = element.geometry(scale);
// Then test if the element is completely hidden behind opaque regions
let is_hidden = element_geometry
.subtract_rects(opaque_regions.iter().copied())
.is_empty();
if is_hidden {
// No need to draw a completely hidden element
continue;
}
render_damage.extend(Rectangle::subtract_rects_many(
damage.iter().copied(),
opaque_regions.iter().copied(),
));
opaque_regions.extend(element.opaque_regions(scale).into_iter().map(|mut region| {
region.loc += element_geometry.loc;
region
}));
render_elements.insert(0, element);
}
// Optimize the damage for rendering
render_damage.dedup();
render_damage.retain(|rect| !rect.is_empty());
// filter damage outside of the output gep and merge overlapping rectangles
render_damage = render_damage
.into_iter()
.fold(Vec::new(), |new_damage, mut rect| {
// replace with drain_filter, when that becomes stable to reuse the original Vec's memory
let (overlapping, mut new_damage): (Vec<_>, Vec<_>) = new_damage
.into_iter()
.partition(|other| other.overlaps_or_touches(rect));
for overlap in overlapping {
rect = rect.merge(overlap);
}
new_damage.push(rect);
new_damage
});
if render_damage.is_empty() {
return Ok(None);
}
for element in render_elements.iter() {
let element_geometry = element.geometry(scale);
let element_damage = damage
.iter()
.filter_map(|d| d.intersection(element_geometry))
.map(|mut d| {
d.loc -= element_geometry.loc;
d
})
.collect::<Vec<_>>();
if element_damage.is_empty() {
continue;
}
element.draw(frame, element.src(), element_geometry, &element_damage, &[])?;
}
Ok(Some(render_damage))
}