chiark - git - mdw - disorder/blob - lib/uaudio-rtp.c

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2009, 2013 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 3 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,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU 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, see <http://www.gnu.org/licenses/>.
  17  */
  18 /** @file lib/uaudio-rtp.c
  19  * @brief Support for RTP network play backend */
  20 #include "common.h"
  21
  22 #include <errno.h>
  23 #include <sys/socket.h>
  24 #include <ifaddrs.h>
  25 #include <net/if.h>
  26 #include <arpa/inet.h>
  27 #include <netinet/in.h>
  28 #include <gcrypt.h>
  29 #include <unistd.h>
  30 #include <time.h>
  31 #include <sys/uio.h>
  32 #include <pthread.h>
  33
  34 #include "uaudio.h"
  35 #include "mem.h"
  36 #include "log.h"
  37 #include "syscalls.h"
  38 #include "rtp.h"
  39 #include "addr.h"
  40 #include "ifreq.h"
  41 #include "timeval.h"
  42 #include "configuration.h"
  43
  44 /** @brief Bytes to send per network packet
  45  *
  46  * This is the maximum number of bytes we pass to write(2); to determine actual
  47  * packet sizes, add a UDP header and an IP header (and a link layer header if
  48  * it's the link layer size you care about).
  49  *
  50  * Don't make this too big or arithmetic will start to overflow.
  51  */
  52 #define NETWORK_BYTES (1500-8/*UDP*/-40/*IP*/-8/*conservatism*/)
  53
  54 /** @brief RTP payload type */
  55 static int rtp_payload;
  56
  57 /** @brief RTP output socket */
  58 static int rtp_fd = -1;
  59
  60 /** @brief RTP output socket (IPv6) */
  61 static int rtp_fd6;
  62 /** @brief RTP unicast output socket (IPv6) */
  63 static int rtp_fd6 = -1;
  64
  65 /** @brief RTP SSRC */
  66 static uint32_t rtp_id;
  67
  68 /** @brief Base for timestamp */
  69 static uint32_t rtp_base;
  70
  71 /** @brief RTP sequence number */
  72 static uint16_t rtp_sequence;
  73
  74 /** @brief Network error count
  75  *
  76  * If too many errors occur in too short a time, we give up.
  77  */
  78 static int rtp_errors;
  79
  80 /** @brief RTP mode */
  81 static int rtp_mode;
  82
  83 #define RTP_BROADCAST 1
  84 #define RTP_MULTICAST 2
  85 #define RTP_UNICAST 3
  86 #define RTP_REQUEST 4
  87 #define RTP_AUTO 5
  88
  89 /** @brief A unicast client */
  90 struct rtp_recipient {
  91   struct rtp_recipient *next;
  92   struct sockaddr_storage sa;
  93 };
  94
  95 /** @brief List of unicast clients */
  96 static struct rtp_recipient *rtp_recipient_list;
  97
  98 /** @brief Mutex protecting data structures */
  99 static pthread_mutex_t rtp_lock = PTHREAD_MUTEX_INITIALIZER;
 100
 101 static const char *const rtp_options[] = {
 102   "rtp-destination",
 103   "rtp-destination-port",
 104   "rtp-source",
 105   "rtp-source-port",
 106   "multicast-ttl",
 107   "multicast-loop",
 108   "rtp-mode",
 109   NULL
 110 };
 111
 112 static void rtp_get_netconfig(const char *af,
 113                               const char *addr,
 114                               const char *port,
 115                               struct netaddress *na) {
 116   char *vec[3];
 117
 118   vec[0] = uaudio_get(af, NULL);
 119   vec[1] = uaudio_get(addr, NULL);
 120   vec[2] = uaudio_get(port, NULL);
 121   if(!*vec)
 122     na->af = -1;
 123   else
 124     if(netaddress_parse(na, 3, vec))
 125       disorder_fatal(0, "invalid RTP address");
 126 }
 127
 128 static void rtp_set_netconfig(const char *af,
 129                               const char *addr,
 130                               const char *port,
 131                               const struct netaddress *na) {
 132   uaudio_set(af, NULL);
 133   uaudio_set(addr, NULL);
 134   uaudio_set(port, NULL);
 135   if(na->af != -1) {
 136     int nvec;
 137     char **vec;
 138
 139     netaddress_format(na, &nvec, &vec);
 140     if(nvec > 0) {
 141       uaudio_set(af, vec[0]);
 142       xfree(vec[0]);
 143     }
 144     if(nvec > 1) {
 145       uaudio_set(addr, vec[1]);
 146       xfree(vec[1]);
 147     }
 148     if(nvec > 2) {
 149       uaudio_set(port, vec[2]);
 150       xfree(vec[2]);
 151     }
 152     xfree(vec);
 153   }
 154 }
 155
 156 static size_t rtp_play(void *buffer, size_t nsamples, unsigned flags) {
 157   struct rtp_header header;
 158   struct iovec vec[2];
 159
 160 #if 0
 161   if(flags & (UAUDIO_PAUSE|UAUDIO_RESUME))
 162     fprintf(stderr, "rtp_play %zu samples%s%s%s%s\n", nsamples,
 163             flags & UAUDIO_PAUSE ? " UAUDIO_PAUSE" : "",
 164             flags & UAUDIO_RESUME ? " UAUDIO_RESUME" : "",
 165             flags & UAUDIO_PLAYING ? " UAUDIO_PLAYING" : "",
 166             flags & UAUDIO_PAUSED ? " UAUDIO_PAUSED" : "");
 167 #endif
 168
 169   /* We do as much work as possible before checking what time it is */
 170   /* Fill out header */
 171   header.vpxcc = 2 << 6;              /* V=2, P=0, X=0, CC=0 */
 172   header.seq = htons(rtp_sequence++);
 173   header.ssrc = rtp_id;
 174   header.mpt = rtp_payload;
 175   /* If we've come out of a pause, set the marker bit */
 176   if(flags & UAUDIO_RESUME)
 177     header.mpt |= 0x80;
 178 #if !WORDS_BIGENDIAN
 179   /* Convert samples to network byte order */
 180   uint16_t *u = buffer, *const limit = u + nsamples;
 181   while(u < limit) {
 182     *u = htons(*u);
 183     ++u;
 184   }
 185 #endif
 186   vec[0].iov_base = (void *)&header;
 187   vec[0].iov_len = sizeof header;
 188   vec[1].iov_base = buffer;
 189   vec[1].iov_len = nsamples * uaudio_sample_size;
 190   const uint32_t timestamp = uaudio_schedule_sync();
 191   header.timestamp = htonl(rtp_base + (uint32_t)timestamp);
 192
 193   /* We send ~120 packets a second with current arrangements.  So if we log
 194    * once every 8192 packets we log about once a minute. */
 195
 196   if(!(ntohs(header.seq) & 8191)
 197      && config->rtp_verbose)
 198     disorder_info("RTP: seq %04"PRIx16" %08"PRIx32"+%08"PRIx32"=%08"PRIx32" ns %zu%s",
 199                   ntohs(header.seq),
 200                   rtp_base,
 201                   timestamp,
 202                   header.timestamp,
 203                   nsamples,
 204                   flags & UAUDIO_PAUSED ? " [paused]" : "");
 205
 206   /* If we're paused don't actually end a packet, we just pretend */
 207   if(flags & UAUDIO_PAUSED) {
 208     uaudio_schedule_sent(nsamples);
 209     return nsamples;
 210   }
 211   if(rtp_mode == RTP_REQUEST) {
 212     struct rtp_recipient *r;
 213     struct msghdr m;
 214     memset(&m, 0, sizeof m);
 215     m.msg_iov = vec;
 216     m.msg_iovlen = 2;
 217     pthread_mutex_lock(&rtp_lock);
 218     for(r = rtp_recipient_list; r; r = r->next) {
 219       m.msg_name = &r->sa;
 220       m.msg_namelen = r->sa.ss_family == AF_INET ?
 221         sizeof(struct sockaddr_in) : sizeof (struct sockaddr_in6);
 222       sendmsg(r->sa.ss_family == AF_INET ? rtp_fd : rtp_fd6,
 223               &m, MSG_DONTWAIT|MSG_NOSIGNAL);
 224       // TODO similar error handling to other case?
 225     }
 226     pthread_mutex_unlock(&rtp_lock);
 227   } else {
 228     int written_bytes;
 229     do {
 230       written_bytes = writev(rtp_fd, vec, 2);
 231     } while(written_bytes < 0 && errno == EINTR);
 232     if(written_bytes < 0) {
 233       disorder_error(errno, "error transmitting audio data");
 234       ++rtp_errors;
 235       if(rtp_errors == 10)
 236         disorder_fatal(0, "too many audio transmission errors");
 237       return 0;
 238     } else
 239       rtp_errors /= 2;                    /* gradual decay */
 240   }
 241   /* TODO what can we sensibly do about short writes here?  Really that's just
 242    * an error and we ought to be using smaller packets. */
 243   uaudio_schedule_sent(nsamples);
 244   return nsamples;
 245 }
 246
 247 static void hack_send_buffer_size(int fd, const char *what) {
 248   int sndbuf, target_sndbuf = 131072;
 249   socklen_t len = sizeof sndbuf;
 250
 251   if(getsockopt(fd, SOL_SOCKET, SO_SNDBUF,
 252                 &sndbuf, &len) < 0)
 253     disorder_fatal(errno, "error getting SO_SNDBUF on %s socket", what);
 254   if(target_sndbuf > sndbuf) {
 255     if(setsockopt(fd, SOL_SOCKET, SO_SNDBUF,
 256                   &target_sndbuf, sizeof target_sndbuf) < 0)
 257       disorder_error(errno, "error setting SO_SNDBUF on %s socket to %d",
 258                      what, target_sndbuf);
 259     else
 260       disorder_info("changed socket send buffer size on %socket from %d to %d",
 261                     what, sndbuf, target_sndbuf);
 262   } else
 263     disorder_info("default socket send buffer on %s socket is %d",
 264                   what, sndbuf);
 265 }
 266
 267 static void rtp_open(void) {
 268   struct addrinfo *dres, *sres;
 269   static const int one = 1;
 270   struct netaddress dst[1], src[1];
 271   const char *mode;
 272
 273   /* Get the mode */
 274   mode = uaudio_get("rtp-mode", "auto");
 275   if(!strcmp(mode, "broadcast")) rtp_mode = RTP_BROADCAST;
 276   else if(!strcmp(mode, "multicast")) rtp_mode = RTP_MULTICAST;
 277   else if(!strcmp(mode, "unicast")) rtp_mode = RTP_UNICAST;
 278   else if(!strcmp(mode, "request")) rtp_mode = RTP_REQUEST;
 279   else rtp_mode = RTP_AUTO;
 280   /* Get the source and destination addresses (which might be missing) */
 281   rtp_get_netconfig("rtp-destination-af",
 282                     "rtp-destination",
 283                     "rtp-destination-port",
 284                     dst);
 285   rtp_get_netconfig("rtp-source-af",
 286                     "rtp-source",
 287                     "rtp-source-port",
 288                     src);
 289   if(dst->af != -1) {
 290     dres = netaddress_resolve(dst, 0, IPPROTO_UDP);
 291     if(!dres)
 292       exit(-1);
 293   } else
 294     dres = 0;
 295   if(src->af != -1) {
 296     sres = netaddress_resolve(src, 1, IPPROTO_UDP);
 297     if(!sres)
 298       exit(-1);
 299   } else
 300     sres = 0;
 301   /* _AUTO inspects the destination address and acts accordingly */
 302   if(rtp_mode == RTP_AUTO) {
 303     if(!dres)
 304       rtp_mode = RTP_REQUEST;
 305     else if(multicast(dres->ai_addr))
 306       rtp_mode = RTP_MULTICAST;
 307     else {
 308       struct ifaddrs *ifs;
 309
 310       if(getifaddrs(&ifs) < 0)
 311         disorder_fatal(errno, "error calling getifaddrs");
 312       while(ifs) {
 313         /* (At least on Darwin) IFF_BROADCAST might be set but ifa_broadaddr
 314          * still a null pointer.  It turns out that there's a subsequent entry
 315          * for he same interface which _does_ have ifa_broadaddr though... */
 316         if((ifs->ifa_flags & IFF_BROADCAST)
 317            && ifs->ifa_broadaddr
 318            && sockaddr_equal(ifs->ifa_broadaddr, dres->ai_addr))
 319           break;
 320         ifs = ifs->ifa_next;
 321       }
 322       if(ifs)
 323         rtp_mode = RTP_BROADCAST;
 324       else
 325         rtp_mode = RTP_UNICAST;
 326     }
 327   }
 328   /* Create the socket */
 329   if(rtp_mode != RTP_REQUEST) {
 330     if((rtp_fd = socket(dres->ai_family,
 331                         dres->ai_socktype,
 332                         dres->ai_protocol)) < 0)
 333       disorder_fatal(errno, "error creating RTP transmission socket");
 334   } else {                              /* request mode slightly different */
 335     if((rtp_fd = socket(AF_INET,
 336                         SOCK_DGRAM,
 337                         IPPROTO_UDP)) < 0)
 338       disorder_fatal(errno, "error creating v4 RTP transmission socket");
 339     if((rtp_fd6 = socket(AF_INET6,
 340                          SOCK_DGRAM,
 341                          IPPROTO_UDP)) < 0)
 342       disorder_fatal(errno, "error creating v6 RTP transmission socket");
 343   }
 344   /* Configure the socket according to the desired mode */
 345   switch(rtp_mode) {
 346   case RTP_MULTICAST: {
 347     /* Enable multicast options */
 348     const int ttl = atoi(uaudio_get("multicast-ttl", "1"));
 349     const int loop = !strcmp(uaudio_get("multicast-loop", "yes"), "yes");
 350     switch(dres->ai_family) {
 351     case PF_INET: {
 352       if(setsockopt(rtp_fd, IPPROTO_IP, IP_MULTICAST_TTL,
 353                     &ttl, sizeof ttl) < 0)
 354         disorder_fatal(errno, "error setting IP_MULTICAST_TTL on multicast socket");
 355       if(setsockopt(rtp_fd, IPPROTO_IP, IP_MULTICAST_LOOP,
 356                     &loop, sizeof loop) < 0)
 357         disorder_fatal(errno, "error setting IP_MULTICAST_LOOP on multicast socket");
 358       break;
 359     }
 360     case PF_INET6: {
 361       if(setsockopt(rtp_fd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS,
 362                     &ttl, sizeof ttl) < 0)
 363         disorder_fatal(errno, "error setting IPV6_MULTICAST_HOPS on multicast socket");
 364       if(setsockopt(rtp_fd, IPPROTO_IP, IPV6_MULTICAST_LOOP,
 365                     &loop, sizeof loop) < 0)
 366         disorder_fatal(errno, "error setting IPV6_MULTICAST_LOOP on multicast socket");
 367       break;
 368     }
 369     default:
 370       disorder_fatal(0, "unsupported address family %d", dres->ai_family);
 371     }
 372     disorder_info("multicasting on %s TTL=%d loop=%s",
 373                   format_sockaddr(dres->ai_addr), ttl, loop ? "yes" : "no");
 374     break;
 375   }
 376   case RTP_UNICAST: {
 377     disorder_info("unicasting on %s", format_sockaddr(dres->ai_addr));
 378     break;
 379   }
 380   case RTP_BROADCAST: {
 381     if(setsockopt(rtp_fd, SOL_SOCKET, SO_BROADCAST, &one, sizeof one) < 0)
 382       disorder_fatal(errno, "error setting SO_BROADCAST on broadcast socket");
 383     disorder_info("broadcasting on %s",
 384                   format_sockaddr(dres->ai_addr));
 385     break;
 386   }
 387   case RTP_REQUEST: {
 388     disorder_info("will transmit on request");
 389     break;
 390   }
 391   }
 392   /* Enlarge the socket buffers */
 393   hack_send_buffer_size(rtp_fd, "master socket");
 394   hack_send_buffer_size(rtp_fd6, "IPv6 on-demand socket");
 395   /* We might well want to set additional broadcast- or multicast-related
 396    * options here */
 397   if(rtp_mode != RTP_REQUEST) {
 398     if(sres && bind(rtp_fd, sres->ai_addr, sres->ai_addrlen) < 0)
 399       disorder_fatal(errno, "error binding broadcast socket to %s",
 400                      format_sockaddr(sres->ai_addr));
 401     if(connect(rtp_fd, dres->ai_addr, dres->ai_addrlen) < 0)
 402       disorder_fatal(errno, "error connecting broadcast socket to %s",
 403                      format_sockaddr(dres->ai_addr));
 404   }
 405   if(config->rtp_verbose)
 406     disorder_info("RTP: prepared socket");
 407 }
 408
 409 static void rtp_start(uaudio_callback *callback,
 410                       void *userdata) {
 411   /* We only support L16 (but we do stereo and mono and will convert sign) */
 412   if(uaudio_channels == 2
 413      && uaudio_bits == 16
 414      && uaudio_rate == 44100)
 415     rtp_payload = 10;
 416   else if(uaudio_channels == 1
 417      && uaudio_bits == 16
 418      && uaudio_rate == 44100)
 419     rtp_payload = 11;
 420   else
 421     disorder_fatal(0, "asked for %d/%d/%d 16/44100/1 and 16/44100/2",
 422                    uaudio_bits, uaudio_rate, uaudio_channels);
 423   if(config->rtp_verbose)
 424     disorder_info("RTP: %d channels %d bits %d Hz payload type %d",
 425                   uaudio_channels, uaudio_bits, uaudio_rate, rtp_payload);
 426   /* Various fields are required to have random initial values by RFC3550.  The
 427    * packet contents are highly public so there's no point asking for very
 428    * strong randomness. */
 429   gcry_create_nonce(&rtp_id, sizeof rtp_id);
 430   gcry_create_nonce(&rtp_base, sizeof rtp_base);
 431   gcry_create_nonce(&rtp_sequence, sizeof rtp_sequence);
 432   if(config->rtp_verbose)
 433     disorder_info("RTP: id %08"PRIx32" base %08"PRIx32" initial seq %08"PRIx16,
 434                   rtp_id, rtp_base, rtp_sequence);
 435   rtp_open();
 436   uaudio_schedule_init();
 437   if(config->rtp_verbose)
 438     disorder_info("RTP: initialized schedule");
 439   uaudio_thread_start(callback,
 440                       userdata,
 441                       rtp_play,
 442                       256 / uaudio_sample_size,
 443                       (NETWORK_BYTES - sizeof(struct rtp_header))
 444                       / uaudio_sample_size,
 445                       0);
 446   if(config->rtp_verbose)
 447     disorder_info("RTP: created thread");
 448 }
 449
 450 static void rtp_stop(void) {
 451   uaudio_thread_stop();
 452   close(rtp_fd); rtp_fd = -1;
 453   if(rtp_fd6 >= 0) { close(rtp_fd6); rtp_fd6 = -1; }
 454 }
 455
 456 static void rtp_configure(void) {
 457   char buffer[64];
 458
 459   uaudio_set("rtp-mode", config->rtp_mode);
 460   rtp_set_netconfig("rtp-destination-af",
 461                     "rtp-destination",
 462                     "rtp-destination-port", &config->broadcast);
 463   rtp_set_netconfig("rtp-source-af",
 464                     "rtp-source",
 465                     "rtp-source-port", &config->broadcast_from);
 466   snprintf(buffer, sizeof buffer, "%ld", config->multicast_ttl);
 467   uaudio_set("multicast-ttl", buffer);
 468   uaudio_set("multicast-loop", config->multicast_loop ? "yes" : "no");
 469   if(config->rtp_verbose)
 470     disorder_info("RTP: configured");
 471 }
 472
 473 /** @brief Add an RTP recipient address
 474  * @param sa Pointer to recipient address
 475  * @return 0 on success, -1 on error
 476  */
 477 int rtp_add_recipient(const struct sockaddr_storage *sa) {
 478   struct rtp_recipient *r;
 479   int rc;
 480   pthread_mutex_lock(&rtp_lock);
 481   for(r = rtp_recipient_list;
 482       r && sockaddrcmp((struct sockaddr *)sa,
 483                        (struct sockaddr *)&r->sa);
 484       r = r->next)
 485     ;
 486   if(r)
 487     rc = -1;
 488   else {
 489     r = xmalloc(sizeof *r);
 490     memcpy(&r->sa, sa, sizeof *sa);
 491     r->next = rtp_recipient_list;
 492     rtp_recipient_list = r;
 493     rc = 0;
 494   }
 495   pthread_mutex_unlock(&rtp_lock);
 496   return rc;
 497 }
 498
 499 /** @brief Remove an RTP recipient address
 500  * @param sa Pointer to recipient address
 501  * @return 0 on success, -1 on error
 502  */
 503 int rtp_remove_recipient(const struct sockaddr_storage *sa) {
 504   struct rtp_recipient *r, **rr;
 505   int rc;
 506   pthread_mutex_lock(&rtp_lock);
 507   for(rr = &rtp_recipient_list;
 508       (r = *rr) && sockaddrcmp((struct sockaddr *)sa,
 509                                (struct sockaddr *)&r->sa);
 510       rr = &r->next)
 511     ;
 512   if(r) {
 513     *rr = r->next;
 514     xfree(r);
 515     rc = 0;
 516   } else {
 517     disorder_error(0, "bogus rtp_remove_recipient");
 518     rc = -1;
 519   }
 520   pthread_mutex_unlock(&rtp_lock);
 521   return rc;
 522 }
 523
 524 const struct uaudio uaudio_rtp = {
 525   .name = "rtp",
 526   .options = rtp_options,
 527   .start = rtp_start,
 528   .stop = rtp_stop,
 529   .activate = uaudio_thread_activate,
 530   .deactivate = uaudio_thread_deactivate,
 531   .configure = rtp_configure,
 532   .flags = UAUDIO_API_SERVER,
 533 };
 534
 535 /*
 536 Local Variables:
 537 c-basic-offset:2
 538 comment-column:40
 539 fill-column:79
 540 indent-tabs-mode:nil
 541 End:
 542 */