chiark / gitweb /
uaudio_apis[] is a constant
[disorder] / disobedience / control.c
CommitLineData
460b9539 1/*
2 * This file is part of DisOrder.
3849817f 3 * Copyright (C) 2006-2008 Richard Kettlewell
460b9539 4 *
e7eb3a27 5 * This program is free software: you can redistribute it and/or modify
460b9539 6 * it under the terms of the GNU General Public License as published by
e7eb3a27 7 * the Free Software Foundation, either version 3 of the License, or
460b9539 8 * (at your option) any later version.
9 *
e7eb3a27
RK
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
460b9539 15 * You should have received a copy of the GNU General Public License
e7eb3a27 16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
460b9539 17 */
219dc95c
RK
18/** @file disobedience/control.c
19 * @brief Volume control and buttons
20 */
460b9539 21
22#include "disobedience.h"
321f7536 23#include "mixer.h"
460b9539 24
e9b70a84 25/* Forward declarations ---------------------------------------------------- */
26
460b9539 27struct icon;
28
460b9539 29static void clicked_icon(GtkButton *, gpointer);
ac6bf2ba 30static void clicked_menu(GtkMenuItem *, gpointer userdata);
2d504956 31static void toggled_menu(GtkCheckMenuItem *, gpointer userdata);
460b9539 32
a99c4e9a
RK
33static int enable_rtp(disorder_eclient *c,
34 disorder_eclient_no_response *completed,
35 void *v);
36static int disable_rtp(disorder_eclient *c,
37 disorder_eclient_no_response *completed,
38 void *v);
39
460b9539 40static double left(double v, double b);
41static double right(double v, double b);
42static double volume(double l, double r);
43static double balance(double l, double r);
44
45static void volume_adjusted(GtkAdjustment *a, gpointer user_data);
46static gchar *format_volume(GtkScale *scale, gdouble value);
47static gchar *format_balance(GtkScale *scale, gdouble value);
48
6856f665
RK
49static void icon_changed(const char *event,
50 void *evendata,
51 void *callbackdata);
1f868ca3
RK
52static void volume_changed(const char *event,
53 void *eventdata,
54 void *callbackdata);
55
460b9539 56/* Control bar ------------------------------------------------------------- */
57
fb44b59e
RK
58/** @brief Guard against feedback */
59int suppress_actions = 1;
460b9539 60
219dc95c
RK
61/** @brief Definition of an icon
62 *
3849817f
RK
63 * We have two kinds of icon:
64 * - action icons, which just do something but don't have a state as such
65 * - toggle icons, which toggle between two states ("on" and "off").
66 *
67 * The scratch button is an action icon; currently all the others are toggle
68 * icons.
69 *
70 * (All icons can be sensitive or insensitive, separately to the above.)
219dc95c
RK
71 */
72struct icon {
3849817f
RK
73 /** @brief Filename for 'on' image */
74 const char *icon_on;
75
76 /** @brief Text for 'on' tooltip */
77 const char *tip_on;
219dc95c 78
3849817f
RK
79 /** @brief Filename for 'off' image or NULL for an action icon */
80 const char *icon_off;
81
82 /** @brief Text for 'off tooltip */
83 const char *tip_off;
219dc95c 84
ac6bf2ba
RK
85 /** @brief Associated menu item or NULL */
86 const char *menuitem;
219dc95c 87
6856f665
RK
88 /** @brief Events that change this icon, separated by spaces */
89 const char *events;
90
3849817f
RK
91 /** @brief @ref eclient.h function to call to go from off to on
92 *
93 * For action buttons, this should be NULL.
94 */
95 int (*action_go_on)(disorder_eclient *c,
96 disorder_eclient_no_response *completed,
97 void *v);
219dc95c 98
3849817f
RK
99 /** @brief @ref eclient.h function to call to go from on to off
100 *
101 * For action buttons, this action is used.
102 */
103 int (*action_go_off)(disorder_eclient *c,
104 disorder_eclient_no_response *completed,
105 void *v);
219dc95c 106
3849817f
RK
107 /** @brief Get button state
108 * @return 1 for on, 0 for off
109 */
110 int (*on)(void);
111
112 /** @brief Get button sensitivity
113 * @return 1 for sensitive, 0 for insensitive
114 *
115 * Can be NULL for always sensitive.
116 */
117 int (*sensitive)(void);
2d504956 118
219dc95c 119 /** @brief Pointer to button */
460b9539 120 GtkWidget *button;
ac6bf2ba
RK
121
122 /** @brief Pointer to menu item */
123 GtkWidget *item;
3849817f
RK
124
125 GtkWidget *image_on;
126 GtkWidget *image_off;
219dc95c
RK
127};
128
3849817f
RK
129static int pause_resume_on(void) {
130 return !(last_state & DISORDER_TRACK_PAUSED);
131}
132
133static int pause_resume_sensitive(void) {
6f09d54d
RK
134 return !!(last_state & DISORDER_PLAYING)
135 && (last_rights & RIGHT_PAUSE);
3849817f
RK
136}
137
138static int scratch_sensitive(void) {
6f09d54d 139 return !!(last_state & DISORDER_PLAYING)
afe9f743 140 && right_scratchable(last_rights, config->username, playing_track);
6f09d54d
RK
141}
142
143static int random_sensitive(void) {
144 return !!(last_rights & RIGHT_GLOBAL_PREFS);
3849817f
RK
145}
146
147static int random_enabled(void) {
148 return !!(last_state & DISORDER_RANDOM_ENABLED);
149}
150
6f09d54d
RK
151static int playing_sensitive(void) {
152 return !!(last_rights & RIGHT_GLOBAL_PREFS);
153}
154
3849817f
RK
155static int playing_enabled(void) {
156 return !!(last_state & DISORDER_PLAYING_ENABLED);
157}
2d504956 158
3849817f
RK
159static int rtp_enabled(void) {
160 return rtp_is_running;
161}
162
163static int rtp_sensitive(void) {
164 return rtp_supported;
165}
2d504956 166
219dc95c
RK
167/** @brief Table of all icons */
168static struct icon icons[] = {
2d504956 169 {
5c739b23 170 icon_on: "pause32.png",
3849817f 171 tip_on: "Pause playing track",
5c739b23 172 icon_off: "play32.png",
3849817f
RK
173 tip_off: "Resume playing track",
174 menuitem: "<GdisorderMain>/Control/Playing",
175 on: pause_resume_on,
176 sensitive: pause_resume_sensitive,
177 action_go_on: disorder_eclient_resume,
178 action_go_off: disorder_eclient_pause,
6856f665 179 events: "pause-changed playing-changed rights-changed",
2d504956
RK
180 },
181 {
5c739b23 182 icon_on: "cross32.png",
3849817f
RK
183 tip_on: "Cancel playing track",
184 menuitem: "<GdisorderMain>/Control/Scratch",
185 sensitive: scratch_sensitive,
186 action_go_off: disorder_eclient_scratch_playing,
6856f665 187 events: "playing-track-changed rights-changed",
2d504956
RK
188 },
189 {
5c739b23 190 icon_on: "randomenabled32.png",
3849817f 191 tip_on: "Disable random play",
5c739b23 192 icon_off: "randomdisabled32.png",
3849817f
RK
193 tip_off: "Enable random play",
194 menuitem: "<GdisorderMain>/Control/Random play",
195 on: random_enabled,
6f09d54d 196 sensitive: random_sensitive,
3849817f
RK
197 action_go_on: disorder_eclient_random_enable,
198 action_go_off: disorder_eclient_random_disable,
6856f665 199 events: "random-changed rights-changed",
2d504956
RK
200 },
201 {
5c739b23 202 icon_on: "playenabled32.png",
3849817f 203 tip_on: "Disable play",
5c739b23 204 icon_off: "playdisabled32.png",
3849817f
RK
205 tip_off: "Enable play",
206 on: playing_enabled,
6f09d54d 207 sensitive: playing_sensitive,
3849817f
RK
208 action_go_on: disorder_eclient_enable,
209 action_go_off: disorder_eclient_disable,
6856f665 210 events: "enabled-changed rights-changed",
2d504956
RK
211 },
212 {
5c739b23 213 icon_on: "rtpenabled32.png",
3849817f 214 tip_on: "Stop playing network stream",
5c739b23 215 icon_off: "rtpdisabled32.png",
3849817f
RK
216 tip_off: "Play network stream",
217 menuitem: "<GdisorderMain>/Control/Network player",
218 on: rtp_enabled,
219 sensitive: rtp_sensitive,
220 action_go_on: enable_rtp,
6856f665
RK
221 action_go_off: disable_rtp,
222 events: "rtp-changed",
2d504956 223 },
460b9539 224};
219dc95c
RK
225
226/** @brief Count of icons */
460b9539 227#define NICONS (int)(sizeof icons / sizeof *icons)
228
219dc95c
RK
229static GtkAdjustment *volume_adj;
230static GtkAdjustment *balance_adj;
3c499fe7
RK
231static GtkWidget *volume_widget;
232static GtkWidget *balance_widget;
460b9539 233
219dc95c 234/** @brief Create the control bar */
e9b70a84 235GtkWidget *control_widget(void) {
460b9539 236 GtkWidget *hbox = gtk_hbox_new(FALSE, 1), *vbox;
460b9539 237 int n;
238
239 D(("control_widget"));
ac6bf2ba 240 assert(mainmenufactory); /* ordering must be right */
460b9539 241 for(n = 0; n < NICONS; ++n) {
3849817f 242 /* Create the button */
3849817f
RK
243 icons[n].button = gtk_button_new();
244 gtk_widget_set_style(icons[n].button, tool_style);
245 icons[n].image_on = gtk_image_new_from_pixbuf(find_image(icons[n].icon_on));
246 gtk_widget_set_style(icons[n].image_on, tool_style);
247 g_object_ref(icons[n].image_on);
248 /* If it's a toggle icon, create the 'off' half too */
249 if(icons[n].icon_off) {
250 icons[n].image_off = gtk_image_new_from_pixbuf(find_image(icons[n].icon_off));
251 gtk_widget_set_style(icons[n].image_off, tool_style);
252 g_object_ref(icons[n].image_off);
253 }
460b9539 254 g_signal_connect(G_OBJECT(icons[n].button), "clicked",
ac6bf2ba 255 G_CALLBACK(clicked_icon), &icons[n]);
460b9539 256 /* pop the icon in a vbox so it doesn't get vertically stretch if there are
257 * taller things in the control bar */
258 vbox = gtk_vbox_new(FALSE, 0);
259 gtk_box_pack_start(GTK_BOX(vbox), icons[n].button, TRUE, FALSE, 0);
260 gtk_box_pack_start(GTK_BOX(hbox), vbox, FALSE, FALSE, 0);
ac6bf2ba 261 if(icons[n].menuitem) {
3849817f 262 /* Find the menu item */
ac6bf2ba
RK
263 icons[n].item = gtk_item_factory_get_widget(mainmenufactory,
264 icons[n].menuitem);
3849817f 265 if(icons[n].icon_off)
2d504956
RK
266 g_signal_connect(G_OBJECT(icons[n].item), "toggled",
267 G_CALLBACK(toggled_menu), &icons[n]);
3849817f 268 else
2d504956
RK
269 g_signal_connect(G_OBJECT(icons[n].item), "activate",
270 G_CALLBACK(clicked_menu), &icons[n]);
ac6bf2ba 271 }
6856f665
RK
272 /* Make sure the icon is updated when relevant things changed */
273 char **events = split(icons[n].events, 0, 0, 0, 0);
274 while(*events)
275 event_register(*events++, icon_changed, &icons[n]);
f513e538 276 event_register("connected-changed", icon_changed, &icons[n]);
460b9539 277 }
278 /* create the adjustments for the volume control */
279 volume_adj = GTK_ADJUSTMENT(gtk_adjustment_new(0, 0, goesupto,
280 goesupto / 20, goesupto / 20,
281 0));
282 balance_adj = GTK_ADJUSTMENT(gtk_adjustment_new(0, -1, 1,
283 0.2, 0.2, 0));
284 /* the volume control */
3c499fe7 285 volume_widget = gtk_hscale_new(volume_adj);
3c499fe7
RK
286 balance_widget = gtk_hscale_new(balance_adj);
287 gtk_widget_set_style(volume_widget, tool_style);
288 gtk_widget_set_style(balance_widget, tool_style);
289 gtk_scale_set_digits(GTK_SCALE(volume_widget), 10);
290 gtk_scale_set_digits(GTK_SCALE(balance_widget), 10);
291 gtk_widget_set_size_request(volume_widget, 192, -1);
292 gtk_widget_set_size_request(balance_widget, 192, -1);
293 gtk_tooltips_set_tip(tips, volume_widget, "Volume", "");
294 gtk_tooltips_set_tip(tips, balance_widget, "Balance", "");
295 gtk_box_pack_start(GTK_BOX(hbox), volume_widget, FALSE, TRUE, 0);
296 gtk_box_pack_start(GTK_BOX(hbox), balance_widget, FALSE, TRUE, 0);
460b9539 297 /* space updates rather than hammering the server */
3c499fe7
RK
298 gtk_range_set_update_policy(GTK_RANGE(volume_widget), GTK_UPDATE_DELAYED);
299 gtk_range_set_update_policy(GTK_RANGE(balance_widget), GTK_UPDATE_DELAYED);
460b9539 300 /* notice when the adjustments are changed */
301 g_signal_connect(G_OBJECT(volume_adj), "value-changed",
302 G_CALLBACK(volume_adjusted), 0);
303 g_signal_connect(G_OBJECT(balance_adj), "value-changed",
304 G_CALLBACK(volume_adjusted), 0);
305 /* format the volume/balance values ourselves */
3c499fe7 306 g_signal_connect(G_OBJECT(volume_widget), "format-value",
460b9539 307 G_CALLBACK(format_volume), 0);
3c499fe7 308 g_signal_connect(G_OBJECT(balance_widget), "format-value",
460b9539 309 G_CALLBACK(format_balance), 0);
1f868ca3 310 event_register("volume-changed", volume_changed, 0);
6856f665 311 event_register("rtp-changed", volume_changed, 0);
460b9539 312 return hbox;
313}
314
6d1302f0 315/** @brief Update the volume control when it changes */
1f868ca3
RK
316static void volume_changed(const char attribute((unused)) *event,
317 void attribute((unused)) *eventdata,
318 void attribute((unused)) *callbackdata) {
460b9539 319 double l, r;
6856f665 320 gboolean volume_supported;
460b9539 321
1f868ca3 322 D(("volume_changed"));
fb44b59e 323 ++suppress_actions;
6856f665
RK
324 /* Only display volume/balance controls if they will work */
325 if(!rtp_supported
326 || (rtp_supported && mixer_supported(DEFAULT_BACKEND)))
327 volume_supported = TRUE;
328 else
329 volume_supported = FALSE;
330 /* TODO: if the server doesn't know how to set the volume [but isn't using
331 * network play] then we should have volume_supported = FALSE */
332 if(volume_supported) {
333 gtk_widget_show(volume_widget);
334 gtk_widget_show(balance_widget);
335 l = volume_l / 100.0;
336 r = volume_r / 100.0;
337 gtk_adjustment_set_value(volume_adj, volume(l, r) * goesupto);
338 gtk_adjustment_set_value(balance_adj, balance(l, r));
339 } else {
340 gtk_widget_hide(volume_widget);
341 gtk_widget_hide(balance_widget);
342 }
fb44b59e 343 --suppress_actions;
460b9539 344}
345
ad58ebcc 346/** @brief Update the state of one of the control icons
ad58ebcc 347 */
6856f665
RK
348static void icon_changed(const char attribute((unused)) *event,
349 void attribute((unused)) *evendata,
350 void *callbackdata) {
00e0c652 351 //fprintf(stderr, "icon_changed (%s)\n", event);
6856f665 352 const struct icon *const icon = callbackdata;
3849817f
RK
353 int on = icon->on ? icon->on() : 1;
354 int sensitive = icon->sensitive ? icon->sensitive() : 1;
00e0c652 355 //fprintf(stderr, "sensitive->%d\n", sensitive);
3849817f
RK
356 GtkWidget *child, *newchild;
357
358 ++suppress_actions;
ad58ebcc 359 /* If the connection is down nothing is ever usable */
00959300 360 if(!(last_state & DISORDER_CONNECTED))
3849817f 361 sensitive = 0;
00e0c652 362 //fprintf(stderr, "(checked connected) sensitive->%d\n", sensitive);
3849817f
RK
363 /* Replace the child */
364 newchild = on ? icon->image_on : icon->image_off;
365 child = gtk_bin_get_child(GTK_BIN(icon->button));
366 if(child != newchild) {
367 if(child)
368 gtk_container_remove(GTK_CONTAINER(icon->button), child);
369 gtk_container_add(GTK_CONTAINER(icon->button), newchild);
370 gtk_widget_show(newchild);
371 }
7392b131
RK
372 /* If you disable play or random play NOT via the icon (for instance, via the
373 * edit menu or via a completely separate command line invocation) then the
00e0c652 374 * icon shows up as insensitive. Hover the mouse over it and the correct
7392b131
RK
375 * state is immediately displayed. sensitive and GTK_WIDGET_SENSITIVE show
376 * it to be in the correct state, so I think this is may be a GTK+ bug. */
3849817f
RK
377 if(icon->tip_on)
378 gtk_tooltips_set_tip(tips, icon->button,
379 on ? icon->tip_on : icon->tip_off, "");
380 gtk_widget_set_sensitive(icon->button, sensitive);
381 /* Icons with an associated menu item */
ac6bf2ba 382 if(icon->item) {
3849817f
RK
383 if(icon->icon_off)
384 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(icon->item), on);
385 gtk_widget_set_sensitive(icon->item, sensitive);
ac6bf2ba 386 }
3849817f 387 --suppress_actions;
a99c4e9a
RK
388}
389
53fa91bb 390static void icon_action_completed(void attribute((unused)) *v,
abf99697
RK
391 const char *err) {
392 if(err)
393 popup_protocol_error(0, err);
53fa91bb
RK
394}
395
460b9539 396static void clicked_icon(GtkButton attribute((unused)) *button,
397 gpointer userdata) {
398 const struct icon *icon = userdata;
399
3849817f
RK
400 if(suppress_actions)
401 return;
402 if(!icon->on || icon->on())
403 icon->action_go_off(client, icon_action_completed, 0);
404 else
405 icon->action_go_on(client, icon_action_completed, 0);
460b9539 406}
407
ac6bf2ba
RK
408static void clicked_menu(GtkMenuItem attribute((unused)) *menuitem,
409 gpointer userdata) {
3849817f 410 clicked_icon(NULL, userdata);
ac6bf2ba
RK
411}
412
3849817f 413static void toggled_menu(GtkCheckMenuItem attribute((unused)) *menuitem,
2d504956 414 gpointer userdata) {
3849817f 415 clicked_icon(NULL, userdata);
2d504956
RK
416}
417
699517af
RK
418/** @brief Called when a volume command completes */
419static void volume_completed(void attribute((unused)) *v,
abf99697 420 const char *err,
699517af
RK
421 int attribute((unused)) l,
422 int attribute((unused)) r) {
abf99697
RK
423 if(err)
424 popup_protocol_error(0, err);
699517af
RK
425 /* We don't set the UI's notion of the volume here, it is set from the log
426 * regardless of the reason it changed */
427}
428
219dc95c 429/** @brief Called when the volume has been adjusted */
460b9539 430static void volume_adjusted(GtkAdjustment attribute((unused)) *a,
431 gpointer attribute((unused)) user_data) {
432 double v = gtk_adjustment_get_value(volume_adj) / goesupto;
433 double b = gtk_adjustment_get_value(balance_adj);
434
fb44b59e 435 if(suppress_actions)
460b9539 436 /* This is the result of an update from the server, not a change from the
437 * user. Don't feedback! */
438 return;
439 D(("volume_adjusted"));
440 /* force to 'stereotypical' values */
441 v = nearbyint(100 * v) / 100;
442 b = nearbyint(5 * b) / 5;
443 /* Set the volume. We don't want a reply, we'll get the actual new volume
444 * from the log. */
321f7536
RK
445 if(rtp_supported) {
446 int l = nearbyint(left(v, b) * 100), r = nearbyint(right(v, b) * 100);
3c499fe7 447 mixer_control(DEFAULT_BACKEND, &l, &r, 1);
321f7536 448 } else
699517af 449 disorder_eclient_volume(client, volume_completed,
321f7536
RK
450 nearbyint(left(v, b) * 100),
451 nearbyint(right(v, b) * 100),
452 0);
460b9539 453}
454
219dc95c 455/** @brief Formats the volume value */
460b9539 456static gchar *format_volume(GtkScale attribute((unused)) *scale,
457 gdouble value) {
458 char s[32];
459
460 snprintf(s, sizeof s, "%.1f", (double)value);
2fc4475d 461 return g_strdup(s);
460b9539 462}
463
219dc95c 464/** @brief Formats the balance value */
460b9539 465static gchar *format_balance(GtkScale attribute((unused)) *scale,
466 gdouble value) {
467 char s[32];
468
469 if(fabs(value) < 0.1)
2fc4475d 470 return g_strdup("0");
460b9539 471 snprintf(s, sizeof s, "%+.1f", (double)value);
2fc4475d 472 return g_strdup(s);
460b9539 473}
474
475/* Volume mapping. We consider left, right, volume to be in [0,1]
476 * and balance to be in [-1,1].
477 *
478 * First, we just have volume = max(left, right).
479 *
480 * Balance we consider to linearly represent the amount by which the quieter
481 * channel differs from the louder. In detail:
482 *
483 * if right > left then balance > 0:
484 * balance = 0 => left = right (as an endpoint, not an instance)
485 * balance = 1 => left = 0
486 * fitting to linear, left = right * (1 - balance)
487 * so balance = 1 - left / right
488 * (right > left => right > 0 so no division by 0.)
489 *
490 * if left > right then balance < 0:
491 * balance = 0 => right = left (same caveat as above)
492 * balance = -1 => right = 0
493 * again fitting to linear, right = left * (1 + balance)
494 * so balance = right / left - 1
495 * (left > right => left > 0 so no division by 0.)
496 *
497 * if left = right then we just have balance = 0.
498 *
499 * Thanks to Clive and Andrew.
500 */
501
219dc95c 502/** @brief Return the greater of @p x and @p y */
460b9539 503static double max(double x, double y) {
504 return x > y ? x : y;
505}
506
219dc95c 507/** @brief Compute the left channel volume */
460b9539 508static double left(double v, double b) {
509 if(b > 0) /* volume = right */
510 return v * (1 - b);
511 else /* volume = left */
512 return v;
513}
514
219dc95c 515/** @brief Compute the right channel volume */
460b9539 516static double right(double v, double b) {
517 if(b > 0) /* volume = right */
518 return v;
519 else /* volume = left */
520 return v * (1 + b);
521}
522
219dc95c 523/** @brief Compute the overall volume */
460b9539 524static double volume(double l, double r) {
525 return max(l, r);
526}
527
219dc95c 528/** @brief Compute the balance */
460b9539 529static double balance(double l, double r) {
530 if(l > r)
531 return r / l - 1;
532 else if(r > l)
533 return 1 - l / r;
534 else /* left = right */
535 return 0;
536}
537
a99c4e9a
RK
538/** @brief Called to enable RTP play
539 *
540 * Rather odd signature is to fit in with the other icons which all call @ref
541 * lib/eclient.h functions.
542 */
543static int enable_rtp(disorder_eclient attribute((unused)) *c,
544 disorder_eclient_no_response attribute((unused)) *completed,
545 void attribute((unused)) *v) {
546 start_rtp();
547 return 0;
548}
549
550/** @brief Called to disable RTP play
551 *
552 * Rather odd signature is to fit in with the other icons which all call @ref
553 * lib/eclient.h functions.
554 */
555static int disable_rtp(disorder_eclient attribute((unused)) *c,
556 disorder_eclient_no_response attribute((unused)) *completed,
557 void attribute((unused)) *v) {
558 stop_rtp();
559 return 0;
560}
561
460b9539 562/*
563Local Variables:
564c-basic-offset:2
565comment-column:40
566fill-column:79
567indent-tabs-mode:nil
568End:
569*/