2 * This file is part of DisOrder.
3 * Copyright (C) 2006, 2007 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"
26 /* Forward declarations ---------------------------------------------------- */
38 static void update_pause(const struct icon
*);
39 static void update_play(const struct icon
*);
40 static void update_scratch(const struct icon
*);
41 static void update_random_enable(const struct icon
*);
42 static void update_random_disable(const struct icon
*);
43 static void update_enable(const struct icon
*);
44 static void update_disable(const struct icon
*);
45 static void update_rtp(const struct icon
*);
46 static void update_nortp(const struct icon
*);
47 static void clicked_icon(GtkButton
*, gpointer
);
48 static void clicked_menu(GtkMenuItem
*, gpointer userdata
);
49 static void toggled_menu(GtkCheckMenuItem
*, gpointer userdata
);
51 static int enable_rtp(disorder_eclient
*c
,
52 disorder_eclient_no_response
*completed
,
54 static int disable_rtp(disorder_eclient
*c
,
55 disorder_eclient_no_response
*completed
,
58 static double left(double v
, double b
);
59 static double right(double v
, double b
);
60 static double volume(double l
, double r
);
61 static double balance(double l
, double r
);
63 static void volume_adjusted(GtkAdjustment
*a
, gpointer user_data
);
64 static gchar
*format_volume(GtkScale
*scale
, gdouble value
);
65 static gchar
*format_balance(GtkScale
*scale
, gdouble value
);
67 /* Control bar ------------------------------------------------------------- */
69 /** @brief Guard against feedback loop in volume control */
70 static int suppress_set_volume
;
72 /** @brief Definition of an icon
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.
78 /** @brief Filename for image */
81 /** @brief Text for tooltip */
84 /** @brief Associated menu item or NULL */
87 /** @brief Called to update button when state may have changed */
88 void (*update
)(const struct icon
*i
);
90 /** @brief @ref eclient.h function to call */
91 int (*action
)(disorder_eclient
*c
,
92 disorder_eclient_no_response
*completed
,
98 /** @brief Pointer to button */
101 /** @brief Pointer to menu item */
105 /** @brief This is the active half of a pair */
106 #define ICON_ACTIVE 0x0001
108 /** @brief This is the inactive half of a pair */
109 #define ICON_INACTIVE 0x0002
111 /** @brief Table of all icons */
112 static struct icon icons
[] = {
114 "pause.png", /* icon */
115 "Pause playing track", /* tip */
117 update_pause
, /* update */
118 disorder_eclient_pause
, /* action */
119 ICON_INACTIVE
, /* flags */
124 "play.png", /* icon */
125 "Resume playing track", /* tip */
127 update_play
, /* update */
128 disorder_eclient_resume
, /* action */
129 ICON_ACTIVE
, /* flags */
134 "cross.png", /* icon */
135 "Cancel playing track", /* tip */
136 "<GdisorderMain>/Control/Scratch", /* menuitem */
137 update_scratch
, /* update */
138 disorder_eclient_scratch_playing
, /* action */
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 */
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 */
164 "notes.png", /* icon */
165 "Enable play", /* tip */
167 update_enable
, /* update */
168 disorder_eclient_enable
, /* action */
169 ICON_INACTIVE
, /* flags */
174 "notescross.png", /* icon */
175 "Disable play", /* tip */
177 update_disable
, /* update */
178 disorder_eclient_disable
, /* action */
179 ICON_ACTIVE
, /* flags */
184 "speaker.png", /* icon */
185 "Play network stream", /* tip */
187 update_rtp
, /* update */
188 enable_rtp
, /* action */
189 ICON_INACTIVE
, /* flags */
194 "speakercross.png", /* icon */
195 "Stop playing network stream", /* tip */
197 update_nortp
, /* update */
198 disable_rtp
, /* action */
199 ICON_ACTIVE
, /* flags */
205 /** @brief Count of icons */
206 #define NICONS (int)(sizeof icons / sizeof *icons)
208 static GtkAdjustment
*volume_adj
;
209 static GtkAdjustment
*balance_adj
;
211 /** @brief Called whenever last_state changes in any way */
212 void control_monitor(void attribute((unused
)) *u
) {
215 D(("control_monitor"));
216 for(n
= 0; n
< NICONS
; ++n
)
217 icons
[n
].update(&icons
[n
]);
220 /** @brief Create the control bar */
221 GtkWidget
*control_widget(void) {
222 GtkWidget
*hbox
= gtk_hbox_new(FALSE
, 1), *vbox
;
229 D(("control_widget"));
230 assert(mainmenufactory
); /* ordering must be right */
231 for(n
= 0; n
< NICONS
; ++n
) {
233 icons
[n
].button
= gtk_button_new();
234 if((pb
= find_image(icons
[n
].icon
))) {
236 content
= gtk_image_new_from_pixbuf(pb
);
239 content
= gtk_label_new(icons
[n
].icon
);
241 gtk_container_add(GTK_CONTAINER(icons
[n
].button
), content
);
242 gtk_tooltips_set_tip(tips
, icons
[n
].button
, icons
[n
].tip
, "");
243 g_signal_connect(G_OBJECT(icons
[n
].button
), "clicked",
244 G_CALLBACK(clicked_icon
), &icons
[n
]);
245 /* pop the icon in a vbox so it doesn't get vertically stretch if there are
246 * taller things in the control bar */
248 vbox
= gtk_vbox_new(FALSE
, 0);
249 gtk_box_pack_start(GTK_BOX(vbox
), icons
[n
].button
, TRUE
, FALSE
, 0);
250 gtk_box_pack_start(GTK_BOX(hbox
), vbox
, FALSE
, FALSE
, 0);
251 if(icons
[n
].menuitem
) {
252 icons
[n
].item
= gtk_item_factory_get_widget(mainmenufactory
,
254 switch(icons
[n
].flags
& (ICON_ACTIVE
|ICON_INACTIVE
)) {
256 g_signal_connect(G_OBJECT(icons
[n
].item
), "toggled",
257 G_CALLBACK(toggled_menu
), &icons
[n
]);
260 /* Don't connect two instances of the signal! */
263 g_signal_connect(G_OBJECT(icons
[n
].item
), "activate",
264 G_CALLBACK(clicked_menu
), &icons
[n
]);
269 /* create the adjustments for the volume control */
271 volume_adj
= GTK_ADJUSTMENT(gtk_adjustment_new(0, 0, goesupto
,
272 goesupto
/ 20, goesupto
/ 20,
275 balance_adj
= GTK_ADJUSTMENT(gtk_adjustment_new(0, -1, 1,
277 /* the volume control */
279 v
= gtk_hscale_new(volume_adj
);
281 b
= gtk_hscale_new(balance_adj
);
282 gtk_scale_set_digits(GTK_SCALE(v
), 10);
283 gtk_scale_set_digits(GTK_SCALE(b
), 10);
284 gtk_widget_set_size_request(v
, 192, -1);
285 gtk_widget_set_size_request(b
, 192, -1);
286 gtk_tooltips_set_tip(tips
, v
, "Volume", "");
287 gtk_tooltips_set_tip(tips
, b
, "Balance", "");
288 gtk_box_pack_start(GTK_BOX(hbox
), v
, FALSE
, TRUE
, 0);
289 gtk_box_pack_start(GTK_BOX(hbox
), b
, FALSE
, TRUE
, 0);
290 /* space updates rather than hammering the server */
291 gtk_range_set_update_policy(GTK_RANGE(v
), GTK_UPDATE_DELAYED
);
292 gtk_range_set_update_policy(GTK_RANGE(b
), GTK_UPDATE_DELAYED
);
293 /* notice when the adjustments are changed */
294 g_signal_connect(G_OBJECT(volume_adj
), "value-changed",
295 G_CALLBACK(volume_adjusted
), 0);
296 g_signal_connect(G_OBJECT(balance_adj
), "value-changed",
297 G_CALLBACK(volume_adjusted
), 0);
298 /* format the volume/balance values ourselves */
299 g_signal_connect(G_OBJECT(v
), "format-value",
300 G_CALLBACK(format_volume
), 0);
301 g_signal_connect(G_OBJECT(b
), "format-value",
302 G_CALLBACK(format_balance
), 0);
303 register_monitor(control_monitor
, 0, -1UL);
307 /** @brief Update the volume control when it changes */
308 void volume_update(void) {
311 D(("volume_update"));
312 l
= volume_l
/ 100.0;
313 r
= volume_r
/ 100.0;
314 ++suppress_set_volume
;
315 gtk_adjustment_set_value(volume_adj
, volume(l
, r
) * goesupto
);
316 gtk_adjustment_set_value(balance_adj
, balance(l
, r
));
317 --suppress_set_volume
;
320 /** @brief Update the state of one of the control icons
321 * @param icon Target icon
322 * @param visible True if this version of the button should be visible
323 * @param usable True if the button is currently usable
325 * Several of the icons, rather bizarrely, come in pairs: for instance exactly
326 * one of the play and pause buttons is supposed to be visible at any given
329 * @p usable need not take into account server availability, that is done
332 static void update_icon(const struct icon
*icon
,
333 int visible
, int usable
) {
334 /* If the connection is down nothing is ever usable */
335 if(!(last_state
& DISORDER_CONNECTED
))
337 (visible ? gtk_widget_show
: gtk_widget_hide
)(icon
->button
);
338 /* Only both updating usability if the button is visible */
340 gtk_widget_set_sensitive(icon
->button
, usable
);
342 /* There's an associated menu item. These are always visible, but may not
344 if((icon
->flags
& (ICON_ACTIVE
|ICON_INACTIVE
)) == ICON_ACTIVE
) {
345 /* The active half of a pair */
346 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(icon
->item
), visible
);
348 gtk_widget_set_sensitive(icon
->item
, usable
);
352 static void update_pause(const struct icon
*icon
) {
353 const int visible
= !(last_state
& DISORDER_TRACK_PAUSED
);
354 const int usable
= !!(last_state
& DISORDER_PLAYING
); /* TODO: might be a lie */
355 update_icon(icon
, visible
, usable
);
358 static void update_play(const struct icon
*icon
) {
359 const int visible
= !!(last_state
& DISORDER_TRACK_PAUSED
);
360 const int usable
= !!(last_state
& DISORDER_PLAYING
);
361 update_icon(icon
, visible
, usable
);
364 static void update_scratch(const struct icon
*icon
) {
365 const int visible
= 1;
366 const int usable
= !!(last_state
& DISORDER_PLAYING
);
367 update_icon(icon
, visible
, usable
);
370 static void update_random_enable(const struct icon
*icon
) {
371 const int visible
= !(last_state
& DISORDER_RANDOM_ENABLED
);
372 const int usable
= 1;
373 update_icon(icon
, visible
, usable
);
376 static void update_random_disable(const struct icon
*icon
) {
377 const int visible
= !!(last_state
& DISORDER_RANDOM_ENABLED
);
378 const int usable
= 1;
379 update_icon(icon
, visible
, usable
);
382 static void update_enable(const struct icon
*icon
) {
383 const int visible
= !(last_state
& DISORDER_PLAYING_ENABLED
);
384 const int usable
= 1;
385 update_icon(icon
, visible
, usable
);
388 static void update_disable(const struct icon
*icon
) {
389 const int visible
= !!(last_state
& DISORDER_PLAYING_ENABLED
);
390 const int usable
= 1;
391 update_icon(icon
, visible
, usable
);
394 static void update_rtp(const struct icon
*icon
) {
395 const int visible
= !rtp_is_running
;
396 const int usable
= rtp_supported
;
397 update_icon(icon
, visible
, usable
);
400 static void update_nortp(const struct icon
*icon
) {
401 const int visible
= rtp_is_running
;
402 const int usable
= rtp_supported
;
403 update_icon(icon
, visible
, usable
);
406 static void clicked_icon(GtkButton
attribute((unused
)) *button
,
408 const struct icon
*icon
= userdata
;
410 icon
->action(client
, 0, 0);
413 static void clicked_menu(GtkMenuItem
attribute((unused
)) *menuitem
,
415 const struct icon
*icon
= userdata
;
417 icon
->action(client
, 0, 0);
420 static void toggled_menu(GtkCheckMenuItem
*menuitem
,
422 const struct icon
*icon
= userdata
;
425 /* This is a bit fiddlier than the others, we need to find the action for the
426 * new state. If the new state is active then we want the ICON_INACTIVE
427 * version and vica versa. */
428 for(n
= 0; n
< NICONS
; ++n
)
429 if(icons
[n
].item
== icon
->item
430 && !!(icons
[n
].flags
& ICON_INACTIVE
) == !!menuitem
->active
)
433 icons
[n
].action(client
, 0, 0);
436 /** @brief Called when the volume has been adjusted */
437 static void volume_adjusted(GtkAdjustment
attribute((unused
)) *a
,
438 gpointer
attribute((unused
)) user_data
) {
439 double v
= gtk_adjustment_get_value(volume_adj
) / goesupto
;
440 double b
= gtk_adjustment_get_value(balance_adj
);
442 if(suppress_set_volume
)
443 /* This is the result of an update from the server, not a change from the
444 * user. Don't feedback! */
446 D(("volume_adjusted"));
447 /* force to 'stereotypical' values */
448 v
= nearbyint(100 * v
) / 100;
449 b
= nearbyint(5 * b
) / 5;
450 /* Set the volume. We don't want a reply, we'll get the actual new volume
452 disorder_eclient_volume(client
, 0,
453 nearbyint(left(v
, b
) * 100),
454 nearbyint(right(v
, b
) * 100),
458 /** @brief Formats the volume value */
459 static gchar
*format_volume(GtkScale
attribute((unused
)) *scale
,
463 snprintf(s
, sizeof s
, "%.1f", (double)value
);
467 /** @brief Formats the balance value */
468 static gchar
*format_balance(GtkScale
attribute((unused
)) *scale
,
472 if(fabs(value
) < 0.1)
473 return g_strdup("0");
474 snprintf(s
, sizeof s
, "%+.1f", (double)value
);
478 /* Volume mapping. We consider left, right, volume to be in [0,1]
479 * and balance to be in [-1,1].
481 * First, we just have volume = max(left, right).
483 * Balance we consider to linearly represent the amount by which the quieter
484 * channel differs from the louder. In detail:
486 * if right > left then balance > 0:
487 * balance = 0 => left = right (as an endpoint, not an instance)
488 * balance = 1 => left = 0
489 * fitting to linear, left = right * (1 - balance)
490 * so balance = 1 - left / right
491 * (right > left => right > 0 so no division by 0.)
493 * if left > right then balance < 0:
494 * balance = 0 => right = left (same caveat as above)
495 * balance = -1 => right = 0
496 * again fitting to linear, right = left * (1 + balance)
497 * so balance = right / left - 1
498 * (left > right => left > 0 so no division by 0.)
500 * if left = right then we just have balance = 0.
502 * Thanks to Clive and Andrew.
505 /** @brief Return the greater of @p x and @p y */
506 static double max(double x
, double y
) {
507 return x
> y ? x
: y
;
510 /** @brief Compute the left channel volume */
511 static double left(double v
, double b
) {
512 if(b
> 0) /* volume = right */
514 else /* volume = left */
518 /** @brief Compute the right channel volume */
519 static double right(double v
, double b
) {
520 if(b
> 0) /* volume = right */
522 else /* volume = left */
526 /** @brief Compute the overall volume */
527 static double volume(double l
, double r
) {
531 /** @brief Compute the balance */
532 static double balance(double l
, double r
) {
537 else /* left = right */
541 /** @brief Called to enable RTP play
543 * Rather odd signature is to fit in with the other icons which all call @ref
544 * lib/eclient.h functions.
546 static int enable_rtp(disorder_eclient
attribute((unused
)) *c
,
547 disorder_eclient_no_response
attribute((unused
)) *completed
,
548 void attribute((unused
)) *v
) {
553 /** @brief Called to disable RTP play
555 * Rather odd signature is to fit in with the other icons which all call @ref
556 * lib/eclient.h functions.
558 static int disable_rtp(disorder_eclient
attribute((unused
)) *c
,
559 disorder_eclient_no_response
attribute((unused
)) *completed
,
560 void attribute((unused
)) *v
) {