diff --git a/checklist.md b/checklist.md index 82fb668..8fe67a1 100644 --- a/checklist.md +++ b/checklist.md @@ -54,18 +54,18 @@ Replace `INDEX` below with the selected sink-input index. your desktop mixer; confirm each change produces an updated fixture line. - [x] Stop and restart playback; confirm the watcher reports removal and then a newly discovered sink input without crashing. -- [ ] When interrupting audio is acceptable, run +- [x] When interrupting audio is acceptable, run `systemctl --user restart pipewire pipewire-pulse wireplumber`, then repeat the watch. A clean connection error is acceptable for this bounded fixture; record it so reconnect behavior can be verified in the full worker integration. ## Restore and report -- [ ] Restore the application's original volume and mute state. -- [ ] Run `cargo test --workspace --all-targets --all-features --locked` and +- [x] Restore the application's original volume and mute state. +- [x] Run `cargo test --workspace --all-targets --all-features --locked` and confirm it passes with your native libpulse installation. -- [ ] Report the `Server Name` shown by `pactl info` and any unchecked or failed - item, including the fixture's exact error text. +- [x] Report the `Server Name` shown by `pactl info` and any unchecked or failed + item, including the fixture's exact error text. : PulseAudio (on PipeWire 1.6.9) ## Owned Pulse worker milestone @@ -74,40 +74,40 @@ used by the earlier commands. - [ ] Start playback, then run `cargo run --locked -p volume_lib --example pulse_fixture -- worker-watch 30`. -- [ ] Confirm the output starts with `Ready`, contains one `SnapshotBegin` and +- [x] Confirm the output starts with `Ready`, contains one `SnapshotBegin` and one `SnapshotEnd`, and reports the playing stream through copied `StreamMetadata` and `Observed` events. -- [ ] During the watch, change volume and mute in your desktop mixer and confirm +- [x] During the watch, change volume and mute in your desktop mixer and confirm new `Observed` events contain the updated channel values and mute state. -- [ ] Stop and restart playback during another watch. Confirm `StreamRemoved` is +- [x] Stop and restart playback during another watch. Confirm `StreamRemoved` is followed by a newly observed handle; if PipeWire reuses the numeric backend ID, its `incarnation` must differ. -- [ ] Confirm the command exits normally without `Disconnected`, event-lane +- [x] Confirm the command exits normally without `Disconnected`, event-lane overflow, or an owner-thread panic. ## Adapter selection milestone These probes are read-only and do not alter the saved profile or live volumes. -- [ ] Run +- [x] Run `cargo run --locked -p volume_lib --example pulse_fixture -- probe auto`. Confirm it prints `selected=pulse`, reports `PulseAudio (on PipeWire ...)`, and lists application-stream, volume, mute, and subscription capabilities as `true`. -- [ ] Run +- [x] Run `cargo run --locked -p volume_lib --example pulse_fixture -- probe pulse` and confirm the explicit selection succeeds with the same server identity. -- [ ] Run +- [x] Run `cargo run --locked -p volume_lib --example pulse_fixture -- probe pipewire`. This must fail with an actionable `not built`/`pipewire` feature diagnostic; it must not silently select `pulse` after the manual request fails. -- [ ] Confirm none of these probe commands changes application volume or mute. +- [x] Confirm none of these probe commands changes application volume or mute. ## Real-daemon integration fixture -- [ ] Confirm `paplay` is installed with `command -v paplay` and pause any audio +- [x] Confirm `paplay` is installed with `command -v paplay` and pause any audio you do not want visible in the diagnostic output. -- [ ] Run the non-disruptive isolated-stream fixture: +- [x] Run the non-disruptive isolated-stream fixture: ```sh cargo test --locked -p volume_lib --test pulse_daemon --all-features \ @@ -115,7 +115,7 @@ These probes are read-only and do not alter the saved profile or live volumes. --ignored --exact --nocapture ``` -- [ ] Confirm it passes after showing the uniquely named +- [x] Confirm it passes after showing the uniquely named `fader-master-fixture-*` stream converge through worker volume/mute commands, external changes, removal, and replacement. Other streams may be listed but must not be changed. @@ -128,8 +128,17 @@ These probes are read-only and do not alter the saved profile or live volumes. --ignored --exact --nocapture ``` -- [ ] Confirm the restart fixture observes a disconnect, reconnects with a new +- [x] Confirm the restart fixture observes a disconnect, reconnects with a new backend epoch, completes a fresh snapshot, and that `pactl info` works again. + running 1 test + fixture snapshot event: SnapshotBegin(BackendEpoch(20)) + fixture snapshot event: StreamMetadata { stream: StreamHandle { epoch: BackendEpoch(20), backend_id: 162, incarnation: 1 }, metadata: StreamMetadata { application_name: Some("PipeWire ALSA [qbz]"), application_id: None, process_binary: None, media_name: Some("ALSA Playback"), raw: {} }, volume_writable: true } + fixture snapshot event: Adapter(Observed { stream: StreamHandle { epoch: BackendEpoch(20), backend_id: 162, incarnation: 1 }, channels: ChannelGains([Gain(0.050650994655370596), Gain(0.050650994655370596)]), muted: Unmuted, operation: None }) + fixture observed expected disconnect: PulseAudio context entered state Failed + fixture snapshot event: SnapshotBegin(BackendEpoch(21)) + test pipewire_restart_disconnects_and_a_new_epoch_resnapshots ... ok + + test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out; finished in 1.90s The fixture design and standalone-PulseAudio CI instructions are documented in [`docs/pulse-daemon-fixture.md`](docs/pulse-daemon-fixture.md). @@ -148,39 +157,40 @@ milestones. ## MIDI preparation and discovery -- [ ] Confirm the Arch ALSA userspace library is installed: +- [x] Confirm the Arch ALSA userspace library is installed: `sudo pacman -S --needed alsa-lib`. -- [ ] Connect the controller and run +- [X] Connect the controller and run `cargo run --locked -p midi --example midi_monitor -- list`. -- [ ] Confirm the controller appears with an `index`, backend `id`, and readable + index=1 identity=PortIdentity { backend_id: "36:0", name: "APC MINI:APC MINI MIDI 1 36:0", usb: Some(UsbDeviceIdentity { vendor_id: "09e8", product_id: "0028", serial: Some("Ver00.10"), path: Some("pci-0000:0f:00.4-usb-0:1.4.4:1.0") }) } +- [x] Confirm the controller appears with an `index`, backend `id`, and readable `name`. Ignore `Midi Through` unless that is intentionally the input under test. -- [ ] Record the controller model/firmware and its reported `id` and `name` for +- [x] Record the controller model/firmware and its reported `id` and `name` for the M5.2 identity spike. ## Decode a real controller Replace `INDEX` with the controller index from the list command. -- [ ] Run +- [x] Run `cargo run --locked -p midi --example midi_monitor -- watch INDEX 30`. -- [ ] Move an absolute fader or knob. Confirm `ControlChange` lines show the +- [x] Move an absolute fader or knob. Confirm `ControlChange` lines show the expected 1-based channel and values spanning some or all of `0..127`. -- [ ] Press and release a note button. Confirm a nonzero note-on reports +- [x] Press and release a note button. Confirm a nonzero note-on reports `Press`, while note-off or note-on velocity zero reports `Release`. -- [ ] If the controller has a CC button, press and release it and confirm its +- [x] If the controller has a CC button, press and release it and confirm its values move between nonzero and zero. CC button edge interpretation is tested in the router even though the raw monitor intentionally displays CC values. -- [ ] If the controller sends MIDI clock or active sensing, confirm those +- [x] If the controller sends MIDI clock or active sensing, confirm those packets produce no lines and do not prevent supported controls from appearing. -- [ ] Confirm the command exits normally without `Malformed`, callback +- [x] Confirm the command exits normally without `Malformed`, callback disconnection, or `queue overflowed` errors. ## Hardware-free verification -- [ ] Run `cargo test --locked -p midi --all-targets --all-features`. -- [ ] Run `cargo test --locked -p midi --all-targets --no-default-features`. -- [ ] Confirm both pass. The second command proves decoding and binding remain +- [x] Run `cargo test --locked -p midi --all-targets --all-features`. +- [x] Run `cargo test --locked -p midi --all-targets --no-default-features`. +- [x] Confirm both pass. The second command proves decoding and binding remain testable without an ALSA device or daemon. ## MIDI identity spike @@ -188,14 +198,14 @@ Replace `INDEX` with the controller index from the list command. These checks close M5.2. They do not save an assignment or test hotplug reconnection yet. -- [ ] With one USB MIDI controller connected, run +- [x] With one USB MIDI controller connected, run `cargo run --locked -p midi --example midi_monitor -- list`. -- [ ] Confirm its `PortIdentity` includes the ALSA `backend_id`, port `name`, +- [x] Confirm its `PortIdentity` includes the ALSA `backend_id`, port `name`, four-digit USB `vendor_id` and `product_id`, and a udev `path`. -- [ ] If the device has a serial number, confirm `serial` is `Some(...)` and +- [x] If the device has a serial number, confirm `serial` is `Some(...)` and record it. If it reports `None`, record that explicitly; this is valid device metadata, not a probe failure. -- [ ] Disconnect and reconnect the controller to another USB socket. Record +- [x] Disconnect and reconnect the controller to another USB socket. Record which of the ALSA backend ID, udev path, and serial changed. A real serial should remain stable while the physical path is expected to change. - [ ] If two identical controllers are available, connect both and confirm they @@ -204,12 +214,13 @@ reconnection yet. confirm they cannot be identified independently of the sockets. This is the intentional manual-assignment case: the server must show ambiguity rather than choosing whichever ALSA port was enumerated first. -- [ ] Run `cargo test --locked -p midi --test identity --all-features` and +- [x] Run `cargo test --locked -p midi --test identity --all-features` and confirm the serial, path, ambiguity, and explicit-selection policy tests pass. Report the controller model/firmware plus the complete `PortIdentity` lines. Do not redact USB serials unless you prefer not to store them in the project test record; a redacted but clearly stable/absent result is sufficient. + index=1 identity=PortIdentity { backend_id: "36:0", name: "APC MINI:APC MINI MIDI 1 36:0", usb: Some(UsbDeviceIdentity { vendor_id: "09e8", product_id: "0028", serial: Some("Ver00.10"), path: Some("pci-0000:0d:00.0-usb-0:2.3:1.0") }) } # First live TUI milestone checklist (Arch Linux + PipeWire) @@ -220,47 +231,47 @@ groups, pickup, MIDI status, and the editor remain later M8/M9 work. ## Start the server -- [ ] Start playback in at least two applications whose volume can safely be +- [x] Start playback in at least two applications whose volume can safely be changed, and record their original volume/mute states. -- [ ] In terminal 1, run: +- [x] In terminal 1, run: ```sh cargo run --locked -p fader_master -- serve \ --config examples/profiles/desktop.toml --audio pulse ``` -- [ ] Confirm it prints `serving profile=desktop backend=pulse` and remains +- [x] Confirm it prints `serving profile=desktop backend=pulse` and remains running without changing any application volume at startup. -- [ ] Attempt the same command in another terminal and confirm it refuses to +- [x] Attempt the same command in another terminal and confirm it refuses to start a second server. -- [ ] Run `cargo run --locked -p fader_master -- status` and confirm it reports +- [x] Run `cargo run --locked -p fader_master -- status` and confirm it reports `status=ready` plus the currently playing streams with sensible labels, gains, mute state, and `writable=true`. ## Exercise the live mixer -- [ ] In terminal 2, run `cargo run --locked -p fader_master -- tui`. -- [ ] Confirm the header shows `pulse · ready`, and each playing application +- [x] In terminal 2, run `cargo run --locked -p fader_master -- tui`. +- [x] Confirm the header shows `pulse · ready`, and each playing application appears as a separate row with its current volume and mute state. - [ ] Resize the terminal smaller and larger. Confirm borders remain intact and the selected row remains visible without a panic. -- [ ] Use `↑`/`↓` or `k`/`j` to select different application streams. -- [ ] On a disposable stream, use `←`/`→` to change volume. Confirm only that +- [x] Use `↑`/`↓` or `k`/`j` to select different application streams. +- [x] On a disposable stream, use `←`/`→` to change volume. Confirm only that selected application changes, channel balance is preserved, and the displayed value converges to the desktop mixer's readback. -- [ ] Press `m` twice. Confirm the selected application mutes and unmutes without +- [x] Press `m` twice. Confirm the selected application mutes and unmutes without changing its volume. -- [ ] Change volume and mute externally in the desktop mixer. Confirm the TUI +- [x] Change volume and mute externally in the desktop mixer. Confirm the TUI refreshes to the external values without emitting a compensating write. -- [ ] Stop and restart one playback application. Confirm its row disappears and +- [x] Stop and restart one playback application. Confirm its row disappears and a fresh row appears without crashing or reusing stale state. -- [ ] Press `q` or `Esc`. Confirm the terminal is restored and terminal 1 keeps +- [x] Press `q` or `Esc`. Confirm the terminal is restored and terminal 1 keeps serving; `cargo run --locked -p fader_master -- status` must still work. ## Finish and report -- [ ] Stop terminal 1 with `Ctrl-C`, then start it once more. Confirm the stale +- [x] Stop terminal 1 with `Ctrl-C`, then start it once more. Confirm the stale socket is recovered automatically and the new server reaches `ready`. -- [ ] Restore the applications' original volume and mute states. -- [ ] Report any missing/mislabeled stream, wrong application being controlled, +- [x] Restore the applications' original volume and mute states. +- [x] Report any missing/mislabeled stream, wrong application being controlled, visible error, layout corruption, or command that fails to converge. diff --git a/task.md b/task.md index b75d9d0..6d3b7fc 100644 --- a/task.md +++ b/task.md @@ -120,15 +120,16 @@ Dependencies: M3. diagnostics. Auto mode stops at its first capable authority; manual mode never falls back; application profiles reject hardware-only candidates. Disconnect backoff remains pinned to the selected authority until a reload. -- [ ] **M4.4 Real-daemon fixture:** isolated playback streams and external control client. Acceptance: server command and external change both converge to the observed value/mute; stream churn and daemon restart recover. Document commands and opt-in fixture requirements; do not label mocks as hardware verification. +- [x] **M4.4 Real-daemon fixture:** isolated playback streams and external control client. Acceptance: server command and external change both converge to the observed value/mute; stream churn and daemon restart recover. Document commands and opt-in fixture requirements; do not label mocks as hardware verification. An opt-in fixture now creates a uniquely named silent `paplay` stream and verifies real worker volume/mute writes, independent-client edits, readback, removal, and replacement without targeting other desktop streams. That phase passed against PipeWire 1.6.9 through `pipewire-pulse` on 2026-10-14. A separately acknowledged test restarts the known PipeWire user services and requires disconnect, bounded retry, a new epoch, and a complete resnapshot. - Keep this item open until that disruptive phase passes; the same stream fixture - can target an isolated standalone PulseAudio server through `PULSE_SERVER`. + That disruptive phase passed on 2026-10-15: it observed epoch 20 disconnect, + epoch 21 reconnect, and a complete fresh snapshot. The same stream fixture can + target an isolated standalone PulseAudio server through `PULSE_SERVER`. M4.2 verification on 2026-10-14: the scripted worker contract suite passes without an audio daemon, and a read-only owner-thread smoke run against PipeWire @@ -162,9 +163,11 @@ Dependencies: M3; M4 for full end-to-end acceptance. client card number to udev, copying VID/PID, serial, and physical path. Pure policy tests prove serial and path matching survive port reorder and that two identical serial-less candidates stay ambiguous until manually selected. - Keep this item open until physical controller metadata and the two-controller - cases in the checklist are recorded; the current host exposes only the - virtual `Midi Through` port. + An Akai APC MINI (USB 09e8:0028, firmware-reported serial `Ver00.10`) was + observed on 2026-10-15. Its serial and ALSA backend ID `36:0` remained stable + across USB sockets while its udev path changed, validating serial-first + matching on real hardware. Keep this item open until the two-identical-device + ambiguity cases in the checklist can be exercised. - [ ] **M5.3 Multi-surface lifecycle:** persist user IDs and independent input/output assignment; hotplug scanning/notification, retries and absent placeholders. Tests: unplug/replug/reboot-style port reorder preserve assignments; ambiguous serial-less matches stay unassigned; one failed device does not stop another. - [ ] **M5.4 Pickup:** crossing/tolerance, current physical position, reset on external change/rebind/reconnect/profile switch. Tests: old physical position cannot jump audio at startup; crossing activates; another surface re-arms pickup; above-range target can be picked up at the endpoint. - [ ] **M5.5 Physical smoke test:** one controller -> server -> application audio; then two controllers with overlapping MIDI message numbers. Acceptance: correct applications respond, bindings persist, and USB loss leaves server running. Record controller/firmware and environment. @@ -227,6 +230,12 @@ Clippy, release build, no-default-feature checks/tests, and the complete Rust 1.88 all-feature test suite pass. M7.2, M7.3, and M8.1 remain open for the explicit acceptance gaps noted above and in the hands-on checklist. +Hands-on acceptance on 2026-10-15 confirmed one-instance enforcement, live +multi-stream display, keyboard selection, confirmed volume/mute actions, +external-change refresh, stream churn, independent TUI exit/reconnect, and +terminal restoration against PipeWire 1.6.9. Terminal resize remains to be +checked alongside the next profile-aware TUI slice. + ## M9 — TUI configuration editor Dependencies: M8, M2, M1.