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