chiark / gitweb /
server: docs: remove deprecated configuration and user upgrade.
[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 }
253 /* Regardless we always report and record the status and do cleanup for
254 * prefork calls. */
255 if(status)
2e9ba080 256 disorder_error(0, "player for %s %s", q->track, wstat(status));
460b9539 257 if(q->type & DISORDER_PLAYER_PREFORK)
258 play_cleanup(q->pl, q->data);
259 q->wstat = status;
260 /* If this actually was the current track, and does not use the speaker
261 * process, then it must have finished. For raw-output players we will get a
262 * separate notification from the speaker process. */
263 if(q == playing
264 && (q->type & DISORDER_PLAYER_TYPEMASK) != DISORDER_PLAYER_RAW)
265 finished(ev);
266 return 0;
267}
268
5bac5b78
RK
269/* Track initiation --------------------------------------------------------- */
270
16fb2830 271/** @brief Find the player for @p q */
5bac5b78 272static const struct stringlist *find_player(const struct queue_entry *q) {
460b9539 273 int n;
274
275 for(n = 0; n < config->player.n; ++n)
276 if(fnmatch(config->player.s[n].s[0], q->track, 0) == 0)
277 break;
278 if(n >= config->player.n)
5bac5b78 279 return NULL;
460b9539 280 else
5bac5b78 281 return &config->player.s[n];
460b9539 282}
283
5bac5b78 284/** @brief Start to play @p q
84aa9f93
RK
285 * @param ev Event loop
286 * @param q Track to play/prepare
3149c1e2 287 * @return @ref START_OK, @ref START_HARDFAIL or @ref START_SOFTFAIL
16fb2830 288 *
5bac5b78 289 * This makes @p actually start playing. It calls prepare() if necessary and
c0f52b2c 290 * either sends an @ref SM_PLAY command or invokes the player itself in a
5bac5b78 291 * subprocess.
16fb2830 292 *
5bac5b78
RK
293 * It's up to the caller to set @ref playing and @c playing->state (this might
294 * be changed in the future).
84aa9f93 295 */
460b9539 296static int start(ev_source *ev,
5bac5b78
RK
297 struct queue_entry *q) {
298 const struct stringlist *player;
299 int rc;
460b9539 300
5bac5b78 301 D(("start %s", q->id));
460b9539 302 /* Find the player plugin. */
8141805c 303 if(!(player = find_player(q)))
5bac5b78
RK
304 return START_HARDFAIL; /* No player */
305 if(!(q->pl = open_plugin(player->s[1], 0)))
460b9539 306 return START_HARDFAIL;
307 q->type = play_get_type(q->pl);
5bac5b78
RK
308 /* Special handling for raw-format players */
309 if((q->type & DISORDER_PLAYER_TYPEMASK) == DISORDER_PLAYER_RAW) {
310 /* Make sure that the track is prepared */
311 if((rc = prepare(ev, q)))
312 return rc;
313 /* Now we're sure it's prepared, start it playing */
314 /* TODO actually it might not be fully prepared yet - it's all happening in
315 * a subprocess. See speaker.c for further discussion. */
316 struct speaker_message sm[1];
317 memset(sm, 0, sizeof sm);
318 strcpy(sm->id, q->id);
319 sm->type = SM_PLAY;
320 speaker_send(speaker_fd, sm);
321 D(("sent SM_PLAY for %s", sm->id));
322 /* Our caller will set playing and playing->state = playing_started */
460b9539 323 return START_OK;
5bac5b78
RK
324 } else {
325 rc = play_background(ev, player, q, start_child, NULL);
326 if(rc == START_OK)
327 ev_child(ev, q->pid, 0, player_finished, q);
328 /* Our caller will set playing and playing->state = playing_started */
329 return rc;
460b9539 330 }
5bac5b78
RK
331}
332
6ac9a215
RK
333/** @brief Child-process half of start()
334 * @return Process exit code
335 *
336 * Called in subprocess to execute non-raw-format players (via plugin).
337 */
5bac5b78
RK
338static int start_child(struct queue_entry *q,
339 const struct pbgc_params *params,
340 void attribute((unused)) *bgdata) {
341 int n;
342
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
16fb2830
RK
477/** @brief Abandon a queue entry
478 *
479 * Called from c_remove() (but NOT when scratching a track). Only does
480 * anything to raw-format tracks. Terminates the background decoder and tells
481 * the speaker process to cancel the track.
482 */
460b9539 483void abandon(ev_source attribute((unused)) *ev,
484 struct queue_entry *q) {
485 struct speaker_message sm;
460b9539 486
90b8faa5
RK
487 if(q->pid < 0)
488 return; /* Not prepared. */
460b9539 489 if((q->type & DISORDER_PLAYER_TYPEMASK) != DISORDER_PLAYER_RAW)
490 return; /* Not a raw player. */
491 /* Terminate the player. */
90b8faa5 492 kill(-q->pid, config->signal);
460b9539 493 /* Cancel the track. */
494 memset(&sm, 0, sizeof sm);
495 sm.type = SM_CANCEL;
496 strcpy(sm.id, q->id);
84aa9f93 497 speaker_send(speaker_fd, &sm);
460b9539 498}
499
5bac5b78
RK
500/* Random tracks ------------------------------------------------------------ */
501
49a773eb 502/** @brief Called with a new random track
59cf25c4 503 * @param ev Event loop
49a773eb
RK
504 * @param track Track name
505 */
506static void chosen_random_track(ev_source *ev,
507 const char *track) {
508 struct queue_entry *q;
509
510 if(!track)
511 return;
512 /* Add the track to the queue */
7a853280 513 q = queue_add(track, 0, WHERE_END, NULL, origin_random);
49a773eb
RK
514 D(("picked %p (%s) at random", (void *)q, q->track));
515 queue_write();
516 /* Maybe a track can now be played */
517 play(ev);
518}
519
520/** @brief Maybe add a randomly chosen track
521 * @param ev Event loop
16fb2830
RK
522 *
523 * Picking can take some time so the track will only be added after this
524 * function has returned.
49a773eb
RK
525 */
526void add_random_track(ev_source *ev) {
460b9539 527 struct queue_entry *q;
459d4402 528 long qlen = 0;
460b9539 529
530 /* If random play is not enabled then do nothing. */
531 if(shutting_down || !random_is_enabled())
49a773eb 532 return;
459d4402 533 /* Count how big the queue is */
460b9539 534 for(q = qhead.next; q != &qhead; q = q->next)
459d4402 535 ++qlen;
49a773eb
RK
536 /* If it's smaller than the desired size then add a track */
537 if(qlen < config->queue_pad)
538 trackdb_request_random(ev, chosen_random_track);
460b9539 539}
540
5bac5b78
RK
541/* Track initiation (part 2) ------------------------------------------------ */
542
16fb2830
RK
543/** @brief Attempt to play something
544 *
545 * This is called from numerous locations - whenever it might conceivably have
546 * become possible to play something.
547 */
460b9539 548void play(ev_source *ev) {
549 struct queue_entry *q;
550 int random_enabled = random_is_enabled();
551
552 D(("play playing=%p", (void *)playing));
16fb2830
RK
553 /* If we're shutting down, or there's something playing, or playing is not
554 * enabled, give up now */
460b9539 555 if(shutting_down || playing || !playing_is_enabled()) return;
49a773eb 556 /* See if there's anything to play */
460b9539 557 if(qhead.next == &qhead) {
49a773eb
RK
558 /* Queue is empty. We could just wait around since there are periodic
559 * attempts to add a random track anyway. However they are rarer than
560 * attempts to force a track so we initiate one now. */
561 add_random_track(ev);
16fb2830
RK
562 /* chosen_random_track() will call play() when a new random track has been
563 * added to the queue. */
49a773eb 564 return;
460b9539 565 }
49a773eb 566 /* There must be at least one track in the queue. */
460b9539 567 q = qhead.next;
2dc2f478
RK
568 /* If random play is disabled but the track is a non-adopted random one
569 * then don't play it. play() will be called again when random play is
570 * re-enabled. */
571 if(!random_enabled && q->origin == origin_random)
460b9539 572 return;
573 D(("taken %p (%s) from queue", (void *)q, q->track));
574 /* Try to start playing. */
5bac5b78 575 switch(start(ev, q)) {
460b9539 576 case START_HARDFAIL:
577 if(q == qhead.next) {
578 queue_remove(q, 0); /* Abandon this track. */
579 queue_played(q);
580 recent_write();
581 }
49a773eb
RK
582 /* Oh well, try the next one */
583 play(ev);
460b9539 584 break;
585 case START_SOFTFAIL:
49a773eb 586 /* We'll try the same track again shortly. */
460b9539 587 break;
588 case START_OK:
16fb2830 589 /* Remove from the queue */
460b9539 590 if(q == qhead.next) {
591 queue_remove(q, 0);
592 queue_write();
593 }
16fb2830 594 /* It's become the playing track */
460b9539 595 playing = q;
4265e5d3 596 xtime(&playing->played);
460b9539 597 playing->state = playing_started;
598 notify_play(playing->track, playing->submitter);
599 eventlog("playing", playing->track,
600 playing->submitter ? playing->submitter : (const char *)0,
601 (const char *)0);
602 /* Maybe add a random track. */
49a773eb 603 add_random_track(ev);
460b9539 604 /* If there is another track in the queue prepare it now. This could
605 * potentially be a just-added random track. */
606 if(qhead.next != &qhead)
607 prepare(ev, qhead.next);
4857234e
RK
608 /* Make sure there is a prepared scratch */
609 ensure_next_scratch(ev);
460b9539 610 break;
611 }
612}
613
5bac5b78
RK
614/* Miscelleneous ------------------------------------------------------------ */
615
9439cdab
RK
616int flag_enabled(const char *s) {
617 return !s || !strcmp(s, "yes");
618}
619
16fb2830 620/** @brief Return true if play is enabled */
460b9539 621int playing_is_enabled(void) {
9439cdab 622 return flag_enabled(trackdb_get_global("playing"));
460b9539 623}
624
16fb2830 625/** @brief Enable play */
460b9539 626void enable_playing(const char *who, ev_source *ev) {
627 trackdb_set_global("playing", "yes", who);
628 /* Add a random track if necessary. */
49a773eb 629 add_random_track(ev);
460b9539 630 play(ev);
631}
632
16fb2830 633/** @brief Disable play */
9439cdab 634void disable_playing(const char *who, ev_source attribute((unused)) *ev) {
460b9539 635 trackdb_set_global("playing", "no", who);
636}
637
16fb2830 638/** @brief Return true if random play is enabled */
460b9539 639int random_is_enabled(void) {
9439cdab 640 return flag_enabled(trackdb_get_global("random-play"));
460b9539 641}
642
16fb2830 643/** @brief Enable random play */
460b9539 644void enable_random(const char *who, ev_source *ev) {
645 trackdb_set_global("random-play", "yes", who);
49a773eb 646 add_random_track(ev);
460b9539 647 play(ev);
648}
649
16fb2830 650/** @brief Disable random play */
9439cdab 651void disable_random(const char *who, ev_source attribute((unused)) *ev) {
460b9539 652 trackdb_set_global("random-play", "no", who);
653}
654
5bac5b78
RK
655/* Scratching --------------------------------------------------------------- */
656
4857234e
RK
657/** @brief Track to play next time something is scratched */
658static struct queue_entry *next_scratch;
659
660/** @brief Ensure there isa prepared scratch */
661static void ensure_next_scratch(ev_source *ev) {
662 if(next_scratch) /* There's one already */
663 return;
664 if(!config->scratch.n) /* There are no scratches */
665 return;
666 int r = rand() * (double)config->scratch.n / (RAND_MAX + 1.0);
667 next_scratch = queue_add(config->scratch.s[r], NULL,
668 WHERE_NOWHERE, NULL, origin_scratch);
669 if(ev)
670 prepare(ev, next_scratch);
671}
672
16fb2830 673/** @brief Scratch a track
c0f52b2c
RK
674 * @param who User responsible (or NULL)
675 * @param id Track ID (or NULL for current)
16fb2830 676 */
460b9539 677void scratch(const char *who, const char *id) {
460b9539 678 struct speaker_message sm;
460b9539 679
680 D(("scratch playing=%p state=%d id=%s playing->id=%s",
681 (void *)playing,
682 playing ? playing->state : 0,
683 id ? id : "(none)",
684 playing ? playing->id : "(none)"));
16fb2830
RK
685 /* There must be a playing track; it must be in a scratchable state; if a
686 * specific ID was mentioned it must be that track. */
460b9539 687 if(playing
688 && (playing->state == playing_started
689 || playing->state == playing_paused)
690 && (!id
691 || !strcmp(id, playing->id))) {
16fb2830 692 /* Update state (for the benefit of the 'recent' list) */
460b9539 693 playing->state = playing_scratched;
694 playing->scratched = who ? xstrdup(who) : 0;
16fb2830 695 /* Find the player and kill the whole process group */
90b8faa5
RK
696 if(playing->pid >= 0) {
697 D(("kill -%d -%lu", config->signal, (unsigned long)playing->pid));
698 kill(-playing->pid, config->signal);
16fb2830
RK
699 }
700 /* Tell the speaker, if we think it'll care */
460b9539 701 if((playing->type & DISORDER_PLAYER_TYPEMASK) == DISORDER_PLAYER_RAW) {
702 memset(&sm, 0, sizeof sm);
703 sm.type = SM_CANCEL;
704 strcpy(sm.id, playing->id);
84aa9f93 705 speaker_send(speaker_fd, &sm);
460b9539 706 D(("sending SM_CANCEL for %s", playing->id));
707 }
62416f14
RK
708 /* If playing is enabled then add a scratch to the queue. Having a scratch
709 * appear in the queue when further play is disabled is weird and
710 * contradicts implicit assumptions made elsewhere, so we try to avoid
711 * it. */
712 if(playing_is_enabled()) {
713 /* Try to make sure there is a scratch */
714 ensure_next_scratch(NULL);
715 /* Insert it at the head of the queue */
716 if(next_scratch){
717 next_scratch->submitter = who;
718 queue_insert_entry(&qhead, next_scratch);
719 eventlog_raw("queue", queue_marshall(next_scratch), (const char *)0);
720 next_scratch = NULL;
721 }
460b9539 722 }
723 notify_scratch(playing->track, playing->submitter, who,
4265e5d3 724 xtime(0) - playing->played);
460b9539 725 }
726}
727
5bac5b78
RK
728/* Server termination ------------------------------------------------------- */
729
730/** @brief Called from quit() to tear down everything belonging to this file */
460b9539 731void quitting(ev_source *ev) {
732 struct queue_entry *q;
460b9539 733
734 /* Don't start anything new */
735 shutting_down = 1;
736 /* Shut down the current player */
737 if(playing) {
90b8faa5
RK
738 if(playing->pid >= 0)
739 kill(-playing->pid, config->signal);
460b9539 740 playing->state = playing_quitting;
741 finished(0);
742 }
90b8faa5 743 /* Zap any background decoders that are going */
460b9539 744 for(q = qhead.next; q != &qhead; q = q->next)
90b8faa5
RK
745 if(q->pid >= 0) {
746 D(("kill -%d %lu", config->signal, (unsigned long)q->pid));
747 kill(-q->pid, config->signal);
16fb2830 748 }
460b9539 749 /* Don't need the speaker any more */
750 ev_fd_cancel(ev, ev_read, speaker_fd);
751 xclose(speaker_fd);
752}
753
5bac5b78
RK
754/* Pause and resume --------------------------------------------------------- */
755
16fb2830 756/** @brief Pause the playing track */
460b9539 757int pause_playing(const char *who) {
758 struct speaker_message sm;
759 long played;
760
761 /* Can't pause if already paused or if nothing playing. */
762 if(!playing || paused) return 0;
763 switch(playing->type & DISORDER_PLAYER_TYPEMASK) {
764 case DISORDER_PLAYER_STANDALONE:
765 if(!(playing->type & DISORDER_PLAYER_PAUSES)) {
766 default:
2e9ba080 767 disorder_error(0, "cannot pause because player is not powerful enough");
460b9539 768 return -1;
769 }
770 if(play_pause(playing->pl, &played, playing->data)) {
2e9ba080 771 disorder_error(0, "player indicates it cannot pause");
460b9539 772 return -1;
773 }
4265e5d3 774 xtime(&playing->lastpaused);
460b9539 775 playing->uptopause = played;
776 playing->lastresumed = 0;
777 break;
778 case DISORDER_PLAYER_RAW:
779 memset(&sm, 0, sizeof sm);
780 sm.type = SM_PAUSE;
84aa9f93 781 speaker_send(speaker_fd, &sm);
460b9539 782 break;
783 }
2e9ba080
RK
784 if(who)
785 disorder_info("paused by %s", who);
460b9539 786 notify_pause(playing->track, who);
787 paused = 1;
788 if(playing->state == playing_started)
789 playing->state = playing_paused;
790 eventlog("state", "pause", (char *)0);
791 return 0;
792}
793
16fb2830 794/** @brief Resume playing after a pause */
460b9539 795void resume_playing(const char *who) {
796 struct speaker_message sm;
797
798 if(!paused) return;
799 paused = 0;
800 if(!playing) return;
801 switch(playing->type & DISORDER_PLAYER_TYPEMASK) {
802 case DISORDER_PLAYER_STANDALONE:
c458dd3d 803 if(!(playing->type & DISORDER_PLAYER_PAUSES)) {
460b9539 804 default:
805 /* Shouldn't happen */
806 return;
807 }
808 play_resume(playing->pl, playing->data);
4265e5d3 809 xtime(&playing->lastresumed);
460b9539 810 break;
811 case DISORDER_PLAYER_RAW:
812 memset(&sm, 0, sizeof sm);
813 sm.type = SM_RESUME;
84aa9f93 814 speaker_send(speaker_fd, &sm);
460b9539 815 break;
816 }
2e9ba080 817 if(who) disorder_info("resumed by %s", who);
460b9539 818 notify_resume(playing->track, who);
819 if(playing->state == playing_paused)
820 playing->state = playing_started;
821 eventlog("state", "resume", (char *)0);
822}
823
824/*
825Local Variables:
826c-basic-offset:2
827comment-column:40
828fill-column:79
16fb2830 829indent-tabs-mode:nil
460b9539 830End:
831*/