Add foreground blurring (Privacy and Focus modes) #765

dshoreman · 2022-01-23T16:28:53Z

Continuation/revival of #490 by @rajansaini691; see that PR for more background.

Differences in this PR:

Dropped merge commit, squashed formatting fixes
Rebased onto latest next branch, resolved conflicts
Added --inactive-blur-include option (see below)
Added --inactive-blur-opacity
Utilised the blur_foreground property (added but unused in original PR)
Avoids blurring background and foreground of the same window to boost speed

Option Rationale

Comments in the original PR called for an exclusion list to be added, but I couldn't see how that would be useful so opted for the inverse.
Doing it this way allows for two different behaviours - either "privacy" or "focus" mode.

Focus Mode
The easiest option, this will blur all inactive windows:
```
inactive-blur = true;
```

Privacy Mode
Combining both options will only blur windows defined in --inactive-blur-list.
This can be useful for hiding sensitive data, eg communication or banking apps:

inactive-blur = true;
inactive-blur-include = [
    "class_g = 'discord'",
    "name *= '- Gmail -'",
    "class_g = 'Signal'",
    "class_g = 'TelegramDesktop'",
];

Closes #489

codecov · 2022-01-23T16:31:39Z

Codecov Report

Merging #765 (cda8ca4) into next (05ef18d) will increase coverage by 1.28%.
The diff coverage is 36.00%.

❗ Current head cda8ca4 differs from pull request most recent head 45dc995. Consider uploading reports for the commit 45dc995 to get more accurate results

@@            Coverage Diff             @@
##             next     #765      +/-   ##
==========================================
+ Coverage   37.74%   39.02%   +1.28%     
==========================================
  Files          48       46       -2     
  Lines       10869     9681    -1188     
==========================================
- Hits         4102     3778     -324     
+ Misses       6767     5903     -864

Impacted Files	Coverage Δ
src/config.c	`42.74% <ø> (-8.53%)`	⬇️
src/config.h	`23.52% <ø> (ø)`
src/options.c	`21.09% <0.00%> (+1.89%)`	⬆️
src/render.c	`4.08% <0.00%> (+2.77%)`	⬆️
src/win.h	`78.12% <ø> (ø)`
src/config_libconfig.c	`58.09% <25.00%> (+0.53%)`	⬆️
src/backend/backend.c	`62.27% <33.33%> (+2.59%)`	⬆️
src/win.c	`68.15% <80.00%> (+1.01%)`	⬆️
src/picom.c	`67.80% <100.00%> (+1.91%)`	⬆️

... and 27 files with indirect coverage changes

yshui

Thanks for the PR! This is great work, I like how small the changes are for what it does.

Just a couple of concerns

src/win.c

src/backend/backend.c

src/config_libconfig.c

dshoreman · 2022-02-10T15:55:23Z

Thanks for the PR! This is great work, I like how small the changes are for what it does.

Thanks! I can't take all the credit though.
Much of the work is by @rajansaini691—I simply rebased and made some minor behavioural changes ;)

Sorry it took so long to fix the style issue, a few things came up all at once IRL. I'll see what I can do to resolve any issues later.
It'd be nice to add a test or two as well but so far I haven't even looked inside the tests dir, so we'll see

schrottkatze · 2022-09-19T11:40:38Z

Hi, looking for an update on this, does this PR have a future? I'm looking for this feature for quite a while and it's kind of disheartening to see this PR and its predecessor be practically dead.

rajansaini691 · 2022-09-19T21:40:43Z

Hi Gabriel, I stopped work on this PR since I temporarily stopped using Linux altogether for unrelated reasons. However, like my successor said, it shouldn't be too much work to integrate my changes. Hope someone can pick it up again and take focus mode to production! :)

…

On Mon, Sep 19, 2022, 4:40 AM Gabriel ***@***.***> wrote: Hi, looking for an update on this, does this PR have a future? I'm looking for this feature for quite a while and it's kind of disheartening to see this PR and its predecessor be practically dead. — Reply to this email directly, view it on GitHub <#765 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AJJ4AHNET5XQK3L3UIJ6KYTV7BGMBANCNFSM5MTRBCUA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

schrottkatze · 2022-09-21T12:22:02Z

Hello, thanks for the response!
I'm both lacking the time and C skills to implement it sadly, but I use my laptop in public a lot so I hope that someone will integrate them soon.

dshoreman · 2022-09-28T03:59:04Z

@obsidianical Apologies, things came up after my first rebase in July and I forgot to push. I rebased again yesterday (only one new commit) and pushed just now after making sure it still works.

Most conflicts were from new window-shadow-fg and window-shadow-fg-rule options added in 654772b. I'm unsure if it adds similar (or underlying) functionality that could replace or support this PR. It could be something else entirely...

