chiark / gitweb /
Core Audio support should now include descriptions in error strings.
[disorder] / disobedience / disobedience.c
1 /*
2  * This file is part of DisOrder.
3  * Copyright (C) 2006, 2007, 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 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 "mixer.h"
24 #include "version.h"
25
26 #include <getopt.h>
27 #include <locale.h>
28 #include <pcre.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 Main client */
48 disorder_eclient *client;
49
50 /** @brief Log client */
51 disorder_eclient *logclient;
52
53 /** @brief Last reported state
54  *
55  * This is updated by log_state().
56  */
57 unsigned long last_state;
58
59 /** @brief True if some track is playing
60  *
61  * This ought to be removed in favour of last_state & DISORDER_PLAYING
62  */
63 int playing;
64
65 /** @brief Left channel volume */
66 int volume_l;
67
68 /** @brief Right channel volume */
69 int volume_r;
70
71 double goesupto = 10;                   /* volume upper bound */
72
73 /** @brief True if a NOP is in flight */
74 static int nop_in_flight;
75
76 /** @brief True if an rtp-address command is in flight */
77 static int rtp_address_in_flight;
78
79 /** @brief True if a rights lookup is in flight */
80 static int rights_lookup_in_flight;
81
82 /** @brief Current rights bitmap */
83 rights_type last_rights;
84
85 /** @brief Global tooltip group */
86 GtkTooltips *tips;
87
88 /** @brief True if RTP play is available
89  *
90  * This is a bit of a bodge...
91  */
92 int rtp_supported;
93
94 /** @brief True if RTP play is enabled */
95 int rtp_is_running;
96
97 /** @brief Server version */
98 const char *server_version;
99
100 /** @brief Parsed server version */
101 long server_version_bytes;
102
103 static void check_rtp_address(const char *event,
104                               void *eventdata,
105                               void *callbackdata);
106
107 /* Window creation --------------------------------------------------------- */
108
109 /* Note that all the client operations kicked off from here will only complete
110  * after we've entered the event loop. */
111
112 /** @brief Called when main window is deleted
113  *
114  * Terminates the program.
115  */
116 static gboolean delete_event(GtkWidget attribute((unused)) *widget,
117                              GdkEvent attribute((unused)) *event,
118                              gpointer attribute((unused)) data) {
119   D(("delete_event"));
120   exit(0);                              /* die immediately */
121 }
122
123 /** @brief Called when the current tab is switched
124  *
125  * Updates the menu settings to correspond to the new page.
126  */
127 static void tab_switched(GtkNotebook *notebook,
128                          GtkNotebookPage attribute((unused)) *page,
129                          guint page_num,
130                          gpointer attribute((unused)) user_data) {
131   GtkWidget *const tab = gtk_notebook_get_nth_page(notebook, page_num);
132   const struct tabtype *const t = g_object_get_data(G_OBJECT(tab), "type");
133   assert(t != 0);
134   if(t->selected)
135     t->selected();
136 }
137
138 /** @brief Create the report box */
139 static GtkWidget *report_box(void) {
140   GtkWidget *vbox = gtk_vbox_new(FALSE, 0);
141
142   report_label = gtk_label_new("");
143   gtk_label_set_ellipsize(GTK_LABEL(report_label), PANGO_ELLIPSIZE_END);
144   gtk_misc_set_alignment(GTK_MISC(report_label), 0, 0);
145   gtk_container_add(GTK_CONTAINER(vbox), gtk_hseparator_new());
146   gtk_container_add(GTK_CONTAINER(vbox), report_label);
147   return vbox;
148 }
149
150 /** @brief Create and populate the main tab group */
151 static GtkWidget *notebook(void) {
152   tabs = gtk_notebook_new();
153   /* The current tab is _NORMAL, the rest are _ACTIVE, which is bizarre but
154    * produces not too dreadful appearance */
155   gtk_widget_set_style(tabs, tool_style);
156   g_signal_connect(tabs, "switch-page", G_CALLBACK(tab_switched), 0);
157   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), queue_widget(),
158                            gtk_label_new("Queue"));
159   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), recent_widget(),
160                            gtk_label_new("Recent"));
161   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), choose_widget(),
162                            gtk_label_new("Choose"));
163   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), added_widget(),
164                            gtk_label_new("Added"));
165   return tabs;
166 }
167
168 /** @brief Create and populate the main window */
169 static void make_toplevel_window(void) {
170   GtkWidget *const vbox = gtk_vbox_new(FALSE, 1);
171   GtkWidget *const rb = report_box();
172
173   D(("top_window"));
174   toplevel = gtk_window_new(GTK_WINDOW_TOPLEVEL);
175   /* default size is too small */
176   gtk_window_set_default_size(GTK_WINDOW(toplevel), 640, 480);
177   /* terminate on close */
178   g_signal_connect(G_OBJECT(toplevel), "delete_event",
179                    G_CALLBACK(delete_event), NULL);
180   /* lay out the window */
181   gtk_window_set_title(GTK_WINDOW(toplevel), "Disobedience");
182   gtk_container_add(GTK_CONTAINER(toplevel), vbox);
183   /* lay out the vbox */
184   gtk_box_pack_start(GTK_BOX(vbox),
185                      menubar(toplevel),
186                      FALSE,             /* expand */
187                      FALSE,             /* fill */
188                      0);
189   gtk_box_pack_start(GTK_BOX(vbox),
190                      control_widget(),
191                      FALSE,             /* expand */
192                      FALSE,             /* fill */
193                      0);
194   gtk_container_add(GTK_CONTAINER(vbox), notebook());
195   gtk_box_pack_end(GTK_BOX(vbox),
196                    rb,
197                    FALSE,             /* expand */
198                    FALSE,             /* fill */
199                    0);
200   gtk_widget_set_style(toplevel, tool_style);
201 }
202
203 static void userinfo_rights_completed(void attribute((unused)) *v,
204                                       const char *err,
205                                       const char *value) {
206   rights_type r;
207
208   if(err) {
209     popup_protocol_error(0, err);
210     r = 0;
211   } else {
212     if(parse_rights(value, &r, 0))
213       r = 0;
214   }
215   /* If rights have changed, signal everything that cares */
216   if(r != last_rights) {
217     last_rights = r;
218     ++suppress_actions;
219     event_raise("rights-changed", 0);
220     --suppress_actions;
221   }
222   rights_lookup_in_flight = 0;
223 }
224
225 static void check_rights(void) {
226   if(!rights_lookup_in_flight) {
227     rights_lookup_in_flight = 1;
228     disorder_eclient_userinfo(client,
229                               userinfo_rights_completed,
230                               config->username, "rights",
231                               0);
232   }
233 }
234
235 /** @brief Called occasionally */
236 static gboolean periodic_slow(gpointer attribute((unused)) data) {
237   D(("periodic_slow"));
238   /* Expire cached data */
239   cache_expire();
240   /* Update everything to be sure that the connection to the server hasn't
241    * mysteriously gone stale on us. */
242   all_update();
243   /* Recheck RTP status too */
244   check_rtp_address(0, 0, 0);
245   return TRUE;                          /* don't remove me */
246 }
247
248 /** @brief Called frequently */
249 static gboolean periodic_fast(gpointer attribute((unused)) data) {
250 #if 0                                   /* debugging hack */
251   static struct timeval last;
252   struct timeval now;
253   double delta;
254
255   xgettimeofday(&now, 0);
256   if(last.tv_sec) {
257     delta = (now.tv_sec + now.tv_sec / 1.0E6) 
258       - (last.tv_sec + last.tv_sec / 1.0E6);
259     if(delta >= 1.0625)
260       fprintf(stderr, "%f: %fs between 1s heartbeats\n", 
261               now.tv_sec + now.tv_sec / 1.0E6,
262               delta);
263   }
264   last = now;
265 #endif
266   if(rtp_supported && mixer_supported(DEFAULT_BACKEND)) {
267     int nl, nr;
268     if(!mixer_control(DEFAULT_BACKEND, &nl, &nr, 0)
269        && (nl != volume_l || nr != volume_r)) {
270       volume_l = nl;
271       volume_r = nr;
272       event_raise("volume-changed", 0);
273     }
274   }
275   /* Periodically check what our rights are */
276   int recheck_rights = 1;
277   if(server_version_bytes >= 0x04010000)
278     /* Server versions after 4.1 will send updates */
279     recheck_rights = 0;
280   if((server_version_bytes & 0xFF) == 0x01)
281     /* Development servers might do regardless of their version number */
282     recheck_rights = 0;
283   if(recheck_rights)
284     check_rights();
285   return TRUE;
286 }
287
288 /** @brief Called when a NOP completes */
289 static void nop_completed(void attribute((unused)) *v,
290                           const char attribute((unused)) *err) {
291   /* TODO report the error somewhere */
292   nop_in_flight = 0;
293 }
294
295 /** @brief Called from time to time to arrange for a NOP to be sent
296  *
297  * At most one NOP remains in flight at any moment.  If the client is not
298  * currently connected then no NOP is sent.
299  */
300 static gboolean maybe_send_nop(gpointer attribute((unused)) data) {
301   if(!nop_in_flight && (disorder_eclient_state(client) & DISORDER_CONNECTED)) {
302     nop_in_flight = 1;
303     disorder_eclient_nop(client, nop_completed, 0);
304   }
305   if(rtp_supported) {
306     const int rtp_was_running = rtp_is_running;
307     rtp_is_running = rtp_running();
308     if(rtp_was_running != rtp_is_running)
309       event_raise("rtp-changed", 0);
310   }
311   return TRUE;                          /* keep call me please */
312 }
313
314 /** @brief Called when a rtp-address command succeeds */
315 static void got_rtp_address(void attribute((unused)) *v,
316                             const char *err,
317                             int attribute((unused)) nvec,
318                             char attribute((unused)) **vec) {
319   const int rtp_was_supported = rtp_supported;
320   const int rtp_was_running = rtp_is_running;
321
322   ++suppress_actions;
323   rtp_address_in_flight = 0;
324   if(err) {
325     /* An error just means that we're not using network play */
326     rtp_supported = 0;
327     rtp_is_running = 0;
328   } else {
329     rtp_supported = 1;
330     rtp_is_running = rtp_running();
331   }
332   /*fprintf(stderr, "rtp supported->%d, running->%d\n",
333           rtp_supported, rtp_is_running);*/
334   if(rtp_supported != rtp_was_supported
335      || rtp_is_running != rtp_was_running)
336     event_raise("rtp-changed", 0);
337   --suppress_actions;
338 }
339
340 /** @brief Called to check whether RTP play is available */
341 static void check_rtp_address(const char attribute((unused)) *event,
342                               void attribute((unused)) *eventdata,
343                               void attribute((unused)) *callbackdata) {
344   if(!rtp_address_in_flight) {
345     //fprintf(stderr, "checking rtp\n");
346     disorder_eclient_rtp_address(client, got_rtp_address, NULL);
347   }
348 }
349
350 /* main -------------------------------------------------------------------- */
351
352 static const struct option options[] = {
353   { "help", no_argument, 0, 'h' },
354   { "version", no_argument, 0, 'V' },
355   { "config", required_argument, 0, 'c' },
356   { "tufnel", no_argument, 0, 't' },
357   { "debug", no_argument, 0, 'd' },
358   { 0, 0, 0, 0 }
359 };
360
361 /* display usage message and terminate */
362 static void help(void) {
363   xprintf("Disobedience - GUI client for DisOrder\n"
364           "\n"
365           "Usage:\n"
366           "  disobedience [OPTIONS]\n"
367           "Options:\n"
368           "  --help, -h              Display usage message\n"
369           "  --version, -V           Display version number\n"
370           "  --config PATH, -c PATH  Set configuration file\n"
371           "  --debug, -d             Turn on debugging\n"
372           "\n"
373           "Also GTK+ options will work.\n");
374   xfclose(stdout);
375   exit(0);
376 }
377
378 static void version_completed(void attribute((unused)) *v,
379                               const char attribute((unused)) *err,
380                               const char *ver) {
381   long major, minor, patch, dev;
382
383   if(!ver) {
384     server_version = 0;
385     server_version_bytes = 0;
386     return;
387   }
388   server_version = ver;
389   server_version_bytes = 0;
390   major = strtol(ver, (char **)&ver, 10);
391   if(*ver != '.')
392     return;
393   ++ver;
394   minor = strtol(ver, (char **)&ver, 10);
395   if(*ver == '.') {
396     ++ver;
397     patch = strtol(ver, (char **)&ver, 10);
398   } else
399     patch = 0;
400   if(*ver) {
401     if(*ver == '+') {
402       dev = 1;
403       ++ver;
404     }
405     if(*ver)
406       dev = 2;
407   } else
408     dev = 0;
409   server_version_bytes = (major << 24) + (minor << 16) + (patch << 8) + dev;
410 }
411
412 void logged_in(void) {
413   /* reset the clients */
414   disorder_eclient_close(client);
415   disorder_eclient_close(logclient);
416   rtp_supported = 0;
417   event_raise("logged-in", 0);
418   /* Force the periodic checks */
419   periodic_slow(0);
420   periodic_fast(0);
421   /* Recheck server version */
422   disorder_eclient_version(client, version_completed, 0);
423   disorder_eclient_enable_connect(client);
424   disorder_eclient_enable_connect(logclient);
425 }
426
427 int main(int argc, char **argv) {
428   int n;
429   gboolean gtkok;
430
431   mem_init();
432   /* garbage-collect PCRE's memory */
433   pcre_malloc = xmalloc;
434   pcre_free = xfree;
435   if(!setlocale(LC_CTYPE, "")) fatal(errno, "error calling setlocale");
436   gtkok = gtk_init_check(&argc, &argv);
437   while((n = getopt_long(argc, argv, "hVc:dtHC", options, 0)) >= 0) {
438     switch(n) {
439     case 'h': help();
440     case 'V': version("disobedience");
441     case 'c': configfile = optarg; break;
442     case 'd': debugging = 1; break;
443     case 't': goesupto = 11; break;
444     default: fatal(0, "invalid option");
445     }
446   }
447   if(!gtkok)
448     fatal(0, "failed to initialize GTK+");
449   signal(SIGPIPE, SIG_IGN);
450   init_styles();
451   load_settings();
452   /* create the event loop */
453   D(("create main loop"));
454   mainloop = g_main_loop_new(0, 0);
455   if(config_read(0)) fatal(0, "cannot read configuration");
456   /* create the clients */
457   if(!(client = gtkclient())
458      || !(logclient = gtkclient()))
459     return 1;                           /* already reported an error */
460   /* periodic operations (e.g. expiring the cache, checking local volume) */
461   g_timeout_add(600000/*milliseconds*/, periodic_slow, 0);
462   g_timeout_add(1000/*milliseconds*/, periodic_fast, 0);
463   /* global tooltips */
464   tips = gtk_tooltips_new();
465   make_toplevel_window();
466   /* reset styles now everything has its name */
467   gtk_rc_reset_styles(gtk_settings_get_for_screen(gdk_screen_get_default()));
468   gtk_widget_show_all(toplevel);
469   /* issue a NOP every so often */
470   g_timeout_add_full(G_PRIORITY_LOW,
471                      2000/*interval, ms*/,
472                      maybe_send_nop,
473                      0/*data*/,
474                      0/*notify*/);
475   /* Start monitoring the log */
476   disorder_eclient_log(logclient, &log_callbacks, 0);
477   /* Initiate all the checks */
478   periodic_fast(0);
479   disorder_eclient_version(client, version_completed, 0);
480   event_register("log-connected", check_rtp_address, 0);
481   suppress_actions = 0;
482   /* If no password is set yet pop up a login box */
483   if(!config->password)
484     login_box();
485   D(("enter main loop"));
486   g_main_loop_run(mainloop);
487   return 0;
488 }
489
490 /*
491 Local Variables:
492 c-basic-offset:2
493 comment-column:40
494 fill-column:79
495 indent-tabs-mode:nil
496 End:
497 */