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_rtp(disorder_eclient *c,
35 disorder_eclient_no_response *completed,
37 static int disable_rtp(disorder_eclient *c,
38 disorder_eclient_no_response *completed,
41 static double left(double v, double b);
42 static double right(double v, double b);
43 static double volume(double l, double r);
44 static double balance(double l, double r);
46 static void volume_adjusted(GtkAdjustment *a, gpointer user_data);
47 static gchar *format_volume(GtkScale *scale, gdouble value);
48 static gchar *format_balance(GtkScale *scale, gdouble value);
50 static void icon_changed(const char *event,
53 static void volume_changed(const char *event,
56 static void control_minimode(const char *event,
60 /* Control bar ------------------------------------------------------------- */
62 /** @brief Guard against feedback */
63 int suppress_actions = 1;
65 /** @brief Toolbar widget */
66 static GtkWidget *toolbar;
68 /** @brief Definition of an icon
70 * We have two kinds of icon:
71 * - action icons, which just do something but don't have a state as such
72 * - toggle icons, which toggle between two states ("on" and "off").
74 * The scratch button is an action icon; currently all the others are toggle
77 * (All icons can be sensitive or insensitive, separately to the above.)
80 /** @brief TRUE to use GTK+ stock icons instead of filenames */
83 /** @brief TRUE for toggle buttons, FALSE for action buttons */
86 /** @brief Filename for image or stock string */
89 /** @brief Text for 'on' tooltip */
92 /** @brief Text for 'off' tooltip */
95 /** @brief Associated menu item or NULL */
98 /** @brief Label text */
101 /** @brief Events that change this icon, separated by spaces */
104 /** @brief @ref eclient.h function to call to go from off to on
106 * For action buttons, this should be NULL.
108 int (*action_go_on)(disorder_eclient *c,
109 disorder_eclient_no_response *completed,
112 /** @brief @ref eclient.h function to call to go from on to off
114 * For action buttons, this action is used.
116 int (*action_go_off)(disorder_eclient *c,
117 disorder_eclient_no_response *completed,
120 /** @brief Get button state
121 * @return 1 for on, 0 for off
125 /** @brief Get button sensitivity
126 * @return 1 for sensitive, 0 for insensitive
128 * Can be NULL for always sensitive.
130 int (*sensitive)(void);
132 /** @brief True if the menu item has inverse sense to the button */
133 gboolean menu_invert;
135 /** @brief Pointer to button */
138 /** @brief Pointer to menu item */
144 static int pause_resume_on(void) {
145 return !!(last_state & DISORDER_TRACK_PAUSED);
148 static int pause_resume_sensitive(void) {
150 && !!(last_state & DISORDER_PLAYING)
151 && (last_rights & RIGHT_PAUSE);
154 static int scratch_sensitive(void) {
155 return !!(last_state & DISORDER_PLAYING)
156 && right_scratchable(last_rights, config->username, playing_track);
159 static int random_sensitive(void) {
160 return !!(last_rights & RIGHT_GLOBAL_PREFS);
163 static int random_enabled(void) {
164 return !!(last_state & DISORDER_RANDOM_ENABLED);
167 static int playing_sensitive(void) {
168 return !!(last_rights & RIGHT_GLOBAL_PREFS);
171 static int playing_enabled(void) {
172 return !!(last_state & DISORDER_PLAYING_ENABLED);
175 static int rtp_enabled(void) {
176 return rtp_is_running;
179 static int rtp_sensitive(void) {
180 return rtp_supported;
183 /** @brief Table of all icons */
184 static struct icon icons[] = {
188 icon: GTK_STOCK_MEDIA_PAUSE,
190 tip_on: "Resume playing track",
191 tip_off: "Pause playing track",
192 menuitem: "<GdisorderMain>/Control/Playing",
194 sensitive: pause_resume_sensitive,
195 action_go_on: disorder_eclient_pause,
196 action_go_off: disorder_eclient_resume,
197 events: "pause-changed playing-changed rights-changed playing-track-changed",
202 icon: GTK_STOCK_STOP,
204 tip_on: "Cancel playing track",
205 menuitem: "<GdisorderMain>/Control/Scratch",
206 sensitive: scratch_sensitive,
207 action_go_off: disorder_eclient_scratch_playing,
208 events: "playing-track-changed rights-changed",
215 tip_on: "Disable random play",
216 tip_off: "Enable random play",
217 menuitem: "<GdisorderMain>/Control/Random play",
219 sensitive: random_sensitive,
220 action_go_on: disorder_eclient_random_enable,
221 action_go_off: disorder_eclient_random_disable,
222 events: "random-changed rights-changed",
227 icon: GTK_STOCK_MEDIA_PLAY,
229 tip_on: "Disable play",
230 tip_off: "Enable play",
232 sensitive: playing_sensitive,
233 action_go_on: disorder_eclient_enable,
234 action_go_off: disorder_eclient_disable,
235 events: "enabled-changed rights-changed",
240 icon: GTK_STOCK_CONNECT,
242 tip_on: "Stop playing network stream",
243 tip_off: "Play network stream",
244 menuitem: "<GdisorderMain>/Control/Network player",
246 sensitive: rtp_sensitive,
247 action_go_on: enable_rtp,
248 action_go_off: disable_rtp,
249 events: "rtp-changed",
253 /** @brief Count of icons */
254 #define NICONS (int)(sizeof icons / sizeof *icons)
256 static GtkAdjustment *volume_adj;
257 static GtkAdjustment *balance_adj;
258 static GtkWidget *volume_widget;
259 static GtkWidget *balance_widget;
261 /** @brief Create the control bar */
262 GtkWidget *control_widget(void) {
263 GtkWidget *hbox = gtk_hbox_new(FALSE, 1);
266 D(("control_widget"));
267 assert(mainmenufactory); /* ordering must be right */
268 toolbar = gtk_toolbar_new();
269 /* Don't permit overflow arrow as otherwise the toolbar isn't greedy enough
270 * in asking for space. The ideal is probably to make the volume and balance
271 * sliders hang down from the toolbar so it unavoidably gets the whole width
272 * of the window to play with. */
273 gtk_toolbar_set_show_arrow(GTK_TOOLBAR(toolbar), FALSE);
274 gtk_toolbar_set_style(GTK_TOOLBAR(toolbar),
275 full_mode ? GTK_TOOLBAR_BOTH : GTK_TOOLBAR_ICONS);
276 for(n = 0; n < NICONS; ++n) {
277 struct icon *const icon = &icons[n];
278 icon->button = (icon->toggle
279 ? GTK_WIDGET(gtk_toggle_tool_button_new())
280 : GTK_WIDGET(gtk_tool_button_new(NULL, NULL)));
281 gtk_widget_set_style(icons[n].button, tool_style);
283 /* We'll use the stock icons for this one */
284 icon->image = gtk_image_new_from_stock(icons[n].icon,
285 GTK_ICON_SIZE_LARGE_TOOLBAR);
287 /* Create the 'on' image */
288 icon->image = gtk_image_new_from_pixbuf(find_image(icons[n].icon));
291 gtk_tool_button_set_icon_widget(GTK_TOOL_BUTTON(icon->button),
293 gtk_tool_button_set_label(GTK_TOOL_BUTTON(icon->button),
296 g_signal_connect(G_OBJECT(icon->button), "toggled",
297 G_CALLBACK(toggled_icon), icon);
299 g_signal_connect(G_OBJECT(icon->button), "clicked",
300 G_CALLBACK(clicked_icon), icon);
301 gtk_toolbar_insert(GTK_TOOLBAR(toolbar),
302 GTK_TOOL_ITEM(icon->button),
304 if(icons[n].menuitem) {
305 /* Find the menu item */
306 icons[n].item = gtk_item_factory_get_widget(mainmenufactory,
309 g_signal_connect(G_OBJECT(icons[n].item), "toggled",
310 G_CALLBACK(toggled_menu), &icons[n]);
312 g_signal_connect(G_OBJECT(icons[n].item), "activate",
313 G_CALLBACK(clicked_menu), &icons[n]);
315 /* Make sure the icon is updated when relevant things changed */
316 char **events = split(icons[n].events, 0, 0, 0, 0);
318 event_register(*events++, icon_changed, &icons[n]);
319 event_register("connected-changed", icon_changed, &icons[n]);
321 /* create the adjustments for the volume control */
322 volume_adj = GTK_ADJUSTMENT(gtk_adjustment_new(0, 0, goesupto,
323 goesupto / 20, goesupto / 20,
325 balance_adj = GTK_ADJUSTMENT(gtk_adjustment_new(0, -1, 1,
327 /* the volume control */
328 volume_widget = gtk_hscale_new(volume_adj);
329 balance_widget = gtk_hscale_new(balance_adj);
330 gtk_widget_set_style(volume_widget, tool_style);
331 gtk_widget_set_style(balance_widget, tool_style);
332 gtk_scale_set_digits(GTK_SCALE(volume_widget), 10);
333 gtk_scale_set_digits(GTK_SCALE(balance_widget), 10);
334 gtk_widget_set_size_request(volume_widget, 128, -1);
335 gtk_widget_set_size_request(balance_widget, 128, -1);
336 gtk_widget_set_tooltip_text(volume_widget, "Volume");
337 gtk_widget_set_tooltip_text(balance_widget, "Balance");
338 gtk_box_pack_start(GTK_BOX(hbox), toolbar,
339 FALSE/*expand*/, TRUE/*fill*/, 0);
340 gtk_box_pack_start(GTK_BOX(hbox), volume_widget,
341 FALSE/*expand*/, TRUE/*fill*/, 0);
342 gtk_box_pack_start(GTK_BOX(hbox), balance_widget,
343 FALSE/*expand*/, TRUE/*fill*/, 0);
344 /* space updates rather than hammering the server */
345 gtk_range_set_update_policy(GTK_RANGE(volume_widget), GTK_UPDATE_DELAYED);
346 gtk_range_set_update_policy(GTK_RANGE(balance_widget), GTK_UPDATE_DELAYED);
347 /* notice when the adjustments are changed */
348 g_signal_connect(G_OBJECT(volume_adj), "value-changed",
349 G_CALLBACK(volume_adjusted), 0);
350 g_signal_connect(G_OBJECT(balance_adj), "value-changed",
351 G_CALLBACK(volume_adjusted), 0);
352 /* format the volume/balance values ourselves */
353 g_signal_connect(G_OBJECT(volume_widget), "format-value",
354 G_CALLBACK(format_volume), 0);
355 g_signal_connect(G_OBJECT(balance_widget), "format-value",
356 G_CALLBACK(format_balance), 0);
357 event_register("volume-changed", volume_changed, 0);
358 event_register("rtp-changed", volume_changed, 0);
359 event_register("mini-mode-changed", control_minimode, 0);
363 /** @brief Return TRUE if volume setting is supported */
364 static int volume_supported(void) {
365 /* TODO: if the server doesn't know how to set the volume [but isn't using
366 * network play] then we should have volume_supported = FALSE */
367 return (!rtp_supported
368 || (rtp_supported && backend && backend->set_volume));
371 /** @brief Update the volume control when it changes */
372 static void volume_changed(const char attribute((unused)) *event,
373 void attribute((unused)) *eventdata,
374 void attribute((unused)) *callbackdata) {
377 D(("volume_changed"));
379 /* Only display volume/balance controls if they will work */
380 if(volume_supported()) {
381 gtk_widget_show(volume_widget);
383 gtk_widget_show(balance_widget);
384 l = volume_l / 100.0;
385 r = volume_r / 100.0;
386 gtk_adjustment_set_value(volume_adj, volume(l, r) * goesupto);
387 gtk_adjustment_set_value(balance_adj, balance(l, r));
389 gtk_widget_hide(volume_widget);
390 gtk_widget_hide(balance_widget);
395 /** @brief Update the state of one of the control icons
397 static void icon_changed(const char attribute((unused)) *event,
398 void attribute((unused)) *evendata,
399 void *callbackdata) {
400 //fprintf(stderr, "icon_changed (%s)\n", event);
401 const struct icon *const icon = callbackdata;
402 int on = icon->on ? icon->on() : 1;
403 int sensitive = icon->sensitive ? icon->sensitive() : 1;
404 //fprintf(stderr, "sensitive->%d\n", sensitive);
407 /* If the connection is down nothing is ever usable */
408 if(!(last_state & DISORDER_CONNECTED))
411 gtk_toggle_tool_button_set_active(GTK_TOGGLE_TOOL_BUTTON(icon->button),
413 /* If you disable play or random play NOT via the icon (for instance, via the
414 * edit menu or via a completely separate command line invocation) then the
415 * icon shows up as insensitive. Hover the mouse over it and the correct
416 * state is immediately displayed. sensitive and GTK_WIDGET_SENSITIVE show
417 * it to be in the correct state, so I think this is may be a GTK+ bug. */
419 gtk_widget_set_tooltip_text(icon->button,
420 on ? icon->tip_on : icon->tip_off);
421 gtk_widget_set_sensitive(icon->button, sensitive);
422 /* Icons with an associated menu item */
425 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(icon->item),
426 !!icon->menu_invert ^ !!on);
427 gtk_widget_set_sensitive(icon->item, sensitive);
432 static void icon_action_completed(void attribute((unused)) *v,
435 popup_protocol_error(0, err);
438 static void clicked_icon(GtkToolButton attribute((unused)) *button,
440 const struct icon *icon = userdata;
444 icon->action_go_off(client, icon_action_completed, 0);
447 static void toggled_icon(GtkToggleToolButton attribute((unused)) *button,
448 gpointer user_data) {
449 const struct icon *icon = user_data;
454 icon->action_go_off(client, icon_action_completed, 0);
456 icon->action_go_on(client, icon_action_completed, 0);
459 static void clicked_menu(GtkMenuItem attribute((unused)) *menuitem,
461 clicked_icon(NULL, userdata);
464 static void toggled_menu(GtkCheckMenuItem attribute((unused)) *menuitem,
466 toggled_icon(NULL, userdata);
469 /** @brief Called when a volume command completes */
470 static void volume_completed(void attribute((unused)) *v,
472 int attribute((unused)) l,
473 int attribute((unused)) r) {
475 popup_protocol_error(0, err);
476 /* We don't set the UI's notion of the volume here, it is set from the log
477 * regardless of the reason it changed */
480 /** @brief Called when the volume has been adjusted */
481 static void volume_adjusted(GtkAdjustment attribute((unused)) *a,
482 gpointer attribute((unused)) user_data) {
483 double v = gtk_adjustment_get_value(volume_adj) / goesupto;
484 double b = gtk_adjustment_get_value(balance_adj);
487 /* This is the result of an update from the server, not a change from the
488 * user. Don't feedback! */
490 D(("volume_adjusted"));
491 /* force to 'stereotypical' values */
492 v = nearbyint(100 * v) / 100;
493 b = nearbyint(5 * b) / 5;
494 /* Set the volume. We don't want a reply, we'll get the actual new volume
497 int l = nearbyint(left(v, b) * 100), r = nearbyint(right(v, b) * 100);
498 if(backend && backend->set_volume)
499 backend->set_volume(&l, &r);
501 disorder_eclient_volume(client, volume_completed,
502 nearbyint(left(v, b) * 100),
503 nearbyint(right(v, b) * 100),
507 /** @brief Formats the volume value */
508 static gchar *format_volume(GtkScale attribute((unused)) *scale,
512 snprintf(s, sizeof s, "%.1f", (double)value);
516 /** @brief Formats the balance value */
517 static gchar *format_balance(GtkScale attribute((unused)) *scale,
521 if(fabs(value) < 0.1)
522 return g_strdup("0");
523 snprintf(s, sizeof s, "%+.1f", (double)value);
527 /* Volume mapping. We consider left, right, volume to be in [0,1]
528 * and balance to be in [-1,1].
530 * First, we just have volume = max(left, right).
532 * Balance we consider to linearly represent the amount by which the quieter
533 * channel differs from the louder. In detail:
535 * if right > left then balance > 0:
536 * balance = 0 => left = right (as an endpoint, not an instance)
537 * balance = 1 => left = 0
538 * fitting to linear, left = right * (1 - balance)
539 * so balance = 1 - left / right
540 * (right > left => right > 0 so no division by 0.)
542 * if left > right then balance < 0:
543 * balance = 0 => right = left (same caveat as above)
544 * balance = -1 => right = 0
545 * again fitting to linear, right = left * (1 + balance)
546 * so balance = right / left - 1
547 * (left > right => left > 0 so no division by 0.)
549 * if left = right then we just have balance = 0.
551 * Thanks to Clive and Andrew.
554 /** @brief Return the greater of @p x and @p y */
555 static double max(double x, double y) {
556 return x > y ? x : y;
559 /** @brief Compute the left channel volume */
560 static double left(double v, double b) {
561 if(b > 0) /* volume = right */
563 else /* volume = left */
567 /** @brief Compute the right channel volume */
568 static double right(double v, double b) {
569 if(b > 0) /* volume = right */
571 else /* volume = left */
575 /** @brief Compute the overall volume */
576 static double volume(double l, double r) {
580 /** @brief Compute the balance */
581 static double balance(double l, double r) {
586 else /* left = right */
590 /** @brief Called to enable RTP play
592 * Rather odd signature is to fit in with the other icons which all call @ref
593 * lib/eclient.h functions.
595 static int enable_rtp(disorder_eclient attribute((unused)) *c,
596 disorder_eclient_no_response attribute((unused)) *completed,
597 void attribute((unused)) *v) {
602 /** @brief Called to disable RTP play
604 * Rather odd signature is to fit in with the other icons which all call @ref
605 * lib/eclient.h functions.
607 static int disable_rtp(disorder_eclient attribute((unused)) *c,
608 disorder_eclient_no_response attribute((unused)) *completed,
609 void attribute((unused)) *v) {
614 static void control_minimode(const char attribute((unused)) *event,
615 void attribute((unused)) *evendata,
616 void attribute((unused)) *callbackdata) {
617 if(full_mode && volume_supported()) {
618 gtk_widget_show(balance_widget);
619 gtk_scale_set_value_pos(GTK_SCALE(volume_widget), GTK_POS_TOP);
621 gtk_widget_hide(balance_widget);
622 gtk_scale_set_value_pos(GTK_SCALE(volume_widget), GTK_POS_RIGHT);
624 gtk_toolbar_set_style(GTK_TOOLBAR(toolbar),
625 full_mode ? GTK_TOOLBAR_BOTH : GTK_TOOLBAR_ICONS);