2 * This file is part of DisOrder.
3 * Copyright (C) 2006-2008 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 2 of the License, or
8 * (at your option) any later version.
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.
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
20 /** @file disobedience/control.c
21 * @brief Volume control and buttons
24 #include "disobedience.h"
27 /* Forward declarations ---------------------------------------------------- */
31 static void clicked_icon(GtkButton
*, gpointer
);
32 static void clicked_menu(GtkMenuItem
*, gpointer userdata
);
33 static void toggled_menu(GtkCheckMenuItem
*, gpointer userdata
);
35 static int enable_rtp(disorder_eclient
*c
,
36 disorder_eclient_no_response
*completed
,
38 static int disable_rtp(disorder_eclient
*c
,
39 disorder_eclient_no_response
*completed
,
42 static double left(double v
, double b
);
43 static double right(double v
, double b
);
44 static double volume(double l
, double r
);
45 static double balance(double l
, double r
);
47 static void volume_adjusted(GtkAdjustment
*a
, gpointer user_data
);
48 static gchar
*format_volume(GtkScale
*scale
, gdouble value
);
49 static gchar
*format_balance(GtkScale
*scale
, gdouble value
);
51 static void icon_changed(const char *event
,
54 static void volume_changed(const char *event
,
58 /* Control bar ------------------------------------------------------------- */
60 /** @brief Guard against feedback */
61 int suppress_actions
= 1;
63 /** @brief Definition of an icon
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").
69 * The scratch button is an action icon; currently all the others are toggle
72 * (All icons can be sensitive or insensitive, separately to the above.)
75 /** @brief Filename for 'on' image */
78 /** @brief Text for 'on' tooltip */
81 /** @brief Filename for 'off' image or NULL for an action icon */
84 /** @brief Text for 'off tooltip */
87 /** @brief Associated menu item or NULL */
90 /** @brief Events that change this icon, separated by spaces */
93 /** @brief @ref eclient.h function to call to go from off to on
95 * For action buttons, this should be NULL.
97 int (*action_go_on
)(disorder_eclient
*c
,
98 disorder_eclient_no_response
*completed
,
101 /** @brief @ref eclient.h function to call to go from on to off
103 * For action buttons, this action is used.
105 int (*action_go_off
)(disorder_eclient
*c
,
106 disorder_eclient_no_response
*completed
,
109 /** @brief Get button state
110 * @return 1 for on, 0 for off
114 /** @brief Get button sensitivity
115 * @return 1 for sensitive, 0 for insensitive
117 * Can be NULL for always sensitive.
119 int (*sensitive
)(void);
121 /** @brief Pointer to button */
124 /** @brief Pointer to menu item */
128 GtkWidget
*image_off
;
131 /* TODO: Add rights into the mix below */
133 static int pause_resume_on(void) {
134 return !(last_state
& DISORDER_TRACK_PAUSED
);
137 static int pause_resume_sensitive(void) {
138 return !!(last_state
& DISORDER_PLAYING
)
139 && (last_rights
& RIGHT_PAUSE
);
142 static int scratch_sensitive(void) {
143 return !!(last_state
& DISORDER_PLAYING
)
144 && right_scratchable(last_rights
, config
->username
, playing_track
);
147 static int random_sensitive(void) {
148 return !!(last_rights
& RIGHT_GLOBAL_PREFS
);
151 static int random_enabled(void) {
152 return !!(last_state
& DISORDER_RANDOM_ENABLED
);
155 static int playing_sensitive(void) {
156 return !!(last_rights
& RIGHT_GLOBAL_PREFS
);
159 static int playing_enabled(void) {
160 return !!(last_state
& DISORDER_PLAYING_ENABLED
);
163 static int rtp_enabled(void) {
164 return rtp_is_running
;
167 static int rtp_sensitive(void) {
168 return rtp_supported
;
171 /** @brief Table of all icons */
172 static struct icon icons
[] = {
174 icon_on
: "pause.png",
175 tip_on
: "Pause playing track",
176 icon_off
: "play.png",
177 tip_off
: "Resume playing track",
178 menuitem
: "<GdisorderMain>/Control/Playing",
180 sensitive
: pause_resume_sensitive
,
181 action_go_on
: disorder_eclient_resume
,
182 action_go_off
: disorder_eclient_pause
,
183 events
: "pause-changed playing-changed rights-changed",
186 icon_on
: "cross.png",
187 tip_on
: "Cancel playing track",
188 menuitem
: "<GdisorderMain>/Control/Scratch",
189 sensitive
: scratch_sensitive
,
190 action_go_off
: disorder_eclient_scratch_playing
,
191 events
: "playing-track-changed rights-changed",
194 icon_on
: "randomcross.png",
195 tip_on
: "Disable random play",
196 icon_off
: "random.png",
197 tip_off
: "Enable random play",
198 menuitem
: "<GdisorderMain>/Control/Random play",
200 sensitive
: random_sensitive
,
201 action_go_on
: disorder_eclient_random_enable
,
202 action_go_off
: disorder_eclient_random_disable
,
203 events
: "random-changed rights-changed",
206 icon_on
: "notescross.png",
207 tip_on
: "Disable play",
208 icon_off
: "notes.png",
209 tip_off
: "Enable play",
211 sensitive
: playing_sensitive
,
212 action_go_on
: disorder_eclient_enable
,
213 action_go_off
: disorder_eclient_disable
,
214 events
: "enabled-changed rights-changed",
217 icon_on
: "speakercross.png",
218 tip_on
: "Stop playing network stream",
219 icon_off
: "speaker.png",
220 tip_off
: "Play network stream",
221 menuitem
: "<GdisorderMain>/Control/Network player",
223 sensitive
: rtp_sensitive
,
224 action_go_on
: enable_rtp
,
225 action_go_off
: disable_rtp
,
226 events
: "rtp-changed",
230 /** @brief Count of icons */
231 #define NICONS (int)(sizeof icons / sizeof *icons)
233 static GtkAdjustment
*volume_adj
;
234 static GtkAdjustment
*balance_adj
;
235 static GtkWidget
*volume_widget
;
236 static GtkWidget
*balance_widget
;
238 /** @brief Create the control bar */
239 GtkWidget
*control_widget(void) {
240 GtkWidget
*hbox
= gtk_hbox_new(FALSE
, 1), *vbox
;
243 D(("control_widget"));
244 assert(mainmenufactory
); /* ordering must be right */
245 for(n
= 0; n
< NICONS
; ++n
) {
246 /* Create the button */
247 icons
[n
].button
= gtk_button_new();
248 gtk_widget_set_style(icons
[n
].button
, tool_style
);
249 icons
[n
].image_on
= gtk_image_new_from_pixbuf(find_image(icons
[n
].icon_on
));
250 gtk_widget_set_style(icons
[n
].image_on
, tool_style
);
251 g_object_ref(icons
[n
].image_on
);
252 /* If it's a toggle icon, create the 'off' half too */
253 if(icons
[n
].icon_off
) {
254 icons
[n
].image_off
= gtk_image_new_from_pixbuf(find_image(icons
[n
].icon_off
));
255 gtk_widget_set_style(icons
[n
].image_off
, tool_style
);
256 g_object_ref(icons
[n
].image_off
);
258 g_signal_connect(G_OBJECT(icons
[n
].button
), "clicked",
259 G_CALLBACK(clicked_icon
), &icons
[n
]);
260 /* pop the icon in a vbox so it doesn't get vertically stretch if there are
261 * taller things in the control bar */
262 vbox
= gtk_vbox_new(FALSE
, 0);
263 gtk_box_pack_start(GTK_BOX(vbox
), icons
[n
].button
, TRUE
, FALSE
, 0);
264 gtk_box_pack_start(GTK_BOX(hbox
), vbox
, FALSE
, FALSE
, 0);
265 if(icons
[n
].menuitem
) {
266 /* Find the menu item */
267 icons
[n
].item
= gtk_item_factory_get_widget(mainmenufactory
,
269 if(icons
[n
].icon_off
)
270 g_signal_connect(G_OBJECT(icons
[n
].item
), "toggled",
271 G_CALLBACK(toggled_menu
), &icons
[n
]);
273 g_signal_connect(G_OBJECT(icons
[n
].item
), "activate",
274 G_CALLBACK(clicked_menu
), &icons
[n
]);
276 /* Make sure the icon is updated when relevant things changed */
277 char **events
= split(icons
[n
].events
, 0, 0, 0, 0);
279 event_register(*events
++, icon_changed
, &icons
[n
]);
281 /* create the adjustments for the volume control */
282 volume_adj
= GTK_ADJUSTMENT(gtk_adjustment_new(0, 0, goesupto
,
283 goesupto
/ 20, goesupto
/ 20,
285 balance_adj
= GTK_ADJUSTMENT(gtk_adjustment_new(0, -1, 1,
287 /* the volume control */
288 volume_widget
= gtk_hscale_new(volume_adj
);
289 balance_widget
= gtk_hscale_new(balance_adj
);
290 gtk_widget_set_style(volume_widget
, tool_style
);
291 gtk_widget_set_style(balance_widget
, tool_style
);
292 gtk_scale_set_digits(GTK_SCALE(volume_widget
), 10);
293 gtk_scale_set_digits(GTK_SCALE(balance_widget
), 10);
294 gtk_widget_set_size_request(volume_widget
, 192, -1);
295 gtk_widget_set_size_request(balance_widget
, 192, -1);
296 gtk_tooltips_set_tip(tips
, volume_widget
, "Volume", "");
297 gtk_tooltips_set_tip(tips
, balance_widget
, "Balance", "");
298 gtk_box_pack_start(GTK_BOX(hbox
), volume_widget
, FALSE
, TRUE
, 0);
299 gtk_box_pack_start(GTK_BOX(hbox
), balance_widget
, FALSE
, TRUE
, 0);
300 /* space updates rather than hammering the server */
301 gtk_range_set_update_policy(GTK_RANGE(volume_widget
), GTK_UPDATE_DELAYED
);
302 gtk_range_set_update_policy(GTK_RANGE(balance_widget
), GTK_UPDATE_DELAYED
);
303 /* notice when the adjustments are changed */
304 g_signal_connect(G_OBJECT(volume_adj
), "value-changed",
305 G_CALLBACK(volume_adjusted
), 0);
306 g_signal_connect(G_OBJECT(balance_adj
), "value-changed",
307 G_CALLBACK(volume_adjusted
), 0);
308 /* format the volume/balance values ourselves */
309 g_signal_connect(G_OBJECT(volume_widget
), "format-value",
310 G_CALLBACK(format_volume
), 0);
311 g_signal_connect(G_OBJECT(balance_widget
), "format-value",
312 G_CALLBACK(format_balance
), 0);
313 event_register("volume-changed", volume_changed
, 0);
314 event_register("rtp-changed", volume_changed
, 0);
318 /** @brief Update the volume control when it changes */
319 static void volume_changed(const char attribute((unused
)) *event
,
320 void attribute((unused
)) *eventdata
,
321 void attribute((unused
)) *callbackdata
) {
323 gboolean volume_supported
;
325 D(("volume_changed"));
327 /* Only display volume/balance controls if they will work */
329 || (rtp_supported
&& mixer_supported(DEFAULT_BACKEND
)))
330 volume_supported
= TRUE
;
332 volume_supported
= FALSE
;
333 /* TODO: if the server doesn't know how to set the volume [but isn't using
334 * network play] then we should have volume_supported = FALSE */
335 if(volume_supported
) {
336 gtk_widget_show(volume_widget
);
337 gtk_widget_show(balance_widget
);
338 l
= volume_l
/ 100.0;
339 r
= volume_r
/ 100.0;
340 gtk_adjustment_set_value(volume_adj
, volume(l
, r
) * goesupto
);
341 gtk_adjustment_set_value(balance_adj
, balance(l
, r
));
343 gtk_widget_hide(volume_widget
);
344 gtk_widget_hide(balance_widget
);
349 /** @brief Update the state of one of the control icons
351 static void icon_changed(const char attribute((unused
)) *event
,
352 void attribute((unused
)) *evendata
,
353 void *callbackdata
) {
354 const struct icon
*const icon
= callbackdata
;
355 int on
= icon
->on ? icon
->on() : 1;
356 int sensitive
= icon
->sensitive ? icon
->sensitive() : 1;
357 GtkWidget
*child
, *newchild
;
360 /* If the connection is down nothing is ever usable */
361 if(!(last_state
& DISORDER_CONNECTED
))
363 /* Replace the child */
364 newchild
= on ? icon
->image_on
: icon
->image_off
;
365 child
= gtk_bin_get_child(GTK_BIN(icon
->button
));
366 if(child
!= newchild
) {
368 gtk_container_remove(GTK_CONTAINER(icon
->button
), child
);
369 gtk_container_add(GTK_CONTAINER(icon
->button
), newchild
);
370 gtk_widget_show(newchild
);
372 /* If you disable play or random play NOT via the icon (for instance, via the
373 * edit menu or via a completely separate command line invocation) then the
374 * icon shows up as insensitive. Hover the mouse over it and the corrcet
375 * state is immediately displayed. sensitive and GTK_WIDGET_SENSITIVE show
376 * it to be in the correct state, so I think this is may be a GTK+ bug. */
378 gtk_tooltips_set_tip(tips
, icon
->button
,
379 on ? icon
->tip_on
: icon
->tip_off
, "");
380 gtk_widget_set_sensitive(icon
->button
, sensitive
);
381 /* Icons with an associated menu item */
384 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(icon
->item
), on
);
385 gtk_widget_set_sensitive(icon
->item
, sensitive
);
390 static void icon_action_completed(void attribute((unused
)) *v
,
393 popup_protocol_error(0, error
);
396 static void clicked_icon(GtkButton
attribute((unused
)) *button
,
398 const struct icon
*icon
= userdata
;
402 if(!icon
->on
|| icon
->on())
403 icon
->action_go_off(client
, icon_action_completed
, 0);
405 icon
->action_go_on(client
, icon_action_completed
, 0);
408 static void clicked_menu(GtkMenuItem
attribute((unused
)) *menuitem
,
410 clicked_icon(NULL
, userdata
);
413 static void toggled_menu(GtkCheckMenuItem
attribute((unused
)) *menuitem
,
415 clicked_icon(NULL
, userdata
);
418 /** @brief Called when a volume command completes */
419 static void volume_completed(void attribute((unused
)) *v
,
421 int attribute((unused
)) l
,
422 int attribute((unused
)) r
) {
424 popup_protocol_error(0, error
);
425 /* We don't set the UI's notion of the volume here, it is set from the log
426 * regardless of the reason it changed */
429 /** @brief Called when the volume has been adjusted */
430 static void volume_adjusted(GtkAdjustment
attribute((unused
)) *a
,
431 gpointer
attribute((unused
)) user_data
) {
432 double v
= gtk_adjustment_get_value(volume_adj
) / goesupto
;
433 double b
= gtk_adjustment_get_value(balance_adj
);
436 /* This is the result of an update from the server, not a change from the
437 * user. Don't feedback! */
439 D(("volume_adjusted"));
440 /* force to 'stereotypical' values */
441 v
= nearbyint(100 * v
) / 100;
442 b
= nearbyint(5 * b
) / 5;
443 /* Set the volume. We don't want a reply, we'll get the actual new volume
446 int l
= nearbyint(left(v
, b
) * 100), r
= nearbyint(right(v
, b
) * 100);
447 mixer_control(DEFAULT_BACKEND
, &l
, &r
, 1);
449 disorder_eclient_volume(client
, volume_completed
,
450 nearbyint(left(v
, b
) * 100),
451 nearbyint(right(v
, b
) * 100),
455 /** @brief Formats the volume value */
456 static gchar
*format_volume(GtkScale
attribute((unused
)) *scale
,
460 snprintf(s
, sizeof s
, "%.1f", (double)value
);
464 /** @brief Formats the balance value */
465 static gchar
*format_balance(GtkScale
attribute((unused
)) *scale
,
469 if(fabs(value
) < 0.1)
470 return g_strdup("0");
471 snprintf(s
, sizeof s
, "%+.1f", (double)value
);
475 /* Volume mapping. We consider left, right, volume to be in [0,1]
476 * and balance to be in [-1,1].
478 * First, we just have volume = max(left, right).
480 * Balance we consider to linearly represent the amount by which the quieter
481 * channel differs from the louder. In detail:
483 * if right > left then balance > 0:
484 * balance = 0 => left = right (as an endpoint, not an instance)
485 * balance = 1 => left = 0
486 * fitting to linear, left = right * (1 - balance)
487 * so balance = 1 - left / right
488 * (right > left => right > 0 so no division by 0.)
490 * if left > right then balance < 0:
491 * balance = 0 => right = left (same caveat as above)
492 * balance = -1 => right = 0
493 * again fitting to linear, right = left * (1 + balance)
494 * so balance = right / left - 1
495 * (left > right => left > 0 so no division by 0.)
497 * if left = right then we just have balance = 0.
499 * Thanks to Clive and Andrew.
502 /** @brief Return the greater of @p x and @p y */
503 static double max(double x
, double y
) {
504 return x
> y ? x
: y
;
507 /** @brief Compute the left channel volume */
508 static double left(double v
, double b
) {
509 if(b
> 0) /* volume = right */
511 else /* volume = left */
515 /** @brief Compute the right channel volume */
516 static double right(double v
, double b
) {
517 if(b
> 0) /* volume = right */
519 else /* volume = left */
523 /** @brief Compute the overall volume */
524 static double volume(double l
, double r
) {
528 /** @brief Compute the balance */
529 static double balance(double l
, double r
) {
534 else /* left = right */
538 /** @brief Called to enable RTP play
540 * Rather odd signature is to fit in with the other icons which all call @ref
541 * lib/eclient.h functions.
543 static int enable_rtp(disorder_eclient
attribute((unused
)) *c
,
544 disorder_eclient_no_response
attribute((unused
)) *completed
,
545 void attribute((unused
)) *v
) {
550 /** @brief Called to disable RTP play
552 * Rather odd signature is to fit in with the other icons which all call @ref
553 * lib/eclient.h functions.
555 static int disable_rtp(disorder_eclient
attribute((unused
)) *c
,
556 disorder_eclient_no_response
attribute((unused
)) *completed
,
557 void attribute((unused
)) *v
) {