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 #include "disobedience.h"
20 #include "queue-generic.h"
22 /** @brief The actual queue */
23 static struct queue_entry
*actual_queue
;
24 static struct queue_entry
*actual_playing_track
;
26 /** @brief The playing track */
27 struct queue_entry
*playing_track
;
29 /** @brief When we last got the playing track */
32 static void queue_completed(void *v
,
34 struct queue_entry
*q
);
35 static void playing_completed(void *v
,
37 struct queue_entry
*q
);
39 /** @brief Called when either the actual queue or the playing track change */
40 static void queue_playing_changed(void) {
41 const char *old_id
= playing_track ? playing_track
->id
: 0;
43 /* Check that the playing track isn't in the queue. There's a race here due
44 * to the fact that we issue the two commands at slightly different times.
45 * If it goes wrong we re-issue and try again, so that we never offer up an
46 * inconsistent state. */
47 if(actual_playing_track
) {
48 struct queue_entry
*q
;
49 for(q
= actual_queue
; q
; q
= q
->next
)
50 if(!strcmp(q
->id
, actual_playing_track
->id
))
53 disorder_eclient_playing(client
, playing_completed
, 0);
54 disorder_eclient_queue(client
, queue_completed
, 0);
59 struct queue_entry
*q
= xmalloc(sizeof *q
);
60 if(actual_playing_track
) {
61 *q
= *actual_playing_track
;
62 q
->next
= actual_queue
;
68 if(!old_id
|| !playing_track
|| strcmp(old_id
, playing_track
->id
))
69 time(&last_playing
); /* for column_length() */
70 ql_new_queue(&ql_queue
, q
);
71 /* Tell anyone who cares */
72 event_raise("queue-list-changed", q
);
73 event_raise("playing-track-changed", q
);
76 /** @brief Update the queue itself */
77 static void queue_completed(void attribute((unused
)) *v
,
79 struct queue_entry
*q
) {
81 popup_protocol_error(0, err
);
85 queue_playing_changed();
88 /** @brief Update the playing track */
89 static void playing_completed(void attribute((unused
)) *v
,
91 struct queue_entry
*q
) {
93 popup_protocol_error(0, err
);
96 actual_playing_track
= q
;
97 queue_playing_changed();
100 /** @brief Schedule an update to the queue
102 * Called whenever a track is added to it or removed from it.
104 static void queue_changed(const char attribute((unused
)) *event
,
105 void attribute((unused
)) *eventdata
,
106 void attribute((unused
)) *callbackdata
) {
107 D(("queue_changed"));
108 gtk_label_set_text(GTK_LABEL(report_label
), "updating queue");
109 disorder_eclient_queue(client
, queue_completed
, 0);
112 /** @brief Schedule an update to the playing track
114 * Called whenever it changes
116 static void playing_changed(const char attribute((unused
)) *event
,
117 void attribute((unused
)) *eventdata
,
118 void attribute((unused
)) *callbackdata
) {
119 D(("playing_changed"));
120 gtk_label_set_text(GTK_LABEL(report_label
), "updating playing track");
121 disorder_eclient_playing(client
, playing_completed
, 0);
124 /** @brief Called regularly
126 * Updates the played-so-far field
128 static gboolean
playing_periodic(gpointer
attribute((unused
)) data
) {
129 /* If there's a track playing, update its row */
131 ql_update_row(playing_track
, 0);
135 /** @brief Called at startup */
136 static void queue_init(void) {
137 /* Arrange a callback whenever the playing state changes */
138 event_register("playing-changed", playing_changed
, 0);
139 /* We reget both playing track and queue at pause/resume so that start times
140 * can be computed correctly */
141 event_register("pause-changed", playing_changed
, 0);
142 event_register("pause-changed", queue_changed
, 0);
143 /* Reget the queue whenever it changes */
144 event_register("queue-changed", queue_changed
, 0);
145 /* ...and once a second anyway */
146 g_timeout_add(1000/*ms*/, playing_periodic
, 0);
149 /** @brief Columns for the queue */
150 static const struct queue_column queue_columns
[] = {
151 { "When", column_when
, 0, COL_RIGHT
},
152 { "Who", column_who
, 0, 0 },
153 { "Artist", column_namepart
, "artist", COL_EXPAND
|COL_ELLIPSIZE
},
154 { "Album", column_namepart
, "album", COL_EXPAND
|COL_ELLIPSIZE
},
155 { "Title", column_namepart
, "title", COL_EXPAND
|COL_ELLIPSIZE
},
156 { "Length", column_length
, 0, COL_RIGHT
}
159 /** @brief Pop-up menu for queue */
160 static struct menuitem queue_menuitems
[] = {
161 { "Track properties", ql_properties_activate
, ql_properties_sensitive
, 0, 0 },
162 { "Select all tracks", ql_selectall_activate
, ql_selectall_sensitive
, 0, 0 },
163 { "Deselect all tracks", ql_selectnone_activate
, ql_selectnone_sensitive
, 0, 0 },
164 { "Scratch playing track", ql_scratch_activate
, ql_scratch_sensitive
, 0, 0 },
165 { "Remove track from queue", ql_remove_activate
, ql_remove_sensitive
, 0, 0 },
168 struct queuelike ql_queue
= {
171 .columns
= queue_columns
,
172 .ncolumns
= sizeof queue_columns
/ sizeof *queue_columns
,
173 .menuitems
= queue_menuitems
,
174 .nmenuitems
= sizeof queue_menuitems
/ sizeof *queue_menuitems
177 /* Drag and drop has to be figured out experimentally, because it is not well
180 * First you get a row-inserted. The path argument points to the destination
181 * row but this will not yet have had its values set. The source row is still
182 * present. AFAICT the iter argument points to the same place.
184 * Then you get a row-deleted. The path argument identifies the row that was
185 * deleted. By this stage the row inserted above has acquired its values.
187 * A complication is that the deletion will move the inserted row. For
188 * instance, if you do a drag that moves row 1 down to after the track that was
189 * formerly on row 9, in the row-inserted call it will show up as row 10, but
190 * in the row-deleted call, row 1 will have been deleted thus making the
191 * inserted row be row 9.
193 * So when we see the row-inserted we have no idea what track to move.
194 * Therefore we stash it until we see a row-deleted.
197 /** @brief Target row for drag */
198 static int queue_drag_target
= -1;
200 static void queue_move_completed(void attribute((unused
)) *v
,
203 popup_protocol_error(0, err
);
206 /* The log should tell us the queue changed so we do no more here */
209 static void queue_row_deleted(GtkTreeModel
*treemodel
,
211 gpointer
attribute((unused
)) user_data
) {
212 if(!suppress_actions
) {
214 char *ps
= gtk_tree_path_to_string(path
);
215 fprintf(stderr
, "row-deleted path=%s queue_drag_target=%d\n",
216 ps
, queue_drag_target
);
218 gboolean jt
= gtk_tree_model_get_iter_first(treemodel
, j
);
221 struct queue_entry
*q
= ql_iter_to_q(treemodel
, j
);
222 fprintf(stderr
, " %2d %s\n", row
++, q ? q
->track
: "(no q)");
223 jt
= gtk_tree_model_iter_next(GTK_TREE_MODEL(ql_queue
.store
), j
);
227 if(queue_drag_target
< 0) {
228 error(0, "unsuppressed row-deleted with no row-inserted");
231 int drag_source
= gtk_tree_path_get_indices(path
)[0];
233 /* If the drag is downwards (=towards higher row numbers) then the target
234 * will have been moved upwards (=towards lower row numbers) by one row. */
235 if(drag_source
< queue_drag_target
)
238 /* Find the track to move */
240 gboolean srcv
= gtk_tree_model_iter_nth_child(treemodel
, src
, NULL
,
243 error(0, "cannot get iterator to drag target %d", queue_drag_target
);
244 queue_playing_changed();
245 queue_drag_target
= -1;
248 struct queue_entry
*srcq
= ql_iter_to_q(treemodel
, src
);
250 //fprintf(stderr, "move %s %s\n", srcq->id, srcq->track);
252 /* Don't allow the currently playing track to be moved. As above, we put
253 * the queue back into the right order straight away. */
254 if(srcq
== playing_track
) {
255 //fprintf(stderr, "cannot move currently playing track\n");
256 queue_playing_changed();
257 queue_drag_target
= -1;
261 /* Find the destination */
262 struct queue_entry
*dstq
;
263 if(queue_drag_target
) {
265 gboolean dstv
= gtk_tree_model_iter_nth_child(treemodel
, dst
, NULL
,
266 queue_drag_target
- 1);
268 error(0, "cannot get iterator to drag target predecessor %d",
269 queue_drag_target
- 1);
270 queue_playing_changed();
271 queue_drag_target
= -1;
274 dstq
= ql_iter_to_q(treemodel
, dst
);
276 if(dstq
== playing_track
)
280 /* NB if the user attempts to move a queued track before the currently
281 * playing track we assume they just missed a bit, and put it after. */
282 //fprintf(stderr, " target %s %s\n", dstq ? dstq->id : "(none)", dstq ? dstq->track : "(none)");
283 /* Now we know what is to be moved. We need to know the preceding queue
284 * entry so we can move it. */
285 disorder_eclient_moveafter(client
,
286 dstq ? dstq
->id
: "",
288 queue_move_completed
, NULL
);
289 queue_drag_target
= -1;
293 static void queue_row_inserted(GtkTreeModel
attribute((unused
)) *treemodel
,
295 GtkTreeIter
attribute((unused
)) *iter
,
296 gpointer
attribute((unused
)) user_data
) {
297 if(!suppress_actions
) {
299 char *ps
= gtk_tree_path_to_string(path
);
300 GtkTreeIter piter
[1];
301 gboolean pi
= gtk_tree_model_get_iter(treemodel
, piter
, path
);
302 struct queue_entry
*pq
= pi ?
ql_iter_to_q(treemodel
, piter
) : 0;
303 struct queue_entry
*iq
= ql_iter_to_q(treemodel
, iter
);
305 fprintf(stderr
, "row-inserted path=%s pi=%d pq=%p path=%s iq=%p iter=%s\n",
310 ?
(pq ? pq
->track
: "(pq=0)")
313 iq ? iq
->track
: "(iq=0)");
316 gboolean jt
= gtk_tree_model_get_iter_first(treemodel
, j
);
319 struct queue_entry
*q
= ql_iter_to_q(treemodel
, j
);
320 fprintf(stderr
, " %2d %s\n", row
++, q ? q
->track
: "(no q)");
321 jt
= gtk_tree_model_iter_next(GTK_TREE_MODEL(ql_queue
.store
), j
);
325 queue_drag_target
= gtk_tree_path_get_indices(path
)[0];
329 /** @brief Called when a key is pressed in the queue tree view */
330 static gboolean
queue_key_press(GtkWidget
attribute((unused
)) *widget
,
332 gpointer user_data
) {
333 /*fprintf(stderr, "queue_key_press type=%d state=%#x keyval=%#x\n",
334 event->type, event->state, event->keyval);*/
335 switch(event
->keyval
) {
339 break; /* Only take unmodified DEL/<-- */
340 ql_remove_activate(0, user_data
);
341 return TRUE
; /* Do not propagate */
343 return FALSE
; /* Propagate */
346 GtkWidget
*queue_widget(void) {
347 GtkWidget
*const w
= init_queuelike(&ql_queue
);
349 /* Enable drag+drop */
350 gtk_tree_view_set_reorderable(GTK_TREE_VIEW(ql_queue
.view
), TRUE
);
351 g_signal_connect(ql_queue
.store
,
353 G_CALLBACK(queue_row_inserted
), &ql_queue
);
354 g_signal_connect(ql_queue
.store
,
356 G_CALLBACK(queue_row_deleted
), &ql_queue
);
357 /* Catch keypresses */
358 g_signal_connect(ql_queue
.view
, "key-press-event",
359 G_CALLBACK(queue_key_press
), &ql_queue
);
363 /** @brief Return nonzero if @p track is in the queue */
364 int queued(const char *track
) {
365 struct queue_entry
*q
;
367 D(("queued %s", track
));
368 /* Queue will contain resolved name */
369 track
= namepart_resolve(track
);
370 for(q
= ql_queue
.q
; q
; q
= q
->next
)
371 if(!strcmp(q
->track
, track
))