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