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"
54 #include "speaker-protocol.h"
59 #define SPEAKER "disorder-speaker"
61 struct queue_entry
*playing
;
64 static void finished(ev_source
*ev
);
66 static int speaker_fd
= -1;
67 static hash
*player_pids
;
68 static int shutting_down
;
70 static void store_player_pid(const char *id
, pid_t pid
) {
71 if(!player_pids
) player_pids
= hash_new(sizeof (pid_t
));
72 hash_add(player_pids
, id
, &pid
, HASH_INSERT_OR_REPLACE
);
75 static pid_t
find_player_pid(const char *id
) {
78 if(player_pids
&& (pidp
= hash_find(player_pids
, id
))) return *pidp
;
82 static void forget_player_pid(const char *id
) {
83 if(player_pids
) hash_remove(player_pids
, id
);
86 /* called when speaker process terminates */
87 static int speaker_terminated(ev_source
attribute((unused
)) *ev
,
88 pid_t
attribute((unused
)) pid
,
89 int attribute((unused
)) status
,
90 const struct rusage
attribute((unused
)) *rusage
,
91 void attribute((unused
)) *u
) {
92 fatal(0, "speaker subprocess %s",
96 /* called when speaker process has something to say */
97 static int speaker_readable(ev_source
*ev
, int fd
,
98 void attribute((unused
)) *u
) {
99 struct speaker_message sm
;
100 int ret
= speaker_recv(fd
, &sm
);
102 if(ret
< 0) return 0; /* EAGAIN */
104 ev_fd_cancel(ev
, ev_read
, fd
);
109 /* track ID is paused, DATA seconds played */
110 D(("SM_PAUSED %s %ld", sm
.id
, sm
.data
));
111 playing
->sofar
= sm
.data
;
114 /* the playing track finished */
115 D(("SM_FINISHED %s", sm
.id
));
119 /* track ID is playing, DATA seconds played */
120 D(("SM_PLAYING %s %ld", sm
.id
, sm
.data
));
121 playing
->sofar
= sm
.data
;
124 error(0, "unknown message type %d", sm
.type
);
129 void speaker_setup(ev_source
*ev
) {
132 struct speaker_message sm
;
134 if(socketpair(PF_UNIX
, SOCK_DGRAM
, 0, sp
) < 0)
135 fatal(errno
, "error calling socketpair");
136 if(!(pid
= xfork())) {
138 ev_signal_atfork(ev
);
143 signal(SIGPIPE
, SIG_DFL
);
145 execlp("valgrind", "valgrind", SPEAKER
, "--config", configfile
,
146 debugging ?
"--debug" : "--no-debug",
147 log_default
== &log_syslog ?
"--syslog" : "--no-syslog",
150 execlp(SPEAKER
, SPEAKER
, "--config", configfile
,
151 debugging ?
"--debug" : "--no-debug",
152 log_default
== &log_syslog ?
"--syslog" : "--no-syslog",
155 fatal(errno
, "error invoking %s", SPEAKER
);
157 ev_child(ev
, pid
, 0, speaker_terminated
, 0);
161 /* Wait for the speaker to be ready */
162 speaker_recv(speaker_fd
, &sm
);
163 nonblock(speaker_fd
);
164 ev_fd(ev
, ev_read
, speaker_fd
, speaker_readable
, 0, "speaker read");
167 void speaker_reload(void) {
168 struct speaker_message sm
;
170 memset(&sm
, 0, sizeof sm
);
172 speaker_send(speaker_fd
, &sm
);
175 /* timeout for play retry */
176 static int play_again(ev_source
*ev
,
177 const struct timeval
attribute((unused
)) *now
,
178 void attribute((unused
)) *u
) {
184 /* try calling play() again after @offset@ seconds */
185 static void retry_play(ev_source
*ev
, int offset
) {
188 D(("retry_play(%d)", offset
));
191 ev_timeout(ev
, 0, &w
, play_again
, 0);
194 /* Called when the currently playing track finishes playing. This
195 * might be because the player finished or because the speaker process
197 static void finished(ev_source
*ev
) {
198 D(("finished playing=%p", (void *)playing
));
201 if(playing
->state
!= playing_scratched
)
202 notify_not_scratched(playing
->track
, playing
->submitter
);
203 switch(playing
->state
) {
205 eventlog("completed", playing
->track
, (char *)0);
207 case playing_scratched
:
208 eventlog("scratched", playing
->track
, playing
->scratched
, (char *)0);
211 eventlog("failed", playing
->track
, wstat(playing
->wstat
), (char *)0);
216 queue_played(playing
);
218 forget_player_pid(playing
->id
);
220 if(ev
) retry_play(ev
, config
->gap
);
223 /* Called when a player terminates. */
224 static int player_finished(ev_source
*ev
,
227 const struct rusage
attribute((unused
)) *rusage
,
229 struct queue_entry
*q
= u
;
231 D(("player_finished pid=%lu status=%#x",
232 (unsigned long)pid
, (unsigned)status
));
233 /* Record that this PID is dead. If we killed the track we might know this
234 * already, but also it might have exited or crashed. Either way we don't
235 * want to end up signalling it. */
236 if(pid
== find_player_pid(q
->id
))
237 forget_player_pid(q
->id
);
239 case playing_unplayed
:
241 /* If this was a pre-prepared track then either it failed or we
242 * deliberately stopped it because it was removed from the queue or moved
243 * down it. So leave it state alone for future use. */
246 /* We actually started playing this track. */
248 if(q
->state
!= playing_scratched
)
249 q
->state
= playing_failed
;
251 q
->state
= playing_ok
;
254 /* Regardless we always report and record the status and do cleanup for
257 error(0, "player for %s %s", q
->track
, wstat(status
));
258 if(q
->type
& DISORDER_PLAYER_PREFORK
)
259 play_cleanup(q
->pl
, q
->data
);
261 /* If this actually was the current track, and does not use the speaker
262 * process, then it must have finished. For raw-output players we will get a
263 * separate notification from the speaker process. */
265 && (q
->type
& DISORDER_PLAYER_TYPEMASK
) != DISORDER_PLAYER_RAW
)
270 /* Find the player for Q */
271 static int find_player(const struct queue_entry
*q
) {
274 for(n
= 0; n
< config
->player
.n
; ++n
)
275 if(fnmatch(config
->player
.s
[n
].s
[0], q
->track
, 0) == 0)
277 if(n
>= config
->player
.n
)
283 /* Return values from start() */
284 #define START_OK 0 /**< @brief Succeeded. */
285 #define START_HARDFAIL 1 /**< @brief Track is broken. */
286 #define START_SOFTFAIL 2 /**< @brief Track OK, system (temporarily?) broken */
288 /** @brief Play or prepare @p q
289 * @param ev Event loop
290 * @param q Track to play/prepare
291 * @param prepare_only If true, only prepares track
292 * @return @ref START_OK, @ref START_HARDFAIL or @ref START_SOFTFAIL
294 static int start(ev_source
*ev
,
295 struct queue_entry
*q
,
300 struct speaker_message sm
;
303 ao_sample_format format
;
307 const char *waitdevice
= 0;
308 const char *const *optv
;
310 struct sockaddr_un addr
;
313 memset(&sm
, 0, sizeof sm
);
314 D(("start %s %d", q
->id
, prepare_only
));
316 /* The track is alraedy prepared */
318 /* We want to run it, since it's prepared the answer is to tell the
319 * speaker to set it off */
320 strcpy(sm
.id
, q
->id
);
322 speaker_send(speaker_fd
, &sm
);
323 D(("sent SM_PLAY for %s", sm
.id
));
327 /* Find the player plugin. */
328 if((n
= find_player(q
)) < 0) return START_HARDFAIL
;
329 if(!(q
->pl
= open_plugin(config
->player
.s
[n
].s
[1], 0)))
330 return START_HARDFAIL
;
331 q
->type
= play_get_type(q
->pl
);
332 /* Can't prepare non-raw tracks. */
334 && (q
->type
& DISORDER_PLAYER_TYPEMASK
) != DISORDER_PLAYER_RAW
)
336 /* Call the prefork function. */
337 p
= trackdb_rawpath(q
->track
);
338 if(q
->type
& DISORDER_PLAYER_PREFORK
)
339 if(!(q
->data
= play_prefork(q
->pl
, p
))) {
340 error(0, "prefork function for %s failed", q
->track
);
341 return START_HARDFAIL
;
343 /* Use the second arg as the tag if available (it's probably a command name),
344 * otherwise the module name. */
346 lfd
= logfd(ev
, (config
->player
.s
[n
].s
[2]
347 ? config
->player
.s
[n
].s
[2] : config
->player
.s
[n
].s
[1]));
350 optc
= config
->player
.s
[n
].n
- 2;
351 optv
= (void *)&config
->player
.s
[n
].s
[2];
352 while(optc
> 0 && optv
[0][0] == '-') {
353 if(!strcmp(optv
[0], "--")) {
358 if(!strcmp(optv
[0], "--wait-for-device")
359 || !strncmp(optv
[0], "--wait-for-device=", 18)) {
360 if((waitdevice
= strchr(optv
[0], '='))) {
363 waitdevice
= ""; /* use default */
367 error(0, "unknown option %s", optv
[0]);
368 return START_HARDFAIL
;
371 switch(pid
= fork()) {
374 ev_signal_atfork(ev
);
375 signal(SIGPIPE
, SIG_DFL
);
379 xclose(lfd
); /* tidy up */
382 if((q
->type
& DISORDER_PLAYER_TYPEMASK
) == DISORDER_PLAYER_RAW
) {
383 /* "Raw" format players always have their output send down a pipe
384 * to the disorder-normalize process. This will connect to the
385 * speaker process to actually play the audio data.
387 /* np will be the pipe to disorder-normalize */
388 if(socketpair(PF_UNIX
, SOCK_STREAM
, 0, np
) < 0)
389 fatal(errno
, "error calling socketpair");
390 xshutdown(np
[0], SHUT_WR
); /* normalize reads from np[0] */
391 xshutdown(np
[1], SHUT_RD
); /* decoder writes to np[1] */
394 /* Start disorder-normalize */
395 if(!(npid
= xfork())) {
397 /* Connect to the speaker process */
398 memset(&addr
, 0, sizeof addr
);
399 addr
.sun_family
= AF_UNIX
;
400 snprintf(addr
.sun_path
, sizeof addr
.sun_path
,
401 "%s/speaker", config
->home
);
402 sfd
= xsocket(PF_UNIX
, SOCK_STREAM
, 0);
403 if(connect(sfd
, (const struct sockaddr
*)&addr
, sizeof addr
) < 0)
404 fatal(errno
, "connecting to %s", addr
.sun_path
);
406 if(write(sfd
, &l
, sizeof l
) < 0
407 || write(sfd
, q
->id
, l
) < 0)
408 fatal(errno
, "writing to %s", addr
.sun_path
);
417 /* Ask the speaker to actually start playing the track; we do it here
418 * so it's definitely after ack. */
420 strcpy(sm
.id
, q
->id
);
422 speaker_send(speaker_fd
, &sm
);
423 D(("sent SM_PLAY for %s", sm
.id
));
425 /* TODO stderr shouldn't be redirected for disorder-normalize
426 * (but it should be for play_track() */
427 execlp("disorder-normalize", "disorder-normalize",
428 log_default
== &log_syslog ?
"--syslog" : "--no-syslog",
430 fatal(errno
, "executing disorder-normalize");
431 /* end of the innermost fork */
434 /* end of the middle fork */
436 /* Wait for the middle fork to finish */
437 while(waitpid(npid
, &n
, 0) < 0 && errno
== EINTR
)
439 /* Pass the file descriptor to the driver in an environment
441 snprintf(buffer
, sizeof buffer
, "DISORDER_RAW_FD=%d", np
[1]);
442 if(putenv(buffer
) < 0)
443 fatal(errno
, "error calling putenv");
444 /* Close all the FDs we don't need */
450 n
= ao_driver_id(waitdevice
);
452 fatal(0, "invalid libao driver: %s", optv
[0]);
454 n
= ao_default_driver_id();
455 /* Make up a format. */
456 memset(&format
, 0, sizeof format
);
460 format
.byte_format
= AO_FMT_NATIVE
;
463 ts
.tv_nsec
= 100000000; /* 0.1s */
464 while((device
= ao_open_live(n
, &format
, 0)) == 0 && retries
-- > 0)
475 error(errno
, "error calling fork");
476 if(q
->type
& DISORDER_PLAYER_PREFORK
)
477 play_cleanup(q
->pl
, q
->data
); /* else would leak */
480 return START_SOFTFAIL
;
482 store_player_pid(q
->id
, pid
);
487 ev_child(ev
, pid
, 0, player_finished
, q
);
488 D(("player subprocess ID %lu", (unsigned long)pid
));
492 int prepare(ev_source
*ev
,
493 struct queue_entry
*q
) {
496 /* Find the player plugin */
497 if(find_player_pid(q
->id
) > 0) return 0; /* Already going. */
498 if((n
= find_player(q
)) < 0) return -1; /* No player */
499 q
->pl
= open_plugin(config
->player
.s
[n
].s
[1], 0); /* No player */
500 q
->type
= play_get_type(q
->pl
);
501 if((q
->type
& DISORDER_PLAYER_TYPEMASK
) != DISORDER_PLAYER_RAW
)
502 return 0; /* Not a raw player */
503 return start(ev
, q
, 1/*prepare_only*/); /* Prepare it */
506 void abandon(ev_source
attribute((unused
)) *ev
,
507 struct queue_entry
*q
) {
508 struct speaker_message sm
;
509 pid_t pid
= find_player_pid(q
->id
);
511 if(pid
< 0) return; /* Not prepared. */
512 if((q
->type
& DISORDER_PLAYER_TYPEMASK
) != DISORDER_PLAYER_RAW
)
513 return; /* Not a raw player. */
514 /* Terminate the player. */
515 kill(-pid
, config
->signal
);
516 forget_player_pid(q
->id
);
517 /* Cancel the track. */
518 memset(&sm
, 0, sizeof sm
);
520 strcpy(sm
.id
, q
->id
);
521 speaker_send(speaker_fd
, &sm
);
524 int add_random_track(void) {
525 struct queue_entry
*q
;
530 /* If random play is not enabled then do nothing. */
531 if(shutting_down
|| !random_is_enabled())
533 /* Count how big the queue is */
534 for(q
= qhead
.next
; q
!= &qhead
; q
= q
->next
)
536 /* Add random tracks until the queue is at the right size */
537 while(qlen
< config
->queue_pad
) {
538 /* Try to pick a random track */
539 if(!(p
= trackdb_random(16))) {
543 /* Add it to the end of the queue. */
544 q
= queue_add(p
, 0, WHERE_END
);
545 q
->state
= playing_random
;
546 D(("picked %p (%s) at random", (void *)q
, q
->track
));
549 /* Commit the queue */
554 /* try to play a track */
555 void play(ev_source
*ev
) {
556 struct queue_entry
*q
;
557 int random_enabled
= random_is_enabled();
559 D(("play playing=%p", (void *)playing
));
560 if(shutting_down
|| playing
|| !playing_is_enabled()) return;
561 /* If the queue is empty then add a random track. */
562 if(qhead
.next
== &qhead
) {
565 if(add_random_track()) {
566 /* On error, try again in 10s. */
570 /* Now there must be at least one track in the queue. */
573 /* If random play is disabled but the track is a random one then don't play
574 * it. play() will be called again when random play is re-enabled. */
575 if(!random_enabled
&& q
->state
== playing_random
)
577 D(("taken %p (%s) from queue", (void *)q
, q
->track
));
578 /* Try to start playing. */
579 switch(start(ev
, q
, 0/*!prepare_only*/)) {
581 if(q
== qhead
.next
) {
582 queue_remove(q
, 0); /* Abandon this track. */
586 if(qhead
.next
== &qhead
)
587 /* Queue is empty, wait a bit before trying something else (so we don't
588 * sit there looping madly in the presence of persistent problem). Note
589 * that we might not reliably get a random track lookahead in this case,
590 * but if we get here then really there are bigger problems. */
593 /* More in queue, try again now. */
597 /* Try same track again in a bit. */
601 if(q
== qhead
.next
) {
606 time(&playing
->played
);
607 playing
->state
= playing_started
;
608 notify_play(playing
->track
, playing
->submitter
);
609 eventlog("playing", playing
->track
,
610 playing
->submitter ? playing
->submitter
: (const char *)0,
612 /* Maybe add a random track. */
614 /* If there is another track in the queue prepare it now. This could
615 * potentially be a just-added random track. */
616 if(qhead
.next
!= &qhead
)
617 prepare(ev
, qhead
.next
);
622 int playing_is_enabled(void) {
623 const char *s
= trackdb_get_global("playing");
625 return !s
|| !strcmp(s
, "yes");
628 void enable_playing(const char *who
, ev_source
*ev
) {
629 trackdb_set_global("playing", "yes", who
);
630 /* Add a random track if necessary. */
635 void disable_playing(const char *who
) {
636 trackdb_set_global("playing", "no", who
);
639 int random_is_enabled(void) {
640 const char *s
= trackdb_get_global("random-play");
642 return !s
|| !strcmp(s
, "yes");
645 void enable_random(const char *who
, ev_source
*ev
) {
646 trackdb_set_global("random-play", "yes", who
);
651 void disable_random(const char *who
) {
652 trackdb_set_global("random-play", "no", who
);
655 void scratch(const char *who
, const char *id
) {
656 struct queue_entry
*q
;
657 struct speaker_message sm
;
660 D(("scratch playing=%p state=%d id=%s playing->id=%s",
662 playing ? playing
->state
: 0,
664 playing ? playing
->id
: "(none)"));
666 && (playing
->state
== playing_started
667 || playing
->state
== playing_paused
)
669 || !strcmp(id
, playing
->id
))) {
670 playing
->state
= playing_scratched
;
671 playing
->scratched
= who ?
xstrdup(who
) : 0;
672 if((pid
= find_player_pid(playing
->id
)) > 0) {
673 D(("kill -%d %lu", config
->signal
, (unsigned long)pid
));
674 kill(-pid
, config
->signal
);
675 forget_player_pid(playing
->id
);
677 error(0, "could not find PID for %s", playing
->id
);
678 if((playing
->type
& DISORDER_PLAYER_TYPEMASK
) == DISORDER_PLAYER_RAW
) {
679 memset(&sm
, 0, sizeof sm
);
681 strcpy(sm
.id
, playing
->id
);
682 speaker_send(speaker_fd
, &sm
);
683 D(("sending SM_CANCEL for %s", playing
->id
));
685 /* put a scratch track onto the front of the queue (but don't
686 * bother if playing is disabled) */
687 if(playing_is_enabled() && config
->scratch
.n
) {
688 int r
= rand() * (double)config
->scratch
.n
/ (RAND_MAX
+ 1.0);
689 q
= queue_add(config
->scratch
.s
[r
], who
, WHERE_START
);
690 q
->state
= playing_isscratch
;
692 notify_scratch(playing
->track
, playing
->submitter
, who
,
693 time(0) - playing
->played
);
697 void quitting(ev_source
*ev
) {
698 struct queue_entry
*q
;
701 /* Don't start anything new */
703 /* Shut down the current player */
705 if((pid
= find_player_pid(playing
->id
)) > 0) {
706 kill(-pid
, config
->signal
);
707 forget_player_pid(playing
->id
);
709 error(0, "could not find PID for %s", playing
->id
);
710 playing
->state
= playing_quitting
;
713 /* Zap any other players */
714 for(q
= qhead
.next
; q
!= &qhead
; q
= q
->next
)
715 if((pid
= find_player_pid(q
->id
)) > 0) {
716 D(("kill -%d %lu", config
->signal
, (unsigned long)pid
));
717 kill(-pid
, config
->signal
);
718 forget_player_pid(q
->id
);
720 error(0, "could not find PID for %s", q
->id
);
721 /* Don't need the speaker any more */
722 ev_fd_cancel(ev
, ev_read
, speaker_fd
);
726 int pause_playing(const char *who
) {
727 struct speaker_message sm
;
730 /* Can't pause if already paused or if nothing playing. */
731 if(!playing
|| paused
) return 0;
732 switch(playing
->type
& DISORDER_PLAYER_TYPEMASK
) {
733 case DISORDER_PLAYER_STANDALONE
:
734 if(!(playing
->type
& DISORDER_PLAYER_PAUSES
)) {
736 error(0, "cannot pause because player is not powerful enough");
739 if(play_pause(playing
->pl
, &played
, playing
->data
)) {
740 error(0, "player indicates it cannot pause");
743 time(&playing
->lastpaused
);
744 playing
->uptopause
= played
;
745 playing
->lastresumed
= 0;
747 case DISORDER_PLAYER_RAW
:
748 memset(&sm
, 0, sizeof sm
);
750 speaker_send(speaker_fd
, &sm
);
753 if(who
) info("paused by %s", who
);
754 notify_pause(playing
->track
, who
);
756 if(playing
->state
== playing_started
)
757 playing
->state
= playing_paused
;
758 eventlog("state", "pause", (char *)0);
762 void resume_playing(const char *who
) {
763 struct speaker_message sm
;
768 switch(playing
->type
& DISORDER_PLAYER_TYPEMASK
) {
769 case DISORDER_PLAYER_STANDALONE
:
770 if(!playing
->type
& DISORDER_PLAYER_PAUSES
) {
772 /* Shouldn't happen */
775 play_resume(playing
->pl
, playing
->data
);
776 time(&playing
->lastresumed
);
778 case DISORDER_PLAYER_RAW
:
779 memset(&sm
, 0, sizeof sm
);
781 speaker_send(speaker_fd
, &sm
);
784 if(who
) info("resumed by %s", who
);
785 notify_resume(playing
->track
, who
);
786 if(playing
->state
== playing_paused
)
787 playing
->state
= playing_started
;
788 eventlog("state", "resume", (char *)0);