2 * This file is part of DisOrder.
3 * Copyright (C) 2004, 2005, 2006, 2007 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 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * 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, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
24 #include <sys/types.h>
33 #include <sys/socket.h>
44 #include "configuration.h"
46 #include "server-queue.h"
55 #include "speaker-protocol.h"
60 #define SPEAKER "disorder-speaker"
62 struct queue_entry
*playing
;
65 static void finished(ev_source
*ev
);
67 static int speaker_fd
= -1;
68 static hash
*player_pids
;
69 static int shutting_down
;
71 static void store_player_pid(const char *id
, pid_t pid
) {
72 if(!player_pids
) player_pids
= hash_new(sizeof (pid_t
));
73 hash_add(player_pids
, id
, &pid
, HASH_INSERT_OR_REPLACE
);
76 static pid_t
find_player_pid(const char *id
) {
79 if(player_pids
&& (pidp
= hash_find(player_pids
, id
))) return *pidp
;
83 static void forget_player_pid(const char *id
) {
84 if(player_pids
) hash_remove(player_pids
, id
);
87 /* called when speaker process terminates */
88 static int speaker_terminated(ev_source
attribute((unused
)) *ev
,
89 pid_t
attribute((unused
)) pid
,
90 int attribute((unused
)) status
,
91 const struct rusage
attribute((unused
)) *rusage
,
92 void attribute((unused
)) *u
) {
93 fatal(0, "speaker subprocess %s",
97 /* called when speaker process has something to say */
98 static int speaker_readable(ev_source
*ev
, int fd
,
99 void attribute((unused
)) *u
) {
100 struct speaker_message sm
;
101 int ret
= speaker_recv(fd
, &sm
);
103 if(ret
< 0) return 0; /* EAGAIN */
105 ev_fd_cancel(ev
, ev_read
, fd
);
110 /* track ID is paused, DATA seconds played */
111 D(("SM_PAUSED %s %ld", sm
.id
, sm
.data
));
112 playing
->sofar
= sm
.data
;
114 case SM_FINISHED
: /* scratched the playing track */
115 case SM_STILLBORN
: /* scratched too early */
116 case SM_UNKNOWN
: /* scratched WAY too early */
117 if(playing
&& !strcmp(sm
.id
, playing
->id
))
121 /* track ID is playing, DATA seconds played */
122 D(("SM_PLAYING %s %ld", sm
.id
, sm
.data
));
123 playing
->sofar
= sm
.data
;
126 error(0, "unknown message type %d", sm
.type
);
131 void speaker_setup(ev_source
*ev
) {
134 struct speaker_message sm
;
136 if(socketpair(PF_UNIX
, SOCK_DGRAM
, 0, sp
) < 0)
137 fatal(errno
, "error calling socketpair");
138 if(!(pid
= xfork())) {
140 ev_signal_atfork(ev
);
145 signal(SIGPIPE
, SIG_DFL
);
147 execlp("valgrind", "valgrind", SPEAKER
, "--config", configfile
,
148 debugging ?
"--debug" : "--no-debug",
149 log_default
== &log_syslog ?
"--syslog" : "--no-syslog",
152 execlp(SPEAKER
, SPEAKER
, "--config", configfile
,
153 debugging ?
"--debug" : "--no-debug",
154 log_default
== &log_syslog ?
"--syslog" : "--no-syslog",
157 fatal(errno
, "error invoking %s", SPEAKER
);
159 ev_child(ev
, pid
, 0, speaker_terminated
, 0);
163 /* Wait for the speaker to be ready */
164 speaker_recv(speaker_fd
, &sm
);
165 nonblock(speaker_fd
);
166 ev_fd(ev
, ev_read
, speaker_fd
, speaker_readable
, 0, "speaker read");
169 void speaker_reload(void) {
170 struct speaker_message sm
;
172 memset(&sm
, 0, sizeof sm
);
174 speaker_send(speaker_fd
, &sm
);
177 /* timeout for play retry */
178 static int play_again(ev_source
*ev
,
179 const struct timeval
attribute((unused
)) *now
,
180 void attribute((unused
)) *u
) {
186 /* try calling play() again after @offset@ seconds */
187 static void retry_play(ev_source
*ev
, int offset
) {
190 D(("retry_play(%d)", offset
));
193 ev_timeout(ev
, 0, &w
, play_again
, 0);
196 /* Called when the currently playing track finishes playing. This
197 * might be because the player finished or because the speaker process
199 static void finished(ev_source
*ev
) {
200 D(("finished playing=%p", (void *)playing
));
203 if(playing
->state
!= playing_scratched
)
204 notify_not_scratched(playing
->track
, playing
->submitter
);
205 switch(playing
->state
) {
207 eventlog("completed", playing
->track
, (char *)0);
209 case playing_scratched
:
210 eventlog("scratched", playing
->track
, playing
->scratched
, (char *)0);
213 eventlog("failed", playing
->track
, wstat(playing
->wstat
), (char *)0);
218 queue_played(playing
);
220 forget_player_pid(playing
->id
);
222 if(ev
) retry_play(ev
, config
->gap
);
225 /* Called when a player terminates. */
226 static int player_finished(ev_source
*ev
,
229 const struct rusage
attribute((unused
)) *rusage
,
231 struct queue_entry
*q
= u
;
233 D(("player_finished pid=%lu status=%#x",
234 (unsigned long)pid
, (unsigned)status
));
235 /* Record that this PID is dead. If we killed the track we might know this
236 * already, but also it might have exited or crashed. Either way we don't
237 * want to end up signalling it. */
238 if(pid
== find_player_pid(q
->id
))
239 forget_player_pid(q
->id
);
241 case playing_unplayed
:
243 /* If this was a pre-prepared track then either it failed or we
244 * deliberately stopped it because it was removed from the queue or moved
245 * down it. So leave it state alone for future use. */
248 /* We actually started playing this track. */
250 if(q
->state
!= playing_scratched
)
251 q
->state
= playing_failed
;
253 q
->state
= playing_ok
;
256 /* Regardless we always report and record the status and do cleanup for
259 error(0, "player for %s %s", q
->track
, wstat(status
));
260 if(q
->type
& DISORDER_PLAYER_PREFORK
)
261 play_cleanup(q
->pl
, q
->data
);
263 /* If this actually was the current track, and does not use the speaker
264 * process, then it must have finished. For raw-output players we will get a
265 * separate notification from the speaker process. */
267 && (q
->type
& DISORDER_PLAYER_TYPEMASK
) != DISORDER_PLAYER_RAW
)
272 /* Find the player for Q */
273 static int find_player(const struct queue_entry
*q
) {
276 for(n
= 0; n
< config
->player
.n
; ++n
)
277 if(fnmatch(config
->player
.s
[n
].s
[0], q
->track
, 0) == 0)
279 if(n
>= config
->player
.n
)
285 /* Return values from start() */
286 #define START_OK 0 /**< @brief Succeeded. */
287 #define START_HARDFAIL 1 /**< @brief Track is broken. */
288 #define START_SOFTFAIL 2 /**< @brief Track OK, system (temporarily?) broken */
290 /** @brief Play or prepare @p q
291 * @param ev Event loop
292 * @param q Track to play/prepare
293 * @param prepare_only If true, only prepares track
294 * @return @ref START_OK, @ref START_HARDFAIL or @ref START_SOFTFAIL
296 static int start(ev_source
*ev
,
297 struct queue_entry
*q
,
302 struct speaker_message sm
;
305 ao_sample_format format
;
309 const char *waitdevice
= 0;
310 const char *const *optv
;
312 struct sockaddr_un addr
;
315 memset(&sm
, 0, sizeof sm
);
316 D(("start %s %d", q
->id
, prepare_only
));
318 /* The track is alraedy prepared */
320 /* We want to run it, since it's prepared the answer is to tell the
321 * speaker to set it off */
322 strcpy(sm
.id
, q
->id
);
324 speaker_send(speaker_fd
, &sm
);
325 D(("sent SM_PLAY for %s", sm
.id
));
329 /* Find the player plugin. */
330 if((n
= find_player(q
)) < 0) return START_HARDFAIL
;
331 if(!(q
->pl
= open_plugin(config
->player
.s
[n
].s
[1], 0)))
332 return START_HARDFAIL
;
333 q
->type
= play_get_type(q
->pl
);
334 /* Can't prepare non-raw tracks. */
336 && (q
->type
& DISORDER_PLAYER_TYPEMASK
) != DISORDER_PLAYER_RAW
)
338 /* Call the prefork function. */
339 p
= trackdb_rawpath(q
->track
);
340 if(q
->type
& DISORDER_PLAYER_PREFORK
)
341 if(!(q
->data
= play_prefork(q
->pl
, p
))) {
342 error(0, "prefork function for %s failed", q
->track
);
343 return START_HARDFAIL
;
345 /* Use the second arg as the tag if available (it's probably a command name),
346 * otherwise the module name. */
348 lfd
= logfd(ev
, (config
->player
.s
[n
].s
[2]
349 ? config
->player
.s
[n
].s
[2] : config
->player
.s
[n
].s
[1]));
352 optc
= config
->player
.s
[n
].n
- 2;
353 optv
= (void *)&config
->player
.s
[n
].s
[2];
354 while(optc
> 0 && optv
[0][0] == '-') {
355 if(!strcmp(optv
[0], "--")) {
360 if(!strcmp(optv
[0], "--wait-for-device")
361 || !strncmp(optv
[0], "--wait-for-device=", 18)) {
362 if((waitdevice
= strchr(optv
[0], '='))) {
365 waitdevice
= ""; /* use default */
369 error(0, "unknown option %s", optv
[0]);
370 return START_HARDFAIL
;
373 switch(pid
= fork()) {
376 progname
= "disorderd-fork";
377 ev_signal_atfork(ev
);
378 signal(SIGPIPE
, SIG_DFL
);
382 xclose(lfd
); /* tidy up */
385 if((q
->type
& DISORDER_PLAYER_TYPEMASK
) == DISORDER_PLAYER_RAW
) {
386 /* "Raw" format players always have their output send down a pipe
387 * to the disorder-normalize process. This will connect to the
388 * speaker process to actually play the audio data.
390 /* np will be the pipe to disorder-normalize */
391 if(socketpair(PF_UNIX
, SOCK_STREAM
, 0, np
) < 0)
392 fatal(errno
, "error calling socketpair");
393 /* Beware of the Leopard! On OS X 10.5.x, the order of the shutdown
394 * calls here DOES MATTER. If you do the SHUT_WR first then the SHUT_RD
395 * fails iwth "Socket is not connected". I think this is a bug but
396 * provided implementors either don't care about the order or all agree
397 * about the order, choosing the reliable order is an adequate
399 xshutdown(np
[1], SHUT_RD
); /* decoder writes to np[1] */
400 xshutdown(np
[0], SHUT_WR
); /* normalize reads from np[0] */
403 /* Start disorder-normalize */
404 if(!(npid
= xfork())) {
406 /* Connect to the speaker process */
407 memset(&addr
, 0, sizeof addr
);
408 addr
.sun_family
= AF_UNIX
;
409 snprintf(addr
.sun_path
, sizeof addr
.sun_path
,
410 "%s/speaker/socket", config
->home
);
411 sfd
= xsocket(PF_UNIX
, SOCK_STREAM
, 0);
412 if(connect(sfd
, (const struct sockaddr
*)&addr
, sizeof addr
) < 0)
413 fatal(errno
, "connecting to %s", addr
.sun_path
);
415 if(write(sfd
, &l
, sizeof l
) < 0
416 || write(sfd
, q
->id
, l
) < 0)
417 fatal(errno
, "writing to %s", addr
.sun_path
);
426 /* Ask the speaker to actually start playing the track; we do it here
427 * so it's definitely after ack. */
429 strcpy(sm
.id
, q
->id
);
431 speaker_send(speaker_fd
, &sm
);
432 D(("sent SM_PLAY for %s", sm
.id
));
434 /* TODO stderr shouldn't be redirected for disorder-normalize
435 * (but it should be for play_track() */
436 execlp("disorder-normalize", "disorder-normalize",
437 log_default
== &log_syslog ?
"--syslog" : "--no-syslog",
438 "--config", configfile
,
440 fatal(errno
, "executing disorder-normalize");
441 /* end of the innermost fork */
444 /* end of the middle fork */
446 /* Wait for the middle fork to finish */
447 while(waitpid(npid
, &n
, 0) < 0 && errno
== EINTR
)
449 /* Pass the file descriptor to the driver in an environment
451 snprintf(buffer
, sizeof buffer
, "DISORDER_RAW_FD=%d", np
[1]);
452 if(putenv(buffer
) < 0)
453 fatal(errno
, "error calling putenv");
454 /* Close all the FDs we don't need */
460 n
= ao_driver_id(waitdevice
);
462 fatal(0, "invalid libao driver: %s", optv
[0]);
464 n
= ao_default_driver_id();
465 /* Make up a format. */
466 memset(&format
, 0, sizeof format
);
470 format
.byte_format
= AO_FMT_NATIVE
;
473 ts
.tv_nsec
= 100000000; /* 0.1s */
474 while((device
= ao_open_live(n
, &format
, 0)) == 0 && retries
-- > 0)
485 error(errno
, "error calling fork");
486 if(q
->type
& DISORDER_PLAYER_PREFORK
)
487 play_cleanup(q
->pl
, q
->data
); /* else would leak */
490 return START_SOFTFAIL
;
492 store_player_pid(q
->id
, pid
);
497 ev_child(ev
, pid
, 0, player_finished
, q
);
498 D(("player subprocess ID %lu", (unsigned long)pid
));
502 int prepare(ev_source
*ev
,
503 struct queue_entry
*q
) {
506 /* Find the player plugin */
507 if(find_player_pid(q
->id
) > 0) return 0; /* Already going. */
508 if((n
= find_player(q
)) < 0) return -1; /* No player */
509 q
->pl
= open_plugin(config
->player
.s
[n
].s
[1], 0); /* No player */
510 q
->type
= play_get_type(q
->pl
);
511 if((q
->type
& DISORDER_PLAYER_TYPEMASK
) != DISORDER_PLAYER_RAW
)
512 return 0; /* Not a raw player */
513 return start(ev
, q
, 1/*prepare_only*/); /* Prepare it */
516 void abandon(ev_source
attribute((unused
)) *ev
,
517 struct queue_entry
*q
) {
518 struct speaker_message sm
;
519 pid_t pid
= find_player_pid(q
->id
);
521 if(pid
< 0) return; /* Not prepared. */
522 if((q
->type
& DISORDER_PLAYER_TYPEMASK
) != DISORDER_PLAYER_RAW
)
523 return; /* Not a raw player. */
524 /* Terminate the player. */
525 kill(-pid
, config
->signal
);
526 forget_player_pid(q
->id
);
527 /* Cancel the track. */
528 memset(&sm
, 0, sizeof sm
);
530 strcpy(sm
.id
, q
->id
);
531 speaker_send(speaker_fd
, &sm
);
534 int add_random_track(void) {
535 struct queue_entry
*q
;
540 /* If random play is not enabled then do nothing. */
541 if(shutting_down
|| !random_is_enabled())
543 /* Count how big the queue is */
544 for(q
= qhead
.next
; q
!= &qhead
; q
= q
->next
)
546 /* Add random tracks until the queue is at the right size */
547 while(qlen
< config
->queue_pad
) {
548 /* Try to pick a random track */
549 if(!(p
= trackdb_random(16))) {
553 /* Add it to the end of the queue. */
554 q
= queue_add(p
, 0, WHERE_END
);
555 q
->state
= playing_random
;
556 D(("picked %p (%s) at random", (void *)q
, q
->track
));
559 /* Commit the queue */
564 /* try to play a track */
565 void play(ev_source
*ev
) {
566 struct queue_entry
*q
;
567 int random_enabled
= random_is_enabled();
569 D(("play playing=%p", (void *)playing
));
570 if(shutting_down
|| playing
|| !playing_is_enabled()) return;
571 /* If the queue is empty then add a random track. */
572 if(qhead
.next
== &qhead
) {
575 if(add_random_track()) {
576 /* On error, try again in 10s. */
580 /* Now there must be at least one track in the queue. */
583 /* If random play is disabled but the track is a random one then don't play
584 * it. play() will be called again when random play is re-enabled. */
585 if(!random_enabled
&& q
->state
== playing_random
)
587 D(("taken %p (%s) from queue", (void *)q
, q
->track
));
588 /* Try to start playing. */
589 switch(start(ev
, q
, 0/*!prepare_only*/)) {
591 if(q
== qhead
.next
) {
592 queue_remove(q
, 0); /* Abandon this track. */
596 if(qhead
.next
== &qhead
)
597 /* Queue is empty, wait a bit before trying something else (so we don't
598 * sit there looping madly in the presence of persistent problem). Note
599 * that we might not reliably get a random track lookahead in this case,
600 * but if we get here then really there are bigger problems. */
603 /* More in queue, try again now. */
607 /* Try same track again in a bit. */
611 if(q
== qhead
.next
) {
616 time(&playing
->played
);
617 playing
->state
= playing_started
;
618 notify_play(playing
->track
, playing
->submitter
);
619 eventlog("playing", playing
->track
,
620 playing
->submitter ? playing
->submitter
: (const char *)0,
622 /* Maybe add a random track. */
624 /* If there is another track in the queue prepare it now. This could
625 * potentially be a just-added random track. */
626 if(qhead
.next
!= &qhead
)
627 prepare(ev
, qhead
.next
);
632 int playing_is_enabled(void) {
633 const char *s
= trackdb_get_global("playing");
635 return !s
|| !strcmp(s
, "yes");
638 void enable_playing(const char *who
, ev_source
*ev
) {
639 trackdb_set_global("playing", "yes", who
);
640 /* Add a random track if necessary. */
645 void disable_playing(const char *who
) {
646 trackdb_set_global("playing", "no", who
);
649 int random_is_enabled(void) {
650 const char *s
= trackdb_get_global("random-play");
652 return !s
|| !strcmp(s
, "yes");
655 void enable_random(const char *who
, ev_source
*ev
) {
656 trackdb_set_global("random-play", "yes", who
);
661 void disable_random(const char *who
) {
662 trackdb_set_global("random-play", "no", who
);
665 void scratch(const char *who
, const char *id
) {
666 struct queue_entry
*q
;
667 struct speaker_message sm
;
670 D(("scratch playing=%p state=%d id=%s playing->id=%s",
672 playing ? playing
->state
: 0,
674 playing ? playing
->id
: "(none)"));
676 && (playing
->state
== playing_started
677 || playing
->state
== playing_paused
)
679 || !strcmp(id
, playing
->id
))) {
680 playing
->state
= playing_scratched
;
681 playing
->scratched
= who ?
xstrdup(who
) : 0;
682 if((pid
= find_player_pid(playing
->id
)) > 0) {
683 D(("kill -%d %lu", config
->signal
, (unsigned long)pid
));
684 kill(-pid
, config
->signal
);
685 forget_player_pid(playing
->id
);
687 error(0, "could not find PID for %s", playing
->id
);
688 if((playing
->type
& DISORDER_PLAYER_TYPEMASK
) == DISORDER_PLAYER_RAW
) {
689 memset(&sm
, 0, sizeof sm
);
691 strcpy(sm
.id
, playing
->id
);
692 speaker_send(speaker_fd
, &sm
);
693 D(("sending SM_CANCEL for %s", playing
->id
));
695 /* put a scratch track onto the front of the queue (but don't
696 * bother if playing is disabled) */
697 if(playing_is_enabled() && config
->scratch
.n
) {
698 int r
= rand() * (double)config
->scratch
.n
/ (RAND_MAX
+ 1.0);
699 q
= queue_add(config
->scratch
.s
[r
], who
, WHERE_START
);
700 q
->state
= playing_isscratch
;
702 notify_scratch(playing
->track
, playing
->submitter
, who
,
703 time(0) - playing
->played
);
707 void quitting(ev_source
*ev
) {
708 struct queue_entry
*q
;
711 /* Don't start anything new */
713 /* Shut down the current player */
715 if((pid
= find_player_pid(playing
->id
)) > 0) {
716 kill(-pid
, config
->signal
);
717 forget_player_pid(playing
->id
);
719 error(0, "could not find PID for %s", playing
->id
);
720 playing
->state
= playing_quitting
;
723 /* Zap any other players */
724 for(q
= qhead
.next
; q
!= &qhead
; q
= q
->next
)
725 if((pid
= find_player_pid(q
->id
)) > 0) {
726 D(("kill -%d %lu", config
->signal
, (unsigned long)pid
));
727 kill(-pid
, config
->signal
);
728 forget_player_pid(q
->id
);
730 error(0, "could not find PID for %s", q
->id
);
731 /* Don't need the speaker any more */
732 ev_fd_cancel(ev
, ev_read
, speaker_fd
);
736 int pause_playing(const char *who
) {
737 struct speaker_message sm
;
740 /* Can't pause if already paused or if nothing playing. */
741 if(!playing
|| paused
) return 0;
742 switch(playing
->type
& DISORDER_PLAYER_TYPEMASK
) {
743 case DISORDER_PLAYER_STANDALONE
:
744 if(!(playing
->type
& DISORDER_PLAYER_PAUSES
)) {
746 error(0, "cannot pause because player is not powerful enough");
749 if(play_pause(playing
->pl
, &played
, playing
->data
)) {
750 error(0, "player indicates it cannot pause");
753 time(&playing
->lastpaused
);
754 playing
->uptopause
= played
;
755 playing
->lastresumed
= 0;
757 case DISORDER_PLAYER_RAW
:
758 memset(&sm
, 0, sizeof sm
);
760 speaker_send(speaker_fd
, &sm
);
763 if(who
) info("paused by %s", who
);
764 notify_pause(playing
->track
, who
);
766 if(playing
->state
== playing_started
)
767 playing
->state
= playing_paused
;
768 eventlog("state", "pause", (char *)0);
772 void resume_playing(const char *who
) {
773 struct speaker_message sm
;
778 switch(playing
->type
& DISORDER_PLAYER_TYPEMASK
) {
779 case DISORDER_PLAYER_STANDALONE
:
780 if(!playing
->type
& DISORDER_PLAYER_PAUSES
) {
782 /* Shouldn't happen */
785 play_resume(playing
->pl
, playing
->data
);
786 time(&playing
->lastresumed
);
788 case DISORDER_PLAYER_RAW
:
789 memset(&sm
, 0, sizeof sm
);
791 speaker_send(speaker_fd
, &sm
);
794 if(who
) info("resumed by %s", who
);
795 notify_resume(playing
->track
, who
);
796 if(playing
->state
== playing_paused
)
797 playing
->state
= playing_started
;
798 eventlog("state", "resume", (char *)0);