Skip to content

feat: interactive Recording with PTY and Hotkeys #316

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.

Sign up for GitHub

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

Jump to bottom
Open
sassman wants to merge 44 commits into
base: main
Choose a base branch
from
Open

feat: interactive Recording with PTY and Hotkeys #316

sassman wants to merge 44 commits into from

Conversation

@sassman
Copy link
Owner

@sassman sassman commented Dec 27, 2025 •
edited
Loading

Interactive Recording with PTY and Hotkeys

Replaces the simple subprocess shell with a PTY-based architecture and adds keyboard hotkeys for in-session control.

Changes

PTY shell spawning

  • Shell now runs in a proper pseudo-terminal (nix::pty::openpty)
  • Enables raw mode keyboard interception while maintaining full shell interactivity

Keyboard hotkeys via crossterm

  • F2: Capture a screenshot (saved as PNG with effects applied)
  • F3: Toggle keystroke capture (placeholder for future overlay feature)
  • Ctrl+D: End recording
  • Other input forwarded to shell unchanged

Event-driven actor model

  • New EventRouter coordinates capture, input, shell output, and presenter actors
  • Uses tokio::sync::broadcast for inter-actor communication

Recording countdown

  • 3-second countdown before capture begins

On-screen visual feedback (macOS, optional)

Headless recorder library API

  • Requires lib feature
  • HeadlessRecorder for programmatic recording of any window to GIF/MP4
  • Builder pattern with type-safe config (Decor, BackgroundColor, Wallpaper enums)
  • Includes post-processing pipeline (shadows, corners, wallpaper backgrounds)

Lazy logging

  • Log file (t-rec-recording.log) only created when something is logged

Structure

Reorganized as a Cargo workspace:

  • crates/t-rec — CLI and library

@sassman
feat: using crossterm key events to intercept the screenshot trigger
6927409 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat: add countdown when t-rec starts, fix auto-skip countdown
0b648ca 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat: create a lazy logger, so that no empty log file flies around
755ec83 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
chore: fix lints
10ecebb 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
fix: fix outdated convert command call in docblock
9182a99 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat: use skylight as on-screen-display lib to show screenshot indica…
563c1fe 
…tors

- also restructure threading and messaging so that we can broadcast events between threads (e.g. screenshots)

Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat: restructure to Cargo workspace with modular crates
c9d0388 
Enable cleaner architecture by splitting into workspace with skylight-osd crate for on-screen display functionality.
@sassman sassman force-pushed the feat/crossterm-input-interception branch from 0e1b555 to c9d0388 Compare December 27, 2025 23:56
@sassman
chore: fix lints and add tests for capture mechanics
39747bf 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat(skylight-osd): examples for skylight-osd
56e502e 
- also add a README.md explaining a quickstart and the API and the examples
- fix glitch with one particular but random white border showing up

Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat: evolve skylight-osd into osd-flash crate with better structuring
0b94596 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
chore: fmt fix
dc85c53 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman sassman force-pushed the feat/crossterm-input-interception branch from 0307c39 to dc85c53 Compare December 30, 2025 00:27
sassman added 10 commits December 30, 2025 12:49
@sassman
chore: refactored geometry into an own folder module, with margin as …
fe9cff9 
…new abstraction

Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat: evolve to a new builder-api
bbed49c 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
chore: cleanup after new API was introduced
37a0b7d 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
chore: refine examples + transition to a minimal NSApplication setup
e84b939 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat: support layered drawing and text drawing, added 2 examples for it
dda700b 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat: focus more on the public external higher level API and not expo…
f43a8b2 
…se backend internals in the prelude module

Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat: add layout/style modules, window styling API, and new examples
4ecc518 
- Add layout module (Padding, Margin, Border, BoxModel)
- Add style module (Paint, TextStyle)
- Add background() and corner_radius() to OsdFlashBuilder
- Add examples: battery, equalizer, radar, sierpinski
- Fix canvas trait to use ref parameters
- Fix content bounds and center positioning
@sassman
feat: add animation capabilities with a builder API
b9fd5fa 
- Add a keyframe based API to the OsdWindowBuilder
  - interpolates numerical values of color and scale between the phases of keyframes
  - has change detection based on object order in the keyframe "drawing"
  - based on the the architecture at `.planning/osd-flash-animation-architecture.md` the documentation is on a module level at `crates/osd-flash/src/animation/mod.rs`
- Add a pulsing animation example (crates/osd-flash/examples/recording_indicator_pulse.rs)
- todo: there is a small flickering, so we explore if double buffering from CALayer might help us
@sassman
feat(t-rec): make osd-flash an optional feature with rollback support
28fcf6c 
Add `osd-flash-indicator` feature flag (enabled by default) that:
- Uses dual cfg guard (target_os + feature) for proper platform handling
- Falls back to NoopPresenter when disabled or on non-macOS
- Removes osd-flash from dependency tree when disabled

