Update to current trunk

3 files changed, 342 insertions, 12 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 4a4443f..c18726c 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -21,6 +21,7 @@ vala_init(indicator-sound-service
     accounts-service
   PACKAGES
     config
+    gee-1.0
     gio-2.0
     gio-unix-2.0
     libxml-2.0
diff --git a/src/sound-menu.vala b/src/sound-menu.vala
index 6cbbf67..f245a1f 100644
--- a/src/sound-menu.vala
+++ b/src/sound-menu.vala
@@ -44,7 +44,7 @@ public class SoundMenu: Object
 			volume_section.append_item(item);
 		}
 
-		volume_section.append_item (this.create_slider_menu_item ("indicator.volume(0)", 0.0, 1.0, 0.01,
+		volume_section.append_item (this.create_slider_menu_item (_("Volume"), "indicator.volume(0)", 0.0, 1.0, 0.01,
 																  "audio-volume-low-zero-panel",
 																  "audio-volume-high-panel"));
 
@@ -86,7 +86,7 @@ public class SoundMenu: Object
 		}
 		set {
 			if (value && !this.mic_volume_shown) {
-				var slider = this.create_slider_menu_item ("indicator.mic-volume", 0.0, 1.0, 0.01,
+				var slider = this.create_slider_menu_item (_("Microphone Volume"), "indicator.mic-volume", 0.0, 1.0, 0.01,
 														   "audio-input-microphone-low-zero-panel",
 														   "audio-input-microphone-high-panel");
 				volume_section.append_item (slider);
@@ -243,11 +243,11 @@ public class SoundMenu: Object
 		player_section.append_submenu (_("Choose Playlist"), submenu);
 	}
 
-	MenuItem create_slider_menu_item (string action, double min, double max, double step, string min_icon_name, string max_icon_name) {
+	MenuItem create_slider_menu_item (string label, string action, double min, double max, double step, string min_icon_name, string max_icon_name) {
 		var min_icon = new ThemedIcon.with_default_fallbacks (min_icon_name);
 		var max_icon = new ThemedIcon.with_default_fallbacks (max_icon_name);
 
-		var slider = new MenuItem (null, action);
+		var slider = new MenuItem (label, action);
 		slider.set_attribute ("x-canonical-type", "s", "com.canonical.unity.slider");
 		slider.set_attribute_value ("min-icon", min_icon.serialize ());
 		slider.set_attribute_value ("max-icon", max_icon.serialize ());
diff --git a/src/volume-control.vala b/src/volume-control.vala
index afcca15..70c038e 100644
--- a/src/volume-control.vala
+++ b/src/volume-control.vala
@@ -19,6 +19,8 @@
  */
 
 using PulseAudio;
+using Notify;
+using Gee;
 
 [CCode(cname="pa_cvolume_set", cheader_filename = "pulse/volume.h")]
 extern unowned PulseAudio.CVolume? vol_set (PulseAudio.CVolume? cv, uint channels, PulseAudio.Volume v);
@@ -43,6 +45,21 @@ public class VolumeControl : Object
 	private double _volume = 0.0;
 	private double _mic_volume = 0.0;
 
+	/* Used by the pulseaudio stream restore extension */
+	private DBusConnection _pconn;
+	/* Need both the list and hash so we can retrieve the last known sink-input after
+	 * releasing the current active one (restoring back to the previous known role) */
+	private Gee.ArrayList<uint32> _sink_input_list = new Gee.ArrayList<uint32> ();
+	private HashMap<uint32, string> _sink_input_hash = new HashMap<uint32, string> ();
+	private bool _pulse_use_stream_restore = false;
+	private uint32 _active_sink_input = -1;
+	private string[] _valid_roles = {"multimedia", "alert", "alarm", "phone"};
+	private string? _objp_role_multimedia = null;
+	private string? _objp_role_alert = null;
+	private string? _objp_role_alarm = null;
+	private string? _objp_role_phone = null;
+	private uint _pa_volume_sig_count = 0;
+
 	private DBusProxy _user_proxy;
 	private GreeterListInterface _greeter_proxy;
 	private Cancellable _mute_cancellable;
@@ -51,6 +68,7 @@ public class VolumeControl : Object
 	private uint _accountservice_volume_timer = 0;
 	private bool _send_next_local_volume = false;
 	private double _account_service_volume = 0.0;
+	private Notify.Notification _notification;
 
 	public signal void volume_changed (double v);
 	public signal void mic_volume_changed (double v);
@@ -68,6 +86,13 @@ public class VolumeControl : Object
 
 		_mute_cancellable = new Cancellable ();
 		_volume_cancellable = new Cancellable ();
+
+		Notify.init ("Volume");
+		_notification = new Notify.Notification("Volume", "", "audio-volume-muted");
+		_notification.set_hint ("value", 0);
+		_notification.set_hint ("x-canonical-private-synchronous", "true");
+		_notification.set_hint ("x-canonical-non-shaped-icon", "true");
+
 		setup_accountsservice.begin ();
 
 		this.reconnect_to_pulse ();
@@ -92,6 +117,26 @@ public class VolumeControl : Object
 				update_sink ();
 				break;
 
+			case Context.SubscriptionEventType.SINK_INPUT:
+				switch (t & Context.SubscriptionEventType.TYPE_MASK)
+				{
+					case Context.SubscriptionEventType.NEW:
+						c.get_sink_input_info (index, handle_new_sink_input_cb);
+						break;
+
+					case Context.SubscriptionEventType.CHANGE:
+						c.get_sink_input_info (index, handle_changed_sink_input_cb);
+						break;
+
+					case Context.SubscriptionEventType.REMOVE:
+						remove_sink_input_from_list (index);
+						break;
+					default:
+						debug ("Sink input event not known.");
+						break;
+				}
+				break;
+
 			case Context.SubscriptionEventType.SOURCE:
 				update_source ();
 				break;
@@ -129,9 +174,10 @@ public class VolumeControl : Object
 			this.notify_property ("is-playing");
 		}
 
-		if (_volume != volume_to_double (i.volume.values[0]))
+		if (_pulse_use_stream_restore == false &&
+				_volume != volume_to_double (i.volume.max ()))
 		{
-			_volume = volume_to_double (i.volume.values[0]);
+			_volume = volume_to_double (i.volume.max ());
 			volume_changed (_volume);
 		}
 	}
@@ -170,6 +216,153 @@ public class VolumeControl : Object
 		context.get_server_info (update_source_get_server_info_cb);
 	}
 
+	private DBusMessage pulse_dbus_filter (DBusConnection connection, owned DBusMessage message, bool incoming)
+	{
+		if (message.get_message_type () == DBusMessageType.SIGNAL) {
+			string active_role_objp = _objp_role_alert;
+			if (_active_sink_input != -1)
+				active_role_objp = _sink_input_hash.get (_active_sink_input);
+
+			if (message.get_path () == active_role_objp && message.get_member () == "VolumeUpdated") {
+				uint sig_count = 0;
+				lock (_pa_volume_sig_count) {
+					sig_count = _pa_volume_sig_count;
+					if (_pa_volume_sig_count > 0)
+						_pa_volume_sig_count--;
+				}
+
+				/* We only care about signals if our internal count is zero */
+				if (sig_count == 0) {
+					/* Extract volume and make sure it's not a side effect of us setting it */
+					Variant body = message.get_body ();
+					Variant varray = body.get_child_value (0);
+
+					uint32 type = 0, volume = 0;
+					VariantIter iter = varray.iterator ();
+					iter.next ("(uu)", &type, &volume);
+					/* Here we need to compare integer values to avoid rounding issues, so just
+					 * using the volume values used by pulseaudio */
+					PulseAudio.Volume cvolume = double_to_volume (_volume);
+					if (volume != cvolume) {
+						/* Someone else changed the volume for this role, reflect on the indicator */
+						_volume = volume_to_double (volume);
+						volume_changed (_volume);
+					}
+				}
+			}
+		}
+
+		return message;
+	}
+
+	private async void update_active_sink_input (uint32 index)
+	{
+		if ((index == -1) || (index != _active_sink_input && index in _sink_input_list)) {
+			string sink_input_objp = _objp_role_alert;
+			if (index != -1)
+				sink_input_objp = _sink_input_hash.get (index);
+			_active_sink_input = index;
+
+			/* Listen for role volume changes from pulse itself (external clients) */
+			try {
+				var builder = new VariantBuilder (new VariantType ("ao"));
+				builder.add ("o", sink_input_objp);
+
+				yield _pconn.call ("org.PulseAudio.Core1", "/org/pulseaudio/core1",
+						"org.PulseAudio.Core1", "ListenForSignal",
+						new Variant ("(sao)", "org.PulseAudio.Ext.StreamRestore1.RestoreEntry.VolumeUpdated", builder),
+						null, DBusCallFlags.NONE, -1);
+			} catch (GLib.Error e) {
+				warning ("unable to listen for pulseaudio dbus signals (%s)", e.message);
+			}
+
+			try {
+				var props_variant = yield _pconn.call ("org.PulseAudio.Ext.StreamRestore1.RestoreEntry",
+						sink_input_objp, "org.freedesktop.DBus.Properties", "Get",
+						new Variant ("(ss)", "org.PulseAudio.Ext.StreamRestore1.RestoreEntry", "Volume"),
+						null, DBusCallFlags.NONE, -1);
+				Variant tmp;
+				props_variant.get ("(v)", out tmp);
+				uint32 type = 0, volume = 0;
+				VariantIter iter = tmp.iterator ();
+				iter.next ("(uu)", &type, &volume);
+
+				_volume = volume_to_double (volume);
+				volume_changed (_volume);
+			} catch (GLib.Error e) {
+				warning ("unable to get volume for active role %s (%s)", sink_input_objp, e.message);
+			}
+		}
+	}
+
+	private void add_sink_input_into_list (SinkInputInfo sink_input)
+	{
+		/* We're only adding ones that are not corked and with a valid role */
+		var role = sink_input.proplist.gets (PulseAudio.Proplist.PROP_MEDIA_ROLE);
+
+		if (role != null && role in _valid_roles) {
+			if (sink_input.corked == 0 || role == "phone") {
+				_sink_input_list.insert (0, sink_input.index);
+				switch (role)
+				{
+					case "multimedia":
+						_sink_input_hash.set (sink_input.index, _objp_role_multimedia);
+						break;
+					case "alert":
+						_sink_input_hash.set (sink_input.index, _objp_role_alert);
+						break;
+					case "alarm":
+						_sink_input_hash.set (sink_input.index, _objp_role_alarm);
+						break;
+					case "phone":
+						_sink_input_hash.set (sink_input.index, _objp_role_phone);
+						break;
+				}
+				/* Only switch the active sink input in case a phone one is not active */
+				if (_active_sink_input == -1 ||
+						_sink_input_hash.get (_active_sink_input) != _objp_role_phone)
+					update_active_sink_input.begin (sink_input.index);
+			}
+		}
+	}
+
+	private void remove_sink_input_from_list (uint32 index)
+	{
+		if (index in _sink_input_list) {
+			_sink_input_list.remove (index);
+			_sink_input_hash.unset (index);
+			if (index == _active_sink_input) {
+				if (_sink_input_list.size != 0)
+					update_active_sink_input.begin (_sink_input_list.get (0));
+				else
+					update_active_sink_input.begin (-1);
+			}
+		}
+	}
+
+	private void handle_new_sink_input_cb (Context c, SinkInputInfo? i, int eol)
+	{
+		if (i == null)
+			return;
+
+		add_sink_input_into_list (i);
+	}
+
+	private void handle_changed_sink_input_cb (Context c, SinkInputInfo? i, int eol)
+	{
+		if (i == null)
+			return;
+
+		if (i.index in _sink_input_list) {
+			/* Phone stream is always corked, so handle it differently */
+			if (i.corked == 1 && _sink_input_hash.get (i.index) != _objp_role_phone)
+				remove_sink_input_from_list (i.index);
+		} else {
+			if (i.corked == 0)
+				add_sink_input_into_list (i);
+		}
+	}
+
 	private void source_output_info_cb (Context c, SourceOutputInfo? i, int eol)
 	{
 		if (i == null)
@@ -184,9 +377,16 @@ public class VolumeControl : Object
 	{
 		switch (c.get_state ()) {
 			case Context.State.READY:
-				c.subscribe (PulseAudio.Context.SubscriptionMask.SINK |
-							 PulseAudio.Context.SubscriptionMask.SOURCE |
-							 PulseAudio.Context.SubscriptionMask.SOURCE_OUTPUT);
+				if (_pulse_use_stream_restore) {
+					c.subscribe (PulseAudio.Context.SubscriptionMask.SINK |
+							PulseAudio.Context.SubscriptionMask.SINK_INPUT |
+							PulseAudio.Context.SubscriptionMask.SOURCE |
+							PulseAudio.Context.SubscriptionMask.SOURCE_OUTPUT);
+				} else {
+					c.subscribe (PulseAudio.Context.SubscriptionMask.SINK |
+							PulseAudio.Context.SubscriptionMask.SOURCE |
+							PulseAudio.Context.SubscriptionMask.SOURCE_OUTPUT);
+				}
 				c.set_subscribe_callback (context_events_cb);
 				update_sink ();
 				update_source ();
@@ -226,6 +426,8 @@ public class VolumeControl : Object
 		props.sets (Proplist.PROP_APPLICATION_ICON_NAME, "multimedia-volume-control");
 		props.sets (Proplist.PROP_APPLICATION_VERSION, "0.1");
 
+		reconnect_pulse_dbus ();
+
 		this.context = new PulseAudio.Context (loop.get_api(), null, props);
 		this.context.set_state_callback (context_state_callback);
 
@@ -310,7 +512,8 @@ public class VolumeControl : Object
 		if (i == null)
 			return;
 
-		unowned CVolume cvol = vol_set (i.volume, 1, double_to_volume (_volume));
+		unowned CVolume cvol = i.volume;
+		cvol.scale (double_to_volume (_volume));
 		c.set_sink_volume_by_index (i.index, cvol, set_volume_success_cb);
 	}
 
@@ -325,6 +528,37 @@ public class VolumeControl : Object
 		context.get_sink_info_by_name (i.default_sink_name, sink_info_set_volume_cb);
 	}
 
+	private async void set_volume_active_role ()
+	{
+		string active_role_objp = _objp_role_alert;
+
+		if (_active_sink_input != -1 && _active_sink_input in _sink_input_list)
+			active_role_objp = _sink_input_hash.get (_active_sink_input);
+
+		try {
+			var builder = new VariantBuilder (new VariantType ("a(uu)"));
+			builder.add ("(uu)", 0, double_to_volume (_volume));
+			Variant volume = builder.end ();
+
+			/* Increase the signal counter so we can handle the callback */
+			lock (_pa_volume_sig_count) {
+				_pa_volume_sig_count++;
+			}
+
+			yield _pconn.call ("org.PulseAudio.Ext.StreamRestore1.RestoreEntry",
+					active_role_objp, "org.freedesktop.DBus.Properties", "Set",
+					new Variant ("(ssv)", "org.PulseAudio.Ext.StreamRestore1.RestoreEntry", "Volume", volume),
+					null, DBusCallFlags.NONE, -1);
+
+			volume_changed (_volume);
+		} catch (GLib.Error e) {
+			lock (_pa_volume_sig_count) {
+				_pa_volume_sig_count--;
+			}
+			warning ("unable to set volume for stream obj path %s (%s)", active_role_objp, e.message);
+		}
+	}
+
 	bool set_volume_internal (double volume)
 	{
 		if (context.get_state () != Context.State.READY)
@@ -332,7 +566,10 @@ public class VolumeControl : Object
 
 		if (_volume != volume) {
 			_volume = volume;
-			context.get_server_info (server_info_cb_for_set_volume);
+			if (_pulse_use_stream_restore)
+				set_volume_active_role.begin ();
+			else
+				context.get_server_info (server_info_cb_for_set_volume);
 			return true;
 		} else {
 			return false;
@@ -341,8 +578,21 @@ public class VolumeControl : Object
 
 	public void set_volume (double volume)
 	{
-		if (set_volume_internal (volume))
+		if (_volume == 0.0)
+			_notification.update ("Volume", "", "audio-volume-muted");
+		if (_volume > 0.0 && _volume <= 0.33)
+			_notification.update ("Volume", "", "audio-volume-low");
+		if (_volume > 0.33 && _volume <= 0.66)
+			_notification.update ("Volume", "", "audio-volume-medium");
+		if (_volume > 0.66 && _volume <= 1.0)
+			_notification.update ("Volume", "", "audio-volume-high");
+		_notification.set_hint ("value", _volume * 100.0);
+		_notification.set_hint ("sound-file", "/usr/share/sounds/ubuntu/stereo/message.ogg");
+		_notification.show ();			
+
+		if (set_volume_internal (volume)) {
 			start_local_volume_timer();
+		}
 	}
 
 	void set_mic_volume_success_cb (Context c, int success)
@@ -378,6 +628,85 @@ public class VolumeControl : Object
 		return _mic_volume;
 	}
 
+	/* PulseAudio Dbus (Stream Restore) logic */
+	private void reconnect_pulse_dbus ()
+	{
+		unowned string pulse_dbus_server_env = Environment.get_variable ("PULSE_DBUS_SERVER");
+		string address;
+
+		/* In case of a reconnect */
+		_pulse_use_stream_restore = false;
+		_pa_volume_sig_count = 0;
+
+		if (pulse_dbus_server_env != null) {
+			address = pulse_dbus_server_env;
+		} else {
+			DBusConnection conn;
+			Variant props;
+
+			try {
+				conn = Bus.get_sync (BusType.SESSION);
+			} catch (GLib.IOError e) {
+				warning ("unable to get the dbus session bus: %s", e.message);
+				return;
+			}
+
+			try {
+				var props_variant = conn.call_sync ("org.PulseAudio1",
+						"/org/pulseaudio/server_lookup1", "org.freedesktop.DBus.Properties",
+						"Get", new Variant ("(ss)", "org.PulseAudio.ServerLookup1", "Address"),
+						null, DBusCallFlags.NONE, -1);
+				props_variant.get ("(v)", out props);
+				address = props.get_string ();
+			} catch (GLib.Error e) {
+				warning ("unable to get pulse unix socket: %s", e.message);
+				return;
+			}
+		}
+
+		stdout.printf ("PulseAudio dbus unix socket: %s\n", address);
+		try {
+			_pconn = new DBusConnection.for_address_sync (address, DBusConnectionFlags.AUTHENTICATION_CLIENT);
+		} catch (GLib.Error e) {
+			/* If it fails, it means the dbus pulse extension is not available */
+			return;
+		}
+
+		/* For pulse dbus related events */
+		_pconn.add_filter (pulse_dbus_filter);
+
+		/* Check if the 4 currently supported media roles are already available in StreamRestore
+		 * Roles: multimedia, alert, alarm and phone */
+		_objp_role_multimedia = stream_restore_get_object_path ("sink-input-by-media-role:multimedia");
+		_objp_role_alert = stream_restore_get_object_path ("sink-input-by-media-role:alert");
+		_objp_role_alarm = stream_restore_get_object_path ("sink-input-by-media-role:alarm");
+		_objp_role_phone = stream_restore_get_object_path ("sink-input-by-media-role:phone");
+
+		/* Only use stream restore if every used role is available */
+		if (_objp_role_multimedia != null && _objp_role_alert != null && _objp_role_alarm != null && _objp_role_phone != null) {
+			stdout.printf ("Using PulseAudio DBUS Stream Restore module\n");
+			/* Restore volume and update default entry */
+			update_active_sink_input.begin (-1);
+			_pulse_use_stream_restore = true;
+		}
+	}
+
+	private string? stream_restore_get_object_path (string name) {
+		string? objp = null;
+		try {
+			Variant props_variant = _pconn.call_sync ("org.PulseAudio.Ext.StreamRestore1",
+					"/org/pulseaudio/stream_restore1", "org.PulseAudio.Ext.StreamRestore1",
+					"GetEntryByName", new Variant ("(s)", name), null, DBusCallFlags.NONE, -1);
+			/* Workaround for older versions of vala that don't provide get_objv */
+			VariantIter iter = props_variant.iterator ();
+			iter.next ("o", &objp);
+			stdout.printf ("Found obj path %s for restore data named %s\n", objp, name);
+		} catch (GLib.Error e) {
+			warning ("unable to find stream restore data for: %s", name);
+		}
+		return objp;
+	}
+
 	/* AccountsService operations */
 	private void accountsservice_props_changed_cb (DBusProxy proxy, Variant changed_properties, string[] invalidated_properties)
 	{