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
;
115 /* the playing track finished */
116 D(("SM_FINISHED %s", sm
.id
));
120 /* we asked for an unknown track to be cancelled */
121 if(playing
&& !strcmp(sm
.id
, playing
->id
))
125 /* track ID is playing, DATA seconds played */
126 D(("SM_PLAYING %s %ld", sm
.id
, sm
.data
));
127 playing
->sofar
= sm
.data
;
130 error(0, "unknown message type %d", sm
.type
);
135 void speaker_setup(ev_source
*ev
) {
138 struct speaker_message sm
;
140 if(socketpair(PF_UNIX
, SOCK_DGRAM
, 0, sp
) < 0)
141 fatal(errno
, "error calling socketpair");
142 if(!(pid
= xfork())) {
144 ev_signal_atfork(ev
);
149 signal(SIGPIPE
, SIG_DFL
);
151 execlp("valgrind", "valgrind", SPEAKER
, "--config", configfile
,
152 debugging ?
"--debug" : "--no-debug",
153 log_default
== &log_syslog ?
"--syslog" : "--no-syslog",
156 execlp(SPEAKER
, SPEAKER
, "--config", configfile
,
157 debugging ?
"--debug" : "--no-debug",
158 log_default
== &log_syslog ?
"--syslog" : "--no-syslog",
161 fatal(errno
, "error invoking %s", SPEAKER
);
163 ev_child(ev
, pid
, 0, speaker_terminated
, 0);
167 /* Wait for the speaker to be ready */
168 speaker_recv(speaker_fd
, &sm
);
169 nonblock(speaker_fd
);
170 ev_fd(ev
, ev_read
, speaker_fd
, speaker_readable
, 0, "speaker read");
173 void speaker_reload(void) {
174 struct speaker_message sm
;
176 memset(&sm
, 0, sizeof sm
);
178 speaker_send(speaker_fd
, &sm
);
181 /* timeout for play retry */
182 static int play_again(ev_source
*ev
,
183 const struct timeval
attribute((unused
)) *now
,
184 void attribute((unused
)) *u
) {
190 /* try calling play() again after @offset@ seconds */
191 static void retry_play(ev_source
*ev
, int offset
) {
194 D(("retry_play(%d)", offset
));
197 ev_timeout(ev
, 0, &w
, play_again
, 0);
200 /* Called when the currently playing track finishes playing. This
201 * might be because the player finished or because the speaker process
203 static void finished(ev_source
*ev
) {
204 D(("finished playing=%p", (void *)playing
));
207 if(playing
->state
!= playing_scratched
)
208 notify_not_scratched(playing
->track
, playing
->submitter
);
209 switch(playing
->state
) {
211 eventlog("completed", playing
->track
, (char *)0);
213 case playing_scratched
:
214 eventlog("scratched", playing
->track
, playing
->scratched
, (char *)0);
217 eventlog("failed", playing
->track
, wstat(playing
->wstat
), (char *)0);
222 queue_played(playing
);
224 forget_player_pid(playing
->id
);
226 if(ev
) retry_play(ev
, config
->gap
);
229 /* Called when a player terminates. */
230 static int player_finished(ev_source
*ev
,
233 const struct rusage
attribute((unused
)) *rusage
,
235 struct queue_entry
*q
= u
;
237 D(("player_finished pid=%lu status=%#x",
238 (unsigned long)pid
, (unsigned)status
));
239 /* Record that this PID is dead. If we killed the track we might know this
240 * already, but also it might have exited or crashed. Either way we don't
241 * want to end up signalling it. */
242 if(pid
== find_player_pid(q
->id
))
243 forget_player_pid(q
->id
);
245 case playing_unplayed
:
247 /* If this was a pre-prepared track then either it failed or we
248 * deliberately stopped it because it was removed from the queue or moved
249 * down it. So leave it state alone for future use. */
252 /* We actually started playing this track. */
254 if(q
->state
!= playing_scratched
)
255 q
->state
= playing_failed
;
257 q
->state
= playing_ok
;
260 /* Regardless we always report and record the status and do cleanup for
263 error(0, "player for %s %s", q
->track
, wstat(status
));
264 if(q
->type
& DISORDER_PLAYER_PREFORK
)
265 play_cleanup(q
->pl
, q
->data
);
267 /* If this actually was the current track, and does not use the speaker
268 * process, then it must have finished. For raw-output players we will get a
269 * separate notification from the speaker process. */
271 && (q
->type
& DISORDER_PLAYER_TYPEMASK
) != DISORDER_PLAYER_RAW
)
276 /* Find the player for Q */
277 static int find_player(const struct queue_entry
*q
) {
280 for(n
= 0; n
< config
->player
.n
; ++n
)
281 if(fnmatch(config
->player
.s
[n
].s
[0], q
->track
, 0) == 0)
283 if(n
>= config
->player
.n
)
289 /* Return values from start() */
290 #define START_OK 0 /**< @brief Succeeded. */
291 #define START_HARDFAIL 1 /**< @brief Track is broken. */
292 #define START_SOFTFAIL 2 /**< @brief Track OK, system (temporarily?) broken */
294 /** @brief Play or prepare @p q
295 * @param ev Event loop
296 * @param q Track to play/prepare
297 * @param prepare_only If true, only prepares track
298 * @return @ref START_OK, @ref START_HARDFAIL or @ref START_SOFTFAIL
300 static int start(ev_source
*ev
,
301 struct queue_entry
*q
,
306 struct speaker_message sm
;
309 ao_sample_format format
;
313 const char *waitdevice
= 0;
314 const char *const *optv
;
316 struct sockaddr_un addr
;
319 memset(&sm
, 0, sizeof sm
);
320 D(("start %s %d", q
->id
, prepare_only
));
322 /* The track is alraedy prepared */
324 /* We want to run it, since it's prepared the answer is to tell the
325 * speaker to set it off */
326 strcpy(sm
.id
, q
->id
);
328 speaker_send(speaker_fd
, &sm
);
329 D(("sent SM_PLAY for %s", sm
.id
));
333 /* Find the player plugin. */
334 if((n
= find_player(q
)) < 0) return START_HARDFAIL
;
335 if(!(q
->pl
= open_plugin(config
->player
.s
[n
].s
[1], 0)))
336 return START_HARDFAIL
;
337 q
->type
= play_get_type(q
->pl
);
338 /* Can't prepare non-raw tracks. */
340 && (q
->type
& DISORDER_PLAYER_TYPEMASK
) != DISORDER_PLAYER_RAW
)
342 /* Call the prefork function. */
343 p
= trackdb_rawpath(q
->track
);
344 if(q
->type
& DISORDER_PLAYER_PREFORK
)
345 if(!(q
->data
= play_prefork(q
->pl
, p
))) {
346 error(0, "prefork function for %s failed", q
->track
);
347 return START_HARDFAIL
;
349 /* Use the second arg as the tag if available (it's probably a command name),
350 * otherwise the module name. */
352 lfd
= logfd(ev
, (config
->player
.s
[n
].s
[2]
353 ? config
->player
.s
[n
].s
[2] : config
->player
.s
[n
].s
[1]));
356 optc
= config
->player
.s
[n
].n
- 2;
357 optv
= (void *)&config
->player
.s
[n
].s
[2];
358 while(optc
> 0 && optv
[0][0] == '-') {
359 if(!strcmp(optv
[0], "--")) {
364 if(!strcmp(optv
[0], "--wait-for-device")
365 || !strncmp(optv
[0], "--wait-for-device=", 18)) {
366 if((waitdevice
= strchr(optv
[0], '='))) {
369 waitdevice
= ""; /* use default */
373 error(0, "unknown option %s", optv
[0]);
374 return START_HARDFAIL
;
377 switch(pid
= fork()) {
380 ev_signal_atfork(ev
);
381 signal(SIGPIPE
, SIG_DFL
);
385 xclose(lfd
); /* tidy up */
388 if((q
->type
& DISORDER_PLAYER_TYPEMASK
) == DISORDER_PLAYER_RAW
) {
389 /* "Raw" format players always have their output send down a pipe
390 * to the disorder-normalize process. This will connect to the
391 * speaker process to actually play the audio data.
393 /* np will be the pipe to disorder-normalize */
394 if(socketpair(PF_UNIX
, SOCK_STREAM
, 0, np
) < 0)
395 fatal(errno
, "error calling socketpair");
396 xshutdown(np
[0], SHUT_WR
); /* normalize reads from np[0] */
397 xshutdown(np
[1], SHUT_RD
); /* decoder writes to np[1] */
400 /* Start disorder-normalize */
401 if(!(npid
= xfork())) {
403 /* Connect to the speaker process */
404 memset(&addr
, 0, sizeof addr
);
405 addr
.sun_family
= AF_UNIX
;
406 snprintf(addr
.sun_path
, sizeof addr
.sun_path
,
407 "%s/speaker/socket", config
->home
);
408 sfd
= xsocket(PF_UNIX
, SOCK_STREAM
, 0);
409 if(connect(sfd
, (const struct sockaddr
*)&addr
, sizeof addr
) < 0)
410 fatal(errno
, "connecting to %s", addr
.sun_path
);
412 if(write(sfd
, &l
, sizeof l
) < 0
413 || write(sfd
, q
->id
, l
) < 0)
414 fatal(errno
, "writing to %s", addr
.sun_path
);
423 /* Ask the speaker to actually start playing the track; we do it here
424 * so it's definitely after ack. */
426 strcpy(sm
.id
, q
->id
);
428 speaker_send(speaker_fd
, &sm
);
429 D(("sent SM_PLAY for %s", sm
.id
));
431 /* TODO stderr shouldn't be redirected for disorder-normalize
432 * (but it should be for play_track() */
433 execlp("disorder-normalize", "disorder-normalize",
434 log_default
== &log_syslog ?
"--syslog" : "--no-syslog",
435 "--config", configfile
,
437 fatal(errno
, "executing disorder-normalize");
438 /* end of the innermost fork */
441 /* end of the middle fork */
443 /* Wait for the middle fork to finish */
444 while(waitpid(npid
, &n
, 0) < 0 && errno
== EINTR
)
446 /* Pass the file descriptor to the driver in an environment
448 snprintf(buffer
, sizeof buffer
, "DISORDER_RAW_FD=%d", np
[1]);
449 if(putenv(buffer
) < 0)
450 fatal(errno
, "error calling putenv");
451 /* Close all the FDs we don't need */
457 n
= ao_driver_id(waitdevice
);
459 fatal(0, "invalid libao driver: %s", optv
[0]);
461 n
= ao_default_driver_id();
462 /* Make up a format. */
463 memset(&format
, 0, sizeof format
);
467 format
.byte_format
= AO_FMT_NATIVE
;
470 ts
.tv_nsec
= 100000000; /* 0.1s */
471 while((device
= ao_open_live(n
, &format
, 0)) == 0 && retries
-- > 0)
482 error(errno
, "error calling fork");
483 if(q
->type
& DISORDER_PLAYER_PREFORK
)
484 play_cleanup(q
->pl
, q
->data
); /* else would leak */
487 return START_SOFTFAIL
;
489 store_player_pid(q
->id
, pid
);
494 ev_child(ev
, pid
, 0, player_finished
, q
);
495 D(("player subprocess ID %lu", (unsigned long)pid
));
499 int prepare(ev_source
*ev
,
500 struct queue_entry
*q
) {
503 /* Find the player plugin */
504 if(find_player_pid(q
->id
) > 0) return 0; /* Already going. */
505 if((n
= find_player(q
)) < 0) return -1; /* No player */
506 q
->pl
= open_plugin(config
->player
.s
[n
].s
[1], 0); /* No player */
507 q
->type
= play_get_type(q
->pl
);
508 if((q
->type
& DISORDER_PLAYER_TYPEMASK
) != DISORDER_PLAYER_RAW
)
509 return 0; /* Not a raw player */
510 return start(ev
, q
, 1/*prepare_only*/); /* Prepare it */
513 void abandon(ev_source
attribute((unused
)) *ev
,
514 struct queue_entry
*q
) {
515 struct speaker_message sm
;
516 pid_t pid
= find_player_pid(q
->id
);
518 if(pid
< 0) return; /* Not prepared. */
519 if((q
->type
& DISORDER_PLAYER_TYPEMASK
) != DISORDER_PLAYER_RAW
)
520 return; /* Not a raw player. */
521 /* Terminate the player. */
522 kill(-pid
, config
->signal
);
523 forget_player_pid(q
->id
);
524 /* Cancel the track. */
525 memset(&sm
, 0, sizeof sm
);
527 strcpy(sm
.id
, q
->id
);
528 speaker_send(speaker_fd
, &sm
);
531 int add_random_track(void) {
532 struct queue_entry
*q
;
537 /* If random play is not enabled then do nothing. */
538 if(shutting_down
|| !random_is_enabled())
540 /* Count how big the queue is */
541 for(q
= qhead
.next
; q
!= &qhead
; q
= q
->next
)
543 /* Add random tracks until the queue is at the right size */
544 while(qlen
< config
->queue_pad
) {
545 /* Try to pick a random track */
546 if(!(p
= trackdb_random(16))) {
550 /* Add it to the end of the queue. */
551 q
= queue_add(p
, 0, WHERE_END
);
552 q
->state
= playing_random
;
553 D(("picked %p (%s) at random", (void *)q
, q
->track
));
556 /* Commit the queue */
561 /* try to play a track */
562 void play(ev_source
*ev
) {
563 struct queue_entry
*q
;
564 int random_enabled
= random_is_enabled();
566 D(("play playing=%p", (void *)playing
));
567 if(shutting_down
|| playing
|| !playing_is_enabled()) return;
568 /* If the queue is empty then add a random track. */
569 if(qhead
.next
== &qhead
) {
572 if(add_random_track()) {
573 /* On error, try again in 10s. */
577 /* Now there must be at least one track in the queue. */
580 /* If random play is disabled but the track is a random one then don't play
581 * it. play() will be called again when random play is re-enabled. */
582 if(!random_enabled
&& q
->state
== playing_random
)
584 D(("taken %p (%s) from queue", (void *)q
, q
->track
));
585 /* Try to start playing. */
586 switch(start(ev
, q
, 0/*!prepare_only*/)) {
588 if(q
== qhead
.next
) {
589 queue_remove(q
, 0); /* Abandon this track. */
593 if(qhead
.next
== &qhead
)
594 /* Queue is empty, wait a bit before trying something else (so we don't
595 * sit there looping madly in the presence of persistent problem). Note
596 * that we might not reliably get a random track lookahead in this case,
597 * but if we get here then really there are bigger problems. */
600 /* More in queue, try again now. */
604 /* Try same track again in a bit. */
608 if(q
== qhead
.next
) {
613 time(&playing
->played
);
614 playing
->state
= playing_started
;
615 notify_play(playing
->track
, playing
->submitter
);
616 eventlog("playing", playing
->track
,
617 playing
->submitter ? playing
->submitter
: (const char *)0,
619 /* Maybe add a random track. */
621 /* If there is another track in the queue prepare it now. This could
622 * potentially be a just-added random track. */
623 if(qhead
.next
!= &qhead
)
624 prepare(ev
, qhead
.next
);
629 int playing_is_enabled(void) {
630 const char *s
= trackdb_get_global("playing");
632 return !s
|| !strcmp(s
, "yes");
635 void enable_playing(const char *who
, ev_source
*ev
) {
636 trackdb_set_global("playing", "yes", who
);
637 /* Add a random track if necessary. */
642 void disable_playing(const char *who
) {
643 trackdb_set_global("playing", "no", who
);
646 int random_is_enabled(void) {
647 const char *s
= trackdb_get_global("random-play");
649 return !s
|| !strcmp(s
, "yes");
652 void enable_random(const char *who
, ev_source
*ev
) {
653 trackdb_set_global("random-play", "yes", who
);
658 void disable_random(const char *who
) {
659 trackdb_set_global("random-play", "no", who
);
662 void scratch(const char *who
, const char *id
) {
663 struct queue_entry
*q
;
664 struct speaker_message sm
;
667 D(("scratch playing=%p state=%d id=%s playing->id=%s",
669 playing ? playing
->state
: 0,
671 playing ? playing
->id
: "(none)"));
673 && (playing
->state
== playing_started
674 || playing
->state
== playing_paused
)
676 || !strcmp(id
, playing
->id
))) {
677 playing
->state
= playing_scratched
;
678 playing
->scratched
= who ?
xstrdup(who
) : 0;
679 if((pid
= find_player_pid(playing
->id
)) > 0) {
680 D(("kill -%d %lu", config
->signal
, (unsigned long)pid
));
681 kill(-pid
, config
->signal
);
682 forget_player_pid(playing
->id
);
684 error(0, "could not find PID for %s", playing
->id
);
685 if((playing
->type
& DISORDER_PLAYER_TYPEMASK
) == DISORDER_PLAYER_RAW
) {
686 memset(&sm
, 0, sizeof sm
);
688 strcpy(sm
.id
, playing
->id
);
689 speaker_send(speaker_fd
, &sm
);
690 D(("sending SM_CANCEL for %s", playing
->id
));
692 /* put a scratch track onto the front of the queue (but don't
693 * bother if playing is disabled) */
694 if(playing_is_enabled() && config
->scratch
.n
) {
695 int r
= rand() * (double)config
->scratch
.n
/ (RAND_MAX
+ 1.0);
696 q
= queue_add(config
->scratch
.s
[r
], who
, WHERE_START
);
697 q
->state
= playing_isscratch
;
699 notify_scratch(playing
->track
, playing
->submitter
, who
,
700 time(0) - playing
->played
);
704 void quitting(ev_source
*ev
) {
705 struct queue_entry
*q
;
708 /* Don't start anything new */
710 /* Shut down the current player */
712 if((pid
= find_player_pid(playing
->id
)) > 0) {
713 kill(-pid
, config
->signal
);
714 forget_player_pid(playing
->id
);
716 error(0, "could not find PID for %s", playing
->id
);
717 playing
->state
= playing_quitting
;
720 /* Zap any other players */
721 for(q
= qhead
.next
; q
!= &qhead
; q
= q
->next
)
722 if((pid
= find_player_pid(q
->id
)) > 0) {
723 D(("kill -%d %lu", config
->signal
, (unsigned long)pid
));
724 kill(-pid
, config
->signal
);
725 forget_player_pid(q
->id
);
727 error(0, "could not find PID for %s", q
->id
);
728 /* Don't need the speaker any more */
729 ev_fd_cancel(ev
, ev_read
, speaker_fd
);
733 int pause_playing(const char *who
) {
734 struct speaker_message sm
;
737 /* Can't pause if already paused or if nothing playing. */
738 if(!playing
|| paused
) return 0;
739 switch(playing
->type
& DISORDER_PLAYER_TYPEMASK
) {
740 case DISORDER_PLAYER_STANDALONE
:
741 if(!(playing
->type
& DISORDER_PLAYER_PAUSES
)) {
743 error(0, "cannot pause because player is not powerful enough");
746 if(play_pause(playing
->pl
, &played
, playing
->data
)) {
747 error(0, "player indicates it cannot pause");
750 time(&playing
->lastpaused
);
751 playing
->uptopause
= played
;
752 playing
->lastresumed
= 0;
754 case DISORDER_PLAYER_RAW
:
755 memset(&sm
, 0, sizeof sm
);
757 speaker_send(speaker_fd
, &sm
);
760 if(who
) info("paused by %s", who
);
761 notify_pause(playing
->track
, who
);
763 if(playing
->state
== playing_started
)
764 playing
->state
= playing_paused
;
765 eventlog("state", "pause", (char *)0);
769 void resume_playing(const char *who
) {
770 struct speaker_message sm
;
775 switch(playing
->type
& DISORDER_PLAYER_TYPEMASK
) {
776 case DISORDER_PLAYER_STANDALONE
:
777 if(!playing
->type
& DISORDER_PLAYER_PAUSES
) {
779 /* Shouldn't happen */
782 play_resume(playing
->pl
, playing
->data
);
783 time(&playing
->lastresumed
);
785 case DISORDER_PLAYER_RAW
:
786 memset(&sm
, 0, sizeof sm
);
788 speaker_send(speaker_fd
, &sm
);
791 if(who
) info("resumed by %s", who
);
792 notify_resume(playing
->track
, who
);
793 if(playing
->state
== playing_paused
)
794 playing
->state
= playing_started
;
795 eventlog("state", "resume", (char *)0);