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.
128 lines
4.4 KiB
Nix
128 lines
4.4 KiB
Nix
{
|
|
description = "Headroom — AGC + compressor + true-peak limiter daemon for PipeWire";
|
|
|
|
inputs = {
|
|
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
|
flake-utils.url = "github:numtide/flake-utils";
|
|
rust-overlay = {
|
|
url = "github:oxalica/rust-overlay";
|
|
inputs.nixpkgs.follows = "nixpkgs";
|
|
};
|
|
};
|
|
|
|
outputs = { self, nixpkgs, flake-utils, rust-overlay }:
|
|
flake-utils.lib.eachSystem [ "x86_64-linux" "aarch64-linux" ]
|
|
(system:
|
|
let
|
|
pkgs = import nixpkgs {
|
|
inherit system;
|
|
overlays = [ rust-overlay.overlays.default ];
|
|
};
|
|
|
|
rustToolchain = pkgs.rust-bin.fromRustupToolchainFile ./rust-toolchain.toml;
|
|
|
|
rustPlatform = pkgs.makeRustPlatform {
|
|
cargo = rustToolchain;
|
|
rustc = rustToolchain;
|
|
};
|
|
|
|
# Native libs the audio crates link against.
|
|
nativeAudioBuildInputs = with pkgs; [
|
|
pipewire
|
|
pipewire.dev
|
|
];
|
|
|
|
nativeBuildTools = with pkgs; [
|
|
pkg-config
|
|
clang
|
|
];
|
|
|
|
commonEnv = {
|
|
LIBCLANG_PATH = "${pkgs.libclang.lib}/lib";
|
|
PKG_CONFIG_PATH = "${pkgs.pipewire.dev}/lib/pkgconfig";
|
|
};
|
|
in
|
|
{
|
|
# `nix develop` — full dev environment.
|
|
devShells.default = pkgs.mkShell ({
|
|
name = "headroom-dev";
|
|
|
|
nativeBuildInputs = nativeBuildTools ++ [
|
|
rustToolchain
|
|
pkgs.rust-analyzer
|
|
];
|
|
|
|
buildInputs = nativeAudioBuildInputs ++ (with pkgs; [
|
|
socat # poke the IPC socket
|
|
jq # pretty-print JSON
|
|
pipewire # for pw-cli, pw-cat, etc.
|
|
wireplumber
|
|
]);
|
|
|
|
shellHook = ''
|
|
echo "headroom dev shell — rustc $(rustc --version | cut -d' ' -f2)"
|
|
echo " cargo build / cargo test for iteration."
|
|
echo " nix build .#headroom for the packaged binary."
|
|
export RUST_BACKTRACE=1
|
|
export RUST_LOG=headroom=debug,info
|
|
'';
|
|
} // commonEnv);
|
|
|
|
# `nix build` — the final packaged daemon + CLI.
|
|
packages = rec {
|
|
default = headroom;
|
|
|
|
headroom = rustPlatform.buildRustPackage ({
|
|
pname = "headroom";
|
|
# Pull from the workspace Cargo.toml — the per-crate
|
|
# manifests use `version.workspace = true` which evaluates
|
|
# to a table here, not a string.
|
|
version = (builtins.fromTOML (builtins.readFile ./Cargo.toml)).workspace.package.version;
|
|
|
|
src = ./.;
|
|
|
|
cargoLock = {
|
|
lockFile = ./Cargo.lock;
|
|
# allowBuiltinFetchGit = true;
|
|
};
|
|
|
|
nativeBuildInputs = nativeBuildTools;
|
|
buildInputs = nativeAudioBuildInputs;
|
|
|
|
# We ship one binary from the workspace: `headroom` (cli + daemon).
|
|
cargoBuildFlags = [ "-p" "headroom-cli" ];
|
|
doCheck = true;
|
|
cargoTestFlags = [ "--workspace" ];
|
|
|
|
# Install the systemd user unit (templated with @bindir@
|
|
# so the unit refers to the absolute path of the binary in
|
|
# this derivation, never to whatever happens to be on
|
|
# PATH) and ship the canonical profiles under
|
|
# share/headroom/profiles so users / modules can copy
|
|
# them into XDG_CONFIG_HOME on first run.
|
|
postInstall = ''
|
|
install -Dm644 contrib/systemd/headroom.service \
|
|
"$out/lib/systemd/user/headroom.service"
|
|
substituteInPlace "$out/lib/systemd/user/headroom.service" \
|
|
--replace-fail '@bindir@' "$out/bin"
|
|
|
|
mkdir -p "$out/share/headroom/profiles"
|
|
cp -r profiles/. "$out/share/headroom/profiles/"
|
|
'';
|
|
|
|
meta = with pkgs.lib; {
|
|
description = "AGC + compressor + true-peak limiter daemon for PipeWire";
|
|
license = licenses.gpl3Plus;
|
|
platforms = platforms.linux;
|
|
mainProgram = "headroom";
|
|
};
|
|
} // commonEnv);
|
|
};
|
|
|
|
formatter = pkgs.nixpkgs-fmt;
|
|
}) // {
|
|
# System-independent outputs — modules.
|
|
nixosModules.default = import ./nix/nixos-module.nix self;
|
|
homeModules.default = import ./nix/home-module.nix self;
|
|
};
|
|
}
|