search

maximbaz / wluma

Automatic brightness adjustment based on screen contents and ALS
ISC License
645 stars 28 forks source link

[Bug]: Screen flickering and voliatile image artifacts #122

Open nitrotol opened 1 day ago

nitrotol commented 1 day ago

Steps for reproducing the issue

  1. Launch wluma

What is the buggy behavior?

Right after start app screen starts flickering (with frequency near 5 Hz) and sometimes appear dark rectangles on light parts of screen image which persist on the same place after change image (scroll out or change browser tab). I saw this only in Chrome but I can't be sure that it don't appear in other apps

What is the expected behavior?

Clear screen image without flickering

Logs

[2024-10-22T17:49:32Z DEBUG wluma] Using Config {
        als: Iio {
            path: "/sys/bus/iio/devices",
            thresholds: {
                0: "night",
                500: "bright",
                80: "dim",
                800: "outdoors",
                250: "normal",
                20: "dark",
            },
        },
        output: [
            Backlight(
                BacklightOutput {
                    name: "eDP-1",
                    path: "/sys/class/backlight/intel_backlight",
                    capturer: Wlroots,
                    min_brightness: 1,
                },
            ),
            Backlight(
                BacklightOutput {
                    name: "eDP-2",
                    path: "/sys/class/backlight/card1-eDP-2-backlight",
                    capturer: Wlroots,
                    min_brightness: 1,
                },
            ),
        ],
    }
[2024-10-22T17:49:32Z INFO  wluma] Continue adjusting brightness and wluma will learn your preference over time.
[2024-10-22T17:49:32Z DEBUG wluma::frame::capturer::wlroots] Using output 'Samsung Display Corp. 0x419D (eDP-1)' for config 'eDP-1'

Version

4.4.1

Environment

lsb_release -a; uname -a; pgrep -l sway; pacman -Q | egrep "(wlroots|vulkan|sway|clang|rust)"; dpkg -l | egrep "(wlroots|vulkan|sway|clang|rust)"; echo "WLR_DRM_NO_MODIFIERS=$WLR_DRM_NO_MODIFIERS"
zsh: command not found: lsb_release
Linux nitrotol-zenbook 6.11.3-arch1-1 #1 SMP PREEMPT_DYNAMIC Thu, 10 Oct 2024 20:11:06 +0000 x86_64 GNU/Linux
1829 sway
1849 swaybg
1884 swayidle
egrep: warning: egrep is obsolescent; using grep -E
clang 18.1.8-3
grimshot-bin-sway 1-3
rust 1:1.81.0-1
sway-contrib 1.9.0-2
swaybg 1.2.1-1
swayfx 0.4-3
swayfx-debug 0.4-3
swayidle 1.8.0-2
swaylock 1.8.0-1
vulkan-headers 1:1.3.295-1
vulkan-icd-loader 1.3.295-1
vulkan-intel 1:24.2.4-1
vulkan-tools 1.3.269-1
vulkan-validation-layers 1.3.290-2
wlroots 0.18.1-1
wlroots0.17 0.17.4-3
zsh: command not found: dpkg
egrep: warning: egrep is obsolescent; using grep -E
WLR_DRM_NO_MODIFIERS=1
maximbaz commented 1 day ago

Wow, I've never heard anything like that 😧

Do you have two screens? Does it reproduce if you only leave one of them in the config?

nitrotol commented 1 day ago

Yeah, I have dual screen laptop

RUST_LOG=debug wluma
[2024-10-22T18:06:33Z DEBUG wluma] Using Config {
        als: Iio {
            path: "/sys/bus/iio/devices",
            thresholds: {
                20: "dark",
                0: "night",
                500: "bright",
                80: "dim",
                800: "outdoors",
                250: "normal",
            },
        },
        output: [
            Backlight(
                BacklightOutput {
                    name: "eDP-1",
                    path: "/sys/class/backlight/intel_backlight",
                    capturer: Wlroots,
                    min_brightness: 1,
                },
            ),
        ],
    }
[2024-10-22T18:06:33Z INFO  wluma] Continue adjusting brightness and wluma will learn your preference over time.
[2024-10-22T18:06:33Z DEBUG wluma::frame::capturer::wlroots] Using output 'Samsung Display Corp. 0x419D (eDP-1)' for config 'eDP-1'

Flickering still persist

maximbaz commented 1 day ago

I cannot possibly imagine how we can be affecting screen contents if all we do is receive a frame and copy it into a new image for further professing ☹️

What if you replace this entire part with let result = 0;, does flickering go away? This maps the frame but doesn't copy it.

https://github.com/maximbaz/wluma/blob/5e0732e5cb4925e6d31cf46336e2d2b8b80a3552/src/frame/vulkan.rs#L203-L226

Or what if you comment out this part, does the flickering go away? This is basically receiving frames and not doing anything with them at all.

https://github.com/maximbaz/wluma/blob/5e0732e5cb4925e6d31cf46336e2d2b8b80a3552/src/frame/capturer/wlroots.rs#L126-L131

nitrotol commented 1 day ago

Changes in vulkan.rs - flickering still persist Changes in wlroots.rs - no changes, flickering still there

Maybe this is not about image as is, maybe it related to change backlight so fast? But if it is, why I have black rectaggles here and there sometimes?

maximbaz commented 1 day ago

I did not expect that flickering would persist with changes to vulkan.rs!

Let's comment one more line and see if it changes anything, replace all of this please with let result = 0;, does it make a difference?

