[PATCH 0/1] MR337: winepulse: Return device-specific values for GetMixFormat and GetDevicePeriod
When `GetMixFormat` or `GetDevicePeriod` are used, return values specific to the selected device instead of those of the default one. This is especially useful when the audio devices features less channels than one specifically selected by the application. This patch is part of an attempt to get Sony's DualSense controllers to work with Windows games through Wine. This is not enough by itself, but getting the proper mix format is required for most of those games to correctly use the haptic feedback features of the DualSense (which go through an audio output with 4 audio devices). -- https://gitlab.winehq.org/wine/wine/-/merge_requests/337
From: Claire Girka <claire(a)sitedethib.com> When GetMixFormat or GetDevicePeriod are used, return values specific to the selected device instead of those of the default one. This is especially useful when the audio devices features less channels than one specifically selected by the application. --- dlls/winepulse.drv/mmdevdrv.c | 32 ++++++++++++++- dlls/winepulse.drv/pulse.c | 74 ++++++++++++++++++++++++++++++----- dlls/winepulse.drv/unixlib.h | 19 +++++++++ 3 files changed, 114 insertions(+), 11 deletions(-) diff --git a/dlls/winepulse.drv/mmdevdrv.c b/dlls/winepulse.drv/mmdevdrv.c index 3cbbc1d8115..1bc32c6a343 100644 --- a/dlls/winepulse.drv/mmdevdrv.c +++ b/dlls/winepulse.drv/mmdevdrv.c @@ -1142,7 +1142,20 @@ static HRESULT WINAPI AudioClient_GetMixFormat(IAudioClient3 *iface, if (!pwfx) return E_POINTER; - *pwfx = clone_format(&pulse_config.modes[This->dataflow == eCapture].format.Format); + if (This->pulse_name[0]) { + struct get_device_mix_format_params params; + params.render = This->dataflow == eRender; + params.pulse_name = This->pulse_name; + pulse_call(get_device_mix_format, ¶ms); + + if (FAILED(params.result)) + return params.result; + + *pwfx = clone_format(¶ms.fmt.Format); + } else { + *pwfx = clone_format(&pulse_config.modes[This->dataflow == eCapture].format.Format); + } + if (!*pwfx) return E_OUTOFMEMORY; dump_fmt(*pwfx); @@ -1159,6 +1172,23 @@ static HRESULT WINAPI AudioClient_GetDevicePeriod(IAudioClient3 *iface, if (!defperiod && !minperiod) return E_POINTER; + if (This->pulse_name[0]) { + struct get_device_period_params params; + params.render = This->dataflow == eRender; + params.pulse_name = This->pulse_name; + pulse_call(get_device_period, ¶ms); + + if (FAILED(params.result)) + return params.result; + + if (defperiod) + *defperiod = params.def_period; + if (minperiod) + *minperiod = params.min_period; + + return S_OK; + } + if (defperiod) *defperiod = pulse_config.modes[This->dataflow == eCapture].def_period; if (minperiod) diff --git a/dlls/winepulse.drv/pulse.c b/dlls/winepulse.drv/pulse.c index 42d73db45f9..f113d1b2a62 100644 --- a/dlls/winepulse.drv/pulse.c +++ b/dlls/winepulse.drv/pulse.c @@ -89,6 +89,8 @@ typedef struct _PhysDevice { EndpointFormFactor form; UINT channel_mask; UINT index; + REFERENCE_TIME min_period, def_period; + WAVEFORMATEXTENSIBLE fmt; char pulse_name[0]; } PhysDevice; @@ -539,6 +541,7 @@ static void pulse_add_device(struct list *list, pa_proplist *proplist, int index free(dev); return; } + dev->form = form; dev->index = index; dev->channel_mask = channel_mask; @@ -659,7 +662,7 @@ static void convert_channel_map(const pa_channel_map *pa_map, WAVEFORMATEXTENSIB fmt->dwChannelMask = pa_mask; } -static void pulse_probe_settings(int render, WAVEFORMATEXTENSIBLE *fmt) { +static void pulse_probe_settings(int render, WAVEFORMATEXTENSIBLE *fmt, REFERENCE_TIME *def_period, REFERENCE_TIME *min_period, CHAR *pulse_name) { WAVEFORMATEX *wfx = &fmt->Format; pa_stream *stream; pa_channel_map map; @@ -684,10 +687,10 @@ static void pulse_probe_settings(int render, WAVEFORMATEXTENSIBLE *fmt) { if (!stream) ret = -1; else if (render) - ret = pa_stream_connect_playback(stream, NULL, &attr, + ret = pa_stream_connect_playback(stream, pulse_name, &attr, PA_STREAM_START_CORKED|PA_STREAM_FIX_RATE|PA_STREAM_FIX_CHANNELS|PA_STREAM_EARLY_REQUESTS, NULL, NULL); else - ret = pa_stream_connect_record(stream, NULL, &attr, PA_STREAM_START_CORKED|PA_STREAM_FIX_RATE|PA_STREAM_FIX_CHANNELS|PA_STREAM_EARLY_REQUESTS); + ret = pa_stream_connect_record(stream, pulse_name, &attr, PA_STREAM_START_CORKED|PA_STREAM_FIX_RATE|PA_STREAM_FIX_CHANNELS|PA_STREAM_EARLY_REQUESTS); if (ret >= 0) { while (pa_mainloop_iterate(pulse_ml, 1, &ret) >= 0 && pa_stream_get_state(stream) == PA_STREAM_CREATING) @@ -710,13 +713,13 @@ static void pulse_probe_settings(int render, WAVEFORMATEXTENSIBLE *fmt) { pa_stream_unref(stream); if (length) - pulse_def_period[!render] = pulse_min_period[!render] = pa_bytes_to_usec(10 * length, &ss); + *def_period = *min_period = pa_bytes_to_usec(10 * length, &ss); - if (pulse_min_period[!render] < MinimumPeriod) - pulse_min_period[!render] = MinimumPeriod; + if (*min_period < MinimumPeriod) + *min_period = MinimumPeriod; - if (pulse_def_period[!render] < DefaultPeriod) - pulse_def_period[!render] = DefaultPeriod; + if (*def_period < DefaultPeriod) + *def_period = DefaultPeriod; wfx->wFormatTag = WAVE_FORMAT_EXTENSIBLE; wfx->cbSize = sizeof(WAVEFORMATEXTENSIBLE) - sizeof(WAVEFORMATEX); @@ -737,6 +740,46 @@ static void pulse_probe_settings(int render, WAVEFORMATEXTENSIBLE *fmt) { fmt->SubFormat = KSDATAFORMAT_SUBTYPE_PCM; } +static NTSTATUS pulse_get_device_mix_format(void *args) +{ + struct get_device_mix_format_params *params = args; + struct list *list = params->render ? &g_phys_speakers : &g_phys_sources; + PhysDevice *dev; + + LIST_FOR_EACH_ENTRY(dev, list, PhysDevice, entry) { + if (strcmp(params->pulse_name, dev->pulse_name)) + continue; + + params->fmt = dev->fmt; + params->result = S_OK; + + return STATUS_SUCCESS; + } + + params->result = E_FAIL; + return STATUS_SUCCESS; +} + +static NTSTATUS pulse_get_device_period(void *args) { + struct get_device_period_params *params = args; + struct list *list = params->render ? &g_phys_speakers : &g_phys_sources; + PhysDevice *dev; + + LIST_FOR_EACH_ENTRY(dev, list, PhysDevice, entry) { + if (strcmp(params->pulse_name, dev->pulse_name)) + continue; + + params->def_period = dev->def_period; + params->min_period = dev->min_period; + params->result = S_OK; + + return STATUS_SUCCESS; + } + + params->result = E_FAIL; + return STATUS_SUCCESS; +} + /* some poorly-behaved applications call audio functions during DllMain, so we * have to do as much as possible without creating a new thread. this function * sets up a synchronous connection to verify the server is running and query @@ -745,6 +788,7 @@ static NTSTATUS pulse_test_connect(void *args) { struct test_connect_params *params = args; struct pulse_config *config = params->config; + PhysDevice *dev; pa_operation *o; int ret; @@ -787,8 +831,8 @@ static NTSTATUS pulse_test_connect(void *args) pa_context_get_server(pulse_ctx), pa_context_get_server_protocol_version(pulse_ctx)); - pulse_probe_settings(1, &pulse_fmt[0]); - pulse_probe_settings(0, &pulse_fmt[1]); + pulse_probe_settings(1, &pulse_fmt[0], &pulse_def_period[0], &pulse_min_period[0], NULL); + pulse_probe_settings(0, &pulse_fmt[1], &pulse_def_period[1], &pulse_min_period[1], NULL); free_phys_device_lists(); list_init(&g_phys_speakers); @@ -813,6 +857,14 @@ static NTSTATUS pulse_test_connect(void *args) pa_operation_unref(o); } + LIST_FOR_EACH_ENTRY(dev, &g_phys_speakers, PhysDevice, entry) { + pulse_probe_settings(1, &dev->fmt, &dev->def_period, &dev->min_period, dev->pulse_name); + } + + LIST_FOR_EACH_ENTRY(dev, &g_phys_sources, PhysDevice, entry) { + pulse_probe_settings(0, &dev->fmt, &dev->def_period, &dev->min_period, dev->pulse_name); + } + pa_context_unref(pulse_ctx); pulse_ctx = NULL; pa_mainloop_free(pulse_ml); @@ -2305,6 +2357,8 @@ const unixlib_entry_t __wine_unix_call_funcs[] = pulse_test_connect, pulse_is_started, pulse_get_prop_value, + pulse_get_device_mix_format, + pulse_get_device_period, }; #ifdef _WIN64 diff --git a/dlls/winepulse.drv/unixlib.h b/dlls/winepulse.drv/unixlib.h index f224f26c909..68137c5a59a 100644 --- a/dlls/winepulse.drv/unixlib.h +++ b/dlls/winepulse.drv/unixlib.h @@ -159,6 +159,23 @@ struct get_current_padding_params UINT32 *padding; }; +struct get_device_mix_format_params +{ + const char *pulse_name; + HRESULT result; + BOOL render; + WAVEFORMATEXTENSIBLE fmt; +}; + +struct get_device_period_params +{ + const char *pulse_name; + HRESULT result; + BOOL render; + REFERENCE_TIME def_period; + REFERENCE_TIME min_period; +}; + struct get_next_packet_size_params { stream_handle stream; @@ -252,4 +269,6 @@ enum unix_funcs test_connect, is_started, get_prop_value, + get_device_mix_format, + get_device_period, }; -- GitLab https://gitlab.winehq.org/wine/wine/-/merge_requests/337
Rather than adding new unix calls, we should probably add a `BOOL device` field to the existing ones, like we do for `get_position`. Also, I’d suggest splitting this into two commits. -- https://gitlab.winehq.org/wine/wine/-/merge_requests/337#note_2945
I'm not sure using a `BOOL device` field is really an option, since there is currently no existing unix call to get those values, they are all computed in the one-shot `pulse_test_connect` then retrieved from a global object. With regards to splitting this into multiple commits, should I force-push to this branch, or make a new Merge Request? -- https://gitlab.winehq.org/wine/wine/-/merge_requests/337#note_2946
On a style note, please consistently use 4-space indents. There's also an unnecessary diff in `pulse_add_device`. I'd also suggest falling back to the default format, in the case where the unix call fails for some reason. But maybe there's a good reason to prefer failing? -- https://gitlab.winehq.org/wine/wine/-/merge_requests/337#note_2948
Oops, sorry about the styling issues, I will address them. With regards to handling failure, I think it might be more accurate to fail if the device does not exist (maybe with something like `AUDCLNT_E_DEVICE_INVALIDATED`, cf. https://docs.microsoft.com/en-us/windows/win32/api/audioclient/nf-audioclien...) but I don't think it matters much, and I can definitely fall back to the default format if you're more confident with avoiding a potential behavior change. -- https://gitlab.winehq.org/wine/wine/-/merge_requests/337#note_2950
participants (4)
-
Andrew Eikum (＠aeikum) -
Claire (＠ClearlyClaire)
-
Claire Girka
-
Huw Davies (＠huw)