picom/src/backend/backend.c

// SPDX-License-Identifier: MPL-2.0
// Copyright (c) Yuxuan Shui <yshuiv7@gmail.com>
#include <xcb/xcb.h>

#include "backend.h"
#include "common.h"
#include "compiler.h"
#include "config.h"
#include "region.h"
#include "win.h"
#include "log.h"

backend_init_fn backend_list[NUM_BKEND] = {
    [BKEND_XRENDER] = backend_xrender_init,
#ifdef CONFIG_OPENGL
    [BKEND_GLX] = backend_glx_init,
#endif
};

region_t get_damage(session_t *ps) {
	region_t region;
	auto buffer_age_fn = ps->backend_data->ops->buffer_age;
	int buffer_age = buffer_age_fn ? buffer_age_fn(ps->backend_data) : -1;

	pixman_region32_init(&region);
	if (buffer_age == -1 || buffer_age > ps->ndamage) {
		pixman_region32_copy(&region, &ps->screen_reg);
	} else {
		for (int i = 0; i < buffer_age; i++) {
			const int curr = ((ps->damage - ps->damage_ring) + i) % ps->ndamage;
			pixman_region32_union(&region, &region, &ps->damage_ring[curr]);
		}
		pixman_region32_intersect(&region, &region, &ps->screen_reg);
	}
	return region;
}

