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 Pointer to button */
135 /** @brief Pointer to menu item */
141 static int pause_resume_on(void) {
142 return !!(last_state
& DISORDER_TRACK_PAUSED
);
145 static int pause_resume_sensitive(void) {
147 && !!(last_state
& DISORDER_PLAYING
)
148 && (last_rights
& RIGHT_PAUSE
);
151 static int scratch_sensitive(void) {
152 return !!(last_state
& DISORDER_PLAYING
)
153 && right_scratchable(last_rights
, config
->username
, playing_track
);
156 static int random_sensitive(void) {
157 return !!(last_rights
& RIGHT_GLOBAL_PREFS
);
160 static int random_enabled(void) {
161 return !!(last_state
& DISORDER_RANDOM_ENABLED
);
164 static int playing_sensitive(void) {
165 return !!(last_rights
& RIGHT_GLOBAL_PREFS
);
168 static int playing_enabled(void) {
169 return !!(last_state
& DISORDER_PLAYING_ENABLED
);
172 static int rtp_enabled(void) {
173 return rtp_is_running
;
176 static int rtp_sensitive(void) {
177 return rtp_supported
;
180 /** @brief Table of all icons */
181 static struct icon icons
[] = {
185 icon
: GTK_STOCK_MEDIA_PAUSE
,
187 tip_on
: "Resume playing track",
188 tip_off
: "Pause playing track",
189 menuitem
: "<GdisorderMain>/Control/Playing",
191 sensitive
: pause_resume_sensitive
,
192 action_go_on
: disorder_eclient_pause
,
193 action_go_off
: disorder_eclient_resume
,
194 events
: "pause-changed playing-changed rights-changed playing-track-changed",
198 icon
: GTK_STOCK_STOP
,
200 tip_on
: "Cancel playing track",
201 menuitem
: "<GdisorderMain>/Control/Scratch",
202 sensitive
: scratch_sensitive
,
203 action_go_off
: disorder_eclient_scratch_playing
,
204 events
: "playing-track-changed rights-changed",
211 tip_on
: "Disable random play",
212 tip_off
: "Enable random play",
213 menuitem
: "<GdisorderMain>/Control/Random play",
215 sensitive
: random_sensitive
,
216 action_go_on
: disorder_eclient_random_enable
,
217 action_go_off
: disorder_eclient_random_disable
,
218 events
: "random-changed rights-changed",
223 icon
: GTK_STOCK_MEDIA_PLAY
,
225 tip_on
: "Disable play",
226 tip_off
: "Enable play",
228 sensitive
: playing_sensitive
,
229 action_go_on
: disorder_eclient_enable
,
230 action_go_off
: disorder_eclient_disable
,
231 events
: "enabled-changed rights-changed",
236 icon
: GTK_STOCK_CONNECT
,
238 tip_on
: "Stop playing network stream",
239 tip_off
: "Play network stream",
240 menuitem
: "<GdisorderMain>/Control/Network player",
242 sensitive
: rtp_sensitive
,
243 action_go_on
: enable_rtp
,
244 action_go_off
: disable_rtp
,
245 events
: "rtp-changed",
249 /** @brief Count of icons */
250 #define NICONS (int)(sizeof icons / sizeof *icons)
252 static GtkAdjustment
*volume_adj
;
253 static GtkAdjustment
*balance_adj
;
254 static GtkWidget
*volume_widget
;
255 static GtkWidget
*balance_widget
;
257 /** @brief Create the control bar */
258 GtkWidget
*control_widget(void) {
259 GtkWidget
*hbox
= gtk_hbox_new(FALSE
, 1);
262 D(("control_widget"));
263 assert(mainmenufactory
); /* ordering must be right */
264 toolbar
= gtk_toolbar_new();
265 /* Don't permit overflow arrow as otherwise the toolbar isn't greedy enough
266 * in asking for space. The ideal is probably to make the volume and balance
267 * sliders hang down from the toolbar so it unavoidably gets the whole width
268 * of the window to play with. */
269 gtk_toolbar_set_show_arrow(GTK_TOOLBAR(toolbar
), FALSE
);
270 gtk_toolbar_set_style(GTK_TOOLBAR(toolbar
),
271 full_mode ? GTK_TOOLBAR_BOTH
: GTK_TOOLBAR_ICONS
);
272 for(n
= 0; n
< NICONS
; ++n
) {
273 struct icon
*const icon
= &icons
[n
];
274 icon
->button
= (icon
->toggle
275 ?
GTK_WIDGET(gtk_toggle_tool_button_new())
276 : GTK_WIDGET(gtk_tool_button_new(NULL
, NULL
)));
277 gtk_widget_set_style(icons
[n
].button
, tool_style
);
279 /* We'll use the stock icons for this one */
280 icon
->image
= gtk_image_new_from_stock(icons
[n
].icon
,
281 GTK_ICON_SIZE_LARGE_TOOLBAR
);
283 /* Create the 'on' image */
284 icon
->image
= gtk_image_new_from_pixbuf(find_image(icons
[n
].icon
));
287 gtk_tool_button_set_icon_widget(GTK_TOOL_BUTTON(icon
->button
),
289 gtk_tool_button_set_label(GTK_TOOL_BUTTON(icon
->button
),
292 g_signal_connect(G_OBJECT(icon
->button
), "toggled",
293 G_CALLBACK(toggled_icon
), icon
);
295 g_signal_connect(G_OBJECT(icon
->button
), "clicked",
296 G_CALLBACK(clicked_icon
), icon
);
297 gtk_toolbar_insert(GTK_TOOLBAR(toolbar
),
298 GTK_TOOL_ITEM(icon
->button
),
300 if(icons
[n
].menuitem
) {
301 /* Find the menu item */
302 icons
[n
].item
= gtk_item_factory_get_widget(mainmenufactory
,
305 g_signal_connect(G_OBJECT(icons
[n
].item
), "toggled",
306 G_CALLBACK(toggled_menu
), &icons
[n
]);
308 g_signal_connect(G_OBJECT(icons
[n
].item
), "activate",
309 G_CALLBACK(clicked_menu
), &icons
[n
]);
311 /* Make sure the icon is updated when relevant things changed */
312 char **events
= split(icons
[n
].events
, 0, 0, 0, 0);
314 event_register(*events
++, icon_changed
, &icons
[n
]);
315 event_register("connected-changed", icon_changed
, &icons
[n
]);
317 /* create the adjustments for the volume control */
318 volume_adj
= GTK_ADJUSTMENT(gtk_adjustment_new(0, 0, goesupto
,
319 goesupto
/ 20, goesupto
/ 20,
321 balance_adj
= GTK_ADJUSTMENT(gtk_adjustment_new(0, -1, 1,
323 /* the volume control */
324 volume_widget
= gtk_hscale_new(volume_adj
);
325 balance_widget
= gtk_hscale_new(balance_adj
);
326 gtk_widget_set_style(volume_widget
, tool_style
);
327 gtk_widget_set_style(balance_widget
, tool_style
);
328 gtk_scale_set_digits(GTK_SCALE(volume_widget
), 10);
329 gtk_scale_set_digits(GTK_SCALE(balance_widget
), 10);
330 gtk_widget_set_size_request(volume_widget
, 128, -1);
331 gtk_widget_set_size_request(balance_widget
, 128, -1);
332 gtk_widget_set_tooltip_text(volume_widget
, "Volume");
333 gtk_widget_set_tooltip_text(balance_widget
, "Balance");
334 gtk_box_pack_start(GTK_BOX(hbox
), toolbar
,
335 FALSE
/*expand*/, TRUE
/*fill*/, 0);
336 gtk_box_pack_start(GTK_BOX(hbox
), volume_widget
,
337 FALSE
/*expand*/, TRUE
/*fill*/, 0);
338 gtk_box_pack_start(GTK_BOX(hbox
), balance_widget
,
339 FALSE
/*expand*/, TRUE
/*fill*/, 0);
340 /* space updates rather than hammering the server */
341 gtk_range_set_update_policy(GTK_RANGE(volume_widget
), GTK_UPDATE_DELAYED
);
342 gtk_range_set_update_policy(GTK_RANGE(balance_widget
), GTK_UPDATE_DELAYED
);
343 /* notice when the adjustments are changed */
344 g_signal_connect(G_OBJECT(volume_adj
), "value-changed",
345 G_CALLBACK(volume_adjusted
), 0);
346 g_signal_connect(G_OBJECT(balance_adj
), "value-changed",
347 G_CALLBACK(volume_adjusted
), 0);
348 /* format the volume/balance values ourselves */
349 g_signal_connect(G_OBJECT(volume_widget
), "format-value",
350 G_CALLBACK(format_volume
), 0);
351 g_signal_connect(G_OBJECT(balance_widget
), "format-value",
352 G_CALLBACK(format_balance
), 0);
353 event_register("volume-changed", volume_changed
, 0);
354 event_register("rtp-changed", volume_changed
, 0);
355 event_register("mini-mode-changed", control_minimode
, 0);
359 /** @brief Return TRUE if volume setting is supported */
360 static int volume_supported(void) {
361 /* TODO: if the server doesn't know how to set the volume [but isn't using
362 * network play] then we should have volume_supported = FALSE */
363 return (!rtp_supported
364 || (rtp_supported
&& backend
&& backend
->set_volume
));
367 /** @brief Update the volume control when it changes */
368 static void volume_changed(const char attribute((unused
)) *event
,
369 void attribute((unused
)) *eventdata
,
370 void attribute((unused
)) *callbackdata
) {
373 D(("volume_changed"));
375 /* Only display volume/balance controls if they will work */
376 if(volume_supported()) {
377 gtk_widget_show(volume_widget
);
379 gtk_widget_show(balance_widget
);
380 l
= volume_l
/ 100.0;
381 r
= volume_r
/ 100.0;
382 gtk_adjustment_set_value(volume_adj
, volume(l
, r
) * goesupto
);
383 gtk_adjustment_set_value(balance_adj
, balance(l
, r
));
385 gtk_widget_hide(volume_widget
);
386 gtk_widget_hide(balance_widget
);
391 /** @brief Update the state of one of the control icons
393 static void icon_changed(const char attribute((unused
)) *event
,
394 void attribute((unused
)) *evendata
,
395 void *callbackdata
) {
396 //fprintf(stderr, "icon_changed (%s)\n", event);
397 const struct icon
*const icon
= callbackdata
;
398 int on
= icon
->on ? icon
->on() : 1;
399 int sensitive
= icon
->sensitive ? icon
->sensitive() : 1;
400 //fprintf(stderr, "sensitive->%d\n", sensitive);
403 /* If the connection is down nothing is ever usable */
404 if(!(last_state
& DISORDER_CONNECTED
))
407 gtk_toggle_tool_button_set_active(GTK_TOGGLE_TOOL_BUTTON(icon
->button
),
409 /* If you disable play or random play NOT via the icon (for instance, via the
410 * edit menu or via a completely separate command line invocation) then the
411 * icon shows up as insensitive. Hover the mouse over it and the correct
412 * state is immediately displayed. sensitive and GTK_WIDGET_SENSITIVE show
413 * it to be in the correct state, so I think this is may be a GTK+ bug. */
415 gtk_widget_set_tooltip_text(icon
->button
,
416 on ? icon
->tip_on
: icon
->tip_off
);
417 gtk_widget_set_sensitive(icon
->button
, sensitive
);
418 /* Icons with an associated menu item */
421 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(icon
->item
), on
);
422 gtk_widget_set_sensitive(icon
->item
, sensitive
);
427 static void icon_action_completed(void attribute((unused
)) *v
,
430 popup_protocol_error(0, err
);
433 static void clicked_icon(GtkToolButton
attribute((unused
)) *button
,
435 const struct icon
*icon
= userdata
;
439 icon
->action_go_off(client
, icon_action_completed
, 0);
442 static void toggled_icon(GtkToggleToolButton
attribute((unused
)) *button
,
443 gpointer user_data
) {
444 const struct icon
*icon
= user_data
;
449 icon
->action_go_off(client
, icon_action_completed
, 0);
451 icon
->action_go_on(client
, icon_action_completed
, 0);
454 static void clicked_menu(GtkMenuItem
attribute((unused
)) *menuitem
,
456 clicked_icon(NULL
, userdata
);
459 static void toggled_menu(GtkCheckMenuItem
attribute((unused
)) *menuitem
,
461 toggled_icon(NULL
, userdata
);
464 /** @brief Called when a volume command completes */
465 static void volume_completed(void attribute((unused
)) *v
,
467 int attribute((unused
)) l
,
468 int attribute((unused
)) r
) {
470 popup_protocol_error(0, err
);
471 /* We don't set the UI's notion of the volume here, it is set from the log
472 * regardless of the reason it changed */
475 /** @brief Called when the volume has been adjusted */
476 static void volume_adjusted(GtkAdjustment
attribute((unused
)) *a
,
477 gpointer
attribute((unused
)) user_data
) {
478 double v
= gtk_adjustment_get_value(volume_adj
) / goesupto
;
479 double b
= gtk_adjustment_get_value(balance_adj
);
482 /* This is the result of an update from the server, not a change from the
483 * user. Don't feedback! */
485 D(("volume_adjusted"));
486 /* force to 'stereotypical' values */
487 v
= nearbyint(100 * v
) / 100;
488 b
= nearbyint(5 * b
) / 5;
489 /* Set the volume. We don't want a reply, we'll get the actual new volume
492 int l
= nearbyint(left(v
, b
) * 100), r
= nearbyint(right(v
, b
) * 100);
493 if(backend
&& backend
->set_volume
)
494 backend
->set_volume(&l
, &r
);
496 disorder_eclient_volume(client
, volume_completed
,
497 nearbyint(left(v
, b
) * 100),
498 nearbyint(right(v
, b
) * 100),
502 /** @brief Formats the volume value */
503 static gchar
*format_volume(GtkScale
attribute((unused
)) *scale
,
507 snprintf(s
, sizeof s
, "%.1f", (double)value
);
511 /** @brief Formats the balance value */
512 static gchar
*format_balance(GtkScale
attribute((unused
)) *scale
,
516 if(fabs(value
) < 0.1)
517 return g_strdup("0");
518 snprintf(s
, sizeof s
, "%+.1f", (double)value
);
522 /* Volume mapping. We consider left, right, volume to be in [0,1]
523 * and balance to be in [-1,1].
525 * First, we just have volume = max(left, right).
527 * Balance we consider to linearly represent the amount by which the quieter
528 * channel differs from the louder. In detail:
530 * if right > left then balance > 0:
531 * balance = 0 => left = right (as an endpoint, not an instance)
532 * balance = 1 => left = 0
533 * fitting to linear, left = right * (1 - balance)
534 * so balance = 1 - left / right
535 * (right > left => right > 0 so no division by 0.)
537 * if left > right then balance < 0:
538 * balance = 0 => right = left (same caveat as above)
539 * balance = -1 => right = 0
540 * again fitting to linear, right = left * (1 + balance)
541 * so balance = right / left - 1
542 * (left > right => left > 0 so no division by 0.)
544 * if left = right then we just have balance = 0.
546 * Thanks to Clive and Andrew.
549 /** @brief Return the greater of @p x and @p y */
550 static double max(double x
, double y
) {
551 return x
> y ? x
: y
;
554 /** @brief Compute the left channel volume */
555 static double left(double v
, double b
) {
556 if(b
> 0) /* volume = right */
558 else /* volume = left */
562 /** @brief Compute the right channel volume */
563 static double right(double v
, double b
) {
564 if(b
> 0) /* volume = right */
566 else /* volume = left */
570 /** @brief Compute the overall volume */
571 static double volume(double l
, double r
) {
575 /** @brief Compute the balance */
576 static double balance(double l
, double r
) {
581 else /* left = right */
585 /** @brief Called to enable RTP play
587 * Rather odd signature is to fit in with the other icons which all call @ref
588 * lib/eclient.h functions.
590 static int enable_rtp(disorder_eclient
attribute((unused
)) *c
,
591 disorder_eclient_no_response
attribute((unused
)) *completed
,
592 void attribute((unused
)) *v
) {
597 /** @brief Called to disable RTP play
599 * Rather odd signature is to fit in with the other icons which all call @ref
600 * lib/eclient.h functions.
602 static int disable_rtp(disorder_eclient
attribute((unused
)) *c
,
603 disorder_eclient_no_response
attribute((unused
)) *completed
,
604 void attribute((unused
)) *v
) {
609 static void control_minimode(const char attribute((unused
)) *event
,
610 void attribute((unused
)) *evendata
,
611 void attribute((unused
)) *callbackdata
) {
612 if(full_mode
&& volume_supported()) {
613 gtk_widget_show(balance_widget
);
614 gtk_scale_set_value_pos(GTK_SCALE(volume_widget
), GTK_POS_TOP
);
616 gtk_widget_hide(balance_widget
);
617 gtk_scale_set_value_pos(GTK_SCALE(volume_widget
), GTK_POS_RIGHT
);
619 gtk_toolbar_set_style(GTK_TOOLBAR(toolbar
),
620 full_mode ? GTK_TOOLBAR_BOTH
: GTK_TOOLBAR_ICONS
);