aboutsummaryrefslogtreecommitdiff
path: root/src/volume-warning.vala
blob: 8e38e6142af746b469c5607867b5a3ef4e5bbe60 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
/*
 * -*- Mode:Vala; indent-tabs-mode:t; tab-width:4; encoding:utf8 -*-
 * Copyright 2013 Canonical Ltd.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authors:
 *      Alberto Ruiz <alberto.ruiz@canonical.com>
 */

using PulseAudio;
using Notify;

public class VolumeWarning : Object
{
	// true if headphones are currently in use
	public bool headphones_active { get; set; default = false; }

	// true if the warning dialog is currently active
	public bool active { get; protected set; default = false; }

	// true if we're playing unapproved loud multimedia over headphones
	public bool high_volume { get; protected set; default = false; }

	public enum Key {
		VOLUME_UP,
		VOLUME_DOWN
	}

	public void user_keypress(Key key) {
		if ((key == Key.VOLUME_DOWN) && active) {
			_notification.close();
			on_user_response(IndicatorSound.WarnNotification.Response.CANCEL);
		}
	}

	public VolumeWarning (IndicatorSound.Options options, PulseAudio.GLibMainLoop pgloop) {
		_options = options;
		_pgloop = pgloop;

		init_all_properties();

		pulse_start();

		_notification = new IndicatorSound.WarnNotification();
		_notification.user_responded.connect((n, response) => on_user_response(response));
	}

	/***
	****
	***/

	// true if the user has approved high volumes recently
	protected bool high_volume_approved { get; set; default = false; }

	// true if multimedia is currently playing
	protected bool multimedia_active { get; set; default = false; }

	/* Cached value of what pulse says the multimedia volume is.
	   This is a PulseAudio.Volume but typed as uint to unconfuse valac.
	   Setting this only updates the cache --
	   to actually change the volume, use set_multimedia_volume(). */
	protected uint cached_multimedia_volume { get; set; default = PulseAudio.Volume.INVALID; }

	protected virtual void set_multimedia_volume(PulseAudio.Volume volume) {
		pulse_set_sink_input_volume(volume);
	}

	/***
	****
	***/

	// FIXME: what to do with this now?
	private bool   _ignore_warning_this_time = false;

	private IndicatorSound.Options _options;

	private void init_all_properties()
	{
		init_high_volume();
		init_high_volume_approved();
	}

	~VolumeWarning ()
	{
		stop_all_timers();

		pulse_stop();
	}

	private void stop_all_timers()
	{
		stop_high_volume_approved_timer();
	}

	/***
	****  PulseAudio: Tracking which sink input (if any) is active multimedia
	***/

	private unowned PulseAudio.GLibMainLoop _pgloop = null;
	private PulseAudio.Context _pulse_context = null;
	private uint _pulse_reconnect_timer = 0;
	private uint32 _multimedia_sink_input_index = PulseAudio.INVALID_INDEX;
	private uint32 _warning_sink_input_index = PulseAudio.INVALID_INDEX;
	private unowned PulseAudio.CVolume _multimedia_cvolume;

	private bool is_active_multimedia (SinkInputInfo i)
	{
		if (i.corked != 0)
			return false;

		var media_role = i.proplist.gets(PulseAudio.Proplist.PROP_MEDIA_ROLE);
		if (media_role != "multimedia")
			return false;

		return true;
	}

	private void pulse_on_sink_input_info (Context c, SinkInputInfo? i, int eol)
	{
		if (i == null)
			return;

		if (is_active_multimedia(i)) {
			GLib.message("pulse_on_sink_input_info() setting multimedia index to %d, volume to %d", (int)i.index, (int)i.volume.max());
			_multimedia_sink_input_index = i.index;
			_multimedia_cvolume = i.volume;
			cached_multimedia_volume = i.volume.max();
			multimedia_active = true;
		}
		else if (i.index == _multimedia_sink_input_index) {
			_multimedia_sink_input_index = PulseAudio.INVALID_INDEX;
			cached_multimedia_volume = PulseAudio.Volume.INVALID;
			multimedia_active = false;
		}
	}

	private void pulse_update_sink_inputs()
	{
		_pulse_context.get_sink_input_info_list (pulse_on_sink_input_info);
	}


