chiark - git - mdw - disorder/blob - server/speaker-network.c

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2005, 2006, 2007 Richard Kettlewell
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  * USA
  19  */
  20 /** @file server/speaker-network.c
  21  * @brief Support for @ref BACKEND_NETWORK */
  22
  23 #include <config.h>
  24 #include "types.h"
  25
  26 #include <unistd.h>
  27 #include <poll.h>
  28 #include <netdb.h>
  29 #include <gcrypt.h>
  30 #include <sys/socket.h>
  31 #include <sys/uio.h>
  32 #include <assert.h>
  33 #include <sys/ioctl.h>
  34 #include <net/if.h>
  35
  36 #include "configuration.h"
  37 #include "syscalls.h"
  38 #include "log.h"
  39 #include "addr.h"
  40 #include "timeval.h"
  41 #include "rtp.h"
  42 #include "ifreq.h"
  43 #include "speaker-protocol.h"
  44 #include "speaker.h"
  45
  46 /** @brief Network socket
  47  *
  48  * This is the file descriptor to write to for @ref BACKEND_NETWORK.
  49  */
  50 static int bfd = -1;
  51
  52 /** @brief RTP timestamp
  53  *
  54  * This counts the number of samples played (NB not the number of frames
  55  * played).
  56  *
  57  * The timestamp in the packet header is only 32 bits wide.  With 44100Hz
  58  * stereo, that only gives about half a day before wrapping, which is not
  59  * particularly convenient for certain debugging purposes.  Therefore the
  60  * timestamp is maintained as a 64-bit integer, giving around six million years
  61  * before wrapping, and truncated to 32 bits when transmitting.
  62  */
  63 static uint64_t rtp_time;
  64
  65 /** @brief RTP base timestamp
  66  *
  67  * This is the real time correspoding to an @ref rtp_time of 0.  It is used
  68  * to recalculate the timestamp after idle periods.
  69  */
  70 static struct timeval rtp_time_0;
  71
  72 /** @brief RTP packet sequence number */
  73 static uint16_t rtp_seq;
  74
  75 /** @brief RTP SSRC */
  76 static uint32_t rtp_id;
  77
  78 /** @brief Error counter */
  79 static int audio_errors;
  80
  81 /** @brief Network backend initialization */
  82 static void network_init(void) {
  83   struct addrinfo *res, *sres;
  84   static const struct addrinfo pref = {
  85     0,
  86     PF_INET,
  87     SOCK_DGRAM,
  88     IPPROTO_UDP,
  89     0,
  90     0,
  91     0,
  92     0
  93   };
  94   static const struct addrinfo prefbind = {
  95     AI_PASSIVE,
  96     PF_INET,
  97     SOCK_DGRAM,
  98     IPPROTO_UDP,
  99     0,
 100     0,
 101     0,
 102     0
 103   };
 104   static const int one = 1;
 105   int sndbuf, target_sndbuf = 131072, n;
 106   socklen_t len;
 107   char *sockname, *ssockname;
 108
 109   /* Override sample format */
 110   config->sample_format.rate = 44100;
 111   config->sample_format.channels = 2;
 112   config->sample_format.bits = 16;
 113   config->sample_format.byte_format = AO_FMT_BIG;
 114   res = get_address(&config->broadcast, &pref, &sockname);
 115   if(!res) exit(-1);
 116   if(config->broadcast_from.n) {
 117     sres = get_address(&config->broadcast_from, &prefbind, &ssockname);
 118     if(!sres) exit(-1);
 119   } else
 120     sres = 0;
 121   if((bfd = socket(res->ai_family,
 122                    res->ai_socktype,
 123                    res->ai_protocol)) < 0)
 124     fatal(errno, "error creating broadcast socket");
 125   if((res->ai_family == PF_INET
 126       && IN_MULTICAST(
 127            ntohl(((struct sockaddr_in *)res->ai_addr)->sin_addr.s_addr)
 128          ))
 129      || (res->ai_family == PF_INET6
 130          && IN6_IS_ADDR_MULTICAST(
 131                &((struct sockaddr_in6 *)res->ai_addr)->sin6_addr
 132             ))) {
 133     /* Multicasting */
 134     switch(res->ai_family) {
 135     case PF_INET: {
 136       const int mttl = config->multicast_ttl;
 137       if(setsockopt(bfd, IPPROTO_IP, IP_MULTICAST_TTL, &mttl, sizeof mttl) < 0)
 138         fatal(errno, "error setting IP_MULTICAST_TTL on multicast socket");
 139       break;
 140     }
 141     case PF_INET6: {
 142       const int mttl = config->multicast_ttl;
 143       if(setsockopt(bfd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS,
 144                     &mttl, sizeof mttl) < 0)
 145         fatal(errno, "error setting IPV6_MULTICAST_HOPS on multicast socket");
 146       break;
 147     }
 148     default:
 149       fatal(0, "unsupported address family %d", res->ai_family);
 150     }
 151     info("multicasting on %s", sockname);
 152   } else {
 153     struct ifreq *ifs;
 154     int nifs;
 155
 156     /* See if the address matches the broadcast address of some interface */
 157     ifreq_list(bfd, &ifs, &nifs);
 158     for(n = 0; n < nifs; ++n) {
 159       if(ioctl(bfd, SIOCGIFBRDADDR, &ifs[n]) < 0)
 160         fatal(errno, "error calling ioctl SIOCGIFBRDADDR");
 161       if(sockaddr_equal(&ifs[n].ifr_broadaddr, res->ai_addr))
 162         break;
 163     }
 164     if(n < nifs) {
 165       if(setsockopt(bfd, SOL_SOCKET, SO_BROADCAST, &one, sizeof one) < 0)
 166         fatal(errno, "error setting SO_BROADCAST on broadcast socket");
 167       info("broadcasting on %s (%s)", sockname, ifs[n].ifr_name);
 168     } else
 169       info("unicasting on %s", sockname);
 170   }
 171   len = sizeof sndbuf;
 172   if(getsockopt(bfd, SOL_SOCKET, SO_SNDBUF,
 173                 &sndbuf, &len) < 0)
 174     fatal(errno, "error getting SO_SNDBUF");
 175   if(target_sndbuf > sndbuf) {
 176     if(setsockopt(bfd, SOL_SOCKET, SO_SNDBUF,
 177                   &target_sndbuf, sizeof target_sndbuf) < 0)
 178       error(errno, "error setting SO_SNDBUF to %d", target_sndbuf);
 179     else
 180       info("changed socket send buffer size from %d to %d",
 181            sndbuf, target_sndbuf);
 182   } else
 183     info("default socket send buffer is %d",
 184          sndbuf);
 185   /* We might well want to set additional broadcast- or multicast-related
 186    * options here */
 187   if(sres && bind(bfd, sres->ai_addr, sres->ai_addrlen) < 0)
 188     fatal(errno, "error binding broadcast socket to %s", ssockname);
 189   if(connect(bfd, res->ai_addr, res->ai_addrlen) < 0)
 190     fatal(errno, "error connecting broadcast socket to %s", sockname);
 191   /* Select an SSRC */
 192   gcry_randomize(&rtp_id, sizeof rtp_id, GCRY_STRONG_RANDOM);
 193   info("selected network backend, sending to %s", sockname);
 194 }
 195
 196 /** @brief Play over the network */
 197 static size_t network_play(size_t frames) {
 198   struct rtp_header header;
 199   struct iovec vec[2];
 200   size_t bytes = frames * device_bpf, written_frames;
 201   int written_bytes;
 202   /* We transmit using RTP (RFC3550) and attempt to conform to the internet
 203    * AVT profile (RFC3551). */
 204
 205   if(idled) {
 206     /* There may have been a gap.  Fix up the RTP time accordingly. */
 207     struct timeval now;
 208     uint64_t delta;
 209     uint64_t target_rtp_time;
 210
 211     /* Find the current time */
 212     xgettimeofday(&now, 0);
 213     /* Find the number of microseconds elapsed since rtp_time=0 */
 214     delta = tvsub_us(now, rtp_time_0);
 215     assert(delta <= UINT64_MAX / 88200);
 216     target_rtp_time = (delta * playing->format.rate
 217                        * playing->format.channels) / 1000000;
 218     /* Overflows at ~6 years uptime with 44100Hz stereo */
 219
 220     /* rtp_time is the number of samples we've played.  NB that we play
 221      * RTP_AHEAD_MS ahead of ourselves, so it may legitimately be ahead of
 222      * the value we deduce from time comparison.
 223      *
 224      * Suppose we have 1s track started at t=0, and another track begins to
 225      * play at t=2s.  Suppose RTP_AHEAD_MS=1000 and 44100Hz stereo.  In that
 226      * case we'll send 1s of audio as fast as we can, giving rtp_time=88200.
 227      * rtp_time stops at this point.
 228      *
 229      * At t=2s we'll have calculated target_rtp_time=176400.  In this case we
 230      * set rtp_time=176400 and the player can correctly conclude that it
 231      * should leave 1s between the tracks.
 232      *
 233      * Suppose instead that the second track arrives at t=0.5s, and that
 234      * we've managed to transmit the whole of the first track already.  We'll
 235      * have target_rtp_time=44100.
 236      *
 237      * The desired behaviour is to play the second track back to back with
 238      * first.  In this case therefore we do not modify rtp_time.
 239      *
 240      * Is it ever right to reduce rtp_time?  No; for that would imply
 241      * transmitting packets with overlapping timestamp ranges, which does not
 242      * make sense.
 243      */
 244     target_rtp_time &= ~(uint64_t)1;    /* stereo! */
 245     if(target_rtp_time > rtp_time) {
 246       /* More time has elapsed than we've transmitted samples.  That implies
 247        * we've been 'sending' silence.  */
 248       info("advancing rtp_time by %"PRIu64" samples",
 249            target_rtp_time - rtp_time);
 250       rtp_time = target_rtp_time;
 251     } else if(target_rtp_time < rtp_time) {
 252       const int64_t samples_ahead = ((uint64_t)RTP_AHEAD_MS
 253                                      * config->sample_format.rate
 254                                      * config->sample_format.channels
 255                                      / 1000);
 256
 257       if(target_rtp_time + samples_ahead < rtp_time) {
 258         info("reversing rtp_time by %"PRIu64" samples",
 259              rtp_time - target_rtp_time);
 260       }
 261     }
 262   }
 263   header.vpxcc = 2 << 6;              /* V=2, P=0, X=0, CC=0 */
 264   header.seq = htons(rtp_seq++);
 265   header.timestamp = htonl((uint32_t)rtp_time);
 266   header.ssrc = rtp_id;
 267   header.mpt = (idled ? 0x80 : 0x00) | 10;
 268   /* 10 = L16 = 16-bit x 2 x 44100KHz.  We ought to deduce this value from
 269    * the sample rate (in a library somewhere so that configuration.c can rule
 270    * out invalid rates).
 271    */
 272   idled = 0;
 273   if(bytes > NETWORK_BYTES - sizeof header) {
 274     bytes = NETWORK_BYTES - sizeof header;
 275     /* Always send a whole number of frames */
 276     bytes -= bytes % device_bpf;
 277   }
 278   /* "The RTP clock rate used for generating the RTP timestamp is independent
 279    * of the number of channels and the encoding; it equals the number of
 280    * sampling periods per second.  For N-channel encodings, each sampling
 281    * period (say, 1/8000 of a second) generates N samples. (This terminology
 282    * is standard, but somewhat confusing, as the total number of samples
 283    * generated per second is then the sampling rate times the channel
 284    * count.)"
 285    */
 286   vec[0].iov_base = (void *)&header;
 287   vec[0].iov_len = sizeof header;
 288   vec[1].iov_base = playing->buffer + playing->start;
 289   vec[1].iov_len = bytes;
 290   do {
 291     written_bytes = writev(bfd, vec, 2);
 292   } while(written_bytes < 0 && errno == EINTR);
 293   if(written_bytes < 0) {
 294     error(errno, "error transmitting audio data");
 295     ++audio_errors;
 296     if(audio_errors == 10)
 297       fatal(0, "too many audio errors");
 298     return 0;
 299   } else
 300     audio_errors /= 2;
 301   written_bytes -= sizeof (struct rtp_header);
 302   written_frames = written_bytes / device_bpf;
 303   /* Advance RTP's notion of the time */
 304   rtp_time += written_frames * playing->format.channels;
 305   return written_frames;
 306 }
 307
 308 static int bfd_slot;
 309
 310 /** @brief Set up poll array for network play */
 311 static void network_beforepoll(void) {
 312   struct timeval now;
 313   uint64_t target_us;
 314   uint64_t target_rtp_time;
 315   const int64_t samples_ahead = ((uint64_t)RTP_AHEAD_MS
 316                                  * config->sample_format.rate
 317                                  * config->sample_format.channels
 318                                  / 1000);
 319
 320   /* If we're starting then initialize the base time */
 321   if(!rtp_time)
 322     xgettimeofday(&rtp_time_0, 0);
 323   /* We send audio data whenever we get RTP_AHEAD seconds or more
 324    * behind */
 325   xgettimeofday(&now, 0);
 326   target_us = tvsub_us(now, rtp_time_0);
 327   assert(target_us <= UINT64_MAX / 88200);
 328   target_rtp_time = (target_us * config->sample_format.rate
 329                                * config->sample_format.channels)
 330                      / 1000000;
 331   if((int64_t)(rtp_time - target_rtp_time) < samples_ahead)
 332     bfd_slot = addfd(bfd, POLLOUT);
 333 }
 334
 335 /** @brief Process poll() results for network play */
 336 static int network_ready(void) {
 337   if(fds[bfd_slot].revents & (POLLOUT | POLLERR))
 338     return 1;
 339   else
 340     return 0;
 341 }
 342
 343 const struct speaker_backend network_backend = {
 344   BACKEND_NETWORK,
 345   FIXED_FORMAT,
 346   network_init,
 347   0,                                    /* activate */
 348   network_play,
 349   0,                                    /* deactivate */
 350   network_beforepoll,
 351   network_ready
 352 };
 353
 354 /*
 355 Local Variables:
 356 c-basic-offset:2
 357 comment-column:40
 358 fill-column:79
 359 indent-tabs-mode:nil
 360 End:
 361 */