Merge pull request #12429 from omacom/owe-video-backgrounds

Replace the shell's desktop video path with OWE

test/shell.d/fixtures/owe-lock/shell.qml

@@ -0,0 +1,69 @@
+import QtQuick
+import Quickshell
+
+ShellRoot {
+  id: root
+  property var view
+  property var wallpaper
+  property var feed
+  property int step: 0
+
+  Item { id: host; width: 1000; height: 700 }
+
+  function findItem(item, name) {
+    if (item.objectName === name) return item
+    for (var i = 0; i < item.children.length; i++) {
+      var found = findItem(item.children[i], name)
+      if (found) return found
+    }
+    return null
+  }
+
+  function check(condition, message) {
+    if (!condition) throw new Error(message)
+  }
+
+  Timer {
+    interval: 150
+    repeat: true
+    running: true
+    onTriggered: {
+      try {
+        if (root.step === 0) {
+          var component = Qt.createComponent("file://" + Quickshell.env("OMARCHY_PATH") + "/shell/plugins/lock/LockView.qml")
+          check(component.status === Component.Ready, component.errorString())
+          root.view = component.createObject(host, {width: 1000, height: 700, backgroundPath: "/still.png", loadBackground: false})
+          check(root.view !== null, component.errorString())
+          root.wallpaper = findItem(root.view, "lockWallpaper")
+          root.feed = findItem(root.view, "lockFeedLoader")
+          check(root.wallpaper.path === "", "hidden still must not decode")
+          root.view.backgroundPath = "/video.mp4"
+          root.view.videoPosterPath = "/poster.jpg"
+        } else if (root.step === 1) {
+          check(!root.feed.active && root.feed.item === null, "hidden video must not load a feed client")
+          root.view.loadBackground = true
+          root.view.powerSaverActive = true
+        } else if (root.step === 2) {
+          check(root.wallpaper.path === "/poster.jpg", "power saver keeps the video poster")
+          check(!root.feed.active, "power saver must not connect to the feed")
+          root.view.powerSaverActive = false
+        } else if (root.step === 3) {
+          check(root.feed.active, "visible video enables the isolated feed loader")
+          check(root.wallpaper.path === "/poster.jpg", "poster stays beneath the feed before its first frame")
+          root.view.displaysBlank = true
+        } else if (root.step === 4) {
+          check(!root.feed.active && root.feed.item === null, "blanking releases the feed client")
+          root.view.loadBackground = false
+        } else {
+          check(root.wallpaper.path === "", "unlock releases the poster image")
+          console.log("OWE_LOCK_TEST_PASS")
+          Qt.quit()
+        }
+        root.step++
+      } catch (error) {
+        console.error("OWE_LOCK_TEST_FAIL: " + error)
+        Qt.quit()
+      }
+    }
+  }
+}

test/shell.d/owe-integration-test.sh

