chiark / gitweb /
doxygen
[disorder] / disobedience / disobedience.c
1 /*
2  * This file is part of DisOrder.
3  * Copyright (C) 2006, 2007 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
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 #include "style.h"                      /* generated style */
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 Last reported state
53  *
54  * This is updated by log_state().
55  */
56 unsigned long last_state;
57
58 /** @brief True if some track is playing
59  *
60  * This ought to be removed in favour of last_state & DISORDER_PLAYING
61  */
62 int playing;
63
64 /** @brief Left channel volume */
65 int volume_l;
66
67 /** @brief Right channel volume */
68 int volume_r;
69
70 double goesupto = 10;                   /* volume upper bound */
71
72 /** @brief Break up choose tab by initial letter */
73 int choosealpha;
74
75 /** @brief True if a NOP is in flight */
76 static int nop_in_flight;
77
78 /* Window creation --------------------------------------------------------- */
79
80 /* Note that all the client operations kicked off from here will only complete
81  * after we've entered the event loop. */
82
83 /** @brief Called when main window is deleted
84  *
85  * Terminates the program.
86  */
87 static gboolean delete_event(GtkWidget attribute((unused)) *widget,
88                              GdkEvent attribute((unused)) *event,
89                              gpointer attribute((unused)) data) {
90   D(("delete_event"));
91   exit(0);                              /* die immediately */
92 }
93
94 /** @brief Called when the current tab is switched
95  *
96  * Updates the menu settings to correspond to the new page.
97  */
98 static void tab_switched(GtkNotebook attribute((unused)) *notebook,
99                          GtkNotebookPage attribute((unused)) *page,
100                          guint page_num,
101                          gpointer attribute((unused)) user_data) {
102   menu_update(page_num);
103 }
104
105 /** @brief Create the report box */
106 static GtkWidget *report_box(void) {
107   GtkWidget *vbox = gtk_vbox_new(FALSE, 0);
108
109   report_label = gtk_label_new("");
110   gtk_label_set_ellipsize(GTK_LABEL(report_label), PANGO_ELLIPSIZE_END);
111   gtk_misc_set_alignment(GTK_MISC(report_label), 0, 0);
112   gtk_container_add(GTK_CONTAINER(vbox), gtk_hseparator_new());
113   gtk_container_add(GTK_CONTAINER(vbox), report_label);
114   return vbox;
115 }
116
117 /** @brief Create and populate the main tab group */
118 static GtkWidget *notebook(void) {
119   tabs = gtk_notebook_new();
120   g_signal_connect(tabs, "switch-page", G_CALLBACK(tab_switched), 0);
121   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), queue_widget(),
122                            gtk_label_new("Queue"));
123   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), recent_widget(),
124                            gtk_label_new("Recent"));
125   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), choose_widget(),
126                            gtk_label_new("Choose"));
127   return tabs;
128 }
129
130 /** @brief Create and populate the main window */
131 static void make_toplevel_window(void) {
132   GtkWidget *const vbox = gtk_vbox_new(FALSE, 1);
133   GtkWidget *const rb = report_box();
134
135   D(("top_window"));
136   toplevel = gtk_window_new(GTK_WINDOW_TOPLEVEL);
137   /* default size is too small */
138   gtk_window_set_default_size(GTK_WINDOW(toplevel), 640, 480);
139   /* terminate on close */
140   g_signal_connect(G_OBJECT(toplevel), "delete_event",
141                    G_CALLBACK(delete_event), NULL);
142   /* lay out the window */
143   gtk_window_set_title(GTK_WINDOW(toplevel), "Disobedience");
144   gtk_container_add(GTK_CONTAINER(toplevel), vbox);
145   /* lay out the vbox */
146   gtk_box_pack_start(GTK_BOX(vbox),
147                      menubar(toplevel),
148                      FALSE,             /* expand */
149                      FALSE,             /* fill */
150                      0);
151   gtk_box_pack_start(GTK_BOX(vbox),
152                      control_widget(),
153                      FALSE,             /* expand */
154                      FALSE,             /* fill */
155                      0);
156   gtk_container_add(GTK_CONTAINER(vbox), notebook());
157   gtk_box_pack_end(GTK_BOX(vbox),
158                    rb,
159                    FALSE,             /* expand */
160                    FALSE,             /* fill */
161                    0);
162   gtk_widget_set_name(toplevel, "disobedience");
163 }
164
165 #if MDEBUG
166 static int widget_count, container_count;
167
168 static void count_callback(GtkWidget *w,
169                            gpointer attribute((unused)) data) {
170   ++widget_count;
171   if(GTK_IS_CONTAINER(w)) {
172     ++container_count;
173     gtk_container_foreach(GTK_CONTAINER(w), count_callback, 0);
174   }
175 }
176
177 static void count_widgets(void) {
178   widget_count = 0;
179   container_count = 1;
180   if(toplevel)
181     gtk_container_foreach(GTK_CONTAINER(toplevel), count_callback, 0);
182   fprintf(stderr, "widget count: %8d  container count: %8d\n",
183           widget_count, container_count);
184 }
185 #endif
186
187 #if MTRACK
188 const char *mtag = "init";
189 static hash *mtrack_hash;
190
191 static int *mthfind(const char *tag) {
192   static const int zero = 0;
193   int *cp = hash_find(mtrack_hash, tag);
194   if(!cp) {
195     hash_add(mtrack_hash, tag, &zero, HASH_INSERT);
196     cp = hash_find(mtrack_hash, tag);
197   }
198   return cp;
199 }
200
201 static void *trap_malloc(size_t n) {
202   void *ptr = malloc(n + sizeof(char *));
203
204   *(const char **)ptr = mtag;
205   ++*mthfind(mtag);
206   return (char *)ptr + sizeof(char *);
207 }
208
209 static void trap_free(void *ptr) {
210   const char *tag;
211   if(!ptr)
212     return;
213   ptr = (char *)ptr - sizeof(char *);
214   tag = *(const char **)ptr;
215   --*mthfind(tag);
216   free(ptr);
217 }
218
219 static void *trap_realloc(void *ptr, size_t n) {
220   if(!ptr)
221     return trap_malloc(n);
222   if(!n) {
223     trap_free(ptr);
224     return 0;
225   }
226   ptr = (char *)ptr - sizeof(char *);
227   ptr = realloc(ptr, n + sizeof(char *));
228   *(const char **)ptr = mtag;
229   return (char *)ptr + sizeof(char *);
230 }
231
232 static int report_tags_callback(const char *key, void *value,
233                                 void attribute((unused)) *u) {
234   fprintf(stderr, "%16s: %d\n", key, *(int *)value);
235   return 0;
236 }
237
238 static void report_tags(void) {
239   hash_foreach(mtrack_hash, report_tags_callback, 0);
240   fprintf(stderr, "\n");
241 }
242
243 static const GMemVTable glib_memvtable = {
244   trap_malloc,
245   trap_realloc,
246   trap_free,
247   0,
248   0,
249   0
250 };
251 #endif
252
253 /** @brief Called once every 10 minutes */
254 static gboolean periodic(gpointer attribute((unused)) data) {
255   D(("periodic"));
256   /* Expire cached data */
257   cache_expire();
258   /* Update everything to be sure that the connection to the server hasn't
259    * mysteriously gone stale on us. */
260   all_update();
261 #if MDEBUG
262   count_widgets();
263   fprintf(stderr, "cache size: %zu\n", cache_count());
264 #endif
265 #if MTRACK
266   report_tags();
267 #endif
268   return TRUE;                          /* don't remove me */
269 }
270
271 /** @brief Called from time to time
272  *
273  * Used for debugging purposes
274  */
275 static gboolean heartbeat(gpointer attribute((unused)) data) {
276   static struct timeval last;
277   struct timeval now;
278   double delta;
279
280   xgettimeofday(&now, 0);
281   if(last.tv_sec) {
282     delta = (now.tv_sec + now.tv_sec / 1.0E6) 
283       - (last.tv_sec + last.tv_sec / 1.0E6);
284     if(delta >= 1.0625)
285       fprintf(stderr, "%f: %fs between 1s heartbeats\n", 
286               now.tv_sec + now.tv_sec / 1.0E6,
287               delta);
288   }
289   last = now;
290   return TRUE;
291 }
292
293 /** @brief Called when a NOP completes */
294 static void nop_completed(void attribute((unused)) *v) {
295   nop_in_flight = 0;
296 }
297
298 /** @brief Called from time to time to arrange for a NOP to be sent
299  *
300  * At most one NOP remains in flight at any moment.  If the client is not
301  * currently connected then no NOP is sent.
302  */
303 static gboolean maybe_send_nop(gpointer attribute((unused)) data) {
304   if(!nop_in_flight && (disorder_eclient_state(client) & DISORDER_CONNECTED)) {
305     nop_in_flight = 1;
306     disorder_eclient_nop(client, nop_completed, 0);
307   }
308   return TRUE;                          /* keep call me please */
309 }
310
311 /* main -------------------------------------------------------------------- */
312
313 static const struct option options[] = {
314   { "help", no_argument, 0, 'h' },
315   { "version", no_argument, 0, 'V' },
316   { "config", required_argument, 0, 'c' },
317   { "tufnel", no_argument, 0, 't' },
318   { "choosealpha", no_argument, 0, 'C' },
319   { "debug", no_argument, 0, 'd' },
320   { 0, 0, 0, 0 }
321 };
322
323 /* display usage message and terminate */
324 static void help(void) {
325   xprintf("Disobedience - GUI client for DisOrder\n"
326           "\n"
327           "Usage:\n"
328           "  disobedience [OPTIONS]\n"
329           "Options:\n"
330           "  --help, -h              Display usage message\n"
331           "  --version, -V           Display version number\n"
332           "  --config PATH, -c PATH  Set configuration file\n"
333           "  --debug, -d             Turn on debugging\n"
334           "\n"
335           "Also GTK+ options will work.\n");
336   xfclose(stdout);
337   exit(0);
338 }
339
340 /* display version number and terminate */
341 static void version(void) {
342   xprintf("disorder version %s\n", disorder_version_string);
343   xfclose(stdout);
344   exit(0);
345 }
346
347 int main(int argc, char **argv) {
348   int n;
349   disorder_eclient *logclient;
350
351   mem_init();
352   /* garbage-collect PCRE's memory */
353   pcre_malloc = xmalloc;
354   pcre_free = xfree;
355 #if MTRACK
356   mtrack_hash = hash_new(sizeof (int));
357   g_mem_set_vtable((GMemVTable *)&glib_memvtable);
358 #endif
359   if(!setlocale(LC_CTYPE, "")) fatal(errno, "error calling setlocale");
360   gtk_init(&argc, &argv);
361   gtk_rc_parse_string(style);
362   while((n = getopt_long(argc, argv, "hVc:dtH", options, 0)) >= 0) {
363     switch(n) {
364     case 'h': help();
365     case 'V': version();
366     case 'c': configfile = optarg; break;
367     case 'd': debugging = 1; break;
368     case 't': goesupto = 11; break;
369     case 'C': choosealpha = 1; break;   /* not well tested any more */
370     default: fatal(0, "invalid option");
371     }
372   }
373   signal(SIGPIPE, SIG_IGN);
374   /* create the event loop */
375   D(("create main loop"));
376   mainloop = g_main_loop_new(0, 0);
377   if(config_read()) fatal(0, "cannot read configuration");
378   /* create the clients */
379   if(!(client = gtkclient())
380      || !(logclient = gtkclient()))
381     return 1;                           /* already reported an error */
382   /* periodic operations (e.g. expiring the cache) */
383 #if MDEBUG || MTRACK
384   g_timeout_add(5000/*milliseconds*/, periodic, 0);
385 #else
386   g_timeout_add(600000/*milliseconds*/, periodic, 0);
387 #endif
388   /* The point of this is to try and get a handle on mysterious
389    * unresponsiveness.  It's not very useful in production use. */
390   if(0)
391     g_timeout_add(1000/*milliseconds*/, heartbeat, 0);
392   make_toplevel_window();
393   /* reset styles now everything has its name */
394   gtk_rc_reset_styles(gtk_settings_get_for_screen(gdk_screen_get_default()));
395   gtk_widget_show_all(toplevel);
396   /* issue a NOP every so often */
397   g_timeout_add_full(G_PRIORITY_LOW,
398                      1000/*interval, ms*/,
399                      maybe_send_nop,
400                      0/*data*/,
401                      0/*notify*/);
402   /* Start monitoring the log */
403   disorder_eclient_log(logclient, &log_callbacks, 0);
404   D(("enter main loop"));
405   MTAG("misc");
406   g_main_loop_run(mainloop);
407   return 0;
408 }
409
410 /*
411 Local Variables:
412 c-basic-offset:2
413 comment-column:40
414 fill-column:79
415 indent-tabs-mode:nil
416 End:
417 */