This provides a rollback strategy if OSD issues arise:
  cargo build --release --no-default-features

Also adds --no-default-features CI testing to verify rollback path.
@sassman
feat: implement the core-animation crate, as foundation for osd-flash…
6f0d864 
… animations

Signed-off-by: Sven Kanoldt <[email protected]>
@sassman sassman force-pushed the feat/crossterm-input-interception branch from ede5dd5 to 6f0d864 Compare January 8, 2026 23:39
sassman added 3 commits January 9, 2026 11:47
@sassman
feat: implement t-rec HeadlessRecorder that is used to create recordi…
f244e77 
…ngs for the core-animation examples

Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat: add a pulsing-poc crate and refined core-animations crate
1c5c96f 
- we are just about to overhaul osd-flash and simplify it greatly

Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat: after refactoring of osd-flash
3916087 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman sassman force-pushed the feat/crossterm-input-interception branch from f4d7a9a to 98f3401 Compare January 11, 2026 08:46
@sassman
fix: fmt + clippy
e089d8d 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman sassman force-pushed the feat/crossterm-input-interception branch from 98f3401 to e089d8d Compare January 11, 2026 11:28
@sassman sassman force-pushed the feat/crossterm-input-interception branch from 4e20078 to 2980a2d Compare January 11, 2026 14:44
@sassman
fix: fix linux gating issues
aebeb5d 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman sassman force-pushed the feat/crossterm-input-interception branch from 3cd50a1 to aebeb5d Compare January 11, 2026 15:08
@sassman sassman force-pushed the feat/crossterm-input-interception branch from 901e44b to 5717775 Compare January 11, 2026 21:18
@sassman sassman force-pushed the feat/crossterm-input-interception branch from 7f7c3d5 to 5f63b5c Compare January 11, 2026 23:23
@sassman
fix: make capture tests deterministic
73afbaf 
Tests failed on CI because the stop timer started before capture began.
On slow CI machines, timeout expired before all frames were captured.

TestApi now sends Stop when the last frame is returned, removing
timing dependency entirely.
@sassman
fix: recording indicator shown only once at start
8bbbc73 
- Remove duplicate show_recording_indicator() call in presenter
- Move RecordingStarted event from countdown loop to fire once after countdown
@sassman sassman changed the title feat: f2 interception and screenshot indicator feat: interactive Recording with PTY and Hotkeys Jan 13, 2026
@sassman sassman requested a review from Copilot January 14, 2026 07:13
Copilot AI reviewed Jan 14, 2026
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@sassman
chore: cleanup separated crates core-animation and duration-ext + mig…
c11abae 
…rate to objc2- crates for t-rec

Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
chore: cleanup poc crates
fb33a17 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
chore: cleanup poc experiments
81661e2 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
feat: disable osd-flash as default feature
6242808 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
refactor(osd-flash): migrate from anyhow to typed errors
090d162 
Replace anyhow with custom Error enum for better API stability:
- Add Error::NotOnMainThread for thread safety violations
- Add Error::NoScreenAvailable for missing display
- Replace panics with proper error propagation in apply_position
@sassman
chore: remove osd-flash crate for PR splitting
fa547cb 
This commit removes osd-flash and its integration to allow splitting
the feature branch into two PRs:
1. crossterm-input-interception (this branch)
2. osd-flash-for-screenshots (separate branch)

Removed:
- crates/osd-flash/ directory
- osd-flash workspace member
- osd-flash-indicator feature from t-rec
- OSD presenter integration code
- test_flash CLI arg
@sassman
chore: fix lint
61d0824 
Signed-off-by: Sven Kanoldt <[email protected]>
@sassman
fix: make idle threshold test more robust on CI
cf917a0 
Increase the idle threshold from 50ms to 500ms to avoid timing-related
flakiness on CI where thread scheduling can vary. Also relax the
assertion to check for >= 2 frames rather than >= 3, as the test only
needs to verify that frames within the threshold are preserved.
sassman
sassman commented Jan 16, 2026
View reviewed changes
crates/t-rec/src/event_router.rs
use super::*;

#[test]
fn test_event_router() {
Copy link
Owner Author

@sassman sassman Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Testing that's broadcasting is really working so two receivers in one test is needed

@sassman
refactor(wallpapers): consolidate wallpaper types and validation
43121fb 
- Move Wallpaper, WallpaperConfig, WallpaperError, ValidatedPath from
  types.rs to new wallpapers/types.rs module
- Add validate_wallpaper_dimensions() for DynamicImage validation
- Add resolve_wallpaper() as main entry point for loading/validating
- Update is_builtin_wallpaper() to use Wallpaper::builtin_values() as
  single source of truth
- Simplify validate_wallpaper_config() in main.rs (~50 to ~15 lines)
- Replace tuple (Wallpaper, u32) with WallpaperConfig in headless.rs
- Make wallpapers module public in lib.rs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@sassman