Shorten copyright notice.
[paraslash.git] / vss.c
1 /* Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
2
3 /** \file vss.c The virtual streaming system.
4 *
5 * This contains the audio streaming code of para_server which is independent
6 * of the current audio format, audio file selector and of the activated
7 * senders.
8 */
9
10 #include <sys/socket.h>
11 #include <netinet/in.h>
12 #include <regex.h>
13 #include <osl.h>
14 #include <sys/types.h>
15 #include <arpa/inet.h>
16 #include <sys/un.h>
17 #include <netdb.h>
18 #include <lopsub.h>
19
20 #include "server.lsg.h"
21 #include "para.h"
22 #include "error.h"
23 #include "portable_io.h"
24 #include "fec.h"
25 #include "string.h"
26 #include "afh.h"
27 #include "afs.h"
28 #include "server.h"
29 #include "net.h"
30 #include "list.h"
31 #include "send.h"
32 #include "sched.h"
33 #include "vss.h"
34 #include "ipc.h"
35 #include "fd.h"
36
37 extern struct misc_meta_data *mmd;
38
39 extern void dccp_send_init(struct sender *);
40 extern void http_send_init(struct sender *);
41 extern void udp_send_init(struct sender *);
42
43 /** The list of supported senders. */
44 struct sender senders[] = {
45 {
46 .name = "http",
47 .init = http_send_init,
48 },
49 {
50 .name = "dccp",
51 .init = dccp_send_init,
52 },
53 {
54 .name = "udp",
55 .init = udp_send_init,
56 },
57 {
58 .name = NULL,
59 }
60 };
61
62 /** The possible states of the afs socket. */
63 enum afs_socket_status {
64 /** Socket is inactive. */
65 AFS_SOCKET_READY,
66 /** Socket fd was included in the write fd set for select(). */
67 AFS_SOCKET_CHECK_FOR_WRITE,
68 /** vss wrote a request to the socket and waits for reply from afs. */
69 AFS_SOCKET_AFD_PENDING
70 };
71
72 /** The task structure for the virtual streaming system. */
73 struct vss_task {
74 /** Copied from the -announce_time command line option. */
75 struct timeval announce_tv;
76 /** End of the announcing interval. */
77 struct timeval data_send_barrier;
78 /** End of the EOF interval. */
79 struct timeval eof_barrier;
80 /** Only used if --autoplay_delay was given. */
81 struct timeval autoplay_barrier;
82 /** Used for afs-server communication. */
83 int afs_socket;
84 /** The current state of \a afs_socket. */
85 enum afs_socket_status afsss;
86 /** The memory mapped audio file. */
87 char *map;
88 /** The size of the memory mapping. */
89 size_t mapsize;
90 /** Used by the scheduler. */
91 struct task *task;
92 /** Pointer to the header of the mapped audio file. */
93 char *header_buf;
94 /** Length of the audio file header. */
95 size_t header_len;
96 /** Time between audio file headers are sent. */
97 struct timeval header_interval;
98 /* Only used if afh supports dynamic chunks. */
99 void *afh_context;
100 };
101
102 /**
103 * The list of currently connected fec clients.
104 *
105 * Senders may use \ref vss_add_fec_client() to add entries to the list.
106 */
107 static struct list_head fec_client_list;
108
109 /**
110 * Data associated with one FEC group.
111 *
112 * A FEC group consists of a fixed number of slices and this number is given by
113 * the \a slices_per_group parameter of struct \ref fec_client_parms. Each FEC
114 * group contains a number of chunks of the current audio file.
115 *
116 * FEC slices directly correspond to the data packages sent by the paraslash
117 * senders that use FEC. Each slice is identified by its group number and its
118 * number within the group. All slices have the same size, but the last slice
119 * of the group may not be filled entirely.
120 */
121 struct fec_group {
122 /** The number of the FEC group. */
123 uint32_t num;
124 /** Number of bytes in this group. */
125 uint32_t bytes;
126 /** The first chunk of the current audio file belonging to the group. */
127 uint32_t first_chunk;
128 /** The number of chunks contained in this group. */
129 uint32_t num_chunks;
130 /** When the first chunk was sent. */
131 struct timeval start;
132 /** The duration of the full group. */
133 struct timeval duration;
134 /** The group duration divided by the number of slices. */
135 struct timeval slice_duration;
136 /** Group contains the audio file header that occupies that many slices. */
137 uint8_t num_header_slices;
138 /** Number of bytes per slice for this group. */
139 uint16_t slice_bytes;
140 };
141
142 /** A FEC client is always in one of these states. */
143 enum fec_client_state {
144 FEC_STATE_NONE = 0, /**< not initialized and not enabled */
145 FEC_STATE_DISABLED, /**< temporarily disabled */
146 FEC_STATE_READY_TO_RUN /**< initialized and enabled */
147 };
148
149 /**
150 * Describes one connected FEC client.
151 */
152 struct fec_client {
153 /** Current state of the client */
154 enum fec_client_state state;
155 /** The connected sender client (transport layer). */
156 struct sender_client *sc;
157 /** Parameters requested by the client. */
158 struct fec_client_parms *fcp;
159 /** Used by the core FEC code. */
160 struct fec_parms *parms;
161 /** The position of this client in the fec client list. */
162 struct list_head node;
163 /** When the first slice for this client was sent. */
164 struct timeval stream_start;
165 /** The first chunk sent to this FEC client. */
166 int first_stream_chunk;
167 /** Describes the current group. */
168 struct fec_group group;
169 /** The current slice. */
170 uint8_t current_slice_num;
171 /** The data to be FEC-encoded (point to a region within the mapped audio file). */
172 const unsigned char **src_data;
173 /** Last time an audio header was sent. */
174 struct timeval next_header_time;
175 /** Used for the last source pointer of an audio file. */
176 unsigned char *extra_src_buf;
177 /** Needed for the last slice of the audio file header. */
178 unsigned char *extra_header_buf;
179 /** Extra slices needed to store largest chunk + header. */
180 int num_extra_slices;
181 /** Contains the FEC-encoded data. */
182 unsigned char *enc_buf;
183 /** Maximal packet size. */
184 int mps;
185 };
186
187 /**
188 * Get the chunk time of the current audio file.
189 *
190 * \return A pointer to a struct containing the chunk time, or NULL,
191 * if currently no audio file is selected.
192 */
193 struct timeval *vss_chunk_time(void)
194 {
195 if (mmd->afd.afhi.chunk_tv.tv_sec == 0 &&
196 mmd->afd.afhi.chunk_tv.tv_usec == 0)
197 return NULL;
198 return &mmd->afd.afhi.chunk_tv;
199 }
200
201 /**
202 * Write a fec header to a buffer.
203 *
204 * \param buf The buffer to write to.
205 * \param h The fec header to write.
206 */
207 static void write_fec_header(struct fec_client *fc, struct vss_task *vsst)
208 {
209 char *buf = (char *)fc->enc_buf;
210 struct fec_group *g = &fc->group;
211 struct fec_client_parms *p = fc->fcp;
212
213 write_u32(buf, FEC_MAGIC);
214
215 write_u8(buf + 4, p->slices_per_group + fc->num_extra_slices);
216 write_u8(buf + 5, p->data_slices_per_group + fc->num_extra_slices);
217 write_u32(buf + 6, g->num_header_slices? vsst->header_len : 0);
218
219 write_u32(buf + 10, g->num);
220 write_u32(buf + 14, g->bytes);
221
222 write_u8(buf + 18, fc->current_slice_num);
223 write_u8(buf + 19, 0); /* unused */
224 write_u16(buf + 20, g->slice_bytes);
225 write_u8(buf + 22, g->first_chunk? 0 : 1);
226 write_u8(buf + 23, vsst->header_len? 1 : 0);
227 memset(buf + 24, 0, 8);
228 }
229
230 static bool need_audio_header(struct fec_client *fc, struct vss_task *vsst)
231 {
232 if (!mmd->current_chunk) {
233 tv_add(now, &vsst->header_interval, &fc->next_header_time);
234 return false;
235 }
236 if (!vsst->header_buf)
237 return false;
238 if (vsst->header_len == 0)
239 return false;
240 if (fc->group.num > 0) {
241 if (!fc->fcp->need_periodic_header)
242 return false;
243 if (tv_diff(&fc->next_header_time, now, NULL) > 0)
244 return false;
245 }
246 tv_add(now, &vsst->header_interval, &fc->next_header_time);
247 return true;
248 }
249
250 static bool need_data_slices(struct fec_client *fc, struct vss_task *vsst)
251 {
252 if (fc->group.num > 0)
253 return true;
254 if (!vsst->header_buf)
255 return true;
256 if (vsst->header_len == 0)
257 return true;
258 if (fc->fcp->need_periodic_header)
259 return true;
260 return false;
261 }
262
263 static int num_slices(long unsigned bytes, int max_payload, int rs)
264 {
265 int ret;
266
267 assert(max_payload > 0);
268 assert(rs > 0);
269 ret = DIV_ROUND_UP(bytes, max_payload);
270 if (ret + rs > 255)
271 return -E_BAD_CT;
272 return ret;
273 }
274
275 /* set group start and group duration */
276 static void set_group_timing(struct fec_client *fc, struct vss_task *vsst)
277 {
278 struct fec_group *g = &fc->group;
279 struct timeval *chunk_tv = vss_chunk_time();
280
281 if (!need_data_slices(fc, vsst))
282 ms2tv(200, &g->duration);
283 else
284 tv_scale(g->num_chunks, chunk_tv, &g->duration);
285 tv_divide(fc->fcp->slices_per_group + fc->num_extra_slices,
286 &g->duration, &g->slice_duration);
287 PARA_DEBUG_LOG("durations (group/chunk/slice): %lu/%lu/%lu\n",
288 tv2ms(&g->duration), tv2ms(chunk_tv), tv2ms(&g->slice_duration));
289 }
290
291 static int initialize_fec_client(struct fec_client *fc, struct vss_task *vsst)
292 {
293 int k, n, ret;
294 int hs, ds, rs; /* header/data/redundant slices */
295 struct fec_client_parms *fcp = fc->fcp;
296
297 /* set mps */
298 if (fcp->init_fec) {
299 /*
300 * Set the maximum slice size to the Maximum Packet Size if the
301 * transport protocol allows to determine this value. The user
302 * can specify a slice size up to this value.
303 */
304 ret = fcp->init_fec(fc->sc);
305 if (ret < 0)
306 return ret;
307 fc->mps = ret;
308 } else
309 fc->mps = generic_max_transport_msg_size(fc->sc->fd);
310 if (fc->mps <= FEC_HEADER_SIZE)
311 return -ERRNO_TO_PARA_ERROR(EINVAL);
312
313 rs = fc->fcp->slices_per_group - fc->fcp->data_slices_per_group;
314 ret = num_slices(vsst->header_len, fc->mps - FEC_HEADER_SIZE, rs);
315 if (ret < 0)
316 return ret;
317 hs = ret;
318 ret = num_slices(mmd->afd.max_chunk_size, fc->mps - FEC_HEADER_SIZE, rs);
319 if (ret < 0)
320 return ret;
321 ds = ret;
322 if (fc->fcp->need_periodic_header)
323 k = hs + ds;
324 else
325 k = PARA_MAX(hs, ds);
326 if (k < fc->fcp->data_slices_per_group)
327 k = fc->fcp->data_slices_per_group;
328 fc->num_extra_slices = k - fc->fcp->data_slices_per_group;
329 n = k + rs;
330 fec_free(fc->parms);
331 ret = fec_new(k, n, &fc->parms);
332 if (ret < 0)
333 return ret;
334 PARA_INFO_LOG("mps: %d, k: %d, n: %d, extra slices: %d\n",
335 fc->mps, k, n, fc->num_extra_slices);
336 fc->src_data = para_realloc(fc->src_data, k * sizeof(char *));
337 fc->enc_buf = para_realloc(fc->enc_buf, fc->mps);
338 fc->extra_src_buf = para_realloc(fc->extra_src_buf, fc->mps);
339 fc->extra_header_buf = para_realloc(fc->extra_header_buf, fc->mps);
340
341 fc->state = FEC_STATE_READY_TO_RUN;
342 fc->next_header_time.tv_sec = 0;
343 fc->stream_start = *now;
344 fc->first_stream_chunk = mmd->current_chunk;
345 return 1;
346 }
347
348 static void vss_get_chunk(int chunk_num, struct vss_task *vsst,
349 char **buf, size_t *sz)
350 {
351 int ret;
352
353 /*
354 * Chunk zero is special for header streams: It is the first portion of
355 * the audio file which consists of the audio file header. It may be
356 * arbitrary large due to embedded meta data. Audio format handlers may
357 * replace the header by a stripped one with meta data omitted which is
358 * of bounded size. We always use the stripped header for streaming
359 * rather than the unmodified header (chunk zero).
360 */
361 if (chunk_num == 0 && vsst->header_len > 0) {
362 assert(vsst->header_buf);
363 *buf = vsst->header_buf; /* stripped header */
364 *sz = vsst->header_len;
365 return;
366 }
367 ret = afh_get_chunk(chunk_num, &mmd->afd.afhi,
368 mmd->afd.audio_format_id, vsst->map, vsst->mapsize,
369 (const char **)buf, sz, &vsst->afh_context);
370 if (ret < 0) {
371 PARA_WARNING_LOG("could not get chunk %d: %s\n",
372 chunk_num, para_strerror(-ret));
373 *buf = NULL;
374 *sz = 0;
375 }
376 }
377
378 static void compute_group_size(struct vss_task *vsst, struct fec_group *g,
379 int max_bytes)
380 {
381 char *buf;
382 size_t len;
383 int i, max_chunks = PARA_MAX(1LU, 150 / tv2ms(vss_chunk_time()));
384
385 if (g->first_chunk == 0) {
386 g->num_chunks = 1;
387 vss_get_chunk(0, vsst, &buf, &len);
388 g->bytes = len;
389 return;
390 }
391
392 g->num_chunks = 0;
393 g->bytes = 0;
394 /*
395 * Include chunks into the group until the group duration is at least
396 * 150ms. For ogg and wma, a single chunk's duration (ogg page/wma
397 * super frame) is already larger than 150ms, so a FEC group consists
398 * of exactly one chunk for these audio formats.
399 */
400 for (i = 0;; i++) {
401 int chunk_num = g->first_chunk + i;
402
403 if (g->bytes > 0 && i >= max_chunks) /* duration limit */
404 break;
405 if (chunk_num >= mmd->afd.afhi.chunks_total) /* eof */
406 break;
407 vss_get_chunk(chunk_num, vsst, &buf, &len);
408 if (g->bytes + len > max_bytes)
409 break;
410 /* Include this chunk */
411 g->bytes += len;
412 g->num_chunks++;
413 }
414 assert(g->num_chunks);
415 }
416
417 /*
418 * Compute the slice size of the next group.
419 *
420 * The FEC parameters n and k are fixed but the slice size varies per
421 * FEC group. We'd like to choose slices as small as possible to avoid
422 * unnecessary FEC calculations but large enough to guarantee that the
423 * k data slices suffice to encode the header (if needed) and the data
424 * chunk(s).
425 *
426 * Once we know the payload of the next group, we define the number s
427 * of bytes per slice for this group by
428 *
429 * s = ceil(payload / k)
430 *
431 * However, for header streams, computing s is more complicated since no
432 * overlapping of header and data slices is possible. Hence we have k >=
433 * 2 and s must satisfy
434 *
435 * (*) ceil(h / s) + ceil(d / s) <= k
436 *
437 * where h and d are payload of the header and the data chunk(s)
438 * respectively. In general there is no value for s such that (*)
439 * becomes an equality, for example if h = 4000, d = 5000 and k = 10.
440 *
441 * We use the following approach for computing a suitable value for s:
442 *
443 * Let
444 * k1 := ceil(k * min(h, d) / (h + d)),
445 * k2 := k - k1.
446 *
447 * Note that k >= 2 implies k1 > 0 and k2 > 0, so
448 *
449 * s := max(ceil(min(h, d) / k1), ceil(max(h, d) / k2))
450 *
451 * is well-defined. Inequality (*) holds for this value of s since k1
452 * slices suffice to store min(h, d) while k2 slices suffice to store
453 * max(h, d), i.e. the first addent of (*) is bounded by k1 and the
454 * second by k2.
455 *
456 * For the above example we obtain
457 *
458 * k1 = ceil(10 * 4000 / 9000) = 5, k2 = 5,
459 * s = max(4000 / 5, 5000 / 5) = 1000,
460 *
461 * which is optimal since a slice size of 999 bytes would already require
462 * 11 slices.
463 */
464 static int compute_slice_size(struct fec_client *fc, struct vss_task *vsst)
465 {
466 struct fec_group *g = &fc->group;
467 int k = fc->fcp->data_slices_per_group + fc->num_extra_slices;
468 int n = fc->fcp->slices_per_group + fc->num_extra_slices;
469 int ret, k1, k2, h, d, min, max, sum;
470 int max_slice_bytes = fc->mps - FEC_HEADER_SIZE;
471 int max_group_bytes;
472
473 if (!need_audio_header(fc, vsst)) {
474 max_group_bytes = k * max_slice_bytes;
475 g->num_header_slices = 0;
476 compute_group_size(vsst, g, max_group_bytes);
477 g->slice_bytes = DIV_ROUND_UP(g->bytes, k);
478 if (g->slice_bytes == 0)
479 g->slice_bytes = 1;
480 return 1;
481 }
482 if (!need_data_slices(fc, vsst)) {
483 g->bytes = 0;
484 g->num_chunks = 0;
485 g->slice_bytes = DIV_ROUND_UP(vsst->header_len, k);
486 g->num_header_slices = k;
487 return 1;
488 }
489 h = vsst->header_len;
490 max_group_bytes = (k - num_slices(h, max_slice_bytes, n - k))
491 * max_slice_bytes;
492 compute_group_size(vsst, g, max_group_bytes);
493 d = g->bytes;
494 if (d == 0) {
495 g->slice_bytes = DIV_ROUND_UP(h, k);
496 ret = num_slices(vsst->header_len, g->slice_bytes, n - k);
497 if (ret < 0)
498 return ret;
499 g->num_header_slices = ret;
500 return 1;
501 }
502 min = PARA_MIN(h, d);
503 max = PARA_MAX(h, d);
504 sum = h + d;
505 k1 = DIV_ROUND_UP(k * min, sum);
506 k2 = k - k1;
507 assert(k1 > 0);
508 assert(k2 > 0);
509
510 g->slice_bytes = PARA_MAX(DIV_ROUND_UP(min, k1), DIV_ROUND_UP(max, k2));
511 /*
512 * This value of s := g->slice_bytes satisfies inequality (*) above,
513 * but it might be larger than max_slice_bytes. However, we know that
514 * max_slice_bytes are sufficient to store header and data, so:
515 */
516 g->slice_bytes = PARA_MIN((int)g->slice_bytes, max_slice_bytes);
517
518 ret = num_slices(vsst->header_len, g->slice_bytes, n - k);
519 if (ret < 0)
520 return ret;
521 g->num_header_slices = ret;
522 return 1;
523 }
524
525 static int setup_next_fec_group(struct fec_client *fc, struct vss_task *vsst)
526 {
527 int ret, i, k, n, data_slices;
528 size_t len;
529 char *buf, *p;
530 struct fec_group *g = &fc->group;
531
532 if (fc->state == FEC_STATE_NONE) {
533 ret = initialize_fec_client(fc, vsst);
534 if (ret < 0)
535 return ret;
536 g->first_chunk = mmd->current_chunk;
537 g->num = 0;
538 g->start = *now;
539 } else {
540 struct timeval tmp;
541 if (g->first_chunk + g->num_chunks >= mmd->afd.afhi.chunks_total)
542 return 0;
543 /*
544 * Start and duration of this group depend only on the previous
545 * group. Compute the new group start as g->start += g->duration.
546 */
547 tmp = g->start;
548 tv_add(&tmp, &g->duration, &g->start);
549 set_group_timing(fc, vsst);
550 g->first_chunk += g->num_chunks;
551 g->num++;
552 }
553 k = fc->fcp->data_slices_per_group + fc->num_extra_slices;
554 n = fc->fcp->slices_per_group + fc->num_extra_slices;
555
556 compute_slice_size(fc, vsst);
557 assert(g->slice_bytes > 0);
558 ret = num_slices(g->bytes, g->slice_bytes, n - k);
559 if (ret < 0)
560 return ret;
561 data_slices = ret;
562 assert(g->num_header_slices + data_slices <= k);
563 fc->current_slice_num = 0;
564 if (g->num == 0)
565 set_group_timing(fc, vsst);
566 /* setup header slices */
567 buf = vsst->header_buf;
568 for (i = 0; i < g->num_header_slices; i++) {
569 uint32_t payload_size;
570 if (buf + g->slice_bytes <= vsst->header_buf + vsst->header_len) {
571 fc->src_data[i] = (const unsigned char *)buf;
572 buf += g->slice_bytes;
573 continue;
574 }
575 /*
576 * Can not use vss->header_buf for this slice as it
577 * goes beyond the buffer. This slice will not be fully
578 * used.
579 */
580 payload_size = vsst->header_buf + vsst->header_len - buf;
581 memcpy(fc->extra_header_buf, buf, payload_size);
582 if (payload_size < g->slice_bytes)
583 memset(fc->extra_header_buf + payload_size, 0,
584 g->slice_bytes - payload_size);
585 /*
586 * There might be more than one header slice to fill although
587 * only the first one will be used. Set all header slices to
588 * our extra buffer.
589 */
590 while (i < g->num_header_slices)
591 fc->src_data[i++] = fc->extra_header_buf;
592 break; /* we don't want i to be increased. */
593 }
594
595 /*
596 * Setup data slices. Note that for ogg streams chunk 0 points to a
597 * buffer on the heap rather than to the mapped audio file.
598 */
599 vss_get_chunk(g->first_chunk, vsst, &buf, &len);
600 for (p = buf; i < g->num_header_slices + data_slices; i++) {
601 if (p + g->slice_bytes > buf + g->bytes) {
602 /*
603 * We must make a copy for this slice since using p
604 * directly would exceed the buffer.
605 */
606 uint32_t payload_size = buf + g->bytes - p;
607 assert(payload_size + FEC_HEADER_SIZE <= fc->mps);
608 memcpy(fc->extra_src_buf, p, payload_size);
609 if (payload_size < g->slice_bytes)
610 memset(fc->extra_src_buf + payload_size, 0,
611 g->slice_bytes - payload_size);
612 fc->src_data[i] = fc->extra_src_buf;
613 i++;
614 break;
615 }
616 fc->src_data[i] = (const unsigned char *)p;
617 p += g->slice_bytes;
618 }
619 if (i < k) {
620 /* use arbitrary data for all remaining slices */
621 buf = vsst->map;
622 for (; i < k; i++)
623 fc->src_data[i] = (const unsigned char *)buf;
624 }
625 PARA_DEBUG_LOG("FEC group %u: %u chunks (%u - %u), %u bytes\n",
626 g->num, g->num_chunks, g->first_chunk,
627 g->first_chunk + g->num_chunks - 1, g->bytes
628 );
629 PARA_DEBUG_LOG("slice_bytes: %d, %d header slices, %d data slices\n",
630 g->slice_bytes, g->num_header_slices, data_slices
631 );
632 return 1;
633 }
634
635 static int compute_next_fec_slice(struct fec_client *fc, struct vss_task *vsst)
636 {
637 if (fc->state == FEC_STATE_NONE || fc->current_slice_num
638 == fc->fcp->slices_per_group + fc->num_extra_slices) {
639 int ret = setup_next_fec_group(fc, vsst);
640 if (ret == 0)
641 return 0;
642 if (ret < 0) {
643 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
644 PARA_ERROR_LOG("FEC client temporarily disabled\n");
645 fc->state = FEC_STATE_DISABLED;
646 return ret;
647 }
648 }
649 write_fec_header(fc, vsst);
650 fec_encode(fc->parms, fc->src_data, fc->enc_buf + FEC_HEADER_SIZE,
651 fc->current_slice_num, fc->group.slice_bytes);
652 return 1;
653 }
654
655 /**
656 * Return a buffer that marks the end of the stream.
657 *
658 * \param buf Result pointer.
659 * \return The length of the eof buffer.
660 *
661 * This is used for (multicast) udp streaming where closing the socket on the
662 * sender might not give rise to an eof condition at the peer.
663 */
664 size_t vss_get_fec_eof_packet(const char **buf)
665 {
666 static const char fec_eof_packet[FEC_HEADER_SIZE] = FEC_EOF_PACKET;
667 *buf = fec_eof_packet;
668 return FEC_HEADER_SIZE;
669 }
670
671 /**
672 * Add one entry to the list of active fec clients.
673 *
674 * \param sc Generic sender_client data of the transport layer.
675 * \param fcp FEC parameters as supplied by the transport layer.
676 *
677 * \return Newly allocated fec_client struct.
678 */
679 struct fec_client *vss_add_fec_client(struct sender_client *sc,
680 struct fec_client_parms *fcp)
681 {
682 struct fec_client *fc = para_calloc(sizeof(*fc));
683
684 fc->sc = sc;
685 fc->fcp = fcp;
686 para_list_add(&fc->node, &fec_client_list);
687 return fc;
688 }
689
690 /**
691 * Remove one entry from the list of active fec clients.
692 *
693 * \param fc The client to be removed.
694 */
695 void vss_del_fec_client(struct fec_client *fc)
696 {
697 list_del(&fc->node);
698 free(fc->src_data);
699 free(fc->enc_buf);
700 free(fc->extra_src_buf);
701 free(fc->extra_header_buf);
702 fec_free(fc->parms);
703 free(fc);
704 }
705
706 /*
707 * Compute if/when next slice is due. If it isn't due yet and \a diff is
708 * not \p Null, compute the time difference next - now, where
709 *
710 * next = stream_start + (first_group_chunk - first_stream_chunk)
711 * * chunk_time + slice_num * slice_time
712 */
713 static int next_slice_is_due(struct fec_client *fc, struct timeval *diff)
714 {
715 struct timeval tmp, next;
716 int ret;
717
718 if (fc->state == FEC_STATE_NONE)
719 return 1;
720 tv_scale(fc->current_slice_num, &fc->group.slice_duration, &tmp);
721 tv_add(&tmp, &fc->group.start, &next);
722 ret = tv_diff(&next, now, diff);
723 return ret < 0? 1 : 0;
724 }
725
726 static void set_eof_barrier(struct vss_task *vsst)
727 {
728 struct fec_client *fc;
729 struct timeval timeout = {1, 0}, *chunk_tv = vss_chunk_time();
730
731 if (!chunk_tv)
732 goto out;
733 list_for_each_entry(fc, &fec_client_list, node) {
734 struct timeval group_duration;
735
736 if (fc->state != FEC_STATE_READY_TO_RUN)
737 continue;
738 tv_scale(fc->group.num_chunks, chunk_tv, &group_duration);
739 if (tv_diff(&timeout, &group_duration, NULL) < 0)
740 timeout = group_duration;
741 }
742 out:
743 tv_add(now, &timeout, &vsst->eof_barrier);
744 }
745
746 /**
747 * Check if vss status flag \a P (playing) is set.
748 *
749 * \return Greater than zero if playing, zero otherwise.
750 *
751 */
752 unsigned int vss_playing(void)
753 {
754 return mmd->new_vss_status_flags & VSS_PLAYING;
755 }
756
757 /**
758 * Check if the \a N (next) status flag is set.
759 *
760 * \return Greater than zero if set, zero if not.
761 *
762 */
763 unsigned int vss_next(void)
764 {
765 return mmd->new_vss_status_flags & VSS_NEXT;
766 }
767
768 /**
769 * Check if a reposition request is pending.
770 *
771 * \return Greater than zero if true, zero otherwise.
772 *
773 */
774 unsigned int vss_repos(void)
775 {
776 return mmd->new_vss_status_flags & VSS_REPOS;
777 }
778
779 /**
780 * Check if the vss is currently paused.
781 *
782 * \return Greater than zero if paused, zero otherwise.
783 *
784 */
785 unsigned int vss_paused(void)
786 {
787 return !(mmd->new_vss_status_flags & VSS_NEXT)
788 && !(mmd->new_vss_status_flags & VSS_PLAYING);
789 }
790
791 /**
792 * Check if the vss is currently stopped.
793 *
794 * \return Greater than zero if paused, zero otherwise.
795 *
796 */
797 unsigned int vss_stopped(void)
798 {
799 return (mmd->new_vss_status_flags & VSS_NEXT)
800 && !(mmd->new_vss_status_flags & VSS_PLAYING);
801 }
802
803 static int chk_barrier(const char *bname, const struct timeval *barrier,
804 struct timeval *diff, int print_log)
805 {
806 long ms;
807
808 if (tv_diff(now, barrier, diff) > 0)
809 return 1;
810 ms = tv2ms(diff);
811 if (print_log && ms)
812 PARA_DEBUG_LOG("%s barrier: %lims left\n", bname, ms);
813 return -1;
814 }
815
816 static void vss_compute_timeout(struct sched *s, struct vss_task *vsst)
817 {
818 struct timeval tv;
819 struct fec_client *fc;
820
821 if (!vss_playing() || !vsst->map)
822 return;
823 if (vss_next() && vsst->map) /* only sleep a bit, nec*/
824 return sched_request_timeout_ms(100, s);
825
826 /* Each of these barriers must have passed until we may proceed */
827 if (sched_request_barrier(&vsst->autoplay_barrier, s) == 1)
828 return;
829 if (sched_request_barrier(&vsst->eof_barrier, s) == 1)
830 return;
831 if (sched_request_barrier(&vsst->data_send_barrier, s) == 1)
832 return;
833 /*
834 * Compute the select timeout as the minimal time until the next
835 * chunk/slice is due for any client.
836 */
837 compute_chunk_time(mmd->chunks_sent, &mmd->afd.afhi.chunk_tv,
838 &mmd->stream_start, &tv);
839 if (sched_request_barrier_or_min_delay(&tv, s) == 0)
840 return;
841 list_for_each_entry(fc, &fec_client_list, node) {
842 if (fc->state != FEC_STATE_READY_TO_RUN)
843 continue;
844 if (next_slice_is_due(fc, &tv))
845 return sched_min_delay(s);
846 sched_request_timeout(&tv, s);
847 }
848 }
849
850 static void vss_eof(struct vss_task *vsst)
851 {
852
853 if (!vsst->map)
854 return;
855 if (mmd->new_vss_status_flags & VSS_NOMORE)
856 mmd->new_vss_status_flags = VSS_NEXT;
857 set_eof_barrier(vsst);
858 afh_free_header(vsst->header_buf, mmd->afd.audio_format_id);
859 vsst->header_buf = NULL;
860 para_munmap(vsst->map, vsst->mapsize);
861 vsst->map = NULL;
862 mmd->chunks_sent = 0;
863 //mmd->offset = 0;
864 mmd->afd.afhi.seconds_total = 0;
865 mmd->afd.afhi.chunk_tv.tv_sec = 0;
866 mmd->afd.afhi.chunk_tv.tv_usec = 0;
867 free(mmd->afd.afhi.chunk_table);
868 mmd->afd.afhi.chunk_table = NULL;
869 vsst->mapsize = 0;
870 afh_close(vsst->afh_context, mmd->afd.audio_format_id);
871 vsst->afh_context = NULL;
872 mmd->events++;
873 }
874
875 static int need_to_request_new_audio_file(struct vss_task *vsst)
876 {
877 struct timeval diff;
878
879 if (vsst->map) /* have audio file */
880 return 0;
881 if (!vss_playing()) /* don't need one */
882 return 0;
883 if (mmd->new_vss_status_flags & VSS_NOMORE)
884 return 0;
885 if (vsst->afsss == AFS_SOCKET_AFD_PENDING) /* already requested one */
886 return 0;
887 if (chk_barrier("autoplay_delay", &vsst->autoplay_barrier,
888 &diff, 1) < 0)
889 return 0;
890 return 1;
891 }
892
893 static void set_mmd_offset(void)
894 {
895 struct timeval offset;
896 tv_scale(mmd->current_chunk, &mmd->afd.afhi.chunk_tv, &offset);
897 mmd->offset = tv2ms(&offset);
898 }
899
900 static void vss_pre_select(struct sched *s, void *context)
901 {
902 int i;
903 struct vss_task *vsst = context;
904
905 if (need_to_request_new_audio_file(vsst)) {
906 PARA_DEBUG_LOG("ready and playing, but no audio file\n");
907 para_fd_set(vsst->afs_socket, &s->wfds, &s->max_fileno);
908 vsst->afsss = AFS_SOCKET_CHECK_FOR_WRITE;
909 } else
910 para_fd_set(vsst->afs_socket, &s->rfds, &s->max_fileno);
911 for (i = 0; senders[i].name; i++) {
912 if (!senders[i].pre_select)
913 continue;
914 senders[i].pre_select(&s->max_fileno, &s->rfds, &s->wfds);
915 }
916 vss_compute_timeout(s, vsst);
917 }
918
919 static int recv_afs_msg(int afs_socket, int *fd, uint32_t *code, uint32_t *data)
920 {
921 char control[255] __a_aligned(8), buf[8];
922 struct msghdr msg = {.msg_iov = NULL};
923 struct cmsghdr *cmsg;
924 struct iovec iov;
925 int ret = 0;
926
927 *fd = -1;
928 iov.iov_base = buf;
929 iov.iov_len = sizeof(buf);
930 msg.msg_iov = &iov;
931 msg.msg_iovlen = 1;
932 msg.msg_control = control;
933 msg.msg_controllen = sizeof(control);
934 memset(buf, 0, sizeof(buf));
935 ret = recvmsg(afs_socket, &msg, 0);
936 if (ret < 0)
937 return -ERRNO_TO_PARA_ERROR(errno);
938 if (iov.iov_len != sizeof(buf))
939 return -E_AFS_SHORT_READ;
940 *code = *(uint32_t*)buf;
941 *data = *(uint32_t*)(buf + 4);
942 for (cmsg = CMSG_FIRSTHDR(&msg); cmsg; cmsg = CMSG_NXTHDR(&msg, cmsg)) {
943 if (cmsg->cmsg_level != SOL_SOCKET
944 || cmsg->cmsg_type != SCM_RIGHTS)
945 continue;
946 if ((cmsg->cmsg_len - CMSG_LEN(0)) / sizeof(int) != 1)
947 continue;
948 *fd = *(int *)CMSG_DATA(cmsg);
949 }
950 return 1;
951 }
952
953 #ifndef MAP_POPULATE
954 #define MAP_POPULATE 0
955 #endif
956
957 static void recv_afs_result(struct vss_task *vsst, fd_set *rfds)
958 {
959 int ret, passed_fd, shmid;
960 uint32_t afs_code = 0, afs_data = 0;
961 struct stat statbuf;
962
963 if (!FD_ISSET(vsst->afs_socket, rfds))
964 return;
965 ret = recv_afs_msg(vsst->afs_socket, &passed_fd, &afs_code, &afs_data);
966 if (ret == -ERRNO_TO_PARA_ERROR(EAGAIN))
967 return;
968 if (ret < 0)
969 goto err;
970 vsst->afsss = AFS_SOCKET_READY;
971 PARA_DEBUG_LOG("fd: %d, code: %u, shmid: %u\n", passed_fd, afs_code,
972 afs_data);
973 ret = -E_NOFD;
974 if (afs_code != NEXT_AUDIO_FILE)
975 goto err;
976 if (passed_fd < 0)
977 goto err;
978 shmid = afs_data;
979 ret = load_afd(shmid, &mmd->afd);
980 if (ret < 0)
981 goto err;
982 shm_destroy(shmid);
983 ret = fstat(passed_fd, &statbuf);
984 if (ret < 0) {
985 PARA_ERROR_LOG("fstat error:\n");
986 ret = -ERRNO_TO_PARA_ERROR(errno);
987 goto err;
988 }
989 ret = para_mmap(statbuf.st_size, PROT_READ, MAP_PRIVATE | MAP_POPULATE,
990 passed_fd, 0, &vsst->map);
991 if (ret < 0)
992 goto err;
993 vsst->mapsize = statbuf.st_size;
994 close(passed_fd);
995 mmd->chunks_sent = 0;
996 mmd->current_chunk = 0;
997 mmd->offset = 0;
998 mmd->events++;
999 mmd->num_played++;
1000 mmd->new_vss_status_flags &= (~VSS_NEXT);
1001 afh_get_header(&mmd->afd.afhi, mmd->afd.audio_format_id,
1002 vsst->map, vsst->mapsize, &vsst->header_buf, &vsst->header_len);
1003 return;
1004 err:
1005 free(mmd->afd.afhi.chunk_table);
1006 if (passed_fd >= 0)
1007 close(passed_fd);
1008 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
1009 mmd->new_vss_status_flags = VSS_NEXT;
1010 }
1011
1012 /**
1013 * Main sending function.
1014 *
1015 * This function gets called from vss_post_select(). It checks whether the next
1016 * chunk of data should be pushed out. It obtains a pointer to the data to be
1017 * sent out as well as its length from mmd->afd.afhi. This information is then
1018 * passed to each supported sender's send() function as well as to the send()
1019 * functions of each registered fec client.
1020 */
1021 static void vss_send(struct vss_task *vsst)
1022 {
1023 int i;
1024 bool fec_active = false;
1025 struct timeval due;
1026 struct fec_client *fc, *tmp_fc;
1027
1028 if (!vsst->map || !vss_playing())
1029 return;
1030 if (chk_barrier("eof", &vsst->eof_barrier, &due, 1) < 0)
1031 return;
1032 if (chk_barrier("data send", &vsst->data_send_barrier, &due, 1) < 0)
1033 return;
1034 list_for_each_entry_safe(fc, tmp_fc, &fec_client_list, node) {
1035 if (fc->state == FEC_STATE_DISABLED)
1036 continue;
1037 if (!next_slice_is_due(fc, NULL)) {
1038 fec_active = true;
1039 continue;
1040 }
1041 if (compute_next_fec_slice(fc, vsst) <= 0)
1042 continue;
1043 PARA_DEBUG_LOG("sending %u:%u (%u bytes)\n", fc->group.num,
1044 fc->current_slice_num, fc->group.slice_bytes);
1045 fc->current_slice_num++;
1046 fc->fcp->send_fec(fc->sc, (char *)fc->enc_buf,
1047 fc->group.slice_bytes + FEC_HEADER_SIZE);
1048 fec_active = true;
1049 }
1050 if (mmd->current_chunk >= mmd->afd.afhi.chunks_total) { /* eof */
1051 if (!fec_active)
1052 mmd->new_vss_status_flags |= VSS_NEXT;
1053 return;
1054 }
1055 compute_chunk_time(mmd->chunks_sent, &mmd->afd.afhi.chunk_tv,
1056 &mmd->stream_start, &due);
1057 if (tv_diff(&due, now, NULL) <= 0) {
1058 char *buf;
1059 size_t len;
1060
1061 if (!mmd->chunks_sent) {
1062 mmd->stream_start = *now;
1063 mmd->events++;
1064 set_mmd_offset();
1065 }
1066 vss_get_chunk(mmd->current_chunk, vsst, &buf, &len);
1067 for (i = 0; senders[i].name; i++) {
1068 /*
1069 * We call ->send() even if len is zero because senders
1070 * might have data queued which can be sent now.
1071 */
1072 if (!senders[i].send)
1073 continue;
1074 senders[i].send(mmd->current_chunk, mmd->chunks_sent,
1075 buf, len, vsst->header_buf, vsst->header_len);
1076 }
1077 mmd->chunks_sent++;
1078 mmd->current_chunk++;
1079 }
1080 }
1081
1082 static int vss_post_select(struct sched *s, void *context)
1083 {
1084 int ret, i;
1085 struct vss_task *vsst = context;
1086
1087 if (!vsst->map || vss_next() || vss_paused() || vss_repos()) {
1088 /* shut down senders and fec clients */
1089 struct fec_client *fc, *tmp;
1090 for (i = 0; senders[i].name; i++)
1091 if (senders[i].shutdown_clients)
1092 senders[i].shutdown_clients();
1093 list_for_each_entry_safe(fc, tmp, &fec_client_list, node)
1094 fc->state = FEC_STATE_NONE;
1095 mmd->stream_start.tv_sec = 0;
1096 mmd->stream_start.tv_usec = 0;
1097 }
1098 if (vss_next())
1099 vss_eof(vsst);
1100 else if (vss_paused()) {
1101 if (mmd->chunks_sent)
1102 set_eof_barrier(vsst);
1103 mmd->chunks_sent = 0;
1104 } else if (vss_repos()) { /* repositioning due to ff/jmp command */
1105 tv_add(now, &vsst->announce_tv, &vsst->data_send_barrier);
1106 set_eof_barrier(vsst);
1107 mmd->chunks_sent = 0;
1108 mmd->current_chunk = afh_get_start_chunk(mmd->repos_request,
1109 &mmd->afd.afhi, mmd->afd.audio_format_id);
1110 mmd->new_vss_status_flags &= ~VSS_REPOS;
1111 set_mmd_offset();
1112 }
1113 /* If a sender command is pending, run it. */
1114 if (mmd->sender_cmd_data.cmd_num >= 0) {
1115 int num = mmd->sender_cmd_data.cmd_num,
1116 sender_num = mmd->sender_cmd_data.sender_num;
1117
1118 if (senders[sender_num].client_cmds[num]) {
1119 ret = senders[sender_num].client_cmds[num]
1120 (&mmd->sender_cmd_data);
1121 if (ret < 0)
1122 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
1123 }
1124 mmd->sender_cmd_data.cmd_num = -1;
1125 }
1126 if (vsst->afsss != AFS_SOCKET_CHECK_FOR_WRITE)
1127 recv_afs_result(vsst, &s->rfds);
1128 else if (FD_ISSET(vsst->afs_socket, &s->wfds)) {
1129 PARA_NOTICE_LOG("requesting new fd from afs\n");
1130 ret = write_buffer(vsst->afs_socket, "new");
1131 if (ret < 0)
1132 PARA_CRIT_LOG("%s\n", para_strerror(-ret));
1133 else
1134 vsst->afsss = AFS_SOCKET_AFD_PENDING;
1135 }
1136 for (i = 0; senders[i].name; i++) {
1137 if (!senders[i].post_select)
1138 continue;
1139 senders[i].post_select(&s->rfds, &s->wfds);
1140 }
1141 if ((vss_playing() && !(mmd->vss_status_flags & VSS_PLAYING)) ||
1142 (vss_next() && vss_playing()))
1143 tv_add(now, &vsst->announce_tv, &vsst->data_send_barrier);
1144 vss_send(vsst);
1145 return 0;
1146 }
1147
1148 /**
1149 * Initialize the virtual streaming system task.
1150 *
1151 * \param afs_socket The fd for communication with afs.
1152 * \param s The scheduler to register the vss task to.
1153 *
1154 * This also initializes all supported senders and starts streaming
1155 * if the --autoplay command line flag was given.
1156 */
1157 void vss_init(int afs_socket, struct sched *s)
1158 {
1159 static struct vss_task vss_task_struct, *vsst = &vss_task_struct;
1160 int i;
1161 long unsigned announce_time = OPT_UINT32_VAL(ANNOUNCE_TIME),
1162 autoplay_delay = OPT_UINT32_VAL(AUTOPLAY_DELAY);
1163 vsst->header_interval.tv_sec = 5; /* should this be configurable? */
1164 vsst->afs_socket = afs_socket;
1165 ms2tv(announce_time, &vsst->announce_tv);
1166 PARA_INFO_LOG("announce timeval: %lums\n", tv2ms(&vsst->announce_tv));
1167 INIT_LIST_HEAD(&fec_client_list);
1168 for (i = 0; senders[i].name; i++) {
1169 PARA_NOTICE_LOG("initializing %s sender\n", senders[i].name);
1170 senders[i].init(&senders[i]);
1171 }
1172 mmd->sender_cmd_data.cmd_num = -1;
1173 if (OPT_GIVEN(AUTOPLAY)) {
1174 struct timeval tmp;
1175 mmd->vss_status_flags |= VSS_PLAYING;
1176 mmd->new_vss_status_flags |= VSS_PLAYING;
1177 ms2tv(autoplay_delay, &tmp);
1178 tv_add(clock_get_realtime(NULL), &tmp, &vsst->autoplay_barrier);
1179 tv_add(&vsst->autoplay_barrier, &vsst->announce_tv,
1180 &vsst->data_send_barrier);
1181 }
1182 vsst->task = task_register(&(struct task_info) {
1183 .name = "vss task",
1184 .pre_select = vss_pre_select,
1185 .post_select = vss_post_select,
1186 .context = vsst,
1187 }, s);
1188 }