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
26 #include <gst/interfaces/mixer.h>
28 #include <libempathy/empathy-utils.h>
29 #include <libempathy-gtk/empathy-call-utils.h>
31 #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)
48 static guint signals[LAST_SIGNAL] = {0};
58 /* private structure */
59 struct _EmpathyGstAudioSrcPrivate
61 gboolean dispose_has_run;
65 EmpathyMicMonitor *mic_monitor;
67 /* 0 if not known yet */
68 guint source_output_idx;
69 /* G_MAXUINT if not known yet */
77 /* the mixer track on src we follow and adjust */
85 #define EMPATHY_GST_AUDIO_SRC_GET_PRIVATE(o) \
86 (G_TYPE_INSTANCE_GET_PRIVATE ((o), EMPATHY_TYPE_GST_AUDIO_SRC, \
87 EmpathyGstAudioSrcPrivate))
89 /* There is no predefined maximum channels by gstreamer, just pick 32, which is
90 * the same as the pulseaudio maximum */
91 #define MAX_MIC_CHANNELS 32
94 empathy_audio_set_hw_mute (EmpathyGstAudioSrc *self, gboolean mute)
96 g_mutex_lock (&self->priv->lock);
97 /* If there is no mixer available ignore the setting */
98 if (self->priv->track == NULL)
101 gst_mixer_set_mute (GST_MIXER (self->priv->src), self->priv->track, mute);
104 g_mutex_unlock (&self->priv->lock);
105 self->priv->mute = mute;
109 empathy_audio_src_get_hw_mute (EmpathyGstAudioSrc *self)
111 gboolean result = self->priv->mute;
113 g_mutex_lock (&self->priv->lock);
114 if (self->priv->track == NULL)
117 result = GST_MIXER_TRACK_HAS_FLAG (self->priv->track, GST_MIXER_TRACK_MUTE);
119 g_mutex_unlock (&self->priv->lock);
125 empathy_audio_src_set_hw_volume (EmpathyGstAudioSrc *self,
128 gint volumes[MAX_MIC_CHANNELS];
131 g_mutex_lock (&self->priv->lock);
132 /* If there is no mixer available ignore the setting */
133 if (self->priv->track == NULL)
136 for (i = 0; i < MAX_MIC_CHANNELS; i++)
137 volumes[i] = self->priv->track->max_volume * volume;
139 gst_mixer_set_volume (GST_MIXER (self->priv->src),
140 self->priv->track, volumes);
143 g_mutex_unlock (&self->priv->lock);
145 self->priv->volume = volume;
149 empathy_audio_src_get_hw_volume (EmpathyGstAudioSrc *self)
151 gint volumes[MAX_MIC_CHANNELS];
152 gdouble result = self->priv->volume;
154 g_mutex_lock (&self->priv->lock);
155 if (self->priv->track == NULL)
158 gst_mixer_get_volume (GST_MIXER (self->priv->src),
159 self->priv->track, volumes);
160 result = volumes[0]/(gdouble)self->priv->track->max_volume;
163 g_mutex_unlock (&self->priv->lock);
170 empathy_audio_src_supports_changing_mic (EmpathyGstAudioSrc *self)
172 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
173 GObjectClass *object_class;
175 object_class = G_OBJECT_GET_CLASS (priv->src);
177 return (g_object_class_find_property (object_class,
178 "source-output-index") != NULL);
182 empathy_audio_src_get_mic_index (EmpathyGstAudioSrc *self)
184 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
185 guint audio_src_idx = PA_INVALID_INDEX;
187 if (empathy_audio_src_supports_changing_mic (self))
188 g_object_get (priv->src,
189 "source-output-index", &audio_src_idx,
192 return audio_src_idx;
196 empathy_audio_src_microphone_changed_cb (EmpathyMicMonitor *monitor,
197 guint source_output_idx,
201 EmpathyGstAudioSrc *self = user_data;
202 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
205 audio_src_idx = empathy_audio_src_get_mic_index (self);
207 if (source_output_idx == PA_INVALID_INDEX
208 || source_output_idx != audio_src_idx)
211 if (priv->source_idx == source_idx)
214 priv->source_idx = source_idx;
215 g_object_notify (G_OBJECT (self), "microphone");
219 empathy_audio_src_get_current_mic_cb (GObject *source_object,
220 GAsyncResult *result,
223 EmpathyMicMonitor *monitor = EMPATHY_MIC_MONITOR (source_object);
224 EmpathyGstAudioSrc *self = user_data;
225 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
227 GError *error = NULL;
229 source_idx = empathy_mic_monitor_get_current_mic_finish (monitor, result, &error);
233 DEBUG ("Failed to get current mic: %s", error->message);
234 g_clear_error (&error);
238 if (priv->source_idx == source_idx)
241 priv->source_idx = source_idx;
242 g_object_notify (G_OBJECT (self), "microphone");
246 empathy_audio_src_source_output_index_notify (GObject *object,
248 EmpathyGstAudioSrc *self)
250 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
251 guint source_output_idx;
253 source_output_idx = empathy_audio_src_get_mic_index (self);
255 if (source_output_idx == PA_INVALID_INDEX)
258 if (priv->source_output_idx == source_output_idx)
261 /* It's actually changed. */
262 priv->source_output_idx = source_output_idx;
264 empathy_mic_monitor_get_current_mic_async (priv->mic_monitor,
265 source_output_idx, empathy_audio_src_get_current_mic_cb, self);
268 static GstMixerTrack *
269 empathy_audio_src_get_track (GstElement *src)
272 GstMixerTrack *track = NULL;
274 if (!gst_element_implements_interface (src, GST_TYPE_MIXER))
276 g_warning ("No mixer interface implementation, can't control volume");
280 for (t = gst_mixer_list_tracks (GST_MIXER (src));
281 t != NULL; t = g_list_next (t))
283 GstMixerTrack *tr = t->data;
284 if (!tp_strdiff (tr->label, "Master"))
293 g_warning ("No suitable track found");
295 else if (track->num_channels > MAX_MIC_CHANNELS)
297 g_warning ("Microphones with more then %d channels not supported ",
309 const gchar *description;
311 description = g_getenv ("EMPATHY_AUDIO_SRC");
313 if (description != NULL)
315 GError *error = NULL;
317 src = gst_parse_bin_from_description (description, TRUE, &error);
320 DEBUG ("Failed to create bin %s: %s", description, error->message);
321 g_error_free (error);
327 /* Use pulsesrc as default */
328 src = gst_element_factory_make ("pulsesrc", NULL);
332 empathy_call_set_stream_properties (src, TRUE);
334 /* Set latency (buffering on the PulseAudio side) of 20ms */
335 g_object_set (src, "buffer-time", (gint64) 20000, NULL);
341 empathy_audio_src_init (EmpathyGstAudioSrc *obj)
343 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (obj);
345 GstElement *capsfilter;
349 priv->peak_level = -G_MAXDOUBLE;
350 g_mutex_init (&priv->lock);
354 priv->src = create_src ();
355 if (priv->src == NULL)
358 gst_bin_add (GST_BIN (obj), priv->src);
360 /* Explicitly state what format we want from pulsesrc. This pushes resampling
361 * and format conversion as early as possible, lowering the amount of data
362 * transferred and thus improving performance. When moving to GStreamer
363 * 0.11/1.0, this should change so that we actually request what the encoder
364 * wants downstream. */
365 caps = gst_caps_new_simple ("audio/x-raw-int",
366 "channels", G_TYPE_INT, 1,
367 "width", G_TYPE_INT, 16,
368 "depth", G_TYPE_INT, 16,
369 "rate", G_TYPE_INT, 32000,
371 capsfilter = gst_element_factory_make ("capsfilter", NULL);
372 g_object_set (G_OBJECT (capsfilter), "caps", caps, NULL);
373 gst_bin_add (GST_BIN (obj), capsfilter);
374 gst_element_link (priv->src, capsfilter);
376 priv->level = gst_element_factory_make ("level", NULL);
377 gst_bin_add (GST_BIN (obj), priv->level);
378 gst_element_link (capsfilter, priv->level);
380 src = gst_element_get_static_pad (priv->level, "src");
382 ghost = gst_ghost_pad_new ("src", src);
383 gst_element_add_pad (GST_ELEMENT (obj), ghost);
385 gst_object_unref (G_OBJECT (src));
387 /* Listen to changes to GstPulseSrc:source-output-index so we know when
388 * it's no longer PA_INVALID_INDEX (starting for the first time) or if it
389 * changes (READY->NULL->READY...) */
390 g_signal_connect (priv->src, "notify::source-output-index",
391 G_CALLBACK (empathy_audio_src_source_output_index_notify),
394 priv->mic_monitor = empathy_mic_monitor_new ();
395 g_signal_connect (priv->mic_monitor, "microphone-changed",
396 G_CALLBACK (empathy_audio_src_microphone_changed_cb), obj);
398 priv->source_idx = PA_INVALID_INDEX;
401 static void empathy_audio_src_dispose (GObject *object);
402 static void empathy_audio_src_finalize (GObject *object);
403 static void empathy_audio_src_handle_message (GstBin *bin,
404 GstMessage *message);
406 static gboolean empathy_audio_src_levels_updated (gpointer user_data);
409 empathy_audio_src_set_property (GObject *object,
410 guint property_id, const GValue *value, GParamSpec *pspec)
415 empathy_audio_src_set_hw_volume (EMPATHY_GST_AUDIO_SRC (object),
416 g_value_get_double (value));
419 empathy_audio_set_hw_mute (EMPATHY_GST_AUDIO_SRC (object),
420 g_value_get_boolean (value));
423 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
428 empathy_audio_src_get_property (GObject *object,
429 guint property_id, GValue *value, GParamSpec *pspec)
431 EmpathyGstAudioSrc *self = EMPATHY_GST_AUDIO_SRC (object);
432 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
437 g_value_set_double (value, priv->volume);
440 g_value_set_boolean (value, priv->mute);
442 case PROP_PEAK_LEVEL:
443 g_mutex_lock (&priv->lock);
444 g_value_set_double (value, priv->peak_level);
445 g_mutex_unlock (&priv->lock);
448 g_mutex_lock (&priv->lock);
449 g_value_set_double (value, priv->rms_level);
450 g_mutex_unlock (&priv->lock);
452 case PROP_MICROPHONE:
453 g_value_set_uint (value, priv->source_idx);
456 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
461 empathy_audio_src_class_init (EmpathyGstAudioSrcClass
462 *empathy_audio_src_class)
464 GObjectClass *object_class = G_OBJECT_CLASS (empathy_audio_src_class);
465 GstBinClass *gstbin_class = GST_BIN_CLASS (empathy_audio_src_class);
466 GParamSpec *param_spec;
468 g_type_class_add_private (empathy_audio_src_class,
469 sizeof (EmpathyGstAudioSrcPrivate));
471 object_class->dispose = empathy_audio_src_dispose;
472 object_class->finalize = empathy_audio_src_finalize;
474 object_class->set_property = empathy_audio_src_set_property;
475 object_class->get_property = empathy_audio_src_get_property;
477 gstbin_class->handle_message =
478 GST_DEBUG_FUNCPTR (empathy_audio_src_handle_message);
480 param_spec = g_param_spec_double ("volume", "Volume", "volume contol",
482 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
483 g_object_class_install_property (object_class, PROP_VOLUME, param_spec);
485 param_spec = g_param_spec_boolean ("mute", "Mute", "mute contol",
487 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
488 g_object_class_install_property (object_class, PROP_MUTE, param_spec);
490 param_spec = g_param_spec_double ("peak-level", "peak level", "peak level",
491 -G_MAXDOUBLE, G_MAXDOUBLE, 0,
492 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
493 g_object_class_install_property (object_class, PROP_PEAK_LEVEL, param_spec);
495 param_spec = g_param_spec_uint ("microphone", "microphone", "microphone",
496 0, G_MAXUINT, G_MAXUINT,
497 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
498 g_object_class_install_property (object_class, PROP_MICROPHONE, param_spec);
500 signals[PEAK_LEVEL_CHANGED] = g_signal_new ("peak-level-changed",
501 G_TYPE_FROM_CLASS (empathy_audio_src_class),
505 g_cclosure_marshal_generic,
506 G_TYPE_NONE, 1, G_TYPE_DOUBLE);
508 param_spec = g_param_spec_double ("rms-level", "RMS level", "RMS level",
509 -G_MAXDOUBLE, G_MAXDOUBLE, 0,
510 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
511 g_object_class_install_property (object_class, PROP_RMS_LEVEL, param_spec);
513 signals[RMS_LEVEL_CHANGED] = g_signal_new ("rms-level-changed",
514 G_TYPE_FROM_CLASS (empathy_audio_src_class),
518 g_cclosure_marshal_generic,
519 G_TYPE_NONE, 1, G_TYPE_DOUBLE);
523 empathy_audio_src_dispose (GObject *object)
525 EmpathyGstAudioSrc *self = EMPATHY_GST_AUDIO_SRC (object);
526 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
528 if (priv->dispose_has_run)
531 priv->dispose_has_run = TRUE;
533 if (priv->level_idle_id != 0)
534 g_source_remove (priv->level_idle_id);
535 priv->level_idle_id = 0;
537 if (priv->volume_idle_id != 0)
538 g_source_remove (priv->volume_idle_id);
539 priv->volume_idle_id = 0;
541 tp_clear_object (&priv->mic_monitor);
543 /* release any references held by the object here */
545 if (G_OBJECT_CLASS (empathy_audio_src_parent_class)->dispose)
546 G_OBJECT_CLASS (empathy_audio_src_parent_class)->dispose (object);
550 empathy_audio_src_finalize (GObject *object)
552 EmpathyGstAudioSrc *self = EMPATHY_GST_AUDIO_SRC (object);
553 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
555 /* free any data held directly by the object here */
556 g_mutex_clear (&priv->lock);
558 G_OBJECT_CLASS (empathy_audio_src_parent_class)->finalize (object);
562 empathy_audio_src_levels_updated (gpointer user_data)
564 EmpathyGstAudioSrc *self = EMPATHY_GST_AUDIO_SRC (user_data);
565 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
567 g_mutex_lock (&priv->lock);
569 g_signal_emit (self, signals[PEAK_LEVEL_CHANGED], 0, priv->peak_level);
570 g_signal_emit (self, signals[RMS_LEVEL_CHANGED], 0, priv->rms_level);
571 priv->level_idle_id = 0;
573 g_mutex_unlock (&priv->lock);
579 empathy_audio_src_volume_changed (gpointer user_data)
581 EmpathyGstAudioSrc *self = EMPATHY_GST_AUDIO_SRC (user_data);
582 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
586 g_mutex_lock (&priv->lock);
587 priv->volume_idle_id = 0;
588 g_mutex_unlock (&priv->lock);
590 volume = empathy_audio_src_get_hw_volume (self);
592 if (volume != priv->volume)
594 priv->volume = volume;
595 g_object_notify (G_OBJECT (self), "volume");
598 mute = empathy_audio_src_get_hw_mute (self);
599 if (mute != priv->mute)
602 g_object_notify (G_OBJECT (self), "mute");
609 empathy_audio_src_handle_message (GstBin *bin, GstMessage *message)
611 EmpathyGstAudioSrc *self = EMPATHY_GST_AUDIO_SRC (bin);
612 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (self);
614 if (GST_MESSAGE_TYPE (message) == GST_MESSAGE_ELEMENT &&
615 GST_MESSAGE_SRC (message) == GST_OBJECT (priv->level))
617 const GstStructure *s;
621 gdouble peak = -G_MAXDOUBLE;
622 gdouble rms = -G_MAXDOUBLE;
624 s = gst_message_get_structure (message);
625 name = gst_structure_get_name (s);
627 if (g_strcmp0 ("level", name) != 0)
630 list = gst_structure_get_value (s, "peak");
631 len = gst_value_list_get_size (list);
633 for (i =0 ; i < len; i++)
638 value = gst_value_list_get_value (list, i);
639 db = g_value_get_double (value);
640 peak = MAX (db, peak);
643 list = gst_structure_get_value (s, "rms");
644 len = gst_value_list_get_size (list);
646 for (i =0 ; i < len; i++)
651 value = gst_value_list_get_value (list, i);
652 db = g_value_get_double (value);
656 g_mutex_lock (&priv->lock);
658 priv->peak_level = peak;
659 priv->rms_level = rms;
660 if (priv->level_idle_id == 0)
661 priv->level_idle_id = g_idle_add (
662 empathy_audio_src_levels_updated, self);
664 g_mutex_unlock (&priv->lock);
666 else if (GST_MESSAGE_TYPE (message) == GST_MESSAGE_ELEMENT &&
667 GST_MESSAGE_SRC (message) == GST_OBJECT (priv->src))
669 GstMixerTrack *track = NULL;
671 /* Listen for mute or volume changes on the src element */
672 if (gst_mixer_message_get_type (message) ==
673 GST_MIXER_MESSAGE_VOLUME_CHANGED)
674 gst_mixer_message_parse_volume_changed (message, &track,
677 if (gst_mixer_message_get_type (message) ==
678 GST_MIXER_MESSAGE_MUTE_TOGGLED)
679 gst_mixer_message_parse_mute_toggled (message, &track, NULL);
681 g_mutex_lock (&priv->lock);
683 if (track != NULL && track == priv->track && priv->volume_idle_id == 0)
684 priv->volume_idle_id = g_idle_add (
685 empathy_audio_src_volume_changed, self);
687 g_mutex_unlock (&priv->lock);
689 else if (GST_MESSAGE_TYPE (message) == GST_MESSAGE_STATE_CHANGED &&
690 GST_MESSAGE_SRC (message) == GST_OBJECT (priv->src))
694 gst_message_parse_state_changed (message, &old, &new, NULL);
696 /* GstMixer is only available in state >= READY, so only start
697 * controlling the source element when going to ready state and stop
698 * doing so when going below ready. Furthermore once we have mixer read
699 * the current volume level from it and remove the settings done by
700 * Empathy. We want to pick up the level pulseaudio saved */
701 if (old == GST_STATE_NULL && new == GST_STATE_READY)
703 g_mutex_lock (&priv->lock);
704 priv->track = empathy_audio_src_get_track (priv->src);
705 if (priv->track != NULL)
706 priv->volume_idle_id = g_idle_add (
707 empathy_audio_src_volume_changed, self);
708 g_mutex_unlock (&priv->lock);
710 else if (old == GST_STATE_READY && new == GST_STATE_NULL)
712 g_mutex_lock (&priv->lock);
714 g_mutex_unlock (&priv->lock);
719 GST_BIN_CLASS (empathy_audio_src_parent_class)->handle_message (bin,
724 empathy_audio_src_new (void)
726 static gboolean registered = FALSE;
729 if (!gst_element_register (NULL, "empathyaudiosrc",
730 GST_RANK_NONE, EMPATHY_TYPE_GST_AUDIO_SRC))
734 return gst_element_factory_make ("empathyaudiosrc", NULL);
738 empathy_audio_src_set_echo_cancel (EmpathyGstAudioSrc *src,
741 DEBUG ("Src echo cancellation setting: %s", enable ? "on" : "off");
742 empathy_call_set_stream_properties (src->priv->src, enable);
746 empathy_audio_src_set_volume (EmpathyGstAudioSrc *src, gdouble volume)
748 g_object_set (src, "volume", volume, NULL);
752 empathy_audio_src_get_volume (EmpathyGstAudioSrc *src)
754 return src->priv->volume;
758 empathy_audio_src_get_microphone (EmpathyGstAudioSrc *src)
760 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (src);
762 return priv->source_idx;
766 empathy_audio_src_change_microphone_cb (GObject *source_object,
767 GAsyncResult *result,
770 EmpathyMicMonitor *monitor = EMPATHY_MIC_MONITOR (source_object);
771 GSimpleAsyncResult *simple = user_data;
772 GError *error = NULL;
774 if (!empathy_mic_monitor_change_microphone_finish (monitor,
777 g_simple_async_result_take_error (simple, error);
780 g_simple_async_result_complete (simple);
781 g_object_unref (simple);
785 empathy_audio_src_change_microphone_async (EmpathyGstAudioSrc *src,
787 GAsyncReadyCallback callback,
790 EmpathyGstAudioSrcPrivate *priv = EMPATHY_GST_AUDIO_SRC_GET_PRIVATE (src);
791 guint source_output_idx;
792 GSimpleAsyncResult *simple;
794 simple = g_simple_async_result_new (G_OBJECT (src), callback, user_data,
795 empathy_audio_src_change_microphone_async);
797 if (!empathy_audio_src_supports_changing_mic (src))
799 g_simple_async_result_set_error (simple, G_IO_ERROR, G_IO_ERROR_FAILED,
800 "pulsesrc is not new enough to support changing microphone");
801 g_simple_async_result_complete_in_idle (simple);
802 g_object_unref (simple);
806 source_output_idx = empathy_audio_src_get_mic_index (src);
808 if (source_output_idx == PA_INVALID_INDEX)
810 g_simple_async_result_set_error (simple, G_IO_ERROR, G_IO_ERROR_FAILED,
811 "pulsesrc is not yet PLAYING");
812 g_simple_async_result_complete_in_idle (simple);
813 g_object_unref (simple);
817 empathy_mic_monitor_change_microphone_async (priv->mic_monitor,
818 source_output_idx, microphone, empathy_audio_src_change_microphone_cb,
823 empathy_audio_src_change_microphone_finish (EmpathyGstAudioSrc *src,
824 GAsyncResult *result,
827 empathy_implement_finish_void (src,
828 empathy_audio_src_change_microphone_async);