disobedience, playrtp: Have `playrtp' handle volume control.
[disorder] / disobedience / control.c
1 /*
2 * This file is part of DisOrder.
3 * Copyright (C) 2006-2009 Richard Kettlewell
4 *
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.
9 *
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 *
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/>.
17 */
18 /** @file disobedience/control.c
19 * @brief Volume control and buttons
20 */
21
22 #include "disobedience.h"
23
24 /* Forward declarations ---------------------------------------------------- */
25
26 struct icon;
27
28 static void clicked_icon(GtkToolButton *, gpointer);
29 static void toggled_icon(GtkToggleToolButton *button,
30 gpointer user_data);
31 static void clicked_menu(GtkMenuItem *, gpointer userdata);
32 static void toggled_menu(GtkCheckMenuItem *, gpointer userdata);
33
34 static int enable_rtp(disorder_eclient *c,
35 disorder_eclient_no_response *completed,
36 void *v);
37 static int disable_rtp(disorder_eclient *c,
38 disorder_eclient_no_response *completed,
39 void *v);
40
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);
45
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);
49
50 static void icon_changed(const char *event,
51 void *evendata,
52 void *callbackdata);
53 static void volume_changed(const char *event,
54 void *eventdata,
55 void *callbackdata);
56 static void control_minimode(const char *event,
57 void *eventdata,
58 void *callbackdata);
59
60 /* Control bar ------------------------------------------------------------- */
61
62 /** @brief Guard against feedback */
63 int suppress_actions = 1;
64
65 /** @brief Toolbar widget */
66 static GtkWidget *toolbar;
67
68 /** @brief Definition of an icon
69 *
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").
73 *
74 * The scratch button is an action icon; currently all the others are toggle
75 * icons.
76 *
77 * (All icons can be sensitive or insensitive, separately to the above.)
78 */
79 struct icon {
80 /** @brief TRUE to use GTK+ stock icons instead of filenames */
81 gboolean stock;
82
83 /** @brief TRUE for toggle buttons, FALSE for action buttons */
84 gboolean toggle;
85
86 /** @brief Filename for image or stock string */
87 const char *icon;
88
89 /** @brief Text for 'on' tooltip */
90 const char *tip_on;
91
92 /** @brief Text for 'off' tooltip */
93 const char *tip_off;
94
95 /** @brief Associated menu item or NULL */
96 const char *menuitem;
97
98 /** @brief Label text */
99 const char *label;
100
101 /** @brief Events that change this icon, separated by spaces */
102 const char *events;
103
104 /** @brief @ref eclient.h function to call to go from off to on
105 *
106 * For action buttons, this should be NULL.
107 */
108 int (*action_go_on)(disorder_eclient *c,
109 disorder_eclient_no_response *completed,
110 void *v);
111
112 /** @brief @ref eclient.h function to call to go from on to off
113 *
114 * For action buttons, this action is used.
115 */
116 int (*action_go_off)(disorder_eclient *c,
117 disorder_eclient_no_response *completed,
118 void *v);
119
120 /** @brief Get button state
121 * @return 1 for on, 0 for off
122 */
123 int (*on)(void);
124
125 /** @brief Get button sensitivity
126 * @return 1 for sensitive, 0 for insensitive
127 *
128 * Can be NULL for always sensitive.
129 */
130 int (*sensitive)(void);
131
132 /** @brief True if the menu item has inverse sense to the button */
133 gboolean menu_invert;
134
135 /** @brief Pointer to button */
136 GtkWidget *button;
137
138 /** @brief Pointer to menu item */
139 GtkWidget *item;
140
141 GtkWidget *image;
142 };
143
144 static int pause_resume_on(void) {
145 return !!(last_state & DISORDER_TRACK_PAUSED);
146 }
147
148 static int pause_resume_sensitive(void) {
149 return playing_track
150 && !!(last_state & DISORDER_PLAYING)
151 && (last_rights & RIGHT_PAUSE);
152 }
153
154 static int scratch_sensitive(void) {
155 return !!(last_state & DISORDER_PLAYING)
156 && right_scratchable(last_rights, config->username, playing_track);
157 }
158
159 static int random_sensitive(void) {
160 return !!(last_rights & RIGHT_GLOBAL_PREFS);
161 }
162
163 static int random_enabled(void) {
164 return !!(last_state & DISORDER_RANDOM_ENABLED);
165 }
166
167 static int playing_sensitive(void) {
168 return !!(last_rights & RIGHT_GLOBAL_PREFS);
169 }
170
171 static int playing_enabled(void) {
172 return !!(last_state & DISORDER_PLAYING_ENABLED);
173 }
174
175 static int rtp_enabled(void) {
176 return rtp_is_running;
177 }
178
179 static int rtp_sensitive(void) {
180 return rtp_supported;
181 }
182
183 /** @brief Table of all icons */
184 static struct icon icons[] = {
185 {
186 .toggle = TRUE,
187 .stock = TRUE,
188 .icon = GTK_STOCK_MEDIA_PAUSE,
189 .label = "Pause",
190 .tip_on = "Resume playing track",
191 .tip_off = "Pause playing track",
192 .menuitem = "<GdisorderMain>/Control/Playing",
193 .on = pause_resume_on,
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",
198 .menu_invert = TRUE,
199 },
200 {
201 .stock = TRUE,
202 .icon = GTK_STOCK_STOP,
203 .label = "Scratch",
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",
209 },
210 {
211 .toggle = TRUE,
212 .stock = FALSE,
213 .icon = "cards24.png",
214 .label = "Random",
215 .tip_on = "Disable random play",
216 .tip_off = "Enable random play",
217 .menuitem = "<GdisorderMain>/Control/Random play",
218 .on = random_enabled,
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",
223 },
224 {
225 .toggle = TRUE,
226 .stock = TRUE,
227 .icon = GTK_STOCK_MEDIA_PLAY,
228 .label = "Play",
229 .tip_on = "Disable play",
230 .tip_off = "Enable play",
231 .on = playing_enabled,
232 .sensitive = playing_sensitive,
233 .action_go_on = disorder_eclient_enable,
234 .action_go_off = disorder_eclient_disable,
235 .events = "enabled-changed rights-changed",
236 },
237 {
238 .toggle = TRUE,
239 .stock = TRUE,
240 .icon = GTK_STOCK_CONNECT,
241 .label = "RTP",
242 .tip_on = "Stop playing network stream",
243 .tip_off = "Play network stream",
244 .menuitem = "<GdisorderMain>/Control/Network player",
245 .on = rtp_enabled,
246 .sensitive = rtp_sensitive,
247 .action_go_on = enable_rtp,
248 .action_go_off = disable_rtp,
249 .events = "rtp-changed",
250 },
251 };
252
253 /** @brief Count of icons */
254 #define NICONS (int)(sizeof icons / sizeof *icons)
255
256 static GtkAdjustment *volume_adj;
257 static GtkAdjustment *balance_adj;
258 static GtkWidget *volume_widget;
259 static GtkWidget *balance_widget;
260
261 /** @brief Create the control bar */
262 GtkWidget *control_widget(void) {
263 GtkWidget *hbox = gtk_hbox_new(FALSE, 1);
264 int n;
265
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);
282 if(icons[n].stock) {
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);
286 } else {
287 /* Create the 'on' image */
288 icon->image = gtk_image_new_from_pixbuf(find_image(icons[n].icon));
289 }
290 assert(icon->image);
291 gtk_tool_button_set_icon_widget(GTK_TOOL_BUTTON(icon->button),
292 icon->image);
293 gtk_tool_button_set_label(GTK_TOOL_BUTTON(icon->button),
294 icon->label);
295 if(icon->toggle)
296 g_signal_connect(G_OBJECT(icon->button), "toggled",
297 G_CALLBACK(toggled_icon), icon);
298 else
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),
303 -1);
304 if(icons[n].menuitem) {
305 /* Find the menu item */
306 icons[n].item = gtk_item_factory_get_widget(mainmenufactory,
307 icons[n].menuitem);
308 if(icon->toggle)
309 g_signal_connect(G_OBJECT(icons[n].item), "toggled",
310 G_CALLBACK(toggled_menu), &icons[n]);
311 else
312 g_signal_connect(G_OBJECT(icons[n].item), "activate",
313 G_CALLBACK(clicked_menu), &icons[n]);
314 }
315 /* Make sure the icon is updated when relevant things changed */
316 char **events = split(icons[n].events, 0, 0, 0, 0);
317 while(*events)
318 event_register(*events++, icon_changed, &icons[n]);
319 event_register("connected-changed", icon_changed, &icons[n]);
320 }
321 /* create the adjustments for the volume control */
322 volume_adj = GTK_ADJUSTMENT(gtk_adjustment_new(0, 0, goesupto,
323 goesupto / 20, goesupto / 20,
324 0));
325 balance_adj = GTK_ADJUSTMENT(gtk_adjustment_new(0, -1, 1,
326 0.2, 0.2, 0));
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);
360 return hbox;
361 }
362
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 1;
368 }
369
370 /** @brief Update the volume control when it changes */
371 static void volume_changed(const char attribute((unused)) *event,
372 void attribute((unused)) *eventdata,
373 void attribute((unused)) *callbackdata) {
374 double l, r;
375
376 D(("volume_changed"));
377 ++suppress_actions;
378 /* Only display volume/balance controls if they will work */
379 if(volume_supported()) {
380 gtk_widget_show(volume_widget);
381 if(full_mode)
382 gtk_widget_show(balance_widget);
383 l = volume_l / 100.0;
384 r = volume_r / 100.0;
385 gtk_adjustment_set_value(volume_adj, volume(l, r) * goesupto);
386 gtk_adjustment_set_value(balance_adj, balance(l, r));
387 } else {
388 gtk_widget_hide(volume_widget);
389 gtk_widget_hide(balance_widget);
390 }
391 --suppress_actions;
392 }
393
394 /** @brief Update the state of one of the control icons
395 */
396 static void icon_changed(const char attribute((unused)) *event,
397 void attribute((unused)) *evendata,
398 void *callbackdata) {
399 //fprintf(stderr, "icon_changed (%s)\n", event);
400 const struct icon *const icon = callbackdata;
401 int on = icon->on ? icon->on() : 1;
402 int sensitive = icon->sensitive ? icon->sensitive() : 1;
403 //fprintf(stderr, "sensitive->%d\n", sensitive);
404
405 ++suppress_actions;
406 /* If the connection is down nothing is ever usable */
407 if(!(last_state & DISORDER_CONNECTED))
408 sensitive = 0;
409 if(icon->toggle)
410 gtk_toggle_tool_button_set_active(GTK_TOGGLE_TOOL_BUTTON(icon->button),
411 on);
412 /* If you disable play or random play NOT via the icon (for instance, via the
413 * edit menu or via a completely separate command line invocation) then the
414 * icon shows up as insensitive. Hover the mouse over it and the correct
415 * state is immediately displayed. sensitive and GTK_WIDGET_SENSITIVE show
416 * it to be in the correct state, so I think this is may be a GTK+ bug. */
417 if(icon->tip_on)
418 gtk_widget_set_tooltip_text(icon->button,
419 on ? icon->tip_on : icon->tip_off);
420 gtk_widget_set_sensitive(icon->button, sensitive);
421 /* Icons with an associated menu item */
422 if(icon->item) {
423 if(icon->toggle)
424 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(icon->item),
425 !!icon->menu_invert ^ !!on);
426 gtk_widget_set_sensitive(icon->item, sensitive);
427 }
428 --suppress_actions;
429 }
430
431 static void icon_action_completed(void attribute((unused)) *v,
432 const char *err) {
433 if(err)
434 popup_protocol_error(0, err);
435 }
436
437 static void clicked_icon(GtkToolButton attribute((unused)) *button,
438 gpointer userdata) {
439 const struct icon *icon = userdata;
440
441 if(suppress_actions)
442 return;
443 icon->action_go_off(client, icon_action_completed, 0);
444 }
445
446 static void toggled_icon(GtkToggleToolButton attribute((unused)) *button,
447 gpointer user_data) {
448 const struct icon *icon = user_data;
449
450 if(suppress_actions)
451 return;
452 if(icon->on())
453 icon->action_go_off(client, icon_action_completed, 0);
454 else
455 icon->action_go_on(client, icon_action_completed, 0);
456 }
457
458 static void clicked_menu(GtkMenuItem attribute((unused)) *menuitem,
459 gpointer userdata) {
460 clicked_icon(NULL, userdata);
461 }
462
463 static void toggled_menu(GtkCheckMenuItem attribute((unused)) *menuitem,
464 gpointer userdata) {
465 toggled_icon(NULL, userdata);
466 }
467
468 /** @brief Called when a volume command completes */
469 static void volume_completed(void attribute((unused)) *v,
470 const char *err) {
471 if(err)
472 popup_protocol_error(0, err);
473 /* We don't set the UI's notion of the volume here, it is set from the log
474 * regardless of the reason it changed */
475 }
476
477 /** @brief Called when the volume has been adjusted */
478 static void volume_adjusted(GtkAdjustment attribute((unused)) *a,
479 gpointer attribute((unused)) user_data) {
480 double v = gtk_adjustment_get_value(volume_adj) / goesupto;
481 double b = gtk_adjustment_get_value(balance_adj);
482
483 if(suppress_actions)
484 /* This is the result of an update from the server, not a change from the
485 * user. Don't feedback! */
486 return;
487 D(("volume_adjusted"));
488 /* force to 'stereotypical' values */
489 v = nearbyint(100 * v) / 100;
490 b = nearbyint(5 * b) / 5;
491 /* Set the volume. We don't want a reply, we'll get the actual new volume
492 * from the log. */
493 if(rtp_supported) {
494 int l = nearbyint(left(v, b) * 100), r = nearbyint(right(v, b) * 100);
495 rtp_setvol(&l, &r);
496 } else
497 disorder_eclient_set_volume(client, volume_completed,
498 nearbyint(left(v, b) * 100),
499 nearbyint(right(v, b) * 100),
500 0);
501 }
502
503 /** @brief Formats the volume value */
504 static gchar *format_volume(GtkScale attribute((unused)) *scale,
505 gdouble value) {
506 char s[32];
507
508 snprintf(s, sizeof s, "%.1f", (double)value);
509 return g_strdup(s);
510 }
511
512 /** @brief Formats the balance value */
513 static gchar *format_balance(GtkScale attribute((unused)) *scale,
514 gdouble value) {
515 char s[32];
516
517 if(fabs(value) < 0.1)
518 return g_strdup("0");
519 snprintf(s, sizeof s, "%+.1f", (double)value);
520 return g_strdup(s);
521 }
522
523 /* Volume mapping. We consider left, right, volume to be in [0,1]
524 * and balance to be in [-1,1].
525 *
526 * First, we just have volume = max(left, right).
527 *
528 * Balance we consider to linearly represent the amount by which the quieter
529 * channel differs from the louder. In detail:
530 *
531 * if right > left then balance > 0:
532 * balance = 0 => left = right (as an endpoint, not an instance)
533 * balance = 1 => left = 0
534 * fitting to linear, left = right * (1 - balance)
535 * so balance = 1 - left / right
536 * (right > left => right > 0 so no division by 0.)
537 *
538 * if left > right then balance < 0:
539 * balance = 0 => right = left (same caveat as above)
540 * balance = -1 => right = 0
541 * again fitting to linear, right = left * (1 + balance)
542 * so balance = right / left - 1
543 * (left > right => left > 0 so no division by 0.)
544 *
545 * if left = right then we just have balance = 0.
546 *
547 * Thanks to Clive and Andrew.
548 */
549
550 /** @brief Return the greater of @p x and @p y */
551 static double max(double x, double y) {
552 return x > y ? x : y;
553 }
554
555 /** @brief Compute the left channel volume */
556 static double left(double v, double b) {
557 if(b > 0) /* volume = right */
558 return v * (1 - b);
559 else /* volume = left */
560 return v;
561 }
562
563 /** @brief Compute the right channel volume */
564 static double right(double v, double b) {
565 if(b > 0) /* volume = right */
566 return v;
567 else /* volume = left */
568 return v * (1 + b);
569 }
570
571 /** @brief Compute the overall volume */
572 static double volume(double l, double r) {
573 return max(l, r);
574 }
575
576 /** @brief Compute the balance */
577 static double balance(double l, double r) {
578 if(l > r)
579 return r / l - 1;
580 else if(r > l)
581 return 1 - l / r;
582 else /* left = right */
583 return 0;
584 }
585
586 /** @brief Called to enable RTP play
587 *
588 * Rather odd signature is to fit in with the other icons which all call @ref
589 * lib/eclient.h functions.
590 */
591 static int enable_rtp(disorder_eclient attribute((unused)) *c,
592 disorder_eclient_no_response attribute((unused)) *completed,
593 void attribute((unused)) *v) {
594 start_rtp();
595 return 0;
596 }
597
598 /** @brief Called to disable RTP play
599 *
600 * Rather odd signature is to fit in with the other icons which all call @ref
601 * lib/eclient.h functions.
602 */
603 static int disable_rtp(disorder_eclient attribute((unused)) *c,
604 disorder_eclient_no_response attribute((unused)) *completed,
605 void attribute((unused)) *v) {
606 stop_rtp();
607 return 0;
608 }
609
610 static void control_minimode(const char attribute((unused)) *event,
611 void attribute((unused)) *evendata,
612 void attribute((unused)) *callbackdata) {
613 if(full_mode && volume_supported()) {
614 gtk_widget_show(balance_widget);
615 gtk_scale_set_value_pos(GTK_SCALE(volume_widget), GTK_POS_TOP);
616 } else {
617 gtk_widget_hide(balance_widget);
618 gtk_scale_set_value_pos(GTK_SCALE(volume_widget), GTK_POS_RIGHT);
619 }
620 gtk_toolbar_set_style(GTK_TOOLBAR(toolbar),
621 full_mode ? GTK_TOOLBAR_BOTH : GTK_TOOLBAR_ICONS);
622 }
623
624 /*
625 Local Variables:
626 c-basic-offset:2
627 comment-column:40
628 fill-column:79
629 indent-tabs-mode:nil
630 End:
631 */