@@ -0,0 +1,90 @@
+#!/bin/bash
+set -euo pipefail
+source "$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)/base-test.sh"
+
+work=$(mktemp -d)
+trap 'rm -rf "$work"' EXIT
+mkdir -p "$work/bin" "$work/home"
+export TEST_CALLS="$work/calls"
+for command in omarchy-pkg-add omarchy-hook-install systemctl; do
+  cat >"$work/bin/$command" <<'SH'
+#!/bin/bash
+printf '%s %s\n' "${0##*/}" "$*" >>"$TEST_CALLS"
+case "$*" in
+  '--user enable owed.service') [[ ${TEST_TTY:-0} == 0 ]] ;;
+  '--user is-active --quiet graphical-session.target') [[ ${TEST_TTY:-0} == 0 ]] ;;
+  '--user start owed.service') [[ ${TEST_START_FAIL:-0} == 0 ]] ;;
+  *) exit 0 ;;
+esac
+SH
+  chmod +x "$work/bin/$command"
+done
+
+migration="$ROOT/migrations/1789764927.sh"
+run_migration() {
+  HOME="$work/home" PATH="$work/bin:$PATH" bash -euo pipefail "$migration"
+}
+run_migration
+run_migration
+grep -Fx 'omarchy-pkg-add owe owe-lockfeed' "$TEST_CALLS" >/dev/null
+grep -Fx 'omarchy-hook-install theme-set /usr/share/owe/10-owe-sync' "$TEST_CALLS" >/dev/null
+grep -Fx 'systemctl --user start owed.service' "$TEST_CALLS" >/dev/null
+pass "migration installs OWE, its theme refresh hook, and starts the graphical session service"
+
+: >"$TEST_CALLS"
+TEST_TTY=1 run_migration
+TEST_TTY=1 run_migration
+[[ $(readlink "$work/home/.config/systemd/user/graphical-session.target.wants/owed.service") == /usr/lib/systemd/user/owed.service ]]
+if grep -F 'systemctl --user start' "$TEST_CALLS" >/dev/null; then
+  fail "TTY migration must not start the renderer"
+fi
+pass "TTY migrations enable the next login without starting a renderer"
+
+: >"$TEST_CALLS"
+OMARCHY_UPGRADE_TO_QUATTRO_LIVE=1 run_migration
+if grep -F 'systemctl --user start' "$TEST_CALLS" >/dev/null; then
+  fail "Quattro upgrade must defer OWE until the new graphical session"
+fi
+pass "Quattro upgrade enables OWE without starting it in the old shell"
+
+if TEST_START_FAIL=1 run_migration; then
+  fail "a failed live service start leaves the migration pending"
+fi
+pass "a failed live service start fails the migration"
+
+: >"$TEST_CALLS"
+HOME="$work/home" PATH="$work/bin:$PATH" bash "$ROOT/install/user/first-run/enable-user-units.sh"
+grep -E '^systemctl --user enable --now .*owed.service' "$TEST_CALLS" >/dev/null
+grep -Fx 'omarchy-hook-install theme-set /usr/share/owe/10-owe-sync' "$TEST_CALLS" >/dev/null
+pass "fresh installs enable OWE and install the theme refresh hook"
+
+cat >"$work/bin/ffmpegthumbnailer" <<'SH'
+#!/bin/bash
+printf 'thumbnail\n' >>"$TEST_CALLS"
+while (( $# )); do
+  case "$1" in
+    -o) output=$2; shift 2 ;;
+    *) shift ;;
+  esac
+done
+[[ ${TEST_POSTER_FAIL:-0} == 0 ]] || exit 1
+printf 'poster\n' >"$output"
+SH
+chmod +x "$work/bin/ffmpegthumbnailer"
+source_path="$work/video with 'quotes'.mp4"
+printf 'source\n' >"$source_path"
+poster() {
+  PATH="$work/bin:$PATH" XDG_CACHE_HOME="$work/cache" bash "$ROOT/shell/plugins/lock/poster.sh" "$source_path"
+}
+: >"$TEST_CALLS"
+first=$(poster)
+[[ -s $first && $(poster) == "$first" ]]
+[[ $(wc -l <"$TEST_CALLS") == 1 ]]
+printf 'changed source\n' >>"$source_path"
+second=$(poster)
+[[ -s $second && $second != "$first" && ! -e $first ]]
+pass "lock posters are cached, refreshed after source changes, and old frames are evicted"
+printf 'broken source\n' >>"$source_path"
+if TEST_POSTER_FAIL=1 poster; then fail "failed poster generation must fail"; fi
+[[ -z $(find "$work/cache" -name '.poster-*.jpg' -print -quit) ]]
+pass "failed poster generation never publishes a partial image"

