2 * This file is part of DisOrder
3 * Copyright (C) 2005-2008 Richard Kettlewell
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.
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.
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
20 /** @file server/speaker-network.c
21 * @brief Support for @ref BACKEND_NETWORK */
30 #include <sys/socket.h>
36 #include <netinet/in.h>
38 #include "configuration.h"
45 #include "speaker-protocol.h"
48 /** @brief Network socket
50 * This is the file descriptor to write to for @ref BACKEND_NETWORK.
54 /** @brief RTP timestamp
56 * This counts the number of samples played (NB not the number of frames
59 * The timestamp in the packet header is only 32 bits wide. With 44100Hz
60 * stereo, that only gives about half a day before wrapping, which is not
61 * particularly convenient for certain debugging purposes. Therefore the
62 * timestamp is maintained as a 64-bit integer, giving around six million years
63 * before wrapping, and truncated to 32 bits when transmitting.
65 static uint64_t rtp_time;
67 /** @brief RTP base timestamp
69 * This is the real time correspoding to an @ref rtp_time of 0. It is used
70 * to recalculate the timestamp after idle periods.
72 static struct timeval rtp_time_0;
74 /** @brief RTP packet sequence number */
75 static uint16_t rtp_seq;
77 /** @brief RTP SSRC */
78 static uint32_t rtp_id;
80 /** @brief Error counter */
81 static int audio_errors;
83 /** @brief Network backend initialization */
84 static void network_init(void) {
85 struct addrinfo *res, *sres;
86 static const struct addrinfo pref = {
96 static const struct addrinfo prefbind = {
106 static const int one = 1;
107 int sndbuf, target_sndbuf = 131072;
109 char *sockname, *ssockname;
111 res = get_address(&config->broadcast, &pref, &sockname);
113 if(config->broadcast_from.n) {
114 sres = get_address(&config->broadcast_from, &prefbind, &ssockname);
118 if((bfd = socket(res->ai_family,
120 res->ai_protocol)) < 0)
121 fatal(errno, "error creating broadcast socket");
122 if(multicast(res->ai_addr)) {
124 switch(res->ai_family) {
126 const int mttl = config->multicast_ttl;
127 if(setsockopt(bfd, IPPROTO_IP, IP_MULTICAST_TTL, &mttl, sizeof mttl) < 0)
128 fatal(errno, "error setting IP_MULTICAST_TTL on multicast socket");
129 if(setsockopt(bfd, IPPROTO_IP, IP_MULTICAST_LOOP,
130 &config->multicast_loop, sizeof one) < 0)
131 fatal(errno, "error setting IP_MULTICAST_LOOP on multicast socket");
135 const int mttl = config->multicast_ttl;
136 if(setsockopt(bfd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS,
137 &mttl, sizeof mttl) < 0)
138 fatal(errno, "error setting IPV6_MULTICAST_HOPS on multicast socket");
139 if(setsockopt(bfd, IPPROTO_IP, IPV6_MULTICAST_LOOP,
140 &config->multicast_loop, sizeof (int)) < 0)
141 fatal(errno, "error setting IPV6_MULTICAST_LOOP on multicast socket");
145 fatal(0, "unsupported address family %d", res->ai_family);
147 info("multicasting on %s", sockname);
151 if(getifaddrs(&ifs) < 0)
152 fatal(errno, "error calling getifaddrs");
154 /* (At least on Darwin) IFF_BROADCAST might be set but ifa_broadaddr
155 * still a null pointer. It turns out that there's a subsequent entry
156 * for he same interface which _does_ have ifa_broadaddr though... */
157 if((ifs->ifa_flags & IFF_BROADCAST)
158 && ifs->ifa_broadaddr
159 && sockaddr_equal(ifs->ifa_broadaddr, res->ai_addr))
164 if(setsockopt(bfd, SOL_SOCKET, SO_BROADCAST, &one, sizeof one) < 0)
165 fatal(errno, "error setting SO_BROADCAST on broadcast socket");
166 info("broadcasting on %s (%s)", sockname, ifs->ifa_name);
168 info("unicasting on %s", sockname);
171 if(getsockopt(bfd, SOL_SOCKET, SO_SNDBUF,
173 fatal(errno, "error getting SO_SNDBUF");
174 if(target_sndbuf > sndbuf) {
175 if(setsockopt(bfd, SOL_SOCKET, SO_SNDBUF,
176 &target_sndbuf, sizeof target_sndbuf) < 0)
177 error(errno, "error setting SO_SNDBUF to %d", target_sndbuf);
179 info("changed socket send buffer size from %d to %d",
180 sndbuf, target_sndbuf);
182 info("default socket send buffer is %d",
184 /* We might well want to set additional broadcast- or multicast-related
186 if(sres && bind(bfd, sres->ai_addr, sres->ai_addrlen) < 0)
187 fatal(errno, "error binding broadcast socket to %s", ssockname);
188 if(connect(bfd, res->ai_addr, res->ai_addrlen) < 0)
189 fatal(errno, "error connecting broadcast socket to %s", sockname);
191 gcry_randomize(&rtp_id, sizeof rtp_id, GCRY_STRONG_RANDOM);
194 /** @brief Play over the network */
195 static size_t network_play(size_t frames) {
196 struct rtp_header header;
198 size_t bytes = frames * bpf, written_frames;
200 /* We transmit using RTP (RFC3550) and attempt to conform to the internet
201 * AVT profile (RFC3551). */
203 /* If we're starting then initialize the base time */
205 xgettimeofday(&rtp_time_0, 0);
207 /* There may have been a gap. Fix up the RTP time accordingly. */
210 uint64_t target_rtp_time;
212 /* Find the current time */
213 xgettimeofday(&now, 0);
214 /* Find the number of microseconds elapsed since rtp_time=0 */
215 delta = tvsub_us(now, rtp_time_0);
216 if(delta > UINT64_MAX / 88200)
217 fatal(0, "rtp_time=%llu now=%ld.%06ld rtp_time_0=%ld.%06ld delta=%llu (%lld)",
219 (long)now.tv_sec, (long)now.tv_usec,
220 (long)rtp_time_0.tv_sec, (long)rtp_time_0.tv_usec,
222 target_rtp_time = (delta * config->sample_format.rate
223 * config->sample_format.channels) / 1000000;
224 /* Overflows at ~6 years uptime with 44100Hz stereo */
226 /* rtp_time is the number of samples we've played. NB that we play
227 * RTP_AHEAD_MS ahead of ourselves, so it may legitimately be ahead of
228 * the value we deduce from time comparison.
230 * Suppose we have 1s track started at t=0, and another track begins to
231 * play at t=2s. Suppose 44100Hz stereo. We send 1s of audio over the
232 * next (about) one second, giving rtp_time=88200. rtp_time stops at this
235 * At t=2s we'll have calculated target_rtp_time=176400. In this case we
236 * set rtp_time=176400 and the player can correctly conclude that it
237 * should leave 1s between the tracks.
239 * It's never right to reduce rtp_time, for that would imply packets with
240 * overlapping timestamp ranges, which does not make sense.
242 target_rtp_time &= ~(uint64_t)1; /* stereo! */
243 if(target_rtp_time > rtp_time) {
244 /* More time has elapsed than we've transmitted samples. That implies
245 * we've been 'sending' silence. */
246 info("advancing rtp_time by %"PRIu64" samples",
247 target_rtp_time - rtp_time);
248 rtp_time = target_rtp_time;
249 } else if(target_rtp_time < rtp_time) {
250 info("would reverse rtp_time by %"PRIu64" samples",
251 rtp_time - target_rtp_time);
254 header.vpxcc = 2 << 6; /* V=2, P=0, X=0, CC=0 */
255 header.seq = htons(rtp_seq++);
256 header.timestamp = htonl((uint32_t)rtp_time);
257 header.ssrc = rtp_id;
258 header.mpt = (idled ? 0x80 : 0x00) | 10;
259 /* 10 = L16 = 16-bit x 2 x 44100KHz. We ought to deduce this value from
260 * the sample rate (in a library somewhere so that configuration.c can rule
261 * out invalid rates).
264 if(bytes > NETWORK_BYTES - sizeof header) {
265 bytes = NETWORK_BYTES - sizeof header;
266 /* Always send a whole number of frames */
267 bytes -= bytes % bpf;
269 /* "The RTP clock rate used for generating the RTP timestamp is independent
270 * of the number of channels and the encoding; it equals the number of
271 * sampling periods per second. For N-channel encodings, each sampling
272 * period (say, 1/8000 of a second) generates N samples. (This terminology
273 * is standard, but somewhat confusing, as the total number of samples
274 * generated per second is then the sampling rate times the channel
277 vec[0].iov_base = (void *)&header;
278 vec[0].iov_len = sizeof header;
279 vec[1].iov_base = playing->buffer + playing->start;
280 vec[1].iov_len = bytes;
282 written_bytes = writev(bfd, vec, 2);
283 } while(written_bytes < 0 && errno == EINTR);
284 if(written_bytes < 0) {
285 error(errno, "error transmitting audio data");
287 if(audio_errors == 10)
288 fatal(0, "too many audio errors");
292 written_bytes -= sizeof (struct rtp_header);
293 written_frames = written_bytes / bpf;
294 /* Advance RTP's notion of the time */
295 rtp_time += written_frames * config->sample_format.channels;
296 return written_frames;
301 /** @brief Set up poll array for network play */
302 static void network_beforepoll(int *timeoutp) {
305 uint64_t target_rtp_time;
306 const int64_t samples_per_second = config->sample_format.rate
307 * config->sample_format.channels;
308 int64_t lead, ahead_ms;
310 /* If we're starting then initialize the base time */
312 xgettimeofday(&rtp_time_0, 0);
313 /* We send audio data whenever we would otherwise get behind */
314 xgettimeofday(&now, 0);
315 target_us = tvsub_us(now, rtp_time_0);
316 if(target_us > UINT64_MAX / 88200)
317 fatal(0, "rtp_time=%llu rtp_time_0=%ld.%06ld now=%ld.%06ld target_us=%llu (%lld)\n",
319 (long)rtp_time_0.tv_sec, (long)rtp_time_0.tv_usec,
320 (long)now.tv_sec, (long)now.tv_usec,
321 target_us, target_us);
322 target_rtp_time = (target_us * config->sample_format.rate
323 * config->sample_format.channels)
325 /* Lead is how far ahead we are */
326 lead = rtp_time - target_rtp_time;
328 /* We're behind or even, so we'll need to write as soon as we can */
329 bfd_slot = addfd(bfd, POLLOUT);
331 /* We've ahead, we can afford to wait a bit even if the IP stack thinks it
332 * can accept more. */
333 ahead_ms = 1000 * lead / samples_per_second;
334 if(ahead_ms < *timeoutp)
335 *timeoutp = ahead_ms;
339 /** @brief Process poll() results for network play */
340 static int network_ready(void) {
341 if(fds[bfd_slot].revents & (POLLOUT | POLLERR))
347 const struct speaker_backend network_backend = {