c65c75bb9f
Ships the daemon as a real installable, not just `cargo build`.
Artifacts
- `contrib/systemd/headroom.service` — user-scope unit. Type=simple
(the daemon doesn't fork), After=pipewire.service, Restart=on-
failure with a 2 s back-off so a crash loop doesn't spam stderr,
StandardOutput/Error=journal, LimitRTPRIO=20 / LimitNICE=-11 to
match the rtkit-style grant PipeWire's own unit carries. The
file is templated with `@bindir@` so the build derivation can
substitute in an absolute store path at install time, without
the unit having to rely on whatever `headroom` happens to be on
PATH.
- `nix/home-module.nix` — `services.headroom.enable`. Installs the
package on the user's PATH, symlinks the shipped profiles into
`$XDG_CONFIG_HOME/headroom/profiles/`, and writes the systemd
user unit (start After=pipewire.service Requires=pipewire.service
Wants=wireplumber.service WantedBy=pipewire.service). Knobs:
`installDefaultProfiles` for users who maintain their own set,
`extraProfiles` (attrset of filename → path) to drop in personal
profiles that override shipped ones by name.
- `nix/nixos-module.nix` — `programs.headroom.enable`. Narrow scope:
binary on global PATH, the package's `lib/systemd/user/*.service`
is materialised under `/etc/systemd/user/` via `systemd.packages`,
and an assertion fires if pipewire isn't enabled (clearer than a
runtime crash). Per-user defaults (profile install, RT priority
tuning) live in the Home Manager module; the two compose.
Build derivation
`postInstall` now installs the unit (with `@bindir@` substituted to
`$out/bin`) and copies `profiles/*.toml` to
`$out/share/headroom/profiles/`. The flake's version lookup moved
from `crates/headroom-cli/Cargo.toml` (where `version.workspace =
true` evaluates to a table, not a string) to the workspace
`Cargo.toml`. Modules exposed under `nixosModules.default` and
`homeModules.default`.
README
Rewrote the install section: Nix flake-based install with both
Home Manager and NixOS module examples, plus a from-scratch
`cargo install` + `install`/`sed` recipe for non-Nix users. Added
a usage section with the common `headroom` subcommands and bumped
the status banner from "pre-alpha" to "alpha" (signal chain,
routing, IPC, monitor TUI, profile reload, and packaging all work
end-to-end now).
Verified
- `nix flake check` passes; NixOS module type-checks under
nixpkgs eval.
- `nix build .#headroom` produces `bin/headroom`,
`lib/systemd/user/headroom.service` with the absolute store-path
ExecStart baked in, and all five shipped profiles under
`share/headroom/profiles/`.
- `systemd-analyze verify --user` accepts the unit.
- 185 workspace tests still pass; clippy clean at -D warnings
--all-targets; `nix fmt` happy.
39 lines
1.5 KiB
Desktop File
39 lines
1.5 KiB
Desktop File
[Unit]
|
|
Description=Headroom audio daemon (PipeWire AGC + compressor + true-peak limiter)
|
|
Documentation=https://github.com/amaanq/headroom
|
|
# PipeWire is a hard dependency: headroom registers a virtual sink and
|
|
# wires explicit links via PW's link-factory, so we can't start before
|
|
# pw-mainloop is up. ConditionUser ensures this only ever runs as a
|
|
# user-scope unit, never accidentally as the system instance.
|
|
After=pipewire.service pipewire-pulse.service wireplumber.service
|
|
Requires=pipewire.service
|
|
Wants=wireplumber.service
|
|
ConditionUser=!@system
|
|
|
|
[Service]
|
|
Type=simple
|
|
ExecStart=@bindir@/headroom daemon
|
|
# Restart on failure but not too aggressively — a tight crash loop
|
|
# would just produce a lot of stderr noise and clobber the user's
|
|
# routing repeatedly.
|
|
Restart=on-failure
|
|
RestartSec=2s
|
|
# Headroom doesn't fork; SIGTERM is the clean shutdown path. The
|
|
# default KillMode=control-group is correct for a single-process
|
|
# daemon; explicit here for clarity.
|
|
KillMode=control-group
|
|
TimeoutStopSec=5s
|
|
# Surface stdout/stderr to journald so `journalctl --user -u headroom`
|
|
# shows daemon logs with the expected RUST_LOG filtering.
|
|
StandardOutput=journal
|
|
StandardError=journal
|
|
SyslogIdentifier=headroom
|
|
# Realtime hint — pipewire grants RT scheduling via pw_thread_loop,
|
|
# but the daemon main thread benefits from a slight scheduling boost
|
|
# too. LimitRTPRIO matches the pipewire user unit's grant.
|
|
LimitRTPRIO=20
|
|
LimitRTTIME=200000
|
|
LimitNICE=-11
|
|
|
|
[Install]
|
|
WantedBy=pipewire.service
|