Merge lp:~dylanmccall/notify-osd/sounds-support into lp:notify-osd/lucid

[Dylan McCall]

This branch adds sounds support, as specified at https://wiki.ubuntu.com/NotifyOSD#Sound and http://people.canonical.com/~agateau/notifications-1.1/spec/ar01s08.html

The feature can be tested with notify-send:
notify-send --hint=string:sound-name:phone-incoming-call "Yay" "sound-name hint"
notify-send --hint=string:sound-file:/usr/share/sounds/gnome/default/alerts/sonar.ogg "Yay" "sound-file hint"

Note that a bubble's sound plays when it appears, and libcanberra-gtk (+PulseAudio) position the sound so it seems to come from the notification bubble.

[lp:~dylanmccall/notify-osd/sounds-support]

431. By Dylan McCall on 2010-12-05

Remove type check for suppress-sound hint. If the hint is there, immediately set suppress_sound to TRUE.

[Dylan McCall (dylanmccall)]

To test suppress-sound, you'll need a sufficiently long sound (but the file can't be too big or Canberra will refuse to play it). Try something like this:

notify-send --hint=string:sound-file:/home/dylan/Desktop/Freedom.ogg --hint=string:suppress-sound: "Testing" "suppress-sound hint"

Run that twice, giving it your own sound-file. The specification on this one wasn't completely clear to me, but my implementation will stop any other notification sounds generated by notify-osd.

I noticed that pynotify doesn't deal in Boolean hints (which the specification wants), and I couldn't find any other hints that were boolean either. So, in revision 431 I made this not look at the type of the hint. If the hint is there, it's assumed that suppress_sound should be True.

[Mirco Müller (macslow)]

This patch causes notification bubbles not to show up at all (but attached sound-files are played). I'm not sure what's causing the bubble not to appear. I've used these to commands to test this on current natty:

notify-send "Incoming call" "Yo dude, answer the damn phone" -i ubuntu-logo --hint=string:sound-file:/usr/share/sounds/ubuntu/stereo/phone-incoming-call.ogg

notify-send "Line busy" "Please call again later" -i gnome-foot --hint=string:sound-file:/usr/share/sounds/ubuntu/stereo/phone-outgoing-busy.ogg

I see and hear the first bubble, but the second bubble does not get displayed. I only hear the sound file played of the second one.

review: Needs Fixing

[Dylan McCall (dylanmccall)]

Interesting… I tried to reproduce that problem but I haven't seen it yet :o
I tried under both Maverick and Natty (under a VM) with this branch. (I had to rebase it to the current lp:notify-osd to get it to build under Natty).

Was this consistently happening on your end, or should I be looking for more of a chance occurrence?

[Andrew Somerville (andy-somerville)]

Seems like this died several years ago. Any replacement?

Unmerged revisions

431. By Dylan McCall on 2010-12-05

Remove type check for suppress-sound hint. If the hint is there, immediately set suppress_sound to TRUE.

430. By Dylan McCall on 2010-04-17

Renamed sound-id to sound-name, matching specification at http://people.canonical.com/~agateau/notifications-1.1/spec/ar01s08.html

Set ID for sound-file, sounds, too, so suppress-sound works reliably.

429. By Dylan McCall on 2010-03-27

Implement suppress-sound hint. Haven't been able to test this, but it _should_ work, I think...

428. By Dylan McCall on 2010-03-27

Initial support for sounds in notify-osd.

This adds a dependency on libcanberra-gtk, which carries out the actual playing of event sounds.
This uses the sound-file hint described in the Desktop Notification Specification.
In addition, there is a non-standard x-sound-id hint.

Implementation so far plays sounds, but does not fully comply with the specification. Still need to implement suppress-sounds :)

=== modified file 'configure.in'
--- configure.in	2010-10-05 17:54:42 +0000
+++ configure.in	2010-12-05 20:02:10 +0000
@@ -26,7 +26,7 @@
 #
 # glib, we need 2.16.0 for the unit-tests
 #
-PKG_CHECK_MODULES([GLIB], [glib-2.0 >= 2.16.0 gthread-2.0 gconf-2.0 gio-2.0])
+PKG_CHECK_MODULES([GLIB], [glib-2.0 >= 2.16.0 gthread-2.0 gconf-2.0 gio-2.0 libcanberra libcanberra-gtk])
 
 #
 # gconf, used by the Defaults class to get system font-face and font-size

=== modified file 'src/bubble.c'
--- src/bubble.c	2010-10-05 17:54:42 +0000
+++ src/bubble.c	2010-12-05 20:02:10 +0000
@@ -42,6 +42,8 @@
 #include <egg/egg-hack.h>
 #include <egg/egg-alpha.h>
 
