From 398ef9263b8a0005cc506bd6f22a343e66078bdb Mon Sep 17 00:00:00 2001
From: Vincent Bernat <vincent@bernat.ch>
Date: Sat, 30 Apr 2022 16:13:41 +0200
Subject: [PATCH] xss-dimmer: play a sound to notice dimmer when not looking at
 the screen

---
 bin/xss-dimmer                       | 23 ++++++++++++++++++++++-
 dotfiles/systemd/xss-dimmer@.service |  3 ++-
 2 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/bin/xss-dimmer b/bin/xss-dimmer
index c105514..4f68952 100755
--- a/bin/xss-dimmer
+++ b/bin/xss-dimmer
@@ -17,10 +17,17 @@ import argparse
 import threading
 import time
 import math
+import os
 from Xlib import display, X
 from Xlib.error import BadWindow
 from Xlib.protocol.event import MapNotify
 
+try:
+    os.environ["PYGAME_HIDE_SUPPORT_PROMPT"] = "hide"
+    import pygame
+except ImportError:
+    pygame = None
+
 
 def on_xevent(source, condition, xdisplay, locker):
     while xdisplay.pending_events():
@@ -89,7 +96,17 @@ def on_refresh(window, options, start):
     elapsed = time.monotonic() - start
     if elapsed < options.delay:
         next_step = min(options.step, options.delay - elapsed)
-        GLib.timeout_add(options.step * 1000, on_refresh, window, options, start)
+        GLib.timeout_add(next_step * 1000, on_refresh, window, options, start)
+
+
+def on_sound_ticker(options, sound, start):
+    elapsed = time.monotonic() - start
+    if elapsed < options.delay:
+        if sound is None:
+            pygame.mixer.init()
+            sound = pygame.mixer.Sound(options.sound)
+        sound.play()
+        GLib.timeout_add(1000, on_sound_ticker, options, sound, now)
 
 
 # See: https://easings.net/
@@ -144,6 +161,7 @@ if __name__ == "__main__":
         choices=easing_functions.keys(),
         help="easing function for opacity",
     )
+    add("--sound", help="play a sound for each second elapsed while dimmer running")
     options = parser.parse_args()
 
     background = None
@@ -192,5 +210,8 @@ if __name__ == "__main__":
     )
     xdisplay.pending_events()  # otherwise, socket is inactive
 
+    if options.sound and pygame:
+        GLib.timeout_add(5000, on_sound_ticker, options, None, now)
+
     # Main loop
     Gtk.main()
diff --git a/dotfiles/systemd/xss-dimmer@.service b/dotfiles/systemd/xss-dimmer@.service
index 59d2b44..a3de649 100644
--- a/dotfiles/systemd/xss-dimmer@.service
+++ b/dotfiles/systemd/xss-dimmer@.service
@@ -3,4 +3,5 @@ Description=Screen dimmer
 
 [Service]
 ExecStart=%h/.config/i3/bin/xss-dimmer --delay=%i \
-                                       --background=%t/i3/current-wallpaper.png
+                                       --background=%t/i3/current-wallpaper.png \
+                                       --sound=/usr/share/sounds/freedesktop/stereo/audio-volume-change.oga