	private void context_events_cb (Context c, Context.SubscriptionEventType t, uint32 index)
	{
		if ((t & Context.SubscriptionEventType.FACILITY_MASK) != Context.SubscriptionEventType.SINK_INPUT)
			return;

		switch (t & Context.SubscriptionEventType.TYPE_MASK)
		{
			case Context.SubscriptionEventType.NEW:
			case Context.SubscriptionEventType.CHANGE:
				GLib.message("-> Context.SubscriptionEventType.CHANGE or NEW");
				c.get_sink_input_info(index, pulse_on_sink_input_info);
				break;
			case Context.SubscriptionEventType.REMOVE:
				GLib.message("-> Context.SubscriptionEventType.REMOVE");
				pulse_update_sink_inputs();
				break;
			default:
				GLib.debug("Sink input event not known.");
				break;
		}
	}

	private void pulse_context_state_callback (Context c)
	{
		switch (c.get_state ()) {
			case Context.State.READY:
				c.subscribe (PulseAudio.Context.SubscriptionMask.SINK_INPUT);
				c.set_subscribe_callback (context_events_cb);
				pulse_update_sink_inputs();
                                break;

                        case Context.State.FAILED:
                        case Context.State.TERMINATED:
				pulse_reconnect_soon();
                                break;

                        default:
                                break;
                }
        }

	private void pulse_disconnect()
	{
                if (_pulse_context != null) {
                        _pulse_context.disconnect ();
                        _pulse_context = null;
                }
	}

	private void pulse_reconnect_soon ()
	{
		if (_pulse_reconnect_timer == 0)
			_pulse_reconnect_timer = Timeout.add_seconds (2, pulse_reconnect_timeout);
	}

        private void pulse_reconnect_soon_cancel()
	{
                if (_pulse_reconnect_timer != 0) {
                        Source.remove(_pulse_reconnect_timer);
                        _pulse_reconnect_timer = 0;
                }
        }

        private bool pulse_reconnect_timeout ()
        {
                _pulse_reconnect_timer = 0;
                pulse_reconnect ();
                return false; // G_SOURCE_REMOVE
        }

        void pulse_reconnect ()
        {
		pulse_disconnect();

                var props = new Proplist ();
                props.sets (Proplist.PROP_APPLICATION_NAME, "Ubuntu Audio Settings");
                props.sets (Proplist.PROP_APPLICATION_ID, "com.canonical.settings.sound");
                props.sets (Proplist.PROP_APPLICATION_ICON_NAME, "multimedia-volume-control");
                props.sets (Proplist.PROP_APPLICATION_VERSION, "0.1");

                _pulse_context = new PulseAudio.Context (_pgloop.get_api(), null, props);
                _pulse_context.set_state_callback (pulse_context_state_callback);

                var server_string = Environment.get_variable("PULSE_SERVER");
                if (_pulse_context.connect(server_string, Context.Flags.NOFAIL, null) < 0)
                        warning( "pa_context_connect() failed: %s\n", PulseAudio.strerror(_pulse_context.errno()));
        }

	///

	void pulse_set_sink_input_volume(PulseAudio.Volume volume)
	{
		var index = _warning_sink_input_index;

		GLib.return_if_fail(_pulse_context != null);
		GLib.return_if_fail(index != PulseAudio.INVALID_INDEX);
		GLib.return_if_fail(volume != PulseAudio.Volume.INVALID);

		unowned CVolume cvol = CVolume();
		cvol.set(_multimedia_cvolume.channels, volume);
		GLib.message("setting multimedia volume to %s", cvol.to_string());
		_pulse_context.set_sink_input_volume(index, cvol, null);
	}

	///

	private void pulse_start()
	{
		pulse_reconnect();
	}

	private void pulse_stop()
	{
		pulse_reconnect_soon_cancel();
		pulse_disconnect();
	}


	/** HIGH VOLUME PROPERTY **/

