Fast test implementation of a midi-fader based software
Go to file
Dandaedre 8add95df3f
Rust CI fader_master passed its selected CI mode.
MadGobblins/fader_master/pipeline/head This commit looks good Details
docs: refresh all guides and regenerate mixer screenshots
Bring README, architecture, backlog, checklist, steward baseline, and every docs guide up to date. Document unnamed spacers, current setup/save/restart behavior, MIDI feedback and portable builds. Replace both screenshots with current representative layouts and fixed cell-grid SVG text/border rendering.

Validation PASS: local file links across all 12 Markdown documents; both SVGs parsed and visually inspected after rsvg-convert; repeated doc_screenshots generation produced identical SHA-256 hashes; git diff --check; cargo fmt --all -- --check; cargo check --workspace --all-targets --all-features; cargo clippy --workspace --all-targets --all-features -- -D warnings; canonical architecture-profile schema test; portable no-default-feature package check. Full workspace gates passed in preceding empty-separator implementation commit.
2026-10-16 19:38:59 +02:00
config fix(M9.4): accept unnamed separators and spacers 2026-10-16 19:34:19 +02:00
core feat(M1.4): reserve stateful relative groups 2026-10-15 03:14:36 +02:00
docs docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
examples/profiles feat: configure pickup status presentation 2026-10-16 19:11:40 +02:00
fader_master feat(M9.4): add separator sizes and independent decorations 2026-10-16 19:27:46 +02:00
midi feat: reflect confirmed mute state over MIDI 2026-10-15 23:55:29 +02:00
scripts ci: export native backend parameter 2026-10-15 19:44:04 +02:00
sound feat(M7.4): make runtime polling configurable 2026-10-15 03:54:10 +02:00
tui docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
.gitignore ci: establish implementation fallback baseline 2026-10-05 07:28:08 +02:00
AGENTS.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
Cargo.lock feat(M7.1): activate server and diagnostic commands 2026-10-15 00:15:21 +02:00
Cargo.toml feat(M7.2): authenticate and bound local clients 2026-10-15 01:14:50 +02:00
Jenkinsfile ci: export native backend parameter 2026-10-15 19:44:04 +02:00
LICENSE Cargo init + license 2025-03-24 15:31:04 +01:00
README.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
architecture.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
checklist.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
rust-toolchain.toml build(M0.1): pin reproducible Rust foundation 2026-10-05 07:47:49 +02:00
task.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00

README.md

fader_master

Version Tests Coverage

Control Linux application volume and mute from a USB MIDI controller. One fader can follow an application, a group of applications, or the default audio output, while the terminal UI remains useful as a complete software mixer.

Horizontal mixer showing application, group, and output faders

The horizontal layout puts bottom-up faders side by side, with dividers and flexible spacers between sections. Switch to Vertical in Config for stacked cards, including one-row Slim and Bordered slim faders:

Vertical mixer showing stacked faders and separators

Features

  • Match PulseAudio or pipewire-pulse streams by application metadata, with exact and regular-expression capture rules.
  • Control individual applications, non-nesting application groups, and the default output without changing live audio during discovery.
  • Learn volume and mute controls from MIDI, reflect confirmed mute state on control-surface LEDs, use pickup to prevent jumps, and keep independently identified controllers from colliding.
  • Arrange faders, separators, and empty spacers directly in the mixer. Choose Slim, Bordered slim, Standard, or Thick faders, and hide detail faders behind a group when useful.
  • Size separators independently and choose Plain, Line, Double line, or Box. Fill separators share spare space; names are optional.
  • Use horizontal or vertical layouts and six built-in terminal themes.
  • Choose Detailed, Compact, Symbol, Color, or Hidden pickup feedback in Config. Hiding the indicator keeps pickup protection active.
  • Run as one command, or keep a standalone server alive while reconnecting TUI clients come and go.
  • Edit a validated draft from the TUI and persist it with one explicit Save. Malformed or conflicting edits never replace the active configuration.
  • Switch among valid managed profiles from a popup in the Config view; the default switch adopts live audio without writing saved volume state.

Quick start

Install the platform dependencies described in the documentation index, then run the combined server and TUI with the sample PipeWire/Pulse profile:

cargo run --locked -p fader_master -- \
  --config examples/profiles/arch-pipewire.toml --audio pulse

The combined executable connects to an existing per-user server when possible and starts an embedded one otherwise. Running without --config creates a default profile with a Master-output fader. A sole detected MIDI input is adopted as the default controller; otherwise choose a detected input in Config, add it, and Save. Edit the Master fader with E to learn volume and mute controls.

The screenshots use reproducible example state rendered by the actual TUI; they do not represent a live hardware session.

Everyday controls

Action Vertical Horizontal
Select Up/Down or J/K Left/Right or J/K
Change volume Left/Right Up/Down
Reorder Shift+Up/Down or Shift+J/K Shift+Left/Right or Shift+J/K
Toggle mute M M
Edit fader or separator E E
Add/remove separator A / D A / D
Hide selected fader Shift+H Shift+H
Help h or ? h or ?

Use Tab to open Config, T to cycle the theme, and Q to open the quit confirmation. Fader editing exposes capture rules, group membership, separate controller/Learn/Unlearn actions for volume and mute, size, and visibility. Config → Active profile opens the profile switcher. Separator editing offers an optional name, size, and decoration; an empty name with Plain + Fill creates flexible blank space. Press Enter to accept popup edits, then use Config → Save to persist the draft.

After updating the binaries, restart the server as well as the client. The combined launcher reuses an already-running server.

Documentation

The documentation index contains installation instructions, advanced configuration and process layouts, examples, troubleshooting notes, architecture, project status, and related projects.

License

See LICENSE.