Files
RemSound/src/RemSound.Sender/CompositeCaptureBackend.cs
T
EdnunpandClaude Opus 4.7 c59e413c1f Bump to v1.2.0: recording, sound cues, drift compensation, diagnostics
New user-facing features:

* Recording. Dedicated Record menu (Alt+O — moved from Alt+R to
  avoid clashing with the Receive audio checkbox), Start/Stop on
  Ctrl+R, settings dialog, per-profile source / format / bit-depth /
  channel-mode / folder. Three source modes (received only, sent
  only, both). Files are crash-resilient — a process crash
  mid-recording leaves a playable file containing everything up to
  the last header refresh (~5 seconds).

* Four output formats, all functional:
    - WAV: 16/24-bit PCM or 32-bit float, custom writer with
      periodic RIFF re-patching.
    - MP3: LAME 128–320 kbps CBR (via NAudio.Lame).
    - OGG-Opus: 96–256 kbps VBR (via Concentus.Oggfile, reusing the
      Concentus encoder from the wire path).
    - FLAC: 16/24-bit lossless (via CUETools.Codecs.FLAKE — pure
      managed, no native DLL).

* Recording start/stop sound cues. record start.wav and
  record stop.wav play around the recording transition. Played via
  System.Media.SoundPlayer to the default Windows output, separate
  from the recording pipeline so a normal recording does not contain
  the cue.

* Per-cue Preferences. The old single "Mute connect/disconnect
  sounds" checkbox is replaced by a CheckedListBox: Connect /
  Disconnect / Recording start / Recording stop. Old profiles with
  the legacy MuteConnectionCues=true are honoured on first load via
  a migration path in the new Load* helpers.

* Receiver-side drift compensation switched from discrete
  single-frame splices to a continuous WdlResampler at a smoothed
  rate ratio. SessionPlayout.cs rewrite.

Diagnostics (only active with Enable logs ticked):

* Per-stage discontinuity probes — sender raw capture (per backend,
  PushModeWasapi + Asio both wired), sender pre-encode (now per
  lane in BothIndependent, fixing a cross-stream artefact), receiver
  post-decode, post-ring, post-resampler.

* Wire-level packet sequence tracking on each PCM stream — in-order
  / missed / reordered / duplicated counts in the diag log.

* Clipped-sample delta in the diag log.

* New AudioStepProbe in RemSound.Core with per-channel scan helper.

UI changes:

* Record menu uses Alt+O (Rec&ord). Inside the menu, item mnemonics
  unchanged (S / T / O / C).

* Auto-tune interval combo label is mode-aware: "Auto-tune latency
  interval" in classic modes, "Auto-tune interval — WASAPI and ASIO"
  in BothIndependent. The combo's Enabled state now follows EITHER
  lane's auto-tune checkbox (was only the WASAPI one — bug).

Wire format and audio pipeline unchanged from v1.1 — v1.1 and v1.2
peers interoperate.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-15 12:40:01 +01:00

266 lines
12 KiB
C#