test/shell.d/owe-lock-test.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+set -euo pipefail
+source "$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)/base-test.sh"
+
+if ! command -v quickshell >/dev/null 2>&1; then
+  pass "quickshell unavailable; skipping lock feed QML lifecycle"
+  exit 0
+fi
+work=$(mktemp -d)
+trap 'rm -rf "$work"' EXIT
+mkdir -p "$work/config" "$work/runtime" "$work/home"
+chmod 700 "$work/runtime"
+cp "$SHELL_TEST_DIR/fixtures/owe-lock/shell.qml" "$work/config/shell.qml"
+ln -s "$ROOT/shell/Ui" "$work/config/Ui"
+ln -s "$ROOT/shell/Commons" "$work/config/Commons"
+
+# Offscreen rendering exercises the real QML bindings without taking a lock
+# or connecting to the user's compositor.
+HOME="$work/home" XDG_RUNTIME_DIR="$work/runtime" \
+  OMARCHY_PATH="$ROOT" QT_QPA_PLATFORM=offscreen QT_QPA_PLATFORMTHEME= \
+  QT_STYLE_OVERRIDE= QT_QUICK_BACKEND=software \
+  timeout 15 quickshell -p "$work/config" --no-color >"$work/log" 2>&1 || {
+    cat "$work/log" >&2
+    fail "lock feed QML lifecycle runs"
+  }
+if ! grep -q 'OWE_LOCK_TEST_PASS' "$work/log" || grep -q 'OWE_LOCK_TEST_FAIL' "$work/log"; then
+  cat "$work/log" >&2
+  fail "lock feed respects visibility and keeps its poster fallback"
+fi
+pass "lock feed respects visibility, power saver and blanking; hidden views release images"

test/shell.d/video-background-test.sh

@@ -9,15 +9,13 @@ const fs = require('fs')
 
 const utilQml = fs.readFileSync(path.join(root, 'shell/Commons/Util.qml'), 'utf8')
 const mediaQml = fs.readFileSync(path.join(root, 'shell/Ui/BackgroundMedia.qml'), 'utf8')
-const videoQml = fs.readFileSync(path.join(root, 'shell/Ui/BackgroundVideo.qml'), 'utf8')
 const backgroundQml = fs.readFileSync(path.join(root, 'shell/plugins/background/Background.qml'), 'utf8')
 const lockQml = fs.readFileSync(path.join(root, 'shell/plugins/lock/LockView.qml'), 'utf8')
+const lockFeedQml = fs.readFileSync(path.join(root, 'shell/plugins/lock/LockFeedSurface.qml'), 'utf8')
 const themeSwitcher = fs.readFileSync(path.join(root, 'bin/omarchy-theme-switcher'), 'utf8')
 const quattroUpgrade = fs.readFileSync(path.join(root, 'bin/omarchy-upgrade-to-quattro'), 'utf8')
-const multimediaMigration = fs.readFileSync(path.join(root, 'migrations/1786609204.sh'), 'utf8')
 const barTextColor = fs.readFileSync(path.join(root, 'bin/omarchy-bar-text-color'), 'utf8')
 const menuImages = fs.readFileSync(path.join(root, 'bin/omarchy-menu-images'), 'utf8')
-const lockView = fs.readFileSync(path.join(root, 'shell/plugins/lock/LockView.qml'), 'utf8')
 const lockService = fs.readFileSync(path.join(root, 'shell/plugins/lock/Service.qml'), 'utf8')
 const batteryService = fs.readFileSync(path.join(root, 'shell/plugins/services/battery/Service.qml'), 'utf8')
 const themeSet = fs.readFileSync(path.join(root, 'bin/omarchy-theme-set'), 'utf8')
