Merge branch 'next' into implement-window-animations

Author: dccsillag

.github/workflows/codeql-analysis.yml

@@ -36,7 +36,7 @@ jobs:
         languages: ${{ matrix.language }}
 
     # Install dependencies
-    - run: sudo apt install libxext-dev libxcb1-dev libxcb-damage0-dev libxcb-xfixes0-dev libxcb-shape0-dev libxcb-render-util0-dev libxcb-render0-dev libxcb-randr0-dev libxcb-composite0-dev libxcb-image0-dev libxcb-present-dev libxcb-xinerama0-dev libxcb-glx0-dev libpixman-1-dev libdbus-1-dev libconfig-dev libgl1-mesa-dev  libpcre2-dev  libevdev-dev uthash-dev libev-dev libx11-xcb-dev meson ninja-build
+    - run: sudo apt update && sudo apt install libxext-dev libxcb1-dev libxcb-damage0-dev libxcb-xfixes0-dev libxcb-shape0-dev libxcb-render-util0-dev libxcb-render0-dev libxcb-randr0-dev libxcb-composite0-dev libxcb-image0-dev libxcb-present-dev libxcb-xinerama0-dev libxcb-glx0-dev libpixman-1-dev libdbus-1-dev libconfig-dev libgl1-mesa-dev  libpcre2-dev  libevdev-dev uthash-dev libev-dev libx11-xcb-dev meson ninja-build
       if: ${{ matrix.language == 'cpp' }}
 
     # Autobuild

README_orig.md History.md

@@ -1,5 +1,38 @@
+# Picom History
+
+Picom was forked in 2016 from the original Compton because it seemed to have become unmaintained.
+
+The battle plan of the fork was to refactor it to make the code _possible_ to maintain, so potential contributors won't be scared away when they take a look at the code.
+
+And also to try to fix bugs.
+
+## Rename
+
+In 2019 the project name was changed from Compton to picom (git revision 8ddbeb and following).
+
+### Rationale
+
+Since the inception of this fork, the existence of two compton repositories has caused some number of confusions. Mainly, people will report issues of this fork to the original compton, or report issues of the original compton here. Later, when distros started packaging this fork of compton, some wanted to differentiate the newer compton from the older version. They found themselves having no choice but to invent a name for this fork. This is less than ideal since this has the potential to cause more confusions among users.
+
+Therefore, we decided to move this fork to a new name. Personally, I consider this more than justified since this version of compton has gone through significant changes since it was forked.
+
+### The name
+
+The criteria for a good name were
+
+0. Being short, so it's easy to remember.
+1. Pronounceability, again, helps memorability
+2. Searchability, so when people search the name, it's easy for them to find this repository.
+
+Of course, choosing a name is never easy, and there is no apparent way to objectively evaluate the names. Yet, we have to solve the aforementioned problems as soon as possible.
+
+In the end, we picked `picom` (a portmanteau of `pico` and `composite`) as our new name. This name might not be perfect, but is what we will move forward with unless there's a compelling reason not to.
+
+
 # Compton
 