using RemSound.Core;
namespace RemSound.Sender;
/// <summary>
/// Capture backend that runs a WASAPI <see cref="MixingEngine"/> and the persistent
/// <see cref="AsioCaptureBackend"/> owned by <see cref="AudioSender"/> in parallel, as two
/// independent lanes — each producing its own PCM stream for its own <see cref="SenderLane"/>.
///
/// Two pipeline shapes are reachable today:
/// <list type="bullet">
/// <item>WasapiOnly: WASAPI child only, no ASIO in the path. Used when no ASIO driver is
/// selected (or none is installed). Lowest latency for WASAPI-only setups.</item>
/// <item>BothIndependent: WASAPI child + persistent ASIO child running side by side. Each
/// delivers samples to its own callback; there is no mix loop, no shared buffer, no
/// tee. ASIO keeps its native sub-5 ms pipeline; WASAPI keeps its WASAPI-event rate.
/// The legacy <c>AudioMode.Both</c> tee-style mode and <c>AudioMode.AsioOnly</c> are
/// no longer reachable from the UI; their enum values remain in
/// <see cref="AudioMode"/> for back-compat but produce nothing here.</item>
/// </list>
/// </summary>
internal sealed class CompositeCaptureBackend : ICaptureBackend
{
// WASAPI lane callback. In WasapiOnly this is the only callback in use; in BothIndependent
// it is specifically the WASAPI lane (the ASIO lane has its own callback below).
private readonly Action<ReadOnlyMemory<float>> onMixedSamples;
// ASIO lane callback. Only meaningful in BothIndependent (passed but unused in WasapiOnly,
// where the persistent ASIO instance is disposed by AudioSender).
private readonly Action<ReadOnlyMemory<float>>? onAsioLaneSamples;
private readonly Action<string>? onDiagnostic;
private readonly object gate = new();
// WASAPI child. Normally a MixingEngine (timer-driven, supports N sources); swapped to
// PushModeWasapiBackend in Start() when useTightLatencyWasapi is true AND there is exactly
// one WASAPI source. Push-mode lets the WASAPI capture event drive the encoder/UDP-send
// pipeline directly, eliminating ~6 ms of Stopwatch+WaitHandle scheduler jitter that's
// otherwise visible in the receiver as maxGapMs spikes. Multi-source push mode isn't
// supported (rendezvous-of-N-callback-streams problem) — multi-source falls back to
// MixingEngine.
private ICaptureBackend? wasapi;
// ASIO child. BORROWED — AudioSender owns the persistent instance and keeps the driver
// open across audio-mode rebuilds (so Audient and similar drivers don't get a rapid
// close+reopen, which they hate). The composite uses this reference but does NOT
// dispose it; AudioSender disposes on app shutdown or driver change.
private readonly AsioCaptureBackend? asio;
private readonly string? asioDriverName;
private readonly AudioMode mode;
private readonly bool useTightLatencyWasapi;
private List<CaptureSourceSpec> wasapiSpecs = [];
private List<CaptureSourceSpec> asioSpecs = [];
private bool started;
public CompositeCaptureBackend(AudioMode mode, string? asioDriverName, Action<ReadOnlyMemory<float>> onMixedSamples, Action<ReadOnlyMemory<float>>? onAsioLaneSamples, AsioCaptureBackend? injectedAsio, Action<string>? onDiagnostic = null, bool useTightLatencyWasapi = false)
{
this.onMixedSamples = onMixedSamples;
this.onAsioLaneSamples = onAsioLaneSamples;
this.onDiagnostic = onDiagnostic;
this.asioDriverName = asioDriverName;
this.mode = mode;
this.useTightLatencyWasapi = useTightLatencyWasapi;
// Legacy enum values (AsioOnly, Both) are no longer produced by the UI but might
// arrive here from in-flight callers. Coerce them into reachable modes: a non-WASAPI
// request without a driver demotes to WasapiOnly; a non-WASAPI request with a driver
// is treated as BothIndependent (the only ASIO-using mode now).
if (mode != AudioMode.WasapiOnly)
{
if (string.IsNullOrEmpty(asioDriverName) || injectedAsio is null)
{
this.mode = mode = AudioMode.WasapiOnly;
}
else if (mode != AudioMode.BothIndependent)
{
this.mode = mode = AudioMode.BothIndependent;
}
}
// Always build the WASAPI lane (it is the WasapiOnly callback path, and the WASAPI
// lane in BothIndependent). Push-mode swap, if applicable, happens in Start().
wasapi = new MixingEngine(onMixedSamples, msg => onDiagnostic?.Invoke($"wasapi: {msg}"));
// Borrow the persistent ASIO instance only in BothIndependent. AudioSender already
// pointed its callback at the right lane via SetCallback before constructing us.
if (mode == AudioMode.BothIndependent)
{
asio = injectedAsio;
}
}
public bool IsRunning => started;
public long TotalCaptureCallbacks => (wasapi?.TotalCaptureCallbacks ?? 0) + (asio?.TotalCaptureCallbacks ?? 0);
public long TotalCaptureBytes => (wasapi?.TotalCaptureBytes ?? 0) + (asio?.TotalCaptureBytes ?? 0);
public string? FirstCaptureFormatDescription => asio?.FirstCaptureFormatDescription ?? wasapi?.FirstCaptureFormatDescription;
public string? FirstCaptureLastError => asio?.FirstCaptureLastError ?? wasapi?.FirstCaptureLastError;
// ClippedSampleCount lived on the (now-removed) classic-Both mix loop; the per-lane
// BothIndependent pipeline has no shared mix bus to clip. Kept as 0 so any UI binding
// that still reads it doesn't NRE.
public long ClippedSampleCount => 0;
/// <summary>Worst callback-gap across both inner backends. We have to take from BOTH (so
/// each inner's counter resets), then return the larger — otherwise the unread inner
/// would just keep accumulating its max forever.</summary>
public int TakeMaxCallbackGapMs()
{
var w = wasapi?.TakeMaxCallbackGapMs() ?? 0;
var a = asio?.TakeMaxCallbackGapMs() ?? 0;
return Math.Max(w, a);
}
public IReadOnlyList<string> ActiveSourceNames
{
get
{
var combined = new List<string>();
if (wasapi is not null) combined.AddRange(wasapi.ActiveSourceNames);
if (asio is not null) combined.AddRange(asio.ActiveSourceNames);
return combined;
}
}
/// <summary>Max raw-capture step across both inner backends since the last call. Has to
/// drain BOTH probes (so neither sits accumulating forever after we read one) and return
/// the larger value.</summary>
public float TakeMaxRawCaptureStep()
{
var w = wasapi?.TakeMaxRawCaptureStep() ?? 0f;
var a = asio?.TakeMaxRawCaptureStep() ?? 0f;
return w > a ? w : a;
}
public void Start(IReadOnlyList<CaptureSourceSpec> specs)
{
lock (gate)
{
if (started) StopInternal();
(wasapiSpecs, asioSpecs) = SplitSpecs(specs);
// Push-mode WASAPI selection. Lets the WASAPI capture event drive the encoder/UDP
// send pipeline directly, eliminating ~6 ms of Stopwatch+WaitHandle scheduler
// jitter. Conditions: tight-latency requested, and exactly one WASAPI source
// (multi-source needs the rendezvous logic in MixingEngine). Applies equally in
// WasapiOnly and BothIndependent — in either, the WASAPI lane is single-source
// when the user has ticked one input.
var wantPushMode = useTightLatencyWasapi && wasapiSpecs.Count == 1;
var currentIsPush = wasapi is PushModeWasapiBackend;
if (wantPushMode != currentIsPush)
{
try { wasapi?.Dispose(); } catch { /* ignore */ }
if (wantPushMode)
{
wasapi = new PushModeWasapiBackend(onMixedSamples, msg => onDiagnostic?.Invoke($"wasapi: {msg}"));
onDiagnostic?.Invoke("wasapi backend: switched to push-mode (audio-clock-locked, single-source)");
}
else
{
wasapi = new MixingEngine(onMixedSamples, msg => onDiagnostic?.Invoke($"wasapi: {msg}"));
onDiagnostic?.Invoke("wasapi backend: switched to mix-engine (timer-driven, multi-source capable)");
}
}
wasapi!.Start(wasapiSpecs);
// ASIO child is BORROWED from AudioSender. If the driver is already open from a
// previous engine instance we want UpdateSources (which won't close it) rather
// than Start (which would Stop+Open and trigger the close+reopen hang on Audient).
// The callback was already wired to the correct lane by EnsurePersistentAsioLocked.
if (asio is not null)
{
if (asio.IsRunning) asio.UpdateSources(asioSpecs);
else asio.Start(asioSpecs);
}
started = true;
onDiagnostic?.Invoke($"composite capture started: wasapi={wasapiSpecs.Count} sources, asio={asioSpecs.Count} sources, mode={ModeLabel()}{(wantPushMode ? " [wasapi push]" : "")}");
}
}
public void UpdateSources(IReadOnlyList<CaptureSourceSpec> specs)
{
lock (gate)
{
if (!started)
{
Start(specs);
return;
}
var (newWasapi, newAsio) = SplitSpecs(specs);
// If push-mode applicability changes (single WASAPI source toggled on/off), the
// backend has to swap. PushModeWasapiBackend supports only one source. Full
// restart is acceptable here — changing source count mid-session is rare.
var wouldBePush = useTightLatencyWasapi && newWasapi.Count == 1;
var isPush = wasapi is PushModeWasapiBackend;
if (wouldBePush != isPush)
{
onDiagnostic?.Invoke($"wasapi backend: source count changed ({wasapiSpecs.Count}→{newWasapi.Count}), restarting to switch backend");
StopInternal();
Start(specs);
return;
}
if (wasapi is not null && !SpecsEqual(wasapiSpecs, newWasapi))
{
wasapi.UpdateSources(newWasapi);
wasapiSpecs = newWasapi;
}
if (asio is not null && !SpecsEqual(asioSpecs, newAsio))
{
asio.UpdateSources(newAsio);
asioSpecs = newAsio;
}
}
}
private string ModeLabel() => mode switch
{
AudioMode.WasapiOnly => "fast (WASAPI direct)",
AudioMode.BothIndependent => "independent lanes (WASAPI + ASIO, no mix)",
_ => mode.ToString(),
};
public void Stop()
{
lock (gate) StopInternal();
}
private void StopInternal()
{
if (!started) return;
try { wasapi?.Stop(); } catch { /* ignore */ }
// ASIO child is NEVER stopped here — it's the persistent instance owned by AudioSender
// and kept alive across engine rebuilds. Stopping it would force a close+reopen that
// Audient (and similar drivers) hang on for ~5 s. AudioSender disposes it on app
// shutdown or driver change.
started = false;
}
public void Dispose()
{
Stop();
try { wasapi?.Dispose(); } catch { /* ignore */ }
// ASIO child not disposed — see StopInternal above.
}
private static (List<CaptureSourceSpec> wasapi, List<CaptureSourceSpec> asio) SplitSpecs(IReadOnlyList<CaptureSourceSpec> specs)
{
var wasapi = new List<CaptureSourceSpec>();
var asio = new List<CaptureSourceSpec>();
foreach (var spec in specs)
{
if (AsioDeviceId.TryParse(spec.DeviceId, out _)) asio.Add(spec);
else wasapi.Add(spec);
}
return (wasapi, asio);
}
private static bool SpecsEqual(IReadOnlyList<CaptureSourceSpec> a, IReadOnlyList<CaptureSourceSpec> b)
{
if (a.Count != b.Count) return false;
for (var i = 0; i < a.Count; i++)
{
if (a[i].DeviceId != b[i].DeviceId || a[i].Kind != b[i].Kind) return false;
}
return true;
}
}