Merge lp:~equinox-i/xfce4-volumed-pulse/add-support-for-mic-mute into lp:~mrpouit/xfce4-volumed-pulse/master

[Christian Pointner]

Addes support for MicMute Key

This adds support for the MicMute Key on modern Laptops..

[lp:~equinox-i/xfce4-volumed-pulse/add-support-for-mic-mute]

64. By Christian Pointner on 2016-02-02

use icon for microphone mute status

[Simon Steinbeiß (ochosi)]

Thanks for your work! Please note that xfce4-volumed-pulse is now maintained at https://git.xfce.org/apps/xfce4-volumed-pulse.

Your patch has been reviewed and merged there.

[Simon Steinbeiß (ochosi)]

review: Approve

Unmerged revisions

64. By Christian Pointner on 2016-02-02

use icon for microphone mute status

63. By Christian Pointner on 2015-09-11

Addes support for MicMute Key

=== modified file 'src/main.c'
--- src/main.c	2013-03-10 18:28:11 +0000
+++ src/main.c	2016-02-02 19:54:56 +0000
@@ -101,11 +101,13 @@
 	i->pa_main_loop = NULL;
 	i->pulse_context = NULL;
 	i->sink_index = -1;
+	i->source_index = -1;
 	i->chan = NULL;
 	i->loop = NULL;
 	#ifdef HAVE_LIBNOTIFY
 	i->gauge_notifications = FALSE;
 	i->notification	= NULL;
+	i->notification_mic	= NULL;
 	#endif
 }
 

=== modified file 'src/xvd_data_types.h'
--- src/xvd_data_types.h	2013-03-10 18:28:11 +0000
+++ src/xvd_data_types.h	2016-02-02 19:54:56 +0000
@@ -55,8 +55,10 @@
 	pa_glib_mainloop *pa_main_loop;
 	pa_context       *pulse_context;
 	guint32           sink_index;
+	guint32           source_index;
 	pa_cvolume        volume;
 	int               mute;
+	int               mic_mute;
 	
 	/* Xfconf vars */
 	XfconfChannel		*chan;
@@ -66,6 +68,7 @@
     /* Libnotify vars */
 	gboolean			gauge_notifications;
 	NotifyNotification* notification;
+	NotifyNotification* notification_mic;
 	#endif
 
 	/* Other Xvd vars */

=== modified file 'src/xvd_keys.c'
--- src/xvd_keys.c	2013-03-10 18:28:11 +0000
+++ src/xvd_keys.c	2016-02-02 19:54:56 +0000
@@ -55,11 +55,21 @@
 {
   XvdInstance *xvd_inst = (XvdInstance *) Inst;
   
-  g_debug ("The LowerVolume key was pressed.");
+  g_debug ("The Mute key was pressed.");
   
   xvd_toggle_mute (xvd_inst);
 }
 
+static
+void xvd_mic_mute_handler (const char *keystring, void *Inst)
+{
+  XvdInstance *xvd_inst = (XvdInstance *) Inst;
+  
+  g_debug ("The MicMute key was pressed.");
+  
+  xvd_toggle_mic_mute (xvd_inst);
+}
+
 void
 xvd_keys_init(XvdInstance *Inst)
 {
@@ -117,6 +127,24 @@
     keybinder_bind ("<Ctrl><Alt><Super>XF86AudioMute", xvd_mute_handler, Inst);
     keybinder_bind ("<Shift><Alt><Super>XF86AudioMute", xvd_mute_handler, Inst);
     keybinder_bind ("<Ctrl><Shift><Alt><Super>XF86AudioMute", xvd_mute_handler, Inst);
+    
+    
+    keybinder_bind ("XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Ctrl>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Alt>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Super>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Shift>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Ctrl><Shift>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Ctrl><Alt>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Ctrl><Super>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Alt><Shift>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Alt><Super>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Shift><Super>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Ctrl><Shift><Super>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Ctrl><Shift><Alt>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Ctrl><Alt><Super>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Shift><Alt><Super>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
+    keybinder_bind ("<Ctrl><Shift><Alt><Super>XF86AudioMicMute", xvd_mic_mute_handler, Inst);
 }
 
 void
@@ -175,5 +203,22 @@
     keybinder_unbind ("<Ctrl><Alt><Super>XF86AudioMute", xvd_mute_handler);
     keybinder_unbind ("<Shift><Alt><Super>XF86AudioMute", xvd_mute_handler);
     keybinder_unbind ("<Ctrl><Shift><Alt><Super>XF86AudioMute", xvd_mute_handler);
-
+    
+    
+    keybinder_unbind ("XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Ctrl>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Alt>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Super>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Shift>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Ctrl><Shift>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Ctrl><Alt>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Ctrl><Super>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Alt><Shift>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Alt><Super>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Shift><Super>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Ctrl><Shift><Super>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Ctrl><Shift><Alt>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Ctrl><Alt><Super>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Shift><Alt><Super>XF86AudioMicMute", xvd_mic_mute_handler);
+    keybinder_unbind ("<Ctrl><Shift><Alt><Super>XF86AudioMicMute", xvd_mic_mute_handler);
 }

