2 * empathy-gst-audio-sink.c - Source for EmpathyGstAudioSink
3 * Copyright (C) 2008 Collabora Ltd.
4 * @author Sjoerd Simons <sjoerd.simons@collabora.co.uk>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
26 #include <gst/audio/audio.h>
27 #include <gst/interfaces/streamvolume.h>
29 #include <telepathy-glib/telepathy-glib.h>
31 #include <libempathy-gtk/empathy-call-utils.h>
33 #include "empathy-audio-sink.h"
35 #define DEBUG_FLAG EMPATHY_DEBUG_VOIP
36 #include <libempathy/empathy-debug.h>
38 G_DEFINE_TYPE(EmpathyGstAudioSink, empathy_audio_sink, GST_TYPE_BIN)
47 static guint signals[LAST_SIGNAL] = {0};
50 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE(
54 GST_STATIC_CAPS ( GST_AUDIO_INT_PAD_TEMPLATE_CAPS " ; "
55 GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS)
62 struct _EmpathyGstAudioSinkPrivate
68 GStaticMutex volume_mutex;
71 #define EMPATHY_GST_AUDIO_SINK_GET_PRIVATE(o) \
72 (G_TYPE_INSTANCE_GET_PRIVATE ((o), EMPATHY_TYPE_GST_AUDIO_SINK, \
73 EmpathyGstAudioSinkPrivate))
76 empathy_audio_sink_init (EmpathyGstAudioSink *self)
78 self->priv = EMPATHY_GST_AUDIO_SINK_GET_PRIVATE (self);
79 self->priv->echo_cancel = TRUE;
80 g_static_mutex_init (&self->priv->volume_mutex);
83 static GstPad * empathy_audio_sink_request_new_pad (GstElement *self,
84 GstPadTemplate *templ,
87 static void empathy_audio_sink_release_pad (GstElement *self,
91 empathy_audio_sink_set_property (GObject *object,
92 guint property_id, const GValue *value, GParamSpec *pspec)
94 EmpathyGstAudioSink *self = EMPATHY_GST_AUDIO_SINK (object);
98 g_static_mutex_lock (&self->priv->volume_mutex);
99 self->priv->volume = g_value_get_double (value);
100 g_static_mutex_unlock (&self->priv->volume_mutex);
103 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
108 empathy_audio_sink_get_property (GObject *object,
109 guint property_id, GValue *value, GParamSpec *pspec)
111 EmpathyGstAudioSink *self = EMPATHY_GST_AUDIO_SINK (object);
115 g_value_set_double (value, self->priv->volume);
118 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
123 empathy_audio_sink_dispose (GObject *object)
125 EmpathyGstAudioSink *self = EMPATHY_GST_AUDIO_SINK (object);
126 EmpathyGstAudioSinkPrivate *priv = self->priv;
128 if (priv->volume_idle_id != 0)
129 g_source_remove (priv->volume_idle_id);
130 priv->volume_idle_id = 0;
132 g_static_mutex_free (&self->priv->volume_mutex);
134 /* release any references held by the object here */
135 if (G_OBJECT_CLASS (empathy_audio_sink_parent_class)->dispose)
136 G_OBJECT_CLASS (empathy_audio_sink_parent_class)->dispose (object);
140 empathy_audio_sink_class_init (EmpathyGstAudioSinkClass
141 *empathy_audio_sink_class)
143 GObjectClass *object_class = G_OBJECT_CLASS (empathy_audio_sink_class);
144 GstElementClass *element_class =
145 GST_ELEMENT_CLASS (empathy_audio_sink_class);
146 GParamSpec *param_spec;
148 gst_element_class_add_pad_template (element_class,
149 gst_static_pad_template_get (&sink_template));
151 g_type_class_add_private (empathy_audio_sink_class,
152 sizeof (EmpathyGstAudioSinkPrivate));
154 object_class->set_property = empathy_audio_sink_set_property;
155 object_class->get_property = empathy_audio_sink_get_property;
156 object_class->dispose = empathy_audio_sink_dispose;
158 element_class->request_new_pad = empathy_audio_sink_request_new_pad;
159 element_class->release_pad = empathy_audio_sink_release_pad;
161 param_spec = g_param_spec_double ("volume", "Volume", "volume control",
163 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
164 g_object_class_install_property (object_class, PROP_VOLUME, param_spec);
168 empathy_audio_sink_new (void)
170 static gboolean registered = FALSE;
173 if (!gst_element_register (NULL, "empathyaudiosink",
174 GST_RANK_NONE, EMPATHY_TYPE_GST_AUDIO_SINK))
178 return gst_element_factory_make ("empathyaudiosink", NULL);
182 empathy_audio_sink_set_volume (EmpathyGstAudioSink *sink, gdouble volume)
184 g_object_set (sink, "volume", volume, NULL);
188 empathy_audio_sink_get_volume (EmpathyGstAudioSink *sink)
190 EmpathyGstAudioSinkPrivate *priv = EMPATHY_GST_AUDIO_SINK_GET_PRIVATE (sink);
196 create_sink (EmpathyGstAudioSink *self)
199 const gchar *description;
201 description = g_getenv ("EMPATHY_AUDIO_SINK");
203 if (description != NULL)
205 GError *error = NULL;
207 sink = gst_parse_bin_from_description (description, TRUE, &error);
210 DEBUG ("Failed to create bin %s: %s", description, error->message);
211 g_error_free (error);
217 /* Use pulsesink as default */
218 sink = gst_element_factory_make ("pulsesink", NULL);
222 empathy_call_set_stream_properties (sink, self->priv->echo_cancel);
224 /* Set latency (buffering on the PulseAudio side) of 40ms and transfer data
227 "buffer-time", (gint64) 40000,
228 "latency-time", (gint64) 10000,
235 empathy_audio_sink_volume_idle_updated (gpointer user_data)
237 EmpathyGstAudioSink *self = EMPATHY_GST_AUDIO_SINK (user_data);
239 g_static_mutex_lock (&self->priv->volume_mutex);
240 self->priv->volume_idle_id = 0;
241 g_static_mutex_unlock (&self->priv->volume_mutex);
243 g_object_notify (G_OBJECT (self), "volume");
249 empathy_audio_sink_volume_updated (GObject *object,
253 EmpathyGstAudioSink *self = EMPATHY_GST_AUDIO_SINK (user_data);
256 g_static_mutex_lock (&self->priv->volume_mutex);
258 g_object_get (object, "volume", &volume, NULL);
259 if (self->priv->volume == volume)
262 self->priv->volume = volume;
263 if (self->priv->volume_idle_id == 0)
264 self->priv->volume_idle_id = g_idle_add (
265 empathy_audio_sink_volume_idle_updated, self);
268 g_static_mutex_unlock (&self->priv->volume_mutex);
272 empathy_audio_sink_volume_idle_setup (gpointer user_data)
274 EmpathyGstAudioSink *self = EMPATHY_GST_AUDIO_SINK (user_data);
277 g_static_mutex_lock (&self->priv->volume_mutex);
278 self->priv->volume_idle_id = 0;
279 g_static_mutex_unlock (&self->priv->volume_mutex);
281 /* We can't do a bidirection bind as the ::notify comes from another
282 * thread, for other bits of empathy it's most simpler if it comes from
284 g_object_bind_property (self, "volume", self->priv->sink, "volume",
287 /* sync and callback for bouncing */
288 g_object_get (self->priv->sink, "volume", &volume, NULL);
289 g_object_set (self, "volume", volume, NULL);
290 g_signal_connect (self->priv->sink, "notify::volume",
291 G_CALLBACK (empathy_audio_sink_volume_updated), self);
297 empathy_audio_sink_request_new_pad (GstElement *element,
298 GstPadTemplate *templ,
301 EmpathyGstAudioSink *self = EMPATHY_GST_AUDIO_SINK (element);
302 GstElement *bin, *resample, *audioconvert0, *audioconvert1;
304 GstPad *subpad, *filterpad;
306 bin = gst_bin_new (NULL);
308 audioconvert0 = gst_element_factory_make ("audioconvert", NULL);
309 if (audioconvert0 == NULL)
312 gst_bin_add (GST_BIN (bin), audioconvert0);
314 resample = gst_element_factory_make ("audioresample", NULL);
315 if (resample == NULL)
318 gst_bin_add (GST_BIN (bin), resample);
320 audioconvert1 = gst_element_factory_make ("audioconvert", NULL);
321 if (audioconvert1 == NULL)
324 gst_bin_add (GST_BIN (bin), audioconvert1);
326 self->priv->sink = create_sink (self);
327 if (self->priv->sink == NULL)
330 if (GST_IS_STREAM_VOLUME (self->priv->sink))
332 g_static_mutex_lock (&self->priv->volume_mutex);
333 if (self->priv->volume_idle_id == 0)
334 self->priv->volume_idle_id = g_idle_add (
335 empathy_audio_sink_volume_idle_setup, self);
336 g_static_mutex_unlock (&self->priv->volume_mutex);
340 gchar *n = gst_element_get_name (self->priv->sink);
342 DEBUG ("Element %s doesn't support volume", n);
346 gst_bin_add (GST_BIN (bin), self->priv->sink);
348 if (!gst_element_link_many (audioconvert0, resample, audioconvert1,
349 self->priv->sink, NULL))
352 filterpad = gst_element_get_static_pad (audioconvert0, "sink");
354 if (filterpad == NULL)
357 subpad = gst_ghost_pad_new ("sink", filterpad);
358 if (!gst_element_add_pad (GST_ELEMENT (bin), subpad))
361 gst_bin_add (GST_BIN (self), bin);
363 pad = gst_ghost_pad_new (name, subpad);
364 g_assert (pad != NULL);
366 if (!gst_element_sync_state_with_parent (bin))
369 if (!gst_pad_set_active (pad, TRUE))
372 if (!gst_element_add_pad (GST_ELEMENT (self), pad))
380 gst_object_unref (pad);
383 gst_object_unref (bin);
384 g_warning ("Failed to create output subpipeline");
389 empathy_audio_sink_release_pad (GstElement *element,
392 gst_pad_set_active (pad, FALSE);
393 gst_element_remove_pad (element, pad);
397 empathy_audio_sink_set_echo_cancel (EmpathyGstAudioSink *sink,
398 gboolean echo_cancel)
400 DEBUG ("Sink echo cancellation setting: %s", echo_cancel ? "on" : "off");
401 sink->priv->echo_cancel = echo_cancel;
402 if (sink->priv->sink != NULL)
403 empathy_call_set_stream_properties (sink->priv->sink,
404 sink->priv->echo_cancel);