Repository navigation
feat(recording): show pressed keys on screen while a take is live #1633
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -82,6 +82,11 @@ import { isDiagnosticModeEnabled, mainLogFile } from "../diagnostics/main-log-fi | |
| import { createZip } from "../diagnostics/zip"; | ||
| import { mainT } from "../i18n"; | ||
| import { getInstallChannel } from "../install-channel"; | ||
| import { | ||
| broadcastKeystroke, | ||
| hideKeystrokeOverlay, | ||
| showKeystrokeOverlay, | ||
| } from "../keystrokeOverlay"; | ||
| import { | ||
| DEFAULT_RECORDINGS_DIR, | ||
| getRecordingsDirInfo, | ||
|
|
@@ -797,6 +802,14 @@ const CURSOR_SAMPLE_INTERVAL_MS = 33; | |
| const MAX_CURSOR_SAMPLES = 60 * 60 * 30; // 1 hour @ 30Hz | ||
|
|
||
| let cursorRecordingSession: CursorRecordingSession | null = null; | ||
| /** | ||
| * Keyboard-only capture for takes that do not run a cursor telemetry session | ||
| * (Windows system-cursor mode). The keystroke overlay needs the native helper's | ||
| * low-level keyboard hook even when no editable cursor overlay is drawn; reusing | ||
| * the telemetry session would tie key capture to `editable-overlay` and leave | ||
| * system-cursor takes with an overlay that never shows a key (#1633 review). | ||
| */ | ||
| let keystrokeKeySession: CursorRecordingSession | null = null; | ||
| let pendingCursorRecordingData: CursorRecordingData | null = null; | ||
| let nativeWindowsCaptureProcess: ChildProcessWithoutNullStreams | null = null; | ||
| let nativeWindowsCaptureOutput = ""; | ||
|
|
@@ -1398,6 +1411,7 @@ async function startCursorRecording(recordingId?: number) { | |
| sourceId: getSelectedSourceId(), | ||
| startTimeMs: | ||
| typeof recordingId === "number" && Number.isFinite(recordingId) ? recordingId : undefined, | ||
| onKeyEvent: (event) => broadcastKeystroke(event.vk, event.modifiers), | ||
| }); | ||
|
|
||
| try { | ||
|
|
@@ -1423,6 +1437,42 @@ async function stopCursorRecording() { | |
| } | ||
| } | ||
|
|
||
| /** | ||
| * Start a keyboard-only native session for a Windows take that has no cursor | ||
| * telemetry session. The helper's low-level keyboard hook is what drives the | ||
| * keystroke overlay; it is independent of the selected cursor mode. No-op when | ||
| * a cursor session already exists (it carries the same hook) or off Windows. | ||
| */ | ||
| async function startKeystrokeKeyCapture(): Promise<void> { | ||
| if (process.platform !== "win32" || cursorRecordingSession || keystrokeKeySession) return; | ||
| const session = createCursorRecordingSession({ | ||
| getDisplayBounds: getSelectedSourceBounds, | ||
| maxSamples: MAX_CURSOR_SAMPLES, | ||
| platform: "win32", | ||
| sampleIntervalMs: CURSOR_SAMPLE_INTERVAL_MS, | ||
| sourceId: getSelectedSourceId(), | ||
| onKeyEvent: (event) => broadcastKeystroke(event.vk, event.modifiers), | ||
| }); | ||
| try { | ||
| await session.start(); | ||
| keystrokeKeySession = session; | ||
|
Comment on lines
+1457
to
+1458
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Track a pending keystroke session so Stop can tear it down.
A second take that starts during the same wait also passes the guard at line 1447, because the slot is still The required behavior is:
|
||
| } catch (error) { | ||
| console.error("Failed to start keystroke key capture:", error); | ||
| } | ||
| } | ||
|
|
||
| /** Stop the keyboard-only session; its cursor samples are never written out. */ | ||
| async function stopKeystrokeKeyCapture(): Promise<void> { | ||
| const session = keystrokeKeySession; | ||
| keystrokeKeySession = null; | ||
| if (!session) return; | ||
| try { | ||
| await session.stop(); | ||
| } catch (error) { | ||
| console.error("Failed to stop keystroke key capture:", error); | ||
| } | ||
| } | ||
|
|
||
| async function writePendingCursorTelemetry(videoPath: string) { | ||
| const telemetryPath = `${videoPath}.cursor.json`; | ||
| if (pendingCursorRecordingData && pendingCursorRecordingData.samples.length > 0) { | ||
|
|
@@ -2037,6 +2087,13 @@ export function registerIpcHandlers( | |
| ) { | ||
| /** The HUD is recording a take, the user's or an MCP client's. Set by `setAppRecording` only. */ | ||
| let appRecording = false; | ||
| /** | ||
| * Resolved capture bounds of the current take, when the start path knows them | ||
| * explicitly (native Windows request can target a display other than the | ||
| * mutable selection). The keystroke overlay is positioned from these; the | ||
| * selection getter is only a fallback for paths without explicit bounds. | ||
| */ | ||
| let takeRecordingBounds: Rectangle | null = null; | ||
| const recordingCompletion = new RecordingCompletion(); | ||
| /** | ||
| * Every start and stop of a take goes through here: the browser path's `set-recording-state` | ||
|
|
@@ -2056,6 +2113,24 @@ export function registerIpcHandlers( | |
| if (!recording && !preparing) cameraPreview.setCaptureAllowed(true); | ||
| if (!preparing) mcpAppRecorder.recordingChanged(recording, recordingId); | ||
| onRecordingStateChange?.(recording, sourceName, preparing); | ||
| // The keystroke overlay lives only while a take is live, on the display being | ||
| // recorded. Windows only: the overlay's invisibility-to-capture relies on | ||
| // content protection, which `applyContentProtection` gates per platform. | ||
| if (process.platform === "win32") { | ||
| if (recording) { | ||
| void showKeystrokeOverlay(takeRecordingBounds ?? getSelectedSourceBounds()); | ||
| // The keystroke overlay needs the native keyboard hook in every cursor | ||
| // mode. In editable-overlay mode the cursor session already carries it; | ||
| // otherwise (system cursor) no session is running, so start a | ||
| // keyboard-only one. Guarded by `!preparing` so it attaches to the take | ||
| // proper, after the editable-overlay session has had a chance to start. | ||
| if (!preparing) void startKeystrokeKeyCapture(); | ||
| } else { | ||
| hideKeystrokeOverlay(); | ||
| takeRecordingBounds = null; | ||
| void stopKeystrokeKeyCapture(); | ||
| } | ||
| } | ||
| }; | ||
| const appSettings = new AppSettingsStore(app.getPath("userData")); | ||
| const broadcastSelectedSource = (source: SelectedSource | null) => { | ||
|
|
@@ -3243,6 +3318,12 @@ export function registerIpcHandlers( | |
| } | ||
| // Reserve startup before cursor/helper awaits without reporting a started take. | ||
| startReserved = true; | ||
| // Publish the overlay's display only now, after the final reservation | ||
| // guard: a rejected start must not move a take that is already live, and | ||
| // there is no await between here and the overlay show below (#1633). | ||
| // The request resolved this display; it may differ from the mutable | ||
| // selection when an MCP client targets another screen. | ||
| takeRecordingBounds = bounds; | ||
| setAppRecording(true, selectedSource?.name ?? "Screen", undefined, true); | ||
| await fs.mkdir(RECORDINGS_DIR, { recursive: true }); | ||
| nativeWindowsCaptureOutput = ""; | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| import { BrowserWindow, type Rectangle } from "electron"; | ||
| import { createKeystrokeOverlayWindow } from "./windows"; | ||
|
|
||
| /** | ||
| * Lifecycle of the keystroke overlay: one window, alive only while a take is live, | ||
| * bounded to the display being recorded. The window is destroyed on hide rather than | ||
| * cached — a hidden window would otherwise linger as the app's last window and block | ||
| * quit on Windows, the same way the countdown overlay's lingering is special-cased in | ||
| * `main.ts`. A take recreates it lazily, and the first badges may land during the | ||
| * ~0.2 s the renderer needs to load: acceptable for a hint overlay. | ||
| */ | ||
| let overlayWindow: BrowserWindow | null = null; | ||
| // The first-frame wait, stored alongside the window so EVERY caller awaits it — | ||
| // including callers that receive an already-created window still mid-load. Without | ||
| // this, a second recording start could showInactive an unpainted window (#1633). | ||
| let overlayReady: Promise<void> | null = null; | ||
|
|
||
| async function ensureOverlayWindow(): Promise<BrowserWindow | null> { | ||
| if (!overlayWindow || overlayWindow.isDestroyed()) { | ||
| overlayWindow = createKeystrokeOverlayWindow(); | ||
| if (overlayWindow.isDestroyed()) { | ||
| overlayWindow = null; | ||
| return null; | ||
| } | ||
| // Wait for the first frame before showing, else Chromium flashes a black | ||
| // rectangle because it has not rendered any pixels yet. The resolve is | ||
| // idempotent and shared by all callers for this window's lifetime. | ||
| overlayReady = new Promise<void>((resolve) => { | ||
| const win = overlayWindow; | ||
| if (!win || win.isDestroyed()) { | ||
| resolve(); | ||
| return; | ||
| } | ||
| if (win.webContents.isLoading()) { | ||
| win.once("ready-to-show", resolve); | ||
| // A window destroyed before its first frame must not leave waiters | ||
| // hanging; resolve on close too, the destroyed check below then bails. | ||
| win.once("closed", resolve); | ||
| } else { | ||
| resolve(); | ||
| } | ||
| }); | ||
| } | ||
| // Capture the window we are about to wait on. A stop + start during the await | ||
| // can replace `overlayWindow`; this continuation must not then pick up the new | ||
| // window and show it with the old bounds before its own first frame (#1633). | ||
| const awaited = overlayWindow; | ||
| // Every caller, new window or reused, waits on the same readiness signal. | ||
| await overlayReady; | ||
| if (!awaited || awaited.isDestroyed() || overlayWindow !== awaited) { | ||
| // Only clear the globals if the window we waited on is still the current one; | ||
| // otherwise a replacement (with its own readiness wait) owns them. | ||
| if (overlayWindow === awaited) { | ||
| overlayWindow = null; | ||
| overlayReady = null; | ||
| } | ||
| return null; | ||
| } | ||
| return awaited; | ||
| } | ||
|
|
||
| export async function showKeystrokeOverlay(bounds: Rectangle): Promise<void> { | ||
| const win = await ensureOverlayWindow(); | ||
| if (!win || win.isDestroyed()) { | ||
| return; | ||
| } | ||
|
|
||
| win.setBounds(bounds); | ||
| if (!win.isVisible()) { | ||
| win.showInactive(); | ||
| } | ||
| } | ||
|
|
||
| export function hideKeystrokeOverlay(): void { | ||
| const win = overlayWindow; | ||
| overlayWindow = null; | ||
| overlayReady = null; | ||
| if (win && !win.isDestroyed()) { | ||
| win.destroy(); | ||
| } | ||
| } | ||
|
|
||
| /** Forwarded live keydowns (`windowsNativeRecordingSession` → `handlers`). */ | ||
| export function broadcastKeystroke(vk: number, modifiers: number): void { | ||
| const win = overlayWindow; | ||
| if (win && !win.isDestroyed() && win.isVisible()) { | ||
| win.webContents.send("keystroke-overlay-key", vk, modifiers); | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Capture keys independently of editable cursor telemetry.
This callback receives events only while
startCursorRecordingruns. Native Windows starts skip that function unlesscursorCaptureMode === "editable-overlay"at Line 3289. The browser path also stops the session for other cursor modes at Lines 4463–4466.A fresh take with system cursor capture therefore shows an overlay that receives no keys. Give keyboard capture its own recording lifetime, or keep its producer active without enabling editable cursor telemetry. Preserve the selected cursor mode.