chiark / gitweb /
set explicit colors instead of using rc file
[disorder] / disobedience / control.c
CommitLineData
460b9539 1/*
2 * This file is part of DisOrder.
eb525fcd 3 * Copyright (C) 2006, 2007 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"
25
e9b70a84 26/* Forward declarations ---------------------------------------------------- */
27
28WT(adjustment);
29WT(hscale);
30WT(hbox);
e9b70a84 31WT(button);
32WT(image);
33WT(label);
34WT(vbox);
460b9539 35
36struct icon;
37
38static void update_pause(const struct icon *);
39static void update_play(const struct icon *);
40static void update_scratch(const struct icon *);
41static void update_random_enable(const struct icon *);
42static void update_random_disable(const struct icon *);
43static void update_enable(const struct icon *);
44static void update_disable(const struct icon *);
a99c4e9a
RK
45static void update_rtp(const struct icon *);
46static void update_nortp(const struct icon *);
460b9539 47static void clicked_icon(GtkButton *, gpointer);
ac6bf2ba 48static void clicked_menu(GtkMenuItem *, gpointer userdata);
2d504956 49static void toggled_menu(GtkCheckMenuItem *, gpointer userdata);
460b9539 50
a99c4e9a
RK
51static int enable_rtp(disorder_eclient *c,
52 disorder_eclient_no_response *completed,
53 void *v);
54static int disable_rtp(disorder_eclient *c,
55 disorder_eclient_no_response *completed,
56 void *v);
57
460b9539 58static double left(double v, double b);
59static double right(double v, double b);
60static double volume(double l, double r);
61static double balance(double l, double r);
62
63static void volume_adjusted(GtkAdjustment *a, gpointer user_data);
64static gchar *format_volume(GtkScale *scale, gdouble value);
65static gchar *format_balance(GtkScale *scale, gdouble value);
66
67/* Control bar ------------------------------------------------------------- */
68
219dc95c 69/** @brief Guard against feedback loop in volume control */
460b9539 70static int suppress_set_volume;
460b9539 71
219dc95c
RK
72/** @brief Definition of an icon
73 *
74 * The design here is rather mad: rather than changing the image displayed by
75 * icons according to their state, we flip the visibility of pairs of icons.
76 */
77struct icon {
78 /** @brief Filename for image */
460b9539 79 const char *icon;
219dc95c
RK
80
81 /** @brief Text for tooltip */
460b9539 82 const char *tip;
219dc95c 83
ac6bf2ba
RK
84 /** @brief Associated menu item or NULL */
85 const char *menuitem;
219dc95c
RK
86
87 /** @brief Called to update button when state may have changed */
460b9539 88 void (*update)(const struct icon *i);
219dc95c
RK
89
90 /** @brief @ref eclient.h function to call */
460b9539 91 int (*action)(disorder_eclient *c,
92 disorder_eclient_no_response *completed,
93 void *v);
219dc95c 94
2d504956
RK
95 /** @brief Flag */
96 unsigned flags;
97
219dc95c 98 /** @brief Pointer to button */
460b9539 99 GtkWidget *button;
ac6bf2ba
RK
100
101 /** @brief Pointer to menu item */
102 GtkWidget *item;
219dc95c
RK
103};
104
2d504956
RK
105/** @brief This is the active half of a pair */
106#define ICON_ACTIVE 0x0001
107
108/** @brief This is the inactive half of a pair */
109#define ICON_INACTIVE 0x0002
110
219dc95c
RK
111/** @brief Table of all icons */
112static struct icon icons[] = {
2d504956
RK
113 {
114 "pause.png", /* icon */
115 "Pause playing track", /* tip */
685bdfbd 116 "<GdisorderMain>/Control/Playing", /* menuitem */
2d504956
RK
117 update_pause, /* update */
118 disorder_eclient_pause, /* action */
685bdfbd 119 ICON_ACTIVE, /* flags */
2d504956
RK
120 0, /* button */
121 0 /* item */
122 },
123 {
124 "play.png", /* icon */
125 "Resume playing track", /* tip */
685bdfbd 126 "<GdisorderMain>/Control/Playing", /* menuitem */
2d504956
RK
127 update_play, /* update */
128 disorder_eclient_resume, /* action */
685bdfbd 129 ICON_INACTIVE, /* flags */
2d504956
RK
130 0, /* button */
131 0 /* item */
132 },
133 {
134 "cross.png", /* icon */
135 "Cancel playing track", /* tip */
136 "<GdisorderMain>/Control/Scratch", /* menuitem */
137 update_scratch, /* update */
138 disorder_eclient_scratch_playing, /* action */
139 0, /* flags */
140 0, /* button */
141 0 /* item */
142 },
143 {
144 "random.png", /* icon */
145 "Enable random play", /* tip */
146 "<GdisorderMain>/Control/Random play", /* menuitem */
147 update_random_enable, /* update */
148 disorder_eclient_random_enable, /* action */
149 ICON_INACTIVE, /* flags */
150 0, /* button */
151 0 /* item */
152 },
153 {
154 "randomcross.png", /* icon */
155 "Disable random play", /* tip */
156 "<GdisorderMain>/Control/Random play", /* menuitem */
157 update_random_disable, /* update */
158 disorder_eclient_random_disable, /* action */
159 ICON_ACTIVE, /* flags */
160 0, /* button */
161 0 /* item */
162 },
163 {
164 "notes.png", /* icon */
165 "Enable play", /* tip */
166 0, /* menuitem */
167 update_enable, /* update */
168 disorder_eclient_enable, /* action */
169 ICON_INACTIVE, /* flags */
170 0, /* button */
171 0 /* item */
172 },
173 {
174 "notescross.png", /* icon */
175 "Disable play", /* tip */
176 0, /* menuitem */
177 update_disable, /* update */
178 disorder_eclient_disable, /* action */
179 ICON_ACTIVE, /* flags */
180 0, /* button */
181 0 /* item */
182 },
183 {
184 "speaker.png", /* icon */
185 "Play network stream", /* tip */
685bdfbd 186 "<GdisorderMain>/Control/Network player", /* menuitem */
2d504956
RK
187 update_rtp, /* update */
188 enable_rtp, /* action */
189 ICON_INACTIVE, /* flags */
190 0, /* button */
191 0 /* item */
192 },
193 {
194 "speakercross.png", /* icon */
195 "Stop playing network stream", /* tip */
685bdfbd 196 "<GdisorderMain>/Control/Network player", /* menuitem */
2d504956
RK
197 update_nortp, /* update */
198 disable_rtp, /* action */
199 ICON_ACTIVE, /* flags */
200 0, /* button */
201 0 /* item */
202 },
460b9539 203};
219dc95c
RK
204
205/** @brief Count of icons */
460b9539 206#define NICONS (int)(sizeof icons / sizeof *icons)
207
219dc95c
RK
208static GtkAdjustment *volume_adj;
209static GtkAdjustment *balance_adj;
460b9539 210
6d1302f0 211/** @brief Called whenever last_state changes in any way */
a99c4e9a 212void control_monitor(void attribute((unused)) *u) {
6d1302f0
RK
213 int n;
214
215 D(("control_monitor"));
216 for(n = 0; n < NICONS; ++n)
217 icons[n].update(&icons[n]);
218}
219
219dc95c 220/** @brief Create the control bar */
e9b70a84 221GtkWidget *control_widget(void) {
460b9539 222 GtkWidget *hbox = gtk_hbox_new(FALSE, 1), *vbox;
223 GtkWidget *content;
224 GdkPixbuf *pb;
225 GtkWidget *v, *b;
460b9539 226 int n;
227
e9b70a84 228 NW(hbox);
460b9539 229 D(("control_widget"));
ac6bf2ba 230 assert(mainmenufactory); /* ordering must be right */
460b9539 231 for(n = 0; n < NICONS; ++n) {
e9b70a84 232 NW(button);
460b9539 233 icons[n].button = gtk_button_new();
d4ef4132
RK
234 gtk_widget_modify_bg(icons[n].button, GTK_STATE_NORMAL, &tool_bg);
235 gtk_widget_modify_bg(icons[n].button, GTK_STATE_ACTIVE, &tool_active);
236 gtk_widget_modify_bg(icons[n].button, GTK_STATE_PRELIGHT, &tool_active);
237 gtk_widget_modify_bg(icons[n].button, GTK_STATE_SELECTED, &tool_active);
e9b70a84 238 if((pb = find_image(icons[n].icon))) {
239 NW(image);
460b9539 240 content = gtk_image_new_from_pixbuf(pb);
e9b70a84 241 } else {
242 NW(label);
460b9539 243 content = gtk_label_new(icons[n].icon);
e9b70a84 244 }
460b9539 245 gtk_container_add(GTK_CONTAINER(icons[n].button), content);
246 gtk_tooltips_set_tip(tips, icons[n].button, icons[n].tip, "");
247 g_signal_connect(G_OBJECT(icons[n].button), "clicked",
ac6bf2ba 248 G_CALLBACK(clicked_icon), &icons[n]);
460b9539 249 /* pop the icon in a vbox so it doesn't get vertically stretch if there are
250 * taller things in the control bar */
e9b70a84 251 NW(vbox);
460b9539 252 vbox = gtk_vbox_new(FALSE, 0);
253 gtk_box_pack_start(GTK_BOX(vbox), icons[n].button, TRUE, FALSE, 0);
254 gtk_box_pack_start(GTK_BOX(hbox), vbox, FALSE, FALSE, 0);
ac6bf2ba
RK
255 if(icons[n].menuitem) {
256 icons[n].item = gtk_item_factory_get_widget(mainmenufactory,
257 icons[n].menuitem);
2d504956
RK
258 switch(icons[n].flags & (ICON_ACTIVE|ICON_INACTIVE)) {
259 case ICON_ACTIVE:
260 g_signal_connect(G_OBJECT(icons[n].item), "toggled",
261 G_CALLBACK(toggled_menu), &icons[n]);
262 break;
263 case ICON_INACTIVE:
264 /* Don't connect two instances of the signal! */
265 break;
266 default:
267 g_signal_connect(G_OBJECT(icons[n].item), "activate",
268 G_CALLBACK(clicked_menu), &icons[n]);
269 break;
270 }
ac6bf2ba 271 }
460b9539 272 }
273 /* create the adjustments for the volume control */
e9b70a84 274 NW(adjustment);
460b9539 275 volume_adj = GTK_ADJUSTMENT(gtk_adjustment_new(0, 0, goesupto,
276 goesupto / 20, goesupto / 20,
277 0));
e9b70a84 278 NW(adjustment);
460b9539 279 balance_adj = GTK_ADJUSTMENT(gtk_adjustment_new(0, -1, 1,
280 0.2, 0.2, 0));
281 /* the volume control */
e9b70a84 282 NW(hscale);
460b9539 283 v = gtk_hscale_new(volume_adj);
e9b70a84 284 NW(hscale);
460b9539 285 b = gtk_hscale_new(balance_adj);
d4ef4132
RK
286 set_slider_colors(v);
287 set_slider_colors(b);
460b9539 288 gtk_scale_set_digits(GTK_SCALE(v), 10);
289 gtk_scale_set_digits(GTK_SCALE(b), 10);
290 gtk_widget_set_size_request(v, 192, -1);
291 gtk_widget_set_size_request(b, 192, -1);
292 gtk_tooltips_set_tip(tips, v, "Volume", "");
293 gtk_tooltips_set_tip(tips, b, "Balance", "");
294 gtk_box_pack_start(GTK_BOX(hbox), v, FALSE, TRUE, 0);
295 gtk_box_pack_start(GTK_BOX(hbox), b, FALSE, TRUE, 0);
296 /* space updates rather than hammering the server */
297 gtk_range_set_update_policy(GTK_RANGE(v), GTK_UPDATE_DELAYED);
298 gtk_range_set_update_policy(GTK_RANGE(b), GTK_UPDATE_DELAYED);
299 /* notice when the adjustments are changed */
300 g_signal_connect(G_OBJECT(volume_adj), "value-changed",
301 G_CALLBACK(volume_adjusted), 0);
302 g_signal_connect(G_OBJECT(balance_adj), "value-changed",
303 G_CALLBACK(volume_adjusted), 0);
304 /* format the volume/balance values ourselves */
305 g_signal_connect(G_OBJECT(v), "format-value",
306 G_CALLBACK(format_volume), 0);
307 g_signal_connect(G_OBJECT(b), "format-value",
308 G_CALLBACK(format_balance), 0);
00959300 309 register_monitor(control_monitor, 0, -1UL);
460b9539 310 return hbox;
311}
312
6d1302f0
RK
313/** @brief Update the volume control when it changes */
314void volume_update(void) {
460b9539 315 double l, r;
316
6d1302f0 317 D(("volume_update"));
460b9539 318 l = volume_l / 100.0;
319 r = volume_r / 100.0;
00959300 320 ++suppress_set_volume;
460b9539 321 gtk_adjustment_set_value(volume_adj, volume(l, r) * goesupto);
322 gtk_adjustment_set_value(balance_adj, balance(l, r));
323 --suppress_set_volume;
324}
325
ad58ebcc 326/** @brief Update the state of one of the control icons
00959300 327 * @param icon Target icon
ad58ebcc 328 * @param visible True if this version of the button should be visible
329 * @param usable True if the button is currently usable
330 *
331 * Several of the icons, rather bizarrely, come in pairs: for instance exactly
332 * one of the play and pause buttons is supposed to be visible at any given
333 * moment.
334 *
335 * @p usable need not take into account server availability, that is done
336 * automatically.
337 */
00959300 338static void update_icon(const struct icon *icon,
ad58ebcc 339 int visible, int usable) {
340 /* If the connection is down nothing is ever usable */
00959300 341 if(!(last_state & DISORDER_CONNECTED))
ad58ebcc 342 usable = 0;
00959300 343 (visible ? gtk_widget_show : gtk_widget_hide)(icon->button);
ad58ebcc 344 /* Only both updating usability if the button is visible */
345 if(visible)
00959300 346 gtk_widget_set_sensitive(icon->button, usable);
ac6bf2ba 347 if(icon->item) {
2d504956
RK
348 /* There's an associated menu item. These are always visible, but may not
349 * be usable. */
350 if((icon->flags & (ICON_ACTIVE|ICON_INACTIVE)) == ICON_ACTIVE) {
351 /* The active half of a pair */
352 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(icon->item), visible);
353 }
354 gtk_widget_set_sensitive(icon->item, usable);
ac6bf2ba 355 }
460b9539 356}
357
358static void update_pause(const struct icon *icon) {
00959300
RK
359 const int visible = !(last_state & DISORDER_TRACK_PAUSED);
360 const int usable = !!(last_state & DISORDER_PLAYING); /* TODO: might be a lie */
361 update_icon(icon, visible, usable);
460b9539 362}
363
364static void update_play(const struct icon *icon) {
00959300
RK
365 const int visible = !!(last_state & DISORDER_TRACK_PAUSED);
366 const int usable = !!(last_state & DISORDER_PLAYING);
367 update_icon(icon, visible, usable);
460b9539 368}
369
370static void update_scratch(const struct icon *icon) {
00959300
RK
371 const int visible = 1;
372 const int usable = !!(last_state & DISORDER_PLAYING);
373 update_icon(icon, visible, usable);
460b9539 374}
375
376static void update_random_enable(const struct icon *icon) {
00959300
RK
377 const int visible = !(last_state & DISORDER_RANDOM_ENABLED);
378 const int usable = 1;
379 update_icon(icon, visible, usable);
460b9539 380}
381
382static void update_random_disable(const struct icon *icon) {
00959300
RK
383 const int visible = !!(last_state & DISORDER_RANDOM_ENABLED);
384 const int usable = 1;
385 update_icon(icon, visible, usable);
460b9539 386}
387
388static void update_enable(const struct icon *icon) {
00959300
RK
389 const int visible = !(last_state & DISORDER_PLAYING_ENABLED);
390 const int usable = 1;
391 update_icon(icon, visible, usable);
460b9539 392}
393
394static void update_disable(const struct icon *icon) {
00959300
RK
395 const int visible = !!(last_state & DISORDER_PLAYING_ENABLED);
396 const int usable = 1;
397 update_icon(icon, visible, usable);
460b9539 398}
399
a99c4e9a
RK
400static void update_rtp(const struct icon *icon) {
401 const int visible = !rtp_is_running;
402 const int usable = rtp_supported;
403 update_icon(icon, visible, usable);
404}
405
406static void update_nortp(const struct icon *icon) {
407 const int visible = rtp_is_running;
408 const int usable = rtp_supported;
409 update_icon(icon, visible, usable);
410}
411
460b9539 412static void clicked_icon(GtkButton attribute((unused)) *button,
413 gpointer userdata) {
414 const struct icon *icon = userdata;
415
416 icon->action(client, 0, 0);
417}
418
ac6bf2ba
RK
419static void clicked_menu(GtkMenuItem attribute((unused)) *menuitem,
420 gpointer userdata) {
421 const struct icon *icon = userdata;
422
423 icon->action(client, 0, 0);
424}
425
2d504956
RK
426static void toggled_menu(GtkCheckMenuItem *menuitem,
427 gpointer userdata) {
428 const struct icon *icon = userdata;
429 size_t n;
430
431 /* This is a bit fiddlier than the others, we need to find the action for the
432 * new state. If the new state is active then we want the ICON_INACTIVE
433 * version and vica versa. */
434 for(n = 0; n < NICONS; ++n)
435 if(icons[n].item == icon->item
436 && !!(icons[n].flags & ICON_INACTIVE) == !!menuitem->active)
437 break;
438 if(n < NICONS)
439 icons[n].action(client, 0, 0);
440}
441
219dc95c 442/** @brief Called when the volume has been adjusted */
460b9539 443static void volume_adjusted(GtkAdjustment attribute((unused)) *a,
444 gpointer attribute((unused)) user_data) {
445 double v = gtk_adjustment_get_value(volume_adj) / goesupto;
446 double b = gtk_adjustment_get_value(balance_adj);
447
448 if(suppress_set_volume)
449 /* This is the result of an update from the server, not a change from the
450 * user. Don't feedback! */
451 return;
452 D(("volume_adjusted"));
453 /* force to 'stereotypical' values */
454 v = nearbyint(100 * v) / 100;
455 b = nearbyint(5 * b) / 5;
456 /* Set the volume. We don't want a reply, we'll get the actual new volume
457 * from the log. */
458 disorder_eclient_volume(client, 0,
459 nearbyint(left(v, b) * 100),
460 nearbyint(right(v, b) * 100),
461 0);
462}
463
219dc95c 464/** @brief Formats the volume value */
460b9539 465static gchar *format_volume(GtkScale attribute((unused)) *scale,
466 gdouble value) {
467 char s[32];
468
469 snprintf(s, sizeof s, "%.1f", (double)value);
2fc4475d 470 return g_strdup(s);
460b9539 471}
472
219dc95c 473/** @brief Formats the balance value */
460b9539 474static gchar *format_balance(GtkScale attribute((unused)) *scale,
475 gdouble value) {
476 char s[32];
477
478 if(fabs(value) < 0.1)
2fc4475d 479 return g_strdup("0");
460b9539 480 snprintf(s, sizeof s, "%+.1f", (double)value);
2fc4475d 481 return g_strdup(s);
460b9539 482}
483
484/* Volume mapping. We consider left, right, volume to be in [0,1]
485 * and balance to be in [-1,1].
486 *
487 * First, we just have volume = max(left, right).
488 *
489 * Balance we consider to linearly represent the amount by which the quieter
490 * channel differs from the louder. In detail:
491 *
492 * if right > left then balance > 0:
493 * balance = 0 => left = right (as an endpoint, not an instance)
494 * balance = 1 => left = 0
495 * fitting to linear, left = right * (1 - balance)
496 * so balance = 1 - left / right
497 * (right > left => right > 0 so no division by 0.)
498 *
499 * if left > right then balance < 0:
500 * balance = 0 => right = left (same caveat as above)
501 * balance = -1 => right = 0
502 * again fitting to linear, right = left * (1 + balance)
503 * so balance = right / left - 1
504 * (left > right => left > 0 so no division by 0.)
505 *
506 * if left = right then we just have balance = 0.
507 *
508 * Thanks to Clive and Andrew.
509 */
510
219dc95c 511/** @brief Return the greater of @p x and @p y */
460b9539 512static double max(double x, double y) {
513 return x > y ? x : y;
514}
515
219dc95c 516/** @brief Compute the left channel volume */
460b9539 517static double left(double v, double b) {
518 if(b > 0) /* volume = right */
519 return v * (1 - b);
520 else /* volume = left */
521 return v;
522}
523
219dc95c 524/** @brief Compute the right channel volume */
460b9539 525static double right(double v, double b) {
526 if(b > 0) /* volume = right */
527 return v;
528 else /* volume = left */
529 return v * (1 + b);
530}
531
219dc95c 532/** @brief Compute the overall volume */
460b9539 533static double volume(double l, double r) {
534 return max(l, r);
535}
536
219dc95c 537/** @brief Compute the balance */
460b9539 538static double balance(double l, double r) {
539 if(l > r)
540 return r / l - 1;
541 else if(r > l)
542 return 1 - l / r;
543 else /* left = right */
544 return 0;
545}
546
a99c4e9a
RK
547/** @brief Called to enable RTP play
548 *
549 * Rather odd signature is to fit in with the other icons which all call @ref
550 * lib/eclient.h functions.
551 */
552static int enable_rtp(disorder_eclient attribute((unused)) *c,
553 disorder_eclient_no_response attribute((unused)) *completed,
554 void attribute((unused)) *v) {
555 start_rtp();
556 return 0;
557}
558
559/** @brief Called to disable RTP play
560 *
561 * Rather odd signature is to fit in with the other icons which all call @ref
562 * lib/eclient.h functions.
563 */
564static int disable_rtp(disorder_eclient attribute((unused)) *c,
565 disorder_eclient_no_response attribute((unused)) *completed,
566 void attribute((unused)) *v) {
567 stop_rtp();
568 return 0;
569}
570
460b9539 571/*
572Local Variables:
573c-basic-offset:2
574comment-column:40
575fill-column:79
576indent-tabs-mode:nil
577End:
578*/