Add audio and region recording; make routine CI manual (#25)

The top-bar recorder previously saved a full monitor without sound. It now lets you select a region within one monitor and choose system audio, microphone audio, or both. Audio remains off by default, and recordings with audio are saved as VP8/Opus WebM files. The portal still controls screen access and cancellation; stopping from the bar or ending the video stream finishes the recording, including its audio tracks.

Region selection accounts for fractional display scales and negative monitor coordinates. The picker keeps its action buttons visible while the display list and recording options scroll together. The picker, dependency lists, and recording documentation now explain the available choices and the slurp and audio requirements.

Routine pushes and pull requests no longer start CI runners. Workspace checks and website deployment are manual, while release checks run when requested manually, through a version tag, or through a PR labeled `release`. Publishing still requires a pushed version tag. This also fixes release asset checksums by normalizing RPM filenames before generating the checksum file.

Validated locally with a release build, portal and shell recorder tests, formatting, Clippy, actionlint, packaging tests, and mocked publishing checks. Media tests encoded and decoded cropped video with audio, checked that video termination finishes live audio, and exercised system, microphone, and combined capture against a private PipeWire-Pulse server. Mixed recordings must contain both fixture frequencies, with negative controls for either missing source. The picker was also checked on 800 × 600 and 800 × 400 desktops and opened in a live nested window.
This commit is contained in:
Samuel Onoja authored and GitHub committed 2026-10-11 15:37:51 +01:00
1 parent 1b9fabbbe4
commit 42c3b290dd
19 files changed
+898 -130

No files matched your search

+14 -6
View File
@@ -7,12 +7,17 @@ portal and PipeWire dependencies.
## Record from the top bar
1. Click the recording icon.
2. Select a monitor and click **Share**.
3. Click the stop square to finish.
2. Choose a display and an audio source: **Off**, **System sound**, **Microphone**,
or **Both**. Audio is off by default; the other choices use
your default output or input device from audio settings.
3. Click **Record** to capture the whole display. For part of it, turn on
**Select a region**, click **Select region**, then drag a rectangle inside
the chosen display. Press Escape to cancel selection.
4. Click the stop square to finish.
The recorder saves VP8 WebM files under `Ferese` in your XDG Videos folder, then
shows the path in a notification. The built-in recorder does not support audio or
region recording; other recording apps can handle audio separately.
The recorder saves WebM files with VP8 video and, when selected, Opus audio under
`Ferese` in your XDG Videos folder, then shows the path in a notification. Region
recordings cover a rectangle within one display; they cannot span displays.
If recording fails, a notification reports the error and any unfinished
`.webm.part` file.
@@ -50,7 +55,10 @@ permissions are not saved. Stopping a stream does not erase a saved permission.
## Requirements and limits
Install PipeWire, WirePlumber, `xdg-desktop-portal`, and `xdg-desktop-portal-gtk`.
The built-in recorder also needs GStreamer's PipeWire, base, and good plugins;
The built-in recorder also needs GStreamer's PipeWire, base, and good plugins.
Region selection needs `slurp`; audio recording needs PipeWire-Pulse or PulseAudio
and the GStreamer PulseAudio and Opus plugins. With audio set to Off, the recorder
does not open an audio device. For distribution package names,
see the [package lists](installation.md#requirements).
The installer supplies Ferese's portal backend and selects it for screen sharing.