chiark / gitweb /
playrtp: support multiple unicast mode
[disorder] / clients / playrtp.c
CommitLineData
e83d0967
RK
1/*
2 * This file is part of DisOrder.
06385470 3 * Copyright (C) 2007-2009, 2011, 2013 Richard Kettlewell
e83d0967 4 *
e7eb3a27 5 * This program is free software: you can redistribute it and/or modify
e83d0967 6 * it under the terms of the GNU General Public License as published by
e7eb3a27 7 * the Free Software Foundation, either version 3 of the License, or
e83d0967
RK
8 * (at your option) any later version.
9 *
e7eb3a27
RK
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 *
e83d0967 15 * You should have received a copy of the GNU General Public License
e7eb3a27 16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
e83d0967 17 */
28bacdc0
RK
18/** @file clients/playrtp.c
19 * @brief RTP player
20 *
b0fdc63d 21 * This player supports Linux (<a href="http://www.alsa-project.org/">ALSA</a>)
22 * and Apple Mac (<a
23 * href="http://developer.apple.com/audio/coreaudio.html">Core Audio</a>)
24 * systems. There is no support for Microsoft Windows yet, and that will in
25 * fact probably an entirely separate program.
26 *
8d251217
RK
27 * The program runs (at least) three threads:
28 *
29 * listen_thread() is responsible for reading RTP packets off the wire and
30 * adding them to the linked list @ref received_packets, assuming they are
31 * basically sound.
32 *
33 * queue_thread() takes packets off this linked list and adds them to @ref
34 * packets (an operation which might be much slower due to contention for @ref
35 * lock).
36 *
37 * control_thread() accepts commands from Disobedience (or anything else).
38 *
39 * The main thread activates and deactivates audio playing via the @ref
40 * lib/uaudio.h API (which probably implies at least one further thread).
b0fdc63d 41 *
42 * Sometimes it happens that there is no audio available to play. This may
43 * because the server went away, or a packet was dropped, or the server
44 * deliberately did not send any sound because it encountered a silence.
189e9830
RK
45 *
46 * Assumptions:
47 * - it is safe to read uint32_t values without a lock protecting them
28bacdc0 48 */
e83d0967 49
05b75f8d 50#include "common.h"
e83d0967
RK
51
52#include <getopt.h>
e83d0967
RK
53#include <sys/socket.h>
54#include <sys/types.h>
55#include <sys/socket.h>
56#include <netdb.h>
57#include <pthread.h>
0b75463f 58#include <locale.h>
2c7c9eae 59#include <sys/uio.h>
c593cf7c 60#include <errno.h>
e3426f7b 61#include <netinet/in.h>
2d2effe2 62#include <sys/time.h>
a99c4e9a 63#include <sys/un.h>
9fbe0996 64#include <unistd.h>
e9b635a3
RK
65#include <sys/mman.h>
66#include <fcntl.h>
b0619501 67#include <math.h>
cca034e5
RK
68#include <arpa/inet.h>
69#include <ifaddrs.h>
70#include <net/if.h>
e83d0967
RK
71
72#include "log.h"
73#include "mem.h"
74#include "configuration.h"
75#include "addr.h"
76#include "syscalls.h"
77#include "rtp.h"
0b75463f 78#include "defs.h"
28bacdc0
RK
79#include "vector.h"
80#include "heap.h"
189e9830 81#include "timeval.h"
a7e9570a 82#include "client.h"
8e3fe3d8 83#include "playrtp.h"
a99c4e9a 84#include "inputline.h"
3fbdc96d 85#include "version.h"
7a2c7068 86#include "uaudio.h"
e83d0967 87
e3426f7b
RK
88/** @brief Obsolete synonym */
89#ifndef IPV6_JOIN_GROUP
90# define IPV6_JOIN_GROUP IPV6_ADD_MEMBERSHIP
91#endif
92
0b75463f 93/** @brief RTP socket */
e83d0967
RK
94static int rtpfd;
95
345ebe66
RK
96/** @brief Log output */
97static FILE *logfp;
98
0b75463f 99/** @brief Output device */
0b75463f 100
ad535598
RK
101/** @brief Buffer low watermark in samples */
102unsigned minbuffer = 4 * (2 * 44100) / 10; /* 0.4 seconds */
0b75463f 103
ad535598 104/** @brief Maximum buffer size in samples
9086a105 105 *
ad535598
RK
106 * We'll stop reading from the network if we have this many samples.
107 */
9086a105
RK
108static unsigned maxbuffer;
109
189e9830
RK
110/** @brief Received packets
111 * Protected by @ref receive_lock
112 *
113 * Received packets are added to this list, and queue_thread() picks them off
114 * it and adds them to @ref packets. Whenever a packet is added to it, @ref
115 * receive_cond is signalled.
116 */
8e3fe3d8 117struct packet *received_packets;
189e9830
RK
118
119/** @brief Tail of @ref received_packets
120 * Protected by @ref receive_lock
121 */
8e3fe3d8 122struct packet **received_tail = &received_packets;
189e9830
RK
123
124/** @brief Lock protecting @ref received_packets
125 *
126 * Only listen_thread() and queue_thread() ever hold this lock. It is vital
127 * that queue_thread() not hold it any longer than it strictly has to. */
8e3fe3d8 128pthread_mutex_t receive_lock = PTHREAD_MUTEX_INITIALIZER;
189e9830
RK
129
130/** @brief Condition variable signalled when @ref received_packets is updated
131 *
132 * Used by listen_thread() to notify queue_thread() that it has added another
133 * packet to @ref received_packets. */
8e3fe3d8 134pthread_cond_t receive_cond = PTHREAD_COND_INITIALIZER;
189e9830
RK
135
136/** @brief Length of @ref received_packets */
8e3fe3d8 137uint32_t nreceived;
28bacdc0
RK
138
139/** @brief Binary heap of received packets */
8e3fe3d8 140struct pheap packets;
28bacdc0 141
189e9830
RK
142/** @brief Total number of samples available
143 *
144 * We make this volatile because we inspect it without a protecting lock,
145 * so the usual pthread_* guarantees aren't available.
146 */
8e3fe3d8 147volatile uint32_t nsamples;
0b75463f 148
149/** @brief Timestamp of next packet to play.
150 *
151 * This is set to the timestamp of the last packet, plus the number of
09ee2f0d 152 * samples it contained. Only valid if @ref active is nonzero.
0b75463f 153 */
8e3fe3d8 154uint32_t next_timestamp;
e83d0967 155
09ee2f0d 156/** @brief True if actively playing
157 *
158 * This is true when playing and false when just buffering. */
8e3fe3d8 159int active;
09ee2f0d 160
189e9830 161/** @brief Lock protecting @ref packets */
8e3fe3d8 162pthread_mutex_t lock = PTHREAD_MUTEX_INITIALIZER;
189e9830
RK
163
164/** @brief Condition variable signalled whenever @ref packets is changed */
8e3fe3d8 165pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
2c7c9eae 166
c593cf7c 167/** @brief Backend to play with */
7a2c7068 168static const struct uaudio *backend;
c593cf7c 169
8e3fe3d8 170HEAP_DEFINE(pheap, struct packet *, lt_packet);
e83d0967 171
a99c4e9a
RK
172/** @brief Control socket or NULL */
173const char *control_socket;
174
b28bddbb
RK
175/** @brief Buffer for debugging dump
176 *
177 * The debug dump is enabled by the @c --dump option. It records the last 20s
178 * of audio to the specified file (which will be about 3.5Mbytes). The file is
179 * written as as ring buffer, so the start point will progress through it.
180 *
181 * Use clients/dump2wav to convert this to a WAV file, which can then be loaded
182 * into (e.g.) Audacity for further inspection.
183 *
184 * All three backends (ALSA, OSS, Core Audio) now support this option.
185 *
186 * The idea is to allow the user a few seconds to react to an audible artefact.
187 */
e9b635a3 188int16_t *dump_buffer;
b28bddbb
RK
189
190/** @brief Current index within debugging dump */
e9b635a3 191size_t dump_index;
b28bddbb
RK
192
193/** @brief Size of debugging dump in samples */
194size_t dump_size = 44100/*Hz*/ * 2/*channels*/ * 20/*seconds*/;
e9b635a3 195
e83d0967
RK
196static const struct option options[] = {
197 { "help", no_argument, 0, 'h' },
198 { "version", no_argument, 0, 'V' },
199 { "debug", no_argument, 0, 'd' },
0b75463f 200 { "device", required_argument, 0, 'D' },
1153fd23 201 { "min", required_argument, 0, 'm' },
9086a105 202 { "max", required_argument, 0, 'x' },
1f10f780 203 { "rcvbuf", required_argument, 0, 'R' },
a9f0ad12 204#if HAVE_SYS_SOUNDCARD_H || EMPEG_HOST
c593cf7c 205 { "oss", no_argument, 0, 'o' },
206#endif
146e86fb 207#if HAVE_ALSA_ASOUNDLIB_H
c593cf7c 208 { "alsa", no_argument, 0, 'a' },
209#endif
210#if HAVE_COREAUDIO_AUDIOHARDWARE_H
211 { "core-audio", no_argument, 0, 'c' },
212#endif
ba32e50c 213 { "api", required_argument, 0, 'A' },
e9b635a3 214 { "dump", required_argument, 0, 'r' },
e979b844 215 { "command", required_argument, 0, 'e' },
287ad384 216 { "pause-mode", required_argument, 0, 'P' },
a99c4e9a 217 { "socket", required_argument, 0, 's' },
a7e9570a 218 { "config", required_argument, 0, 'C' },
b0619501 219 { "monitor", no_argument, 0, 'M' },
e83d0967
RK
220 { 0, 0, 0, 0 }
221};
222
a99c4e9a
RK
223/** @brief Control thread
224 *
225 * This thread is responsible for accepting control commands from Disobedience
226 * (or other controllers) over an AF_UNIX stream socket with a path specified
227 * by the @c --socket option. The protocol uses simple string commands and
228 * replies:
229 *
230 * - @c stop will shut the player down
231 * - @c query will send back the reply @c running
232 * - anything else is ignored
233 *
234 * Commands and response strings terminated by shutting down the connection or
235 * by a newline. No attempt is made to multiplex multiple clients so it is
236 * important that the command be sent as soon as the connection is made - it is
237 * assumed that both parties to the protocol are entirely cooperating with one
238 * another.
239 */
240static void *control_thread(void attribute((unused)) *arg) {
241 struct sockaddr_un sa;
242 int sfd, cfd;
243 char *line;
244 socklen_t salen;
245 FILE *fp;
246
247 assert(control_socket);
248 unlink(control_socket);
249 memset(&sa, 0, sizeof sa);
250 sa.sun_family = AF_UNIX;
251 strcpy(sa.sun_path, control_socket);
252 sfd = xsocket(PF_UNIX, SOCK_STREAM, 0);
253 if(bind(sfd, (const struct sockaddr *)&sa, sizeof sa) < 0)
2e9ba080 254 disorder_fatal(errno, "error binding to %s", control_socket);
a99c4e9a 255 if(listen(sfd, 128) < 0)
2e9ba080
RK
256 disorder_fatal(errno, "error calling listen on %s", control_socket);
257 disorder_info("listening on %s", control_socket);
a99c4e9a
RK
258 for(;;) {
259 salen = sizeof sa;
260 cfd = accept(sfd, (struct sockaddr *)&sa, &salen);
261 if(cfd < 0) {
262 switch(errno) {
263 case EINTR:
264 case EAGAIN:
265 break;
266 default:
2e9ba080 267 disorder_fatal(errno, "error calling accept on %s", control_socket);
a99c4e9a
RK
268 }
269 }
270 if(!(fp = fdopen(cfd, "r+"))) {
2e9ba080 271 disorder_error(errno, "error calling fdopen for %s connection", control_socket);
a99c4e9a
RK
272 close(cfd);
273 continue;
274 }
275 if(!inputline(control_socket, fp, &line, '\n')) {
276 if(!strcmp(line, "stop")) {
2e9ba080 277 disorder_info("stopped via %s", control_socket);
a99c4e9a
RK
278 exit(0); /* terminate immediately */
279 }
280 if(!strcmp(line, "query"))
281 fprintf(fp, "running");
282 xfree(line);
283 }
284 if(fclose(fp) < 0)
2e9ba080 285 disorder_error(errno, "error closing %s connection", control_socket);
a99c4e9a
RK
286 }
287}
288
28bacdc0
RK
289/** @brief Drop the first packet
290 *
291 * Assumes that @ref lock is held.
292 */
293static void drop_first_packet(void) {
294 if(pheap_count(&packets)) {
295 struct packet *const p = pheap_remove(&packets);
296 nsamples -= p->nsamples;
c593cf7c 297 playrtp_free_packet(p);
2c7c9eae 298 pthread_cond_broadcast(&cond);
2c7c9eae 299 }
9086a105
RK
300}
301
189e9830
RK
302/** @brief Background thread adding packets to heap
303 *
304 * This just transfers packets from @ref received_packets to @ref packets. It
305 * is important that it holds @ref receive_lock for as little time as possible,
306 * in order to minimize the interval between calls to read() in
307 * listen_thread().
308 */
309static void *queue_thread(void attribute((unused)) *arg) {
310 struct packet *p;
311
312 for(;;) {
313 /* Get the next packet */
314 pthread_mutex_lock(&receive_lock);
4dadf1a2 315 while(!received_packets) {
189e9830 316 pthread_cond_wait(&receive_cond, &receive_lock);
4dadf1a2 317 }
189e9830
RK
318 p = received_packets;
319 received_packets = p->next;
320 if(!received_packets)
321 received_tail = &received_packets;
322 --nreceived;
323 pthread_mutex_unlock(&receive_lock);
324 /* Add it to the heap */
325 pthread_mutex_lock(&lock);
326 pheap_insert(&packets, p);
327 nsamples += p->nsamples;
328 pthread_cond_broadcast(&cond);
329 pthread_mutex_unlock(&lock);
330 }
c6a70f38
RK
331#if HAVE_STUPID_GCC44
332 return NULL;
333#endif
189e9830
RK
334}
335
09ee2f0d 336/** @brief Background thread collecting samples
0b75463f 337 *
338 * This function collects samples, perhaps converts them to the target format,
b0fdc63d 339 * and adds them to the packet list.
340 *
341 * It is crucial that the gap between successive calls to read() is as small as
342 * possible: otherwise packets will be dropped.
343 *
344 * We use a binary heap to ensure that the unavoidable effort is at worst
345 * logarithmic in the total number of packets - in fact if packets are mostly
346 * received in order then we will largely do constant work per packet since the
347 * newest packet will always be last.
348 *
349 * Of more concern is that we must acquire the lock on the heap to add a packet
350 * to it. If this proves a problem in practice then the answer would be
351 * (probably doubly) linked list with new packets added the end and a second
352 * thread which reads packets off the list and adds them to the heap.
353 *
354 * We keep memory allocation (mostly) very fast by keeping pre-allocated
c593cf7c 355 * packets around; see @ref playrtp_new_packet().
b0fdc63d 356 */
0b75463f 357static void *listen_thread(void attribute((unused)) *arg) {
2c7c9eae 358 struct packet *p = 0;
0b75463f 359 int n;
2c7c9eae
RK
360 struct rtp_header header;
361 uint16_t seq;
362 uint32_t timestamp;
363 struct iovec iov[2];
e83d0967
RK
364
365 for(;;) {
189e9830 366 if(!p)
c593cf7c 367 p = playrtp_new_packet();
2c7c9eae
RK
368 iov[0].iov_base = &header;
369 iov[0].iov_len = sizeof header;
370 iov[1].iov_base = p->samples_raw;
b64efe7e 371 iov[1].iov_len = sizeof p->samples_raw / sizeof *p->samples_raw;
2c7c9eae 372 n = readv(rtpfd, iov, 2);
e83d0967
RK
373 if(n < 0) {
374 switch(errno) {
375 case EINTR:
376 continue;
377 default:
2e9ba080 378 disorder_fatal(errno, "error reading from socket");
e83d0967
RK
379 }
380 }
0b75463f 381 /* Ignore too-short packets */
345ebe66 382 if((size_t)n <= sizeof (struct rtp_header)) {
2e9ba080 383 disorder_info("ignored a short packet");
0b75463f 384 continue;
345ebe66 385 }
2c7c9eae
RK
386 timestamp = htonl(header.timestamp);
387 seq = htons(header.seq);
09ee2f0d 388 /* Ignore packets in the past */
2c7c9eae 389 if(active && lt(timestamp, next_timestamp)) {
2e9ba080 390 disorder_info("dropping old packet, timestamp=%"PRIx32" < %"PRIx32,
2c7c9eae 391 timestamp, next_timestamp);
09ee2f0d 392 continue;
c0e41690 393 }
28f1495a
RK
394 /* Ignore packets with the extension bit set. */
395 if(header.vpxcc & 0x10)
396 continue;
189e9830 397 p->next = 0;
58b5a68f 398 p->flags = 0;
2c7c9eae 399 p->timestamp = timestamp;
e83d0967 400 /* Convert to target format */
58b5a68f
RK
401 if(header.mpt & 0x80)
402 p->flags |= IDLE;
2c7c9eae 403 switch(header.mpt & 0x7F) {
4fd38868 404 case 10: /* L16 */
2c7c9eae 405 p->nsamples = (n - sizeof header) / sizeof(uint16_t);
e83d0967
RK
406 break;
407 /* TODO support other RFC3551 media types (when the speaker does) */
408 default:
2e9ba080 409 disorder_fatal(0, "unsupported RTP payload type %d", header.mpt & 0x7F);
e83d0967 410 }
67d308e7
RK
411 /* See if packet is silent */
412 const uint16_t *s = p->samples_raw;
7bdf42d0 413 n = p->nsamples;
67d308e7
RK
414 for(; n > 0; --n)
415 if(*s++)
416 break;
417 if(!n)
418 p->flags |= SILENT;
345ebe66
RK
419 if(logfp)
420 fprintf(logfp, "sequence %u timestamp %"PRIx32" length %"PRIx32" end %"PRIx32"\n",
2c7c9eae 421 seq, timestamp, p->nsamples, timestamp + p->nsamples);
0b75463f 422 /* Stop reading if we've reached the maximum.
423 *
424 * This is rather unsatisfactory: it means that if packets get heavily
425 * out of order then we guarantee dropouts. But for now... */
345ebe66 426 if(nsamples >= maxbuffer) {
189e9830 427 pthread_mutex_lock(&lock);
4dadf1a2 428 while(nsamples >= maxbuffer) {
345ebe66 429 pthread_cond_wait(&cond, &lock);
4dadf1a2 430 }
189e9830 431 pthread_mutex_unlock(&lock);
345ebe66 432 }
189e9830
RK
433 /* Add the packet to the receive queue */
434 pthread_mutex_lock(&receive_lock);
435 *received_tail = p;
436 received_tail = &p->next;
437 ++nreceived;
438 pthread_cond_signal(&receive_cond);
439 pthread_mutex_unlock(&receive_lock);
58b5a68f
RK
440 /* We'll need a new packet */
441 p = 0;
e83d0967
RK
442 }
443}
444
5626f6d2
RK
445/** @brief Wait until the buffer is adequately full
446 *
447 * Must be called with @ref lock held.
448 */
c593cf7c 449void playrtp_fill_buffer(void) {
0e72bf84 450 /* Discard current buffer contents */
ad535598
RK
451 while(nsamples) {
452 //fprintf(stderr, "%8u/%u (%u) DROPPING\n", nsamples, maxbuffer, minbuffer);
bfd27c14 453 drop_first_packet();
ad535598 454 }
2e9ba080 455 disorder_info("Buffering...");
0e72bf84
RK
456 /* Wait until there's at least minbuffer samples available */
457 while(nsamples < minbuffer) {
ad535598 458 //fprintf(stderr, "%8u/%u (%u) FILLING\n", nsamples, maxbuffer, minbuffer);
5626f6d2 459 pthread_cond_wait(&cond, &lock);
4dadf1a2 460 }
0e72bf84 461 /* Start from whatever is earliest */
5626f6d2
RK
462 next_timestamp = pheap_first(&packets)->timestamp;
463 active = 1;
464}
465
466/** @brief Find next packet
467 * @return Packet to play or NULL if none found
468 *
469 * The return packet is merely guaranteed not to be in the past: it might be
470 * the first packet in the future rather than one that is actually suitable to
471 * play.
472 *
473 * Must be called with @ref lock held.
474 */
c593cf7c 475struct packet *playrtp_next_packet(void) {
5626f6d2
RK
476 while(pheap_count(&packets)) {
477 struct packet *const p = pheap_first(&packets);
478 if(le(p->timestamp + p->nsamples, next_timestamp)) {
479 /* This packet is in the past. Drop it and try another one. */
480 drop_first_packet();
481 } else
482 /* This packet is NOT in the past. (It might be in the future
483 * however.) */
484 return p;
485 }
486 return 0;
487}
488
e83d0967
RK
489/* display usage message and terminate */
490static void help(void) {
491 xprintf("Usage:\n"
c897bb65 492 " disorder-playrtp [OPTIONS] [[ADDRESS] PORT]\n"
e83d0967 493 "Options:\n"
1153fd23 494 " --device, -D DEVICE Output device\n"
495 " --min, -m FRAMES Buffer low water mark\n"
9086a105 496 " --max, -x FRAMES Buffer maximum size\n"
1f10f780 497 " --rcvbuf, -R BYTES Socket receive buffer size\n"
a7e9570a 498 " --config, -C PATH Set configuration file\n"
ba32e50c
RK
499 " --api, -A API Select audio API. Possibilities:\n"
500 " ");
501 int first = 1;
502 for(int n = 0; uaudio_apis[n]; ++n) {
503 if(uaudio_apis[n]->flags & UAUDIO_API_CLIENT) {
504 if(first)
505 first = 0;
506 else
507 xprintf(", ");
508 xprintf("%s", uaudio_apis[n]->name);
509 }
510 }
511 xprintf("\n"
287ad384
RK
512 " --command, -e COMMAND Pipe audio to command.\n"
513 " --pause-mode, -P silence For -e: pauses send silence (default)\n"
514 " --pause-mode, -P suspend For -e: pauses suspend writes\n"
9086a105
RK
515 " --help, -h Display usage message\n"
516 " --version, -V Display version number\n"
517 );
e83d0967
RK
518 xfclose(stdout);
519 exit(0);
520}
521
4fd38868 522static size_t playrtp_callback(void *buffer,
7a2c7068
RK
523 size_t max_samples,
524 void attribute((unused)) *userdata) {
525 size_t samples;
67d308e7 526 int silent = 0;
7a2c7068
RK
527
528 pthread_mutex_lock(&lock);
529 /* Get the next packet, junking any that are now in the past */
530 const struct packet *p = playrtp_next_packet();
531 if(p && contains(p, next_timestamp)) {
532 /* This packet is ready to play; the desired next timestamp points
533 * somewhere into it. */
534
535 /* Timestamp of end of packet */
536 const uint32_t packet_end = p->timestamp + p->nsamples;
537
538 /* Offset of desired next timestamp into current packet */
539 const uint32_t offset = next_timestamp - p->timestamp;
540
541 /* Pointer to audio data */
542 const uint16_t *ptr = (void *)(p->samples_raw + offset);
543
544 /* Compute number of samples left in packet, limited to output buffer
545 * size */
546 samples = packet_end - next_timestamp;
547 if(samples > max_samples)
548 samples = max_samples;
549
550 /* Copy into buffer, converting to native endianness */
551 size_t i = samples;
552 int16_t *bufptr = buffer;
553 while(i > 0) {
554 *bufptr++ = (int16_t)ntohs(*ptr++);
555 --i;
556 }
67d308e7 557 silent = !!(p->flags & SILENT);
7a2c7068
RK
558 } else {
559 /* There is no suitable packet. We introduce 0s up to the next packet, or
560 * to fill the buffer if there's no next packet or that's too many. The
561 * comparison with max_samples deals with the otherwise troubling overflow
562 * case. */
563 samples = p ? p->timestamp - next_timestamp : max_samples;
564 if(samples > max_samples)
565 samples = max_samples;
566 //info("infill by %zu", samples);
4fd38868 567 memset(buffer, 0, samples * uaudio_sample_size);
67d308e7 568 silent = 1;
7a2c7068
RK
569 }
570 /* Debug dump */
571 if(dump_buffer) {
572 for(size_t i = 0; i < samples; ++i) {
4fd38868 573 dump_buffer[dump_index++] = ((int16_t *)buffer)[i];
7a2c7068
RK
574 dump_index %= dump_size;
575 }
576 }
577 /* Advance timestamp */
578 next_timestamp += samples;
7edc7e42
RK
579 /* If we're getting behind then try to drop just silent packets
580 *
581 * In theory this shouldn't be necessary. The server is supposed to send
582 * packets at the right rate and compares the number of samples sent with the
583 * time in order to ensure this.
584 *
585 * However, various things could throw this off:
586 *
587 * - the server's clock could advance at the wrong rate. This would cause it
588 * to mis-estimate the right number of samples to have sent and
589 * inappropriately throttle or speed up.
590 *
591 * - playback could happen at the wrong rate. If the playback host's sound
592 * card has a slightly incorrect clock then eventually it will get out
593 * of step.
594 *
595 * So if we play back slightly slower than the server sends for either of
596 * these reasons then eventually our buffer, and the socket's buffer, will
597 * fill, and the kernel will start dropping packets. The result is audible
598 * and not very nice.
599 *
600 * Therefore if we're getting behind, we pre-emptively drop silent packets,
601 * since a change in the duration of a silence is less noticeable than a
602 * dropped packet from the middle of continuous music.
603 *
604 * (If things go wrong the other way then eventually we run out of packets to
605 * play and are forced to play silence. This doesn't seem to happen in
606 * practice but if it does then in the same way we can artificially extend
607 * silent packets to compensate.)
608 *
609 * Dropped packets are always logged; use 'disorder-playrtp --monitor' to
610 * track how close to target buffer occupancy we are on a once-a-minute
611 * basis.
612 */
67d308e7 613 if(nsamples > minbuffer && silent) {
2e9ba080
RK
614 disorder_info("dropping %zu samples (%"PRIu32" > %"PRIu32")",
615 samples, nsamples, minbuffer);
67d308e7
RK
616 samples = 0;
617 }
ad535598
RK
618 /* Junk obsolete packets */
619 playrtp_next_packet();
7a2c7068
RK
620 pthread_mutex_unlock(&lock);
621 return samples;
622}
623
cca034e5
RK
624static int compare_family(const struct ifaddrs *a,
625 const struct ifaddrs *b,
626 int family) {
627 int afamily = a->ifa_addr->sa_family;
628 int bfamily = b->ifa_addr->sa_family;
629 if(afamily != bfamily) {
630 /* Preferred family wins */
631 if(afamily == family) return 1;
632 if(bfamily == family) return -1;
633 /* Either there's no preference or it doesn't help. Prefer IPv4 */
634 if(afamily == AF_INET) return 1;
635 if(bfamily == AF_INET) return -1;
636 /* Failing that prefer IPv6 */
637 if(afamily == AF_INET6) return 1;
638 if(bfamily == AF_INET6) return -1;
639 }
640 return 0;
641}
642
643static int compare_flags(const struct ifaddrs *a,
644 const struct ifaddrs *b) {
645 unsigned aflags = a->ifa_flags, bflags = b->ifa_flags;
646 /* Up interfaces are better than down ones */
647 unsigned aup = aflags & IFF_UP, bup = bflags & IFF_UP;
648 if(aup != bup)
649 return aup > bup ? 1 : -1;
650 /* Static addresses are better than dynamic */
651 unsigned adynamic = aflags & IFF_DYNAMIC, bdynamic = bflags & IFF_DYNAMIC;
652 if(adynamic != bdynamic)
653 return adynamic < bdynamic ? 1 : -1;
654 unsigned aloopback = aflags & IFF_LOOPBACK, bloopback = bflags & IFF_LOOPBACK;
655 /* Static addresses are better than dynamic */
656 if(aloopback != bloopback)
657 return aloopback < bloopback ? 1 : -1;
658 return 0;
659}
660
661static int compare_interfaces(const struct ifaddrs *a,
662 const struct ifaddrs *b,
663 int family) {
664 int c;
665 if((c = compare_family(a, b, family))) return c;
666 return compare_flags(a, b);
667}
668
e83d0967 669int main(int argc, char **argv) {
a99c4e9a 670 int n, err;
e83d0967
RK
671 struct addrinfo *res;
672 struct stringlist sl;
0b75463f 673 char *sockname;
0e72bf84 674 int rcvbuf, target_rcvbuf = 0;
1f10f780 675 socklen_t len;
23205f9c
RK
676 struct ip_mreq mreq;
677 struct ipv6_mreq mreq6;
cca034e5 678 disorder_client *c = NULL;
a7e9570a 679 char *address, *port;
6fba990c
RK
680 int is_multicast;
681 union any_sockaddr {
682 struct sockaddr sa;
683 struct sockaddr_in in;
684 struct sockaddr_in6 in6;
685 };
686 union any_sockaddr mgroup;
e9b635a3 687 const char *dumpfile = 0;
7a2c7068 688 pthread_t ltid;
b0619501 689 int monitor = 0;
983c3357 690 static const int one = 1;
e83d0967 691
0b75463f 692 static const struct addrinfo prefs = {
66613034
RK
693 .ai_flags = AI_PASSIVE,
694 .ai_family = PF_INET,
695 .ai_socktype = SOCK_DGRAM,
696 .ai_protocol = IPPROTO_UDP
e83d0967
RK
697 };
698
9d7a6129
RK
699 /* Timing information is often important to debugging playrtp, so we include
700 * timestamps in the logs */
701 logdate = 1;
e83d0967 702 mem_init();
2e9ba080 703 if(!setlocale(LC_CTYPE, "")) disorder_fatal(errno, "error calling setlocale");
ba32e50c 704 while((n = getopt_long(argc, argv, "hVdD:m:x:L:R:aocC:re:P:MA:", options, 0)) >= 0) {
e83d0967
RK
705 switch(n) {
706 case 'h': help();
3fbdc96d 707 case 'V': version("disorder-playrtp");
e83d0967 708 case 'd': debugging = 1; break;
e979b844 709 case 'D': uaudio_set("device", optarg); break;
1153fd23 710 case 'm': minbuffer = 2 * atol(optarg); break;
9086a105 711 case 'x': maxbuffer = 2 * atol(optarg); break;
345ebe66 712 case 'L': logfp = fopen(optarg, "w"); break;
1f10f780 713 case 'R': target_rcvbuf = atoi(optarg); break;
146e86fb 714#if HAVE_ALSA_ASOUNDLIB_H
ba32e50c
RK
715 case 'a':
716 disorder_error(0, "deprecated option; use --api alsa instead");
717 backend = &uaudio_alsa; break;
c593cf7c 718#endif
a9f0ad12 719#if HAVE_SYS_SOUNDCARD_H || EMPEG_HOST
ba32e50c
RK
720 case 'o':
721 disorder_error(0, "deprecated option; use --api oss instead");
722 backend = &uaudio_oss;
723 break;
c593cf7c 724#endif
725#if HAVE_COREAUDIO_AUDIOHARDWARE_H
ba32e50c
RK
726 case 'c':
727 disorder_error(0, "deprecated option; use --api coreaudio instead");
728 backend = &uaudio_coreaudio;
729 break;
c593cf7c 730#endif
ba32e50c 731 case 'A': backend = uaudio_find(optarg); break;
a7e9570a 732 case 'C': configfile = optarg; break;
a99c4e9a 733 case 's': control_socket = optarg; break;
e9b635a3 734 case 'r': dumpfile = optarg; break;
e979b844 735 case 'e': backend = &uaudio_command; uaudio_set("command", optarg); break;
287ad384 736 case 'P': uaudio_set("pause-mode", optarg); break;
b0619501 737 case 'M': monitor = 1; break;
2e9ba080 738 default: disorder_fatal(0, "invalid option");
e83d0967
RK
739 }
740 }
2e9ba080 741 if(config_read(0, NULL)) disorder_fatal(0, "cannot read configuration");
06385470
RK
742 if(!backend) {
743 backend = uaudio_default(uaudio_apis, UAUDIO_API_CLIENT);
744 if(!backend)
745 disorder_fatal(0, "no default uaudio API found");
746 disorder_info("default audio API %s", backend->name);
747 }
30a82196
RK
748 if(backend == &uaudio_rtp) {
749 /* This means that you have NO local sound output. This can happen if you
750 * use a non-Apple GCC on a Mac (because it doesn't know how to compile
751 * CoreAudio/AudioHardware.h). */
752 disorder_fatal(0, "cannot play RTP through RTP");
753 }
9086a105 754 if(!maxbuffer)
0e72bf84 755 maxbuffer = 2 * minbuffer;
e83d0967
RK
756 argc -= optind;
757 argv += optind;
a7e9570a
RK
758 switch(argc) {
759 case 0:
6fba990c 760 /* Get configuration from server */
a7e9570a
RK
761 if(!(c = disorder_new(1))) exit(EXIT_FAILURE);
762 if(disorder_connect(c)) exit(EXIT_FAILURE);
763 if(disorder_rtp_address(c, &address, &port)) exit(EXIT_FAILURE);
6fba990c
RK
764 sl.n = 2;
765 sl.s = xcalloc(2, sizeof *sl.s);
766 sl.s[0] = address;
767 sl.s[1] = port;
a7e9570a 768 break;
6fba990c 769 case 1:
a7e9570a 770 case 2:
6fba990c 771 /* Use command-line ADDRESS+PORT or just PORT */
a7e9570a
RK
772 sl.n = argc;
773 sl.s = argv;
774 break;
775 default:
2e9ba080 776 disorder_fatal(0, "usage: disorder-playrtp [OPTIONS] [[ADDRESS] PORT]");
a7e9570a 777 }
7077d53f
RK
778 disorder_info("version "VERSION" process ID %lu",
779 (unsigned long)getpid());
cca034e5
RK
780 struct sockaddr *addr;
781 socklen_t addr_len;
782 if(!strcmp(sl.s[0], "-")) {
783 /* Pick address family to match known-working connectivity to the server */
784 int family = disorder_client_af(c);
785 /* Get a list of interfaces */
786 struct ifaddrs *ifa, *bestifa = NULL;
787 if(getifaddrs(&ifa) < 0)
788 disorder_fatal(errno, "error calling getifaddrs");
789 /* Try to pick a good one */
790 for(; ifa; ifa = ifa->ifa_next) {
791 if(bestifa == NULL
792 || compare_interfaces(ifa, bestifa, family) > 0)
793 bestifa = ifa;
23205f9c 794 }
cca034e5
RK
795 if(!bestifa)
796 disorder_fatal(0, "failed to select a network interface");
797 family = bestifa->ifa_addr->sa_family;
798 if((rtpfd = socket(family,
799 SOCK_DGRAM,
800 IPPROTO_UDP)) < 0)
801 disorder_fatal(errno, "error creating socket (family %d)", family);
802 /* Bind the address */
803 if(bind(rtpfd, bestifa->ifa_addr,
804 family == AF_INET
805 ? sizeof (struct sockaddr_in) : sizeof (struct sockaddr_in6)) < 0)
806 disorder_fatal(errno, "error binding socket");
807 static struct sockaddr_storage bound_address;
808 addr = (struct sockaddr *)&bound_address;
809 addr_len = sizeof bound_address;
810 if(getsockname(rtpfd, addr, &addr_len) < 0)
811 disorder_fatal(errno, "error getting socket address");
812 /* Convert to string */
813 char addrname[128], portname[32];
814 if(getnameinfo(addr, addr_len,
815 addrname, sizeof addrname,
816 portname, sizeof portname,
817 NI_NUMERICHOST|NI_NUMERICSERV) < 0)
818 disorder_fatal(errno, "getnameinfo");
819 /* Ask for audio data */
820 if(disorder_rtp_request(c, addrname, portname)) exit(EXIT_FAILURE);
983c3357 821 /* Report what we did */
cca034e5 822 disorder_info("listening on %s", format_sockaddr(addr));
983c3357 823 } else {
cca034e5
RK
824 /* Look up address and port */
825 if(!(res = get_address(&sl, &prefs, &sockname)))
826 exit(1);
827 addr = res->ai_addr;
828 addr_len = res->ai_addrlen;
829 /* Create the socket */
830 if((rtpfd = socket(res->ai_family,
831 res->ai_socktype,
832 res->ai_protocol)) < 0)
833 disorder_fatal(errno, "error creating socket");
834 /* Allow multiple listeners */
835 xsetsockopt(rtpfd, SOL_SOCKET, SO_REUSEADDR, &one, sizeof one);
836 is_multicast = multicast(addr);
837 /* The multicast and unicast/broadcast cases are different enough that they
838 * are totally split. Trying to find commonality between them causes more
839 * trouble that it's worth. */
840 if(is_multicast) {
841 /* Stash the multicast group address */
842 memcpy(&mgroup, addr, addr_len);
843 switch(res->ai_addr->sa_family) {
844 case AF_INET:
845 mgroup.in.sin_port = 0;
846 break;
847 case AF_INET6:
848 mgroup.in6.sin6_port = 0;
849 break;
850 default:
851 disorder_fatal(0, "unsupported address family %d",
852 (int)addr->sa_family);
853 }
854 /* Bind to to the multicast group address */
855 if(bind(rtpfd, addr, addr_len) < 0)
856 disorder_fatal(errno, "error binding socket to %s",
857 format_sockaddr(addr));
858 /* Add multicast group membership */
859 switch(mgroup.sa.sa_family) {
860 case PF_INET:
861 mreq.imr_multiaddr = mgroup.in.sin_addr;
862 mreq.imr_interface.s_addr = 0; /* use primary interface */
863 if(setsockopt(rtpfd, IPPROTO_IP, IP_ADD_MEMBERSHIP,
864 &mreq, sizeof mreq) < 0)
865 disorder_fatal(errno, "error calling setsockopt IP_ADD_MEMBERSHIP");
866 break;
867 case PF_INET6:
868 mreq6.ipv6mr_multiaddr = mgroup.in6.sin6_addr;
869 memset(&mreq6.ipv6mr_interface, 0, sizeof mreq6.ipv6mr_interface);
870 if(setsockopt(rtpfd, IPPROTO_IPV6, IPV6_JOIN_GROUP,
871 &mreq6, sizeof mreq6) < 0)
872 disorder_fatal(errno, "error calling setsockopt IPV6_JOIN_GROUP");
873 break;
874 default:
875 disorder_fatal(0, "unsupported address family %d", res->ai_family);
876 }
877 /* Report what we did */
878 disorder_info("listening on %s multicast group %s",
879 format_sockaddr(addr), format_sockaddr(&mgroup.sa));
880 } else {
881 /* Bind to 0/port */
882 switch(addr->sa_family) {
883 case AF_INET: {
884 struct sockaddr_in *in = (struct sockaddr_in *)addr;
983c3357 885
cca034e5
RK
886 memset(&in->sin_addr, 0, sizeof (struct in_addr));
887 break;
888 }
889 case AF_INET6: {
890 struct sockaddr_in6 *in6 = (struct sockaddr_in6 *)addr;
983c3357 891
cca034e5
RK
892 memset(&in6->sin6_addr, 0, sizeof (struct in6_addr));
893 break;
894 }
895 default:
896 disorder_fatal(0, "unsupported family %d", (int)addr->sa_family);
897 }
898 if(bind(rtpfd, addr, addr_len) < 0)
899 disorder_fatal(errno, "error binding socket to %s",
900 format_sockaddr(addr));
901 /* Report what we did */
902 disorder_info("listening on %s", format_sockaddr(addr));
983c3357 903 }
983c3357 904 }
1f10f780
RK
905 len = sizeof rcvbuf;
906 if(getsockopt(rtpfd, SOL_SOCKET, SO_RCVBUF, &rcvbuf, &len) < 0)
2e9ba080 907 disorder_fatal(errno, "error calling getsockopt SO_RCVBUF");
f0bae611 908 if(target_rcvbuf > rcvbuf) {
1f10f780
RK
909 if(setsockopt(rtpfd, SOL_SOCKET, SO_RCVBUF,
910 &target_rcvbuf, sizeof target_rcvbuf) < 0)
2e9ba080
RK
911 disorder_error(errno, "error calling setsockopt SO_RCVBUF %d",
912 target_rcvbuf);
1f10f780
RK
913 /* We try to carry on anyway */
914 else
2e9ba080
RK
915 disorder_info("changed socket receive buffer from %d to %d",
916 rcvbuf, target_rcvbuf);
1f10f780 917 } else
2e9ba080 918 disorder_info("default socket receive buffer %d", rcvbuf);
ad535598 919 //info("minbuffer %u maxbuffer %u", minbuffer, maxbuffer);
1f10f780 920 if(logfp)
2e9ba080 921 disorder_info("WARNING: -L option can impact performance");
a99c4e9a
RK
922 if(control_socket) {
923 pthread_t tid;
924
925 if((err = pthread_create(&tid, 0, control_thread, 0)))
2e9ba080 926 disorder_fatal(err, "pthread_create control_thread");
a99c4e9a 927 }
e9b635a3
RK
928 if(dumpfile) {
929 int fd;
930 unsigned char buffer[65536];
931 size_t written;
932
933 if((fd = open(dumpfile, O_RDWR|O_TRUNC|O_CREAT, 0666)) < 0)
2e9ba080 934 disorder_fatal(errno, "opening %s", dumpfile);
e9b635a3
RK
935 /* Fill with 0s to a suitable size */
936 memset(buffer, 0, sizeof buffer);
937 for(written = 0; written < dump_size * sizeof(int16_t);
938 written += sizeof buffer) {
939 if(write(fd, buffer, sizeof buffer) < 0)
2e9ba080 940 disorder_fatal(errno, "clearing %s", dumpfile);
e9b635a3
RK
941 }
942 /* Map the buffer into memory for convenience */
943 dump_buffer = mmap(0, dump_size * sizeof(int16_t), PROT_READ|PROT_WRITE,
944 MAP_SHARED, fd, 0);
945 if(dump_buffer == (void *)-1)
2e9ba080
RK
946 disorder_fatal(errno, "mapping %s", dumpfile);
947 disorder_info("dumping to %s", dumpfile);
e9b635a3 948 }
4fd38868
RK
949 /* Set up output. Currently we only support L16 so there's no harm setting
950 * the format before we know what it is! */
951 uaudio_set_format(44100/*Hz*/, 2/*channels*/,
952 16/*bits/channel*/, 1/*signed*/);
de0ef46e 953 uaudio_set("application", "disorder-playrtp");
7a2c7068
RK
954 backend->start(playrtp_callback, NULL);
955 /* We receive and convert audio data in a background thread */
956 if((err = pthread_create(&ltid, 0, listen_thread, 0)))
2e9ba080 957 disorder_fatal(err, "pthread_create listen_thread");
7a2c7068
RK
958 /* We have a second thread to add received packets to the queue */
959 if((err = pthread_create(&ltid, 0, queue_thread, 0)))
2e9ba080 960 disorder_fatal(err, "pthread_create queue_thread");
7a2c7068 961 pthread_mutex_lock(&lock);
b0619501 962 time_t lastlog = 0;
7a2c7068
RK
963 for(;;) {
964 /* Wait for the buffer to fill up a bit */
965 playrtp_fill_buffer();
966 /* Start playing now */
2e9ba080 967 disorder_info("Playing...");
7a2c7068
RK
968 next_timestamp = pheap_first(&packets)->timestamp;
969 active = 1;
d4170ca7 970 pthread_mutex_unlock(&lock);
7a2c7068 971 backend->activate();
d4170ca7 972 pthread_mutex_lock(&lock);
0e72bf84
RK
973 /* Wait until the buffer empties out
974 *
975 * If there's a packet that we can play right now then we definitely
976 * continue.
977 *
978 * Also if there's at least minbuffer samples we carry on regardless and
979 * insert silence. The assumption is there's been a pause but more data
980 * is now available.
981 */
7a2c7068
RK
982 while(nsamples >= minbuffer
983 || (nsamples > 0
4fd38868 984 && contains(pheap_first(&packets), next_timestamp))) {
b0619501 985 if(monitor) {
4265e5d3 986 time_t now = xtime(0);
b0619501
RK
987
988 if(now >= lastlog + 60) {
989 int offset = nsamples - minbuffer;
990 double offtime = (double)offset / (uaudio_rate * uaudio_channels);
2e9ba080
RK
991 disorder_info("%+d samples off (%d.%02ds, %d bytes)",
992 offset,
993 (int)fabs(offtime) * (offtime < 0 ? -1 : 1),
994 (int)(fabs(offtime) * 100) % 100,
995 offset * uaudio_bits / CHAR_BIT);
b0619501
RK
996 lastlog = now;
997 }
998 }
ad535598 999 //fprintf(stderr, "%8u/%u (%u) PLAYING\n", nsamples, maxbuffer, minbuffer);
7a2c7068 1000 pthread_cond_wait(&cond, &lock);
4fd38868 1001 }
ad535598
RK
1002#if 0
1003 if(nsamples) {
1004 struct packet *p = pheap_first(&packets);
1005 fprintf(stderr, "nsamples=%u (%u) next_timestamp=%"PRIx32", first packet is [%"PRIx32",%"PRIx32")\n",
1006 nsamples, minbuffer, next_timestamp,p->timestamp,p->timestamp+p->nsamples);
1007 }
1008#endif
7a2c7068 1009 /* Stop playing for a bit until the buffer re-fills */
d4170ca7 1010 pthread_mutex_unlock(&lock);
7a2c7068 1011 backend->deactivate();
d4170ca7 1012 pthread_mutex_lock(&lock);
7a2c7068
RK
1013 active = 0;
1014 /* Go back round */
1015 }
e83d0967
RK
1016 return 0;
1017}
1018
1019/*
1020Local Variables:
1021c-basic-offset:2
1022comment-column:40
1023fill-column:79
1024indent-tabs-mode:nil
1025End:
1026*/