/// paint all windows
void paint_all_new(session_t *ps, win *const t, bool ignore_damage) {
	region_t region;
	if (!ignore_damage) {
		region = get_damage(ps);
	} else {
		pixman_region32_init(&region);
		pixman_region32_copy(&region, &ps->screen_reg);
	}

	if (!pixman_region32_not_empty(&region)) {
		pixman_region32_fini(&region);
		return;
	}

#ifdef DEBUG_REPAINT
	static struct timespec last_paint = {0};
#endif

	region_t reg_tmp;
	const region_t *reg_paint;
	pixman_region32_init(&reg_tmp);
	if (t) {
		// Calculate the region upon which the root window (wallpaper) is to be
		// painted based on the ignore region of the lowest window, if available
		pixman_region32_subtract(&reg_tmp, &region, t->reg_ignore);
		reg_paint = &reg_tmp;
	} else {
		reg_paint = &region;
	}

	// TODO Bind root pixmap

	if (ps->backend_data->ops->prepare) {
		ps->backend_data->ops->prepare(ps->backend_data, reg_paint);
	}

	if (ps->root_image) {
		ps->backend_data->ops->compose(ps->backend_data, ps->root_image, 0, 0,
		                               reg_paint);
	}

	// Windows are sorted from bottom to top
	// Each window has a reg_ignore, which is the region obscured by all the windows
	// on top of that window. This is used to reduce the number of pixels painted.
	//
	// Whether this is beneficial is to be determined XXX
	for (win *w = t; w; w = w->prev_trans) {
		// Calculate the region based on the reg_ignore of the next (higher)
		// window and the bounding region
		// XXX XXX
		pixman_region32_subtract(&reg_tmp, &region, w->reg_ignore);

		if (!pixman_region32_not_empty(&reg_tmp)) {
			continue;
		}

		auto reg_bound = win_get_bounding_shape_global_by_val(w);
		// Draw shadow on target
		if (w->shadow) {
			auto reg_shadow = win_extents_by_val(w);
			pixman_region32_intersect(&reg_shadow, &reg_shadow, &reg_tmp);

			if (!ps->o.wintype_option[w->window_type].full_shadow) {
				pixman_region32_subtract(&reg_shadow, &reg_shadow, &reg_bound);
			}

			// Mask out the region we don't want shadow on
			if (pixman_region32_not_empty(&ps->shadow_exclude_reg)) {
				pixman_region32_subtract(&reg_tmp, &reg_tmp,
				                         &ps->shadow_exclude_reg);
			}

			if (ps->o.xinerama_shadow_crop && w->xinerama_scr >= 0 &&
			    w->xinerama_scr < ps->xinerama_nscrs) {
				// There can be a window where number of screens is
				// updated, but the screen number attached to the windows
				// have not.
				//
				// Window screen number will be updated eventually, so
				// here we just check to make sure we don't access out of
				// bounds.
				pixman_region32_intersect(
				    &reg_shadow, &reg_shadow,
				    &ps->xinerama_scr_regs[w->xinerama_scr]);
			}

			assert(w->shadow_image);
			ps->backend_data->ops->compose(ps->backend_data, w->shadow_image,
			                               w->g.x + w->shadow_dx,
			                               w->g.y + w->shadow_dy, &reg_shadow);
			pixman_region32_fini(&reg_shadow);
		}

		pixman_region32_intersect(&reg_tmp, &reg_tmp, &reg_bound);
		pixman_region32_fini(&reg_bound);
		if (!pixman_region32_not_empty(&reg_tmp)) {
			continue;
		}
		// Blur window background
		bool win_transparent = ps->backend_data->ops->is_image_transparent(
		    ps->backend_data, w->win_image);
		bool frame_transparent = w->frame_opacity != 1;
		if (w->blur_background &&
		    (win_transparent || (ps->o.blur_background_frame && frame_transparent))) {
			// Minimize the region we try to blur, if the window
			// itself is not opaque, only the frame is.
			if (win_is_solid(ps, w)) {
				region_t reg_blur;
				pixman_region32_init(&reg_blur);
				win_get_region_noframe_local(w, &reg_blur);
				pixman_region32_translate(&reg_blur, w->g.x, w->g.y);
				pixman_region32_subtract(&reg_blur, &reg_tmp, &reg_blur);
				ps->backend_data->ops->blur(ps->backend_data, w->opacity,
				                            &reg_blur);
				pixman_region32_fini(&reg_blur);
			} else {
				ps->backend_data->ops->blur(ps->backend_data, w->opacity,
				                            &reg_tmp);
			}
		}
		// Draw window on target
		if (!w->invert_color && !w->dim && w->frame_opacity == 1 && w->opacity == 1) {
			ps->backend_data->ops->compose(ps->backend_data, w->win_image,
			                               w->g.x, w->g.y, &reg_tmp);
		} else {
			region_t reg_local;
			pixman_region32_init(&reg_local);
			pixman_region32_copy(&reg_local, &reg_tmp);
			pixman_region32_translate(&reg_local, -w->g.x, -w->g.y);
			auto new_img = ps->backend_data->ops->copy(
			    ps->backend_data, w->win_image, &reg_local);
			if (w->invert_color) {
				ps->backend_data->ops->image_op(ps->backend_data,
				                                IMAGE_OP_INVERT_COLOR,
				                                new_img, &reg_local, NULL);
			}
			if (w->dim) {
				double dim_opacity = ps->o.inactive_dim;
				if (!ps->o.inactive_dim_fixed) {
					dim_opacity *= w->opacity;
				}
				ps->backend_data->ops->image_op(
				    ps->backend_data, IMAGE_OP_DIM, new_img, &reg_local,
				    (double[]){dim_opacity});
			}
			if (w->frame_opacity != 1) {
				auto reg_frame = win_get_region_noframe_local_by_val(w);
				pixman_region32_subtract(&reg_frame, &reg_local, &reg_frame);
				ps->backend_data->ops->image_op(
				    ps->backend_data, IMAGE_OP_APPLY_ALPHA, new_img,
				    &reg_frame, (double[]){w->frame_opacity});
			}
			if (w->opacity != 1) {
				ps->backend_data->ops->image_op(
				    ps->backend_data, IMAGE_OP_APPLY_ALPHA, new_img, NULL,
				    (double[]){w->opacity});
			}
			ps->backend_data->ops->compose(ps->backend_data, new_img, w->g.x,
			                               w->g.y, &reg_tmp);
			ps->backend_data->ops->release_image(ps->backend_data, new_img);
		}
	}

	// Free up all temporary regions
	pixman_region32_fini(&reg_tmp);

	if (ps->backend_data->ops->present) {
		// Present the rendered scene
		// Vsync is done here
		ps->backend_data->ops->present(ps->backend_data);
	}

#ifdef DEBUG_REPAINT
	print_timestamp(ps);
	struct timespec now = get_time_timespec();
	struct timespec diff = {0};
	timespec_subtract(&diff, &now, &last_paint);
	printf("[ %5ld:%09ld ] ", diff.tv_sec, diff.tv_nsec);
	last_paint = now;
	printf("paint:");
	for (win *w = t; w; w = w->prev_trans)
		printf(" %#010lx", w->id);
	putchar('\n');
	fflush(stdout);
#endif

	// Check if fading is finished on all painted windows
	win *pprev = NULL;
	for (win *w = t; w; w = pprev) {
		pprev = w->prev_trans;
		win_check_fade_finished(ps, &w);
	}
}

// vim: set noet sw=8 ts=8 :