2008-09-30 11:19:10 +00:00
|
|
|
/*
|
|
|
|
* Copyright (C) 2008 Ole André Vadla Ravnås <ole.andre.ravnas@tandberg.com>
|
2013-03-28 15:52:26 +00:00
|
|
|
* Copyright (C) 2013 Collabora Ltd.
|
|
|
|
* Author: Sebastian Dröge <sebastian.droege@collabora.co.uk>
|
2018-01-21 03:32:30 +00:00
|
|
|
* Copyright (C) 2018 Centricular Ltd.
|
|
|
|
* Author: Nirbheek Chauhan <nirbheek@centricular.com>
|
2008-09-30 11:19:10 +00:00
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Library General Public
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 2 of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Library General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Library General Public
|
|
|
|
* License along with this library; if not, write to the
|
2012-11-03 20:38:00 +00:00
|
|
|
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
|
|
|
|
* Boston, MA 02110-1301, USA.
|
2008-09-30 11:19:10 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* SECTION:element-wasapisink
|
2017-03-08 18:01:13 +00:00
|
|
|
* @title: wasapisink
|
2008-09-30 11:19:10 +00:00
|
|
|
*
|
|
|
|
* Provides audio playback using the Windows Audio Session API available with
|
|
|
|
* Vista and newer.
|
|
|
|
*
|
2017-03-08 18:01:13 +00:00
|
|
|
* ## Example pipelines
|
2008-09-30 11:19:10 +00:00
|
|
|
* |[
|
2013-03-26 14:22:16 +00:00
|
|
|
* gst-launch-1.0 -v audiotestsrc samplesperbuffer=160 ! wasapisink
|
2008-09-30 11:19:10 +00:00
|
|
|
* ]| Generate 20 ms buffers and render to the default audio device.
|
2017-03-08 18:01:13 +00:00
|
|
|
*
|
2008-09-30 11:19:10 +00:00
|
|
|
*/
|
2013-03-26 14:01:08 +00:00
|
|
|
#ifdef HAVE_CONFIG_H
|
|
|
|
# include <config.h>
|
|
|
|
#endif
|
2008-09-30 11:19:10 +00:00
|
|
|
|
|
|
|
#include "gstwasapisink.h"
|
|
|
|
|
2018-02-06 18:15:02 +00:00
|
|
|
#include <avrt.h>
|
|
|
|
|
2008-09-30 11:19:10 +00:00
|
|
|
GST_DEBUG_CATEGORY_STATIC (gst_wasapi_sink_debug);
|
|
|
|
#define GST_CAT_DEFAULT gst_wasapi_sink_debug
|
|
|
|
|
|
|
|
static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
|
|
|
|
GST_PAD_SINK,
|
|
|
|
GST_PAD_ALWAYS,
|
2018-01-24 02:50:38 +00:00
|
|
|
GST_STATIC_CAPS (GST_WASAPI_STATIC_CAPS));
|
2018-01-21 03:32:30 +00:00
|
|
|
|
2018-02-06 23:18:58 +00:00
|
|
|
#define DEFAULT_ROLE GST_WASAPI_DEVICE_ROLE_CONSOLE
|
|
|
|
#define DEFAULT_MUTE FALSE
|
|
|
|
#define DEFAULT_EXCLUSIVE FALSE
|
|
|
|
#define DEFAULT_LOW_LATENCY FALSE
|
2018-01-21 03:32:30 +00:00
|
|
|
|
|
|
|
enum
|
|
|
|
{
|
|
|
|
PROP_0,
|
|
|
|
PROP_ROLE,
|
|
|
|
PROP_MUTE,
|
2018-02-06 18:10:49 +00:00
|
|
|
PROP_DEVICE,
|
2018-02-06 23:18:58 +00:00
|
|
|
PROP_EXCLUSIVE,
|
|
|
|
PROP_LOW_LATENCY
|
2018-01-21 03:32:30 +00:00
|
|
|
};
|
2008-09-30 11:19:10 +00:00
|
|
|
|
|
|
|
static void gst_wasapi_sink_dispose (GObject * object);
|
|
|
|
static void gst_wasapi_sink_finalize (GObject * object);
|
2018-01-21 03:32:30 +00:00
|
|
|
static void gst_wasapi_sink_set_property (GObject * object, guint prop_id,
|
|
|
|
const GValue * value, GParamSpec * pspec);
|
|
|
|
static void gst_wasapi_sink_get_property (GObject * object, guint prop_id,
|
|
|
|
GValue * value, GParamSpec * pspec);
|
2008-09-30 11:19:10 +00:00
|
|
|
|
2013-03-27 09:10:21 +00:00
|
|
|
static GstCaps *gst_wasapi_sink_get_caps (GstBaseSink * bsink,
|
|
|
|
GstCaps * filter);
|
2018-01-21 03:32:30 +00:00
|
|
|
|
2013-03-27 09:10:21 +00:00
|
|
|
static gboolean gst_wasapi_sink_prepare (GstAudioSink * asink,
|
|
|
|
GstAudioRingBufferSpec * spec);
|
|
|
|
static gboolean gst_wasapi_sink_unprepare (GstAudioSink * asink);
|
|
|
|
static gboolean gst_wasapi_sink_open (GstAudioSink * asink);
|
|
|
|
static gboolean gst_wasapi_sink_close (GstAudioSink * asink);
|
|
|
|
static gint gst_wasapi_sink_write (GstAudioSink * asink,
|
|
|
|
gpointer data, guint length);
|
|
|
|
static guint gst_wasapi_sink_delay (GstAudioSink * asink);
|
|
|
|
static void gst_wasapi_sink_reset (GstAudioSink * asink);
|
2008-09-30 11:19:10 +00:00
|
|
|
|
2018-01-21 03:32:30 +00:00
|
|
|
#define gst_wasapi_sink_parent_class parent_class
|
2013-03-27 09:10:21 +00:00
|
|
|
G_DEFINE_TYPE (GstWasapiSink, gst_wasapi_sink, GST_TYPE_AUDIO_SINK);
|
2008-09-30 11:19:10 +00:00
|
|
|
|
|
|
|
static void
|
|
|
|
gst_wasapi_sink_class_init (GstWasapiSinkClass * klass)
|
|
|
|
{
|
|
|
|
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
|
2013-03-26 14:22:16 +00:00
|
|
|
GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
|
2008-09-30 11:19:10 +00:00
|
|
|
GstBaseSinkClass *gstbasesink_class = GST_BASE_SINK_CLASS (klass);
|
2013-03-27 09:10:21 +00:00
|
|
|
GstAudioSinkClass *gstaudiosink_class = GST_AUDIO_SINK_CLASS (klass);
|
2008-09-30 11:19:10 +00:00
|
|
|
|
|
|
|
gobject_class->dispose = gst_wasapi_sink_dispose;
|
|
|
|
gobject_class->finalize = gst_wasapi_sink_finalize;
|
2018-01-21 03:32:30 +00:00
|
|
|
gobject_class->set_property = gst_wasapi_sink_set_property;
|
|
|
|
gobject_class->get_property = gst_wasapi_sink_get_property;
|
|
|
|
|
|
|
|
g_object_class_install_property (gobject_class,
|
|
|
|
PROP_ROLE,
|
|
|
|
g_param_spec_enum ("role", "Role",
|
|
|
|
"Role of the device: communications, multimedia, etc",
|
|
|
|
GST_WASAPI_DEVICE_TYPE_ROLE, DEFAULT_ROLE, G_PARAM_READWRITE |
|
|
|
|
G_PARAM_STATIC_STRINGS | GST_PARAM_MUTABLE_READY));
|
|
|
|
|
|
|
|
g_object_class_install_property (gobject_class,
|
|
|
|
PROP_MUTE,
|
|
|
|
g_param_spec_boolean ("mute", "Mute", "Mute state of this stream",
|
|
|
|
DEFAULT_MUTE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
|
|
|
|
GST_PARAM_MUTABLE_PLAYING));
|
|
|
|
|
|
|
|
g_object_class_install_property (gobject_class,
|
|
|
|
PROP_DEVICE,
|
|
|
|
g_param_spec_string ("device", "Device",
|
|
|
|
"WASAPI playback device as a GUID string",
|
|
|
|
NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
|
2008-09-30 11:19:10 +00:00
|
|
|
|
2018-02-06 18:10:49 +00:00
|
|
|
g_object_class_install_property (gobject_class,
|
|
|
|
PROP_EXCLUSIVE,
|
|
|
|
g_param_spec_boolean ("exclusive", "Exclusive mode",
|
|
|
|
"Open the device in exclusive mode",
|
|
|
|
DEFAULT_EXCLUSIVE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
|
|
|
|
|
2018-02-06 23:18:58 +00:00
|
|
|
g_object_class_install_property (gobject_class,
|
|
|
|
PROP_LOW_LATENCY,
|
|
|
|
g_param_spec_boolean ("low-latency", "Low latency",
|
|
|
|
"Optimize all settings for lowest latency",
|
|
|
|
DEFAULT_LOW_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
|
|
|
|
|
2016-03-04 06:50:26 +00:00
|
|
|
gst_element_class_add_static_pad_template (gstelement_class, &sink_template);
|
2013-03-26 14:22:16 +00:00
|
|
|
gst_element_class_set_static_metadata (gstelement_class, "WasapiSrc",
|
|
|
|
"Sink/Audio",
|
|
|
|
"Stream audio to an audio capture device through WASAPI",
|
|
|
|
"Ole André Vadla Ravnås <ole.andre.ravnas@tandberg.com>");
|
|
|
|
|
2013-03-27 09:10:21 +00:00
|
|
|
gstbasesink_class->get_caps = GST_DEBUG_FUNCPTR (gst_wasapi_sink_get_caps);
|
|
|
|
|
|
|
|
gstaudiosink_class->prepare = GST_DEBUG_FUNCPTR (gst_wasapi_sink_prepare);
|
|
|
|
gstaudiosink_class->unprepare = GST_DEBUG_FUNCPTR (gst_wasapi_sink_unprepare);
|
|
|
|
gstaudiosink_class->open = GST_DEBUG_FUNCPTR (gst_wasapi_sink_open);
|
|
|
|
gstaudiosink_class->close = GST_DEBUG_FUNCPTR (gst_wasapi_sink_close);
|
|
|
|
gstaudiosink_class->write = GST_DEBUG_FUNCPTR (gst_wasapi_sink_write);
|
|
|
|
gstaudiosink_class->delay = GST_DEBUG_FUNCPTR (gst_wasapi_sink_delay);
|
|
|
|
gstaudiosink_class->reset = GST_DEBUG_FUNCPTR (gst_wasapi_sink_reset);
|
2008-09-30 11:19:10 +00:00
|
|
|
|
|
|
|
GST_DEBUG_CATEGORY_INIT (gst_wasapi_sink_debug, "wasapisink",
|
|
|
|
0, "Windows audio session API sink");
|
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
2013-03-26 14:22:16 +00:00
|
|
|
gst_wasapi_sink_init (GstWasapiSink * self)
|
2008-09-30 11:19:10 +00:00
|
|
|
{
|
|
|
|
self->event_handle = CreateEvent (NULL, FALSE, FALSE, NULL);
|
|
|
|
|
|
|
|
CoInitialize (NULL);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
gst_wasapi_sink_dispose (GObject * object)
|
|
|
|
{
|
|
|
|
GstWasapiSink *self = GST_WASAPI_SINK (object);
|
|
|
|
|
|
|
|
if (self->event_handle != NULL) {
|
|
|
|
CloseHandle (self->event_handle);
|
|
|
|
self->event_handle = NULL;
|
|
|
|
}
|
|
|
|
|
2018-01-24 02:50:13 +00:00
|
|
|
if (self->client != NULL) {
|
|
|
|
IUnknown_Release (self->client);
|
|
|
|
self->client = NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (self->render_client != NULL) {
|
|
|
|
IUnknown_Release (self->render_client);
|
|
|
|
self->render_client = NULL;
|
|
|
|
}
|
|
|
|
|
2013-03-26 14:22:16 +00:00
|
|
|
G_OBJECT_CLASS (gst_wasapi_sink_parent_class)->dispose (object);
|
2008-09-30 11:19:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
gst_wasapi_sink_finalize (GObject * object)
|
|
|
|
{
|
2018-01-24 02:50:13 +00:00
|
|
|
GstWasapiSink *self = GST_WASAPI_SINK (object);
|
|
|
|
|
|
|
|
g_clear_pointer (&self->mix_format, CoTaskMemFree);
|
|
|
|
|
2008-09-30 11:19:10 +00:00
|
|
|
CoUninitialize ();
|
|
|
|
|
2018-01-24 02:50:13 +00:00
|
|
|
if (self->cached_caps != NULL) {
|
|
|
|
gst_caps_unref (self->cached_caps);
|
|
|
|
self->cached_caps = NULL;
|
|
|
|
}
|
|
|
|
|
2018-01-24 02:50:38 +00:00
|
|
|
g_clear_pointer (&self->positions, g_free);
|
2018-02-06 18:07:19 +00:00
|
|
|
g_clear_pointer (&self->device_strid, g_free);
|
2018-01-24 02:50:13 +00:00
|
|
|
self->mute = FALSE;
|
|
|
|
|
2013-03-26 14:22:16 +00:00
|
|
|
G_OBJECT_CLASS (gst_wasapi_sink_parent_class)->finalize (object);
|
2008-09-30 11:19:10 +00:00
|
|
|
}
|
|
|
|
|
2018-01-21 03:32:30 +00:00
|
|
|
static void
|
|
|
|
gst_wasapi_sink_set_property (GObject * object, guint prop_id,
|
|
|
|
const GValue * value, GParamSpec * pspec)
|
|
|
|
{
|
|
|
|
GstWasapiSink *self = GST_WASAPI_SINK (object);
|
|
|
|
|
|
|
|
switch (prop_id) {
|
|
|
|
case PROP_ROLE:
|
|
|
|
self->role = gst_wasapi_device_role_to_erole (g_value_get_enum (value));
|
|
|
|
break;
|
|
|
|
case PROP_MUTE:
|
|
|
|
self->mute = g_value_get_boolean (value);
|
|
|
|
break;
|
|
|
|
case PROP_DEVICE:
|
|
|
|
{
|
2018-01-24 02:50:13 +00:00
|
|
|
const gchar *device = g_value_get_string (value);
|
2018-02-06 18:07:19 +00:00
|
|
|
g_free (self->device_strid);
|
|
|
|
self->device_strid =
|
2018-01-24 02:50:13 +00:00
|
|
|
device ? g_utf8_to_utf16 (device, -1, NULL, NULL, NULL) : NULL;
|
2018-01-21 03:32:30 +00:00
|
|
|
break;
|
|
|
|
}
|
2018-02-06 18:10:49 +00:00
|
|
|
case PROP_EXCLUSIVE:
|
|
|
|
self->sharemode = g_value_get_boolean (value)
|
|
|
|
? AUDCLNT_SHAREMODE_EXCLUSIVE : AUDCLNT_SHAREMODE_SHARED;
|
|
|
|
break;
|
2018-02-06 23:18:58 +00:00
|
|
|
case PROP_LOW_LATENCY:
|
|
|
|
self->low_latency = g_value_get_boolean (value);
|
|
|
|
break;
|
2018-01-21 03:32:30 +00:00
|
|
|
default:
|
|
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
gst_wasapi_sink_get_property (GObject * object, guint prop_id,
|
|
|
|
GValue * value, GParamSpec * pspec)
|
|
|
|
{
|
|
|
|
GstWasapiSink *self = GST_WASAPI_SINK (object);
|
|
|
|
|
|
|
|
switch (prop_id) {
|
|
|
|
case PROP_ROLE:
|
|
|
|
g_value_set_enum (value, gst_wasapi_erole_to_device_role (self->role));
|
|
|
|
break;
|
|
|
|
case PROP_MUTE:
|
|
|
|
g_value_set_boolean (value, self->mute);
|
|
|
|
break;
|
|
|
|
case PROP_DEVICE:
|
2018-02-06 18:07:19 +00:00
|
|
|
g_value_take_string (value, self->device_strid ?
|
|
|
|
g_utf16_to_utf8 (self->device_strid, -1, NULL, NULL, NULL) : NULL);
|
2018-01-21 03:32:30 +00:00
|
|
|
break;
|
2018-02-06 18:10:49 +00:00
|
|
|
case PROP_EXCLUSIVE:
|
|
|
|
g_value_set_boolean (value,
|
|
|
|
self->sharemode == AUDCLNT_SHAREMODE_EXCLUSIVE);
|
|
|
|
break;
|
2018-02-06 23:18:58 +00:00
|
|
|
case PROP_LOW_LATENCY:
|
|
|
|
g_value_set_boolean (value, self->low_latency);
|
|
|
|
break;
|
2018-01-21 03:32:30 +00:00
|
|
|
default:
|
|
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-03-27 09:10:21 +00:00
|
|
|
static GstCaps *
|
|
|
|
gst_wasapi_sink_get_caps (GstBaseSink * bsink, GstCaps * filter)
|
2008-09-30 11:19:10 +00:00
|
|
|
{
|
2018-01-21 03:32:30 +00:00
|
|
|
GstWasapiSink *self = GST_WASAPI_SINK (bsink);
|
|
|
|
WAVEFORMATEX *format = NULL;
|
|
|
|
GstCaps *caps = NULL;
|
|
|
|
|
|
|
|
GST_DEBUG_OBJECT (self, "entering get caps");
|
|
|
|
|
|
|
|
if (self->cached_caps) {
|
|
|
|
caps = gst_caps_ref (self->cached_caps);
|
|
|
|
} else {
|
|
|
|
GstCaps *template_caps;
|
2018-02-06 18:10:49 +00:00
|
|
|
gboolean ret;
|
2018-01-21 03:32:30 +00:00
|
|
|
|
|
|
|
template_caps = gst_pad_get_pad_template_caps (bsink->sinkpad);
|
|
|
|
|
|
|
|
if (!self->client)
|
|
|
|
gst_wasapi_sink_open (GST_AUDIO_SINK (bsink));
|
|
|
|
|
2018-02-06 18:10:49 +00:00
|
|
|
ret = gst_wasapi_util_get_device_format (GST_ELEMENT (self),
|
|
|
|
self->sharemode, self->device, self->client, &format);
|
|
|
|
if (!ret) {
|
2018-01-21 03:32:30 +00:00
|
|
|
GST_ELEMENT_ERROR (self, STREAM, FORMAT, (NULL),
|
2018-02-06 18:10:49 +00:00
|
|
|
("failed to detect format"));
|
2018-01-21 03:32:30 +00:00
|
|
|
goto out;
|
|
|
|
}
|
|
|
|
|
2018-01-24 02:50:38 +00:00
|
|
|
gst_wasapi_util_parse_waveformatex ((WAVEFORMATEXTENSIBLE *) format,
|
|
|
|
template_caps, &caps, &self->positions);
|
2018-01-21 03:32:30 +00:00
|
|
|
if (caps == NULL) {
|
|
|
|
GST_ELEMENT_ERROR (self, STREAM, FORMAT, (NULL), ("unknown format"));
|
|
|
|
goto out;
|
|
|
|
}
|
|
|
|
|
2018-01-24 02:50:38 +00:00
|
|
|
{
|
|
|
|
gchar *pos_str = gst_audio_channel_positions_to_string (self->positions,
|
|
|
|
format->nChannels);
|
|
|
|
GST_INFO_OBJECT (self, "positions are: %s", pos_str);
|
|
|
|
g_free (pos_str);
|
|
|
|
}
|
|
|
|
|
2018-01-21 03:32:30 +00:00
|
|
|
self->mix_format = format;
|
|
|
|
gst_caps_replace (&self->cached_caps, caps);
|
|
|
|
gst_caps_unref (template_caps);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (filter) {
|
|
|
|
GstCaps *filtered =
|
|
|
|
gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
|
|
|
|
gst_caps_unref (caps);
|
|
|
|
caps = filtered;
|
|
|
|
}
|
|
|
|
|
|
|
|
GST_DEBUG_OBJECT (self, "returning caps %" GST_PTR_FORMAT, caps);
|
|
|
|
|
|
|
|
out:
|
|
|
|
return caps;
|
2013-03-27 09:10:21 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static gboolean
|
|
|
|
gst_wasapi_sink_open (GstAudioSink * asink)
|
|
|
|
{
|
|
|
|
GstWasapiSink *self = GST_WASAPI_SINK (asink);
|
|
|
|
gboolean res = FALSE;
|
2018-02-06 18:10:49 +00:00
|
|
|
IMMDevice *device = NULL;
|
2013-03-27 09:10:21 +00:00
|
|
|
IAudioClient *client = NULL;
|
2008-09-30 11:19:10 +00:00
|
|
|
|
2018-01-21 03:32:30 +00:00
|
|
|
GST_DEBUG_OBJECT (self, "opening device");
|
|
|
|
|
|
|
|
if (self->client)
|
|
|
|
return TRUE;
|
|
|
|
|
2018-02-06 18:07:19 +00:00
|
|
|
/* FIXME: Switching the default device does not switch the stream to it,
|
|
|
|
* 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. */
|
2018-01-21 03:32:30 +00:00
|
|
|
if (!gst_wasapi_util_get_device_client (GST_ELEMENT (self), FALSE,
|
2018-02-06 18:10:49 +00:00
|
|
|
self->role, self->device_strid, &device, &client)) {
|
2018-02-06 18:07:19 +00:00
|
|
|
if (!self->device_strid)
|
|
|
|
GST_ELEMENT_ERROR (self, RESOURCE, OPEN_WRITE, (NULL),
|
2018-01-21 03:32:30 +00:00
|
|
|
("Failed to get default device"));
|
|
|
|
else
|
2018-02-06 18:07:19 +00:00
|
|
|
GST_ELEMENT_ERROR (self, RESOURCE, OPEN_WRITE, (NULL),
|
|
|
|
("Failed to open device %S", self->device_strid));
|
2013-03-27 09:10:21 +00:00
|
|
|
goto beach;
|
|
|
|
}
|
2008-09-30 11:19:10 +00:00
|
|
|
|
2013-03-27 09:10:21 +00:00
|
|
|
self->client = client;
|
2018-02-06 18:10:49 +00:00
|
|
|
self->device = device;
|
2013-03-27 09:10:21 +00:00
|
|
|
res = TRUE;
|
|
|
|
|
|
|
|
beach:
|
|
|
|
|
|
|
|
return res;
|
|
|
|
}
|
|
|
|
|
|
|
|
static gboolean
|
|
|
|
gst_wasapi_sink_close (GstAudioSink * asink)
|
|
|
|
{
|
|
|
|
GstWasapiSink *self = GST_WASAPI_SINK (asink);
|
2008-09-30 11:19:10 +00:00
|
|
|
|
2018-02-06 18:10:49 +00:00
|
|
|
if (self->device != NULL) {
|
|
|
|
IUnknown_Release (self->device);
|
|
|
|
self->device = NULL;
|
|
|
|
}
|
|
|
|
|
2013-03-27 09:10:21 +00:00
|
|
|
if (self->client != NULL) {
|
|
|
|
IUnknown_Release (self->client);
|
|
|
|
self->client = NULL;
|
2008-09-30 11:19:10 +00:00
|
|
|
}
|
2013-03-27 09:10:21 +00:00
|
|
|
|
|
|
|
return TRUE;
|
2008-09-30 11:19:10 +00:00
|
|
|
}
|
|
|
|
|
2018-02-07 21:39:26 +00:00
|
|
|
/* Get the empty space in the buffer that we have to write to */
|
|
|
|
static gint
|
|
|
|
gst_wasapi_sink_get_can_frames (GstWasapiSink * self)
|
|
|
|
{
|
|
|
|
HRESULT hr;
|
|
|
|
guint n_frames_padding;
|
|
|
|
|
|
|
|
/* There is no padding in exclusive mode since there is no ringbuffer */
|
|
|
|
if (self->sharemode == AUDCLNT_SHAREMODE_EXCLUSIVE) {
|
|
|
|
GST_DEBUG_OBJECT (self, "exclusive mode, can write: %i",
|
|
|
|
self->buffer_frame_count);
|
|
|
|
return self->buffer_frame_count;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Frames the card hasn't rendered yet */
|
|
|
|
hr = IAudioClient_GetCurrentPadding (self->client, &n_frames_padding);
|
|
|
|
if (hr != S_OK) {
|
|
|
|
gchar *msg = gst_wasapi_util_hresult_to_string (hr);
|
|
|
|
GST_ERROR_OBJECT (self, "IAudioClient::GetCurrentPadding failed: %s", msg);
|
|
|
|
g_free (msg);
|
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
|
|
|
GST_DEBUG_OBJECT (self, "%i unread frames (padding)", n_frames_padding);
|
|
|
|
|
|
|
|
/* We can write out these many frames */
|
|
|
|
return self->buffer_frame_count - n_frames_padding;
|
|
|
|
}
|
|
|
|
|
2008-09-30 11:19:10 +00:00
|
|
|
static gboolean
|
2013-03-27 09:10:21 +00:00
|
|
|
gst_wasapi_sink_prepare (GstAudioSink * asink, GstAudioRingBufferSpec * spec)
|
2008-09-30 11:19:10 +00:00
|
|
|
{
|
2013-03-27 09:10:21 +00:00
|
|
|
GstWasapiSink *self = GST_WASAPI_SINK (asink);
|
2008-09-30 11:19:10 +00:00
|
|
|
gboolean res = FALSE;
|
2018-01-21 03:32:30 +00:00
|
|
|
REFERENCE_TIME latency_rt;
|
2018-02-06 23:18:58 +00:00
|
|
|
REFERENCE_TIME default_period, min_period;
|
|
|
|
REFERENCE_TIME device_period, device_buffer_duration;
|
2018-01-30 22:21:47 +00:00
|
|
|
guint bpf, rate;
|
|
|
|
HRESULT hr;
|
2008-09-30 11:19:10 +00:00
|
|
|
|
2018-02-06 23:18:58 +00:00
|
|
|
hr = IAudioClient_GetDevicePeriod (self->client, &default_period,
|
|
|
|
&min_period);
|
2018-01-30 22:21:47 +00:00
|
|
|
if (hr != S_OK) {
|
|
|
|
GST_ERROR_OBJECT (self, "IAudioClient::GetDevicePeriod failed");
|
2018-02-06 23:18:58 +00:00
|
|
|
return FALSE;
|
2018-01-30 22:21:47 +00:00
|
|
|
}
|
2018-02-06 23:18:58 +00:00
|
|
|
|
2018-01-30 22:21:47 +00:00
|
|
|
GST_INFO_OBJECT (self, "wasapi default period: %" G_GINT64_FORMAT
|
|
|
|
", min period: %" G_GINT64_FORMAT, default_period, min_period);
|
|
|
|
|
2018-02-07 21:41:10 +00:00
|
|
|
bpf = GST_AUDIO_INFO_BPF (&spec->info);
|
|
|
|
rate = GST_AUDIO_INFO_RATE (&spec->info);
|
|
|
|
|
2018-02-06 23:18:58 +00:00
|
|
|
if (self->low_latency) {
|
|
|
|
if (self->sharemode == AUDCLNT_SHAREMODE_SHARED) {
|
|
|
|
device_period = default_period;
|
|
|
|
device_buffer_duration = 0;
|
|
|
|
} else {
|
|
|
|
device_period = min_period;
|
|
|
|
device_buffer_duration = min_period;
|
|
|
|
}
|
2018-02-06 18:10:49 +00:00
|
|
|
} else {
|
2018-02-06 23:18:58 +00:00
|
|
|
/* Clamp values to integral multiples of an appropriate period */
|
|
|
|
gst_wasapi_util_get_best_buffer_sizes (spec,
|
|
|
|
self->sharemode == AUDCLNT_SHAREMODE_EXCLUSIVE, default_period,
|
|
|
|
min_period, &device_period, &device_buffer_duration);
|
2018-02-06 18:10:49 +00:00
|
|
|
}
|
2018-02-06 23:18:58 +00:00
|
|
|
|
|
|
|
/* For some reason, we need to call this a second time for exclusive mode */
|
|
|
|
if (self->sharemode == AUDCLNT_SHAREMODE_EXCLUSIVE)
|
|
|
|
CoInitialize (NULL);
|
|
|
|
|
|
|
|
hr = IAudioClient_Initialize (self->client, self->sharemode,
|
|
|
|
AUDCLNT_STREAMFLAGS_EVENTCALLBACK, device_buffer_duration,
|
|
|
|
/* This must always be 0 in shared mode */
|
|
|
|
self->sharemode == AUDCLNT_SHAREMODE_SHARED ? 0 : device_period,
|
|
|
|
self->mix_format, NULL);
|
2018-02-07 21:41:10 +00:00
|
|
|
|
|
|
|
if (hr == AUDCLNT_E_BUFFER_SIZE_NOT_ALIGNED &&
|
|
|
|
self->sharemode == AUDCLNT_SHAREMODE_EXCLUSIVE) {
|
|
|
|
guint32 n_frames;
|
|
|
|
|
|
|
|
GST_WARNING_OBJECT (self, "initialize failed due to unaligned period %i",
|
|
|
|
(int) device_period);
|
|
|
|
|
|
|
|
/* Calculate a new aligned period. First get the aligned buffer size. */
|
|
|
|
hr = IAudioClient_GetBufferSize (self->client, &n_frames);
|
|
|
|
if (hr != S_OK) {
|
|
|
|
gchar *msg = gst_wasapi_util_hresult_to_string (hr);
|
|
|
|
GST_ELEMENT_ERROR (self, RESOURCE, OPEN_WRITE, (NULL),
|
|
|
|
("IAudioClient::GetBufferSize() failed: %s", msg));
|
|
|
|
g_free (msg);
|
|
|
|
goto beach;
|
|
|
|
}
|
|
|
|
|
|
|
|
device_period = (GST_SECOND / 100) * n_frames / rate;
|
|
|
|
|
2018-02-08 20:35:23 +00:00
|
|
|
GST_WARNING_OBJECT (self, "trying to re-initialize with period %i "
|
|
|
|
"(%i frames, %i rate)", (int) device_period, n_frames, rate);
|
2018-02-07 21:41:10 +00:00
|
|
|
|
|
|
|
hr = IAudioClient_Initialize (self->client, self->sharemode,
|
|
|
|
AUDCLNT_STREAMFLAGS_EVENTCALLBACK, device_period,
|
|
|
|
device_period, self->mix_format, NULL);
|
|
|
|
}
|
2008-09-30 11:19:10 +00:00
|
|
|
if (hr != S_OK) {
|
2018-02-06 18:26:41 +00:00
|
|
|
gchar *msg = gst_wasapi_util_hresult_to_string (hr);
|
2018-02-06 23:18:58 +00:00
|
|
|
GST_ELEMENT_ERROR (self, RESOURCE, OPEN_WRITE, (NULL),
|
2018-02-06 18:26:41 +00:00
|
|
|
("IAudioClient::Initialize () failed: %s", msg));
|
|
|
|
g_free (msg);
|
2013-03-27 09:10:21 +00:00
|
|
|
goto beach;
|
|
|
|
}
|
|
|
|
|
2018-01-30 22:21:47 +00:00
|
|
|
/* Total size of the allocated buffer that we will write to */
|
|
|
|
hr = IAudioClient_GetBufferSize (self->client, &self->buffer_frame_count);
|
|
|
|
if (hr != S_OK) {
|
|
|
|
GST_ERROR_OBJECT (self, "IAudioClient::GetBufferSize failed");
|
|
|
|
goto beach;
|
|
|
|
}
|
|
|
|
GST_INFO_OBJECT (self, "buffer size is %i frames, bpf is %i bytes, "
|
|
|
|
"rate is %i Hz", self->buffer_frame_count, bpf, rate);
|
|
|
|
|
|
|
|
/* Actual latency-time/buffer-time are different now */
|
|
|
|
spec->segsize = gst_util_uint64_scale_int_round (rate * bpf,
|
2018-02-06 23:18:58 +00:00
|
|
|
device_period * 100, GST_SECOND);
|
2018-02-06 18:10:49 +00:00
|
|
|
|
|
|
|
/* We need a minimum of 2 segments to ensure glitch-free playback */
|
|
|
|
spec->segtotal = MAX (self->buffer_frame_count * bpf / spec->segsize, 2);
|
2018-01-30 22:21:47 +00:00
|
|
|
|
|
|
|
GST_INFO_OBJECT (self, "segsize is %i, segtotal is %i", spec->segsize,
|
|
|
|
spec->segtotal);
|
|
|
|
|
2018-01-21 03:32:30 +00:00
|
|
|
/* Get latency for logging */
|
2013-03-27 09:10:21 +00:00
|
|
|
hr = IAudioClient_GetStreamLatency (self->client, &latency_rt);
|
|
|
|
if (hr != S_OK) {
|
2018-01-21 03:32:30 +00:00
|
|
|
GST_ERROR_OBJECT (self, "IAudioClient::GetStreamLatency failed");
|
2008-09-30 11:19:10 +00:00
|
|
|
goto beach;
|
|
|
|
}
|
2018-01-21 03:32:30 +00:00
|
|
|
GST_INFO_OBJECT (self, "wasapi stream latency: %" G_GINT64_FORMAT " (%"
|
|
|
|
G_GINT64_FORMAT "ms)", latency_rt, latency_rt / 10000);
|
2008-09-30 11:19:10 +00:00
|
|
|
|
2018-01-21 03:32:30 +00:00
|
|
|
/* Set the event handler which will trigger writes */
|
2013-03-27 09:10:21 +00:00
|
|
|
hr = IAudioClient_SetEventHandle (self->client, self->event_handle);
|
2008-09-30 11:19:10 +00:00
|
|
|
if (hr != S_OK) {
|
2018-01-21 03:32:30 +00:00
|
|
|
GST_ERROR_OBJECT (self, "IAudioClient::SetEventHandle failed");
|
|
|
|
goto beach;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Get render sink client and start it up */
|
2013-03-27 09:10:21 +00:00
|
|
|
if (!gst_wasapi_util_get_render_client (GST_ELEMENT (self), self->client,
|
2018-02-08 08:57:43 +00:00
|
|
|
&self->render_client)) {
|
2013-03-27 09:10:21 +00:00
|
|
|
goto beach;
|
|
|
|
}
|
|
|
|
|
2018-01-21 03:32:30 +00:00
|
|
|
GST_INFO_OBJECT (self, "got render client");
|
|
|
|
|
2018-02-07 21:39:26 +00:00
|
|
|
/* To avoid start-up glitches, before starting the streaming, we fill the
|
|
|
|
* buffer with silence as recommended by the documentation:
|
|
|
|
* https://msdn.microsoft.com/en-us/library/windows/desktop/dd370879%28v=vs.85%29.aspx */
|
|
|
|
{
|
|
|
|
gint n_frames, len;
|
|
|
|
gint16 *dst = NULL;
|
|
|
|
|
|
|
|
n_frames = gst_wasapi_sink_get_can_frames (self);
|
|
|
|
if (n_frames < 1) {
|
|
|
|
GST_ELEMENT_ERROR (self, RESOURCE, WRITE, (NULL),
|
|
|
|
("should have more than %i frames to write", n_frames));
|
|
|
|
goto beach;
|
|
|
|
}
|
|
|
|
|
|
|
|
len = n_frames * self->mix_format->nBlockAlign;
|
|
|
|
|
2018-02-08 08:57:43 +00:00
|
|
|
hr = IAudioRenderClient_GetBuffer (self->render_client, n_frames,
|
2018-02-07 21:39:26 +00:00
|
|
|
(BYTE **) & dst);
|
|
|
|
if (hr != S_OK) {
|
|
|
|
gchar *msg = gst_wasapi_util_hresult_to_string (hr);
|
|
|
|
GST_ELEMENT_ERROR (self, RESOURCE, WRITE, (NULL),
|
|
|
|
("IAudioRenderClient::GetBuffer failed: %s", msg));
|
|
|
|
g_free (msg);
|
|
|
|
goto beach;
|
|
|
|
}
|
|
|
|
|
|
|
|
GST_DEBUG_OBJECT (self, "pre-wrote %i bytes of silence", len);
|
|
|
|
|
2018-02-08 08:57:43 +00:00
|
|
|
hr = IAudioRenderClient_ReleaseBuffer (self->render_client, n_frames,
|
2018-02-07 21:39:26 +00:00
|
|
|
AUDCLNT_BUFFERFLAGS_SILENT);
|
|
|
|
if (hr != S_OK) {
|
|
|
|
gchar *msg = gst_wasapi_util_hresult_to_string (hr);
|
|
|
|
GST_ERROR_OBJECT (self, "IAudioRenderClient::ReleaseBuffer failed: %s",
|
|
|
|
msg);
|
|
|
|
g_free (msg);
|
|
|
|
goto beach;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-03-27 09:10:21 +00:00
|
|
|
hr = IAudioClient_Start (self->client);
|
2008-09-30 11:19:10 +00:00
|
|
|
if (hr != S_OK) {
|
|
|
|
GST_ERROR_OBJECT (self, "IAudioClient::Start failed");
|
|
|
|
goto beach;
|
|
|
|
}
|
|
|
|
|
2018-02-08 06:02:32 +00:00
|
|
|
gst_audio_ring_buffer_set_channel_positions (GST_AUDIO_BASE_SINK
|
|
|
|
(self)->ringbuffer, self->positions);
|
2018-01-24 02:50:38 +00:00
|
|
|
|
2018-02-06 18:15:02 +00:00
|
|
|
#if defined(_MSC_VER) || defined(GST_FORCE_WIN_AVRT)
|
|
|
|
/* Increase the thread priority to reduce glitches */
|
|
|
|
{
|
|
|
|
DWORD taskIndex = 0;
|
|
|
|
self->thread_priority_handle =
|
|
|
|
AvSetMmThreadCharacteristics (TEXT ("Pro Audio"), &taskIndex);
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2008-09-30 11:19:10 +00:00
|
|
|
res = TRUE;
|
|
|
|
|
|
|
|
beach:
|
2018-02-08 08:57:43 +00:00
|
|
|
/* unprepare() is not called if prepare() fails, but we want it to be, so call
|
|
|
|
* it manually when needed */
|
|
|
|
if (!res)
|
|
|
|
gst_wasapi_sink_unprepare (asink);
|
2008-09-30 11:19:10 +00:00
|
|
|
|
|
|
|
return res;
|
|
|
|
}
|
|
|
|
|
|
|
|
static gboolean
|
2013-03-27 09:10:21 +00:00
|
|
|
gst_wasapi_sink_unprepare (GstAudioSink * asink)
|
2008-09-30 11:19:10 +00:00
|
|
|
{
|
2013-03-27 09:10:21 +00:00
|
|
|
GstWasapiSink *self = GST_WASAPI_SINK (asink);
|
2008-09-30 11:19:10 +00:00
|
|
|
|
2018-02-06 18:10:49 +00:00
|
|
|
if (self->sharemode == AUDCLNT_SHAREMODE_EXCLUSIVE)
|
|
|
|
CoUninitialize ();
|
|
|
|
|
2018-02-06 18:15:02 +00:00
|
|
|
#if defined(_MSC_VER) || defined(GST_FORCE_WIN_AVRT)
|
|
|
|
if (self->thread_priority_handle != NULL) {
|
|
|
|
AvRevertMmThreadCharacteristics (self->thread_priority_handle);
|
|
|
|
self->thread_priority_handle = NULL;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2008-09-30 11:19:10 +00:00
|
|
|
if (self->client != NULL) {
|
|
|
|
IAudioClient_Stop (self->client);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (self->render_client != NULL) {
|
|
|
|
IUnknown_Release (self->render_client);
|
|
|
|
self->render_client = NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
return TRUE;
|
|
|
|
}
|
|
|
|
|
2013-03-27 09:10:21 +00:00
|
|
|
static gint
|
|
|
|
gst_wasapi_sink_write (GstAudioSink * asink, gpointer data, guint length)
|
2008-09-30 11:19:10 +00:00
|
|
|
{
|
2013-03-27 09:10:21 +00:00
|
|
|
GstWasapiSink *self = GST_WASAPI_SINK (asink);
|
2008-09-30 11:19:10 +00:00
|
|
|
HRESULT hr;
|
|
|
|
gint16 *dst = NULL;
|
2018-01-21 03:32:30 +00:00
|
|
|
guint pending = length;
|
2013-03-26 14:22:16 +00:00
|
|
|
|
2018-01-21 03:32:30 +00:00
|
|
|
while (pending > 0) {
|
2018-02-07 21:39:26 +00:00
|
|
|
guint can_frames, have_frames, n_frames, write_len;
|
2008-09-30 11:19:10 +00:00
|
|
|
|
2018-01-21 03:32:30 +00:00
|
|
|
WaitForSingleObject (self->event_handle, INFINITE);
|
2008-09-30 11:19:10 +00:00
|
|
|
|
2018-02-07 21:39:26 +00:00
|
|
|
/* We have N frames to be written out */
|
|
|
|
have_frames = pending / (self->mix_format->nBlockAlign);
|
|
|
|
/* We have can_frames space in the output buffer */
|
|
|
|
can_frames = gst_wasapi_sink_get_can_frames (self);
|
|
|
|
/* We will write out these many frames, and this much length */
|
|
|
|
n_frames = MIN (can_frames, have_frames);
|
2018-01-21 03:32:30 +00:00
|
|
|
write_len = n_frames * self->mix_format->nBlockAlign;
|
|
|
|
|
2018-02-07 21:39:26 +00:00
|
|
|
GST_DEBUG_OBJECT (self, "total: %i, have_frames: %i (%i bytes), "
|
|
|
|
"can_frames: %i, will write: %i (%i bytes)", self->buffer_frame_count,
|
|
|
|
have_frames, pending, can_frames, n_frames, write_len);
|
|
|
|
|
2018-01-21 03:32:30 +00:00
|
|
|
hr = IAudioRenderClient_GetBuffer (self->render_client, n_frames,
|
|
|
|
(BYTE **) & dst);
|
|
|
|
if (hr != S_OK) {
|
2018-02-06 18:26:41 +00:00
|
|
|
gchar *msg = gst_wasapi_util_hresult_to_string (hr);
|
2018-01-21 03:32:30 +00:00
|
|
|
GST_ELEMENT_ERROR (self, RESOURCE, WRITE, (NULL),
|
2018-02-06 18:26:41 +00:00
|
|
|
("IAudioRenderClient::GetBuffer failed: %s", msg));
|
|
|
|
g_free (msg);
|
2018-01-21 03:32:30 +00:00
|
|
|
length = 0;
|
|
|
|
goto beach;
|
|
|
|
}
|
|
|
|
|
|
|
|
memcpy (dst, data, write_len);
|
|
|
|
|
|
|
|
hr = IAudioRenderClient_ReleaseBuffer (self->render_client, n_frames,
|
|
|
|
self->mute ? AUDCLNT_BUFFERFLAGS_SILENT : 0);
|
|
|
|
if (hr != S_OK) {
|
2018-02-06 18:26:41 +00:00
|
|
|
gchar *msg = gst_wasapi_util_hresult_to_string (hr);
|
2018-01-21 03:32:30 +00:00
|
|
|
GST_ERROR_OBJECT (self, "IAudioRenderClient::ReleaseBuffer failed: %s",
|
2018-02-06 18:26:41 +00:00
|
|
|
msg);
|
|
|
|
g_free (msg);
|
2018-01-21 03:32:30 +00:00
|
|
|
length = 0;
|
|
|
|
goto beach;
|
|
|
|
}
|
|
|
|
|
|
|
|
pending -= write_len;
|
2008-09-30 11:19:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
beach:
|
2013-03-26 14:22:16 +00:00
|
|
|
|
2013-03-27 09:10:21 +00:00
|
|
|
return length;
|
|
|
|
}
|
|
|
|
|
|
|
|
static guint
|
|
|
|
gst_wasapi_sink_delay (GstAudioSink * asink)
|
|
|
|
{
|
2018-01-21 03:32:30 +00:00
|
|
|
GstWasapiSink *self = GST_WASAPI_SINK (asink);
|
|
|
|
guint delay = 0;
|
|
|
|
HRESULT hr;
|
|
|
|
|
|
|
|
hr = IAudioClient_GetCurrentPadding (self->client, &delay);
|
|
|
|
if (hr != S_OK) {
|
2018-02-06 18:26:41 +00:00
|
|
|
gchar *msg = gst_wasapi_util_hresult_to_string (hr);
|
2018-01-21 03:32:30 +00:00
|
|
|
GST_ELEMENT_ERROR (self, RESOURCE, READ, (NULL),
|
2018-02-06 18:26:41 +00:00
|
|
|
("IAudioClient::GetCurrentPadding failed %s", msg));
|
|
|
|
g_free (msg);
|
2018-01-21 03:32:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return delay;
|
2013-03-27 09:10:21 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
gst_wasapi_sink_reset (GstAudioSink * asink)
|
|
|
|
{
|
|
|
|
GstWasapiSink *self = GST_WASAPI_SINK (asink);
|
|
|
|
HRESULT hr;
|
|
|
|
|
|
|
|
if (self->client) {
|
|
|
|
hr = IAudioClient_Stop (self->client);
|
|
|
|
if (hr != S_OK) {
|
2018-02-06 18:26:41 +00:00
|
|
|
gchar *msg = gst_wasapi_util_hresult_to_string (hr);
|
|
|
|
GST_ERROR_OBJECT (self, "IAudioClient::Stop () failed: %s", msg);
|
|
|
|
g_free (msg);
|
2013-03-27 09:10:21 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
hr = IAudioClient_Reset (self->client);
|
|
|
|
if (hr != S_OK) {
|
2018-02-06 18:26:41 +00:00
|
|
|
gchar *msg = gst_wasapi_util_hresult_to_string (hr);
|
|
|
|
GST_ERROR_OBJECT (self, "IAudioClient::Reset () failed: %s", msg);
|
|
|
|
g_free (msg);
|
2013-03-27 09:10:21 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
2008-09-30 11:19:10 +00:00
|
|
|
}
|