=== modified file 'src/xvd_notify.c'
--- src/xvd_notify.c	2013-03-10 18:28:11 +0000
+++ src/xvd_notify.c	2016-02-02 19:54:56 +0000
@@ -99,6 +99,37 @@
 	    (Inst->gauge_notifications) ? -1 : 0);
 }
 
+void
+xvd_notify_mic_notification(XvdInstance *Inst)
+{
+	GError* error						= NULL;
+	gchar*  title						= NULL;
+	gchar*  icon						= NULL;
+  
+	title = g_strdup_printf ("Microphone is %s", (Inst->mic_mute) ? "muted" : "active");
+	icon = (Inst->mic_mute) ? "microphone-sensitivity-muted" : "microphone-sensitivity-high";
+
+	notify_notification_update (Inst->notification_mic,
+                              title,
+                              NULL,
+                              icon);
+	
+	g_free (title);
+
+	if (Inst->gauge_notifications) {
+		notify_notification_set_hint_int32 (Inst->notification_mic,
+							 LAYOUT_ICON_ONLY,
+							 1);
+	}
+  
+	if (!notify_notification_show (Inst->notification_mic, &error))
+	{
+		g_warning ("Error while sending mic notification : %s\n", error->message);
+		g_error_free (error);
+	}
+
+}
+
 void 
 xvd_notify_init(XvdInstance *Inst, 
 				const gchar *appname)
@@ -128,11 +159,14 @@
 #ifdef NOTIFY_CHECK_VERSION
 #if NOTIFY_CHECK_VERSION (0, 7, 0)
 	Inst->notification = notify_notification_new ("Xfce4-Volumed", NULL, NULL);
+	Inst->notification_mic = notify_notification_new ("Xfce4-Volumed", NULL, NULL);
 #else
 	Inst->notification = notify_notification_new ("Xfce4-Volumed", NULL, NULL, NULL);
+	Inst->notification_mic = notify_notification_new ("Xfce4-Volumed", NULL, NULL, NULL);
 #endif
 #else
 	Inst->notification = notify_notification_new ("Xfce4-Volumed", NULL, NULL, NULL);
+	Inst->notification_mic = notify_notification_new ("Xfce4-Volumed", NULL, NULL, NULL);
 #endif
 }
 
@@ -141,5 +175,7 @@
 {
 	g_object_unref (G_OBJECT (Inst->notification));
 	Inst->notification = NULL;
+	g_object_unref (G_OBJECT (Inst->notification_mic));
+	Inst->notification_mic = NULL;
 	notify_uninit ();
 }

=== modified file 'src/xvd_notify.h'
--- src/xvd_notify.h	2013-03-10 18:28:11 +0000
+++ src/xvd_notify.h	2016-02-02 19:54:56 +0000
@@ -46,6 +46,11 @@
 void
 xvd_notify_undershoot_notification(XvdInstance *Inst);
 
+
+void
+xvd_notify_mic_notification(XvdInstance *Inst);
+
+
 void 
 xvd_notify_init(XvdInstance *Inst, 
 				const gchar *appname);

=== modified file 'src/xvd_pulse.c'
--- src/xvd_pulse.c	2012-05-26 13:41:02 +0000
+++ src/xvd_pulse.c	2016-02-02 19:54:56 +0000
@@ -39,14 +39,20 @@
 
 static pa_cvolume old_volume;
 static int        old_mute;
+static int        old_mic_mute;
 
 
 #ifdef HAVE_LIBNOTIFY
 static void xvd_notify_volume_callback     (pa_context                     *c,
                                             int                             success,
                                             void                           *userdata);
+
+static void xvd_notify_mic_callback        (pa_context                     *c,
+                                            int                             success,
+                                            void                           *userdata);
 #else
 #define xvd_notify_volume_callback NULL
+#define xvd_notify_mic_callback NULL
 #endif
 
 static void xvd_context_state_callback     (pa_context                     *c,
@@ -76,6 +82,21 @@
                                             int                             eol,
                                             void                           *userdata);
 
+static void xvd_default_source_info_callback (pa_context                     *c,
+                                              const pa_source_info             *info,
+                                              int                             eol,
+                                              void                           *userdata);
+
+static void xvd_source_info_callback         (pa_context                     *c,
+                                              const pa_source_info             *source,
+                                              int                             eol,
+                                              void                           *userdata);
+
+static void xvd_update_source_callback      (pa_context                     *c,
+                                             const pa_source_info             *info,
+                                             int                             eol,
+                                             void                           *userdata);
+
 static gboolean xvd_connect_to_pulse       (XvdInstance                    *i);
 
 
