Fast test implementation of a midi-fader based software
Go to file
Dandaedre 814c87cc6e
Rust CI fader_master passed its selected CI mode.
MadGobblins/fader_master/pipeline/head This commit looks good Details
docs: record completed M13 implementation and automated qualification
Verify: cargo fmt --all -- --check; cargo check --workspace --all-targets --all-features; cargo test --workspace --all-targets --all-features; cargo test --workspace --doc --all-features; cargo clippy --workspace --all-targets --all-features -- -D warnings; cargo build --workspace --release --all-features all passed. Default/no-default workspace and portable/individual-backend tests and builds passed. Private D-Bus fixtures: 2 passed. scripts/test-ci.sh and git diff --check passed. Real QBZ/controller and provisioned Jenkins runs remain explicitly unverified.
2026-10-18 23:08:47 +02:00
config docs: document M13 media controls and add a validated QBZ profile 2026-10-18 23:06:58 +02:00
core feat: add bounded M13.2 process metadata selectors 2026-10-18 22:25:46 +02:00
docs docs: document M13 media controls and add a validated QBZ profile 2026-10-18 23:06:58 +02:00
examples/profiles docs: document M13 media controls and add a validated QBZ profile 2026-10-18 23:06:58 +02:00
fader_master fix: retain M13 media availability when a player is unresponsive 2026-10-18 23:05:12 +02:00
media fix: reject incomplete M13 player matches and unsupported PlayPause 2026-10-18 23:00:42 +02:00
midi feat: reflect confirmed mute state over MIDI 2026-10-15 23:55:29 +02:00
scripts ci: include M13 media contracts and isolated MPRIS fixtures 2026-10-18 23:07:21 +02:00
sound feat: expose M13.2 normalized process diagnostics 2026-10-18 22:39:03 +02:00
tui feat: implement M13.3d capability-aware media tab and guided editing 2026-10-18 22:59:50 +02:00
.gitignore build(M12.4): prepare guarded Gitea release wrapper 2026-10-16 19:59:16 +02:00
AGENTS.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
CHANGELOG.md docs: document M13 media controls and add a validated QBZ profile 2026-10-18 23:06:58 +02:00
Cargo.lock feat: implement M13.3d capability-aware media tab and guided editing 2026-10-18 22:59:50 +02:00
Cargo.toml feat: add bounded M13.3b MPRIS worker and native adapter 2026-10-18 22:49:03 +02:00
Cross.toml feat: add bounded M13.3b MPRIS worker and native adapter 2026-10-18 22:49:03 +02:00
Jenkinsfile ci: include M13 media contracts and isolated MPRIS fixtures 2026-10-18 23:07:21 +02:00
LICENSE Cargo init + license 2025-03-24 15:31:04 +01:00
README.md docs: document M13 media controls and add a validated QBZ profile 2026-10-18 23:06:58 +02:00
architecture.md docs: record completed M13 implementation and automated qualification 2026-10-18 23:08:47 +02:00
checklist.md docs: document M13 media controls and add a validated QBZ profile 2026-10-18 23:06:58 +02:00
release.sh build(M12.4): prepare guarded Gitea release wrapper 2026-10-16 19:59:16 +02:00
rust-release.toml build(M12.4): prepare guarded Gitea release wrapper 2026-10-16 19:59:16 +02:00
rust-toolchain.toml build(M0.1): pin reproducible Rust foundation 2026-10-05 07:47:49 +02:00
task.md docs: record completed M13 implementation and automated qualification 2026-10-18 23:08:47 +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, Any/All composition, and available executable/working-directory and Steam IDs.
  • Target MPRIS players directly from the Media tab or MIDI: transport, seeking, shuffle, repeat and playlists, with confirmed-state feedback and global/local feedback switches. See media configuration.
  • 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.
  • Reset the active profile from Config after an explicit confirmation. The TUI preserves the previous file as <profile>.toml.reset.bak before installing and activating a safe Master-output profile.

Quick start

With cargo-binstall installed, download the current release candidate without compiling:

cargo binstall --git https://proxy.dandaedre.com/gitea/MadGobblins/fader_master \
  --version '=0.1.0-rc.2' --strategies crate-meta-data fader_master
fader_master

This installs the combined launcher plus fader_master_server and fader_master_client. Ensure Cargo's binary directory (usually ~/.cargo/bin) is on your PATH. No repository checkout or sample configuration is needed.

Prebuilt binaries currently target x86-64 GNU/Linux and require ALSA, libpulse and libudev runtime libraries, plus PulseAudio or pipewire-pulse. They are built with an Ubuntu 24.04-based image; older distributions are not yet qualified. This is an RC, not a stable release.

Without cargo-binstall, download the archive containing all three executables from the release page, verify it against the accompanying SHA256SUMS, and extract the executables into a directory on your PATH.

First launch

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. Configured controllers can be removed with D in Config; confirmation also removes their bindings, and Save activates the change.

Build from source (alternative)

For development or systems without compatible prebuilt binaries, follow the build prerequisites. From a source checkout, run:

cargo run --locked -p fader_master

See advanced configuration for explicit profiles and separate server/client operation.

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
Add fader, group, or separator A A
Edit selected entry E E
Delete selected entry D D
Hide selected fader Shift+H Shift+H
Help h or ? h or ?

Use Tab to open Config, select Mixer layout and use Left/Right to switch its orientation, T to cycle the theme, and Q to open the quit confirmation. Fader editing exposes the application/group display name, capture rules, group membership, separate controller/Learn/Unlearn actions for volume and mute, size, and visibility. Add opens a chooser for a new application fader, empty group, or separator. New faders and groups open directly in the editor and remain visible as offline DRAFT rows until Save activates them. Delete asks for confirmation and removes the selected fader and its unshared target, or the selected separator. Config → Active profile opens the profile switcher. Config → Reset active profile provides an emergency return to safe defaults; confirming it immediately saves and activates the reset and keeps a .reset.bak copy beside the profile. 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.