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