chiark / gitweb /
More reliable gapless play.
[disorder] / server / play.c
index 3b3b928..93a7f48 100644 (file)
@@ -1,58 +1,26 @@
 /*
  * This file is part of DisOrder.
- * Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
+ * Copyright (C) 2004-2008 Richard Kettlewell
  *
- * This program is free software; you can redistribute it and/or modify
+ * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+/** @file server/play.c
+ * @brief Playing tracks
  */
 
-#include <config.h>
-#include "types.h"
-
-#include <sys/types.h>
-#include <sys/time.h>
-#include <unistd.h>
-#include <errno.h>
-#include <fnmatch.h>
-#include <time.h>
-#include <signal.h>
-#include <stdlib.h>
-#include <assert.h>
-#include <sys/socket.h>
-#include <string.h>
-#include <stdio.h>
-#include <pcre.h>
+#include "disorder-server.h"
 #include <ao/ao.h>
-#include <sys/wait.h>
-
-#include "event.h"
-#include "log.h"
-#include "mem.h"
-#include "configuration.h"
-#include "queue.h"
-#include "trackdb.h"
-#include "play.h"
-#include "plugin.h"
-#include "wstat.h"
-#include "eventlog.h"
-#include "logfd.h"
-#include "syscalls.h"
-#include "speaker-protocol.h"
-#include "disorder.h"
-#include "signame.h"
-#include "hash.h"
 
 #define SPEAKER "disorder-speaker"
 