@@ -201,6 +222,47 @@
 }
 
 
+void
+xvd_toggle_mic_mute (XvdInstance *i)
+{
+  pa_operation *op = NULL;
+
+  if (!i || !i->pulse_context)
+   {
+      g_warning ("xvd_toggle_mic_mute: pulseaudio context is null");
+      return;
+   }
+
+  if (pa_context_get_state (i->pulse_context) != PA_CONTEXT_READY)
+    {
+      g_warning ("xvd_toggle_mic_mute: pulseaudio context isn't ready");
+      return;
+    }
+
+  if (i->source_index == PA_INVALID_INDEX)
+    {
+      g_warning ("xvd_toggle_mic_mute: undefined source");
+      return;
+    }
+
+  /* backup existing mute and update */
+  i->mic_mute = !(old_mic_mute = i->mic_mute);
+
+  op =  pa_context_set_source_mute_by_index (i->pulse_context,
+                                             i->source_index,
+                                             i->mic_mute,
+                                             xvd_notify_mic_callback,
+                                             i);
+
+  if (!op)
+    {
+      g_warning ("xvd_toggle_mic_mute: failed");
+      return;
+    }
+  pa_operation_unref (op);
+}
+
+
 gint
 xvd_get_readable_volume (const pa_cvolume *vol)
 {
@@ -259,13 +321,13 @@
 
   if (!c || !userdata)
     {
-      g_warning ("xvd_notify_volume_update: invalid argument");
+      g_warning ("xvd_notify_volume_callback: invalid argument");
       return;
     }
 
   if (!success)
     {
-      g_warning ("xvd_notify_volume_update: operation failed, %s",
+      g_warning ("xvd_notify_volume_callback: operation failed, %s",
                  pa_strerror (pa_context_errno (c)));
       return;
     }
@@ -290,6 +352,39 @@
   else
    xvd_notify_volume_notification (i);
 }
+
+
+/**
+ * Shows Mic mute status notification
+ */
+static void
+xvd_notify_mic_callback (pa_context *c,
+                            int         success,
+                            void       *userdata)
+{
+  XvdInstance  *i = (XvdInstance *) userdata;
+  guint32       r_oldv, r_curv;
+
+  if (!c || !userdata)
+    {
+      g_warning ("xvd_notify_mic_callback: invalid argument");
+      return;
+    }
+
+  if (!success)
+    {
+      g_warning ("xvd_notify_mic_callback: operation failed, %s",
+                 pa_strerror (pa_context_errno (c)));
+      return;
+    }
+
+  /* the sink was (un)muted */
+  if (old_mic_mute != i->mic_mute)
+    {
+      xvd_notify_mic_notification (i);
+      return;
+    }
+}
 #endif
 
 
@@ -335,6 +430,28 @@
              pa_operation_unref (op);
           }
       break;
+      /* change on a source, re-fetch it */
+      case PA_SUBSCRIPTION_EVENT_SOURCE:
+        if (i->source_index != index)
+          return;
+
+        if ((t & PA_SUBSCRIPTION_EVENT_TYPE_MASK) == PA_SUBSCRIPTION_EVENT_REMOVE)
+          i->source_index = PA_INVALID_INDEX;
+        else
+          {
+             op = pa_context_get_source_info_by_index (c,
+                                                       index,
+                                                       xvd_update_source_callback,
+                                                       userdata);
+
+             if (!op)
+               {
+                 g_warning ("xvd_subscribed_events_callback: failed to get source info");
+                 return;
+               }
+             pa_operation_unref (op);
+          }
+      break;
       /* change on the server, re-fetch everything */
       case PA_SUBSCRIPTION_EVENT_SERVER:
         op = pa_context_get_server_info (c,
@@ -360,7 +477,7 @@
                             void       *userdata)
 {
   XvdInstance           *i = (XvdInstance *) userdata;
-  pa_subscription_mask_t mask = PA_SUBSCRIPTION_MASK_SINK | PA_SUBSCRIPTION_MASK_SERVER;
+  pa_subscription_mask_t mask = PA_SUBSCRIPTION_MASK_SINK | PA_SUBSCRIPTION_MASK_SOURCE | PA_SUBSCRIPTION_MASK_SERVER;
   pa_operation          *op = NULL;
 
   if (!c || !userdata)
@@ -390,6 +507,7 @@
       case PA_CONTEXT_FAILED:
         g_critical("xvd_context_state_callback: The connection failed or was disconnected, is PulseAudio Daemon running?");
         i->sink_index = PA_INVALID_INDEX;
+        i->source_index = PA_INVALID_INDEX;
       break;
       case PA_CONTEXT_READY:
         g_debug ("xvd_context_state_callback: The connection is established, the context is ready to execute operations");
@@ -397,7 +515,7 @@
                                            xvd_subscribed_events_callback,
                                            userdata);
 
