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