2 * This file is part of DisOrder
3 * Copyright (C) 2006-2008 Richard Kettlewell
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.
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.
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/>.
18 /** @file disobedience/queue.c
19 * @brief Disobedience queue widget
21 #include "disobedience.h"
23 #include "queue-generic.h"
25 /** @brief The actual queue */
26 static struct queue_entry
*actual_queue
;
27 static struct queue_entry
*actual_playing_track
;
29 /** @brief The playing track */
30 struct queue_entry
*playing_track
;
32 /** @brief When we last got the playing track
34 * Set to 0 if the timings are currently off due to having just unpaused.
38 static void queue_completed(void *v
,
40 struct queue_entry
*q
);
41 static void playing_completed(void *v
,
43 struct queue_entry
*q
);
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
))
57 disorder_eclient_playing(client
, playing_completed
, 0);
58 disorder_eclient_queue(client
, queue_completed
, 0);
63 struct queue_entry
*q
= xmalloc(sizeof *q
);
64 if(actual_playing_track
) {
65 *q
= *actual_playing_track
;
66 q
->next
= actual_queue
;
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
);
78 /** @brief Update the queue itself */
79 static void queue_completed(void attribute((unused
)) *v
,
81 struct queue_entry
*q
) {
83 popup_protocol_error(0, err
);
87 queue_playing_changed();
90 /** @brief Update the playing track */
91 static void playing_completed(void attribute((unused
)) *v
,
93 struct queue_entry
*q
) {
95 popup_protocol_error(0, err
);
98 actual_playing_track
= q
;
99 queue_playing_changed();
100 xtime(&last_playing
);
103 /** @brief Schedule an update to the queue
105 * Called whenever a track is added to it or removed from it.
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);
115 /** @brief Schedule an update to the playing track
117 * Called whenever it changes
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. */
127 disorder_eclient_playing(client
, playing_completed
, 0);
130 /** @brief Called regularly
132 * Updates the played-so-far field
134 static gboolean
playing_periodic(gpointer
attribute((unused
)) data
) {
135 /* If there's a track playing, update its row */
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
142 struct queue_entry
*q
= ql_queue
.q
;
144 if(q
== playing_track
)
149 if(q
->expected
/ 15 < now
/ 15)
150 queue_changed(0,0,0);
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);
171 static void queue_drop_completed(void attribute((unused
)) *v
,
174 popup_protocol_error(0, err
);
177 /* The log should tell us the queue changed so we do no more here */
180 /** @brief Called when drag+drop completes */
181 static void queue_drop(struct queuelike
attribute((unused
)) *ql
,
183 char **tracks
, char **ids
,
184 struct queue_entry
*after_me
) {
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");
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
)
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. */
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 after_me ? after_me
->id
: "",
209 ntracks
, (const char **)ids
,
210 queue_drop_completed
, NULL
);
212 /* You can't tell the server to insert after the playing track by ID, you
213 * have to send "". */
214 if(after_me
== playing_track
)
216 /* Play the tracks */
217 disorder_eclient_playafter(client
,
218 after_me ? after_me
->id
: "",
219 ntracks
, (const char **)tracks
,
220 queue_drop_completed
, NULL
);
224 /** @brief Columns for the queue */
225 static const struct queue_column queue_columns
[] = {
226 { "When", column_when
, 0, COL_RIGHT
},
227 { "Who", column_who
, 0, 0 },
228 { "Artist", column_namepart
, "artist", COL_EXPAND
|COL_ELLIPSIZE
},
229 { "Album", column_namepart
, "album", COL_EXPAND
|COL_ELLIPSIZE
},
230 { "Title", column_namepart
, "title", COL_EXPAND
|COL_ELLIPSIZE
},
231 { "Length", column_length
, 0, COL_RIGHT
}
234 /** @brief Pop-up menu for queue */
235 static struct menuitem queue_menuitems
[] = {
236 { "Track properties", GTK_STOCK_PROPERTIES
, ql_properties_activate
, ql_properties_sensitive
, 0, 0 },
237 { "Select all tracks", GTK_STOCK_SELECT_ALL
, ql_selectall_activate
, ql_selectall_sensitive
, 0, 0 },
238 { "Deselect all tracks", NULL
, ql_selectnone_activate
, ql_selectnone_sensitive
, 0, 0 },
239 { "Scratch playing track", GTK_STOCK_STOP
, ql_scratch_activate
, ql_scratch_sensitive
, 0, 0 },
240 { "Remove track from queue", GTK_STOCK_DELETE
, ql_remove_activate
, ql_remove_sensitive
, 0, 0 },
241 { "Adopt track", NULL
, ql_adopt_activate
, ql_adopt_sensitive
, 0, 0 },
244 static const GtkTargetEntry queue_targets
[] = {
246 QUEUED_TRACKS
, /* drag type */
247 GTK_TARGET_SAME_WIDGET
, /* rearrangement within a widget */
248 QUEUED_TRACKS_ID
/* ID value */
251 PLAYABLE_TRACKS
, /* drag type */
252 GTK_TARGET_SAME_APP
|GTK_TARGET_OTHER_WIDGET
, /* copying between widgets */
253 PLAYABLE_TRACKS_ID
, /* ID value */
260 struct queuelike ql_queue
= {
263 .columns
= queue_columns
,
264 .ncolumns
= sizeof queue_columns
/ sizeof *queue_columns
,
265 .menuitems
= queue_menuitems
,
266 .nmenuitems
= sizeof queue_menuitems
/ sizeof *queue_menuitems
,
268 .drag_source_targets
= queue_targets
,
269 .drag_source_actions
= GDK_ACTION_MOVE
|GDK_ACTION_COPY
,
270 .drag_dest_targets
= queue_targets
,
271 .drag_dest_actions
= GDK_ACTION_MOVE
|GDK_ACTION_COPY
,
274 /** @brief Called when a key is pressed in the queue tree view */
275 static gboolean
queue_key_press(GtkWidget
attribute((unused
)) *widget
,
277 gpointer user_data
) {
278 /*fprintf(stderr, "queue_key_press type=%d state=%#x keyval=%#x\n",
279 event->type, event->state, event->keyval);*/
280 switch(event
->keyval
) {
284 break; /* Only take unmodified DEL/<-- */
285 ql_remove_activate(0, user_data
);
286 return TRUE
; /* Do not propagate */
288 return FALSE
; /* Propagate */
291 GtkWidget
*queue_widget(void) {
292 GtkWidget
*const w
= init_queuelike(&ql_queue
);
294 /* Catch keypresses */
295 g_signal_connect(ql_queue
.view
, "key-press-event",
296 G_CALLBACK(queue_key_press
), &ql_queue
);
300 /** @brief Return nonzero if @p track is in the queue */
301 int queued(const char *track
) {
302 struct queue_entry
*q
;
304 D(("queued %s", track
));
305 /* Queue will contain resolved name */
306 track
= namepart_resolve(track
);
307 for(q
= ql_queue
.q
; q
; q
= q
->next
)
308 if(!strcmp(q
->track
, track
))
313 /* Playing widget for mini-mode */
315 static void queue_set_playing_widget(const char attribute((unused
)) *event
,
316 void attribute((unused
)) *eventdata
,
317 void *callbackdata
) {
318 GtkLabel
*w
= callbackdata
;
321 const char *artist
= namepart(playing_track
->track
, "display", "artist");
322 const char *album
= namepart(playing_track
->track
, "display", "album");
323 const char *title
= namepart(playing_track
->track
, "display", "title");
324 const char *ldata
= column_length(playing_track
, NULL
);
328 byte_xasprintf(&text
, "%s/%s/%s %s", artist
, album
, title
, ldata
);
329 gtk_label_set_text(w
, text
);
331 gtk_label_set_text(w
, "");
334 GtkWidget
*playing_widget(void) {
335 GtkWidget
*w
= gtk_label_new("");
336 gtk_misc_set_alignment(GTK_MISC(w
), 1.0, 0);
337 /* Spot changes to the playing track */
338 event_register("playing-track-changed",
339 queue_set_playing_widget
,
341 /* Use the best-known name for it */
342 event_register("lookups-complete",
343 queue_set_playing_widget
,
345 /* Keep the amount played so far up to date */
346 event_register("periodic-fast",
347 queue_set_playing_widget
,
349 return frame_widget(w
, NULL
);