2 * empathy-gst-audio-src.c - Source for EmpathyGstAudioSrc
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
24 #include <gst/audio/streamvolume.h>
26 #include <gst/interfaces/streamvolume.h>
29 #include "libempathy/empathy-utils.h"
30 #include "empathy-audio-utils.h"
32 #include "empathy-audio-src.h"
33 #include "empathy-mic-monitor.h"
35 #define DEBUG_FLAG EMPATHY_DEBUG_VOIP
36 #include "libempathy/empathy-debug.h"
38 G_DEFINE_TYPE(EmpathyGstAudioSrc, empathy_audio_src, GST_TYPE_BIN)
46 /* private structure */
47 struct _EmpathyGstAudioSrcPrivate
49 gboolean dispose_has_run;
51 GstElement *volume_element;
53 EmpathyMicMonitor *mic_monitor;
55 /* 0 if not known yet */
56 guint source_output_idx;
57 /* G_MAXUINT if not known yet */
62 gboolean have_stream_volume;
68 #define EMPATHY_GST_AUDIO_SRC_GET_PRIVATE(o) \
69 (G_TYPE_INSTANCE_GET_PRIVATE ((o), EMPATHY_TYPE_GST_AUDIO_SRC, \
70 EmpathyGstAudioSrcPrivate))
74 empathy_audio_src_volume_changed (GObject *object,
79 empathy_audio_set_hw_mute (EmpathyGstAudioSrc *self, gboolean mute)
81 if (mute == self->priv->mute)
84 if (self->priv->have_stream_volume)
85 g_object_set (self->priv->src, "mute", mute, NULL);
87 /* Belt and braces: If for some reason the underlying src doesn't mute
88 * correctly or doesn't update us when it unmutes correctly enforce it using
89 * our own volume element. Our UI can in no circumstances be made to think
90 * the input is muted while it's not */
91 g_object_set (self->priv->volume_element, "mute", mute, NULL);
93 self->priv->mute = mute;
97 empathy_audio_src_get_hw_mute (EmpathyGstAudioSrc *self)
100 g_object_get (self->priv->src, "mute", &result, NULL);
106 empathy_audio_src_set_hw_volume (EmpathyGstAudioSrc *self,
109 if (volume == self->priv->volume)
112 if (self->priv->have_stream_volume)
113 g_object_set (self->priv->src, "volume", volume, NULL);
114 self->priv->volume = volume;
118 empathy_audio_src_get_hw_volume (EmpathyGstAudioSrc *self)
121 g_object_get (self->priv->src, "volume", &result, NULL);
128 empathy_audio_src_supports_changing_mic (EmpathyGstAudioSrc *self)
130 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
131 GObjectClass *object_class;
133 object_class = G_OBJECT_GET_CLASS (priv->src);
135 return (g_object_class_find_property (object_class,
136 "source-output-index") != NULL);
140 empathy_audio_src_get_mic_index (EmpathyGstAudioSrc *self)
142 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
143 guint audio_src_idx = PA_INVALID_INDEX;
145 if (empathy_audio_src_supports_changing_mic (self))
146 g_object_get (priv->src,
147 "source-output-index", &audio_src_idx,
150 return audio_src_idx;
154 empathy_audio_src_microphone_changed_cb (EmpathyMicMonitor *monitor,
155 guint source_output_idx,
159 EmpathyGstAudioSrc *self = user_data;
160 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
163 audio_src_idx = empathy_audio_src_get_mic_index (self);
165 if (source_output_idx == PA_INVALID_INDEX
166 || source_output_idx != audio_src_idx)
169 if (priv->source_idx == source_idx)
172 priv->source_idx = source_idx;
173 g_object_notify (G_OBJECT (self), "microphone");
177 empathy_audio_src_get_current_mic_cb (GObject *source_object,
178 GAsyncResult *result,
181 EmpathyMicMonitor *monitor = EMPATHY_MIC_MONITOR (source_object);
182 EmpathyGstAudioSrc *self = user_data;
183 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
185 GError *error = NULL;
187 source_idx = empathy_mic_monitor_get_current_mic_finish (monitor, result, &error);
191 DEBUG ("Failed to get current mic: %s", error->message);
192 g_clear_error (&error);
196 if (priv->source_idx == source_idx)
199 priv->source_idx = source_idx;
200 g_object_notify (G_OBJECT (self), "microphone");
204 empathy_audio_src_source_output_index_notify (GObject *object,
206 EmpathyGstAudioSrc *self)
208 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
209 guint source_output_idx;
211 source_output_idx = empathy_audio_src_get_mic_index (self);
213 if (source_output_idx == PA_INVALID_INDEX)
216 if (priv->source_output_idx == source_output_idx)
219 /* It's actually changed. */
220 priv->source_output_idx = source_output_idx;
222 empathy_mic_monitor_get_current_mic_async (priv->mic_monitor,
223 source_output_idx, empathy_audio_src_get_current_mic_cb, self);
230 const gchar *description;
232 description = g_getenv ("EMPATHY_AUDIO_SRC");
234 if (description != NULL)
236 GError *error = NULL;
238 src = gst_parse_bin_from_description (description, TRUE, &error);
241 DEBUG ("Failed to create bin %s: %s", description, error->message);
242 g_error_free (error);
248 /* Use pulsesrc as default */
249 src = gst_element_factory_make ("pulsesrc", NULL);
252 g_warning ("Missing 'pulsesrc' element");
256 empathy_audio_set_stream_properties (src, TRUE);
258 /* Set latency (buffering on the PulseAudio side) of 20ms */
259 g_object_set (src, "buffer-time", (gint64) 20000, NULL);
265 empathy_audio_src_init (EmpathyGstAudioSrc *obj)
267 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (obj);
271 g_mutex_init (&priv->lock);
275 priv->src = create_src ();
276 if (priv->src == NULL)
279 if (GST_IS_STREAM_VOLUME (priv->src))
284 priv->have_stream_volume = TRUE;
285 /* We can't do a bidirection bind as the ::notify comes from another
286 * thread, for other bits of empathy it's most simpler if it comes from
288 g_object_bind_property (obj, "volume", priv->src, "volume",
290 g_object_bind_property (obj, "mute", priv->src, "mute",
293 /* sync and callback for bouncing */
294 g_object_get (priv->src, "volume", &volume, NULL);
295 g_object_set (obj, "volume", volume, NULL);
297 g_object_get (priv->src, "mute", &mute, NULL);
298 g_object_set (obj, "mute", mute, NULL);
300 g_signal_connect (priv->src, "notify::volume",
301 G_CALLBACK (empathy_audio_src_volume_changed), obj);
302 g_signal_connect (priv->src, "notify::mute",
303 G_CALLBACK (empathy_audio_src_volume_changed), obj);
307 g_message ("No stream volume available :(, mute will work though");
308 priv->have_stream_volume = FALSE;
311 gst_bin_add (GST_BIN (obj), priv->src);
313 priv->volume_element = gst_element_factory_make ("volume", NULL);
314 gst_bin_add (GST_BIN (obj), priv->volume_element);
318 GstElement *capsfilter;
321 /* Explicitly state what format we want from pulsesrc. This pushes resampling
322 * and format conversion as early as possible, lowering the amount of data
323 * transferred and thus improving performance. When moving to GStreamer
324 * 0.11/1.0, this should change so that we actually request what the encoder
325 * wants downstream. */
326 caps = gst_caps_new_simple ("audio/x-raw-int",
327 "channels", G_TYPE_INT, 1,
328 "width", G_TYPE_INT, 16,
329 "depth", G_TYPE_INT, 16,
330 "rate", G_TYPE_INT, 32000,
332 capsfilter = gst_element_factory_make ("capsfilter", NULL);
333 g_object_set (G_OBJECT (capsfilter), "caps", caps, NULL);
334 gst_bin_add (GST_BIN (obj), capsfilter);
335 gst_element_link (priv->src, capsfilter);
336 gst_element_link (capsfilter, priv->volume_element);
339 gst_element_link (priv->src, priv->volume_element);
342 src = gst_element_get_static_pad (priv->volume_element, "src");
344 ghost = gst_ghost_pad_new ("src", src);
345 gst_element_add_pad (GST_ELEMENT (obj), ghost);
347 gst_object_unref (G_OBJECT (src));
349 /* Listen to changes to GstPulseSrc:source-output-index so we know when
350 * it's no longer PA_INVALID_INDEX (starting for the first time) or if it
351 * changes (READY->NULL->READY...) */
352 g_signal_connect (priv->src, "notify::source-output-index",
353 G_CALLBACK (empathy_audio_src_source_output_index_notify),
356 priv->mic_monitor = empathy_mic_monitor_new ();
357 g_signal_connect (priv->mic_monitor, "microphone-changed",
358 G_CALLBACK (empathy_audio_src_microphone_changed_cb), obj);
360 priv->source_idx = PA_INVALID_INDEX;
363 static void empathy_audio_src_dispose (GObject *object);
364 static void empathy_audio_src_finalize (GObject *object);
367 empathy_audio_src_set_property (GObject *object,
368 guint property_id, const GValue *value, GParamSpec *pspec)
373 empathy_audio_src_set_hw_volume (EMPATHY_GST_AUDIO_SRC (object),
374 g_value_get_double (value));
377 empathy_audio_set_hw_mute (EMPATHY_GST_AUDIO_SRC (object),
378 g_value_get_boolean (value));
381 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
386 empathy_audio_src_get_property (GObject *object,
387 guint property_id, GValue *value, GParamSpec *pspec)
389 EmpathyGstAudioSrc *self = EMPATHY_GST_AUDIO_SRC (object);
390 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
395 g_value_set_double (value, priv->volume);
398 g_value_set_boolean (value, priv->mute);
400 case PROP_MICROPHONE:
401 g_value_set_uint (value, priv->source_idx);
404 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
409 empathy_audio_src_class_init (EmpathyGstAudioSrcClass
410 *empathy_audio_src_class)
412 GObjectClass *object_class = G_OBJECT_CLASS (empathy_audio_src_class);
413 GParamSpec *param_spec;
415 g_type_class_add_private (empathy_audio_src_class,
416 sizeof (EmpathyGstAudioSrcPrivate));
418 object_class->dispose = empathy_audio_src_dispose;
419 object_class->finalize = empathy_audio_src_finalize;
421 object_class->set_property = empathy_audio_src_set_property;
422 object_class->get_property = empathy_audio_src_get_property;
424 param_spec = g_param_spec_double ("volume", "Volume", "volume contol",
426 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
427 g_object_class_install_property (object_class, PROP_VOLUME, param_spec);
429 param_spec = g_param_spec_boolean ("mute", "Mute", "mute contol",
431 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
432 g_object_class_install_property (object_class, PROP_MUTE, param_spec);
434 param_spec = g_param_spec_uint ("microphone", "microphone", "microphone",
435 0, G_MAXUINT, G_MAXUINT,
436 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
437 g_object_class_install_property (object_class, PROP_MICROPHONE, param_spec);
441 empathy_audio_src_dispose (GObject *object)
443 EmpathyGstAudioSrc *self = EMPATHY_GST_AUDIO_SRC (object);
444 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
446 if (priv->dispose_has_run)
449 priv->dispose_has_run = TRUE;
451 if (priv->volume_idle_id != 0)
452 g_source_remove (priv->volume_idle_id);
453 priv->volume_idle_id = 0;
455 tp_clear_object (&priv->mic_monitor);
457 /* release any references held by the object here */
459 if (G_OBJECT_CLASS (empathy_audio_src_parent_class)->dispose)
460 G_OBJECT_CLASS (empathy_audio_src_parent_class)->dispose (object);
464 empathy_audio_src_finalize (GObject *object)
466 EmpathyGstAudioSrc *self = EMPATHY_GST_AUDIO_SRC (object);
467 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
469 /* free any data held directly by the object here */
470 g_mutex_clear (&priv->lock);
472 G_OBJECT_CLASS (empathy_audio_src_parent_class)->finalize (object);
476 empathy_audio_src_volume_changed_idle (gpointer user_data)
478 EmpathyGstAudioSrc *self = EMPATHY_GST_AUDIO_SRC (user_data);
479 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
483 g_mutex_lock (&priv->lock);
484 priv->volume_idle_id = 0;
485 g_mutex_unlock (&priv->lock);
487 volume = empathy_audio_src_get_hw_volume (self);
489 if (volume != priv->volume)
491 priv->volume = volume;
492 g_object_notify (G_OBJECT (self), "volume");
495 mute = empathy_audio_src_get_hw_mute (self);
496 if (mute != priv->mute)
499 /* hw mute changed, follow with own volume */
500 g_object_set (self->priv->volume_element, "mute", mute, NULL);
501 g_object_notify (G_OBJECT (self), "mute");
508 empathy_audio_src_volume_changed (GObject *object,
512 EmpathyGstAudioSrc *self = EMPATHY_GST_AUDIO_SRC (user_data);
514 g_mutex_lock (&self->priv->lock);
515 if (self->priv->volume_idle_id == 0)
516 self->priv->volume_idle_id = g_idle_add (
517 empathy_audio_src_volume_changed_idle, self);
518 g_mutex_unlock (&self->priv->lock);
524 empathy_audio_src_new (void)
526 static gboolean registered = FALSE;
529 if (!gst_element_register (NULL, "empathyaudiosrc",
530 GST_RANK_NONE, EMPATHY_TYPE_GST_AUDIO_SRC))
534 return gst_element_factory_make ("empathyaudiosrc", NULL);
538 empathy_audio_src_set_echo_cancel (EmpathyGstAudioSrc *src,
541 DEBUG ("Src echo cancellation setting: %s", enable ? "on" : "off");
542 empathy_audio_set_stream_properties (src->priv->src, enable);
546 empathy_audio_src_set_volume (EmpathyGstAudioSrc *src, gdouble volume)
548 g_object_set (src, "volume", volume, NULL);
552 empathy_audio_src_get_volume (EmpathyGstAudioSrc *src)
554 return src->priv->volume;
558 empathy_audio_src_get_microphone (EmpathyGstAudioSrc *src)
560 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (src);
562 return priv->source_idx;
566 empathy_audio_src_change_microphone_cb (GObject *source_object,
567 GAsyncResult *result,
570 EmpathyMicMonitor *monitor = EMPATHY_MIC_MONITOR (source_object);
571 GSimpleAsyncResult *simple = user_data;
572 GError *error = NULL;
574 if (!empathy_mic_monitor_change_microphone_finish (monitor,
577 g_simple_async_result_take_error (simple, error);
580 g_simple_async_result_complete (simple);
581 g_object_unref (simple);
585 empathy_audio_src_change_microphone_async (EmpathyGstAudioSrc *src,
587 GAsyncReadyCallback callback,
590 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (src);
591 guint source_output_idx;
592 GSimpleAsyncResult *simple;
594 simple = g_simple_async_result_new (G_OBJECT (src), callback, user_data,
595 empathy_audio_src_change_microphone_async);
597 if (!empathy_audio_src_supports_changing_mic (src))
599 g_simple_async_result_set_error (simple, G_IO_ERROR, G_IO_ERROR_FAILED,
600 "pulsesrc is not new enough to support changing microphone");
601 g_simple_async_result_complete_in_idle (simple);
602 g_object_unref (simple);
606 source_output_idx = empathy_audio_src_get_mic_index (src);
608 if (source_output_idx == PA_INVALID_INDEX)
610 g_simple_async_result_set_error (simple, G_IO_ERROR, G_IO_ERROR_FAILED,
611 "pulsesrc is not yet PLAYING");
612 g_simple_async_result_complete_in_idle (simple);
613 g_object_unref (simple);
617 empathy_mic_monitor_change_microphone_async (priv->mic_monitor,
618 source_output_idx, microphone, empathy_audio_src_change_microphone_cb,
623 empathy_audio_src_change_microphone_finish (EmpathyGstAudioSrc *src,
624 GAsyncResult *result,
627 empathy_implement_finish_void (src,
628 empathy_audio_src_change_microphone_async);
632 empathy_audio_src_set_mute (EmpathyGstAudioSrc *self,
635 empathy_audio_set_hw_mute (self, mute);
637 g_object_notify (G_OBJECT (self), "mute");