feat(audio): per-stream mix controls in Windows client + vc_get_remote_stream getter
PerUserTuningDialog previously broadcast one gain/mute/NR set to *all* of a user's streams, even though the core mixer (AudioEngine::RemoteStream) and the C ABI (vc_set_remote_stream) were already per-stream. The UI had no per-mix controls anywhere. Reworks the dialog to enumerate ListUserStreams on open and render one row per stream (kind + label + Gain + Mute + NR), each wiring only to its own stream_id. Adds a read-back ABI counterpart, vc_get_remote_stream, so the dialog opens at the listener's actual current per-stream settings (defaults 1.0/unmuted/NR-off) rather than always 100%. Additive ABI change only; no existing symbols touched. Tests: test_m3_multistream extended with getter round-trip assertions; new C# smoke test exercises the full P/Invoke marshaling path with two clients. Docs: voice.md §10 notes the getter. NR checkbox keeps its honest 'passthrough' label (NS DSP still unbuilt per §8).
This commit is contained in:
@@ -3,27 +3,41 @@ using VoiceCat.Interop;
|
||||
namespace VoiceCat.App.Forms;
|
||||
|
||||
/// <summary>
|
||||
/// Per-remote-user gain, mute, and noise reduction settings.
|
||||
/// Changes are applied in real-time as the user adjusts controls — no OK/Cancel round-trip
|
||||
/// for gain and mute (the close button just dismisses). The settings live in the core and
|
||||
/// are not persisted across sessions.
|
||||
/// Per-remote-user, per-stream gain/mute/noise-reduction settings (docs/voice.md §1, §10).
|
||||
/// One row is rendered for each stream the remote user is currently publishing. Each row
|
||||
/// controls only that stream — so a listener can turn down one user's desktop audio while
|
||||
/// keeping their mic, and independently noise-reduce a third user. All of these are
|
||||
/// listener-local: no protocol traffic, no effect on other listeners.
|
||||
///
|
||||
/// Changes apply in real time as the user adjusts controls (no OK/Cancel round-trip); the
|
||||
/// Close button just dismisses. State lives in the core and is not persisted across sessions.
|
||||
/// The dialog is a modal snapshot of the streams active when it was opened — close and
|
||||
/// reopen to see streams started/stopped in the meantime.
|
||||
/// </summary>
|
||||
public sealed class PerUserTuningDialog : Form
|
||||
{
|
||||
private readonly VoiceCatClient _client;
|
||||
private readonly uint _userId;
|
||||
|
||||
private readonly TrackBar _trkGain;
|
||||
private readonly Label _lblGainValue;
|
||||
private readonly CheckBox _chkMute;
|
||||
private readonly CheckBox _chkNr;
|
||||
private readonly List<StreamRow> _rows = new();
|
||||
|
||||
public PerUserTuningDialog(VoiceCatClient client, uint userId, string nickname)
|
||||
{
|
||||
_client = client;
|
||||
_userId = userId;
|
||||
|
||||
// ── Controls ──────────────────────────────────────────────────────────
|
||||
AutoScaleMode = AutoScaleMode.Font;
|
||||
FormBorderStyle = FormBorderStyle.FixedDialog;
|
||||
MaximizeBox = false;
|
||||
MinimizeBox = false;
|
||||
StartPosition = FormStartPosition.CenterParent;
|
||||
Text = $"User settings — {nickname}";
|
||||
|
||||
BuildControls(nickname);
|
||||
}
|
||||
|
||||
private void BuildControls(string nickname)
|
||||
{
|
||||
var lblTitle = new Label
|
||||
{
|
||||
Text = $"Settings for {nickname}",
|
||||
@@ -33,93 +47,169 @@ public sealed class PerUserTuningDialog : Form
|
||||
TabIndex = 0,
|
||||
};
|
||||
|
||||
var lblGainLabel = new Label
|
||||
{
|
||||
Text = "&Gain:",
|
||||
AutoSize = true,
|
||||
Location = new Point(12, 46),
|
||||
TabIndex = 1,
|
||||
};
|
||||
var streams = _client.ListUserStreams(_userId);
|
||||
|
||||
_trkGain = new TrackBar
|
||||
{
|
||||
AccessibleName = "Gain",
|
||||
AccessibleDescription = "Volume level for this user. 100 is normal (1.0×), 200 is double.",
|
||||
Location = new Point(55, 38),
|
||||
Size = new Size(220, 45),
|
||||
Minimum = 0,
|
||||
Maximum = 200,
|
||||
Value = 100,
|
||||
TickFrequency = 25,
|
||||
SmallChange = 5,
|
||||
LargeChange = 25,
|
||||
TabIndex = 2,
|
||||
};
|
||||
const int rowH = 70; // label + trackbar + mute/nr
|
||||
const int rowGap = 8;
|
||||
int y = 44;
|
||||
|
||||
_lblGainValue = new Label
|
||||
if (streams.Count == 0)
|
||||
{
|
||||
Text = "100% (1.0×)",
|
||||
AutoSize = true,
|
||||
Location = new Point(280, 46),
|
||||
TabIndex = 3,
|
||||
};
|
||||
var lblEmpty = new Label
|
||||
{
|
||||
Text = "No active streams.",
|
||||
AutoSize = true,
|
||||
Location = new Point(12, y),
|
||||
};
|
||||
Controls.Add(lblTitle);
|
||||
Controls.Add(lblEmpty);
|
||||
ClientSize = new Size(420, 44 + lblEmpty.PreferredHeight + 16);
|
||||
return;
|
||||
}
|
||||
|
||||
_chkMute = new CheckBox
|
||||
{
|
||||
Text = "&Mute this user",
|
||||
AutoSize = true,
|
||||
Location = new Point(12, 92),
|
||||
TabIndex = 4,
|
||||
};
|
||||
Controls.Add(lblTitle);
|
||||
|
||||
_chkNr = new CheckBox
|
||||
int tabIndex = 1;
|
||||
foreach (var s in streams)
|
||||
{
|
||||
Text = "&Noise reduction (planned — currently passthrough)",
|
||||
AutoSize = true,
|
||||
Location = new Point(12, 118),
|
||||
TabIndex = 5,
|
||||
};
|
||||
var row = CreateRow(s, y, ref tabIndex);
|
||||
_rows.Add(row);
|
||||
Controls.AddRange(row.Controls);
|
||||
y += rowH + rowGap;
|
||||
}
|
||||
|
||||
var btnClose = new Button
|
||||
{
|
||||
Text = "&Close",
|
||||
DialogResult = DialogResult.OK,
|
||||
Location = new Point(296, 152),
|
||||
Location = new Point(336, y + 4),
|
||||
Size = new Size(75, 27),
|
||||
TabIndex = 6,
|
||||
TabIndex = tabIndex,
|
||||
};
|
||||
AcceptButton = btnClose;
|
||||
|
||||
Controls.Add(btnClose);
|
||||
|
||||
ClientSize = new Size(420, y + 40);
|
||||
}
|
||||
|
||||
private StreamRow CreateRow(StreamSummary s, int y, ref int tabIndex)
|
||||
{
|
||||
// Read back the listener's current state for this stream (defaults if never set).
|
||||
float gain0 = 1.0f; bool mute0 = false; bool nr0 = false;
|
||||
var (r, state) = _client.GetRemoteStream(_userId, s.StreamId);
|
||||
if (r == VcResult.Ok && state is not null)
|
||||
{
|
||||
gain0 = state.Gain;
|
||||
mute0 = state.Muted;
|
||||
nr0 = state.NoiseReduction;
|
||||
}
|
||||
|
||||
var lblName = new Label
|
||||
{
|
||||
Text = StreamLabel(s),
|
||||
AutoSize = true,
|
||||
Font = new Font(Font, FontStyle.Bold),
|
||||
Location = new Point(12, y),
|
||||
TabIndex = tabIndex++,
|
||||
};
|
||||
|
||||
// ── Wire events ───────────────────────────────────────────────────────
|
||||
_trkGain.Scroll += (_, _) =>
|
||||
var trkGain = new TrackBar
|
||||
{
|
||||
AccessibleName = $"Gain for {s.Label}",
|
||||
AccessibleDescription = "Volume level for this stream. 100 is normal (1.0×), 200 is double.",
|
||||
Location = new Point(12, y + 20),
|
||||
Size = new Size(260, 45),
|
||||
Minimum = 0,
|
||||
Maximum = 200,
|
||||
Value = ClampToTrack(gain0),
|
||||
TickFrequency = 25,
|
||||
SmallChange = 5,
|
||||
LargeChange = 25,
|
||||
TabIndex = tabIndex++,
|
||||
};
|
||||
|
||||
var lblGainValue = new Label
|
||||
{
|
||||
AutoSize = true,
|
||||
Location = new Point(280, y + 28),
|
||||
TabIndex = tabIndex++,
|
||||
};
|
||||
void UpdateGainLabel() =>
|
||||
lblGainValue.Text = $"{trkGain.Value}% ({trkGain.Value / 100f:F1}×)";
|
||||
UpdateGainLabel();
|
||||
|
||||
var chkMute = new CheckBox
|
||||
{
|
||||
Text = "&Mute",
|
||||
AutoSize = true,
|
||||
Location = new Point(12, y + 48),
|
||||
Checked = mute0,
|
||||
TabIndex = tabIndex++,
|
||||
};
|
||||
|
||||
var chkNr = new CheckBox
|
||||
{
|
||||
Text = "&Noise reduction (planned — currently passthrough)",
|
||||
AutoSize = true,
|
||||
Location = new Point(96, y + 48),
|
||||
Checked = nr0,
|
||||
TabIndex = tabIndex++,
|
||||
};
|
||||
|
||||
var row = new StreamRow(s.StreamId, trkGain, chkMute, chkNr,
|
||||
new Control[] { lblName, trkGain, lblGainValue, chkMute, chkNr });
|
||||
|
||||
trkGain.Scroll += (_, _) =>
|
||||
{
|
||||
UpdateGainLabel();
|
||||
row.Apply(_client, _userId);
|
||||
};
|
||||
chkMute.CheckedChanged += (_, _) => row.Apply(_client, _userId);
|
||||
chkNr.CheckedChanged += (_, _) => row.Apply(_client, _userId);
|
||||
|
||||
return row;
|
||||
}
|
||||
|
||||
private static string StreamLabel(StreamSummary s)
|
||||
{
|
||||
var kind = s.Kind switch
|
||||
{
|
||||
VcStreamKind.Mic => "Mic",
|
||||
VcStreamKind.ScreenAudio => "Screen audio",
|
||||
VcStreamKind.AuxDevice => "Aux device",
|
||||
_ => "Stream",
|
||||
};
|
||||
return string.IsNullOrWhiteSpace(s.Label) ? kind : $"{kind} — {s.Label}";
|
||||
}
|
||||
|
||||
private static int ClampToTrack(float gain)
|
||||
{
|
||||
int v = (int)Math.Round(gain * 100f);
|
||||
return Math.Max(0, Math.Min(200, v));
|
||||
}
|
||||
|
||||
private sealed class StreamRow
|
||||
{
|
||||
private readonly uint _streamId;
|
||||
private readonly TrackBar _trkGain;
|
||||
private readonly CheckBox _chkMute;
|
||||
private readonly CheckBox _chkNr;
|
||||
public Control[] Controls { get; }
|
||||
|
||||
public StreamRow(uint streamId, TrackBar trkGain, CheckBox chkMute, CheckBox chkNr, Control[] controls)
|
||||
{
|
||||
_streamId = streamId;
|
||||
_trkGain = trkGain;
|
||||
_chkMute = chkMute;
|
||||
_chkNr = chkNr;
|
||||
Controls = controls;
|
||||
}
|
||||
|
||||
public void Apply(VoiceCatClient client, uint userId)
|
||||
{
|
||||
float gain = _trkGain.Value / 100f;
|
||||
_lblGainValue.Text = $"{_trkGain.Value}% ({gain:F1}×)";
|
||||
ApplySettings();
|
||||
};
|
||||
_chkMute.CheckedChanged += (_, _) => ApplySettings();
|
||||
_chkNr.CheckedChanged += (_, _) => ApplySettings();
|
||||
|
||||
// ── Form ──────────────────────────────────────────────────────────────
|
||||
AcceptButton = btnClose;
|
||||
AutoScaleMode = AutoScaleMode.Font;
|
||||
ClientSize = new Size(384, 192);
|
||||
Controls.AddRange([lblTitle, lblGainLabel, _trkGain, _lblGainValue,
|
||||
_chkMute, _chkNr, btnClose]);
|
||||
FormBorderStyle = FormBorderStyle.FixedDialog;
|
||||
MaximizeBox = false;
|
||||
MinimizeBox = false;
|
||||
StartPosition = FormStartPosition.CenterParent;
|
||||
Text = $"User settings — {nickname}";
|
||||
}
|
||||
|
||||
private void ApplySettings()
|
||||
{
|
||||
float gain = _trkGain.Value / 100f;
|
||||
bool muted = _chkMute.Checked;
|
||||
bool nr = _chkNr.Checked;
|
||||
// Apply to all of this user's streams
|
||||
var streams = _client.ListUserStreams(_userId);
|
||||
foreach (var s in streams)
|
||||
_client.SetRemoteStream(_userId, s.StreamId, gain, muted, nr);
|
||||
client.SetRemoteStream(userId, _streamId, gain, _chkMute.Checked, _chkNr.Checked);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -293,4 +293,103 @@ public sealed class VoiceCatClientSmokeTests : IDisposable
|
||||
|
||||
client.Disconnect();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Per-stream receive-side controls (gain/mute/NR) round-trip through P/Invoke: two
|
||||
/// clients in a channel, one publishes a MIC stream, the other SetRemoteStream's it then
|
||||
/// GetRemoteStream's it back. Catches P/Invoke-specific marshaling bugs in
|
||||
/// VcRemoteStreamStateNative (field order, bool-from-int, float precision) that the C++
|
||||
/// ctest (test_m3_multistream) cannot. See docs/voice.md §1, §10.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public void PerStream_RecvControls_RoundTrip_Through_PInvoke()
|
||||
{
|
||||
var eventsA = new List<VoiceCatEvent>();
|
||||
var eventsB = new List<VoiceCatEvent>();
|
||||
using var a = new VoiceCatClient("vc-csharp-mix-a", "0.1", VcLogLevel.Off,
|
||||
tofuStorePath: Path.Combine(_tempDir, "tofu_pins_mix_a.txt"));
|
||||
using var b = new VoiceCatClient("vc-csharp-mix-b", "0.1", VcLogLevel.Off,
|
||||
tofuStorePath: Path.Combine(_tempDir, "tofu_pins_mix_b.txt"));
|
||||
a.EventReceived += eventsA.Add;
|
||||
b.EventReceived += eventsB.Add;
|
||||
|
||||
// Connect + auth A first, then B — staggering avoids concurrent TLS handshakes against
|
||||
// the same server (mirrors the C++ test_m3_multistream harness, which connects A to
|
||||
// completion before starting B).
|
||||
Assert.Equal(VcResult.Ok, a.Connect("127.0.0.1", _port));
|
||||
Assert.Equal(VcResult.Ok, a.AuthenticateGuest("CSharpMixA"));
|
||||
Assert.True(PumpUntil(a, () => eventsA.Any(e => e.Type == VcEventType.ServerIdentity), 5000));
|
||||
Assert.Equal(VcResult.Ok, a.ConfirmServerIdentity(accept: true));
|
||||
Assert.True(PumpUntil(a, () => eventsA.Any(e => e.Type == VcEventType.AuthResult), 5000));
|
||||
Assert.Equal(VcResult.Ok, eventsA.First(e => e.Type == VcEventType.AuthResult).Result);
|
||||
Assert.True(PumpUntil(a, () => eventsA.Any(e => e.Type == VcEventType.ChannelList), 3000));
|
||||
|
||||
Assert.Equal(VcResult.Ok, b.Connect("127.0.0.1", _port));
|
||||
Assert.Equal(VcResult.Ok, b.AuthenticateGuest("CSharpMixB"));
|
||||
Assert.True(PumpUntil(b, () => eventsB.Any(e => e.Type == VcEventType.ServerIdentity), 5000));
|
||||
Assert.Equal(VcResult.Ok, b.ConfirmServerIdentity(accept: true));
|
||||
Assert.True(PumpUntil(b, () => eventsB.Any(e => e.Type == VcEventType.AuthResult), 5000));
|
||||
Assert.Equal(VcResult.Ok, eventsB.First(e => e.Type == VcEventType.AuthResult).Result);
|
||||
Assert.True(PumpUntil(b, () => eventsB.Any(e => e.Type == VcEventType.ChannelList), 3000));
|
||||
|
||||
// Both join Lobby (channel 1) so voice relays between them.
|
||||
Assert.Equal(VcResult.Ok, a.JoinChannel(1, null));
|
||||
Assert.True(PumpUntil(a, () => eventsA.Any(e => e.Type == VcEventType.JoinResult), 5000),
|
||||
"A did not receive VC_EVENT_JOIN_RESULT");
|
||||
Assert.Equal(VcResult.Ok, b.JoinChannel(1, null));
|
||||
Assert.True(PumpUntil(b, () => eventsB.Any(e => e.Type == VcEventType.JoinResult), 5000),
|
||||
"B did not receive VC_EVENT_JOIN_RESULT");
|
||||
|
||||
// UDP binding handshake is async; give it a moment (mirrors ScreenAudio test).
|
||||
Thread.Sleep(500);
|
||||
|
||||
// A publishes a MIC stream.
|
||||
var (startResult, streamId) = a.StartStream(VcStreamKind.Mic, "mix-test-mic");
|
||||
Assert.Equal(VcResult.Ok, startResult);
|
||||
Assert.True(streamId != 0);
|
||||
|
||||
// B sees A's stream and can enumerate it.
|
||||
uint aUid = 0;
|
||||
Assert.True(PumpUntil(b, () =>
|
||||
{
|
||||
return eventsB.Any(e => e.Type == VcEventType.StreamStarted && e.StreamId == streamId);
|
||||
}, 5000), "B did not see A's STREAM_STARTED");
|
||||
// Resolve A's user id from B's user list.
|
||||
Assert.True(PumpUntil(b, () =>
|
||||
{
|
||||
aUid = b.ListUsers().FirstOrDefault(u => u.Nickname == "CSharpMixA")?.Id ?? 0;
|
||||
return aUid != 0;
|
||||
}, 3000), "could not resolve A's user id on B");
|
||||
Assert.True(aUid != 0);
|
||||
|
||||
Assert.True(PumpUntil(b, () => b.ListUserStreams(aUid).Any(s => s.StreamId == streamId), 3000),
|
||||
"B could not enumerate A's stream");
|
||||
var bStreams = b.ListUserStreams(aUid);
|
||||
Assert.Contains(bStreams, s => s.StreamId == streamId && s.Kind == VcStreamKind.Mic);
|
||||
|
||||
// Before B ever sets anything, defaults read back (gain 1.0, unmuted, NR off).
|
||||
var (r0, st0) = b.GetRemoteStream(aUid, streamId);
|
||||
Assert.Equal(VcResult.Ok, r0);
|
||||
Assert.NotNull(st0);
|
||||
Assert.Equal(1.0f, st0!.Gain);
|
||||
Assert.False(st0.Muted);
|
||||
Assert.False(st0.NoiseReduction);
|
||||
|
||||
// B turns A down to 0.4×, mutes, and enables NR — then reads it back.
|
||||
Assert.Equal(VcResult.Ok, b.SetRemoteStream(aUid, streamId, 0.4f, muted: true, noiseReduction: true));
|
||||
var (r1, st1) = b.GetRemoteStream(aUid, streamId);
|
||||
Assert.Equal(VcResult.Ok, r1);
|
||||
Assert.NotNull(st1);
|
||||
Assert.Equal(0.4f, st1!.Gain);
|
||||
Assert.True(st1.Muted);
|
||||
Assert.True(st1.NoiseReduction);
|
||||
|
||||
// Unknown stream id on a known user -> INVALID_ARG.
|
||||
var (rBad, stBad) = b.GetRemoteStream(aUid, 0xDEADBEEF);
|
||||
Assert.Equal(VcResult.InvalidArg, rBad);
|
||||
Assert.Null(stBad);
|
||||
|
||||
a.Disconnect();
|
||||
b.Disconnect();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -81,6 +81,11 @@ internal static class Marshaling
|
||||
return result;
|
||||
}
|
||||
|
||||
public static RemoteStreamState ToManaged(in VcRemoteStreamStateNative native) => new(
|
||||
native.Gain,
|
||||
native.Muted != 0,
|
||||
native.NoiseReduction != 0);
|
||||
|
||||
public static AudioConfigInfo ToManaged(in VcAudioConfigNative native) => new(
|
||||
native.Codec,
|
||||
native.Mode != 0,
|
||||
|
||||
@@ -51,6 +51,11 @@ public sealed record StreamSummary(
|
||||
VcStreamKind Kind,
|
||||
string Label);
|
||||
|
||||
public sealed record RemoteStreamState(
|
||||
float Gain,
|
||||
bool Muted,
|
||||
bool NoiseReduction);
|
||||
|
||||
public sealed record DeviceInfo(
|
||||
string Id,
|
||||
string Name,
|
||||
|
||||
@@ -81,6 +81,10 @@ internal static partial class NativeMethods
|
||||
internal static partial VcResult vc_set_remote_stream(nint c, uint userId, uint streamId,
|
||||
float gain, int muted, int noiseReduction);
|
||||
|
||||
[LibraryImport(LibName)]
|
||||
internal static partial VcResult vc_get_remote_stream(nint c, uint userId, uint streamId,
|
||||
out VcRemoteStreamStateNative outState);
|
||||
|
||||
[LibraryImport(LibName)]
|
||||
internal static partial VcResult vc_get_stream_audio_config(nint c, uint userId,
|
||||
uint streamId, out VcAudioConfigNative outCfg);
|
||||
|
||||
@@ -156,6 +156,14 @@ internal struct VcStreamSummaryListNative
|
||||
public nuint Count;
|
||||
}
|
||||
|
||||
[StructLayout(LayoutKind.Sequential)]
|
||||
internal struct VcRemoteStreamStateNative
|
||||
{
|
||||
public float Gain;
|
||||
public int Muted;
|
||||
public int NoiseReduction;
|
||||
}
|
||||
|
||||
[StructLayout(LayoutKind.Sequential)]
|
||||
internal struct VcAccountNative
|
||||
{
|
||||
|
||||
@@ -208,6 +208,13 @@ public sealed class VoiceCatClient : IDisposable
|
||||
NativeMethods.vc_set_remote_stream(_handle.DangerousGetHandle(), userId, streamId, gain,
|
||||
muted ? 1 : 0, noiseReduction ? 1 : 0);
|
||||
|
||||
public (VcResult Result, RemoteStreamState? State) GetRemoteStream(uint userId, uint streamId)
|
||||
{
|
||||
var r = NativeMethods.vc_get_remote_stream(_handle.DangerousGetHandle(), userId,
|
||||
streamId, out var native);
|
||||
return (r, r == VcResult.Ok ? Marshaling.ToManaged(in native) : null);
|
||||
}
|
||||
|
||||
public (VcResult Result, AudioConfigInfo? Config) GetStreamAudioConfig(uint userId, uint streamId)
|
||||
{
|
||||
var r = NativeMethods.vc_get_stream_audio_config(_handle.DangerousGetHandle(), userId,
|
||||
|
||||
Reference in New Issue
Block a user