2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2009 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 server/play.c
19 * @brief Playing tracks
21 * This file is rather badly organized. Sorry. It's better than it was...
24 #include "disorder-server.h"
27 #define SPEAKER "disorder-speaker"
29 /** @brief The current playing track or NULL */
30 struct queue_entry *playing;
32 /** @brief Set when paused */
35 static void finished(ev_source *ev);
36 static int start_child(struct queue_entry *q,
37 const struct pbgc_params *params,
38 void attribute((unused)) *bgdata);
39 static int prepare_child(struct queue_entry *q,
40 const struct pbgc_params *params,
41 void attribute((unused)) *bgdata);
42 static void ensure_next_scratch(ev_source *ev);
44 /** @brief File descriptor of our end of the socket to the speaker */
45 static int speaker_fd = -1;
47 /** @brief Set when shutting down */
48 static int shutting_down;
50 /* Speaker ------------------------------------------------------------------ */
52 /** @brief Called when speaker process terminates
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.
58 static 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) {
63 disorder_fatal(0, "speaker subprocess %s", wstat(status));
66 /** @brief Called when we get a message from the speaker process */
67 static int speaker_readable(ev_source *ev, int fd,
68 void attribute((unused)) *u) {
69 struct speaker_message sm;
70 int ret = speaker_recv(fd, &sm);
72 if(ret < 0) return 0; /* EAGAIN */
74 ev_fd_cancel(ev, ev_read, fd);
79 /* track ID is paused, DATA seconds played */
80 D(("SM_PAUSED %s %ld", sm.id, sm.data));
81 playing->sofar = sm.data;
83 case SM_FINISHED: /* scratched the playing track */
84 case SM_STILLBORN: /* scratched too early */
85 case SM_UNKNOWN: /* scratched WAY too early */
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;
95 /* track ID is playing, DATA seconds played */
96 D(("SM_PLAYING %s %ld", sm.id, sm.data));
97 playing->sofar = sm.data;
100 disorder_error(0, "unknown speaker message type %d", sm.type);
105 /** @brief Initialize the speaker process */
106 void speaker_setup(ev_source *ev) {
109 struct speaker_message sm;
111 if(socketpair(PF_UNIX, SOCK_DGRAM, 0, sp) < 0)
112 disorder_fatal(errno, "error calling socketpair");
113 if(!(pid = xfork())) {
115 ev_signal_atfork(ev);
120 signal(SIGPIPE, SIG_DFL);
122 execlp("valgrind", "valgrind", SPEAKER, "--config", configfile,
123 debugging ? "--debug" : "--no-debug",
124 log_default == &log_syslog ? "--syslog" : "--no-syslog",
127 execlp(SPEAKER, SPEAKER, "--config", configfile,
128 debugging ? "--debug" : "--no-debug",
129 log_default == &log_syslog ? "--syslog" : "--no-syslog",
132 disorder_fatal(errno, "error invoking %s", SPEAKER);
134 ev_child(ev, pid, 0, speaker_terminated, 0);
138 /* Wait for the speaker to be ready */
139 speaker_recv(speaker_fd, &sm);
140 nonblock(speaker_fd);
141 if(ev_fd(ev, ev_read, speaker_fd, speaker_readable, 0, "speaker read") < 0)
142 disorder_fatal(0, "error registering speaker socket fd");
145 /** @brief Tell the speaker to reload its configuration */
146 void speaker_reload(void) {
147 struct speaker_message sm;
149 memset(&sm, 0, sizeof sm);
151 speaker_send(speaker_fd, &sm);
154 /* Track termination -------------------------------------------------------- */
156 /** @brief Called when the currently playing track finishes playing
157 * @param ev Event loop or NULL
159 * There are three places this is called from:
161 * 1) speaker_readable(), when the speaker tells us the playing track finished.
162 * (Technically the speaker lies a little to arrange for gapless play.)
164 * 2) player_finished(), when the player for a non-raw track (i.e. one that
165 * does not use the speaker) finishes.
167 * 3) quitting(), after signalling the decoder or player but possible before it
168 * has actually terminated. In this case @p ev is NULL, inhibiting any further
169 * attempt to play anything.
171 static void finished(ev_source *ev) {
172 D(("finished playing=%p", (void *)playing));
175 if(playing->state != playing_scratched)
176 notify_not_scratched(playing->track, playing->submitter);
177 switch(playing->state) {
179 eventlog("completed", playing->track, (char *)0);
181 case playing_scratched:
182 eventlog("scratched", playing->track, playing->scratched, (char *)0);
185 eventlog("failed", playing->track, wstat(playing->wstat), (char *)0);
190 queue_played(playing);
193 /* Try to play something else */
198 /** @brief Called when a player or decoder process terminates
200 * This is called when a decoder process terminates (which might actually be
201 * some time before the speaker reports it as finished) or when a non-raw
202 * (i.e. non-speaker) player terminates. In the latter case it's imaginable
203 * that the OS has buffered the last few samples.
205 * NB. The finished track might NOT be in the queue (yet) - it might be a
206 * pre-chosen scratch.
208 static int player_finished(ev_source *ev,
211 const struct rusage attribute((unused)) *rusage,
213 struct queue_entry *q = u;
215 D(("player_finished pid=%lu status=%#x",
216 (unsigned long)pid, (unsigned)status));
217 /* Record that this PID is dead. If we killed the track we might know this
218 * already, but also it might have exited or crashed. Either way we don't
219 * want to end up signalling it. */
222 case playing_unplayed:
224 /* If this was a pre-prepared track then either it failed or we
225 * deliberately stopped it: it might have been removed from the queue, or
226 * moved down the queue, or the speaker might be on a break. So we leave
227 * it state alone for future use.
231 /* We actually started playing this track. */
233 /* Don't override 'scratched' with 'failed'. */
234 if(q->state != playing_scratched)
235 q->state = playing_failed;
237 q->state = playing_ok;
240 /* Regardless we always report and record the status and do cleanup for
243 disorder_error(0, "player for %s %s", q->track, wstat(status));
244 if(q->type & DISORDER_PLAYER_PREFORK)
245 play_cleanup(q->pl, q->data);
247 /* If this actually was the current track, and does not use the speaker
248 * process, then it must have finished. For raw-output players we will get a
249 * separate notification from the speaker process. */
251 && (q->type & DISORDER_PLAYER_TYPEMASK) != DISORDER_PLAYER_RAW)
256 /* Track initiation --------------------------------------------------------- */
258 /** @brief Find the player for @p q */
259 static const struct stringlist *find_player(const struct queue_entry *q) {
262 for(n = 0; n < config->player.n; ++n)
263 if(fnmatch(config->player.s[n].s[0], q->track, 0) == 0)
265 if(n >= config->player.n)
268 return &config->player.s[n];
271 /** @brief Start to play @p q
272 * @param ev Event loop
273 * @param q Track to play/prepare
274 * @return @ref START_OK, @ref START_HARDFAIL or @ref START_SOFTFAIL
276 * This makes @p actually start playing. It calls prepare() if necessary and
277 * either sends an @ref SM_PLAY command or invokes the player itself in a
280 * It's up to the caller to set @ref playing and @c playing->state (this might
281 * be changed in the future).
283 static int start(ev_source *ev,
284 struct queue_entry *q) {
285 const struct stringlist *player;
288 D(("start %s", q->id));
289 /* Find the player plugin. */
290 if(!(player = find_player(q)) < 0)
291 return START_HARDFAIL; /* No player */
292 if(!(q->pl = open_plugin(player->s[1], 0)))
293 return START_HARDFAIL;
294 q->type = play_get_type(q->pl);
295 /* Special handling for raw-format players */
296 if((q->type & DISORDER_PLAYER_TYPEMASK) == DISORDER_PLAYER_RAW) {
297 /* Make sure that the track is prepared */
298 if((rc = prepare(ev, q)))
300 /* Now we're sure it's prepared, start it playing */
301 /* TODO actually it might not be fully prepared yet - it's all happening in
302 * a subprocess. See speaker.c for further discussion. */
303 struct speaker_message sm[1];
304 memset(sm, 0, sizeof sm);
305 strcpy(sm->id, q->id);
307 speaker_send(speaker_fd, sm);
308 D(("sent SM_PLAY for %s", sm->id));
309 /* Our caller will set playing and playing->state = playing_started */
312 rc = play_background(ev, player, q, start_child, NULL);
314 ev_child(ev, q->pid, 0, player_finished, q);
315 /* Our caller will set playing and playing->state = playing_started */
320 /** @brief Child-process half of start()
321 * @return Process exit code
323 * Called in subprocess to execute non-raw-format players (via plugin).
325 static int start_child(struct queue_entry *q,
326 const struct pbgc_params *params,
327 void attribute((unused)) *bgdata) {
330 /* Wait for a device to clear. This ugliness is now deprecated and will
331 * eventually be removed. */
332 if(params->waitdevice) {
334 if(*params->waitdevice) {
335 n = ao_driver_id(params->waitdevice);
337 disorder_fatal(0, "invalid libao driver: %s", params->waitdevice);
339 n = ao_default_driver_id();
340 /* Make up a format. */
341 ao_sample_format format;
342 memset(&format, 0, sizeof format);
346 format.byte_format = AO_FMT_NATIVE;
350 ts.tv_nsec = 100000000; /* 0.1s */
352 while((device = ao_open_live(n, &format, 0)) == 0 && retries-- > 0)
359 params->argv, params->argc,
365 /** @brief Prepare a track for later play
366 * @return @ref START_OK, @ref START_HARDFAIL or @ref START_SOFTFAIL
368 * This can be called either when we want to play the track or slightly before
369 * so that some samples are decoded and available in a buffer.
371 * Only applies to raw-format (i.e. speaker-using) players; everything else
374 int prepare(ev_source *ev,
375 struct queue_entry *q) {
376 const struct stringlist *player;
378 /* If there's a decoder (or player!) going we do nothing */
381 /* If the track is already prepared, do nothing */
384 /* Find the player plugin */
385 if(!(player = find_player(q)) < 0)
386 return START_HARDFAIL; /* No player */
387 q->pl = open_plugin(player->s[1], 0);
388 q->type = play_get_type(q->pl);
389 if((q->type & DISORDER_PLAYER_TYPEMASK) != DISORDER_PLAYER_RAW)
390 return START_OK; /* Not a raw player */
391 const int rc = play_background(ev, player, q, prepare_child, NULL);
393 ev_child(ev, q->pid, 0, player_finished, q);
399 /** @brief Child-process half of prepare()
400 * @return Process exit code
402 * Called in subprocess to execute the decoder for a raw-format player.
404 * @todo We currently run the normalizer from here in a double-fork. This is
405 * unsatisfactory for many reasons: we can't prevent it outliving the main
406 * server and we don't adequately report its exit status.
408 static int prepare_child(struct queue_entry *q,
409 const struct pbgc_params *params,
410 void attribute((unused)) *bgdata) {
411 /* np will be the pipe to disorder-normalize */
413 if(socketpair(PF_UNIX, SOCK_STREAM, 0, np) < 0)
414 disorder_fatal(errno, "error calling socketpair");
415 /* Beware of the Leopard! On OS X 10.5.x, the order of the shutdown
416 * calls here DOES MATTER. If you do the SHUT_WR first then the SHUT_RD
417 * fails with "Socket is not connected". I think this is a bug but
418 * provided implementors either don't care about the order or all agree
419 * about the order, choosing the reliable order is an adequate
421 xshutdown(np[1], SHUT_RD); /* decoder writes to np[1] */
422 xshutdown(np[0], SHUT_WR); /* normalize reads from np[0] */
425 /* Start disorder-normalize. We double-fork so that nothing has to wait
426 * for disorder-normalize. */
428 if(!(npid = xfork())) {
429 /* Grandchild of disorderd */
431 /* Great-grandchild of disorderd */
432 /* Connect to the speaker process */
433 struct sockaddr_un addr;
434 memset(&addr, 0, sizeof addr);
435 addr.sun_family = AF_UNIX;
436 snprintf(addr.sun_path, sizeof addr.sun_path,
437 "%s/speaker/socket", config->home);
438 int sfd = xsocket(PF_UNIX, SOCK_STREAM, 0);
439 if(connect(sfd, (const struct sockaddr *)&addr, sizeof addr) < 0)
440 disorder_fatal(errno, "connecting to %s", addr.sun_path);
441 /* Send the ID, with a NATIVE-ENDIAN 32 bit length */
442 uint32_t l = strlen(q->id);
443 if(write(sfd, &l, sizeof l) < 0
444 || write(sfd, q->id, l) < 0)
445 disorder_fatal(errno, "writing to %s", addr.sun_path);
447 if (read(sfd, &l, 1) < 0)
448 disorder_fatal(errno, "reading ack from %s", addr.sun_path);
455 /* TODO stderr shouldn't be redirected for disorder-normalize
456 * (but it should be for play_track() */
457 execlp("disorder-normalize", "disorder-normalize",
458 log_default == &log_syslog ? "--syslog" : "--no-syslog",
459 "--config", configfile,
461 disorder_fatal(errno, "executing disorder-normalize");
462 /* End of the great-grandchild of disorderd */
464 /* Back in the grandchild of disorderd */
466 /* End of the grandchild of disorderd */
468 /* Back in the child of disorderd */
469 /* Wait for the grandchild of disordered to finish */
471 while(waitpid(npid, &n, 0) < 0 && errno == EINTR)
473 /* Pass the file descriptor to the driver in an environment
476 snprintf(buffer, sizeof buffer, "DISORDER_RAW_FD=%d", np[1]);
477 if(putenv(buffer) < 0)
478 disorder_fatal(errno, "error calling putenv");
479 /* Close all the FDs we don't need */
481 /* Start the decoder itself */
483 params->argv, params->argc,
489 /** @brief Abandon a queue entry
491 * Called from c_remove() (but NOT when scratching a track). Only does
492 * anything to raw-format tracks. Terminates the background decoder and tells
493 * the speaker process to cancel the track.
495 void abandon(ev_source attribute((unused)) *ev,
496 struct queue_entry *q) {
497 struct speaker_message sm;
500 return; /* Not prepared. */
501 if((q->type & DISORDER_PLAYER_TYPEMASK) != DISORDER_PLAYER_RAW)
502 return; /* Not a raw player. */
503 /* Terminate the player. */
504 kill(-q->pid, config->signal);
505 /* Cancel the track. */
506 memset(&sm, 0, sizeof sm);
508 strcpy(sm.id, q->id);
509 speaker_send(speaker_fd, &sm);
512 /* Random tracks ------------------------------------------------------------ */
514 /** @brief Called with a new random track
515 * @param ev Event loop
516 * @param track Track name
518 static void chosen_random_track(ev_source *ev,
520 struct queue_entry *q;
524 /* Add the track to the queue */
525 q = queue_add(track, 0, WHERE_END, NULL, origin_random);
526 D(("picked %p (%s) at random", (void *)q, q->track));
528 /* Maybe a track can now be played */
532 /** @brief Maybe add a randomly chosen track
533 * @param ev Event loop
535 * Picking can take some time so the track will only be added after this
536 * function has returned.
538 void add_random_track(ev_source *ev) {
539 struct queue_entry *q;
542 /* If random play is not enabled then do nothing. */
543 if(shutting_down || !random_is_enabled())
545 /* Count how big the queue is */
546 for(q = qhead.next; q != &qhead; q = q->next)
548 /* If it's smaller than the desired size then add a track */
549 if(qlen < config->queue_pad)
550 trackdb_request_random(ev, chosen_random_track);
553 /* Track initiation (part 2) ------------------------------------------------ */
555 /** @brief Attempt to play something
557 * This is called from numerous locations - whenever it might conceivably have
558 * become possible to play something.
560 void play(ev_source *ev) {
561 struct queue_entry *q;
562 int random_enabled = random_is_enabled();
564 D(("play playing=%p", (void *)playing));
565 /* If we're shutting down, or there's something playing, or playing is not
566 * enabled, give up now */
567 if(shutting_down || playing || !playing_is_enabled()) return;
568 /* See if there's anything to play */
569 if(qhead.next == &qhead) {
570 /* Queue is empty. We could just wait around since there are periodic
571 * attempts to add a random track anyway. However they are rarer than
572 * attempts to force a track so we initiate one now. */
573 add_random_track(ev);
574 /* chosen_random_track() will call play() when a new random track has been
575 * added to the queue. */
578 /* There must be at least one track in the queue. */
580 /* If random play is disabled but the track is a non-adopted random one
581 * then don't play it. play() will be called again when random play is
583 if(!random_enabled && q->origin == origin_random)
585 D(("taken %p (%s) from queue", (void *)q, q->track));
586 /* Try to start playing. */
587 switch(start(ev, q)) {
589 if(q == qhead.next) {
590 queue_remove(q, 0); /* Abandon this track. */
594 /* Oh well, try the next one */
598 /* We'll try the same track again shortly. */
601 /* Remove from the queue */
602 if(q == qhead.next) {
606 /* It's become the playing track */
608 xtime(&playing->played);
609 playing->state = playing_started;
610 notify_play(playing->track, playing->submitter);
611 eventlog("playing", playing->track,
612 playing->submitter ? playing->submitter : (const char *)0,
614 /* Maybe add a random track. */
615 add_random_track(ev);
616 /* If there is another track in the queue prepare it now. This could
617 * potentially be a just-added random track. */
618 if(qhead.next != &qhead)
619 prepare(ev, qhead.next);
620 /* Make sure there is a prepared scratch */
621 ensure_next_scratch(ev);
626 /* Miscelleneous ------------------------------------------------------------ */
628 /** @brief Return true if play is enabled */
629 int playing_is_enabled(void) {
630 const char *s = trackdb_get_global("playing");
632 return !s || !strcmp(s, "yes");
635 /** @brief Enable play */
636 void enable_playing(const char *who, ev_source *ev) {
637 trackdb_set_global("playing", "yes", who);
638 /* Add a random track if necessary. */
639 add_random_track(ev);
643 /** @brief Disable play */
644 void disable_playing(const char *who) {
645 trackdb_set_global("playing", "no", who);
648 /** @brief Return true if random play is enabled */
649 int random_is_enabled(void) {
650 const char *s = trackdb_get_global("random-play");
652 return !s || !strcmp(s, "yes");
655 /** @brief Enable random play */
656 void enable_random(const char *who, ev_source *ev) {
657 trackdb_set_global("random-play", "yes", who);
658 add_random_track(ev);
662 /** @brief Disable random play */
663 void disable_random(const char *who) {
664 trackdb_set_global("random-play", "no", who);
667 /* Scratching --------------------------------------------------------------- */
669 /** @brief Track to play next time something is scratched */
670 static struct queue_entry *next_scratch;
672 /** @brief Ensure there isa prepared scratch */
673 static void ensure_next_scratch(ev_source *ev) {
674 if(next_scratch) /* There's one already */
676 if(!config->scratch.n) /* There are no scratches */
678 int r = rand() * (double)config->scratch.n / (RAND_MAX + 1.0);
679 next_scratch = queue_add(config->scratch.s[r], NULL,
680 WHERE_NOWHERE, NULL, origin_scratch);
682 prepare(ev, next_scratch);
685 /** @brief Scratch a track
686 * @param who User responsible (or NULL)
687 * @param id Track ID (or NULL for current)
689 void scratch(const char *who, const char *id) {
690 struct speaker_message sm;
692 D(("scratch playing=%p state=%d id=%s playing->id=%s",
694 playing ? playing->state : 0,
696 playing ? playing->id : "(none)"));
697 /* There must be a playing track; it must be in a scratchable state; if a
698 * specific ID was mentioned it must be that track. */
700 && (playing->state == playing_started
701 || playing->state == playing_paused)
703 || !strcmp(id, playing->id))) {
704 /* Update state (for the benefit of the 'recent' list) */
705 playing->state = playing_scratched;
706 playing->scratched = who ? xstrdup(who) : 0;
707 /* Find the player and kill the whole process group */
708 if(playing->pid >= 0) {
709 D(("kill -%d -%lu", config->signal, (unsigned long)playing->pid));
710 kill(-playing->pid, config->signal);
712 /* Tell the speaker, if we think it'll care */
713 if((playing->type & DISORDER_PLAYER_TYPEMASK) == DISORDER_PLAYER_RAW) {
714 memset(&sm, 0, sizeof sm);
716 strcpy(sm.id, playing->id);
717 speaker_send(speaker_fd, &sm);
718 D(("sending SM_CANCEL for %s", playing->id));
720 /* Try to make sure there is a scratch */
721 ensure_next_scratch(NULL);
722 /* Insert it at the head of the queue */
724 next_scratch->submitter = who;
725 queue_insert_entry(&qhead, next_scratch);
726 eventlog_raw("queue", queue_marshall(next_scratch), (const char *)0);
729 notify_scratch(playing->track, playing->submitter, who,
730 xtime(0) - playing->played);
734 /* Server termination ------------------------------------------------------- */
736 /** @brief Called from quit() to tear down everything belonging to this file */
737 void quitting(ev_source *ev) {
738 struct queue_entry *q;
740 /* Don't start anything new */
742 /* Shut down the current player */
744 if(playing->pid >= 0)
745 kill(-playing->pid, config->signal);
746 playing->state = playing_quitting;
749 /* Zap any background decoders that are going */
750 for(q = qhead.next; q != &qhead; q = q->next)
752 D(("kill -%d %lu", config->signal, (unsigned long)q->pid));
753 kill(-q->pid, config->signal);
755 /* Don't need the speaker any more */
756 ev_fd_cancel(ev, ev_read, speaker_fd);
760 /* Pause and resume --------------------------------------------------------- */
762 /** @brief Pause the playing track */
763 int pause_playing(const char *who) {
764 struct speaker_message sm;
767 /* Can't pause if already paused or if nothing playing. */
768 if(!playing || paused) return 0;
769 switch(playing->type & DISORDER_PLAYER_TYPEMASK) {
770 case DISORDER_PLAYER_STANDALONE:
771 if(!(playing->type & DISORDER_PLAYER_PAUSES)) {
773 disorder_error(0, "cannot pause because player is not powerful enough");
776 if(play_pause(playing->pl, &played, playing->data)) {
777 disorder_error(0, "player indicates it cannot pause");
780 xtime(&playing->lastpaused);
781 playing->uptopause = played;
782 playing->lastresumed = 0;
784 case DISORDER_PLAYER_RAW:
785 memset(&sm, 0, sizeof sm);
787 speaker_send(speaker_fd, &sm);
791 disorder_info("paused by %s", who);
792 notify_pause(playing->track, who);
794 if(playing->state == playing_started)
795 playing->state = playing_paused;
796 eventlog("state", "pause", (char *)0);
800 /** @brief Resume playing after a pause */
801 void resume_playing(const char *who) {
802 struct speaker_message sm;
807 switch(playing->type & DISORDER_PLAYER_TYPEMASK) {
808 case DISORDER_PLAYER_STANDALONE:
809 if(!(playing->type & DISORDER_PLAYER_PAUSES)) {
811 /* Shouldn't happen */
814 play_resume(playing->pl, playing->data);
815 xtime(&playing->lastresumed);
817 case DISORDER_PLAYER_RAW:
818 memset(&sm, 0, sizeof sm);
820 speaker_send(speaker_fd, &sm);
823 if(who) disorder_info("resumed by %s", who);
824 notify_resume(playing->track, who);
825 if(playing->state == playing_paused)
826 playing->state = playing_started;
827 eventlog("state", "resume", (char *)0);