	public bool ignore_high_volume {
		get {
			if (_ignore_warning_this_time) {
				warning("Ignore");
				_ignore_warning_this_time = false;
				return true;
			}
			return false;
		}
		set { }
	}
	private void init_high_volume() {
		_options.loud_changed.connect(() => update_high_volume());
		this.notify["cached-multimedia-volume"].connect(() => {
			GLib.message("recalculating high-volume due to cached-multimedia-volume change");
			this.update_high_volume();
		});
		this.notify["multimedia-active"].connect(() => {
			GLib.message("recalculating high-volume due to multimedia-active change");
			this.update_high_volume();
		});
		this.notify["headphones-active"].connect(() => {
			GLib.message("recalculating high-volume due to headphones-active change");
			this.update_high_volume();
		});
		notify["high-volume-approved"].connect(() => update_high_volume());
		update_high_volume();
	}
	private void update_high_volume() {
		PulseAudio.Volume mm_vol = cached_multimedia_volume;
		var approved = high_volume_approved;
		var hp_active = headphones_active;
		var mm_active = multimedia_active;
		GLib.message("calculating high volume... headphones_active %d high_volume_approved %d multimedia_active %d multimedia_volume %d is_invalid %d, is_loud %d", (int)hp_active, (int)approved, (int)mm_active, (int)mm_vol, (int)(mm_vol == PulseAudio.Volume.INVALID), (int)_options.is_loud_pulse(mm_vol));
		var new_high_volume = hp_active && !approved && mm_active && (mm_vol != PulseAudio.Volume.INVALID) && _options.is_loud_pulse(mm_vol);
		GLib.message("so the new high_volume is %d, was %d", (int)new_high_volume, (int)high_volume);
		if (high_volume != new_high_volume) {
			debug("changing high_volume from %d to %d", (int)high_volume, (int)new_high_volume);
			if (new_high_volume && !active)
				show();
			high_volume = new_high_volume;
		}
	}

	/** HIGH VOLUME APPROVED PROPERTY **/

	private Settings _settings = new Settings ("com.canonical.indicator.sound");

	private void approve_high_volume() {
		_high_volume_approved_at = GLib.get_monotonic_time();
		update_high_volume_approved();
		update_high_volume_approved_timer();
	}

	private uint _high_volume_approved_timer = 0;
	private int64 _high_volume_approved_at = 0;
	private int64 _high_volume_approved_ttl_usec = 0;
	private void init_high_volume_approved() {
		_settings.changed["warning-volume-confirmation-ttl"].connect(() => update_high_volume_approved_cache());
		update_high_volume_approved_cache();
	}
	private void update_high_volume_approved_cache() {
		_high_volume_approved_ttl_usec = _settings.get_int("warning-volume-confirmation-ttl");
		_high_volume_approved_ttl_usec *= 1000000;

		update_high_volume_approved();
		update_high_volume_approved_timer();
	}
	private void update_high_volume_approved_timer() {
		stop_high_volume_approved_timer();
		if (_high_volume_approved_at != 0) {
			int64 expires_at = _high_volume_approved_at + _high_volume_approved_ttl_usec;
			int64 now = GLib.get_monotonic_time();
			if (expires_at > now) {
				var seconds_left = 1 + ((expires_at - now) / 1000000);
				_high_volume_approved_timer = Timeout.add_seconds((uint)seconds_left, on_high_volume_approved_timer);
			}
		}
	}
	private void stop_high_volume_approved_timer() {
		if (_high_volume_approved_timer != 0) {
			Source.remove (_high_volume_approved_timer);
			_high_volume_approved_timer = 0;
		}
	}
	private bool on_high_volume_approved_timer() {
		_high_volume_approved_timer = 0;
		update_high_volume_approved();
		return false; /* Source.REMOVE */
	}
	private void update_high_volume_approved() {
		var new_high_volume_approved = calculate_high_volume_approved();
		if (high_volume_approved != new_high_volume_approved) {
			debug("changing high_volume_approved from %d to %d", (int)high_volume_approved, (int)new_high_volume_approved);
			high_volume_approved = new_high_volume_approved;
		}
	}
	private bool calculate_high_volume_approved() {
		int64 now = GLib.get_monotonic_time();
		return (_high_volume_approved_at != 0)
			&& (_high_volume_approved_at + _high_volume_approved_ttl_usec >= now);
	}

	// NOTIFICATION

	private IndicatorSound.WarnNotification _notification = new IndicatorSound.WarnNotification();

	private PulseAudio.Volume _ok_volume = PulseAudio.Volume.INVALID;

	protected virtual void preshow() {
		_warning_sink_input_index = _multimedia_sink_input_index;
	}

	private void show() {
		preshow();
		_ok_volume = cached_multimedia_volume;

		_notification.show();
		this.active = true;

		// lower the volume to just under the warning level
		set_multimedia_volume (_options.loud_volume()-1);
	}

	private void on_user_response(IndicatorSound.WarnNotification.Response response) {

		this.active = false;

		if (response == IndicatorSound.WarnNotification.Response.OK) {
			approve_high_volume();
			set_multimedia_volume(_ok_volume);
		}

		_ok_volume = PulseAudio.Volume.INVALID;
	}
}