https://github.com/maximbaz/wluma/blob/77bac5a52c81fb189d7d1fbe5ab4a923c5ac5d97/src/frame/vulkan.rs#L201-L226

Similarly to test your idea that it is backlight change that could be the culprit, you could maybe try to replace this part with state.controller.as_mut().unwrap().adjust(0):

https://github.com/maximbaz/wluma/blob/77bac5a52c81fb189d7d1fbe5ab4a923c5ac5d97/src/frame/capturer/wlr_export_dmabuf_unstable_v1.rs#L155-L162

By the way, I just pushed some major update to main branch, it should not have any difference whatsoever, but just so you know why references above have changed.

nitrotol commented 1 day ago

First case - error[E0425]: cannot find valueframe_imagein this scope If keep line 201 - no changes, it still flicker

Please note that all previous tests I'm doing on tag 4.4.1 Now I checkout fresh main (just because tag 4.4.1 dont have wluma/src/frame/capturer/wlr_export_dmabuf_unstable_v1.rs

Fresh unchanged main - flickering with changes in wlr_export_dmabuf_unstable_v1.rs - absolutely the same shit(

maximbaz commented 1 day ago

First case - error[E0425]: cannot find value frame_image in this scope If keep line 201 - no changes, it still flicker

Right, sorry, comment out line 201 and all of the unsafe block in the end too, lines 229-234.

nitrotol commented 1 day ago

It's f**king magic Somehow it stops flickering! On all versions (including installed 4.4.1). I don't understand how. Maybe it depends on some gamma settings? I also have gammastep running...

Give me please some time to make more tests in different circumstances. I'll keep you posted

maximbaz commented 8 hours ago

A new wlr-screencopy-unstable-v1 protocol has landed in wluma's main branch, the way I understand how it is different is that we don't access the compositor's frame directly, but instead we create our own image and ask compositor to fill it in. So I'm guessing/hoping that this would have even less chance for wluma to cause any kind of image artifacts, if it always works on its own copy of the image.

Would you like to try it out? Just pull the latest main, keep capturer=wlroots, and if both protocols are supported, wluma will automatically pick the wlr-screencopy-unstable-v1 one (you will see in RUST_LOG=trace what it picks).

If you do get to try it, please report any issues you face with it, because I want to make this protocol a new default.

And also, on my own hardware I observed that with the new protocol I am getting occasional luma: 0, but I don't know if it's something that I do incorrectly in the code, or it's a bug in my driver.

$ RUST_LOG=trace cargo run
...
[2024-10-23T21:48:43Z TRACE wluma::predictor::controller] Prediction: 180 (lux: none, luma: 17)
[2024-10-23T21:48:43Z TRACE wluma::predictor::controller] Prediction: 181 (lux: none, luma: 16)
[2024-10-23T21:48:43Z TRACE wluma::predictor::controller] Prediction: 181 (lux: none, luma: 16)
[2024-10-23T21:48:43Z TRACE wluma::predictor::controller] Prediction: 181 (lux: none, luma: 16)
[2024-10-23T21:48:44Z TRACE wluma::predictor::controller] Prediction: 174 (lux: none, luma: 0)  <-------------
[2024-10-23T21:48:44Z TRACE wluma::predictor::controller] Prediction: 180 (lux: none, luma: 17)
[2024-10-23T21:48:44Z TRACE wluma::predictor::controller] Prediction: 181 (lux: none, luma: 16)
[2024-10-23T21:48:44Z TRACE wluma::predictor::controller] Prediction: 181 (lux: none, luma: 16)
[2024-10-23T21:48:44Z TRACE wluma::predictor::controller] Prediction: 181 (lux: none, luma: 16)
[2024-10-23T21:48:44Z TRACE wluma::predictor::controller] Prediction: 181 (lux: none, luma: 16)
[2024-10-23T21:48:44Z TRACE wluma::predictor::controller] Prediction: 181 (lux: none, luma: 16)
[2024-10-23T21:48:44Z TRACE wluma::predictor::controller] Prediction: 174 (lux: none, luma: 0)  <-------------
[2024-10-23T21:48:44Z TRACE wluma::predictor::controller] Prediction: 181 (lux: none, luma: 16)
[2024-10-23T21:48:45Z TRACE wluma::predictor::controller] Prediction: 174 (lux: none, luma: 0)  <-------------
[2024-10-23T21:48:45Z TRACE wluma::predictor::controller] Prediction: 181 (lux: none, luma: 16)
[2024-10-23T21:48:45Z TRACE wluma::predictor::controller] Prediction: 181 (lux: none, luma: 16)

Could you tell me if you see them? (they pop up relatively frequently).

If you don't see them, could you comment this line and try again?

https://github.com/maximbaz/wluma/blob/8e81a8f0f3bd0c33d5b368bf909e18caea60b2a1/src/frame/capturer/wayland.rs#L431-L432

I see them without sleep and don't see them anymore with sleep.

nitrotol commented 27 minutes ago

changes in src/frame/capturer/wlr_export_dmabuf_unstable_v1.rs don't helps at all, it still flickering also with

comment out line 201 and all of the unsafe block in the end too, lines 229-234.

I tried fresh master with wlr-screencopy-unstable-v1 and I don't see luma: 0. Screen keeps flickering, and I see that each particular flick happend in the same time with each trace message appear. Same with commented 432 line in src/frame/capturer/wayland.rs