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 2 commits
8833736
d263732
f7bac5e
0bef5ee
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 |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| 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(); | ||
| } | ||
| }); | ||
| } | ||
| // Every caller, new window or reused, waits on the same readiness signal. | ||
| await overlayReady; | ||
| if (!overlayWindow || overlayWindow.isDestroyed()) { | ||
|
coderabbitai[bot] marked this conversation as resolved.
Resolved
|
||
| overlayWindow = null; | ||
| overlayReady = null; | ||
| return null; | ||
| } | ||
| return overlayWindow; | ||
| } | ||
|
|
||
| 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); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,6 +28,48 @@ static std::atomic<int> g_leftUpCount{0}; | |
| static std::atomic<bool> g_stop{false}; | ||
| static std::mutex g_stdoutMtx; | ||
|
|
||
| // ───────────────────────────────────────────────────────────────────────────── | ||
| // Global keyboard-hook state: keydowns the on-screen keystroke overlay shows. | ||
| // The hook only queues — an LL hook must not block, so the sampling loop drains | ||
| // the queue and writes the JSONL lines. ponytail: the repeat filter is one | ||
| // atomic, so alternating two held keys re-queues a repeat of the first one; | ||
| // a per-key down set is the upgrade if that ever matters. | ||
| // ───────────────────────────────────────────────────────────────────────────── | ||
| static HHOOK g_keyHook = nullptr; | ||
| static std::mutex g_keyMtx; | ||
| struct KeyPress { | ||
| DWORD vk; | ||
| DWORD modifiers; // Modifier mask captured at event time (see modifierMask). | ||
| }; | ||
| static std::vector<KeyPress> g_keyQueue; | ||
| static std::atomic<DWORD> g_lastKeyDown{0}; | ||
|
|
||
| // The generic modifier virtual keys are what the renderer's label layer knows. | ||
| // Left/right variants (VK_LSHIFT..VK_RMENU) are normalised here, at the hook, | ||
| // so both the repeat filter and every downstream consumer see the generic code. | ||
| static DWORD normalizeModifierVk(DWORD vk) { | ||
| switch (vk) { | ||
| case 0xA0: case 0xA1: return VK_SHIFT; // VK_LSHIFT / VK_RSHIFT | ||
| case 0xA2: case 0xA3: return VK_CONTROL; // VK_LCONTROL / VK_RCONTROL | ||
| case 0xA4: case 0xA5: return VK_MENU; // VK_LMENU / VK_RMENU | ||
| default: return vk; | ||
| } | ||
| } | ||
|
|
||
| // Bit mask of modifiers currently held, read IN THE HOOK at event time. The | ||
| // sampling loop drains the queue later, when the physical state may have | ||
| // changed; inferring it there would mislabel a combo whose modifier was already | ||
| // released. Bit values match the renderer's MODIFIER mask in keystrokeLabels.ts. | ||
| static DWORD modifierMask() { | ||
| DWORD mask = 0; | ||
| if (GetAsyncKeyState(VK_SHIFT) & 0x8000) mask |= 1; // Shift | ||
| if (GetAsyncKeyState(VK_CONTROL) & 0x8000) mask |= 2; // Ctrl | ||
| if (GetAsyncKeyState(VK_MENU) & 0x8000) mask |= 4; // Alt | ||
| if (GetAsyncKeyState(VK_LWIN) & 0x8000) mask |= 8; // Win (either side) | ||
| if (GetAsyncKeyState(VK_RWIN) & 0x8000) mask |= 8; | ||
| return mask; | ||
| } | ||
|
|
||
| static LRESULT CALLBACK LowLevelMouseProc(int nCode, WPARAM wParam, LPARAM lParam) { | ||
| if (nCode >= 0) { | ||
| if (wParam == WM_LBUTTONDOWN) g_leftDownCount.fetch_add(1, std::memory_order_relaxed); | ||
|
|
@@ -36,6 +78,29 @@ static LRESULT CALLBACK LowLevelMouseProc(int nCode, WPARAM wParam, LPARAM lPara | |
| return CallNextHookEx(g_mouseHook, nCode, wParam, lParam); | ||
| } | ||
|
|
||
| static LRESULT CALLBACK LowLevelKeyboardProc(int nCode, WPARAM wParam, LPARAM lParam) { | ||
| if (nCode >= 0) { | ||
| const KBDLLHOOKSTRUCT* info = reinterpret_cast<KBDLLHOOKSTRUCT*>(lParam); | ||
| if (info && (wParam == WM_KEYDOWN || wParam == WM_SYSKEYDOWN)) { | ||
| const DWORD vk = normalizeModifierVk(info->vkCode); | ||
| // The LL hook keeps firing while a key is held; the overlay wants one | ||
| // badge per press, so only a change of key passes the filter. The | ||
| // normalised code is used so L/R variants of a modifier do not count | ||
| // as alternating distinct keys. | ||
| if (g_lastKeyDown.exchange(vk, std::memory_order_relaxed) != vk) { | ||
| // Capture the modifier state here, at event time, not when the | ||
| // sampling loop drains the queue (#1633). | ||
| const DWORD mods = modifierMask(); | ||
| std::lock_guard<std::mutex> lock(g_keyMtx); | ||
| g_keyQueue.push_back({vk, mods}); | ||
| } | ||
| } else if (info && (wParam == WM_KEYUP || wParam == WM_SYSKEYUP)) { | ||
| g_lastKeyDown.store(0, std::memory_order_relaxed); | ||
|
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. Preserve modifier state in the event stream. Win-down, A-down, Win-up and Win-down, Win-up, A-down produce the same transmitted keydowns. The correct badges differ:
|
||
| } | ||
| } | ||
| return CallNextHookEx(g_keyHook, nCode, wParam, lParam); | ||
| } | ||
|
|
||
| // ───────────────────────────────────────────────────────────────────────────── | ||
| // Utilities | ||
| // ───────────────────────────────────────────────────────────────────────────── | ||
|
|
@@ -322,6 +387,24 @@ static void runSamplingLoop(int intervalMs, HWND targetWindow, const CLSID& pngC | |
| const int downCount = g_leftDownCount.exchange(0, std::memory_order_relaxed); | ||
| const int upCount = g_leftUpCount.exchange(0, std::memory_order_relaxed); | ||
|
|
||
| // Drain the keyboard hook's queue: one JSONL line per keydown, numeric | ||
| // fields only, so nothing needs escaping. Keyups carry no information the | ||
| // overlay shows, so they are never emitted. `modifiers` was captured in | ||
| // the hook at event time so a released modifier cannot relabel the combo. | ||
| std::vector<KeyPress> keys; | ||
| { | ||
| std::lock_guard<std::mutex> lock(g_keyMtx); | ||
| keys.swap(g_keyQueue); | ||
| } | ||
| for (const KeyPress& key : keys) { | ||
| char keyBuf[128]; | ||
| std::snprintf(keyBuf, sizeof(keyBuf), | ||
| "{\"type\":\"key\",\"timestampMs\":%" PRId64 ",\"vk\":%lu,\"modifiers\":%lu}", | ||
| nowMs(), static_cast<unsigned long>(key.vk), | ||
| static_cast<unsigned long>(key.modifiers)); | ||
| writeJsonLine(keyBuf); | ||
| } | ||
|
|
||
| CURSORINFO ci{}; | ||
| ci.cbSize = sizeof(ci); | ||
| if (!GetCursorInfo(&ci)) { | ||
|
|
@@ -474,6 +557,13 @@ int main(int argc, char* argv[]) { | |
| return 1; | ||
| } | ||
|
|
||
| // The keyboard hook feeds the keystroke overlay only, so its failure costs | ||
| // nothing the recording needs — warn and keep going rather than aborting. | ||
| g_keyHook = SetWindowsHookEx(WH_KEYBOARD_LL, LowLevelKeyboardProc, GetModuleHandle(nullptr), 0); | ||
| if (!g_keyHook) { | ||
| std::cerr << "SetWindowsHookEx(WH_KEYBOARD_LL) failed; no keystroke overlay" << std::endl; | ||
| } | ||
|
|
||
| // Prime GetAsyncKeyState so the first poll doesn't return stale "since-last-call" bits | ||
| GetAsyncKeyState(VK_LBUTTON); | ||
|
|
||
|
|
@@ -499,6 +589,7 @@ int main(int argc, char* argv[]) { | |
| g_stop.store(true, std::memory_order_relaxed); | ||
| if (sampler.joinable()) sampler.join(); | ||
| UnhookWindowsHookEx(g_mouseHook); | ||
| if (g_keyHook) UnhookWindowsHookEx(g_keyHook); | ||
| Gdiplus::GdiplusShutdown(gdipToken); | ||
| return 0; | ||
| } | ||
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.