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

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2006-2009 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 3 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,
  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.
  14  *
  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/>.
  17  */
  18 /** @file disobedience/disobedience.c
  19  * @brief Main Disobedience program
  20  */
  21
  22 #include "disobedience.h"
  23 #include "regexp.h"
  24 #include "version.h"
  25
  26 #include <getopt.h>
  27 #include <locale.h>
  28 #include <gcrypt.h>
  29
  30 /* Apologies for the numerous de-consting casts, but GLib et al do not seem to
  31  * have heard of const. */
  32
  33 /* Variables --------------------------------------------------------------- */
  34
  35 /** @brief Event loop */
  36 GMainLoop *mainloop;
  37
  38 /** @brief Top-level window */
  39 GtkWidget *toplevel;
  40
  41 /** @brief Label for progress indicator */
  42 GtkWidget *report_label;
  43
  44 /** @brief Main tab group */
  45 GtkWidget *tabs;
  46
  47 /** @brief Mini-mode widget for playing track */
  48 GtkWidget *playing_mini;
  49
  50 /** @brief Main client */
  51 disorder_eclient *client;
  52
  53 /** @brief Log client */
  54 disorder_eclient *logclient;
  55
  56 /** @brief Last reported state
  57  *
  58  * This is updated by log_state().
  59  */
  60 unsigned long last_state;
  61
  62 /** @brief True if some track is playing
  63  *
  64  * This ought to be removed in favour of last_state & DISORDER_PLAYING
  65  */
  66 int playing;
  67
  68 /** @brief Left channel volume */
  69 int volume_l;
  70
  71 /** @brief Right channel volume */
  72 int volume_r;
  73
  74 /** @brief Audio backend */
  75 const struct uaudio *backend;
  76
  77 double goesupto = 10;                   /* volume upper bound */
  78
  79 /** @brief True if a NOP is in flight */
  80 static int nop_in_flight;
  81
  82 /** @brief True if an rtp-address command is in flight */
  83 static int rtp_address_in_flight;
  84
  85 /** @brief True if a rights lookup is in flight */
  86 static int rights_lookup_in_flight;
  87
  88 /** @brief Current rights bitmap */
  89 rights_type last_rights;
  90
  91 /** @brief True if RTP play is available
  92  *
  93  * This is a bit of a bodge...
  94  */
  95 int rtp_supported;
  96
  97 /** @brief True if RTP play is enabled */
  98 int rtp_is_running;
  99
 100 /** @brief Server version */
 101 const char *server_version;
 102
 103 /** @brief Parsed server version */
 104 long server_version_bytes;
 105
 106 static GtkWidget *queue;
 107
 108 static GtkWidget *notebook_box;
 109
 110 static void check_rtp_address(const char *event,
 111                               void *eventdata,
 112                               void *callbackdata);
 113
 114 /* Window creation --------------------------------------------------------- */
 115
 116 /* Note that all the client operations kicked off from here will only complete
 117  * after we've entered the event loop. */
 118
 119 /** @brief Called when main window is deleted
 120  *
 121  * Terminates the program.
 122  */
 123 static gboolean delete_event(GtkWidget attribute((unused)) *widget,
 124                              GdkEvent attribute((unused)) *event,
 125                              gpointer attribute((unused)) data) {
 126   D(("delete_event"));
 127   exit(0);                              /* die immediately */
 128 }
 129
 130 /** @brief Called when the current tab is switched
 131  *
 132  * Updates the menu settings to correspond to the new page.
 133  */
 134 static void tab_switched(GtkNotebook *notebook,
 135                          GtkNotebookPage attribute((unused)) *page,
 136                          guint page_num,
 137                          gpointer attribute((unused)) user_data) {
 138   GtkWidget *const tab = gtk_notebook_get_nth_page(notebook, page_num);
 139   const struct tabtype *const t = g_object_get_data(G_OBJECT(tab), "type");
 140   assert(t != 0);
 141   if(t->selected)
 142     t->selected();
 143 }
 144
 145 /** @brief Create the report box */
 146 static GtkWidget *report_box(void) {
 147   GtkWidget *vbox = gtk_vbox_new(FALSE, 0);
 148
 149   report_label = gtk_label_new("");
 150   gtk_label_set_ellipsize(GTK_LABEL(report_label), PANGO_ELLIPSIZE_END);
 151   gtk_misc_set_alignment(GTK_MISC(report_label), 0, 0);
 152   gtk_container_add(GTK_CONTAINER(vbox), gtk_hseparator_new());
 153   gtk_container_add(GTK_CONTAINER(vbox), report_label);
 154   return vbox;
 155 }
 156
 157 /** @brief Create and populate the main tab group */
 158 static GtkWidget *notebook(void) {
 159   tabs = gtk_notebook_new();
 160   /* The current tab is _NORMAL, the rest are _ACTIVE, which is bizarre but
 161    * produces not too dreadful appearance */
 162   gtk_widget_set_style(tabs, tool_style);
 163   g_signal_connect(tabs, "switch-page", G_CALLBACK(tab_switched), 0);
 164   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), queue = queue_widget(),
 165                            gtk_label_new("Queue"));
 166   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), recent_widget(),
 167                            gtk_label_new("Recent"));
 168   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), choose_widget(),
 169                            gtk_label_new("Choose"));
 170   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), added_widget(),
 171                            gtk_label_new("Added"));
 172   return tabs;
 173 }
 174
 175 /* Tracking of window sizes */
 176 static int toplevel_width = 640, toplevel_height = 480;
 177 static int mini_width = 480, mini_height = 140;
 178 static struct timeval last_mode_switch;
 179
 180 static void main_minimode(const char attribute((unused)) *event,
 181                           void attribute((unused)) *evendata,
 182                           void attribute((unused)) *callbackdata) {
 183   if(full_mode) {
 184     gtk_window_resize(GTK_WINDOW(toplevel), toplevel_width, toplevel_height);
 185     gtk_widget_show(tabs);
 186     gtk_widget_hide(playing_mini);
 187     /* Show the queue (bit confusing otherwise!) */
 188     gtk_notebook_set_current_page(GTK_NOTEBOOK(tabs), 0);
 189   } else {
 190     gtk_window_resize(GTK_WINDOW(toplevel), mini_width, mini_height);
 191     gtk_widget_hide(tabs);
 192     gtk_widget_show(playing_mini);
 193   }
 194   xgettimeofday(&last_mode_switch, NULL);
 195 }
 196
 197 /* Called when the window size is allocate */
 198 static void toplevel_size_allocate(GtkWidget attribute((unused)) *w,
 199                                    GtkAllocation *a,
 200                                    gpointer attribute((unused)) user_data) {
 201   struct timeval now;
 202   xgettimeofday(&now, NULL);
 203   if(tvdouble(tvsub(now, last_mode_switch)) < 0.5) {
 204     /* Suppress size-allocate signals that are within half a second of a mode
 205      * switch: they are quite likely to be the result of re-arranging widgets
 206      * within the old size, not the application of the new size.  Yes, this is
 207      * a disgusting hack! */
 208     return;                             /* OMG too soon! */
 209   }
 210   if(full_mode) {
 211     toplevel_width = a->width;
 212     toplevel_height = a->height;
 213   } else {
 214     mini_width = a->width;
 215     mini_height = a->height;
 216   }
 217 }
 218
 219 /* Periodically check the toplevel's size
 220  * (the hack in toplevel_size_allocate() means we could in principle
 221  * miss a user-initiated resize)
 222  */
 223 static void check_toplevel_size(const char attribute((unused)) *event,
 224                                 void attribute((unused)) *evendata,
 225                                 void attribute((unused)) *callbackdata) {
 226   GtkAllocation a;
 227   gtk_window_get_size(GTK_WINDOW(toplevel), &a.width, &a.height);
 228   toplevel_size_allocate(NULL, &a, NULL);
 229 }
 230
 231 static void hack_window_title(const char attribute((unused)) *event,
 232                               void attribute((unused)) *eventdata,
 233                               void attribute((unused)) *callbackdata) {
 234   char *p;
 235   const char *note;
 236   static const char *last_note = 0;
 237
 238   if(!(last_state & DISORDER_CONNECTED))
 239     note = "(disconnected)";
 240   else if(last_state & DISORDER_TRACK_PAUSED)
 241     note = "(paused)";
 242   else if(playing_track) {
 243     byte_asprintf(&p, "'%s' by %s, from '%s'",
 244                   namepart(playing_track->track, "display", "title"),
 245                   namepart(playing_track->track, "display", "artist"),
 246                   namepart(playing_track->track, "display", "album"));
 247     note = p;
 248   } else if(!(last_state & DISORDER_PLAYING_ENABLED))
 249     note = "(playing disabled)";
 250   else if(!(last_state & DISORDER_RANDOM_ENABLED))
 251     note = "(random play disabled)";
 252   else
 253     note = "(nothing to play for unknown reason)";
 254
 255   if(last_note && !strcmp(note, last_note))
 256     return;
 257   last_note = xstrdup(note);
 258   byte_asprintf(&p, "Disobedience: %s", note);
 259   gtk_window_set_title(GTK_WINDOW(toplevel), p);
 260 }
 261
 262 /** @brief Create and populate the main window */
 263 static void make_toplevel_window(void) {
 264   GtkWidget *const vbox = gtk_vbox_new(FALSE/*homogeneous*/, 1/*spacing*/);
 265   GtkWidget *const rb = report_box();
 266
 267   D(("top_window"));
 268   toplevel = gtk_window_new(GTK_WINDOW_TOPLEVEL);
 269   /* default size is too small */
 270   gtk_window_set_default_size(GTK_WINDOW(toplevel),
 271                               toplevel_width, toplevel_height);
 272   /* terminate on close */
 273   g_signal_connect(G_OBJECT(toplevel), "delete_event",
 274                    G_CALLBACK(delete_event), NULL);
 275   /* track size */
 276   g_signal_connect(G_OBJECT(toplevel), "size-allocate",
 277                    G_CALLBACK(toplevel_size_allocate), NULL);
 278   /* lay out the window */
 279   hack_window_title(0, 0, 0);
 280   gtk_container_add(GTK_CONTAINER(toplevel), vbox);
 281   /* lay out the vbox */
 282   gtk_box_pack_start(GTK_BOX(vbox),
 283                      menubar(toplevel),
 284                      FALSE,             /* expand */
 285                      FALSE,             /* fill */
 286                      0);
 287   gtk_box_pack_start(GTK_BOX(vbox),
 288                      control_widget(),
 289                      FALSE,             /* expand */
 290                      FALSE,             /* fill */
 291                      0);
 292   playing_mini = playing_widget();
 293   gtk_box_pack_start(GTK_BOX(vbox),
 294                      playing_mini,
 295                      FALSE,
 296                      FALSE,
 297                      0);
 298   notebook_box = gtk_vbox_new(FALSE, 0);
 299   gtk_container_add(GTK_CONTAINER(notebook_box), notebook());
 300   gtk_container_add(GTK_CONTAINER(vbox), notebook_box);
 301   gtk_box_pack_end(GTK_BOX(vbox),
 302                    rb,
 303                    FALSE,             /* expand */
 304                    FALSE,             /* fill */
 305                    0);
 306   gtk_widget_set_style(toplevel, tool_style);
 307   event_register("mini-mode-changed", main_minimode, 0);
 308   event_register("periodic-fast", check_toplevel_size, 0);
 309   event_register("playing-track-changed", hack_window_title, 0);
 310   event_register("enabled-changed", hack_window_title, 0);
 311   event_register("random-changed", hack_window_title, 0);
 312   event_register("pause-changed", hack_window_title, 0);
 313   event_register("playing-changed", hack_window_title, 0);
 314   event_register("connected-changed", hack_window_title, 0);
 315   event_register("lookups-completed", hack_window_title, 0);
 316 }
 317
 318 static void userinfo_rights_completed(void attribute((unused)) *v,
 319                                       const char *err,
 320                                       const char *value) {
 321   rights_type r;
 322
 323   if(err) {
 324     popup_protocol_error(0, err);
 325     r = 0;
 326   } else {
 327     if(parse_rights(value, &r, 0))
 328       r = 0;
 329   }
 330   /* If rights have changed, signal everything that cares */
 331   if(r != last_rights) {
 332     last_rights = r;
 333     ++suppress_actions;
 334     event_raise("rights-changed", 0);
 335     --suppress_actions;
 336   }
 337   rights_lookup_in_flight = 0;
 338 }
 339
 340 static void check_rights(void) {
 341   if(!rights_lookup_in_flight) {
 342     rights_lookup_in_flight = 1;
 343     disorder_eclient_userinfo(client,
 344                               userinfo_rights_completed,
 345                               config->username, "rights",
 346                               0);
 347   }
 348 }
 349
 350 /** @brief Called occasionally */
 351 static gboolean periodic_slow(gpointer attribute((unused)) data) {
 352   D(("periodic_slow"));
 353   /* Expire cached data */
 354   cache_expire();
 355   /* Update everything to be sure that the connection to the server hasn't
 356    * mysteriously gone stale on us. */
 357   all_update();
 358   event_raise("periodic-slow", 0);
 359   /* Recheck RTP status too */
 360   check_rtp_address(0, 0, 0);
 361   return TRUE;                          /* don't remove me */
 362 }
 363
 364 /** @brief Called frequently */
 365 static gboolean periodic_fast(gpointer attribute((unused)) data) {
 366 #if 0                                   /* debugging hack */
 367   static struct timeval last;
 368   struct timeval now;
 369   double delta;
 370
 371   xgettimeofday(&now, 0);
 372   if(last.tv_sec) {
 373     delta = (now.tv_sec + now.tv_sec / 1.0E6)
 374       - (last.tv_sec + last.tv_sec / 1.0E6);
 375     if(delta >= 1.0625)
 376       fprintf(stderr, "%f: %fs between 1s heartbeats\n",
 377               now.tv_sec + now.tv_sec / 1.0E6,
 378               delta);
 379   }
 380   last = now;
 381 #endif
 382   if(rtp_supported && backend && backend->get_volume) {
 383     int nl, nr;
 384     backend->get_volume(&nl, &nr);
 385     if(nl != volume_l || nr != volume_r) {
 386       volume_l = nl;
 387       volume_r = nr;
 388       event_raise("volume-changed", 0);
 389     }
 390   }
 391   /* Periodically check what our rights are */
 392   int recheck_rights = 1;
 393   if(server_version_bytes >= 0x04010000)
 394     /* Server versions after 4.1 will send updates */
 395     recheck_rights = 0;
 396   if((server_version_bytes & 0xFF) == 0x01)
 397     /* Development servers might do regardless of their version number */
 398     recheck_rights = 0;
 399   if(recheck_rights)
 400     check_rights();
 401   event_raise("periodic-fast", 0);
 402   return TRUE;
 403 }
 404
 405 /** @brief Called when a NOP completes */
 406 static void nop_completed(void attribute((unused)) *v,
 407                           const char attribute((unused)) *err) {
 408   /* TODO report the error somewhere */
 409   nop_in_flight = 0;
 410 }
 411
 412 /** @brief Called from time to time to arrange for a NOP to be sent
 413  *
 414  * At most one NOP remains in flight at any moment.  If the client is not
 415  * currently connected then no NOP is sent.
 416  */
 417 static gboolean maybe_send_nop(gpointer attribute((unused)) data) {
 418   if(!nop_in_flight && (disorder_eclient_state(client) & DISORDER_CONNECTED)) {
 419     nop_in_flight = 1;
 420     disorder_eclient_nop(client, nop_completed, 0);
 421   }
 422   if(rtp_supported) {
 423     const int rtp_was_running = rtp_is_running;
 424     rtp_is_running = rtp_running();
 425     if(rtp_was_running != rtp_is_running)
 426       event_raise("rtp-changed", 0);
 427   }
 428   return TRUE;                          /* keep call me please */
 429 }
 430
 431 /** @brief Called when a rtp-address command succeeds */
 432 static void got_rtp_address(void attribute((unused)) *v,
 433                             const char *err,
 434                             int attribute((unused)) nvec,
 435                             char attribute((unused)) **vec) {
 436   const int rtp_was_supported = rtp_supported;
 437   const int rtp_was_running = rtp_is_running;
 438
 439   ++suppress_actions;
 440   rtp_address_in_flight = 0;
 441   if(err) {
 442     /* An error just means that we're not using network play */
 443     rtp_supported = 0;
 444     rtp_is_running = 0;
 445   } else {
 446     rtp_supported = 1;
 447     rtp_is_running = rtp_running();
 448   }
 449   /*fprintf(stderr, "rtp supported->%d, running->%d\n",
 450           rtp_supported, rtp_is_running);*/
 451   if(rtp_supported != rtp_was_supported
 452      || rtp_is_running != rtp_was_running)
 453     event_raise("rtp-changed", 0);
 454   --suppress_actions;
 455 }
 456
 457 /** @brief Called to check whether RTP play is available */
 458 static void check_rtp_address(const char attribute((unused)) *event,
 459                               void attribute((unused)) *eventdata,
 460                               void attribute((unused)) *callbackdata) {
 461   if(!rtp_address_in_flight) {
 462     //fprintf(stderr, "checking rtp\n");
 463     disorder_eclient_rtp_address(client, got_rtp_address, NULL);
 464   }
 465 }
 466
 467 /* main -------------------------------------------------------------------- */
 468
 469 static const struct option options[] = {
 470   { "help", no_argument, 0, 'h' },
 471   { "version", no_argument, 0, 'V' },
 472   { "config", required_argument, 0, 'c' },
 473   { "tufnel", no_argument, 0, 't' },
 474   { "debug", no_argument, 0, 'd' },
 475   { 0, 0, 0, 0 }
 476 };
 477
 478 /* display usage message and terminate */
 479 static void help(void) {
 480   xprintf("Disobedience - GUI client for DisOrder\n"
 481           "\n"
 482           "Usage:\n"
 483           "  disobedience [OPTIONS]\n"
 484           "Options:\n"
 485           "  --help, -h              Display usage message\n"
 486           "  --version, -V           Display version number\n"
 487           "  --config PATH, -c PATH  Set configuration file\n"
 488           "  --debug, -d             Turn on debugging\n"
 489           "\n"
 490           "Also GTK+ options will work.\n");
 491   xfclose(stdout);
 492   exit(0);
 493 }
 494
 495 static void version_completed(void attribute((unused)) *v,
 496                               const char attribute((unused)) *err,
 497                               const char *ver) {
 498   long major, minor, patch, dev;
 499
 500   if(!ver) {
 501     server_version = 0;
 502     server_version_bytes = 0;
 503     return;
 504   }
 505   server_version = ver;
 506   server_version_bytes = 0;
 507   major = strtol(ver, (char **)&ver, 10);
 508   if(*ver != '.')
 509     return;
 510   ++ver;
 511   minor = strtol(ver, (char **)&ver, 10);
 512   if(*ver == '.') {
 513     ++ver;
 514     patch = strtol(ver, (char **)&ver, 10);
 515   } else
 516     patch = 0;
 517   if(*ver) {
 518     if(*ver == '+') {
 519       dev = 1;
 520       ++ver;
 521     }
 522     if(*ver)
 523       dev = 2;
 524   } else
 525     dev = 0;
 526   server_version_bytes = (major << 24) + (minor << 16) + (patch << 8) + dev;
 527 }
 528
 529 void logged_in(void) {
 530   /* reset the clients */
 531   disorder_eclient_close(client);
 532   disorder_eclient_close(logclient);
 533   rtp_supported = 0;
 534   event_raise("logged-in", 0);
 535   /* Force the periodic checks */
 536   periodic_slow(0);
 537   periodic_fast(0);
 538   /* Recheck server version */
 539   disorder_eclient_version(client, version_completed, 0);
 540   disorder_eclient_enable_connect(client);
 541   disorder_eclient_enable_connect(logclient);
 542 }
 543
 544 int main(int argc, char **argv) {
 545   int n;
 546   gboolean gtkok;
 547
 548   mem_init();
 549   /* garbage-collect PCRE's memory */
 550   regexp_setup();
 551   if(!setlocale(LC_CTYPE, "")) disorder_fatal(errno, "error calling setlocale");
 552   gtkok = gtk_init_check(&argc, &argv);
 553   while((n = getopt_long(argc, argv, "hVc:dtHC", options, 0)) >= 0) {
 554     switch(n) {
 555     case 'h': help();
 556     case 'V': version("disobedience");
 557     case 'c': configfile = optarg; break;
 558     case 'd': debugging = 1; break;
 559     case 't': goesupto = 11; break;
 560     default: disorder_fatal(0, "invalid option");
 561     }
 562   }
 563   if(!gtkok)
 564     disorder_fatal(0, "failed to initialize GTK+");
 565   /* gcrypt initialization */
 566   if(!gcry_check_version(NULL))
 567     disorder_fatal(0, "gcry_check_version failed");
 568   gcry_control(GCRYCTL_INIT_SECMEM, 0);
 569   gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
 570   signal(SIGPIPE, SIG_IGN);
 571   init_styles();
 572   load_settings();
 573   /* create the event loop */
 574   D(("create main loop"));
 575   mainloop = g_main_loop_new(0, 0);
 576   if(config_read(0, NULL)) disorder_fatal(0, "cannot read configuration");
 577   /* we'll need mixer support */
 578   backend = uaudio_default(uaudio_apis, UAUDIO_API_CLIENT);
 579   if(backend->configure)
 580     backend->configure();
 581   if(backend->open_mixer)
 582     backend->open_mixer();
 583   /* create the clients */
 584   if(!(client = gtkclient())
 585      || !(logclient = gtkclient()))
 586     return 1;                           /* already reported an error */
 587   /* periodic operations (e.g. expiring the cache, checking local volume) */
 588   g_timeout_add(600000/*milliseconds*/, periodic_slow, 0);
 589   g_timeout_add(1000/*milliseconds*/, periodic_fast, 0);
 590   make_toplevel_window();
 591   /* reset styles now everything has its name */
 592   gtk_rc_reset_styles(gtk_settings_get_for_screen(gdk_screen_get_default()));
 593   gtk_widget_show_all(toplevel);
 594   gtk_widget_hide(playing_mini);
 595   /* issue a NOP every so often */
 596   g_timeout_add_full(G_PRIORITY_LOW,
 597                      2000/*interval, ms*/,
 598                      maybe_send_nop,
 599                      0/*data*/,
 600                      0/*notify*/);
 601   /* Start monitoring the log */
 602   disorder_eclient_log(logclient, &log_callbacks, 0);
 603   /* Initiate all the checks */
 604   periodic_fast(0);
 605   disorder_eclient_version(client, version_completed, 0);
 606   event_register("log-connected", check_rtp_address, 0);
 607   suppress_actions = 0;
 608   playlists_init();
 609   globals_init();
 610   /* If no password is set yet pop up a login box */
 611   if(!config->password)
 612     login_box();
 613   D(("enter main loop"));
 614   g_main_loop_run(mainloop);
 615   return 0;
 616 }
 617
 618 /*
 619 Local Variables:
 620 c-basic-offset:2
 621 comment-column:40
 622 fill-column:79
 623 indent-tabs-mode:nil
 624 End:
 625 */