@@ -29,54 +27,43 @@ assert(
   'shared media helper identifies video paths without truncating valid local names'
 )
 assert(
-  videoQml.includes('loops: MediaPlayer.Infinite') &&
-    videoQml.includes('autoPlay: root.playbackEnabled') &&
-    videoQml.includes('fillMode: VideoOutput.PreserveAspectCrop') &&
-    /imageUrl: path && !Util\.isVideoPath\(path\) \? Util\.fileUrl\(path\) \+ \(version \? "\?v=" \+ version : ""\) : ""/.test(mediaQml) &&
-    /videoUrl: path && Util\.isVideoPath\(path\) \? Util\.fileUrl\(path\) : ""/.test(mediaQml),
-  'background media plays aspect-cropped videos on a loop, and hands each loader only its own kind of file'
+  !fs.existsSync(path.join(root, 'shell/Ui/BackgroundVideo.qml')),
+  'the shell keeps no video player of its own'
 )
 assert(
-  videoQml.includes('MediaPlayer.LoadedMedia') &&
-    videoQml.includes('primePauseTimer') &&
-    videoQml.includes('mediaGeneration') &&
-    videoQml.includes('videoSink') &&
-    videoQml.includes('onVideoFrameChanged') &&
-    videoQml.includes('MediaPlayer.BufferedMedia') &&
-    videoQml.includes('mediaStatus !== MediaPlayer.BufferedMedia') &&
-    videoQml.includes('interval: 1000') &&
-    videoQml.includes('interval: 50') &&
-    videoQml.includes('frameReceived') &&
-    videoQml.includes('output.clearOutput()') &&
-    !videoQml.includes('KeepLastFrame') &&
-    /onPlaybackEnabledChanged:[\s\S]*?if \(playbackEnabled\) player\.play\(\)[\s\S]*?else player\.pause\(\)/.test(videoQml) &&
-    videoQml.includes('primingGeneration') &&
-    videoQml.includes('player.play()') &&
-    videoQml.includes('player.pause()'),
-  'paused video sources are primed to display their first frame'
+  /imageUrl: path && !video \? Util\.fileUrl\(path\) \+ \(version \? "\?v=" \+ version : ""\) : ""/.test(mediaQml) &&
+    /active: root\.path !== "" && !root\.video/.test(mediaQml) &&
+    !mediaQml.includes('videoUrl') &&
+    !mediaQml.includes('videoLoader') &&
+    !mediaQml.includes('videoEnabled'),
+  'background media is image-only: it loads stills and leaves videos to OWE'
 )
 assert(
   !/^\s*import QtMultimedia/m.test(mediaQml) &&
-    mediaQml.includes('source: "BackgroundVideo.qml"'),
-  'the still-image path never imports QtMultimedia, so image-only sessions do not map it'
+    !/^\s*import QtMultimedia/m.test(backgroundQml) &&
+    !/^\s*import QtMultimedia/m.test(lockQml) &&
+    !backgroundQml.includes('MediaPlayer') &&
+    !lockQml.includes('MediaPlayer'),
+  'no shell surface builds a Qt Multimedia pipeline'
 )
 assert(
-  !/^\s*Video\s*\{/m.test(videoQml) &&
-    /property bool audioEnabled: false/.test(videoQml) &&
-    /property bool audioEnabled: false/.test(mediaQml) &&
-    /active: root\.audioEnabled && player\.hasAudio/.test(videoQml) &&
-    /audioOutput: audioLoader\.item/.test(videoQml) &&
-    /muted: root\.priming \|\| !root\.playbackEnabled/.test(videoQml) &&
-    /property: "audioEnabled"\s*\n\s*value: root\.audioEnabled/.test(mediaQml) &&
-    /firstScreen: Quickshell\.screens\.length > 0\s*\n\s*&& String\(Quickshell\.screens\[0\]\.name/.test(backgroundQml) &&
-    backgroundQml.includes('audioEnabled: panel.firstScreen') &&
-    !lockQml.includes('audioEnabled'),
-  'a sound track plays from the first monitor only, a silent file builds no audio output, and the lock stays quiet'
+  /^import Owe\.LockFeed$/m.test(lockFeedQml) &&
+    lockFeedQml.includes('LockFeed {') &&
+    lockQml.includes('source: "LockFeedSurface.qml"') &&
+    lockQml.includes('active: root.feedActive') &&
+    /feedActive: root\.video && root\.loadBackground && !root\.displaysBlank && !root\.powerSaverActive/.test(lockQml),
+  'the lock screen shows video through the OWE lock feed, loaded so a missing module costs only the video'
 )
 assert(
-  /property: "mediaSource"[\s\S]*?when: videoLoader\.item !== null && Util\.isVideoPath\(root\.path\)\s*\n\s*restoreMode: Binding\.RestoreNone/.test(mediaQml) &&
-    !videoQml.includes('Component.onDestruction'),
-  'a player on its way out keeps its source, so nothing is left loading for its destructor to cancel'
+  !/^import Owe\./m.test(lockQml),
+  'the lock view itself carries no foreign import, so the lock still loads without the feed module'
+)
+assert(
+  lockQml.includes('path: root.loadBackground ? (root.video ? root.videoPosterPath : root.backgroundPath) : ""') &&
+    lockQml.indexOf('id: feedLoader') > lockQml.indexOf('MultiEffect {') &&
+    lockQml.includes('visible: root.video') &&
+    !lockQml.includes('wallpaper.video'),
+  'the lock screen keeps its image effect for stills and shows the feed for videos'
 )
 assert(
   !mediaQml.includes('mipmap'),
@@ -86,33 +73,21 @@ assert(
   /instant \|\| !displayedBackground \|\| isVideo\(path\) \|\| isVideo\(displayedBackground\)[\s\S]*displayedBackground = finalPath/.test(backgroundQml),
   'video switches bypass the image-only reveal stack and use the durable background path'
 )
-assert(backgroundQml.includes('BackgroundMedia {') && lockQml.includes('BackgroundMedia {'), 'desktop and lock screen share video-capable media rendering')
+assert(backgroundQml.includes('BackgroundMedia {') && lockQml.includes('BackgroundMedia {'), 'desktop and lock screen share still rendering')
 assert(
-  lockQml.includes('source: wallpaper.video ? null : wallpaper') &&
-    lockQml.includes('visible: !wallpaper.video') &&
-    lockQml.includes('visible: wallpaper.video'),
-  'lock screen bypasses its image effect for video output'
+  !backgroundQml.includes('videoEnabled') &&
+    !backgroundQml.includes('displayedReloads') &&
+    !mediaQml.includes('displayedReloads'),
+  'the desktop hands video backgrounds to OWE with no player switch to carry'
 )
 assert(
-  /sessionObscured:\s*lockActive \|\| screensaverActive/.test(backgroundQml) &&
-    backgroundQml.includes('playbackEnabled: !root.sessionObscured && !root.powerSaverActive && !panel.fullscreenHere') &&
-    backgroundQml.includes('omarchy.lock') &&
-    backgroundQml.includes('omarchy.idle') &&
-    backgroundQml.includes('omarchy.battery'),
-  'desktop playback stops while covered or on battery power-saver'
-)
-assert(
-  backgroundQml.includes('Hyprland.monitorFor(modelData)') &&
-    /fullscreenHere: visibleWorkspace \? visibleWorkspace\.hasFullscreen : false/.test(backgroundQml) &&
-    !backgroundQml.includes('ToplevelManager.activeToplevel'),
-  'a fullscreen window pauses only the output it covers, wherever focus is'
-)
-assert(
-  /if \(displayedBackground === finalPath\) displayedReloads \+= 1/.test(backgroundQml) &&
-    backgroundQml.includes('reloads: root.displayedReloads') &&
-    /active: root\.path !== "" && root\.video && !root\.reloading/.test(mediaQml) &&
-    /onReloadsChanged: \{[\s\S]*?reloading = true/.test(mediaQml),
-  'a theme switch that keeps the video path still reopens the replaced file'
+  !backgroundQml.includes('playbackEnabled') &&
+    !backgroundQml.includes('sessionObscured') &&
+    !backgroundQml.includes('fullscreenHere') &&
+    !backgroundQml.includes('Hyprland.monitorFor') &&
+    !backgroundQml.includes('omarchy.lock') &&
+    !backgroundQml.includes('omarchy.battery'),
+  'the desktop no longer carries the shell video pause policy'
 )
 assert(
   barTextColor.includes('magick "$background_path[0]"'),
@@ -163,13 +138,12 @@ assert(
   'a locked video wallpaper follows what each panel actually did, not only what the lock asked for'
 )
 assert(
-  lockView.includes('playbackEnabled: root.loadBackground && !root.displaysBlank') &&
-    lockView.includes('&& !root.powerSaverActive') &&
+  /feedActive: root\.video && root\.loadBackground && !root\.displaysBlank && !root\.powerSaverActive/.test(lockQml) &&
     /displaysBlank: root\.screenBlank\(/.test(lockService) &&
     /powerSaverActive: root\.powerSaverActive/.test(lockService) &&
     /function runBlank\(\) \{\s*\n\s*root\.displaysBlank = true/.test(lockService) &&
     /function runWake\(\) \{\s*\n\s*root\.displaysBlank = false/.test(lockService),
-  'the lock screen stops playback once displays go dark or power-saver is active'
+  'the lock feed stops once displays go dark or power-saver is active'
 )
 assert(
   batteryService.includes('property string activePowerProfile') &&
@@ -186,10 +160,6 @@ assert(
   'theme switcher previews video-only themes, named preview files included'
 )
 assert(quattroUpgrade.includes("-iname '*.mp4'"), 'Quattro upgrade can seed a video-only theme background')
-assert(
-  multimediaMigration.includes('omarchy-pkg-add qt6-multimedia qt6-multimedia-ffmpeg'),
-  'existing Quattro installations receive video playback dependencies'
-)
 JS
 
 test_tmp=$(mktemp -d)
@@ -303,8 +273,11 @@ timeout_rows=$(PATH="$test_tmp/bin:$PATH" XDG_CACHE_HOME="$timeout_cache" \
 timeout_marker=$(find "$timeout_cache/omarchy/image-selector" -maxdepth 1 -type f -name '*.failed' -print -quit)
 [[ -z $timeout_marker ]] || fail "a timed out video is left to retry rather than remembered as failed"
 
-grep -qx 'qt6-multimedia' "$ROOT/install/omarchy-base.packages" || fail "Qt Multimedia runtime is a base package"
-grep -qx 'qt6-multimedia-ffmpeg' "$ROOT/install/omarchy-base.packages" || fail "Qt Multimedia FFmpeg backend is a base package"
+grep -qx 'owe' "$ROOT/install/omarchy-base.packages" || fail "OWE is a base package"
+grep -qx 'owe-lockfeed' "$ROOT/install/omarchy-base.packages" || fail "the OWE lock feed module is a base package"
+if grep -qx 'qt6-multimedia' "$ROOT/install/omarchy-base.packages"; then
+  fail "Qt Multimedia is no longer needed by the shell"
+fi
 
 pass "menu image generator creates thumbnails consumed by the picker"
 pass "direct picker generates and reuses still thumbnails"
@@ -312,7 +285,7 @@ pass "direct picker omits videos whose thumbnails cannot be generated"
 pass "a rejected video is remembered so it costs nothing on the next open"
 pass "a timed out video is left to retry"
 pass "a locked video wallpaper follows the panels' real DPMS state"
-pass "Qt Multimedia playback dependencies are declared"
+pass "OWE and its lock feed module are declared"
 
 source <(awk '
   /^(is_video_path|snapshot_background_path|background_transition_uses_snapshots|choose_theme_background|choose_staged_theme_background|set_theme_background)\(\) \{/ { copying=1 }