chiark / gitweb /
build: various fixes for ubuntu 12.10/gcc 4.7
[disorder] / server / play.c
CommitLineData
460b9539 1/*
2 * This file is part of DisOrder.
16fb2830 3 * Copyright (C) 2004-2009 Richard Kettlewell
460b9539 4 *
e7eb3a27 5 * This program is free software: you can redistribute it and/or modify
460b9539 6 * it under the terms of the GNU General Public License as published by
e7eb3a27 7 * the Free Software Foundation, either version 3 of the License, or
460b9539 8 * (at your option) any later version.
9 *
e7eb3a27
RK
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 *
460b9539 15 * You should have received a copy of the GNU General Public License
e7eb3a27 16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
460b9539 17 */
132a5a4a
RK
18/** @file server/play.c
19 * @brief Playing tracks
5bac5b78
RK
20 *
21 * This file is rather badly organized. Sorry. It's better than it was...
132a5a4a 22 */
460b9539 23
05b75f8d 24#include "disorder-server.h"
460b9539 25#include <ao/ao.h>
460b9539 26
27#define SPEAKER "disorder-speaker"
28
16fb2830 29/** @brief The current playing track or NULL */
460b9539 30struct queue_entry *playing;
16fb2830
RK
31
32/** @brief Set when paused */
460b9539 33int paused;
34
35static void finished(ev_source *ev);
5bac5b78
RK
36static int start_child(struct queue_entry *q,
37 const struct pbgc_params *params,
38 void attribute((unused)) *bgdata);
39static int prepare_child(struct queue_entry *q,
40 const struct pbgc_params *params,
41 void attribute((unused)) *bgdata);
4857234e 42static void ensure_next_scratch(ev_source *ev);
460b9539 43
16fb2830 44/** @brief File descriptor of our end of the socket to the speaker */
460b9539 45static int speaker_fd = -1;
16fb2830 46
16fb2830 47/** @brief Set when shutting down */
460b9539 48static int shutting_down;
49
5bac5b78
RK
50/* Speaker ------------------------------------------------------------------ */
51
16fb2830
RK
52/** @brief Called when speaker process terminates
53 *
54 * Currently kills of DisOrder completely. A future version could terminate
55 * the speaker when nothing was going on, or recover from failures, though any
56 * tracks with decoders already started would need to have them restarted.
57 */
460b9539 58static int speaker_terminated(ev_source attribute((unused)) *ev,
59 pid_t attribute((unused)) pid,
60 int attribute((unused)) status,
61 const struct rusage attribute((unused)) *rusage,
62 void attribute((unused)) *u) {
2e9ba080 63 disorder_fatal(0, "speaker subprocess %s", wstat(status));
460b9539 64}
65
16fb2830 66/** @brief Called when we get a message from the speaker process */
460b9539 67static int speaker_readable(ev_source *ev, int fd,
68 void attribute((unused)) *u) {
69 struct speaker_message sm;
84aa9f93 70 int ret = speaker_recv(fd, &sm);
460b9539 71
72 if(ret < 0) return 0; /* EAGAIN */
73 if(!ret) { /* EOF */
74 ev_fd_cancel(ev, ev_read, fd);
75 return 0;
76 }
77 switch(sm.type) {
78 case SM_PAUSED:
79 /* track ID is paused, DATA seconds played */
80 D(("SM_PAUSED %s %ld", sm.id, sm.data));
81 playing->sofar = sm.data;
82 break;
819f5988
RK
83 case SM_FINISHED: /* scratched the playing track */
84 case SM_STILLBORN: /* scratched too early */
85 case SM_UNKNOWN: /* scratched WAY too early */
f3102c22
RK
86 if(playing && !strcmp(sm.id, playing->id)) {
87 if((playing->state == playing_unplayed
88 || playing->state == playing_started)
89 && sm.type == SM_FINISHED)
90 playing->state = playing_ok;
2b2a5fed 91 finished(ev);
f3102c22 92 }
2b2a5fed 93 break;
460b9539 94 case SM_PLAYING:
95 /* track ID is playing, DATA seconds played */
96 D(("SM_PLAYING %s %ld", sm.id, sm.data));
97 playing->sofar = sm.data;
98 break;
2a1c84fb
RK
99 case SM_ARRIVED: {
100 /* track ID is now prepared */
101 struct queue_entry *q;
102 for(q = qhead.next; q != &qhead && strcmp(q->id, sm.id); q = q->next)
103 ;
104 if(q && q->preparing) {
105 q->preparing = 0;
106 q->prepared = 1;
107 /* We might be waiting to play the now-prepared track */
108 play(ev);
109 }
110 break;
111 }
460b9539 112 default:
2e9ba080 113 disorder_error(0, "unknown speaker message type %d", sm.type);
460b9539 114 }
115 return 0;
116}
117
16fb2830 118/** @brief Initialize the speaker process */
460b9539 119void speaker_setup(ev_source *ev) {
4387f694 120 int sp[2];
460b9539 121 pid_t pid;
937be4c0 122 struct speaker_message sm;
460b9539 123
124 if(socketpair(PF_UNIX, SOCK_DGRAM, 0, sp) < 0)
2e9ba080 125 disorder_fatal(errno, "error calling socketpair");
460b9539 126 if(!(pid = xfork())) {
127 exitfn = _exit;
128 ev_signal_atfork(ev);
129 xdup2(sp[0], 0);
130 xdup2(sp[0], 1);
131 xclose(sp[0]);
132 xclose(sp[1]);
460b9539 133 signal(SIGPIPE, SIG_DFL);
134#if 0
135 execlp("valgrind", "valgrind", SPEAKER, "--config", configfile,
0ca6d097
RK
136 debugging ? "--debug" : "--no-debug",
137 log_default == &log_syslog ? "--syslog" : "--no-syslog",
138 (char *)0);
460b9539 139#else
140 execlp(SPEAKER, SPEAKER, "--config", configfile,
0ca6d097
RK
141 debugging ? "--debug" : "--no-debug",
142 log_default == &log_syslog ? "--syslog" : "--no-syslog",
143 (char *)0);
460b9539 144#endif
2e9ba080 145 disorder_fatal(errno, "error invoking %s", SPEAKER);
460b9539 146 }
147 ev_child(ev, pid, 0, speaker_terminated, 0);
148 speaker_fd = sp[1];
149 xclose(sp[0]);
150 cloexec(speaker_fd);
937be4c0
RK
151 /* Wait for the speaker to be ready */
152 speaker_recv(speaker_fd, &sm);
153 nonblock(speaker_fd);
31e2a93e 154 if(ev_fd(ev, ev_read, speaker_fd, speaker_readable, 0, "speaker read") < 0)
2e9ba080 155 disorder_fatal(0, "error registering speaker socket fd");
460b9539 156}
157
16fb2830 158/** @brief Tell the speaker to reload its configuration */
460b9539 159void speaker_reload(void) {
160 struct speaker_message sm;
161
162 memset(&sm, 0, sizeof sm);
163 sm.type = SM_RELOAD;
84aa9f93 164 speaker_send(speaker_fd, &sm);
460b9539 165}
166
5bac5b78
RK
167/* Track termination -------------------------------------------------------- */
168
16fb2830
RK
169/** @brief Called when the currently playing track finishes playing
170 * @param ev Event loop or NULL
171 *
172 * There are three places this is called from:
173 *
174 * 1) speaker_readable(), when the speaker tells us the playing track finished.
175 * (Technically the speaker lies a little to arrange for gapless play.)
176 *
177 * 2) player_finished(), when the player for a non-raw track (i.e. one that
178 * does not use the speaker) finishes.
179 *
180 * 3) quitting(), after signalling the decoder or player but possible before it
181 * has actually terminated. In this case @p ev is NULL, inhibiting any further
182 * attempt to play anything.
183 */
460b9539 184static void finished(ev_source *ev) {
185 D(("finished playing=%p", (void *)playing));
186 if(!playing)
187 return;
188 if(playing->state != playing_scratched)
189 notify_not_scratched(playing->track, playing->submitter);
190 switch(playing->state) {
191 case playing_ok:
192 eventlog("completed", playing->track, (char *)0);
193 break;
194 case playing_scratched:
195 eventlog("scratched", playing->track, playing->scratched, (char *)0);
196 break;
197 case playing_failed:
198 eventlog("failed", playing->track, wstat(playing->wstat), (char *)0);
199 break;
200 default:
201 break;
202 }
203 queue_played(playing);
204 recent_write();
460b9539 205 playing = 0;
49a773eb 206 /* Try to play something else */
49a773eb
RK
207 if(ev)
208 play(ev);
460b9539 209}
210
16fb2830
RK
211/** @brief Called when a player or decoder process terminates
212 *
213 * This is called when a decoder process terminates (which might actually be
214 * some time before the speaker reports it as finished) or when a non-raw
215 * (i.e. non-speaker) player terminates. In the latter case it's imaginable
216 * that the OS has buffered the last few samples.
4857234e
RK
217 *
218 * NB. The finished track might NOT be in the queue (yet) - it might be a
219 * pre-chosen scratch.
16fb2830 220 */
460b9539 221static int player_finished(ev_source *ev,
222 pid_t pid,
223 int status,
224 const struct rusage attribute((unused)) *rusage,
225 void *u) {
226 struct queue_entry *q = u;
227
228 D(("player_finished pid=%lu status=%#x",
229 (unsigned long)pid, (unsigned)status));
230 /* Record that this PID is dead. If we killed the track we might know this
231 * already, but also it might have exited or crashed. Either way we don't
232 * want to end up signalling it. */
90b8faa5 233 q->pid = -1;
460b9539 234 switch(q->state) {
235 case playing_unplayed:
236 case playing_random:
84aa9f93 237 /* If this was a pre-prepared track then either it failed or we
16fb2830
RK
238 * deliberately stopped it: it might have been removed from the queue, or
239 * moved down the queue, or the speaker might be on a break. So we leave
240 * it state alone for future use.
241 */
460b9539 242 break;
243 default:
244 /* We actually started playing this track. */
245 if(status) {
16fb2830 246 /* Don't override 'scratched' with 'failed'. */
460b9539 247 if(q->state != playing_scratched)
248 q->state = playing_failed;
249 } else
250 q->state = playing_ok;
251 break;
252 }
0c1d42ad
RK
253 /* Report the status unless we killed it */
254 if(status) {
255 if(!(q->killed && WIFSIGNALED(status) && WTERMSIG(status) == q->killed))
256 disorder_error(0, "player for %s %s", q->track, wstat(status));
257 }
258 /* Clean up any prefork calls */
460b9539 259 if(q->type & DISORDER_PLAYER_PREFORK)
260 play_cleanup(q->pl, q->data);
261 q->wstat = status;
262 /* If this actually was the current track, and does not use the speaker
263 * process, then it must have finished. For raw-output players we will get a
264 * separate notification from the speaker process. */
265 if(q == playing
266 && (q->type & DISORDER_PLAYER_TYPEMASK) != DISORDER_PLAYER_RAW)
267 finished(ev);
268 return 0;
269}
270
5bac5b78
RK
271/* Track initiation --------------------------------------------------------- */
272
16fb2830 273/** @brief Find the player for @p q */
5bac5b78 274static const struct stringlist *find_player(const struct queue_entry *q) {
460b9539 275 int n;
276
277 for(n = 0; n < config->player.n; ++n)
278 if(fnmatch(config->player.s[n].s[0], q->track, 0) == 0)
279 break;
280 if(n >= config->player.n)
5bac5b78 281 return NULL;
460b9539 282 else
5bac5b78 283 return &config->player.s[n];
460b9539 284}
285
5bac5b78 286/** @brief Start to play @p q
84aa9f93
RK
287 * @param ev Event loop
288 * @param q Track to play/prepare
3149c1e2 289 * @return @ref START_OK, @ref START_HARDFAIL or @ref START_SOFTFAIL
16fb2830 290 *
5bac5b78 291 * This makes @p actually start playing. It calls prepare() if necessary and
c0f52b2c 292 * either sends an @ref SM_PLAY command or invokes the player itself in a
5bac5b78 293 * subprocess.
16fb2830 294 *
5bac5b78
RK
295 * It's up to the caller to set @ref playing and @c playing->state (this might
296 * be changed in the future).
84aa9f93 297 */
460b9539 298static int start(ev_source *ev,
5bac5b78
RK
299 struct queue_entry *q) {
300 const struct stringlist *player;
301 int rc;
460b9539 302
5bac5b78 303 D(("start %s", q->id));
460b9539 304 /* Find the player plugin. */
8141805c 305 if(!(player = find_player(q)))
5bac5b78
RK
306 return START_HARDFAIL; /* No player */
307 if(!(q->pl = open_plugin(player->s[1], 0)))
460b9539 308 return START_HARDFAIL;
309 q->type = play_get_type(q->pl);
5bac5b78
RK
310 /* Special handling for raw-format players */
311 if((q->type & DISORDER_PLAYER_TYPEMASK) == DISORDER_PLAYER_RAW) {
312 /* Make sure that the track is prepared */
313 if((rc = prepare(ev, q)))
314 return rc;
315 /* Now we're sure it's prepared, start it playing */
316 /* TODO actually it might not be fully prepared yet - it's all happening in
317 * a subprocess. See speaker.c for further discussion. */
318 struct speaker_message sm[1];
319 memset(sm, 0, sizeof sm);
320 strcpy(sm->id, q->id);
321 sm->type = SM_PLAY;
322 speaker_send(speaker_fd, sm);
323 D(("sent SM_PLAY for %s", sm->id));
324 /* Our caller will set playing and playing->state = playing_started */
460b9539 325 return START_OK;
5bac5b78
RK
326 } else {
327 rc = play_background(ev, player, q, start_child, NULL);
328 if(rc == START_OK)
329 ev_child(ev, q->pid, 0, player_finished, q);
330 /* Our caller will set playing and playing->state = playing_started */
331 return rc;
460b9539 332 }
5bac5b78
RK
333}
334
6ac9a215
RK
335/** @brief Child-process half of start()
336 * @return Process exit code
337 *
338 * Called in subprocess to execute non-raw-format players (via plugin).
339 */
5bac5b78
RK
340static int start_child(struct queue_entry *q,
341 const struct pbgc_params *params,
342 void attribute((unused)) *bgdata) {
5bac5b78
RK
343 /* Play the track */
344 play_track(q->pl,
345 params->argv, params->argc,
346 params->rawpath,
347 q->track);
348 return 0;
460b9539 349}
350
16fb2830 351/** @brief Prepare a track for later play
5bac5b78 352 * @return @ref START_OK, @ref START_HARDFAIL or @ref START_SOFTFAIL
16fb2830 353 *
6ac9a215
RK
354 * This can be called either when we want to play the track or slightly before
355 * so that some samples are decoded and available in a buffer.
356 *
5bac5b78
RK
357 * Only applies to raw-format (i.e. speaker-using) players; everything else
358 * gets @c START_OK.
16fb2830 359 */
460b9539 360int prepare(ev_source *ev,
361 struct queue_entry *q) {
5bac5b78 362 const struct stringlist *player;
460b9539 363
90b8faa5
RK
364 /* If there's a decoder (or player!) going we do nothing */
365 if(q->pid >= 0)
5bac5b78
RK
366 return START_OK;
367 /* If the track is already prepared, do nothing */
2a1c84fb 368 if(q->prepared || q->preparing)
5bac5b78 369 return START_OK;
460b9539 370 /* Find the player plugin */
8141805c 371 if(!(player = find_player(q)))
5bac5b78
RK
372 return START_HARDFAIL; /* No player */
373 q->pl = open_plugin(player->s[1], 0);
460b9539 374 q->type = play_get_type(q->pl);
375 if((q->type & DISORDER_PLAYER_TYPEMASK) != DISORDER_PLAYER_RAW)
5bac5b78 376 return START_OK; /* Not a raw player */
2a1c84fb 377 int rc = play_background(ev, player, q, prepare_child, NULL);
5bac5b78
RK
378 if(rc == START_OK) {
379 ev_child(ev, q->pid, 0, player_finished, q);
2a1c84fb
RK
380 q->preparing = 1;
381 /* Actually the track is still "in flight" */
382 rc = START_SOFTFAIL;
5bac5b78
RK
383 }
384 return rc;
385}
386
6ac9a215
RK
387/** @brief Child-process half of prepare()
388 * @return Process exit code
389 *
390 * Called in subprocess to execute the decoder for a raw-format player.
391 *
392 * @todo We currently run the normalizer from here in a double-fork. This is
393 * unsatisfactory for many reasons: we can't prevent it outliving the main
394 * server and we don't adequately report its exit status.
395 */
5bac5b78
RK
396static int prepare_child(struct queue_entry *q,
397 const struct pbgc_params *params,
398 void attribute((unused)) *bgdata) {
399 /* np will be the pipe to disorder-normalize */
400 int np[2];
401 if(socketpair(PF_UNIX, SOCK_STREAM, 0, np) < 0)
2e9ba080 402 disorder_fatal(errno, "error calling socketpair");
5bac5b78
RK
403 /* Beware of the Leopard! On OS X 10.5.x, the order of the shutdown
404 * calls here DOES MATTER. If you do the SHUT_WR first then the SHUT_RD
405 * fails with "Socket is not connected". I think this is a bug but
406 * provided implementors either don't care about the order or all agree
407 * about the order, choosing the reliable order is an adequate
408 * workaround. */
409 xshutdown(np[1], SHUT_RD); /* decoder writes to np[1] */
410 xshutdown(np[0], SHUT_WR); /* normalize reads from np[0] */
411 blocking(np[0]);
412 blocking(np[1]);
413 /* Start disorder-normalize. We double-fork so that nothing has to wait
414 * for disorder-normalize. */
415 pid_t npid;
416 if(!(npid = xfork())) {
417 /* Grandchild of disorderd */
418 if(!xfork()) {
419 /* Great-grandchild of disorderd */
420 /* Connect to the speaker process */
421 struct sockaddr_un addr;
422 memset(&addr, 0, sizeof addr);
423 addr.sun_family = AF_UNIX;
424 snprintf(addr.sun_path, sizeof addr.sun_path,
425 "%s/speaker/socket", config->home);
426 int sfd = xsocket(PF_UNIX, SOCK_STREAM, 0);
427 if(connect(sfd, (const struct sockaddr *)&addr, sizeof addr) < 0)
2e9ba080 428 disorder_fatal(errno, "connecting to %s", addr.sun_path);
5bac5b78
RK
429 /* Send the ID, with a NATIVE-ENDIAN 32 bit length */
430 uint32_t l = strlen(q->id);
431 if(write(sfd, &l, sizeof l) < 0
432 || write(sfd, q->id, l) < 0)
2e9ba080 433 disorder_fatal(errno, "writing to %s", addr.sun_path);
5bac5b78
RK
434 /* Await the ack */
435 if (read(sfd, &l, 1) < 0)
2e9ba080 436 disorder_fatal(errno, "reading ack from %s", addr.sun_path);
5bac5b78
RK
437 /* Plumbing */
438 xdup2(np[0], 0);
439 xdup2(sfd, 1);
440 xclose(np[0]);
441 xclose(np[1]);
442 xclose(sfd);
443 /* TODO stderr shouldn't be redirected for disorder-normalize
444 * (but it should be for play_track() */
445 execlp("disorder-normalize", "disorder-normalize",
446 log_default == &log_syslog ? "--syslog" : "--no-syslog",
447 "--config", configfile,
448 (char *)0);
2e9ba080 449 disorder_fatal(errno, "executing disorder-normalize");
5bac5b78
RK
450 /* End of the great-grandchild of disorderd */
451 }
452 /* Back in the grandchild of disorderd */
453 _exit(0);
454 /* End of the grandchild of disorderd */
455 }
456 /* Back in the child of disorderd */
457 /* Wait for the grandchild of disordered to finish */
458 int n;
459 while(waitpid(npid, &n, 0) < 0 && errno == EINTR)
460 ;
461 /* Pass the file descriptor to the driver in an environment
462 * variable. */
463 char buffer[64];
464 snprintf(buffer, sizeof buffer, "DISORDER_RAW_FD=%d", np[1]);
465 if(putenv(buffer) < 0)
2e9ba080 466 disorder_fatal(errno, "error calling putenv");
5bac5b78
RK
467 /* Close all the FDs we don't need */
468 xclose(np[0]);
469 /* Start the decoder itself */
470 play_track(q->pl,
471 params->argv, params->argc,
472 params->rawpath,
473 q->track);
474 return 0;
460b9539 475}
476
0c1d42ad
RK
477/** @brief Kill a player
478 * @param q Queue entry corresponding to player
479 */
480static void kill_player(struct queue_entry *q) {
481 if(q->pid >= 0)
482 kill(-q->pid, config->signal);
483 q->killed = config->signal;
484}
485
16fb2830
RK
486/** @brief Abandon a queue entry
487 *
488 * Called from c_remove() (but NOT when scratching a track). Only does
489 * anything to raw-format tracks. Terminates the background decoder and tells
490 * the speaker process to cancel the track.
491 */
460b9539 492void abandon(ev_source attribute((unused)) *ev,
493 struct queue_entry *q) {
494 struct speaker_message sm;
460b9539 495
90b8faa5
RK
496 if(q->pid < 0)
497 return; /* Not prepared. */
460b9539 498 if((q->type & DISORDER_PLAYER_TYPEMASK) != DISORDER_PLAYER_RAW)
499 return; /* Not a raw player. */
500 /* Terminate the player. */
0c1d42ad 501 kill_player(q);
460b9539 502 /* Cancel the track. */
503 memset(&sm, 0, sizeof sm);
504 sm.type = SM_CANCEL;
505 strcpy(sm.id, q->id);
84aa9f93 506 speaker_send(speaker_fd, &sm);
460b9539 507}
508
5bac5b78
RK
509/* Random tracks ------------------------------------------------------------ */
510
49a773eb 511/** @brief Called with a new random track
59cf25c4 512 * @param ev Event loop
49a773eb
RK
513 * @param track Track name
514 */
515static void chosen_random_track(ev_source *ev,
516 const char *track) {
517 struct queue_entry *q;
518
519 if(!track)
520 return;
521 /* Add the track to the queue */
7a853280 522 q = queue_add(track, 0, WHERE_END, NULL, origin_random);
49a773eb
RK
523 D(("picked %p (%s) at random", (void *)q, q->track));
524 queue_write();
525 /* Maybe a track can now be played */
526 play(ev);
527}
528
529/** @brief Maybe add a randomly chosen track
530 * @param ev Event loop
16fb2830
RK
531 *
532 * Picking can take some time so the track will only be added after this
533 * function has returned.
49a773eb
RK
534 */
535void add_random_track(ev_source *ev) {
460b9539 536 struct queue_entry *q;
459d4402 537 long qlen = 0;
460b9539 538
539 /* If random play is not enabled then do nothing. */
540 if(shutting_down || !random_is_enabled())
49a773eb 541 return;
459d4402 542 /* Count how big the queue is */
460b9539 543 for(q = qhead.next; q != &qhead; q = q->next)
459d4402 544 ++qlen;
49a773eb
RK
545 /* If it's smaller than the desired size then add a track */
546 if(qlen < config->queue_pad)
547 trackdb_request_random(ev, chosen_random_track);
460b9539 548}
549
5bac5b78
RK
550/* Track initiation (part 2) ------------------------------------------------ */
551
16fb2830
RK
552/** @brief Attempt to play something
553 *
554 * This is called from numerous locations - whenever it might conceivably have
555 * become possible to play something.
556 */
460b9539 557void play(ev_source *ev) {
558 struct queue_entry *q;
559 int random_enabled = random_is_enabled();
560
561 D(("play playing=%p", (void *)playing));
16fb2830
RK
562 /* If we're shutting down, or there's something playing, or playing is not
563 * enabled, give up now */
460b9539 564 if(shutting_down || playing || !playing_is_enabled()) return;
49a773eb 565 /* See if there's anything to play */
460b9539 566 if(qhead.next == &qhead) {
49a773eb
RK
567 /* Queue is empty. We could just wait around since there are periodic
568 * attempts to add a random track anyway. However they are rarer than
569 * attempts to force a track so we initiate one now. */
570 add_random_track(ev);
16fb2830
RK
571 /* chosen_random_track() will call play() when a new random track has been
572 * added to the queue. */
49a773eb 573 return;
460b9539 574 }
49a773eb 575 /* There must be at least one track in the queue. */
460b9539 576 q = qhead.next;
2dc2f478
RK
577 /* If random play is disabled but the track is a non-adopted random one
578 * then don't play it. play() will be called again when random play is
579 * re-enabled. */
580 if(!random_enabled && q->origin == origin_random)
460b9539 581 return;
582 D(("taken %p (%s) from queue", (void *)q, q->track));
583 /* Try to start playing. */
5bac5b78 584 switch(start(ev, q)) {
460b9539 585 case START_HARDFAIL:
586 if(q == qhead.next) {
587 queue_remove(q, 0); /* Abandon this track. */
588 queue_played(q);
589 recent_write();
590 }
49a773eb
RK
591 /* Oh well, try the next one */
592 play(ev);
460b9539 593 break;
594 case START_SOFTFAIL:
49a773eb 595 /* We'll try the same track again shortly. */
460b9539 596 break;
597 case START_OK:
16fb2830 598 /* Remove from the queue */
460b9539 599 if(q == qhead.next) {
600 queue_remove(q, 0);
601 queue_write();
602 }
16fb2830 603 /* It's become the playing track */
460b9539 604 playing = q;
4265e5d3 605 xtime(&playing->played);
460b9539 606 playing->state = playing_started;
607 notify_play(playing->track, playing->submitter);
608 eventlog("playing", playing->track,
609 playing->submitter ? playing->submitter : (const char *)0,
610 (const char *)0);
611 /* Maybe add a random track. */
49a773eb 612 add_random_track(ev);
460b9539 613 /* If there is another track in the queue prepare it now. This could
614 * potentially be a just-added random track. */
615 if(qhead.next != &qhead)
616 prepare(ev, qhead.next);
4857234e
RK
617 /* Make sure there is a prepared scratch */
618 ensure_next_scratch(ev);
460b9539 619 break;
620 }
621}
622
5bac5b78
RK
623/* Miscelleneous ------------------------------------------------------------ */
624
9439cdab
RK
625int flag_enabled(const char *s) {
626 return !s || !strcmp(s, "yes");
627}
628
16fb2830 629/** @brief Return true if play is enabled */
460b9539 630int playing_is_enabled(void) {
9439cdab 631 return flag_enabled(trackdb_get_global("playing"));
460b9539 632}
633
16fb2830 634/** @brief Enable play */
460b9539 635void enable_playing(const char *who, ev_source *ev) {
636 trackdb_set_global("playing", "yes", who);
637 /* Add a random track if necessary. */
49a773eb 638 add_random_track(ev);
460b9539 639 play(ev);
640}
641
16fb2830 642/** @brief Disable play */
9439cdab 643void disable_playing(const char *who, ev_source attribute((unused)) *ev) {
460b9539 644 trackdb_set_global("playing", "no", who);
645}
646
16fb2830 647/** @brief Return true if random play is enabled */
460b9539 648int random_is_enabled(void) {
9439cdab 649 return flag_enabled(trackdb_get_global("random-play"));
460b9539 650}
651
16fb2830 652/** @brief Enable random play */
460b9539 653void enable_random(const char *who, ev_source *ev) {
654 trackdb_set_global("random-play", "yes", who);
49a773eb 655 add_random_track(ev);
460b9539 656 play(ev);
657}
658
16fb2830 659/** @brief Disable random play */
9439cdab 660void disable_random(const char *who, ev_source attribute((unused)) *ev) {
460b9539 661 trackdb_set_global("random-play", "no", who);
662}
663
5bac5b78
RK
664/* Scratching --------------------------------------------------------------- */
665
4857234e
RK
666/** @brief Track to play next time something is scratched */
667static struct queue_entry *next_scratch;
668
669/** @brief Ensure there isa prepared scratch */
670static void ensure_next_scratch(ev_source *ev) {
671 if(next_scratch) /* There's one already */
672 return;
673 if(!config->scratch.n) /* There are no scratches */
674 return;
675 int r = rand() * (double)config->scratch.n / (RAND_MAX + 1.0);
676 next_scratch = queue_add(config->scratch.s[r], NULL,
677 WHERE_NOWHERE, NULL, origin_scratch);
678 if(ev)
679 prepare(ev, next_scratch);
680}
681
16fb2830 682/** @brief Scratch a track
c0f52b2c
RK
683 * @param who User responsible (or NULL)
684 * @param id Track ID (or NULL for current)
16fb2830 685 */
460b9539 686void scratch(const char *who, const char *id) {
460b9539 687 struct speaker_message sm;
460b9539 688
689 D(("scratch playing=%p state=%d id=%s playing->id=%s",
690 (void *)playing,
691 playing ? playing->state : 0,
692 id ? id : "(none)",
693 playing ? playing->id : "(none)"));
16fb2830
RK
694 /* There must be a playing track; it must be in a scratchable state; if a
695 * specific ID was mentioned it must be that track. */
460b9539 696 if(playing
697 && (playing->state == playing_started
698 || playing->state == playing_paused)
699 && (!id
700 || !strcmp(id, playing->id))) {
16fb2830 701 /* Update state (for the benefit of the 'recent' list) */
460b9539 702 playing->state = playing_scratched;
703 playing->scratched = who ? xstrdup(who) : 0;
16fb2830 704 /* Find the player and kill the whole process group */
0c1d42ad
RK
705 if(playing->pid >= 0)
706 kill_player(playing);
16fb2830 707 /* Tell the speaker, if we think it'll care */
460b9539 708 if((playing->type & DISORDER_PLAYER_TYPEMASK) == DISORDER_PLAYER_RAW) {
709 memset(&sm, 0, sizeof sm);
710 sm.type = SM_CANCEL;
711 strcpy(sm.id, playing->id);
84aa9f93 712 speaker_send(speaker_fd, &sm);
460b9539 713 D(("sending SM_CANCEL for %s", playing->id));
714 }
62416f14
RK
715 /* If playing is enabled then add a scratch to the queue. Having a scratch
716 * appear in the queue when further play is disabled is weird and
717 * contradicts implicit assumptions made elsewhere, so we try to avoid
718 * it. */
719 if(playing_is_enabled()) {
720 /* Try to make sure there is a scratch */
721 ensure_next_scratch(NULL);
722 /* Insert it at the head of the queue */
723 if(next_scratch){
724 next_scratch->submitter = who;
725 queue_insert_entry(&qhead, next_scratch);
726 eventlog_raw("queue", queue_marshall(next_scratch), (const char *)0);
727 next_scratch = NULL;
728 }
460b9539 729 }
730 notify_scratch(playing->track, playing->submitter, who,
4265e5d3 731 xtime(0) - playing->played);
460b9539 732 }
733}
734
5bac5b78
RK
735/* Server termination ------------------------------------------------------- */
736
737/** @brief Called from quit() to tear down everything belonging to this file */
460b9539 738void quitting(ev_source *ev) {
739 struct queue_entry *q;
460b9539 740
741 /* Don't start anything new */
742 shutting_down = 1;
743 /* Shut down the current player */
744 if(playing) {
0c1d42ad 745 kill_player(playing);
460b9539 746 playing->state = playing_quitting;
747 finished(0);
748 }
90b8faa5 749 /* Zap any background decoders that are going */
460b9539 750 for(q = qhead.next; q != &qhead; q = q->next)
0c1d42ad 751 kill_player(q);
460b9539 752 /* Don't need the speaker any more */
753 ev_fd_cancel(ev, ev_read, speaker_fd);
754 xclose(speaker_fd);
755}
756
5bac5b78
RK
757/* Pause and resume --------------------------------------------------------- */
758
16fb2830 759/** @brief Pause the playing track */
460b9539 760int pause_playing(const char *who) {
761 struct speaker_message sm;
762 long played;
763
764 /* Can't pause if already paused or if nothing playing. */
765 if(!playing || paused) return 0;
766 switch(playing->type & DISORDER_PLAYER_TYPEMASK) {
767 case DISORDER_PLAYER_STANDALONE:
768 if(!(playing->type & DISORDER_PLAYER_PAUSES)) {
769 default:
2e9ba080 770 disorder_error(0, "cannot pause because player is not powerful enough");
460b9539 771 return -1;
772 }
773 if(play_pause(playing->pl, &played, playing->data)) {
2e9ba080 774 disorder_error(0, "player indicates it cannot pause");
460b9539 775 return -1;
776 }
4265e5d3 777 xtime(&playing->lastpaused);
460b9539 778 playing->uptopause = played;
779 playing->lastresumed = 0;
780 break;
781 case DISORDER_PLAYER_RAW:
782 memset(&sm, 0, sizeof sm);
783 sm.type = SM_PAUSE;
84aa9f93 784 speaker_send(speaker_fd, &sm);
460b9539 785 break;
786 }
2e9ba080
RK
787 if(who)
788 disorder_info("paused by %s", who);
460b9539 789 notify_pause(playing->track, who);
790 paused = 1;
791 if(playing->state == playing_started)
792 playing->state = playing_paused;
793 eventlog("state", "pause", (char *)0);
794 return 0;
795}
796
16fb2830 797/** @brief Resume playing after a pause */
460b9539 798void resume_playing(const char *who) {
799 struct speaker_message sm;
800
801 if(!paused) return;
802 paused = 0;
803 if(!playing) return;
804 switch(playing->type & DISORDER_PLAYER_TYPEMASK) {
805 case DISORDER_PLAYER_STANDALONE:
c458dd3d 806 if(!(playing->type & DISORDER_PLAYER_PAUSES)) {
460b9539 807 default:
808 /* Shouldn't happen */
809 return;
810 }
811 play_resume(playing->pl, playing->data);
4265e5d3 812 xtime(&playing->lastresumed);
460b9539 813 break;
814 case DISORDER_PLAYER_RAW:
815 memset(&sm, 0, sizeof sm);
816 sm.type = SM_RESUME;
84aa9f93 817 speaker_send(speaker_fd, &sm);
460b9539 818 break;
819 }
2e9ba080 820 if(who) disorder_info("resumed by %s", who);
460b9539 821 notify_resume(playing->track, who);
822 if(playing->state == playing_paused)
823 playing->state = playing_started;
824 eventlog("state", "resume", (char *)0);
825}
826
827/*
828Local Variables:
829c-basic-offset:2
830comment-column:40
831fill-column:79
16fb2830 832indent-tabs-mode:nil
460b9539 833End:
834*/