-        /* subscribe to sink and server changes, we don't need more */
+        /* subscribe to sink/source and server changes, we don't need more */
         op = pa_context_subscribe (c,
                                    mask,
                                    NULL,
@@ -476,6 +594,36 @@
         }
       pa_operation_unref (op);
     }
+
+  if (info->default_source_name)
+    {
+      op = pa_context_get_source_info_by_name (c,
+                                               info->default_source_name,
+                                               xvd_default_source_info_callback,
+                                               userdata);
+
+      if (!op)
+        {
+          g_warning("xvd_server_info_callback: pa_context_get_source_info_by_name() failed");
+          return;
+        }
+      pa_operation_unref (op);
+    }
+  else
+    {
+      /* when PulseAudio doesn't set a default source, look at all of them
+         and hope to find a usable one */
+      op = pa_context_get_source_info_list(c,
+                                           xvd_source_info_callback,
+                                           userdata);
+
+      if (!op)
+        {
+          g_warning("xvd_server_info_callback: pa_context_get_source_info_list() failed");
+          return;
+        }
+      pa_operation_unref (op);
+    }
 }
 
 
@@ -584,3 +732,105 @@
 #endif
     }
 }
+
+
+/**
+ * Callback to retrieve the infos of a given source.
+ */
+static void
+xvd_source_info_callback (pa_context         *c,
+                          const pa_source_info *source,
+                          int                 eol,
+                          void               *userdata)
+{
+  XvdInstance *i = (XvdInstance *) userdata;
+
+  /* detect the end of the list */
+  if (eol > 0)
+    return;
+  else
+    {
+      if (!userdata || !source)
+        {
+          g_warning ("xvd_source_info_callback: invalid argument");
+          return;
+        }
+
+      /* If there's no default source, try to use this one */
+      if (i->source_index == PA_INVALID_INDEX
+          /* indicator-sound does that check */
+          && g_ascii_strncasecmp ("auto_null", source->name, 9) != 0)
+        {
+          i->source_index = source->index;
+          old_mic_mute = i->mic_mute = source->mute;
+        }
+    }
+}
+
+
+/**
+ * Callback to retrieve the infos of the default source.
+ */
+static void
+xvd_default_source_info_callback (pa_context         *c,
+                                  const pa_source_info *info,
+                                  int                 eol,
+                                  void               *userdata)
+{
+  XvdInstance *i = (XvdInstance *) userdata;
+
+  /* detect the end of the list */
+  if (eol > 0)
+    return;
+  else
+    {
+      if (!userdata || !info)
+        {
+          g_warning ("xvd_default_source_info_callback: invalid argument");
+          return;
+        }
+
+      /* is this a new default source? */
+      if (i->source_index != info->index)
+        {
+          i->source_index = info->index;
+          old_mic_mute = i->mic_mute = info->mute;
+        }
+    }
+}
+
+
+/**
+ * Callback for source changes reported by PulseAudio.
+ */
+static void
+xvd_update_source_callback (pa_context         *c,
+                            const pa_source_info *info,
+                            int                 eol,
+                            void               *userdata)
+{
+  XvdInstance *i = (XvdInstance *) userdata;
+
+  /* detect the end of the list */
+  if (eol > 0)
+    return;
+  else
+    {
+      if (!c || !userdata || !info)
+        {
+          g_warning ("xvd_update_source_callback: invalid argument");
+          return;
+        }
+
+      /* re-fetch infos from PulseAudio */
+      i->source_index = info->index;
+      old_mic_mute = i->mic_mute;
+      i->mic_mute = info->mute;
+
+#ifdef HAVE_LIBNOTIFY
+      /* notify user of the possible changes */
+      if (old_mic_mute != i->mic_mute)
+        xvd_notify_mic_callback (c, 1, i);
+#endif
+    }
+}

=== modified file 'src/xvd_pulse.h'
--- src/xvd_pulse.h	2012-05-24 21:24:41 +0000
+++ src/xvd_pulse.h	2016-02-02 19:54:56 +0000
@@ -47,6 +47,11 @@
 void     xvd_toggle_mute         (XvdInstance        *i);
 
 /**
+ * Toggle mic mute.
+ */
+void     xvd_toggle_mic_mute         (XvdInstance        *i);
+
+/**
  * Returns a percentage volume (i.e. between 0 and 100, usable on notifications)
  */
 gint     xvd_get_readable_volume (const pa_cvolume   *vol);