summaryrefslogtreecommitdiff
path: root/aerial_screensaver.py
diff options
context:
space:
mode:
authorChristopher Warner <cwarner@kernelcode.com>2026-10-13 15:07:53 -0400
committerChristopher Warner <cwarner@kernelcode.com>2026-10-13 15:07:53 -0400
commit6f3426c481f03f5beeed9171b3280f0070798844 (patch)
treec2cfb41a3a8f17919aa40d76ccf032546165ab75 /aerial_screensaver.py
parentead35d75893dcbc34a97beb165a2d46f7741bfc8 (diff)
downloadaerial-screensaver-linux-6f3426c481f03f5beeed9171b3280f0070798844.tar.gz
aerial-screensaver-linux-6f3426c481f03f5beeed9171b3280f0070798844.tar.bz2
aerial-screensaver-linux-6f3426c481f03f5beeed9171b3280f0070798844.tar.xz
aerial-screensaver-linux-6f3426c481f03f5beeed9171b3280f0070798844.zip
feat: package portable Aerial screensaver for sharing
Add install/uninstall scripts, XDG config, portable VAAPI detection, fetch-aerial-recent helper, and a LocalSend-ready zip without Apple video assets. Co-authored-by: Cursor <cursoragent@cursor.com>
Diffstat (limited to 'aerial_screensaver.py')
-rwxr-xr-xaerial_screensaver.py318
1 files changed, 194 insertions, 124 deletions
diff --git a/aerial_screensaver.py b/aerial_screensaver.py
index 3c93086..5275dad 100755
--- a/aerial_screensaver.py
+++ b/aerial_screensaver.py
@@ -1,68 +1,102 @@
#!/usr/bin/env python3
-import time
-import subprocess
+"""GNOME idle Aerial screensaver — AC-only, lid-aware, multi-monitor mpv."""
+
+from __future__ import annotations
+
+import logging
import os
+import subprocess
import sys
import threading
-import logging
+import time
+from pathlib import Path
+
from gi.repository import Gio, GLib
-# Setup Logging
-LOG_PATH = os.path.expanduser("~/aerial_debug.log")
-logging.basicConfig(
- level=logging.DEBUG,
- format='%(asctime)s %(levelname)s: %(message)s',
- handlers=[
- logging.FileHandler(LOG_PATH),
- logging.StreamHandler(sys.stdout)
- ]
+CONFIG_DIR = Path(os.environ.get("XDG_CONFIG_HOME", Path.home() / ".config")) / "aerial-screensaver"
+CONFIG_FILE = CONFIG_DIR / "config"
+DEFAULT_VIDEO_DIR = Path.home() / "Videos" / "Screensavers" / "Aerial"
+DEFAULT_IDLE_SECONDS = 300
+LID_STATE_CANDIDATES = (
+ "/proc/acpi/button/lid/LID0/state",
+ "/proc/acpi/button/lid/LID/state",
)
-
-# Configuration
-IDLE_TIMEOUT_SECONDS = 300 # 5 minutes
-VIDEO_DIR = os.path.expanduser("~/Videos/Screensavers/Aerial")
-LID_STATE_FILE = "/proc/acpi/button/lid/LID0/state"
IPC_SOCKET_PREFIX = "/tmp/mpv_aerial_"
-
-# Quiet playback: iGPU VAAPI decode, cheap scaling, no audio, drop freely.
-MPV_BASE_COMMAND = [
- "nice", "-n", "19",
- "mpv",
- "--fullscreen",
- "--no-stop-screensaver",
- "--loop-playlist=inf",
- "--shuffle",
- "--hwdec=vaapi",
- "--vaapi-device=/dev/dri/by-path/pci-0000:c4:00.0-render",
- "--vo=gpu",
- "--gpu-context=wayland",
- "--gpu-api=opengl",
- "--scale=bilinear",
- "--cscale=bilinear",
- "--dscale=bilinear",
- "--dither=no",
- "--correct-downscaling=no",
- "--sigmoid-upscaling=no",
- "--video-sync=audio",
- "--framedrop=vo",
- "--vf=fps=24",
- "--no-osc",
- "--no-osd-bar",
- "--osd-level=0",
- "--cursor-autohide=always",
- "--no-audio",
- "--playlist=-",
-]
+LOG_PATH = Path.home() / "aerial_debug.log"
+
+
+def _load_config() -> dict[str, str]:
+ cfg: dict[str, str] = {}
+ if CONFIG_FILE.is_file():
+ for line in CONFIG_FILE.read_text(encoding="utf-8").splitlines():
+ line = line.strip()
+ if not line or line.startswith("#") or "=" not in line:
+ continue
+ key, value = line.split("=", 1)
+ cfg[key.strip()] = value.strip().strip('"').strip("'")
+ # Environment overrides config
+ for key in ("VIDEO_DIR", "IDLE_TIMEOUT_SECONDS", "VAAPI_DEVICE", "REQUIRE_AC"):
+ env = os.environ.get(f"AERIAL_{key}")
+ if env:
+ cfg[key] = env
+ return cfg
+
+
+def find_vaapi_device(preferred: str | None = None) -> str | None:
+ """Pick a DRM render node for VAAPI. Prefer an explicit path when set."""
+ if preferred and Path(preferred).exists():
+ return preferred
+ by_path = Path("/dev/dri/by-path")
+ if by_path.is_dir():
+ # Prefer integrated / non-USB render nodes; stable by-path names.
+ candidates = sorted(by_path.glob("*-render"))
+ for path in candidates:
+ name = path.name.lower()
+ if "usb" in name:
+ continue
+ return str(path)
+ if candidates:
+ return str(candidates[0])
+ renders = sorted(Path("/dev/dri").glob("renderD*"))
+ return str(renders[0]) if renders else None
+
+
+def setup_logging() -> None:
+ logging.basicConfig(
+ level=logging.DEBUG,
+ format="%(asctime)s %(levelname)s: %(message)s",
+ handlers=[
+ logging.FileHandler(LOG_PATH),
+ logging.StreamHandler(sys.stdout),
+ ],
+ )
class AerialScreensaver:
- def __init__(self):
- self.processes = []
+ def __init__(self) -> None:
+ setup_logging()
+ cfg = _load_config()
+ self.video_dir = Path(cfg.get("VIDEO_DIR", str(DEFAULT_VIDEO_DIR))).expanduser()
+ self.idle_timeout_seconds = int(cfg.get("IDLE_TIMEOUT_SECONDS", DEFAULT_IDLE_SECONDS))
+ self.require_ac = cfg.get("REQUIRE_AC", "1").lower() not in ("0", "false", "no")
+ self.vaapi_device = find_vaapi_device(cfg.get("VAAPI_DEVICE") or None)
+ self.processes: list[subprocess.Popen] = []
self.idle_monitor = None
self.watch_id = None
-
- logging.info("Initializing Aerial Screensaver (mpv Lite Backend, AC-only, Lid-Aware, multi-screen)...")
-
+ self.lid_state_file = next(
+ (p for p in LID_STATE_CANDIDATES if os.path.exists(p)),
+ LID_STATE_CANDIDATES[0],
+ )
+
+ logging.info(
+ "Initializing Aerial Screensaver "
+ "(mpv lite, AC=%s, lid-aware, multi-screen, vaapi=%s)...",
+ self.require_ac,
+ self.vaapi_device or "auto",
+ )
+ self._connect_idle_monitor()
+
+ def _connect_idle_monitor(self) -> None:
connected = False
while not connected:
try:
@@ -73,52 +107,58 @@ class AerialScreensaver:
"org.gnome.Mutter.IdleMonitor",
"/org/gnome/Mutter/IdleMonitor/Core",
"org.gnome.Mutter.IdleMonitor",
- None
+ None,
)
-
reply = self.idle_monitor.call_sync(
"AddIdleWatch",
- GLib.Variant("(t)", (IDLE_TIMEOUT_SECONDS * 1000,)),
+ GLib.Variant("(t)", (self.idle_timeout_seconds * 1000,)),
Gio.DBusCallFlags.NONE,
-1,
- None
+ None,
)
self.watch_id = reply.unpack()[0]
- logging.info(f"Added IdleWatch with ID: {self.watch_id} for {IDLE_TIMEOUT_SECONDS}s")
-
+ logging.info(
+ "Added IdleWatch with ID: %s for %ss",
+ self.watch_id,
+ self.idle_timeout_seconds,
+ )
self.idle_monitor.connect("g-signal", self.on_dbus_signal)
connected = True
-
except Exception as e:
- logging.error(f"Failed to connect to IdleMonitor: {e}")
+ logging.error("Failed to connect to IdleMonitor: %s", e)
logging.info("Retrying in 5 seconds...")
time.sleep(5)
self.idle_monitor = None
- def is_on_ac(self):
+ def is_on_ac(self) -> bool:
+ if not self.require_ac:
+ return True
try:
- for ac in os.listdir('/sys/class/power_supply/'):
- if ac.startswith('AC'):
- with open(f'/sys/class/power_supply/{ac}/online', 'r') as f:
- if f.read().strip() == '1':
+ for ac in os.listdir("/sys/class/power_supply/"):
+ if ac.startswith("AC"):
+ with open(f"/sys/class/power_supply/{ac}/online", "r", encoding="utf-8") as f:
+ if f.read().strip() == "1":
return True
+ # Desktops often have no AC* supply — treat as on AC.
+ supplies = os.listdir("/sys/class/power_supply/")
+ if not any(s.startswith("AC") for s in supplies):
+ return True
return False
except Exception as e:
- logging.error(f"Error checking AC status: {e}")
+ logging.error("Error checking AC status: %s", e)
return False
- def is_lid_open(self):
+ def is_lid_open(self) -> bool:
try:
- if not os.path.exists(LID_STATE_FILE):
+ if not os.path.exists(self.lid_state_file):
return True
- with open(LID_STATE_FILE, 'r') as f:
- content = f.read().strip()
- return "open" in content
+ with open(self.lid_state_file, "r", encoding="utf-8") as f:
+ return "open" in f.read().strip()
except Exception as e:
- logging.error(f"Error checking lid status: {e}")
+ logging.error("Error checking lid status: %s", e)
return True
- def get_screen_count(self):
+ def get_screen_count(self) -> int:
"""Return active GNOME logical monitor count (fallback: 1)."""
try:
proxy = Gio.DBusProxy.new_for_bus_sync(
@@ -128,63 +168,104 @@ class AerialScreensaver:
"org.gnome.Mutter.DisplayConfig",
"/org/gnome/Mutter/DisplayConfig",
"org.gnome.Mutter.DisplayConfig",
- None
+ None,
)
reply = proxy.call_sync(
"GetCurrentState",
None,
Gio.DBusCallFlags.NONE,
-1,
- None
+ None,
)
_serial, _monitors, logical_monitors, _props = reply.unpack()
- count = len(logical_monitors)
- if count < 1:
- return 1
- return count
+ return max(1, len(logical_monitors))
except Exception as e:
- logging.error(f"Error detecting screens, defaulting to 1: {e}")
+ logging.error("Error detecting screens, defaulting to 1: %s", e)
return 1
- def on_dbus_signal(self, proxy, sender_name, signal_name, parameters):
- if signal_name == "WatchFired":
- watch_id = parameters.unpack()[0]
- if watch_id == self.watch_id:
- if self.is_on_ac() and self.is_lid_open():
- logging.info("Idle threshold reached, on AC and lid is OPEN. Starting mpv.")
- self.start_screensaver()
- else:
- logging.info(f"Idle threshold reached but skip (AC: {self.is_on_ac()}, Lid Open: {self.is_lid_open()})")
+ def on_dbus_signal(self, proxy, sender_name, signal_name, parameters) -> None:
+ if signal_name != "WatchFired":
+ return
+ watch_id = parameters.unpack()[0]
+ if watch_id != self.watch_id:
+ return
+ if self.is_on_ac() and self.is_lid_open():
+ logging.info("Idle threshold reached, on AC and lid is OPEN. Starting mpv.")
+ self.start_screensaver()
+ else:
+ logging.info(
+ "Idle threshold reached but skip (AC: %s, Lid Open: %s)",
+ self.is_on_ac(),
+ self.is_lid_open(),
+ )
- def _collect_videos(self):
- if not os.path.isdir(VIDEO_DIR):
+ def _collect_videos(self) -> list[str]:
+ if not self.video_dir.is_dir():
return []
- return [
- os.path.join(VIDEO_DIR, f)
- for f in os.listdir(VIDEO_DIR)
+ return sorted(
+ str(self.video_dir / f)
+ for f in os.listdir(self.video_dir)
if f.lower().endswith((".mov", ".mp4", ".mkv"))
and not f.startswith("_test")
and not f.startswith(".")
and ".partial." not in f.lower()
+ )
+
+ def _mpv_base_command(self) -> list[str]:
+ cmd = [
+ "nice",
+ "-n",
+ "19",
+ "mpv",
+ "--fullscreen",
+ "--no-stop-screensaver",
+ "--loop-playlist=inf",
+ "--shuffle",
+ "--hwdec=vaapi",
+ "--vo=gpu",
+ "--gpu-context=wayland",
+ "--gpu-api=opengl",
+ "--scale=bilinear",
+ "--cscale=bilinear",
+ "--dscale=bilinear",
+ "--dither=no",
+ "--correct-downscaling=no",
+ "--sigmoid-upscaling=no",
+ "--video-sync=audio",
+ "--framedrop=vo",
+ "--vf=fps=24",
+ "--no-osc",
+ "--no-osd-bar",
+ "--osd-level=0",
+ "--cursor-autohide=always",
+ "--no-audio",
+ "--playlist=-",
]
+ if self.vaapi_device:
+ cmd.insert(cmd.index("--hwdec=vaapi") + 1, f"--vaapi-device={self.vaapi_device}")
+ return cmd
- def _any_running(self):
+ def _any_running(self) -> bool:
return any(p.poll() is None for p in self.processes)
- def start_screensaver(self):
+ def start_screensaver(self) -> None:
if self._any_running():
return
-
try:
videos = self._collect_videos()
if not videos:
- logging.error(f"No video files found in {VIDEO_DIR}")
+ logging.error("No video files found in %s", self.video_dir)
return
screen_count = self.get_screen_count()
- logging.info(f"Using {len(videos)} clips from {VIDEO_DIR} on {screen_count} screen(s)")
+ logging.info(
+ "Using %s clips from %s on %s screen(s)",
+ len(videos),
+ self.video_dir,
+ screen_count,
+ )
urls = "\n".join(videos)
-
+ base = self._mpv_base_command()
self.processes = []
for screen in range(screen_count):
ipc = f"{IPC_SOCKET_PREFIX}{screen}"
@@ -192,8 +273,7 @@ class AerialScreensaver:
os.unlink(ipc)
except FileNotFoundError:
pass
-
- cmd = MPV_BASE_COMMAND + [
+ cmd = base + [
f"--input-ipc-server={ipc}",
f"--screen={screen}",
f"--fs-screen={screen}",
@@ -203,21 +283,19 @@ class AerialScreensaver:
stdin=subprocess.PIPE,
stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL,
- text=True
+ text=True,
)
if proc.stdin:
proc.stdin.write(urls)
proc.stdin.close()
self.processes.append(proc)
- logging.info(f"mpv started on screen {screen} with PID: {proc.pid}")
-
+ logging.info("mpv started on screen %s with PID: %s", screen, proc.pid)
threading.Thread(target=self.monitor_activity, daemon=True).start()
-
except Exception as e:
- logging.error(f"Error starting mpv: {e}")
+ logging.error("Error starting mpv: %s", e)
self.stop_screensaver()
- def monitor_activity(self):
+ def monitor_activity(self) -> None:
while self._any_running():
time.sleep(1)
try:
@@ -225,29 +303,24 @@ class AerialScreensaver:
logging.info("Lid closed during playback. Stopping mpv.")
self.stop_screensaver()
break
-
reply = self.idle_monitor.call_sync(
"GetIdletime",
None,
Gio.DBusCallFlags.NONE,
-1,
- None
+ None,
)
- idle_time = reply.unpack()[0]
-
- if idle_time < 1000:
+ if reply.unpack()[0] < 1000:
self.stop_screensaver()
break
-
if not self.is_on_ac():
self.stop_screensaver()
break
-
except Exception as e:
- logging.error(f"Error in monitor_activity: {e}")
+ logging.error("Error in monitor_activity: %s", e)
break
- def stop_screensaver(self):
+ def stop_screensaver(self) -> None:
for proc in self.processes:
if proc.poll() is None:
proc.terminate()
@@ -256,15 +329,13 @@ class AerialScreensaver:
except subprocess.TimeoutExpired:
proc.kill()
self.processes = []
- for path in (
- f"{IPC_SOCKET_PREFIX}{i}" for i in range(8)
- ):
+ for i in range(8):
try:
- os.unlink(path)
+ os.unlink(f"{IPC_SOCKET_PREFIX}{i}")
except FileNotFoundError:
pass
- def run(self):
+ def run(self) -> None:
loop = GLib.MainLoop()
try:
loop.run()
@@ -273,5 +344,4 @@ class AerialScreensaver:
if __name__ == "__main__":
- app = AerialScreensaver()
- app.run()
+ AerialScreensaver().run()