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", q
);
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();
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);
141 /** @brief Called at startup */
142 static void queue_init(void) {
143 /* Arrange a callback whenever the playing state changes */
144 event_register("playing-changed", playing_changed
, 0);
145 /* We reget both playing track and queue at pause/resume so that start times
146 * can be computed correctly */
147 event_register("pause-changed", playing_changed
, 0);
148 event_register("pause-changed", queue_changed
, 0);
149 /* Reget the queue whenever it changes */
150 event_register("queue-changed", queue_changed
, 0);
151 /* ...and once a second anyway */
152 g_timeout_add(1000/*ms*/, playing_periodic
, 0);
155 /** @brief Columns for the queue */
156 static const struct queue_column queue_columns
[] = {
157 { "When", column_when
, 0, COL_RIGHT
},
158 { "Who", column_who
, 0, 0 },
159 { "Artist", column_namepart
, "artist", COL_EXPAND
|COL_ELLIPSIZE
},
160 { "Album", column_namepart
, "album", COL_EXPAND
|COL_ELLIPSIZE
},
161 { "Title", column_namepart
, "title", COL_EXPAND
|COL_ELLIPSIZE
},
162 { "Length", column_length
, 0, COL_RIGHT
}
165 /** @brief Pop-up menu for queue */
166 static struct menuitem queue_menuitems
[] = {
167 { "Track properties", ql_properties_activate
, ql_properties_sensitive
, 0, 0 },
168 { "Select all tracks", ql_selectall_activate
, ql_selectall_sensitive
, 0, 0 },
169 { "Deselect all tracks", ql_selectnone_activate
, ql_selectnone_sensitive
, 0, 0 },
170 { "Scratch playing track", ql_scratch_activate
, ql_scratch_sensitive
, 0, 0 },
171 { "Remove track from queue", ql_remove_activate
, ql_remove_sensitive
, 0, 0 },
172 { "Adopt track", ql_adopt_activate
, ql_adopt_sensitive
, 0, 0 },
175 struct queuelike ql_queue
= {
178 .columns
= queue_columns
,
179 .ncolumns
= sizeof queue_columns
/ sizeof *queue_columns
,
180 .menuitems
= queue_menuitems
,
181 .nmenuitems
= sizeof queue_menuitems
/ sizeof *queue_menuitems
184 /* Drag and drop has to be figured out experimentally, because it is not well
187 * First you get a row-inserted. The path argument points to the destination
188 * row but this will not yet have had its values set. The source row is still
189 * present. AFAICT the iter argument points to the same place.
191 * Then you get a row-deleted. The path argument identifies the row that was
192 * deleted. By this stage the row inserted above has acquired its values.
194 * A complication is that the deletion will move the inserted row. For
195 * instance, if you do a drag that moves row 1 down to after the track that was
196 * formerly on row 9, in the row-inserted call it will show up as row 10, but
197 * in the row-deleted call, row 1 will have been deleted thus making the
198 * inserted row be row 9.
200 * So when we see the row-inserted we have no idea what track to move.
201 * Therefore we stash it until we see a row-deleted.
204 /** @brief Target row for drag */
205 static int queue_drag_target
= -1;
207 static void queue_move_completed(void attribute((unused
)) *v
,
210 popup_protocol_error(0, err
);
213 /* The log should tell us the queue changed so we do no more here */
216 static void queue_row_deleted(GtkTreeModel
*treemodel
,
218 gpointer
attribute((unused
)) user_data
) {
219 if(!suppress_actions
) {
221 char *ps
= gtk_tree_path_to_string(path
);
222 fprintf(stderr
, "row-deleted path=%s queue_drag_target=%d\n",
223 ps
, queue_drag_target
);
225 gboolean jt
= gtk_tree_model_get_iter_first(treemodel
, j
);
228 struct queue_entry
*q
= ql_iter_to_q(treemodel
, j
);
229 fprintf(stderr
, " %2d %s\n", row
++, q ? q
->track
: "(no q)");
230 jt
= gtk_tree_model_iter_next(GTK_TREE_MODEL(ql_queue
.store
), j
);
234 if(queue_drag_target
< 0) {
235 error(0, "unsuppressed row-deleted with no row-inserted");
238 int drag_source
= gtk_tree_path_get_indices(path
)[0];
240 /* If the drag is downwards (=towards higher row numbers) then the target
241 * will have been moved upwards (=towards lower row numbers) by one row. */
242 if(drag_source
< queue_drag_target
)
245 /* Find the track to move */
247 gboolean srcv
= gtk_tree_model_iter_nth_child(treemodel
, src
, NULL
,
250 error(0, "cannot get iterator to drag target %d", queue_drag_target
);
251 queue_playing_changed();
252 queue_drag_target
= -1;
255 struct queue_entry
*srcq
= ql_iter_to_q(treemodel
, src
);
257 //fprintf(stderr, "move %s %s\n", srcq->id, srcq->track);
259 /* Don't allow the currently playing track to be moved. As above, we put
260 * the queue back into the right order straight away. */
261 if(srcq
== playing_track
) {
262 //fprintf(stderr, "cannot move currently playing track\n");
263 queue_playing_changed();
264 queue_drag_target
= -1;
268 /* Find the destination */
269 struct queue_entry
*dstq
;
270 if(queue_drag_target
) {
272 gboolean dstv
= gtk_tree_model_iter_nth_child(treemodel
, dst
, NULL
,
273 queue_drag_target
- 1);
275 error(0, "cannot get iterator to drag target predecessor %d",
276 queue_drag_target
- 1);
277 queue_playing_changed();
278 queue_drag_target
= -1;
281 dstq
= ql_iter_to_q(treemodel
, dst
);
283 if(dstq
== playing_track
)
287 /* NB if the user attempts to move a queued track before the currently
288 * playing track we assume they just missed a bit, and put it after. */
289 //fprintf(stderr, " target %s %s\n", dstq ? dstq->id : "(none)", dstq ? dstq->track : "(none)");
290 /* Now we know what is to be moved. We need to know the preceding queue
291 * entry so we can move it. */
292 disorder_eclient_moveafter(client
,
293 dstq ? dstq
->id
: "",
295 queue_move_completed
, NULL
);
296 queue_drag_target
= -1;
300 static void queue_row_inserted(GtkTreeModel
attribute((unused
)) *treemodel
,
302 GtkTreeIter
attribute((unused
)) *iter
,
303 gpointer
attribute((unused
)) user_data
) {
304 if(!suppress_actions
) {
306 char *ps
= gtk_tree_path_to_string(path
);
307 GtkTreeIter piter
[1];
308 gboolean pi
= gtk_tree_model_get_iter(treemodel
, piter
, path
);
309 struct queue_entry
*pq
= pi ?
ql_iter_to_q(treemodel
, piter
) : 0;
310 struct queue_entry
*iq
= ql_iter_to_q(treemodel
, iter
);
312 fprintf(stderr
, "row-inserted path=%s pi=%d pq=%p path=%s iq=%p iter=%s\n",
317 ?
(pq ? pq
->track
: "(pq=0)")
320 iq ? iq
->track
: "(iq=0)");
323 gboolean jt
= gtk_tree_model_get_iter_first(treemodel
, j
);
326 struct queue_entry
*q
= ql_iter_to_q(treemodel
, j
);
327 fprintf(stderr
, " %2d %s\n", row
++, q ? q
->track
: "(no q)");
328 jt
= gtk_tree_model_iter_next(GTK_TREE_MODEL(ql_queue
.store
), j
);
332 queue_drag_target
= gtk_tree_path_get_indices(path
)[0];
336 /** @brief Called when a key is pressed in the queue tree view */
337 static gboolean
queue_key_press(GtkWidget
attribute((unused
)) *widget
,
339 gpointer user_data
) {
340 /*fprintf(stderr, "queue_key_press type=%d state=%#x keyval=%#x\n",
341 event->type, event->state, event->keyval);*/
342 switch(event
->keyval
) {
346 break; /* Only take unmodified DEL/<-- */
347 ql_remove_activate(0, user_data
);
348 return TRUE
; /* Do not propagate */
350 return FALSE
; /* Propagate */
353 GtkWidget
*queue_widget(void) {
354 GtkWidget
*const w
= init_queuelike(&ql_queue
);
356 /* Enable drag+drop */
357 gtk_tree_view_set_reorderable(GTK_TREE_VIEW(ql_queue
.view
), TRUE
);
358 g_signal_connect(ql_queue
.store
,
360 G_CALLBACK(queue_row_inserted
), &ql_queue
);
361 g_signal_connect(ql_queue
.store
,
363 G_CALLBACK(queue_row_deleted
), &ql_queue
);
364 /* Catch keypresses */
365 g_signal_connect(ql_queue
.view
, "key-press-event",
366 G_CALLBACK(queue_key_press
), &ql_queue
);
370 /** @brief Return nonzero if @p track is in the queue */
371 int queued(const char *track
) {
372 struct queue_entry
*q
;
374 D(("queued %s", track
));
375 /* Queue will contain resolved name */
376 track
= namepart_resolve(track
);
377 for(q
= ql_queue
.q
; q
; q
= q
->next
)
378 if(!strcmp(q
->track
, track
))