chiark - git - mdw - disorder/blob - disobedience/control.c

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