Local checkpoint - NOT for public release. First increment of the send-only Windows service feature (design in memory/project_remsound_service). THE SPIKE PASSED: the send engine runs fully headless (no window, no message pump) and streams, proven by a real self-test — the one genuine unknown that gated the whole feature. Also proves the app-yield model end to end. What's in this increment (all headless, all tested, 19/19 gate): - AppConfig: ServiceProfileName + ServiceLoggingEnabled (machine-wide). - InteractivePresence (Core): the cross-session app-yield token. App holds a Global\ mutex for its lifetime; the service checks it and yields while an interactive app is present, resuming when it closes OR crashes (OS frees the mutex). Name-parameterised internal seams for isolated testing. - ServiceSendHost (App): loads a send-only profile and streams it to its peers, WASAPI-only, no ASIO/receive. ApplyProfile/Suspend/Resume + a RunLoop that drives them from the presence token with a settle delay. v1 sends to direct peer addresses (LAN/port-forwarded); NAT/relay discovery stays the app's job. - Program.cs: the interactive app now acquires the presence token at startup so a future service yields to it. - Tests: "Service app-yield token" (held=present, released=absent) and "Service send host (headless stream + yield)" — streams a captured device to a local receiver over loopback, verifies start/suspend/resume, then drives the full RunLoop against the token (held=suspended, released=resumes-and-flows). Still to come (later increments): the --run-service entry + Windows-service registration, the Service menu, the 3-tab config dialog, updater integration, docs. None user-facing yet, so nothing deployed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
230 lines
10 KiB
C#
230 lines
10 KiB
C#
using System.Net;
|
|
using System.Net.Sockets;
|
|
using NAudio.CoreAudioApi;
|
|
using RemSound.Core;
|
|
using RemSound.Sender;
|
|
|
|
namespace RemSound.App;
|
|
|
|
/// <summary>
|
|
/// The headless engine behind the RemSound Windows service: it loads the designated send-only profile
|
|
/// and streams it to the profile's peers, with no window, tray, hotkeys or screen reader. It YIELDS to
|
|
/// the interactive app — while a normal RemSound is open it suspends (stops capturing, drops the send),
|
|
/// resuming when the app closes or crashes (see <see cref="InteractivePresence"/>).
|
|
///
|
|
/// <para>Send-only and WASAPI-only by design: ASIO can't run in a service, and receive is impossible on
|
|
/// Windows 11 with no user logged in, so neither is attempted. v1 sends directly to the profile's
|
|
/// configured peer addresses (LAN / port-forwarded / reachable hosts); NAT hole-punching and relay
|
|
/// discovery are the interactive app's job, not the service's.</para>
|
|
///
|
|
/// <para>Structured so the mechanism is unit-testable without a real service: <see cref="ApplyProfile"/>,
|
|
/// <see cref="Suspend"/> and <see cref="Resume"/> are driven directly by the self-tests, and
|
|
/// <see cref="RunLoop"/> wires them to the interactive-presence token.</para>
|
|
/// </summary>
|
|
public sealed class ServiceSendHost : IDisposable
|
|
{
|
|
private readonly Func<Profile?> loadProfile;
|
|
private readonly Action<string>? log;
|
|
private readonly AudioSender sender = new();
|
|
private readonly object gate = new();
|
|
private bool running; // the engine is actively sending
|
|
private bool disposed;
|
|
|
|
/// <param name="loadProfile">Supplies the current service profile (re-read on each resume so edits
|
|
/// are picked up). Returns null if none is configured.</param>
|
|
/// <param name="log">Optional diagnostic sink.</param>
|
|
public ServiceSendHost(Func<Profile?> loadProfile, Action<string>? log = null)
|
|
{
|
|
this.loadProfile = loadProfile;
|
|
this.log = log;
|
|
}
|
|
|
|
/// <summary>Convenience factory for the real service: loads the profile named by
|
|
/// <see cref="AppConfig.ServiceProfileName"/> from the given profiles folder each time it's asked.</summary>
|
|
public static ServiceSendHost FromConfig(Action<string>? log = null) => new(() =>
|
|
{
|
|
var cfg = AppConfig.Load();
|
|
if (string.IsNullOrWhiteSpace(cfg.ServiceProfileName) || string.IsNullOrWhiteSpace(cfg.ProfilesDirectory)) return null;
|
|
try { return new ProfileStore(cfg.ProfilesDirectory).Load(cfg.ServiceProfileName!); }
|
|
catch { return null; }
|
|
}, log);
|
|
|
|
public bool IsSending { get { lock (gate) return running; } }
|
|
|
|
/// <summary>Builds the send sources, peer endpoints and encryption key from a profile and starts the
|
|
/// sender. Idempotent-ish: call <see cref="Suspend"/> before re-applying a different profile. Returns
|
|
/// false (and stays stopped) if the profile has nothing to send or no reachable peers.</summary>
|
|
public bool ApplyProfile(Profile profile)
|
|
{
|
|
lock (gate)
|
|
{
|
|
if (disposed) return false;
|
|
var specs = BuildSendSpecs(profile);
|
|
var endpoints = BuildEndpoints(profile);
|
|
if (specs.Count == 0) { log?.Invoke("service: profile has no WASAPI send sources — nothing to stream"); return false; }
|
|
if (endpoints.Count == 0) { log?.Invoke("service: profile has no reachable peers — nothing to stream to"); return false; }
|
|
|
|
sender.AudioKey = string.IsNullOrEmpty(profile.Password)
|
|
? null
|
|
: RemSoundCrypto.DeriveKey(RemSoundCrypto.Deobfuscate(profile.Password));
|
|
sender.ConfigureCodec(profile.Codec, profile.OpusFrameSamplesPerChannel);
|
|
sender.SetSendRate(profile.SendRate);
|
|
sender.SetTightLatency(profile.TightLatencyMode);
|
|
sender.SetReceivers(endpoints);
|
|
sender.Configure(specs);
|
|
sender.Start();
|
|
running = true;
|
|
log?.Invoke($"service: streaming \"{profile.Title}\" — {specs.Count} source(s) to {endpoints.Count} peer(s)");
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/// <summary>Stops sending and releases capture. Safe to call when already stopped.</summary>
|
|
public void Suspend()
|
|
{
|
|
lock (gate)
|
|
{
|
|
if (!running) return;
|
|
try { sender.Stop(); } catch (Exception ex) { log?.Invoke($"service: stop error {ex.GetType().Name}: {ex.Message}"); }
|
|
running = false;
|
|
log?.Invoke("service: suspended (interactive app present)");
|
|
}
|
|
}
|
|
|
|
/// <summary>Re-reads the current service profile and starts sending. Used when the interactive app
|
|
/// goes away, so any edits it made are picked up.</summary>
|
|
public bool Resume()
|
|
{
|
|
var profile = loadProfile();
|
|
if (profile is null) { log?.Invoke("service: no service profile configured — staying idle"); return false; }
|
|
return ApplyProfile(profile);
|
|
}
|
|
|
|
/// <summary>The service's main loop: watch the interactive-presence token and hand the send back and
|
|
/// forth. Starts sending immediately if no app is present. A short settle delay before resuming
|
|
/// stops rapid app open/close from thrashing the engine. Returns when <paramref name="ct"/> is
|
|
/// cancelled (service stop).</summary>
|
|
public void RunLoop(CancellationToken ct, int pollMs = 1000, int resumeSettleMs = 2000)
|
|
=> RunLoopCore(ct, InteractivePresence.IsInteractiveAppRunning, pollMs, resumeSettleMs);
|
|
|
|
/// <summary>Test seam: run the loop against a caller-supplied presence-token name so a test can't
|
|
/// collide with a real running app on the production token.</summary>
|
|
internal void RunLoopWithToken(CancellationToken ct, string tokenName, int pollMs, int resumeSettleMs)
|
|
=> RunLoopCore(ct, () => InteractivePresence.IsInteractiveAppRunning(tokenName), pollMs, resumeSettleMs);
|
|
|
|
private void RunLoopCore(CancellationToken ct, Func<bool> isAppPresent, int pollMs, int resumeSettleMs)
|
|
{
|
|
var appWasPresent = true; // force an initial evaluation
|
|
var absentSince = Environment.TickCount64;
|
|
while (!ct.IsCancellationRequested)
|
|
{
|
|
var appPresent = isAppPresent();
|
|
if (appPresent)
|
|
{
|
|
if (IsSending) Suspend();
|
|
absentSince = long.MaxValue;
|
|
}
|
|
else
|
|
{
|
|
if (appWasPresent) absentSince = Environment.TickCount64; // app just left — start the settle timer
|
|
if (!IsSending && Environment.TickCount64 - absentSince >= resumeSettleMs)
|
|
Resume();
|
|
}
|
|
appWasPresent = appPresent;
|
|
ct.WaitHandle.WaitOne(pollMs);
|
|
}
|
|
Suspend();
|
|
}
|
|
|
|
// WASAPI-only send specs from a profile. Mirrors the app's applications-vs-devices logic but never
|
|
// touches ASIO (the service can't). Applications mode needs Windows 10 19041+.
|
|
internal static List<CaptureSourceSpec> BuildSendSpecs(Profile p)
|
|
{
|
|
var specs = new List<CaptureSourceSpec>();
|
|
var appsMode = ProcessLoopbackCapture.IsSupported
|
|
&& string.Equals(p.WasapiSendMode, "applications", StringComparison.OrdinalIgnoreCase);
|
|
if (appsMode)
|
|
{
|
|
if (p.SendAllApplications)
|
|
{
|
|
var def = ResolveDefaultRenderId();
|
|
if (def is not null) specs.Add(new CaptureSourceSpec(def, CaptureKind.Loopback, "All applications (system audio)"));
|
|
}
|
|
else
|
|
{
|
|
foreach (var name in p.SelectedSendApplications.Distinct(StringComparer.OrdinalIgnoreCase))
|
|
foreach (var pid in AudioAppEnumerator.PidsForProcessName(name))
|
|
specs.Add(new CaptureSourceSpec(ProcessLoopbackId.Format(pid), CaptureKind.ProcessLoopback, name));
|
|
}
|
|
}
|
|
else
|
|
{
|
|
foreach (var id in p.SelectedWasapiSendOutputs.Distinct())
|
|
specs.Add(new CaptureSourceSpec(id, CaptureKind.Loopback, id));
|
|
}
|
|
foreach (var id in p.SelectedWasapiSendInputs.Distinct())
|
|
specs.Add(new CaptureSourceSpec(id, CaptureKind.Input, id));
|
|
return specs;
|
|
}
|
|
|
|
// Resolve the profile's configured peers to audio endpoints. v1: direct addresses only.
|
|
internal static List<IPEndPoint> BuildEndpoints(Profile p)
|
|
{
|
|
var entries = p.SelectedConnectedPeers.Count > 0 ? p.SelectedConnectedPeers : p.RememberedPeers;
|
|
var result = new List<IPEndPoint>();
|
|
var seen = new HashSet<string>();
|
|
foreach (var entry in entries.Where(e => !string.IsNullOrWhiteSpace(e)).Distinct())
|
|
{
|
|
var (host, port) = SplitHostPort(entry);
|
|
IPAddress? addr;
|
|
if (!IPAddress.TryParse(host, out addr))
|
|
{
|
|
try
|
|
{
|
|
var found = Dns.GetHostAddresses(host);
|
|
addr = found.FirstOrDefault(a => a.AddressFamily == AddressFamily.InterNetwork) ?? found.FirstOrDefault();
|
|
}
|
|
catch { addr = null; }
|
|
}
|
|
if (addr is null) continue;
|
|
var ep = new IPEndPoint(addr, port ?? p.AudioPort);
|
|
if (seen.Add($"{ep.Address}:{ep.Port}")) result.Add(ep);
|
|
}
|
|
return result;
|
|
}
|
|
|
|
// Minimal "host[:port]" parser (self-contained so the host doesn't depend on the WinForms UI).
|
|
internal static (string host, int? port) SplitHostPort(string text)
|
|
{
|
|
text = text.Trim();
|
|
var colon = text.LastIndexOf(':');
|
|
if (colon <= 0 || colon == text.Length - 1) return (text, null);
|
|
var host = text[..colon];
|
|
if (host.Contains(':')) return (text, null); // looks like an IPv6 literal — treat whole as host
|
|
return int.TryParse(text[(colon + 1)..], out var port) && port is >= 1 and <= 65535 ? (host, port) : (text, null);
|
|
}
|
|
|
|
private static string? ResolveDefaultRenderId()
|
|
{
|
|
try
|
|
{
|
|
using var en = new MMDeviceEnumerator();
|
|
if (!en.HasDefaultAudioEndpoint(DataFlow.Render, Role.Multimedia)) return null;
|
|
using var d = en.GetDefaultAudioEndpoint(DataFlow.Render, Role.Multimedia);
|
|
return d.ID;
|
|
}
|
|
catch { return null; }
|
|
}
|
|
|
|
public void Dispose()
|
|
{
|
|
lock (gate)
|
|
{
|
|
if (disposed) return;
|
|
disposed = true;
|
|
}
|
|
try { sender.Stop(); } catch { }
|
|
try { sender.Dispose(); } catch { }
|
|
}
|
|
}
|