69 lines
3.2 KiB
Markdown
69 lines
3.2 KiB
Markdown
# fader_master
|
|
|
|

|
|

|
|

|
|
|
|
Linux application volume and mute control from one or more USB MIDI surfaces.
|
|
|
|
This repository contains tested domain and configuration libraries, a PulseAudio
|
|
protocol worker compatible with `pipewire-pulse`, a local per-user server, and a
|
|
live terminal mixer. The domain layer supports matching, routing, balanced group
|
|
volume plans, and mute intent. Atomic TOML persistence, checkpointing, and live
|
|
profile application/group aggregation are implemented; persistent MIDI
|
|
lifecycle, pickup/feedback, and the configuration editor remain on the ordered
|
|
backlog:
|
|
|
|
- [Architecture and library research](architecture.md)
|
|
- [Implementation tasks and acceptance tests](task.md)
|
|
- [Project-agent instructions and test/commit workflow](AGENTS.md)
|
|
- [Build prerequisites and MSRV](docs/build.md)
|
|
- [CI coverage and badge lifecycle](docs/ci-coverage.md)
|
|
- [Hands-on functional checklist](checklist.md)
|
|
|
|
## Run the live TUI
|
|
|
|
Start the server in one terminal:
|
|
|
|
```sh
|
|
cargo run --locked -p fader_master -- serve \
|
|
--config examples/profiles/arch-pipewire.toml --audio pulse
|
|
```
|
|
|
|
Then start the client in another:
|
|
|
|
```sh
|
|
cargo run --locked -p fader_master -- tui
|
|
```
|
|
|
|
Use Up/Down or J/K to select a configured fader or separator, Left/Right to
|
|
change its volume, M to toggle mute, T to cycle the built-in themes, and Q to
|
|
open the quit confirmation. Escape cancels the active editor or dialog and
|
|
does not quit from the main screen. Pass `--theme dracula`, `nord`,
|
|
`gruvbox-dark`, `catppuccin-mocha`, or `solarized-dark` to choose an initial
|
|
theme. Offline objects remain visible, and aggregate rows show `MIXED` when
|
|
member state differs. See the hands-on checklist for the exact milestone scope
|
|
and restoration steps.
|
|
|
|
The mixer is also the primary configuration surface. Shift+Up/Down reorders the
|
|
selected fader or separator; A adds a separator; E edits a selected fader or
|
|
separator; D removes a selected separator; and `h` hides a fader. Fader editing
|
|
provides capture Field/Exact-or-Regex/Pattern controls, group membership and
|
|
mode, and separate controller, Learn MIDI, and Unlearn MIDI actions for both
|
|
volume and mute. Learning opens a waiting popup and captures the next supported
|
|
fader movement or button press from the selected controller. The editor also
|
|
provides per-fader Size (`Slim`, `Standard`, or `Thick`) and visibility. Slim
|
|
faders occupy one terminal row; Standard remains the compatible default. The
|
|
Config tab is a settings/status page: change the session theme, switch the
|
|
persisted mixer layout between Vertical and Horizontal, restore individual
|
|
hidden faders, inspect backend and MIDI-device state, and apply or save the
|
|
server-owned draft. Horizontal mode packs fader cards side by side and keeps
|
|
separators full-width. The old `Shift+h` hidden-list mode and pipe-delimited
|
|
object editors are no longer used.
|
|
|
|
# References
|
|
|
|
* [pwvucontrol](https://github.com/saivert/pwvucontrol/blob/main/src/backend/pwnodeobject/mixerapi.rs)
|
|
* [ratatui](https://ratatui.rs/)
|
|
* [midir](https://github.com/Boddlnagg/midir)
|