@@ -87,17 +55,15 @@ static int speaker_terminated(ev_source attribute((unused)) *ev,
                              int attribute((unused)) status,
                              const struct rusage attribute((unused)) *rusage,
                              void attribute((unused)) *u) {
-  if(status)
-    error(0, "speaker subprocess terminated with status %s",
-         wstat(status));
-  return 0;
+  fatal(0, "speaker subprocess %s",
+       wstat(status));
 }
 
 /* called when speaker process has something to say */
 static int speaker_readable(ev_source *ev, int fd,
                            void attribute((unused)) *u) {
   struct speaker_message sm;
-  int ret = speaker_recv(fd, &sm, 0);
+  int ret = speaker_recv(fd, &sm);
   
   if(ret < 0) return 0;                        /* EAGAIN */
   if(!ret) {                           /* EOF */
@@ -110,10 +76,11 @@ static int speaker_readable(ev_source *ev, int fd,
     D(("SM_PAUSED %s %ld", sm.id, sm.data));
     playing->sofar = sm.data;
     break;
-  case SM_FINISHED:
-    /* the playing track finished */
-    D(("SM_FINISHED %s", sm.id));
-    finished(ev);
+  case SM_FINISHED:                    /* scratched the playing track */
+  case SM_STILLBORN:                   /* scratched too early */
+  case SM_UNKNOWN:                     /* scratched WAY too early */
+    if(playing && !strcmp(sm.id, playing->id))
+      finished(ev);
     break;
   case SM_PLAYING:
     /* track ID is playing, DATA seconds played */
@@ -127,15 +94,12 @@ static int speaker_readable(ev_source *ev, int fd,
 }
 
 void speaker_setup(ev_source *ev) {
-  int sp[2], lfd;
+  int sp[2];
   pid_t pid;
+  struct speaker_message sm;
 
   if(socketpair(PF_UNIX, SOCK_DGRAM, 0, sp) < 0)
     fatal(errno, "error calling socketpair");
-  if(!isatty(2))
-    lfd = logfd(ev, SPEAKER);
-  else
-    lfd = -1;
   if(!(pid = xfork())) {
     exitfn = _exit;
     ev_signal_atfork(ev);
@@ -143,17 +107,17 @@ void speaker_setup(ev_source *ev) {
     xdup2(sp[0], 1);
     xclose(sp[0]);
     xclose(sp[1]);
-    if(lfd != -1) {
-      xdup2(lfd, 2);
-      xclose(lfd);
-    }
     signal(SIGPIPE, SIG_DFL);
 #if 0
     execlp("valgrind", "valgrind", SPEAKER, "--config", configfile,
-          debugging ? "--debug" : "--no-debug", (char *)0);
+          debugging ? "--debug" : "--no-debug",
+          log_default == &log_syslog ? "--syslog" : "--no-syslog",
+          (char *)0);
 #else
     execlp(SPEAKER, SPEAKER, "--config", configfile,
-          debugging ? "--debug" : "--no-debug", (char *)0);
+          debugging ? "--debug" : "--no-debug",
+          log_default == &log_syslog ? "--syslog" : "--no-syslog",
+          (char *)0);
 #endif
     fatal(errno, "error invoking %s", SPEAKER);
   }
@@ -161,9 +125,11 @@ void speaker_setup(ev_source *ev) {
   speaker_fd = sp[1];
   xclose(sp[0]);
   cloexec(speaker_fd);
-  /* Don't need to make speaker_fd nonblocking because speaker_recv() uses
-   * MSG_DONTWAIT. */
-  ev_fd(ev, ev_read, speaker_fd, speaker_readable, 0);
+  /* Wait for the speaker to be ready */
+  speaker_recv(speaker_fd, &sm);
+  nonblock(speaker_fd);
+  if(ev_fd(ev, ev_read, speaker_fd, speaker_readable, 0, "speaker read") < 0)
+    fatal(0, "error registering speaker socket fd");
 }
 
 void speaker_reload(void) {
@@ -171,26 +137,7 @@ void speaker_reload(void) {
 
   memset(&sm, 0, sizeof sm);
   sm.type = SM_RELOAD;
-  speaker_send(speaker_fd, &sm, -1);
-}
-
-/* timeout for play retry */
-static int play_again(ev_source *ev,
-                     const struct timeval attribute((unused)) *now,
-                     void attribute((unused)) *u) {
-  D(("play_again"));
-  play(ev);
-  return 0;
-}
-
-/* try calling play() again after @offset@ seconds */
-static void retry_play(ev_source *ev, int offset) {
-  struct timeval w;
-
-  D(("retry_play(%d)", offset));
-  gettimeofday(&w, 0);
-  w.tv_sec += offset;
-  ev_timeout(ev, 0, &w, play_again, 0);
+  speaker_send(speaker_fd, &sm);
 }
 
 /* Called when the currently playing track finishes playing.  This
@@ -219,7 +166,10 @@ static void finished(ev_source *ev) {
   recent_write();
   forget_player_pid(playing->id);
   playing = 0;
-  if(ev) retry_play(ev, config->gap);
+  /* Try to play something else */
+  /* TODO re-support config->gap? */
+  if(ev)
+    play(ev);
 }
 
 /* Called when a player terminates. */
@@ -240,9 +190,9 @@ static int player_finished(ev_source *ev,
   switch(q->state) {
   case playing_unplayed:
   case playing_random:
-    /* If this was an SM_PREPARE track then either it failed or we deliberately
-     * stopped it because it was removed from the queue or moved down it.  So
-     * leave it state alone for future use. */
+    /* If this was a pre-prepared track then either it failed or we
+     * deliberately stopped it because it was removed from the queue or moved
+     * down it.  So leave it state alone for future use. */
     break;
   default:
     /* We actually started playing this track. */
@@ -283,17 +233,22 @@ static int find_player(const struct queue_entry *q) {
 }
 
 /* Return values from start() */
-#define START_OK 0                     /* Succeeded. */
-#define START_HARDFAIL 1               /* Track is broken. */
-#define START_SOFTFAIL 2          /* Track OK, system (temporarily?) broken */
-
-/* Play or prepare Q */
+#define START_OK 0                     /**< @brief Succeeded. */
+#define START_HARDFAIL 1               /**< @brief Track is broken. */
+#define START_SOFTFAIL 2          /**< @brief Track OK, system (temporarily?) broken */
+
+/** @brief Play or prepare @p q
+ * @param ev Event loop
+ * @param q Track to play/prepare
+ * @param prepare_only If true, only prepares track
+ * @return @ref START_OK, @ref START_HARDFAIL or @ref START_SOFTFAIL
+ */
 static int start(ev_source *ev,
                 struct queue_entry *q,
-                int smop) {
+                int prepare_only) {
   int n, lfd;
   const char *p;
-  int np[2], sp[2];
+  int np[2], sfd;
   struct speaker_message sm;
   char buffer[64];
   int optc;
@@ -304,16 +259,21 @@ static int start(ev_source *ev,
   const char *waitdevice = 0;
   const char *const *optv;
   pid_t pid, npid;
+  struct sockaddr_un addr;
+  uint32_t l;
 
   memset(&sm, 0, sizeof sm);
-  if(find_player_pid(q->id) > 0) {
-    if(smop == SM_PREPARE) return START_OK;
-    /* We have already sent an SM_PREPARE for this track so we just need to
-     * tell the speaker process to start actually playing the queued up audio
-     * data */
-    strcpy(sm.id, q->id);
-    sm.type = SM_PLAY;
-    speaker_send(speaker_fd, &sm, -1);
+  D(("start %s %d", q->id, prepare_only));
+  if(q->prepared) {
+    /* The track is alraedy prepared */
+    if(!prepare_only) {
+      /* We want to run it, since it's prepared the answer is to tell the
+       * speaker to set it off */
+      strcpy(sm.id, q->id);
+      sm.type = SM_PLAY;
+      speaker_send(speaker_fd, &sm);
+      D(("sent SM_PLAY for %s", sm.id));
+    }
     return START_OK;
   }
   /* Find the player plugin. */
@@ -322,7 +282,7 @@ static int start(ev_source *ev,
     return START_HARDFAIL;
   q->type = play_get_type(q->pl);
   /* Can't prepare non-raw tracks. */
-  if(smop == SM_PREPARE
+  if(prepare_only
      && (q->type & DISORDER_PLAYER_TYPEMASK) != DISORDER_PLAYER_RAW)
     return START_OK;
   /* Call the prefork function. */
@@ -334,8 +294,11 @@ static int start(ev_source *ev,
     }
   /* Use the second arg as the tag if available (it's probably a command name),
    * otherwise the module name. */
-  lfd = logfd(ev, (config->player.s[n].s[2]
-                  ? config->player.s[n].s[2] : config->player.s[n].s[1]));
+  if(!isatty(2))
+    lfd = logfd(ev, (config->player.s[n].s[2]
+                    ? config->player.s[n].s[2] : config->player.s[n].s[1]));
+  else
+    lfd = -1;
   optc = config->player.s[n].n - 2;
   optv = (void *)&config->player.s[n].s[2];
   while(optc > 0 && optv[0][0] == '-') {
@@ -360,59 +323,86 @@ static int start(ev_source *ev,
   switch(pid = fork()) {
   case 0:                      /* child */
     exitfn = _exit;
+    progname = "disorderd-fork";
     ev_signal_atfork(ev);
     signal(SIGPIPE, SIG_DFL);
-    xdup2(lfd, 1);
-    xdup2(lfd, 2);
-    xclose(lfd);                       /* tidy up */
+    if(lfd != -1) {
+      xdup2(lfd, 1);
+      xdup2(lfd, 2);
+      xclose(lfd);                     /* tidy up */
+    }
     setpgid(0, 0);
     if((q->type & DISORDER_PLAYER_TYPEMASK) == DISORDER_PLAYER_RAW) {
-      /* "Raw" format players need special treatment:
-       * 1) their output needs to go via the disorder-normalize process
-       * 2) the output of that needs to be passed to the disorder-speaker
-       *    process.
+      /* "Raw" format players always have their output send down a pipe
+       * to the disorder-normalize process.  This will connect to the
+       * speaker process to actually play the audio data.
        */
       /* np will be the pipe to disorder-normalize */
       if(socketpair(PF_UNIX, SOCK_STREAM, 0, np) < 0)
        fatal(errno, "error calling socketpair");
-      xshutdown(np[0], SHUT_WR);       /* normalize reads from np[0] */
+      /* Beware of the Leopard!  On OS X 10.5.x, the order of the shutdown
+       * calls here DOES MATTER.  If you do the SHUT_WR first then the SHUT_RD
+       * fails with "Socket is not connected".  I think this is a bug but
+       * provided implementors either don't care about the order or all agree
+       * about the order, choosing the reliable order is an adequate
+       * workaround.  */
       xshutdown(np[1], SHUT_RD);       /* decoder writes to np[1] */
-      /* sp will be the pipe to disorder-speaker */
-      sm.type = smop;
-      if(socketpair(PF_UNIX, SOCK_STREAM, 0, sp) < 0)
-       fatal(errno, "error calling socketpair");
-      xshutdown(sp[0], SHUT_WR);       /* speaker reads from sp[0] */
-      xshutdown(sp[1], SHUT_RD);       /* normalize writes to sp[1] */
+      xshutdown(np[0], SHUT_WR);       /* normalize reads from np[0] */
+      blocking(np[0]);
+      blocking(np[1]);
       /* Start disorder-normalize */
       if(!(npid = xfork())) {
        if(!xfork()) {
+         /* Connect to the speaker process */
+         memset(&addr, 0, sizeof addr);
+         addr.sun_family = AF_UNIX;
+         snprintf(addr.sun_path, sizeof addr.sun_path,
+                  "%s/speaker/socket", config->home);
+         sfd = xsocket(PF_UNIX, SOCK_STREAM, 0);
+         if(connect(sfd, (const struct sockaddr *)&addr, sizeof addr) < 0)
+           fatal(errno, "connecting to %s", addr.sun_path);
+         l = strlen(q->id);
+         if(write(sfd, &l, sizeof l) < 0
+            || write(sfd, q->id, l) < 0)
+           fatal(errno, "writing to %s", addr.sun_path);
+         /* Await the ack */
+         if (read(sfd, &l, 1) < 0) 
+               fatal(errno, "reading ack from %s", addr.sun_path);
+         /* Plumbing */
          xdup2(np[0], 0);
-         xdup2(sp[1], 1);
+         xdup2(sfd, 1);
          xclose(np[0]);
          xclose(np[1]);
-         xclose(sp[0]);
-         xclose(sp[1]);
-         execlp("disorder-normalize", "disorder-normalize", (char *)0);
+         xclose(sfd);
+         /* Ask the speaker to actually start playing the track; we do it here
+          * so it's definitely after ack. */
+         if(!prepare_only) {
+           strcpy(sm.id, q->id);
+           sm.type = SM_PLAY;
+           speaker_send(speaker_fd, &sm);
+           D(("sent SM_PLAY for %s", sm.id));
+         }
+         /* TODO stderr shouldn't be redirected for disorder-normalize
+          * (but it should be for play_track() */
+         execlp("disorder-normalize", "disorder-normalize",
+                log_default == &log_syslog ? "--syslog" : "--no-syslog",
+                "--config", configfile,
+                (char *)0);
          fatal(errno, "executing disorder-normalize");
+         /* end of the innermost fork */
        }
        _exit(0);
-      } else {
-       int w;
-
-       while(waitpid(npid, &w, 0) < 0 && errno == EINTR)
-         ;
+       /* end of the middle fork */
       }
-      /* Send the speaker process the file descriptor to read from */
-      strcpy(sm.id, q->id);
-      speaker_send(speaker_fd, &sm, sp[0]);
+      /* Wait for the middle fork to finish */
+      while(waitpid(npid, &n, 0) < 0 && errno == EINTR)
+       ;
       /* Pass the file descriptor to the driver in an environment
        * variable. */
       snprintf(buffer, sizeof buffer, "DISORDER_RAW_FD=%d", np[1]);
       if(putenv(buffer) < 0)
        fatal(errno, "error calling putenv");
       /* Close all the FDs we don't need */
-      xclose(sp[0]);
-      xclose(sp[1]);
       xclose(np[0]);
     }
     if(waitdevice) {
@@ -446,11 +436,14 @@ static int start(ev_source *ev,
     error(errno, "error calling fork");
     if(q->type & DISORDER_PLAYER_PREFORK)
       play_cleanup(q->pl, q->data);    /* else would leak */
-    xclose(lfd);
+    if(lfd != -1)
+      xclose(lfd);
     return START_SOFTFAIL;
   }
   store_player_pid(q->id, pid);
-  xclose(lfd);
+  q->prepared = 1;
+  if(lfd != -1)
+    xclose(lfd);
   setpgid(pid, pid);
   ev_child(ev, pid, 0, player_finished, q);
   D(("player subprocess ID %lu", (unsigned long)pid));
@@ -468,7 +461,7 @@ int prepare(ev_source *ev,
   q->type = play_get_type(q->pl);
   if((q->type & DISORDER_PLAYER_TYPEMASK) != DISORDER_PLAYER_RAW)
     return 0;                          /* Not a raw player */
-  return start(ev, q, SM_PREPARE);     /* Prepare it */
+  return start(ev, q, 1/*prepare_only*/); /* Prepare it */
 }
 
 void abandon(ev_source attribute((unused)) *ev,
@@ -486,37 +479,43 @@ void abandon(ev_source attribute((unused)) *ev,
   memset(&sm, 0, sizeof sm);
   sm.type = SM_CANCEL;
   strcpy(sm.id, q->id);
-  speaker_send(speaker_fd, &sm, -1);
+  speaker_send(speaker_fd, &sm);
 }
 
-int add_random_track(void) {
+/** @brief Called with a new random track
+ * @param ev Event loop
+ * @param track Track name
+ */
+static void chosen_random_track(ev_source *ev,
+                               const char *track) {
+  struct queue_entry *q;
+
+  if(!track)
+    return;
+  /* Add the track to the queue */
+  q = queue_add(track, 0, WHERE_END, origin_random);
+  D(("picked %p (%s) at random", (void *)q, q->track));
+  queue_write();
+  /* Maybe a track can now be played */
+  play(ev);
+}
+
+/** @brief Maybe add a randomly chosen track
+ * @param ev Event loop
+ */
+void add_random_track(ev_source *ev) {
   struct queue_entry *q;
-  const char *p;
   long qlen = 0;
-  int rc = 0;
 
   /* If random play is not enabled then do nothing. */
   if(shutting_down || !random_is_enabled())
-    return 0;
+    return;
   /* Count how big the queue is */
   for(q = qhead.next; q != &qhead; q = q->next)
     ++qlen;
-  /* Add random tracks until the queue is at the right size */
-  while(qlen < config->queue_pad) {
-    /* Try to pick a random track */
-    if(!(p = trackdb_random(16))) {
-      rc = -1;
-      break;
-    }
-    /* Add it to the end of the queue. */
-    q = queue_add(p, 0, WHERE_END);
-    q->state = playing_random;
-    D(("picked %p (%s) at random", (void *)q, q->track));
-    ++qlen;
-  }
-  /* Commit the queue */
-  queue_write();
-  return rc;
+  /* If it's smaller than the desired size then add a track */
+  if(qlen < config->queue_pad)
+    trackdb_request_random(ev, chosen_random_track);
 }
 
 /* try to play a track */
@@ -526,44 +525,35 @@ void play(ev_source *ev) {
 
   D(("play playing=%p", (void *)playing));
   if(shutting_down || playing || !playing_is_enabled()) return;
-  /* If the queue is empty then add a random track. */
+  /* See if there's anything to play */
   if(qhead.next == &qhead) {
-    if(!random_enabled)
-      return;
-    if(add_random_track()) {
-      /* On error, try again in 10s. */
-      retry_play(ev, 10);
-      return;
-    }
-    /* Now there must be at least one track in the queue. */
+    /* Queue is empty.  We could just wait around since there are periodic
+     * attempts to add a random track anyway.  However they are rarer than
+     * attempts to force a track so we initiate one now. */
+    add_random_track(ev);
+    return;
   }
+  /* There must be at least one track in the queue. */
   q = qhead.next;
-  /* If random play is disabled but the track is a random one then don't play
-   * it.  play() will be called again when random play is re-enabled. */
-  if(!random_enabled && q->state == playing_random)
+  /* If random play is disabled but the track is a non-adopted random one
+   * then don't play it.  play() will be called again when random play is
+   * re-enabled. */
+  if(!random_enabled && q->origin == origin_random)
     return;
   D(("taken %p (%s) from queue", (void *)q, q->track));
   /* Try to start playing. */
-  switch(start(ev, q, SM_PLAY)) {
+  switch(start(ev, q, 0/*!prepare_only*/)) {
   case START_HARDFAIL:
     if(q == qhead.next) {
       queue_remove(q, 0);              /* Abandon this track. */
       queue_played(q);
       recent_write();
     }
-    if(qhead.next == &qhead)
-      /* Queue is empty, wait a bit before trying something else (so we don't
-       * sit there looping madly in the presence of persistent problem).  Note
-       * that we might not reliably get a random track lookahead in this case,
-       * but if we get here then really there are bigger problems. */
-      retry_play(ev, 1);
-    else
-      /* More in queue, try again now. */
-      play(ev);
+    /* Oh well, try the next one */
+    play(ev);
     break;
   case START_SOFTFAIL:
-    /* Try same track again in a bit. */
-    retry_play(ev, 10);
+    /* We'll try the same track again shortly. */
     break;
   case START_OK:
     if(q == qhead.next) {
@@ -578,7 +568,7 @@ void play(ev_source *ev) {
             playing->submitter ? playing->submitter : (const char *)0,
             (const char *)0);
     /* Maybe add a random track. */
-    add_random_track();
+    add_random_track(ev);
     /* If there is another track in the queue prepare it now.  This could
      * potentially be a just-added random track. */
     if(qhead.next != &qhead)
@@ -596,7 +586,7 @@ int playing_is_enabled(void) {
 void enable_playing(const char *who, ev_source *ev) {
   trackdb_set_global("playing", "yes", who);
   /* Add a random track if necessary. */
-  add_random_track();
+  add_random_track(ev);
   play(ev);
 }
 
@@ -612,7 +602,7 @@ int random_is_enabled(void) {
 
 void enable_random(const char *who, ev_source *ev) {
   trackdb_set_global("random-play", "yes", who);
-  add_random_track();
+  add_random_track(ev);
   play(ev);
 }
 
@@ -647,15 +637,14 @@ void scratch(const char *who, const char *id) {
       memset(&sm, 0, sizeof sm);
       sm.type = SM_CANCEL;
       strcpy(sm.id, playing->id);
-      speaker_send(speaker_fd, &sm, -1);
+      speaker_send(speaker_fd, &sm);
       D(("sending SM_CANCEL for %s", playing->id));
     }
     /* put a scratch track onto the front of the queue (but don't
      * bother if playing is disabled) */
     if(playing_is_enabled() && config->scratch.n) {
       int r = rand() * (double)config->scratch.n / (RAND_MAX + 1.0);
-      q = queue_add(config->scratch.s[r], who, WHERE_START);
-      q->state = playing_isscratch;
+      q = queue_add(config->scratch.s[r], who, WHERE_START, origin_scratch);
     }
     notify_scratch(playing->track, playing->submitter, who,
                   time(0) - playing->played);
@@ -715,7 +704,7 @@ int pause_playing(const char *who) {
   case DISORDER_PLAYER_RAW:
     memset(&sm, 0, sizeof sm);
     sm.type = SM_PAUSE;
-    speaker_send(speaker_fd, &sm, -1);
+    speaker_send(speaker_fd, &sm);
     break;
   }
   if(who) info("paused by %s", who);
@@ -746,7 +735,7 @@ void resume_playing(const char *who) {
   case DISORDER_PLAYER_RAW:
     memset(&sm, 0, sizeof sm);
     sm.type = SM_RESUME;
-    speaker_send(speaker_fd, &sm, -1);
+    speaker_send(speaker_fd, &sm);
     break;
   }
   if(who) info("resumed by %s", who);