2 * This file is part of DisOrder.
3 * Copyright (C) 2006-2009 Richard Kettlewell
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
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.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 /** @file disobedience/control.c
19 * @brief Volume control and buttons
22 #include "disobedience.h"
24 /* Forward declarations ---------------------------------------------------- */
28 static void clicked_icon(GtkToolButton *, gpointer);
29 static void toggled_icon(GtkToggleToolButton *button,
31 static void clicked_menu(GtkMenuItem *, gpointer userdata);
32 static void toggled_menu(GtkCheckMenuItem *, gpointer userdata);
34 static int enable_playing(disorder_eclient *c,
35 disorder_eclient_no_response *completed,
37 static int disable_playing(disorder_eclient *c,
38 disorder_eclient_no_response *completed,
40 static int enable_random(disorder_eclient *c,
41 disorder_eclient_no_response *completed,
43 static int disable_random(disorder_eclient *c,
44 disorder_eclient_no_response *completed,
46 static int pause_track(disorder_eclient *c,
47 disorder_eclient_no_response *completed,
49 static int resume_track(disorder_eclient *c,
50 disorder_eclient_no_response *completed,
52 static int enable_rtp(disorder_eclient *c,
53 disorder_eclient_no_response *completed,
55 static int disable_rtp(disorder_eclient *c,
56 disorder_eclient_no_response *completed,
59 static double left(double v, double b);
60 static double right(double v, double b);
61 static double volume(double l, double r);
62 static double balance(double l, double r);
64 static void volume_adjusted(GtkAdjustment *a, gpointer user_data);
65 static gchar *format_volume(GtkScale *scale, gdouble value);
66 static gchar *format_balance(GtkScale *scale, gdouble value);
68 static void icon_changed(const char *event,
71 static void volume_changed(const char *event,
74 static void control_minimode(const char *event,
78 /* Control bar ------------------------------------------------------------- */
80 /** @brief Guard against feedback */
81 int suppress_actions = 1;
83 /** @brief Toolbar widget */
84 static GtkWidget *toolbar;
86 /** @brief Old state to restore on error
88 * Here's the problem we're trying to solve. Suppose the user clicks the
89 * `pause' button. Immediately, Gtk toggles the button's state. There's also
90 * a menu item which is @i not yet updated, so we hack @c last_state and call
91 * icon_changed() by hand. We send a `pause' command to the server. If all is
92 * well, then we're done: we'll get a state update in the server log which will
93 * match what we're already doing and everything is fine. If there's an error,
94 * though, we must put @c last_state back the way we found it since there will
95 * be no change reported in the server log to correct the wrong state
96 * information. Also, we must untoggle the icon and menu items.
98 static unsigned long restore_state;
100 /** @brief Definition of an icon
102 * We have two kinds of icon:
103 * - action icons, which just do something but don't have a state as such
104 * - toggle icons, which toggle between two states ("on" and "off").
106 * The scratch button is an action icon; currently all the others are toggle
109 * (All icons can be sensitive or insensitive, separately to the above.)
112 /** @brief TRUE to use GTK+ stock icons instead of filenames */
115 /** @brief TRUE for toggle buttons, FALSE for action buttons */
118 /** @brief Filename for image or stock string */
121 /** @brief Text for 'on' tooltip */
124 /** @brief Text for 'off' tooltip */
127 /** @brief Associated menu item or NULL */
128 const char *menuitem;
130 /** @brief Label text */
133 /** @brief Events that change this icon, separated by spaces */
136 /** @brief Event to raise when the icon is frobbed */
139 /** @brief @ref eclient.h function to call to go from off to on
141 * For action buttons, this should be NULL.
143 int (*action_go_on)(disorder_eclient *c,
144 disorder_eclient_no_response *completed,
147 /** @brief @ref eclient.h function to call to go from on to off
149 * For action buttons, this action is used.
151 int (*action_go_off)(disorder_eclient *c,
152 disorder_eclient_no_response *completed,
155 /** @brief Get button state
156 * @return 1 for on, 0 for off
160 /** @brief Get button sensitivity
161 * @return 1 for sensitive, 0 for insensitive
163 * Can be NULL for always sensitive.
165 int (*sensitive)(void);
167 /** @brief True if the menu item has inverse sense to the button */
168 gboolean menu_invert;
170 /** @brief Pointer to button */
173 /** @brief Pointer to menu item */
179 static int pause_resume_on(void) {
180 return !!(last_state & DISORDER_TRACK_PAUSED);
183 static int pause_resume_sensitive(void) {
185 && !!(last_state & DISORDER_PLAYING)
186 && (last_rights & RIGHT_PAUSE);
189 static int scratch_sensitive(void) {
190 return !!(last_state & DISORDER_PLAYING)
191 && right_scratchable(last_rights, config->username, playing_track);
194 static int random_sensitive(void) {
195 return !!(last_rights & RIGHT_GLOBAL_PREFS);
198 static int random_enabled(void) {
199 return !!(last_state & DISORDER_RANDOM_ENABLED);
202 static int playing_sensitive(void) {
203 return !!(last_rights & RIGHT_GLOBAL_PREFS);
206 static int playing_enabled(void) {
207 return !!(last_state & DISORDER_PLAYING_ENABLED);
210 static int rtp_enabled(void) {
211 return rtp_is_running;
214 static int rtp_sensitive(void) {
215 return rtp_supported;
218 /** @brief Table of all icons */
219 static struct icon icons[] = {
223 .icon = GTK_STOCK_MEDIA_PAUSE,
225 .tip_on = "Resume playing track",
226 .tip_off = "Pause playing track",
227 .menuitem = "<GdisorderMain>/Control/Playing",
228 .on = pause_resume_on,
229 .sensitive = pause_resume_sensitive,
230 .action_go_on = pause_track,
231 .action_go_off = resume_track,
232 .events = "pause-changed playing-changed rights-changed playing-track-changed",
233 .raise = "pause-changed",
238 .icon = GTK_STOCK_STOP,
240 .tip_on = "Cancel playing track",
241 .menuitem = "<GdisorderMain>/Control/Scratch",
242 .sensitive = scratch_sensitive,
243 .action_go_off = disorder_eclient_scratch_playing,
244 .events = "playing-track-changed rights-changed",
249 .icon = "cards24.png",
251 .tip_on = "Disable random play",
252 .tip_off = "Enable random play",
253 .menuitem = "<GdisorderMain>/Control/Random play",
254 .on = random_enabled,
255 .sensitive = random_sensitive,
256 .action_go_on = enable_random,
257 .action_go_off = disable_random,
258 .events = "random-changed rights-changed",
259 .raise = "random-changed",
264 .icon = GTK_STOCK_MEDIA_PLAY,
266 .tip_on = "Disable play",
267 .tip_off = "Enable play",
268 .on = playing_enabled,
269 .sensitive = playing_sensitive,
270 .action_go_on = enable_playing,
271 .action_go_off = disable_playing,
272 .events = "enabled-changed rights-changed",
273 .raise = "playing-changed",
278 .icon = GTK_STOCK_CONNECT,
280 .tip_on = "Stop playing network stream",
281 .tip_off = "Play network stream",
282 .menuitem = "<GdisorderMain>/Control/Network player",
284 .sensitive = rtp_sensitive,
285 .action_go_on = enable_rtp,
286 .action_go_off = disable_rtp,
287 .events = "rtp-changed",
291 /** @brief Count of icons */
292 #define NICONS (int)(sizeof icons / sizeof *icons)
294 static GtkAdjustment *volume_adj;
295 static GtkAdjustment *balance_adj;
296 static GtkWidget *volume_widget;
297 static GtkWidget *balance_widget;
299 /** @brief Create the control bar */
300 GtkWidget *control_widget(void) {
301 GtkWidget *hbox = gtk_hbox_new(FALSE, 1);
304 D(("control_widget"));
305 assert(mainmenufactory); /* ordering must be right */
306 toolbar = gtk_toolbar_new();
307 /* Don't permit overflow arrow as otherwise the toolbar isn't greedy enough
308 * in asking for space. The ideal is probably to make the volume and balance
309 * sliders hang down from the toolbar so it unavoidably gets the whole width
310 * of the window to play with. */
311 gtk_toolbar_set_show_arrow(GTK_TOOLBAR(toolbar), FALSE);
312 if(full_mode) gtk_toolbar_unset_style(GTK_TOOLBAR(toolbar));
313 else gtk_toolbar_set_style(GTK_TOOLBAR(toolbar), GTK_TOOLBAR_ICONS);
314 for(n = 0; n < NICONS; ++n) {
315 struct icon *const icon = &icons[n];
316 icon->button = (icon->toggle
317 ? GTK_WIDGET(gtk_toggle_tool_button_new())
318 : GTK_WIDGET(gtk_tool_button_new(NULL, NULL)));
319 gtk_widget_set_style(icons[n].button, tool_style);
321 /* We'll use the stock icons for this one */
322 icon->image = gtk_image_new_from_stock(icons[n].icon,
323 GTK_ICON_SIZE_LARGE_TOOLBAR);
325 /* Create the 'on' image */
326 icon->image = gtk_image_new_from_pixbuf(find_image(icons[n].icon));
329 gtk_tool_button_set_icon_widget(GTK_TOOL_BUTTON(icon->button),
331 gtk_tool_button_set_label(GTK_TOOL_BUTTON(icon->button),
334 g_signal_connect(G_OBJECT(icon->button), "toggled",
335 G_CALLBACK(toggled_icon), icon);
337 g_signal_connect(G_OBJECT(icon->button), "clicked",
338 G_CALLBACK(clicked_icon), icon);
339 gtk_toolbar_insert(GTK_TOOLBAR(toolbar),
340 GTK_TOOL_ITEM(icon->button),
342 if(icons[n].menuitem) {
343 /* Find the menu item */
344 icons[n].item = gtk_item_factory_get_widget(mainmenufactory,
347 g_signal_connect(G_OBJECT(icons[n].item), "toggled",
348 G_CALLBACK(toggled_menu), &icons[n]);
350 g_signal_connect(G_OBJECT(icons[n].item), "activate",
351 G_CALLBACK(clicked_menu), &icons[n]);
353 /* Make sure the icon is updated when relevant things changed */
354 char **events = split(icons[n].events, 0, 0, 0, 0);
356 event_register(*events++, icon_changed, &icons[n]);
357 event_register("connected-changed", icon_changed, &icons[n]);
359 /* create the adjustments for the volume control */
360 volume_adj = GTK_ADJUSTMENT(gtk_adjustment_new(0, 0, goesupto,
361 goesupto / 20, goesupto / 20,
363 balance_adj = GTK_ADJUSTMENT(gtk_adjustment_new(0, -1, 1,
365 /* the volume control */
366 volume_widget = gtk_hscale_new(volume_adj);
367 balance_widget = gtk_hscale_new(balance_adj);
368 gtk_widget_set_style(volume_widget, tool_style);
369 gtk_widget_set_style(balance_widget, tool_style);
370 gtk_scale_set_digits(GTK_SCALE(volume_widget), 10);
371 gtk_scale_set_digits(GTK_SCALE(balance_widget), 10);
372 gtk_widget_set_size_request(volume_widget, 128, -1);
373 gtk_widget_set_size_request(balance_widget, 128, -1);
374 gtk_widget_set_tooltip_text(volume_widget, "Volume");
375 gtk_widget_set_tooltip_text(balance_widget, "Balance");
376 gtk_box_pack_start(GTK_BOX(hbox), toolbar,
377 FALSE/*expand*/, TRUE/*fill*/, 0);
378 gtk_box_pack_start(GTK_BOX(hbox), volume_widget,
379 FALSE/*expand*/, TRUE/*fill*/, 0);
380 gtk_box_pack_start(GTK_BOX(hbox), balance_widget,
381 FALSE/*expand*/, TRUE/*fill*/, 0);
382 /* space updates rather than hammering the server */
383 gtk_range_set_update_policy(GTK_RANGE(volume_widget), GTK_UPDATE_DELAYED);
384 gtk_range_set_update_policy(GTK_RANGE(balance_widget), GTK_UPDATE_DELAYED);
385 /* notice when the adjustments are changed */
386 g_signal_connect(G_OBJECT(volume_adj), "value-changed",
387 G_CALLBACK(volume_adjusted), 0);
388 g_signal_connect(G_OBJECT(balance_adj), "value-changed",
389 G_CALLBACK(volume_adjusted), 0);
390 /* format the volume/balance values ourselves */
391 g_signal_connect(G_OBJECT(volume_widget), "format-value",
392 G_CALLBACK(format_volume), 0);
393 g_signal_connect(G_OBJECT(balance_widget), "format-value",
394 G_CALLBACK(format_balance), 0);
395 event_register("volume-changed", volume_changed, 0);
396 event_register("rtp-changed", volume_changed, 0);
397 event_register("mini-mode-changed", control_minimode, 0);
401 /** @brief Return TRUE if volume setting is supported */
402 static int volume_supported(void) {
403 /* TODO: if the server doesn't know how to set the volume [but isn't using
404 * network play] then we should have volume_supported = FALSE */
408 /** @brief Update the volume control when it changes */
409 static void volume_changed(const char attribute((unused)) *event,
410 void attribute((unused)) *eventdata,
411 void attribute((unused)) *callbackdata) {
414 D(("volume_changed"));
416 /* Only display volume/balance controls if they will work */
417 if(volume_supported()) {
418 gtk_widget_show(volume_widget);
420 gtk_widget_show(balance_widget);
421 l = volume_l / 100.0;
422 r = volume_r / 100.0;
423 gtk_adjustment_set_value(volume_adj, volume(l, r) * goesupto);
424 gtk_adjustment_set_value(balance_adj, balance(l, r));
426 gtk_widget_hide(volume_widget);
427 gtk_widget_hide(balance_widget);
432 /** @brief Update the state of one of the control icons
434 static void icon_changed(const char attribute((unused)) *event,
435 void attribute((unused)) *evendata,
436 void *callbackdata) {
437 //fprintf(stderr, "icon_changed (%s)\n", event);
438 const struct icon *const icon = callbackdata;
439 int on = icon->on ? icon->on() : 1;
440 int sensitive = icon->sensitive ? icon->sensitive() : 1;
441 //fprintf(stderr, "sensitive->%d\n", sensitive);
444 /* If the connection is down nothing is ever usable */
445 if(!(last_state & DISORDER_CONNECTED))
448 gtk_toggle_tool_button_set_active(GTK_TOGGLE_TOOL_BUTTON(icon->button),
450 /* If you disable play or random play NOT via the icon (for instance, via the
451 * edit menu or via a completely separate command line invocation) then the
452 * icon shows up as insensitive. Hover the mouse over it and the correct
453 * state is immediately displayed. sensitive and GTK_WIDGET_SENSITIVE show
454 * it to be in the correct state, so I think this is may be a GTK+ bug. */
456 gtk_widget_set_tooltip_text(icon->button,
457 on ? icon->tip_on : icon->tip_off);
458 gtk_widget_set_sensitive(icon->button, sensitive);
459 /* Icons with an associated menu item */
462 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(icon->item),
463 !!icon->menu_invert ^ !!on);
464 gtk_widget_set_sensitive(icon->item, sensitive);
469 static void icon_action_completed(void *v, const char *err) {
471 last_state = restore_state;
472 popup_protocol_error(0, err);
473 icon_changed(0, 0, v);
477 static void clicked_icon(GtkToolButton attribute((unused)) *button,
479 const struct icon *icon = userdata;
483 icon->action_go_off(client, icon_action_completed, 0);
485 event_raise(icon->raise, 0);
488 static void toggled_icon(GtkToggleToolButton attribute((unused)) *button,
489 gpointer user_data) {
490 const struct icon *icon = user_data;
494 restore_state = last_state;
496 icon->action_go_off(client, icon_action_completed, 0);
498 icon->action_go_on(client, icon_action_completed, 0);
499 icon_changed(0, 0, user_data);
501 event_raise(icon->raise, 0);
504 static void clicked_menu(GtkMenuItem attribute((unused)) *menuitem,
506 clicked_icon(NULL, userdata);
509 static void toggled_menu(GtkCheckMenuItem attribute((unused)) *menuitem,
511 toggled_icon(NULL, userdata);
514 /** @brief Called when a volume command completes */
515 static void volume_completed(void attribute((unused)) *v,
518 popup_protocol_error(0, err);
519 /* We don't set the UI's notion of the volume here, it is set from the log
520 * regardless of the reason it changed */
523 /** @brief Called when the volume has been adjusted */
524 static void volume_adjusted(GtkAdjustment attribute((unused)) *a,
525 gpointer attribute((unused)) user_data) {
526 double v = gtk_adjustment_get_value(volume_adj) / goesupto;
527 double b = gtk_adjustment_get_value(balance_adj);
530 /* This is the result of an update from the server, not a change from the
531 * user. Don't feedback! */
533 D(("volume_adjusted"));
534 /* force to 'stereotypical' values */
535 v = nearbyint(100 * v) / 100;
536 b = nearbyint(5 * b) / 5;
537 /* Set the volume. We don't want a reply, we'll get the actual new volume
540 int l = nearbyint(left(v, b) * 100), r = nearbyint(right(v, b) * 100);
543 disorder_eclient_set_volume(client, volume_completed,
544 nearbyint(left(v, b) * 100),
545 nearbyint(right(v, b) * 100),
549 /** @brief Formats the volume value */
550 static gchar *format_volume(GtkScale attribute((unused)) *scale,
554 snprintf(s, sizeof s, "%.1f", (double)value);
558 /** @brief Formats the balance value */
559 static gchar *format_balance(GtkScale attribute((unused)) *scale,
563 if(fabs(value) < 0.1)
564 return g_strdup("0");
565 snprintf(s, sizeof s, "%+.1f", (double)value);
569 /* Volume mapping. We consider left, right, volume to be in [0,1]
570 * and balance to be in [-1,1].
572 * First, we just have volume = max(left, right).
574 * Balance we consider to linearly represent the amount by which the quieter
575 * channel differs from the louder. In detail:
577 * if right > left then balance > 0:
578 * balance = 0 => left = right (as an endpoint, not an instance)
579 * balance = 1 => left = 0
580 * fitting to linear, left = right * (1 - balance)
581 * so balance = 1 - left / right
582 * (right > left => right > 0 so no division by 0.)
584 * if left > right then balance < 0:
585 * balance = 0 => right = left (same caveat as above)
586 * balance = -1 => right = 0
587 * again fitting to linear, right = left * (1 + balance)
588 * so balance = right / left - 1
589 * (left > right => left > 0 so no division by 0.)
591 * if left = right then we just have balance = 0.
593 * Thanks to Clive and Andrew.
596 /** @brief Return the greater of @p x and @p y */
597 static double max(double x, double y) {
598 return x > y ? x : y;
601 /** @brief Compute the left channel volume */
602 static double left(double v, double b) {
603 if(b > 0) /* volume = right */
605 else /* volume = left */
609 /** @brief Compute the right channel volume */
610 static double right(double v, double b) {
611 if(b > 0) /* volume = right */
613 else /* volume = left */
617 /** @brief Compute the overall volume */
618 static double volume(double l, double r) {
622 /** @brief Compute the balance */
623 static double balance(double l, double r) {
628 else /* left = right */
632 /** @brief Called to enable jukebox playback */
633 static int enable_playing(disorder_eclient *c,
634 disorder_eclient_no_response *completed, void *v) {
635 last_state |= DISORDER_PLAYING;
636 return disorder_eclient_enable(c, completed, v);
639 /** @brief Called to disable jukebox playback */
640 static int disable_playing(disorder_eclient *c,
641 disorder_eclient_no_response *completed, void *v) {
642 last_state &= ~DISORDER_PLAYING;
643 return disorder_eclient_disable(c, completed, v);
646 /** @brief Called to enable random selection */
647 static int enable_random(disorder_eclient *c,
648 disorder_eclient_no_response *completed, void *v) {
649 last_state |= DISORDER_RANDOM_ENABLED;
650 return disorder_eclient_random_enable(c, completed, v);
653 /** @brief Called to disable random selection */
654 static int disable_random(disorder_eclient *c,
655 disorder_eclient_no_response *completed, void *v) {
656 last_state &= ~DISORDER_RANDOM_ENABLED;
657 return disorder_eclient_random_disable(c, completed, v);
660 /** @brief Called to pause the current track */
661 static int pause_track(disorder_eclient *c,
662 disorder_eclient_no_response *completed, void *v) {
663 last_state |= DISORDER_TRACK_PAUSED;
664 return disorder_eclient_pause(c, completed, v);
667 /** @brief Called to resume the current track */
668 static int resume_track(disorder_eclient *c,
669 disorder_eclient_no_response *completed, void *v) {
670 last_state &= ~DISORDER_TRACK_PAUSED;
671 return disorder_eclient_resume(c, completed, v);
674 /** @brief Called to enable RTP play
676 * Rather odd signature is to fit in with the other icons which all call @ref
677 * lib/eclient.h functions.
679 static int enable_rtp(disorder_eclient attribute((unused)) *c,
680 disorder_eclient_no_response attribute((unused)) *completed,
681 void attribute((unused)) *v) {
687 /** @brief Called to disable RTP play
689 * Rather odd signature is to fit in with the other icons which all call @ref
690 * lib/eclient.h functions.
692 static int disable_rtp(disorder_eclient attribute((unused)) *c,
693 disorder_eclient_no_response attribute((unused)) *completed,
694 void attribute((unused)) *v) {
700 static void control_minimode(const char attribute((unused)) *event,
701 void attribute((unused)) *evendata,
702 void attribute((unused)) *callbackdata) {
703 if(full_mode && volume_supported()) {
704 gtk_widget_show(balance_widget);
705 gtk_scale_set_value_pos(GTK_SCALE(volume_widget), GTK_POS_TOP);
707 gtk_widget_hide(balance_widget);
708 gtk_scale_set_value_pos(GTK_SCALE(volume_widget), GTK_POS_RIGHT);
710 if(full_mode) gtk_toolbar_unset_style(GTK_TOOLBAR(toolbar));
711 else gtk_toolbar_set_style(GTK_TOOLBAR(toolbar), GTK_TOOLBAR_ICONS);