GST_STATIC_CAPS (GST_WASAPI_STATIC_CAPS));
#define DEFAULT_ROLE GST_WASAPI_DEVICE_ROLE_CONSOLE
+#define DEFAULT_LOOPBACK FALSE
#define DEFAULT_EXCLUSIVE FALSE
#define DEFAULT_LOW_LATENCY FALSE
#define DEFAULT_AUDIOCLIENT3 FALSE
+/* The clock provided by WASAPI is always off and causes buffers to be late
+ * very quickly on the sink. Disable pending further investigation. */
+#define DEFAULT_PROVIDE_CLOCK FALSE
enum
{
PROP_0,
PROP_ROLE,
PROP_DEVICE,
+ PROP_LOOPBACK,
PROP_EXCLUSIVE,
PROP_LOW_LATENCY,
PROP_AUDIOCLIENT3
static guint gst_wasapi_src_delay (GstAudioSrc * asrc);
static void gst_wasapi_src_reset (GstAudioSrc * asrc);
+#if DEFAULT_PROVIDE_CLOCK
static GstClockTime gst_wasapi_src_get_time (GstClock * clock,
gpointer user_data);
+#endif
#define gst_wasapi_src_parent_class parent_class
G_DEFINE_TYPE (GstWasapiSrc, gst_wasapi_src, GST_TYPE_AUDIO_SRC);
NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (gobject_class,
+ PROP_LOOPBACK,
+ g_param_spec_boolean ("loopback", "Loopback recording",
+ "Open the sink device for loopback recording",
+ DEFAULT_LOOPBACK, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+ g_object_class_install_property (gobject_class,
PROP_EXCLUSIVE,
g_param_spec_boolean ("exclusive", "Exclusive mode",
"Open the device in exclusive mode",
gst_element_class_add_static_pad_template (gstelement_class, &src_template);
gst_element_class_set_static_metadata (gstelement_class, "WasapiSrc",
- "Source/Audio",
+ "Source/Audio/Hardware",
"Stream audio from an audio capture device through WASAPI",
"Nirbheek Chauhan <nirbheek@centricular.com>, "
"Ole André Vadla Ravnås <ole.andre.ravnas@tandberg.com>");
static void
gst_wasapi_src_init (GstWasapiSrc * self)
{
+#if DEFAULT_PROVIDE_CLOCK
/* override with a custom clock */
if (GST_AUDIO_BASE_SRC (self)->clock)
gst_object_unref (GST_AUDIO_BASE_SRC (self)->clock);
GST_AUDIO_BASE_SRC (self)->clock = gst_audio_clock_new ("GstWasapiSrcClock",
gst_wasapi_src_get_time, gst_object_ref (self),
(GDestroyNotify) gst_object_unref);
+#endif
self->role = DEFAULT_ROLE;
self->sharemode = AUDCLNT_SHAREMODE_SHARED;
+ self->loopback = DEFAULT_LOOPBACK;
self->low_latency = DEFAULT_LOW_LATENCY;
self->try_audioclient3 = DEFAULT_AUDIOCLIENT3;
self->event_handle = CreateEvent (NULL, FALSE, FALSE, NULL);
+ self->client_needs_restart = FALSE;
+ self->adapter = gst_adapter_new ();
- CoInitialize (NULL);
+ CoInitializeEx (NULL, COINIT_MULTITHREADED);
}
static void
{
GstWasapiSrc *self = GST_WASAPI_SRC (object);
- g_clear_pointer (&self->mix_format, CoTaskMemFree);
+ CoTaskMemFree (self->mix_format);
+ self->mix_format = NULL;
CoUninitialize ();
g_clear_pointer (&self->positions, g_free);
g_clear_pointer (&self->device_strid, g_free);
+ g_object_unref (self->adapter);
+ self->adapter = NULL;
+
G_OBJECT_CLASS (parent_class)->finalize (object);
}
device ? g_utf8_to_utf16 (device, -1, NULL, NULL, NULL) : NULL;
break;
}
+ case PROP_LOOPBACK:
+ self->loopback = g_value_get_boolean (value);
+ break;
case PROP_EXCLUSIVE:
self->sharemode = g_value_get_boolean (value)
? AUDCLNT_SHAREMODE_EXCLUSIVE : AUDCLNT_SHAREMODE_SHARED;
g_value_take_string (value, self->device_strid ?
g_utf16_to_utf8 (self->device_strid, -1, NULL, NULL, NULL) : NULL);
break;
+ case PROP_LOOPBACK:
+ g_value_set_boolean (value, self->loopback);
+ break;
case PROP_EXCLUSIVE:
g_value_set_boolean (value,
self->sharemode == AUDCLNT_SHAREMODE_EXCLUSIVE);
template_caps = gst_pad_get_pad_template_caps (bsrc->srcpad);
- if (!self->client)
- gst_wasapi_src_open (GST_AUDIO_SRC (bsrc));
+ if (!self->client) {
+ caps = template_caps;
+ goto out;
+ }
ret = gst_wasapi_util_get_device_format (GST_ELEMENT (self),
self->sharemode, self->device, self->client, &format);
if (!ret) {
GST_ELEMENT_ERROR (self, STREAM, FORMAT, (NULL),
("failed to detect format"));
- goto out;
+ gst_caps_unref (template_caps);
+ return NULL;
}
gst_wasapi_util_parse_waveformatex ((WAVEFORMATEXTENSIBLE *) format,
template_caps, &caps, &self->positions);
if (caps == NULL) {
GST_ELEMENT_ERROR (self, STREAM, FORMAT, (NULL), ("unknown format"));
- goto out;
+ gst_caps_unref (template_caps);
+ return NULL;
}
{
caps = filtered;
}
- GST_DEBUG_OBJECT (self, "returning caps %" GST_PTR_FORMAT, caps);
-
out:
+ GST_DEBUG_OBJECT (self, "returning caps %" GST_PTR_FORMAT, caps);
return caps;
}
* even if the old device was unplugged. We need to handle this somehow.
* For example, perhaps we should automatically switch to the new device if
* the default device is changed and a device isn't explicitly selected. */
- if (!gst_wasapi_util_get_device_client (GST_ELEMENT (self), TRUE,
- self->role, self->device_strid, &device, &client)) {
+ if (!gst_wasapi_util_get_device_client (GST_ELEMENT (self),
+ self->loopback ? eRender : eCapture, self->role, self->device_strid,
+ &device, &client)) {
if (!self->device_strid)
GST_ELEMENT_ERROR (self, RESOURCE, OPEN_READ, (NULL),
("Failed to get default device"));
guint bpf, rate, devicep_frames, buffer_frames;
HRESULT hr;
+ CoInitializeEx (NULL, COINIT_MULTITHREADED);
+
if (gst_wasapi_src_can_audioclient3 (self)) {
if (!gst_wasapi_util_initialize_audioclient3 (GST_ELEMENT (self), spec,
(IAudioClient3 *) self->client, self->mix_format, self->low_latency,
- &devicep_frames))
+ self->loopback, &devicep_frames))
goto beach;
} else {
if (!gst_wasapi_util_initialize_audioclient (GST_ELEMENT (self), spec,
self->client, self->mix_format, self->sharemode, self->low_latency,
- &devicep_frames))
+ self->loopback, &devicep_frames))
goto beach;
}
spec->segsize = devicep_frames * bpf;
/* We need a minimum of 2 segments to ensure glitch-free playback */
- spec->segtotal = MAX (self->buffer_frame_count * bpf / spec->segsize, 2);
+ spec->segtotal = MAX (buffer_frames * bpf / spec->segsize, 2);
GST_INFO_OBJECT (self, "segsize is %i, segtotal is %i", spec->segsize,
spec->segtotal);
hr = IAudioClock_GetFrequency (self->client_clock, &self->client_clock_freq);
HR_FAILED_GOTO (hr, IAudioClock::GetFrequency, beach);
+ GST_INFO_OBJECT (self, "wasapi clock freq is %" G_GUINT64_FORMAT,
+ self->client_clock_freq);
+
/* Get capture source client and start it up */
if (!gst_wasapi_util_get_capture_client (GST_ELEMENT (self), self->client,
&self->capture_client)) {
hr = IAudioClient_Start (self->client);
HR_FAILED_GOTO (hr, IAudioClock::Start, beach);
+ self->client_needs_restart = FALSE;
gst_audio_ring_buffer_set_channel_positions (GST_AUDIO_BASE_SRC
(self)->ringbuffer, self->positions);
- /* Increase the thread priority to reduce glitches */
- self->thread_priority_handle = gst_wasapi_util_set_thread_characteristics ();
-
res = TRUE;
beach:
/* unprepare() is not called if prepare() fails, but we want it to be, so call
{
GstWasapiSrc *self = GST_WASAPI_SRC (asrc);
- if (self->sharemode == AUDCLNT_SHAREMODE_EXCLUSIVE &&
- !gst_wasapi_src_can_audioclient3 (self))
- CoUninitialize ();
-
- if (self->thread_priority_handle != NULL) {
- gst_wasapi_util_revert_thread_characteristics
- (self->thread_priority_handle);
- self->thread_priority_handle = NULL;
- }
-
if (self->client != NULL) {
IAudioClient_Stop (self->client);
}
self->client_clock_freq = 0;
+ CoUninitialize ();
+
return TRUE;
}
HRESULT hr;
gint16 *from = NULL;
guint wanted = length;
+ guint bpf;
DWORD flags;
+ GST_OBJECT_LOCK (self);
+ if (self->client_needs_restart) {
+ hr = IAudioClient_Start (self->client);
+ HR_FAILED_ELEMENT_ERROR_AND (hr, IAudioClient::Start, self,
+ GST_OBJECT_UNLOCK (self); goto err);
+ self->client_needs_restart = FALSE;
+ gst_adapter_clear (self->adapter);
+ }
+
+ bpf = self->mix_format->nBlockAlign;
+ GST_OBJECT_UNLOCK (self);
+
+ /* If we've accumulated enough data, return it immediately */
+ if (gst_adapter_available (self->adapter) >= wanted) {
+ memcpy (data, gst_adapter_map (self->adapter, wanted), wanted);
+ gst_adapter_flush (self->adapter, wanted);
+ GST_DEBUG_OBJECT (self, "Adapter has enough data, returning %i", wanted);
+ goto out;
+ }
+
while (wanted > 0) {
- guint have_frames, n_frames, want_frames, read_len;
+ DWORD dwWaitResult;
+ guint got_frames, avail_frames, n_frames, want_frames, read_len;
/* Wait for data to become available */
- WaitForSingleObject (self->event_handle, INFINITE);
+ dwWaitResult = WaitForSingleObject (self->event_handle, INFINITE);
+ if (dwWaitResult != WAIT_OBJECT_0) {
+ GST_ERROR_OBJECT (self, "Error waiting for event handle: %x",
+ (guint) dwWaitResult);
+ goto err;
+ }
hr = IAudioCaptureClient_GetBuffer (self->capture_client,
- (BYTE **) & from, &have_frames, &flags, NULL, NULL);
+ (BYTE **) & from, &got_frames, &flags, NULL, NULL);
if (hr != S_OK) {
- gchar *msg = gst_wasapi_util_hresult_to_string (hr);
- if (hr == AUDCLNT_S_BUFFER_EMPTY)
+ if (hr == AUDCLNT_S_BUFFER_EMPTY) {
+ gchar *msg = gst_wasapi_util_hresult_to_string (hr);
GST_WARNING_OBJECT (self, "IAudioCaptureClient::GetBuffer failed: %s"
", retrying", msg);
- else
- GST_ERROR_OBJECT (self, "IAudioCaptureClient::GetBuffer failed: %s",
- msg);
- g_free (msg);
- length = 0;
- goto beach;
+ g_free (msg);
+ length = 0;
+ goto out;
+ }
+ HR_FAILED_ELEMENT_ERROR_AND (hr, IAudioCaptureClient::GetBuffer, self,
+ goto err);
}
- if (flags != 0)
- GST_INFO_OBJECT (self, "buffer flags=%#08x", (guint) flags);
-
- /* XXX: How do we handle AUDCLNT_BUFFERFLAGS_SILENT? We're supposed to write
- * out silence when that flag is set? See:
- * https://msdn.microsoft.com/en-us/library/windows/desktop/dd370800(v=vs.85).aspx */
+ if (G_UNLIKELY (flags != 0)) {
+ /* https://docs.microsoft.com/en-us/windows/win32/api/audioclient/ne-audioclient-_audclnt_bufferflags */
+ if (flags & AUDCLNT_BUFFERFLAGS_DATA_DISCONTINUITY)
+ GST_DEBUG_OBJECT (self, "WASAPI reported discontinuity (glitch?)");
+ if (flags & AUDCLNT_BUFFERFLAGS_TIMESTAMP_ERROR)
+ GST_DEBUG_OBJECT (self, "WASAPI reported a timestamp error");
+ }
- if (flags & AUDCLNT_BUFFERFLAGS_DATA_DISCONTINUITY)
- GST_WARNING_OBJECT (self, "WASAPI reported glitch in buffer");
+ /* Copy all the frames we got into the adapter, and then extract at most
+ * @wanted size of frames from it. This helps when ::GetBuffer returns more
+ * data than we can handle right now. */
+ {
+ GstBuffer *tmp = gst_buffer_new_allocate (NULL, got_frames * bpf, NULL);
+ /* If flags has AUDCLNT_BUFFERFLAGS_SILENT, we will ignore the actual
+ * data and write out silence, see:
+ * https://docs.microsoft.com/en-us/windows/win32/api/audioclient/ne-audioclient-_audclnt_bufferflags */
+ if (flags & AUDCLNT_BUFFERFLAGS_SILENT)
+ memset (from, 0, got_frames * bpf);
+ gst_buffer_fill (tmp, 0, from, got_frames * bpf);
+ gst_adapter_push (self->adapter, tmp);
+ }
- want_frames = wanted / self->mix_format->nBlockAlign;
+ /* Release all captured buffers; we copied them above */
+ hr = IAudioCaptureClient_ReleaseBuffer (self->capture_client, got_frames);
+ from = NULL;
+ HR_FAILED_ELEMENT_ERROR_AND (hr, IAudioCaptureClient::ReleaseBuffer, self,
+ goto err);
- /* If GetBuffer is returning more frames than we can handle, all we can do is
- * hope that this is temporary and that things will settle down later. */
- if (G_UNLIKELY (have_frames > want_frames))
- GST_WARNING_OBJECT (self, "captured too many frames: have %i, want %i",
- have_frames, want_frames);
+ want_frames = wanted / bpf;
+ avail_frames = gst_adapter_available (self->adapter) / bpf;
/* Only copy data that will fit into the allocated buffer of size @length */
- n_frames = MIN (have_frames, want_frames);
- read_len = n_frames * self->mix_format->nBlockAlign;
+ n_frames = MIN (avail_frames, want_frames);
+ read_len = n_frames * bpf;
- {
- guint bpf = self->mix_format->nBlockAlign;
- GST_DEBUG_OBJECT (self, "have: %i (%i bytes), can read: %i (%i bytes), "
- "will read: %i (%i bytes)", have_frames, have_frames * bpf,
- want_frames, wanted, n_frames, read_len);
- }
+ GST_DEBUG_OBJECT (self, "frames captured: %i (%i bytes), "
+ "can read: %i (%i bytes), will read: %i (%i bytes), "
+ "adapter has: %i (%i bytes)", got_frames, got_frames * bpf, want_frames,
+ wanted, n_frames, read_len, avail_frames, avail_frames * bpf);
- memcpy (data, from, read_len);
+ memcpy (data, gst_adapter_map (self->adapter, read_len), read_len);
+ gst_adapter_flush (self->adapter, read_len);
wanted -= read_len;
-
- /* Always release all captured buffers if we've captured any at all */
- hr = IAudioCaptureClient_ReleaseBuffer (self->capture_client, have_frames);
- HR_FAILED_AND (hr, IAudioClock::ReleaseBuffer, goto beach);
}
-beach:
-
+out:
return length;
+
+err:
+ length = -1;
+ goto out;
}
static guint
if (!self->client)
return;
+ GST_OBJECT_LOCK (self);
hr = IAudioClient_Stop (self->client);
HR_FAILED_RET (hr, IAudioClock::Stop,);
hr = IAudioClient_Reset (self->client);
HR_FAILED_RET (hr, IAudioClock::Reset,);
+
+ self->client_needs_restart = TRUE;
+ GST_OBJECT_UNLOCK (self);
}
+#if DEFAULT_PROVIDE_CLOCK
static GstClockTime
gst_wasapi_src_get_time (GstClock * clock, gpointer user_data)
{
return result;
}
+#endif
projects / platform / upstream / gstreamer.git / blobdiff