+This is a copy of the README of the [original Compton project](https://github.com/chjj/compton/).
+
 [![Join the chat at https://gitter.im/chjj/compton](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/chjj/compton?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 __Compton__ is a compositor for X, and a fork of __xcompmgr-dana__.

README.md

@@ -1,17 +1,11 @@
 picom
-=======
+=====
 
-**This is a development branch, bugs to be expected**
-
-This is forked from the original Compton because it seems to have become unmaintained.
-
-The current battle plan of this fork is to refactor it to make the code _possible_ to maintain, so potential contributors won't be scared away when they take a look at the code.
+__picom__ is a compositor for X, and a [fork of Compton](History.md).
 
-We also try to fix bugs.
-
-You can leave your feedbacks or thoughts in the [discussion tab](https://github.com/yshui/picom/discussions).
+**This is a development branch, bugs to be expected**
 
-The original README can be found [here](README_orig.md)
+You can leave your feedback or thoughts in the [discussion tab](https://github.com/yshui/picom/discussions).
 
 ## Call for testers
 
@@ -27,36 +21,6 @@ To test the new backends, add the `--experimental-backends` flag to the command
 
 To report issues with the new backends, please state explicitly you are using the new backends in your report.
 
-## Rename
-
-### Rationale
-
-Since the inception of this fork, the existence of two compton repositories has caused some number of confusions. Mainly, people will report issues of this fork to the original compton, or report issues of the original compton here. Later, when distros started packaging this fork of compton, some wanted to differentiate the newer compton from the older version. They found themselves having no choice but to invent a name for this fork. This is less than ideal since this has the potential to cause more confusions among users.
-
-Therefore, we decided to move this fork to a new name. Personally, I consider this more than justified since this version of compton has gone through significant changes since it was forked.
-
-### The name
-
-The criteria for a good name were
-
-0. Being short, so it's easy to remember.
-1. Pronounceability, again, helps memorability
-2. Searchability, so when people search the name, it's easy for them to find this repository.
-
-Of course, choosing a name is never easy, and there is no apparent way to objectively evaluate the names. Yet, we have to solve the aforementioned problems as soon as possible.
-
-In the end, we picked `picom` (a portmanteau of `pico` and `composite`) as our new name. This name might not be perfect, but is what we will move forward with unless there's a compelling reason not to.
-
-### Migration
-
-Following the [deprecation process](https://github.com/yshui/picom/issues/114), migration to the new name will be broken into 3 steps:
-
-1. All mentions of `compton` will be updated to `picom` in the code base. `compton` will still be installed, but only as a symlink to `picom`. When `picom` is launched via the symlink, a warning message is printed, alerting the user to migrate. Similarly, the old configuration file names and dbus interface names will still be accepted but warned.
-2. 3 major releases after step 1, the warning messages will be prompted to error messages and `picom` will not start when launched via the symlink.
-3. 3 major releases after step 2, the symlink will be removed.
-
-The dbus interface and service names are unchanged, so no migration needed for that.
-
 ## Change Log
 
 See [Releases](https://github.com/yshui/picom/releases)
@@ -153,3 +117,10 @@ Contributions to the documents and wiki will also be appreciated.
 ## Contributors
 
 See [CONTRIBUTORS](CONTRIBUTORS)
+
+The README for the [original Compton project](https://github.com/chjj/compton/) can be found [here](History.md#Compton).
+
+## Licensing
+
+picom is free software, made available under the [MIT](LICENSES/MIT) and [MPL-2.0](LICENSES/MPL-2.0) software
+licenses. See the individual source files for details.

meson.build

@@ -1,4 +1,4 @@
-project('picom', 'c', version: '8',
+project('picom', 'c', version: '9',
         default_options: ['c_std=c11'])
 
 cc = meson.get_compiler('c')

meson/install.sh

@@ -203,6 +203,9 @@ blur-background-exclude = [
 #       General Settings        #
 #################################
 
+# Enable remote control via D-Bus. See the man page for more details.
+# dbus = true
+
 # Daemonize process. Fork to background after initialization. Causes issues with certain (badly-written) drivers.
 # daemon = false
 

picom.sample.conf

@@ -102,8 +102,37 @@ static void process_window_for_painting(session_t *ps, struct managed_win *w,
 	pixman_region32_fini(&reg_visible_local);
 }
 
+void handle_device_reset(session_t *ps) {
+	log_error("Device reset detected");
+	// Wait for reset to complete
+	// Although ideally the backend should return DEVICE_STATUS_NORMAL after a reset
+	// is completed, it's not always possible.
+	//
+	// According to ARB_robustness (emphasis mine):
+	//
+	//     "If a reset status other than NO_ERROR is returned and subsequent
+	//     calls return NO_ERROR, the context reset was encountered and
+	//     completed. If a reset status is repeatedly returned, the context **may**
+	//     be in the process of resetting."
+	//
+	//  Which means it may also not be in the process of resetting. For example on
+	//  AMDGPU devices, Mesa OpenGL always return CONTEXT_RESET after a reset has
+	//  started, completed or not.
+	//
+	//  So here we blindly wait 5 seconds and hope ourselves best of the luck.
+	sleep(5);
+
+	// Reset picom
+	log_info("Resetting picom after device reset");
+	ev_break(ps->loop, EVBREAK_ALL);
+}
+
 /// paint all windows
 void paint_all_new(session_t *ps, struct managed_win *t, bool ignore_damage) {
+	if (ps->backend_data->ops->device_status &&
+	    ps->backend_data->ops->device_status(ps->backend_data) != DEVICE_STATUS_NORMAL) {
+		return handle_device_reset(ps);
+	}
 	if (ps->o.xrender_sync_fence) {
 		if (ps->xsync_exists && !x_fence_sync(ps->c, ps->sync_fence)) {
 			log_error("x_fence_sync failed, xrender-sync-fence will be "

src/backend/backend.c

@@ -32,6 +32,15 @@ typedef struct backend_base {
 
 typedef void (*backend_ready_callback_t)(void *);
 
+// This mimics OpenGL's ARB_robustness extension, which enables detection of GPU context
+// resets.
+// See: https://www.khronos.org/registry/OpenGL/extensions/ARB/ARB_robustness.txt, section
+// 2.6 "Graphics Reset Recovery".
+enum device_status {
+	DEVICE_STATUS_NORMAL,
+	DEVICE_STATUS_RESETTING,
+};
+
 // When image properties are actually applied to the image, they are applied in a
 // particular order:
 //
@@ -275,6 +284,8 @@ struct backend_operations {
 	enum driver (*detect_driver)(backend_t *backend_data);
 
 	void (*diagnostics)(backend_t *backend_data);
+
+	enum device_status (*device_status)(backend_t *backend_data);
 };
 
 extern struct backend_operations *backend_list[];

src/backend/backend.h

@@ -395,7 +395,11 @@ static void _gl_compose(backend_t *base, struct backend_image *img, GLuint targe
 		glUniform1f(gd->win_shader.uniform_corner_radius, (float)img->corner_radius);
 	}
 	if (gd->win_shader.uniform_border_width >= 0) {
-		glUniform1f(gd->win_shader.uniform_border_width, (float)img->border_width);
+		auto border_width = img->border_width;
+		if (border_width > img->corner_radius) {
+			border_width = 0;
+		}
+		glUniform1f(gd->win_shader.uniform_border_width, (float)border_width);
 	}
 
 	// log_trace("Draw: %d, %d, %d, %d -> %d, %d (%d, %d) z %d\n",
@@ -1554,23 +1558,32 @@ const char *win_shader_glsl = GLSL(330,
 		vec4 border_color = texture(tex, vec2(0.0, 0.5));
 		if (invert_color) {
 			c = vec4(c.aaa - c.rgb, c.a);
+			border_color = vec4(border_color.aaa - border_color.rgb, border_color.a);
 		}
 		c = vec4(c.rgb * (1.0 - dim), c.a) * opacity;
+		border_color = vec4(border_color.rgb * (1.0 - dim), border_color.a) * opacity;
 
 		vec3 rgb_brightness = texelFetch(brightness, ivec2(0, 0), 0).rgb;
 		// Ref: https://en.wikipedia.org/wiki/Relative_luminance
 		float brightness = rgb_brightness.r * 0.21 +
 		                   rgb_brightness.g * 0.72 +
 		                   rgb_brightness.b * 0.07;
-		if (brightness > max_brightness)
+		if (brightness > max_brightness) {
 			c.rgb = c.rgb * (max_brightness / brightness);
+			border_color.rgb = border_color.rgb * (max_brightness / brightness);
+		}
+
+		// Rim color is the color of the outer rim of the window, if there is no
+		// border, it's the color of the window itself, otherwise it's the border.
+		// Using mix() to avoid a branch here.
+		vec4 rim_color = mix(c, border_color, clamp(border_width, 0.0f, 1.0f));
 
 		vec2 outer_size = vec2(textureSize(tex, 0));
 		vec2 inner_size = outer_size - vec2(corner_radius) * 2.0f;
 		float rect_distance = rectangle_sdf(texcoord - outer_size / 2.0f,
 		    inner_size / 2.0f) - corner_radius;
 		if (rect_distance > 0.0f) {
-			c = (1.0f - clamp(rect_distance, 0.0f, 1.0f)) * border_color;
+			c = (1.0f - clamp(rect_distance, 0.0f, 1.0f)) * rim_color;
 		} else {
 			float factor = clamp(rect_distance + border_width, 0.0f, 1.0f);
 			c = (1.0f - factor) * c + factor * border_color;
@@ -1702,6 +1715,7 @@ bool gl_init(struct gl_data *gd, session_t *ps) {
 	} else {
 		gd->is_nvidia = false;
 	}
+	gd->has_robustness = gl_has_extension("GL_ARB_robustness");
 
 	return true;
 }
@@ -1916,3 +1930,15 @@ bool gl_image_op(backend_t *base, enum image_operations op, void *image_data,
 
 	return true;
 }
+
+enum device_status gl_device_status(backend_t *base) {
+	auto gd = (struct gl_data *)base;
+	if (!gd->has_robustness) {
+		return DEVICE_STATUS_NORMAL;
+	}
+	if (glGetGraphicsResetStatusARB() == GL_NO_ERROR) {
+		return DEVICE_STATUS_NORMAL;
+	} else {
+		return DEVICE_STATUS_RESETTING;
+	}
+}

src/backend/gl/gl_common.c

@@ -75,6 +75,8 @@ struct gl_data {
 	backend_t base;
 	// If we are using proprietary NVIDIA driver
 	bool is_nvidia;
+	// If ARB_robustness extension is present
+	bool has_robustness;
 	// Height and width of the root window
 	int height, width;
 	gl_win_shader_t win_shader;
@@ -133,6 +135,7 @@ void gl_fill(backend_t *base, struct color, const region_t *clip);
 
 void gl_present(backend_t *base, const region_t *);
 bool gl_read_pixel(backend_t *base, void *image_data, int x, int y, struct color *output);
+enum device_status gl_device_status(backend_t *base);
 
 static inline void gl_delete_texture(GLuint texture) {
 	glDeleteTextures(1, &texture);

src/backend/gl/gl_common.h

@@ -302,16 +302,21 @@ static backend_t *glx_init(session_t *ps) {
 			continue;
 		}
 
-		gd->ctx = glXCreateContextAttribsARB(ps->dpy, cfg[i], 0, true,
-		                                     (int[]){
-		                                         GLX_CONTEXT_MAJOR_VERSION_ARB,
-		                                         3,
-		                                         GLX_CONTEXT_MINOR_VERSION_ARB,
-		                                         3,
-		                                         GLX_CONTEXT_PROFILE_MASK_ARB,
-		                                         GLX_CONTEXT_CORE_PROFILE_BIT_ARB,
-		                                         0,
-		                                     });
+		int *attributes = (int[]){GLX_CONTEXT_MAJOR_VERSION_ARB,
+		                          3,
+		                          GLX_CONTEXT_MINOR_VERSION_ARB,
+		                          3,
+		                          GLX_CONTEXT_PROFILE_MASK_ARB,
+		                          GLX_CONTEXT_CORE_PROFILE_BIT_ARB,
+		                          0,
+		                          0,
+		                          0};
+		if (glxext.has_GLX_ARB_create_context_robustness) {
+			attributes[6] = GLX_CONTEXT_RESET_NOTIFICATION_STRATEGY_ARB;
+			attributes[7] = GLX_LOSE_CONTEXT_ON_RESET_ARB;
+		}
+
+		gd->ctx = glXCreateContextAttribsARB(ps->dpy, cfg[i], 0, true, attributes);
 		free(cfg);
 
 		if (!gd->ctx) {
@@ -541,6 +546,7 @@ struct backend_operations glx_ops = {
     .destroy_blur_context = gl_destroy_blur_context,
     .get_blur_size = gl_get_blur_size,
     .diagnostics = glx_diagnostics,
+    .device_status = gl_device_status,
     .max_buffer_age = 5,        // Why?
 };
 
@@ -608,6 +614,7 @@ void glxext_init(Display *dpy, int screen) {
 	check_ext(GLX_EXT_texture_from_pixmap);
 	check_ext(GLX_ARB_create_context);
 	check_ext(GLX_EXT_buffer_age);
+	check_ext(GLX_ARB_create_context_robustness);
 #ifdef GLX_MESA_query_renderer
 	check_ext(GLX_MESA_query_renderer);
 #endif

src/backend/gl/glx.c

@@ -55,6 +55,7 @@ struct glxext_info {
 	bool has_GLX_ARB_create_context;
 	bool has_GLX_EXT_buffer_age;
 	bool has_GLX_MESA_query_renderer;
+	bool has_GLX_ARB_create_context_robustness;
 };
 
 extern struct glxext_info glxext;