From ca6a6380c556f1977b8db0fbaf155a9d1c16d2d5 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Thu, 29 Oct 2026 10:55:46 -0700 Subject: [PATCH] feat(record): record the window track by default where windows can be listed --- komorebi-recorder/src/cli/record.rs | 53 +++++++++++++++++--- komorebi-recorder/src/session.rs | 2 +- komorebi-recorder/src/sources/windowtrack.rs | 7 +-- 3 files changed, 51 insertions(+), 11 deletions(-) diff --git a/komorebi-recorder/src/cli/record.rs b/komorebi-recorder/src/cli/record.rs index 4dc31268..93c022bb 100644 --- a/komorebi-recorder/src/cli/record.rs +++ b/komorebi-recorder/src/cli/record.rs @@ -93,19 +93,25 @@ pub struct RecordArgs { /// Windows has hidden, such as a ghost tile #[arg(long)] pub no_probe_windows: bool, - /// Also sample every top-level window's rect, visibility and minimized (and, on Windows, - /// cloaked) state at HZ samples a second [default when given without a value: 30; 1 to 120] - /// into `windows.jsonl`, so that "which window was where in this frame" has an answer for - /// every frame; `sheet --windows` draws it. Written only when something changed, plus a full - /// row each second, so a still desktop costs almost nothing. Off unless asked for + /// Sample every top-level window's rect, visibility and minimized (and, on Windows, + /// cloaked) state at HZ samples a second [default: 30; 1 to 120] into `windows.jsonl`, so + /// that "which window was where in this frame" has an answer for every frame; `sheet + /// --windows` draws it. Written only when something changed, plus a full row each second, so + /// a still desktop costs almost nothing. On by default wherever windows can be listed, so + /// this is for choosing another rate (`--window-track=60`); see `--no-window-track` #[arg( long, value_name = "HZ", num_args = 0..=1, require_equals = true, - default_missing_value = "30" + default_missing_value = "30", + conflicts_with = "no_window_track" )] pub window_track: Option, + /// Do not sample the windows (see `--window-track`, which is on by default on a host that + /// can list windows): the recording then cannot say where a window was in a given frame + #[arg(long)] + pub no_window_track: bool, /// Do not capture the screen: record everything else (komorebi's events and log, the OS /// trace and incidents) on the same clock #[arg(long, conflicts_with = "displays")] @@ -168,6 +174,7 @@ impl Default for RecordArgs { probe_windows: false, no_probe_windows: false, window_track: None, + no_window_track: false, no_oslog: false, oslog_apps: AppsMode::Managed, oslog_all: false, @@ -236,10 +243,42 @@ impl RecordArgs { no_komorebi: self.no_komorebi, no_video: self.no_video, probe_windows: self.probes_windows(), - window_track: self.window_track, + window_track: self.window_track_hz(), } } + /// Returns the rate the recording samples its windows at, or `None` for no window track. + /// + /// The track is on by default ([`DEFAULT_HZ`](crate::sources::windowtrack::DEFAULT_HZ)) + /// wherever windows can be listed ([`CAN_LIST`](crate::platform::window::CAN_LIST)), unless + /// `--no-window-track` says not to. `--window-track[=HZ]` asked for outright is kept as asked, + /// so that a host that cannot do it says so instead of recording without it. + /// + /// # Example + /// + /// ```rust + /// use komorebi_recorder::cli::RecordArgs; + /// use komorebi_recorder::platform::window::CAN_LIST; + /// + /// // the default follows the host + /// assert_eq!(RecordArgs::default().window_track_hz().is_some(), CAN_LIST); + /// + /// // a rate asked for is kept, and the track can be turned off + /// let faster = RecordArgs { window_track: Some(60), ..RecordArgs::default() }; + /// assert_eq!(faster.window_track_hz(), Some(60)); + /// let off = RecordArgs { no_window_track: true, ..RecordArgs::default() }; + /// assert_eq!(off.window_track_hz(), None); + /// ``` + #[must_use] + pub fn window_track_hz(&self) -> Option { + if self.no_window_track { + return None; + } + self.window_track.or_else(|| { + crate::platform::window::CAN_LIST.then_some(crate::sources::windowtrack::DEFAULT_HZ) + }) + } + /// Returns whether the recording reads what Windows says about each window. /// /// It does on Windows and on KDE, unless `--no-probe-windows` says not to, and it does not on a diff --git a/komorebi-recorder/src/session.rs b/komorebi-recorder/src/session.rs index ea49c88b..7c78fd67 100644 --- a/komorebi-recorder/src/session.rs +++ b/komorebi-recorder/src/session.rs @@ -213,7 +213,7 @@ pub struct Manifest { pub apps: Vec, /// What was recorded of komorebi's subscriber events. pub events: EventSummary, - /// The sampled window track (`windows.jsonl`), if `--window-track` was asked for. + /// The sampled window track (`windows.jsonl`), unless `--no-window-track` (it is on by default where windows can be listed). #[serde(default, skip_serializing_if = "Option::is_none")] pub window_track: Option, /// `host-clock` when frame timestamps were verified to be on the mach clock. diff --git a/komorebi-recorder/src/sources/windowtrack.rs b/komorebi-recorder/src/sources/windowtrack.rs index 0a0d0415..c39cc129 100644 --- a/komorebi-recorder/src/sources/windowtrack.rs +++ b/komorebi-recorder/src/sources/windowtrack.rs @@ -5,8 +5,9 @@ //! times, and the per-event probe (`winprobe`) reads one window at the moment of one event. This //! source asks the OS for every window's rect, many times a second, so any frame has an answer. //! -//! It is off unless asked for (`record --window-track[=HZ]`, 30 Hz when no rate is given, clamped -//! to [`MIN_HZ`]..=[`MAX_HZ`]), and writes `windows.jsonl` in the session directory. +//! It is on by default wherever windows can be listed (`record`, at [`DEFAULT_HZ`]); `record +//! --window-track=HZ` picks another rate (clamped to [`MIN_HZ`]..=[`MAX_HZ`]) and +//! `--no-window-track` turns it off. It writes `windows.jsonl` in the session directory. //! //! # The file //! @@ -82,7 +83,7 @@ use std::time::Instant; /// The file the track is written to, in the session directory. pub const WINDOWS_FILE: &str = "windows.jsonl"; -/// The rate used for `--window-track` given without one. +/// The rate used when `record` is not told one. pub const DEFAULT_HZ: u32 = 30; /// The slowest rate that can be asked for. pub const MIN_HZ: u32 = 1;