chiark - git - mdw - disorder/blob - disobedience/queue.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 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/queue.c
  19  * @brief Disobedience queue widget
  20  */
  21 #include "disobedience.h"
  22 #include "popup.h"
  23 #include "queue-generic.h"
  24
  25 /** @brief The actual queue */
  26 static struct queue_entry *actual_queue;
  27 static struct queue_entry *actual_playing_track;
  28
  29 /** @brief The playing track */
  30 struct queue_entry *playing_track;
  31
  32 /** @brief When we last got the playing track
  33  *
  34  * Set to 0 if the timings are currently off due to having just unpaused.
  35  */
  36 time_t last_playing;
  37
  38 static void queue_completed(void *v,
  39                             const char *err,
  40                             struct queue_entry *q);
  41 static void playing_completed(void *v,
  42                               const char *err,
  43                               struct queue_entry *q);
  44
  45 /** @brief Called when either the actual queue or the playing track change */
  46 static void queue_playing_changed(void) {
  47   /* Check that the playing track isn't in the queue.  There's a race here due
  48    * to the fact that we issue the two commands at slightly different times.
  49    * If it goes wrong we re-issue and try again, so that we never offer up an
  50    * inconsistent state. */
  51   if(actual_playing_track) {
  52     struct queue_entry *q;
  53     for(q = actual_queue; q; q = q->next)
  54       if(!strcmp(q->id, actual_playing_track->id))
  55         break;
  56     if(q) {
  57       disorder_eclient_playing(client, playing_completed, 0);
  58       if(full_mode)
  59         disorder_eclient_queue(client, queue_completed, 0);
  60       return;
  61     }
  62   }
  63
  64   struct queue_entry *q = xmalloc(sizeof *q);
  65   if(actual_playing_track) {
  66     *q = *actual_playing_track;
  67     q->next = actual_queue;
  68     playing_track = q;
  69   } else {
  70     playing_track = NULL;
  71     q = actual_queue;
  72   }
  73   ql_new_queue(&ql_queue, q);
  74   /* Tell anyone who cares */
  75   event_raise("queue-list-changed", q);
  76   event_raise("playing-track-changed", q);
  77 }
  78
  79 /** @brief Update the queue itself */
  80 static void queue_completed(void attribute((unused)) *v,
  81                             const char *err,
  82                             struct queue_entry *q) {
  83   if(err) {
  84     popup_protocol_error(0, err);
  85     return;
  86   }
  87   if(full_mode)
  88     actual_queue = q;
  89   else
  90     actual_queue = NULL;
  91   queue_playing_changed();
  92 }
  93
  94 /** @brief Update the playing track */
  95 static void playing_completed(void attribute((unused)) *v,
  96                               const char *err,
  97                               struct queue_entry *q) {
  98   if(err) {
  99     popup_protocol_error(0, err);
 100     return;
 101   }
 102   actual_playing_track = q;
 103   queue_playing_changed();
 104   xtime(&last_playing);
 105 }
 106
 107 /** @brief Schedule an update to the queue
 108  *
 109  * Called whenever a track is added to it or removed from it.
 110  */
 111 static void queue_changed(const char attribute((unused)) *event,
 112                            void  attribute((unused)) *eventdata,
 113                            void  attribute((unused)) *callbackdata) {
 114   D(("queue_changed"));
 115   if(!full_mode)
 116     return;
 117   gtk_label_set_text(GTK_LABEL(report_label), "updating queue");
 118   disorder_eclient_queue(client, queue_completed, 0);
 119 }
 120
 121 /** @brief Schedule an update to the playing track
 122  *
 123  * Called whenever it changes
 124  */
 125 static void playing_changed(const char attribute((unused)) *event,
 126                             void  attribute((unused)) *eventdata,
 127                             void  attribute((unused)) *callbackdata) {
 128   D(("playing_changed"));
 129   gtk_label_set_text(GTK_LABEL(report_label), "updating playing track");
 130   /* Setting last_playing=0 means that we don't know what the correct value
 131    * is right now, e.g. because things have been deranged by a pause. */
 132   last_playing = 0;
 133   disorder_eclient_playing(client, playing_completed, 0);
 134 }
 135
 136 /** @brief Called regularly
 137  *
 138  * Updates the played-so-far field
 139  */
 140 static gboolean playing_periodic(gpointer attribute((unused)) data) {
 141   /* If there's a track playing, update its row */
 142   if(playing_track)
 143     ql_update_row(playing_track, 0);
 144   /* If the first (nonplaying) track starts in the past, update the queue to
 145    * get new expected start times; but rate limit this checking.  (If we only
 146    * do it once a minute then the rest of the queue can get out of date too
 147    * easily.) */
 148   struct queue_entry *q = ql_queue.q;
 149   if(q) {
 150     if(q == playing_track)
 151       q = q->next;
 152     if(q) {
 153       time_t now;
 154       time(&now);
 155       if(q->expected / 15 < now / 15)
 156         queue_changed(0,0,0);
 157     }
 158   }
 159   return TRUE;
 160 }
 161
 162 /** @brief Called at startup */
 163 static void queue_init(struct queuelike attribute((unused)) *ql) {
 164   /* Arrange a callback whenever the playing state changes */
 165   event_register("playing-changed", playing_changed, 0);
 166   /* We reget both playing track and queue at pause/resume so that start times
 167    * can be computed correctly */
 168   event_register("pause-changed", playing_changed, 0);
 169   event_register("pause-changed", queue_changed, 0);
 170   /* Reget the queue whenever it changes */
 171   event_register("queue-changed", queue_changed, 0);
 172   /* ...and once a second anyway */
 173   g_timeout_add(1000/*ms*/, playing_periodic, 0);
 174 }
 175
 176 static void queue_drop_completed(void attribute((unused)) *v,
 177                                  const char *err) {
 178   if(err) {
 179     popup_protocol_error(0, err);
 180     return;
 181   }
 182   /* The log should tell us the queue changed so we do no more here */
 183 }
 184
 185 /** @brief Called when drag+drop completes */
 186 static void queue_drop(struct queuelike attribute((unused)) *ql,
 187                        int ntracks,
 188                        char **tracks, char **ids,
 189                        struct queue_entry *after_me) {
 190   int n;
 191
 192   if(ids) {
 193     /* Rearrangement */
 194     if(playing_track) {
 195       /* If there's a playing track then you can't drag it anywhere  */
 196       for(n = 0; n < ntracks; ++n) {
 197         if(!strcmp(playing_track->id, ids[n])) {
 198           fprintf(stderr, "cannot drag playing track\n");
 199           return;
 200         }
 201       }
 202       /* You can't tell the server to drag after the playing track by ID, you
 203        * have to send "". */
 204       if(after_me == playing_track)
 205         after_me = NULL;
 206       /* If you try to drag before the playing track (i.e. after_me=NULL on
 207        * input) then the effect is just to drag after it, although there's no
 208        * longer code to explicitly implement this. */
 209     }
 210     /* Tell the server to move them.  The log will tell us about the change (if
 211      * indeed it succeeds!), so no need to rearrange the model now. */
 212     disorder_eclient_moveafter(client,
 213                                after_me ? after_me->id : "",
 214                                ntracks, (const char **)ids,
 215                                queue_drop_completed, NULL);
 216   } else {
 217     /* You can't tell the server to insert after the playing track by ID, you
 218      * have to send "". */
 219     if(after_me == playing_track)
 220       after_me = NULL;
 221     /* Play the tracks */
 222     disorder_eclient_playafter(client,
 223                                after_me ? after_me->id : "",
 224                                ntracks, (const char **)tracks,
 225                                queue_drop_completed, NULL);
 226   }
 227 }
 228
 229 /** @brief Columns for the queue */
 230 static const struct queue_column queue_columns[] = {
 231   { "When",   column_when,     0,        COL_RIGHT },
 232   { "Who",    column_who,      0,        0 },
 233   { "Artist", column_namepart, "artist", COL_EXPAND|COL_ELLIPSIZE },
 234   { "Album",  column_namepart, "album",  COL_EXPAND|COL_ELLIPSIZE },
 235   { "Title",  column_namepart, "title",  COL_EXPAND|COL_ELLIPSIZE },
 236   { "Length", column_length,   0,        COL_RIGHT }
 237 };
 238
 239 /** @brief Pop-up menu for queue */
 240 static struct menuitem queue_menuitems[] = {
 241   { "Track properties", ql_properties_activate, ql_properties_sensitive, 0, 0 },
 242   { "Select all tracks", ql_selectall_activate, ql_selectall_sensitive, 0, 0 },
 243   { "Deselect all tracks", ql_selectnone_activate, ql_selectnone_sensitive, 0, 0 },
 244   { "Scratch playing track", ql_scratch_activate, ql_scratch_sensitive, 0, 0 },
 245   { "Remove track from queue", ql_remove_activate, ql_remove_sensitive, 0, 0 },
 246   { "Adopt track", ql_adopt_activate, ql_adopt_sensitive, 0, 0 },
 247 };
 248
 249 static const GtkTargetEntry queue_targets[] = {
 250   {
 251     QUEUED_TRACKS,                      /* drag type */
 252     GTK_TARGET_SAME_WIDGET,             /* rearrangement within a widget */
 253     QUEUED_TRACKS_ID                    /* ID value */
 254   },
 255   {
 256     PLAYABLE_TRACKS,                             /* drag type */
 257     GTK_TARGET_SAME_APP|GTK_TARGET_OTHER_WIDGET, /* copying between widgets */
 258     PLAYABLE_TRACKS_ID,                          /* ID value */
 259   },
 260   {
 261     .target = NULL
 262   }
 263 };
 264
 265 struct queuelike ql_queue = {
 266   .name = "queue",
 267   .init = queue_init,
 268   .columns = queue_columns,
 269   .ncolumns = sizeof queue_columns / sizeof *queue_columns,
 270   .menuitems = queue_menuitems,
 271   .nmenuitems = sizeof queue_menuitems / sizeof *queue_menuitems,
 272   .drop = queue_drop,
 273   .drag_source_targets = queue_targets,
 274   .drag_source_actions = GDK_ACTION_MOVE|GDK_ACTION_COPY,
 275   .drag_dest_targets = queue_targets,
 276   .drag_dest_actions = GDK_ACTION_MOVE|GDK_ACTION_COPY,
 277 };
 278
 279 /** @brief Called when a key is pressed in the queue tree view */
 280 static gboolean queue_key_press(GtkWidget attribute((unused)) *widget,
 281                                 GdkEventKey *event,
 282                                 gpointer user_data) {
 283   /*fprintf(stderr, "queue_key_press type=%d state=%#x keyval=%#x\n",
 284           event->type, event->state, event->keyval);*/
 285   switch(event->keyval) {
 286   case GDK_BackSpace:
 287   case GDK_Delete:
 288     if(event->state)
 289       break;                            /* Only take unmodified DEL/<-- */
 290     ql_remove_activate(0, user_data);
 291     return TRUE;                        /* Do not propagate */
 292   }
 293   return FALSE;                         /* Propagate */
 294 }
 295
 296 static void queue_minimode(const char attribute((unused)) *event,
 297                            void attribute((unused)) *evendata,
 298                            void attribute((unused)) *callbackdata) {
 299   if(full_mode) {
 300     /* We will need to refetch the queue */
 301     disorder_eclient_queue(client, queue_completed, 0);
 302   } else {
 303     /* We will need to hide the queue */
 304     if(actual_queue)
 305       queue_completed(NULL, NULL, NULL);
 306   }
 307 }
 308
 309 GtkWidget *queue_widget(void) {
 310   GtkWidget *const w = init_queuelike(&ql_queue);
 311
 312   /* Catch keypresses */
 313   g_signal_connect(ql_queue.view, "key-press-event",
 314                    G_CALLBACK(queue_key_press), &ql_queue);
 315
 316   event_register("mini-mode-changed", queue_minimode, 0);
 317   return w;
 318 }
 319
 320 /** @brief Return nonzero if @p track is in the queue */
 321 int queued(const char *track) {
 322   struct queue_entry *q;
 323
 324   D(("queued %s", track));
 325   /* Queue will contain resolved name */
 326   track = namepart_resolve(track);
 327   for(q = ql_queue.q; q; q = q->next)
 328     if(!strcmp(q->track, track))
 329       return 1;
 330   return 0;
 331 }
 332
 333 /*
 334 Local Variables:
 335 c-basic-offset:2
 336 comment-column:40
 337 fill-column:79
 338 indent-tabs-mode:nil
 339 End:
 340 */