I plan to throw a test config together later today after some sleep to try the plain next branch. If the functionality of this PR isn't already added by 654772b then I have no problem getting back to work resolving some of the original review issues.

Adds an option to specify which windows will be blurred when inactive.

If --inactive-blur-include isn't specified, but --inactive-blur *is*, then the sensible default would be to blur all inactive windows. This commit does exactly that.

The property was already added in the first commit on this branch, but it wasn't defined so it would've had no effect. With this, the long conditional is easier to read and *should* update automatically.

Moves the setting of `blur_foreground` to a new method which then calls a second to actually set the value and apply damage if it's different, similar to how the blur_background value/damage is handled.

Rather than overriding the background blur method, this will only use blur_method when it's already defined, otherwise creating a whole new blur context using the 'box' blur method with default size of 3. This fixes an issue where background blur would be forced even if unwanted. By placing the fgcontext code in picom.c rather than config_libconfig.c, this also fixes a segfault when passing `--inactive-blur` on the command line without having a blur method set either in an option or in config.

dshoreman · 2023-04-18T01:22:52Z

Finally(!) found enough time to get back to work on this again 🎉

@yshui I'm pretty sure everything's done now, but would you mind reviewing again in case I've missed anything? Thanks!

dshoreman force-pushed the feature/privacy-shade branch from 86363a2 to cda8ca4 Compare February 10, 2022 14:43

yshui requested changes Feb 10, 2022

View reviewed changes

src/win.c Outdated Show resolved Hide resolved

src/backend/backend.c Outdated Show resolved Hide resolved

src/config_libconfig.c Outdated Show resolved Hide resolved

dshoreman force-pushed the feature/privacy-shade branch from cda8ca4 to 4bf45c3 Compare September 28, 2022 03:34

yshui force-pushed the next branch from 61d9ed3 to 3b342af Compare December 14, 2022 14:02

Rajan Saini and others added 9 commits April 16, 2023 02:18

Add foreground blurring

bfc58b0

Add an inactive-blur option

7562cb0

Check for inactive_blur when drawing fg blur

d9929fd

Add --inactive-blur-include option

0279bf1

Adds an option to specify which windows will be blurred when inactive.

Enable blurring all windows without a list

ed53d28

If --inactive-blur-include isn't specified, but --inactive-blur *is*, then the sensible default would be to blur all inactive windows. This commit does exactly that.

Use blur_foreground to simplify conditionals

4591de0

The property was already added in the first commit on this branch, but it wasn't defined so it would've had no effect. With this, the long conditional is easier to read and *should* update automatically.

Avoid blurring background and foreground together

dced2d4

Fix active window also being blurred

5426688

Patch for mask parameter in blur function

5ebb762

dshoreman force-pushed the feature/privacy-shade branch from 4bf45c3 to 5ebb762 Compare April 16, 2023 22:13

dshoreman added 3 commits April 16, 2023 23:13

Add damage when blur_foreground changes

4bccb48

Moves the setting of `blur_foreground` to a new method which then calls a second to actually set the value and apply damage if it's different, similar to how the blur_background value/damage is handled.

Add option to tweak inactive window blur opacity

45dc995

dshoreman force-pushed the feature/privacy-shade branch from 6dcb04d to 45dc995 Compare April 18, 2023 00:25

dshoreman requested a review from yshui May 19, 2023 14:29

yshui force-pushed the next branch from c8c06cf to 5fa870a Compare February 18, 2024 00:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add foreground blurring (Privacy and Focus modes) #765

Add foreground blurring (Privacy and Focus modes) #765

dshoreman commented Jan 23, 2022 •

edited

codecov bot commented Jan 23, 2022 •

edited

yshui left a comment

dshoreman commented Feb 10, 2022 •

edited

schrottkatze commented Sep 19, 2022

rajansaini691 commented Sep 19, 2022 via email

schrottkatze commented Sep 21, 2022

dshoreman commented Sep 28, 2022

dshoreman commented Apr 18, 2023

Add foreground blurring (Privacy and Focus modes) #765

Are you sure you want to change the base?

Add foreground blurring (Privacy and Focus modes) #765

Conversation

dshoreman commented Jan 23, 2022 • edited

Differences in this PR:

Option Rationale

codecov bot commented Jan 23, 2022 • edited

Codecov Report

yshui left a comment

Choose a reason for hiding this comment

dshoreman commented Feb 10, 2022 • edited

schrottkatze commented Sep 19, 2022

rajansaini691 commented Sep 19, 2022 via email

schrottkatze commented Sep 21, 2022

dshoreman commented Sep 28, 2022

dshoreman commented Apr 18, 2023

dshoreman commented Jan 23, 2022 •

edited

codecov bot commented Jan 23, 2022 •

edited

dshoreman commented Feb 10, 2022 •

edited