+#include <canberra-gtk.h>
+
 #include "bubble.h"
 #include "defaults.h"
 #include "stack.h"
@@ -96,6 +98,9 @@
 	guint            timeout;
 	guint            urgency;
 	//notification_t* notification;
+	gboolean         suppress_sound;
+	gchar*           sound_name;
+	gchar*           sound_file;
 
 	// used to prevent unneeded updates of the tile-cache, for append-,
 	// update or replace-cases, needs to move into class Notification
@@ -167,6 +172,8 @@
 #define BUBBLE_CONTENT_BLUR_RADIUS 4
 #define TEXT_DROP_SHADOW_SIZE      2
 
+#define BUBBLE_CA_GTK_SOUNDS_ID    1
+
 //-- private functions ---------------------------------------------------------
 
 static guint g_bubble_signals[LAST_SIGNAL] = { 0 };
@@ -2422,6 +2429,65 @@
 }
 
 void
+bubble_set_suppress_sound (Bubble* self,
+			   gboolean suppress_sound)
+{
+	if (!self || !IS_BUBBLE (self))
+		return;
+
+	GET_PRIVATE (self)->suppress_sound = suppress_sound;
+}
+
+gboolean
+bubble_get_suppress_sound (Bubble* self)
+{
+	if (!self || !IS_BUBBLE (self))
+		return FALSE;
+
+	return GET_PRIVATE (self)->suppress_sound;
+}
+
+void
+bubble_set_sound_name (Bubble* self,
+		     const gchar* id)
+{
+	BubblePrivate* priv;
+	
+	if (!self || !IS_BUBBLE (self) || !g_strcmp0 (id, ""))
+		return;
+
+	priv = GET_PRIVATE (self);
+
+	if (priv->sound_name)
+	{
+		g_object_unref (priv->sound_name);
+		priv->sound_name = NULL;
+	}
+	
+	priv->sound_name = g_strdup (id);
+}
+
+void
+bubble_set_sound_file (Bubble* self,
+		       const gchar* file)
+{
+	BubblePrivate* priv;
+	
+	if (!self || !IS_BUBBLE (self) || !g_strcmp0 (file, ""))
+		return;
+
+	priv = GET_PRIVATE (self);
+
+	if (priv->sound_file)
+	{
+		g_object_unref (priv->sound_file);
+		priv->sound_file = NULL;
+	}
+	
+	priv->sound_file = g_strdup (file);
+}
+
+void
 bubble_set_icon (Bubble*      self,
 		 const gchar* filename)
 {
@@ -2823,6 +2889,30 @@
         priv->pointer_update_id = g_timeout_add (1000/FPS,
 						 (GSourceFunc) pointer_update,
 						 self);
+
+	// play an attached sound using Canberra
+	if (priv->suppress_sound)
+	{
+		ca_context* c = ca_gtk_context_get ();
+		ca_context_cancel(c, BUBBLE_CA_GTK_SOUNDS_ID);
+	}
+
+	if (priv->sound_name)
+	{
+		ca_gtk_play_for_widget (priv->widget, BUBBLE_CA_GTK_SOUNDS_ID,
+					CA_PROP_EVENT_ID, priv->sound_name,
+					/*CA_PROP_EVENT_DESCRIPTION, "event description",
+					CA_PROP_APPLICATION_ID, "application id",*/
+					NULL);
+	}
+	else if (priv->sound_file)
+	{
+		ca_gtk_play_for_widget (priv->widget, BUBBLE_CA_GTK_SOUNDS_ID,
+					CA_PROP_MEDIA_FILENAME, priv->sound_file,
+					/*CA_PROP_EVENT_DESCRIPTION, "event description",
+					CA_PROP_APPLICATION_ID, "application id",*/
+					NULL);
+	}
 }
 
 /* mostly called when we change the content of the bubble

=== modified file 'src/bubble.h'
--- src/bubble.h	2009-10-20 08:51:11 +0000
+++ src/bubble.h	2010-12-05 20:02:10 +0000
@@ -124,6 +124,21 @@
 bubble_get_icon_pixbuf (Bubble *self);
 
 void
+bubble_set_suppress_sound (Bubble* self,
+			   gboolean suppress_sound);
+
+gboolean
+bubble_get_suppress_sound (Bubble* self);
+
+void
+bubble_set_sound_name (Bubble* self,
+		       const gchar* id);
+
+void
+bubble_set_sound_file (Bubble* self,
+		       const gchar* file);
+
+void
 bubble_set_value (Bubble* self,
 		  gint    value);
 

=== modified file 'src/notification.c'
--- src/notification.c	2009-08-04 15:18:03 +0000
+++ src/notification.c	2010-12-05 20:02:10 +0000
@@ -40,6 +40,9 @@
 	PROP_ICON_THEMENAME,
 	PROP_ICON_FILENAME,
 	PROP_ICON_PIXBUF,
+	PROP_SUPPRESS_SOUND,
+	PROP_SOUND_NAME,
+	PROP_SOUND_FILE,
 	PROP_ONSCREEN_TIME,
 	PROP_SENDER_NAME,
 	PROP_SENDER_PID,
@@ -58,6 +61,9 @@
 	GString*   icon_themename;      // e.g. "notification-message-email"
 	GString*   icon_filename;       // e.g. "/usr/share/icons/icon.png"
 	GdkPixbuf* icon_pixbuf;         // from setter memcpy'ed pixbuf 
+	gboolean   suppress_sound;      // true to suppress playing sounds
+	GString*   sound_name;            // eg. "audio-volume-change"
+	GString*   sound_file;          // eg. "/usr/share/sounds/email.wav"
 	gint       onscreen_time;       // time on-screen in ms
 	GString*   sender_name;         // app-name, strdup'ed from setter
 	gint       sender_pid;          // pid of sending application
@@ -135,6 +141,18 @@
 		g_object_unref (priv->icon_pixbuf);
 	}
 
+	if (priv->sound_name)
+	{
+		g_string_free (priv->sound_name, TRUE);
+		priv->sound_name = NULL;
+	}
+
+	if (priv->sound_file)
+	{
+		g_string_free (priv->sound_file, TRUE);
+		priv->sound_file = NULL;
+	}
+
 	if (priv->sender_name)
 	{
 		g_string_free (priv->sender_name, TRUE);
@@ -201,6 +219,21 @@
 					     notification_get_icon_pixbuf (n));
 		break;
 
+		case PROP_SUPPRESS_SOUND:
+			g_value_set_boolean (value,
+					    notification_get_suppress_sound (n));
+		break;
+
+		case PROP_SOUND_NAME:
+			g_value_set_string (value,
+					    notification_get_sound_name (n));
+		break;
+
+		case PROP_SOUND_FILE:
+			g_value_set_string (value,
+					    notification_get_sound_file (n));
+		break;
+
 		case PROP_ONSCREEN_TIME:
 			g_value_set_int (value,
 					 notification_get_onscreen_time (n));
@@ -278,6 +311,24 @@
 				g_value_get_pointer (value));
 		break;
 
+		case PROP_SUPPRESS_SOUND:
+			notification_set_suppress_sound (
+				n,
+				g_value_get_boolean (value));
+		break;
+
+		case PROP_SOUND_NAME:
+			notification_set_sound_name (
+				n,
+				g_value_get_string (value));
+		break;
+
+		case PROP_SOUND_FILE:
+			notification_set_sound_file (
+				n,
+				g_value_get_string (value));
+		break;
+
 		case PROP_ONSCREEN_TIME:
 			notification_set_onscreen_time (
 				n,
@@ -325,6 +376,9 @@
 	GParamSpec*   property_icon_themename;
 	GParamSpec*   property_icon_filename;
 	GParamSpec*   property_icon_pixbuf;
+	GParamSpec*   property_suppress_sound;
+	GParamSpec*   property_sound_name;
+	GParamSpec*   property_sound_file;
 	GParamSpec*   property_onscreen_time;
 	GParamSpec*   property_sender_name;
 	GParamSpec*   property_sender_pid;
@@ -413,6 +467,39 @@
 					 PROP_ICON_PIXBUF,
 					 property_icon_pixbuf);
 
+	property_suppress_sound = g_param_spec_boolean (
+					"suppress-sound",
+					"suppress-sound",
+					"whether to suppress playing sounds",
+					0,
+					G_PARAM_CONSTRUCT |
+					G_PARAM_READWRITE);
+	g_object_class_install_property (gobject_class,
+					 PROP_SUPPRESS_SOUND,
+					 property_suppress_sound);
+
+	property_sound_name = g_param_spec_string (
+					"sound-id",
+					"sound-id",
+					"name of sound to use",
+					NULL,
+					G_PARAM_CONSTRUCT |
+					G_PARAM_READWRITE);
+	g_object_class_install_property (gobject_class,
+					 PROP_SOUND_NAME,
+					 property_sound_name);
+
+	property_sound_file = g_param_spec_string (
+					"sound-file",
+					"sound-file",
+					"file-name of sound to use",
+					NULL,
+					G_PARAM_CONSTRUCT |
+					G_PARAM_READWRITE);
+	g_object_class_install_property (gobject_class,
+					 PROP_SOUND_FILE,
+					 property_sound_file);
+
 	property_onscreen_time = g_param_spec_int ("onscreen-time",
 						   "onscreen-time",
 						   "time on screen sofar",
@@ -617,6 +704,53 @@
 	return GET_PRIVATE (n)->icon_pixbuf;
 }
 
+gboolean
+notification_get_suppress_sound (Notification* n)
+{
+	g_return_val_if_fail (IS_NOTIFICATION (n), -2);
+
+	return GET_PRIVATE (n)->suppress_sound;
+}
+
+void
+notification_set_suppress_sound (Notification* n,
+				 gboolean suppress_sound)
+{
+	NotificationPrivate* priv;
+
+	g_assert (IS_NOTIFICATION (n));
+
+	priv = GET_PRIVATE (n);
+
+	priv->suppress_sound = suppress_sound;
+}
+
+gchar*
+notification_get_sound_name (Notification* n)
+{
+	RETURN_GCHAR (n, sound_name)
+}
+
+void
+notification_set_sound_name (Notification* n,
+			     const gchar* sound_name)
+{
+	SET_GCHAR (n, sound_name)
+}
+
+gchar*
+notification_get_sound_file (Notification* n)
+{
+	RETURN_GCHAR (n, sound_file)
+}
+
+void
+notification_set_sound_file (Notification* n,
+			     const gchar* sound_file)
+{
+	SET_GCHAR (n, sound_file)
+}
+
 void
 notification_set_icon_pixbuf (Notification*    n,
 			      const GdkPixbuf* icon_pixbuf)

=== modified file 'src/notification.h'
--- src/notification.h	2009-08-04 09:59:20 +0000
+++ src/notification.h	2010-12-05 20:02:10 +0000
@@ -127,6 +127,27 @@
 notification_set_icon_pixbuf (Notification*    n,
 			      const GdkPixbuf* icon_pixbuf);
 
+gboolean
+notification_get_suppress_sound (Notification* n);
+
+void
+notification_set_suppress_sound (Notification* n,
+				 const gboolean suppress_sound);
+
+gchar*
+notification_get_sound_name (Notification* n);
+
+void
+notification_set_sound_name (Notification* n,
+			     const gchar* sound_name);
+
+gchar*
+notification_get_sound_file (Notification* n);
+
+void
+notification_set_sound_file (Notification* n,
+				 const gchar* sound_file);
+
 gint
 notification_get_onscreen_time (Notification* n);
 

=== modified file 'src/stack.c'
--- src/stack.c	2009-10-20 08:51:11 +0000
+++ src/stack.c	2010-12-05 20:02:10 +0000
@@ -741,6 +741,35 @@
 			bubble_set_icon_from_pixbuf (bubble, pixbuf);
 		}
 	}
+	
+	if (hints)
+	{
+		if ((data = (GValue*) g_hash_table_lookup (hints, "sound-name")))
+		{
+			g_debug("Using sound-name hint\n");
+			if ((data && G_VALUE_HOLDS_STRING (data)))
+				bubble_set_sound_name (bubble, g_value_get_string(data));
+			else
+				g_warning ("sound-name hint is not a string\n");
+		}
+		else if ((data = (GValue*) g_hash_table_lookup (hints, "sound-file")))
+		{
+			g_debug("Using sound-file hint\n");
+			if ((data && G_VALUE_HOLDS_STRING (data)))
+				bubble_set_sound_file (bubble, g_value_get_string(data));
+			else
+				g_warning ("sound-file hint is not a string\n");
+		}
+	}
+
+	if (hints)
+	{
+		if ((data = (GValue*) g_hash_table_lookup (hints, "suppress-sound")))
+		{
+			g_debug("Using suppress-sound hint\n");
+			bubble_set_suppress_sound (bubble, TRUE);
+		}
+	}
 
 	log_bubble_debug (bubble, app_name,
 			  (*icon == '\0' && data != NULL) ?
@@ -828,7 +857,7 @@
 stack_get_capabilities (Stack*   self,
 			gchar*** out_caps)
 {
-	*out_caps = g_malloc0 (13 * sizeof(char *));
+	*out_caps = g_malloc0 (14 * sizeof(char *));
 
 	(*out_caps)[0]  = g_strdup ("body");
 	(*out_caps)[1]  = g_strdup ("body-markup");
@@ -846,8 +875,9 @@
 	(*out_caps)[9]  = g_strdup ("append");
 	(*out_caps)[10] = g_strdup ("private-icon-only");
 	(*out_caps)[11] = g_strdup ("truncation");
+	(*out_caps)[12] = g_strdup ("sound");
 
-	(*out_caps)[12] = NULL;
+	(*out_caps)[13] = NULL;
 
 	return TRUE;
 }