Minor documentation fixes.
[paraslash.git] / vss.c
1 /*
2  * Copyright (C) 1997-2009 Andre Noll <maan@systemlinux.org>
3  *
4  * Licensed under the GPL v2. For licencing details see COPYING.
5  */
6
7 /** \file vss.c The virtual streaming system.
8  *
9  * This contains the audio streaming code of para_server which is independent
10  * of the current audio format, audio file selector and of the activated
11  * senders.
12  */
13
14 #include <dirent.h>
15
16 #include "para.h"
17 #include "error.h"
18 #include "portable_io.h"
19 #include "fec.h"
20 #include "string.h"
21 #include "afh.h"
22 #include "afs.h"
23 #include "server.h"
24 #include "net.h"
25 #include "server.cmdline.h"
26 #include "list.h"
27 #include "vss.h"
28 #include "send.h"
29 #include "ipc.h"
30 #include "fd.h"
31 #include "sched.h"
32
33 extern struct misc_meta_data *mmd;
34
35 extern void dccp_send_init(struct sender *);
36 extern void http_send_init(struct sender *);
37 extern void udp_send_init(struct sender *);
38
39 /** The list of supported senders. */
40 struct sender senders[] = {
41         {
42                 .name = "http",
43                 .init = http_send_init,
44         },
45         {
46                 .name = "dccp",
47                 .init = dccp_send_init,
48         },
49         {
50                 .name = "udp",
51                 .init = udp_send_init,
52         },
53         {
54                 .name = NULL,
55         }
56 };
57
58 /** The possible states of the afs socket. */
59 enum afs_socket_status {
60         /** Socket is inactive. */
61         AFS_SOCKET_READY,
62         /** Socket fd was included in the write fd set for select(). */
63         AFS_SOCKET_CHECK_FOR_WRITE,
64         /** vss wrote a request to the socket and waits for reply from afs. */
65         AFS_SOCKET_AFD_PENDING
66 };
67
68 /** The task structure for the virtual streaming system. */
69 struct vss_task {
70         /** Copied from the -announce_time command line option. */
71         struct timeval announce_tv;
72         /** End of the announcing interval. */
73         struct timeval data_send_barrier;
74         /** End of the EOF interval. */
75         struct timeval eof_barrier;
76         /** Only used if --autoplay_delay was given. */
77         struct timeval autoplay_barrier;
78         /** Used for afs-server communication. */
79         int afs_socket;
80         /** The current state of \a afs_socket. */
81         enum afs_socket_status afsss;
82         /** The memory mapped audio file. */
83         char *map;
84         /** Used by the scheduler. */
85         struct task task;
86         /** Pointer to the header of the mapped audio file. */
87         const char *header_buf;
88         /** Length of the audio file header. */
89         size_t header_len;
90         /** Time between audio file headers are sent. */
91         struct timeval header_interval;
92 };
93
94 /**
95  * The list of currently connected fec clients.
96  *
97  * Senders may use \ref vss_add_fec_client() to add entries to the list.
98  */
99 static struct list_head fec_client_list;
100
101 /**
102  * Data associated with one FEC group.
103  *
104  * A FEC group consists of a fixed number of slices and this number is given by
105  * the \a slices_per_group parameter of struct \ref fec_client_parms. Each FEC
106  * group contains a number of chunks of the current audio file.
107  *
108  * FEC slices directly correspond to the data packages sent by the paraslash
109  * senders that use FEC. Each slice is identified by its group number and its
110  * number within the group. All slices have the same size, but the last slice
111  * of the group may not be filled entirely.
112  */
113 struct fec_group {
114         /** The number of the FEC group. */
115         uint32_t num;
116         /** Number of bytes in this group. */
117         uint32_t bytes;
118         /** The first chunk of the current audio file belonging to the group. */
119         uint32_t first_chunk;
120         /** The number of chunks contained in this group. */
121         uint32_t num_chunks;
122         /** When the first chunk was sent. */
123         struct timeval start;
124         /** The group duration divided by the number of slices. */
125         struct timeval slice_duration;
126         /** Group contains the audio file header that occupies that many slices. */
127         uint8_t num_header_slices;
128 };
129
130 /**
131  * Describes one connected FEC client.
132  */
133 struct fec_client {
134         /** If negative, this client is temporarily disabled. */
135         int error;
136         /** Parameters requested by the client. */
137         struct fec_client_parms *fcp;
138         /** Used by the core FEC code. */
139         struct fec_parms *parms;
140         /** The position of this client in the fec client list. */
141         struct list_head node;
142         /** When the first slice for this client was sent. */
143         struct timeval stream_start;
144         /** The first chunk sent to this FEC client. */
145         int first_stream_chunk;
146         /** Describes the current group. */
147         struct fec_group group;
148         /** The current slice. */
149         uint8_t current_slice_num;
150         /** The data to be FEC-encoded (point to a region within the mapped audio file). */
151         const unsigned char **src_data;
152         /** Last time an audio  header was sent. */
153         struct timeval next_header_time;
154         /** Used for the last source pointer of an audio file. */
155         unsigned char *extra_src_buf;
156         /** Extra slices needed to store largest chunk + header. */
157         int num_extra_slices;
158         /** Contains the FEC-encoded data. */
159         unsigned char *enc_buf;
160 };
161
162 /**
163  * Get the chunk time of the current audio file.
164  *
165  * \return A pointer to a struct containing the chunk time, or NULL,
166  * if currently no audio file is selected.
167  */
168 struct timeval *vss_chunk_time(void)
169 {
170         if (mmd->afd.afhi.chunk_tv.tv_sec == 0 &&
171                         mmd->afd.afhi.chunk_tv.tv_usec == 0)
172                 return NULL;
173         return &mmd->afd.afhi.chunk_tv;
174 }
175
176 /**
177  * Write a fec header to a buffer.
178  *
179  * \param buf The buffer to write to.
180  * \param h The fec header to write.
181  */
182 static void write_fec_header(struct fec_client *fc, struct vss_task *vsst)
183 {
184         char *buf = (char *)fc->enc_buf;
185         struct fec_group *g = &fc->group;
186         struct fec_client_parms *p = fc->fcp;
187
188         write_u32(buf, FEC_MAGIC);
189
190         write_u8(buf + 4, p->slices_per_group + fc->num_extra_slices);
191         write_u8(buf + 5, p->data_slices_per_group + fc->num_extra_slices);
192         write_u32(buf + 6, g->num_header_slices? vsst->header_len : 0);
193
194         write_u32(buf + 10, g->num);
195         write_u32(buf + 14, g->bytes);
196
197         write_u8(buf + 18, fc->current_slice_num);
198         write_u16(buf + 20, p->max_slice_bytes - FEC_HEADER_SIZE);
199         write_u8(buf + 22, g->first_chunk? 0 : 1);
200         write_u8(buf + 23, vsst->header_len? 1 : 0);
201         memset(buf + 24, 0, 7);
202 }
203
204 static int need_audio_header(struct fec_client *fc, struct vss_task *vsst)
205 {
206         if (!mmd->current_chunk) {
207                 tv_add(now, &vsst->header_interval, &fc->next_header_time);
208                 return 0;
209         }
210         if (!vsst->header_buf)
211                 return 0;
212         if (!vsst->header_len)
213                 return 0;
214         if (fc->group.num && tv_diff(&fc->next_header_time, now, NULL) > 0)
215                 return 0;
216         tv_add(now, &vsst->header_interval, &fc->next_header_time);
217         return 1;
218 }
219
220 static int num_slices(long unsigned bytes, struct fec_client *fc, uint8_t *result)
221 {
222         unsigned long m = fc->fcp->max_slice_bytes - FEC_HEADER_SIZE;
223         unsigned rv, redundant_slices = fc->fcp->slices_per_group
224                 - fc->fcp->data_slices_per_group;
225
226         if (!m)
227                 return -E_BAD_CT;
228         rv = (bytes + m - 1) / m;
229         if (rv + redundant_slices > 255)
230                 return -E_BAD_CT;
231         *result = rv;
232         return 1;
233 }
234
235 static int setup_next_fec_group(struct fec_client *fc, struct vss_task *vsst)
236 {
237         int ret, i, k, data_slices;
238         size_t len;
239         const char *buf, *start_buf;
240         struct timeval tmp, *chunk_tv = vss_chunk_time();
241         struct fec_group *g = &fc->group;
242         unsigned slice_bytes = fc->fcp->max_slice_bytes - FEC_HEADER_SIZE;
243         uint32_t max_data_size;
244
245         assert(chunk_tv);
246         k = fc->fcp->data_slices_per_group + fc->num_extra_slices;
247         if (fc->first_stream_chunk < 0) {
248                 uint32_t largest = afh_get_largest_chunk_size(&mmd->afd.afhi)
249                         + vsst->header_len;
250                 uint8_t needed, want;
251
252                 ret = num_slices(largest, fc, &needed);
253                 if (ret < 0)
254                         return ret;
255                 if (needed > fc->fcp->data_slices_per_group)
256                         PARA_WARNING_LOG("fec parms insufficient for this audio file\n");
257                 want = PARA_MAX(needed, fc->fcp->data_slices_per_group);
258                 if (want != k) {
259                         fec_free(fc->parms);
260                         fc->src_data = para_realloc(fc->src_data, want * sizeof(char *));
261                         ret = fec_new(want, want + fc->fcp->slices_per_group
262                                 - fc->fcp->data_slices_per_group, &fc->parms);
263                         if (ret < 0)
264                                 return ret;
265                         k = want;
266                         fc->num_extra_slices = 0;
267                         if (k > fc->fcp->data_slices_per_group) {
268                                 fc->num_extra_slices = k - fc->fcp->data_slices_per_group;
269                                 PARA_NOTICE_LOG("using %d extra slices\n",
270                                         fc->num_extra_slices);
271                         }
272                 }
273                 fc->stream_start = *now;
274                 fc->first_stream_chunk = mmd->current_chunk;
275                 g->first_chunk = mmd->current_chunk;
276                 g->num = 0;
277         } else {
278                 g->first_chunk += g->num_chunks;
279                 g->num++;
280         }
281         if (g->first_chunk >= mmd->afd.afhi.chunks_total)
282                 return 0;
283         if (need_audio_header(fc, vsst)) {
284                 ret = num_slices(vsst->header_len, fc, &g->num_header_slices);
285                 if (ret < 0)
286                         return ret;
287         } else
288                 g->num_header_slices = 0;
289         afh_get_chunk(g->first_chunk, &mmd->afd.afhi, vsst->map, &start_buf,
290                 &len);
291         data_slices = k - g->num_header_slices;
292         assert(data_slices);
293         max_data_size = slice_bytes * data_slices;
294         g->bytes = 0;
295         for (i = g->first_chunk; i < mmd->afd.afhi.chunks_total; i++) {
296                 afh_get_chunk(i, &mmd->afd.afhi, vsst->map, &buf, &len);
297                 if (g->bytes + len > max_data_size)
298                         break;
299                 g->bytes += len;
300         }
301         g->num_chunks = i - g->first_chunk;
302         assert(g->num_chunks);
303         fc->current_slice_num = 0;
304
305         /* setup header slices */
306         buf = vsst->header_buf;
307         for (i = 0; i < g->num_header_slices; i++) {
308                 fc->src_data[i] = (const unsigned char *)buf;
309                 buf += slice_bytes;
310         }
311
312         /* setup data slices */
313         buf = start_buf;
314         for (i = g->num_header_slices; i < k; i++) {
315                 if (buf + slice_bytes > vsst->map + mmd->size)
316                         /*
317                          * Can not use the memory mapped audio file for this
318                          * slice as it goes beyond the map. This slice will not
319                          * be fully used.
320                          */
321                         break;
322                 fc->src_data[i] = (const unsigned char *)buf;
323                 buf += slice_bytes;
324         }
325         if (i < k) {
326                 uint32_t payload_size = vsst->map + mmd->size - buf;
327                 memcpy(fc->extra_src_buf, buf, payload_size);
328                 fc->src_data[i] = fc->extra_src_buf;
329                 i++;
330                 /* use arbitrary data for all remaining slices */
331                 buf = vsst->map;
332                 for (; i < k; i++)
333                         fc->src_data[i] = (const unsigned char *)buf;
334         }
335
336         /* setup group timing */
337         tv_scale(g->first_chunk - fc->first_stream_chunk, chunk_tv, &tmp);
338         tv_add(&fc->stream_start, &tmp, &g->start);
339         tv_scale(g->num_chunks, chunk_tv, &tmp); /* group duration */
340         tv_divide(fc->fcp->slices_per_group + fc->num_extra_slices,
341                 &tmp, &g->slice_duration);
342
343         PARA_DEBUG_LOG("FEC group %d: %d chunks (%d - %d), %d header slices, %d data slices\n",
344                 g->num, g->num_chunks, g->first_chunk,
345                 g->first_chunk + g->num_chunks - 1,
346                 g->num_header_slices, data_slices
347         );
348         PARA_DEBUG_LOG("durations (group/chunk/slice): %lu/%lu/%lu\n",
349                 tv2ms(&tmp), tv2ms(chunk_tv), tv2ms(&g->slice_duration));
350         return 1;
351 }
352
353 static int compute_next_fec_slice(struct fec_client *fc, struct vss_task *vsst)
354 {
355         assert(fc->error >= 0);
356         if (fc->first_stream_chunk < 0 || fc->current_slice_num
357                         == fc->fcp->slices_per_group + fc->num_extra_slices) {
358                 int ret = setup_next_fec_group(fc, vsst);
359                 if (ret == 0)
360                         return 0;
361                 if (ret < 0) {
362                         PARA_ERROR_LOG("%s\n", para_strerror(-ret));
363                         PARA_ERROR_LOG("FEC client temporarily disabled\n");
364                         fc->error = ret;
365                         return fc->error;
366                 }
367         }
368         write_fec_header(fc, vsst);
369         fec_encode(fc->parms, fc->src_data, fc->enc_buf + FEC_HEADER_SIZE,
370                 fc->current_slice_num,
371                 fc->fcp->max_slice_bytes - FEC_HEADER_SIZE);
372         return 1;
373 }
374
375 /**
376  * Return a buffer that marks the end of the stream.
377  *
378  * \param buf Result pointer.
379  * \return The length of the eof buffer.
380  *
381  * This is used for (multicast) udp streaming where closing the socket on the
382  * sender might not give rise to an eof condition at the peer.
383  */
384 size_t vss_get_fec_eof_packet(const char **buf)
385 {
386         static const char fec_eof_packet[FEC_HEADER_SIZE] = FEC_EOF_PACKET;
387         *buf = fec_eof_packet;
388         return FEC_HEADER_SIZE;
389 }
390
391 /**
392  * Add one entry to the list of active fec clients.
393  *
394  * \param fcp Describes the fec parameters to be used for this client.
395  * \param result An opaque pointer that must be used by remove the client later.
396  *
397  * \return Standard.
398  */
399 int vss_add_fec_client(struct fec_client_parms *fcp, struct fec_client **result)
400 {
401         int ret;
402         struct fec_client *fc;
403
404         if (fcp->max_slice_bytes < FEC_HEADER_SIZE + fcp->data_slices_per_group)
405                 return -ERRNO_TO_PARA_ERROR(EINVAL);
406         fc = para_calloc(sizeof(*fc));
407         fc->fcp = fcp;
408         ret = fec_new(fcp->data_slices_per_group, fcp->slices_per_group,
409                 &fc->parms);
410         if (ret < 0)
411                 goto err;
412         fc->first_stream_chunk = -1; /* stream not yet started */
413         fc->src_data = para_malloc(fc->fcp->slices_per_group * sizeof(char *));
414         fc->enc_buf = para_calloc(fc->fcp->max_slice_bytes);
415         fc->num_extra_slices = 0;
416         fc->extra_src_buf = para_calloc(fc->fcp->max_slice_bytes);
417         fc->next_header_time.tv_sec = 0;
418         para_list_add(&fc->node, &fec_client_list);
419         *result = fc;
420         return 1;
421 err:
422         fec_free(fc->parms);
423         free(fc);
424         *result = NULL;
425         return ret;
426 }
427
428 /**
429  * Remove one entry from the list of active fec clients.
430  *
431  * \param fc The client to be removed.
432  */
433 void vss_del_fec_client(struct fec_client *fc)
434 {
435         list_del(&fc->node);
436         free(fc->src_data);
437         free(fc->enc_buf);
438         free(fc->extra_src_buf);
439         fec_free(fc->parms);
440         free(fc);
441 }
442
443 /*
444  * Compute if/when next slice is due. If it isn't due yet and \a diff is
445  * not \p Null, compute the time difference next - now, where
446  *
447  *      next = stream_start + (first_group_chunk - first_stream_chunk)
448  *              * chunk_time + slice_num * slice_time
449  */
450 static int next_slice_is_due(struct fec_client *fc, struct timeval *diff)
451 {
452         struct timeval tmp, next;
453         int ret;
454
455         if (fc->first_stream_chunk < 0)
456                 return 1;
457         tv_scale(fc->current_slice_num, &fc->group.slice_duration, &tmp);
458         tv_add(&tmp, &fc->group.start, &next);
459         ret = tv_diff(&next, now, diff);
460         return ret < 0? 1 : 0;
461 }
462
463 static void compute_slice_timeout(struct timeval *timeout)
464 {
465         struct fec_client *fc;
466
467         assert(vss_playing());
468         list_for_each_entry(fc, &fec_client_list, node) {
469                 struct timeval diff;
470
471                 if (fc->error < 0)
472                         continue;
473                 if (next_slice_is_due(fc, &diff)) {
474                         timeout->tv_sec = 0;
475                         timeout->tv_usec = 0;
476                         return;
477                 }
478                 /* timeout = min(timeout, diff) */
479                 if (tv_diff(&diff, timeout, NULL) < 0)
480                         *timeout = diff;
481         }
482 }
483
484 static void set_eof_barrier(struct vss_task *vsst)
485 {
486         struct fec_client *fc;
487         struct timeval timeout = mmd->afd.afhi.eof_tv,
488                 *chunk_tv = vss_chunk_time();
489
490         if (!chunk_tv)
491                 goto out;
492         list_for_each_entry(fc, &fec_client_list, node) {
493                 struct timeval group_duration;
494
495                 if (fc->error < 0)
496                         continue;
497                 tv_scale(fc->group.num_chunks, chunk_tv, &group_duration);
498                 if (tv_diff(&timeout, &group_duration, NULL) < 0)
499                         timeout = group_duration;
500         }
501 out:
502         tv_add(now, &timeout, &vsst->eof_barrier);
503 }
504
505 /**
506  * Check if vss status flag \a P (playing) is set.
507  *
508  * \return Greater than zero if playing, zero otherwise.
509  *
510  */
511 unsigned int vss_playing(void)
512 {
513         return mmd->new_vss_status_flags & VSS_PLAYING;
514 }
515
516 /**
517  * Check if the \a N (next) status flag is set.
518  *
519  * \return Greater than zero if set, zero if not.
520  *
521  */
522 unsigned int vss_next(void)
523 {
524         return mmd->new_vss_status_flags & VSS_NEXT;
525 }
526
527 /**
528  * Check if a reposition request is pending.
529  *
530  * \return Greater than zero if true, zero otherwise.
531  *
532  */
533 unsigned int vss_repos(void)
534 {
535         return mmd->new_vss_status_flags & VSS_REPOS;
536 }
537
538 /**
539  * Check if the vss is currently paused.
540  *
541  * \return Greater than zero if paused, zero otherwise.
542  *
543  */
544 unsigned int vss_paused(void)
545 {
546         return !(mmd->new_vss_status_flags & VSS_NEXT)
547                 && !(mmd->new_vss_status_flags & VSS_PLAYING);
548 }
549
550 /**
551  * Check if the vss is currently stopped.
552  *
553  * \return Greater than zero if paused, zero otherwise.
554  *
555  */
556 unsigned int vss_stopped(void)
557 {
558         return (mmd->new_vss_status_flags & VSS_NEXT)
559                 && !(mmd->new_vss_status_flags & VSS_PLAYING);
560 }
561
562 static int chk_barrier(const char *bname, const struct timeval *barrier,
563                 struct timeval *diff, int print_log)
564 {
565         long ms;
566
567         if (tv_diff(now, barrier, diff) > 0)
568                 return 1;
569         ms = tv2ms(diff);
570         if (print_log && ms)
571                 PARA_DEBUG_LOG("%s barrier: %lims left\n", bname, ms);
572         return -1;
573 }
574
575 /*
576  * != NULL: timeout for next chunk
577  * NULL: nothing to do
578  */
579 static struct timeval *vss_compute_timeout(struct vss_task *vsst)
580 {
581         static struct timeval the_timeout;
582         struct timeval next_chunk;
583
584         if (vss_next() && vsst->map) {
585                 /* only sleep a bit, nec*/
586                 the_timeout.tv_sec = 0;
587                 the_timeout.tv_usec = 100;
588                 return &the_timeout;
589         }
590         if (chk_barrier("autoplay_delay", &vsst->autoplay_barrier,
591                         &the_timeout, 1) < 0)
592                 return &the_timeout;
593         if (chk_barrier("eof", &vsst->eof_barrier, &the_timeout, 1) < 0)
594                 return &the_timeout;
595         if (chk_barrier("data send", &vsst->data_send_barrier,
596                         &the_timeout, 1) < 0)
597                 return &the_timeout;
598         if (!vss_playing() || !vsst->map)
599                 return NULL;
600         compute_chunk_time(mmd->chunks_sent, &mmd->afd.afhi.chunk_tv,
601                 &mmd->stream_start, &next_chunk);
602         if (chk_barrier("chunk", &next_chunk, &the_timeout, 0) >= 0) {
603                 /* chunk is due or bof */
604                 the_timeout.tv_sec = 0;
605                 the_timeout.tv_usec = 0;
606                 return &the_timeout;
607         }
608         /* compute min of current timeout and next slice time */
609         compute_slice_timeout(&the_timeout);
610         return &the_timeout;
611 }
612
613 static void vss_eof(struct vss_task *vsst)
614 {
615
616         if (!vsst->map)
617                 return;
618         if (mmd->new_vss_status_flags & VSS_NOMORE)
619                 mmd->new_vss_status_flags = VSS_NEXT;
620         set_eof_barrier(vsst);
621         para_munmap(vsst->map, mmd->size);
622         vsst->map = NULL;
623         mmd->chunks_sent = 0;
624         mmd->offset = 0;
625         mmd->afd.afhi.seconds_total = 0;
626         mmd->afd.afhi.chunk_tv.tv_sec = 0;
627         mmd->afd.afhi.chunk_tv.tv_usec = 0;
628         free(mmd->afd.afhi.chunk_table);
629         mmd->afd.afhi.chunk_table = NULL;
630         free(mmd->afd.afhi.info_string);
631         mmd->afd.afhi.info_string = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_AUDIO_FILE_INFO],
632                 status_item_list[SI_TAGINFO1], status_item_list[SI_TAGINFO2]);
633         make_empty_status_items(mmd->afd.verbose_ls_output);
634         mmd->mtime = 0;
635         mmd->size = 0;
636         mmd->events++;
637 }
638
639 /**
640  * Get the list of all supported audio formats.
641  *
642  * \return Aa space separated list of all supported audio formats
643  * It is not allocated at runtime, i.e. there is no need to free
644  * the returned string in the caller.
645  */
646 const char *supported_audio_formats(void)
647 {
648         return SUPPORTED_AUDIO_FORMATS;
649 }
650
651 static int need_to_request_new_audio_file(struct vss_task *vsst)
652 {
653         struct timeval diff;
654
655         if (vsst->map) /* have audio file */
656                 return 0;
657         if (!vss_playing()) /* don't need one */
658                 return 0;
659         if (mmd->new_vss_status_flags & VSS_NOMORE)
660                 return 0;
661         if (vsst->afsss == AFS_SOCKET_AFD_PENDING) /* already requested one */
662                 return 0;
663         if (chk_barrier("autoplay_delay", &vsst->autoplay_barrier,
664                         &diff, 1) < 0)
665                 return 0;
666         return 1;
667 }
668
669 /**
670  * Compute the timeout for the main select-loop of the scheduler.
671  *
672  * \param s Pointer to the server scheduler.
673  * \param t Pointer to the vss task structure.
674  *
675  * Before the timeout is computed, the current vss status flags are evaluated
676  * and acted upon by calling appropriate functions from the lower layers.
677  * Possible actions include
678  *
679  *      - request a new audio file from afs,
680  *      - shutdown of all senders (stop/pause command),
681  *      - reposition the stream (ff/jmp command).
682  */
683 static void vss_pre_select(struct sched *s, struct task *t)
684 {
685         int i;
686         struct timeval *tv, diff;
687         struct vss_task *vsst = container_of(t, struct vss_task, task);
688
689         if (!vsst->map || vss_next() || vss_paused() || vss_repos()) {
690                 struct fec_client *fc, *tmp;
691                 for (i = 0; senders[i].name; i++)
692                         if (senders[i].shutdown_clients)
693                                 senders[i].shutdown_clients();
694                 list_for_each_entry_safe(fc, tmp, &fec_client_list, node) {
695                         fc->first_stream_chunk = -1;
696                         fc->error = 0;
697                 }
698                 mmd->stream_start.tv_sec = 0;
699                 mmd->stream_start.tv_usec = 0;
700         }
701         if (vss_next())
702                 vss_eof(vsst);
703         else if (vss_paused()) {
704                 if (mmd->chunks_sent)
705                         set_eof_barrier(vsst);
706                 mmd->chunks_sent = 0;
707         } else if (vss_repos()) {
708                 tv_add(now, &vsst->announce_tv, &vsst->data_send_barrier);
709                 set_eof_barrier(vsst);
710                 mmd->chunks_sent = 0;
711                 mmd->current_chunk = mmd->repos_request;
712                 mmd->new_vss_status_flags &= ~VSS_REPOS;
713         }
714         if (need_to_request_new_audio_file(vsst)) {
715                 PARA_DEBUG_LOG("ready and playing, but no audio file\n");
716                 para_fd_set(vsst->afs_socket, &s->wfds, &s->max_fileno);
717                 vsst->afsss = AFS_SOCKET_CHECK_FOR_WRITE;
718         } else
719                 para_fd_set(vsst->afs_socket, &s->rfds, &s->max_fileno);
720         for (i = 0; senders[i].name; i++) {
721                 if (!senders[i].pre_select)
722                         continue;
723                 senders[i].pre_select(&s->max_fileno, &s->rfds, &s->wfds);
724         }
725         tv = vss_compute_timeout(vsst);
726         if (tv && tv_diff(tv, &s->timeout, &diff) < 0)
727                 s->timeout = *tv;
728 }
729
730 static int recv_afs_msg(int afs_socket, int *fd, uint32_t *code, uint32_t *data)
731 {
732         char control[255], buf[8];
733         struct msghdr msg = {.msg_iov = NULL};
734         struct cmsghdr *cmsg;
735         struct iovec iov;
736         int ret = 0;
737
738         *fd = -1;
739         iov.iov_base = buf;
740         iov.iov_len = sizeof(buf);
741         msg.msg_iov = &iov;
742         msg.msg_iovlen = 1;
743         msg.msg_control = control;
744         msg.msg_controllen = sizeof(control);
745         memset(buf, 0, sizeof(buf));
746         ret = recvmsg(afs_socket, &msg, 0);
747         if (ret < 0)
748                 return -ERRNO_TO_PARA_ERROR(errno);
749         if (iov.iov_len != sizeof(buf))
750                 return -E_AFS_SHORT_READ;
751         *code = *(uint32_t*)buf;
752         *data =  *(uint32_t*)(buf + 4);
753         for (cmsg = CMSG_FIRSTHDR(&msg); cmsg; cmsg = CMSG_NXTHDR(&msg, cmsg)) {
754                 if (cmsg->cmsg_level != SOL_SOCKET
755                         || cmsg->cmsg_type != SCM_RIGHTS)
756                         continue;
757                 if ((cmsg->cmsg_len - CMSG_LEN(0)) / sizeof(int) != 1)
758                         continue;
759                 *fd = *(int *)CMSG_DATA(cmsg);
760         }
761         return 1;
762 }
763
764 static void recv_afs_result(struct vss_task *vsst)
765 {
766         int ret, passed_fd, shmid;
767         uint32_t afs_code = 0, afs_data = 0;
768         struct stat statbuf;
769
770         vsst->afsss = AFS_SOCKET_READY;
771         ret = recv_afs_msg(vsst->afs_socket, &passed_fd, &afs_code, &afs_data);
772         if (ret < 0)
773                 goto err;
774         PARA_DEBUG_LOG("fd: %d, code: %u, shmid: %u\n", passed_fd, afs_code,
775                 afs_data);
776         ret = -E_NOFD;
777         if (afs_code != NEXT_AUDIO_FILE)
778                 goto err;
779         if (passed_fd < 0)
780                 goto err;
781         shmid = afs_data;
782         free(mmd->afd.afhi.info_string);
783         ret = load_afd(shmid, &mmd->afd);
784         if (ret < 0)
785                 goto err;
786         shm_destroy(shmid);
787         ret = fstat(passed_fd, &statbuf);
788         if (ret < 0) {
789                 PARA_ERROR_LOG("fstat error:\n");
790                 ret = -ERRNO_TO_PARA_ERROR(errno);
791                 goto err;
792         }
793         mmd->size = statbuf.st_size;
794         mmd->mtime = statbuf.st_mtime;
795         ret = para_mmap(mmd->size, PROT_READ, MAP_PRIVATE, passed_fd,
796                 0, &vsst->map);
797         if (ret < 0)
798                 goto err;
799         close(passed_fd);
800         mmd->chunks_sent = 0;
801         mmd->current_chunk = 0;
802         mmd->offset = 0;
803         mmd->events++;
804         mmd->num_played++;
805         mmd->new_vss_status_flags &= (~VSS_NEXT);
806         afh_get_header(&mmd->afd.afhi, vsst->map, &vsst->header_buf,
807                 &vsst->header_len);
808         return;
809 err:
810         free(mmd->afd.afhi.chunk_table);
811         if (passed_fd >= 0)
812                 close(passed_fd);
813         PARA_ERROR_LOG("%s\n", para_strerror(-ret));
814         mmd->new_vss_status_flags = VSS_NEXT;
815 }
816
817 /**
818  * Main sending function.
819  *
820  * This function gets called from vss_post_select(). It checks whether the next
821  * chunk of data should be pushed out. It obtains a pointer to the data to be
822  * sent out as well as its length from mmd->afd.afhi. This information is then
823  * passed to each supported sender's send() function as well as to the send()
824  * functions of each registered fec client.
825  */
826 static void vss_send(struct vss_task *vsst)
827 {
828         int i, sent_something = 0;
829         struct timeval due;
830         struct fec_client *fc, *tmp_fc;
831
832         if (!vsst->map || !vss_playing())
833                 return;
834         if (chk_barrier("eof", &vsst->eof_barrier, &due, 1) < 0)
835                 return;
836         if (chk_barrier("data send", &vsst->data_send_barrier,
837                         &due, 1) < 0)
838                 return;
839         list_for_each_entry_safe(fc, tmp_fc, &fec_client_list, node) {
840                 if (fc->error < 0)
841                         continue;
842                 if (!next_slice_is_due(fc, NULL))
843                         continue;
844                 if (compute_next_fec_slice(fc, vsst) <= 0)
845                         continue;
846                 PARA_DEBUG_LOG("sending %d:%d (%u bytes)\n", fc->group.num,
847                         fc->current_slice_num, fc->fcp->max_slice_bytes);
848                 fc->fcp->send((char *)fc->enc_buf,
849                         fc->fcp->max_slice_bytes,
850                         fc->fcp->private_data);
851                 fc->current_slice_num++;
852                 sent_something = 1;
853         }
854         if (mmd->current_chunk >= mmd->afd.afhi.chunks_total) { /* eof */
855                 if (!sent_something)
856                         mmd->new_vss_status_flags |= VSS_NEXT;
857                 return;
858         }
859         compute_chunk_time(mmd->chunks_sent, &mmd->afd.afhi.chunk_tv,
860                 &mmd->stream_start, &due);
861         if (tv_diff(&due, now, NULL) <= 0) {
862                 const char *buf;
863                 size_t len;
864
865                 if (!mmd->chunks_sent) {
866                         struct timeval tmp;
867                         mmd->stream_start = *now;
868                         tv_scale(mmd->current_chunk, &mmd->afd.afhi.chunk_tv, &tmp);
869                         mmd->offset = tv2ms(&tmp);
870                         mmd->events++;
871                 }
872                 /*
873                  * We call the send function also in case of empty chunks as
874                  * they might have still some data queued which can be sent in
875                  * this case.
876                  */
877                 afh_get_chunk(mmd->current_chunk, &mmd->afd.afhi, vsst->map,
878                         &buf, &len);
879                 for (i = 0; senders[i].name; i++) {
880                         if (!senders[i].send)
881                                 continue;
882                         senders[i].send(mmd->current_chunk, mmd->chunks_sent,
883                                 buf, len, vsst->header_buf, vsst->header_len);
884                 }
885                 mmd->chunks_sent++;
886                 mmd->current_chunk++;
887         }
888 }
889
890 static void vss_post_select(struct sched *s, struct task *t)
891 {
892         int ret, i;
893         struct vss_task *vsst = container_of(t, struct vss_task, task);
894
895
896         if (mmd->sender_cmd_data.cmd_num >= 0) {
897                 int num = mmd->sender_cmd_data.cmd_num,
898                         sender_num = mmd->sender_cmd_data.sender_num;
899
900                 if (senders[sender_num].client_cmds[num])
901                         senders[sender_num].client_cmds[num](&mmd->sender_cmd_data);
902                 mmd->sender_cmd_data.cmd_num = -1;
903         }
904         if (vsst->afsss != AFS_SOCKET_CHECK_FOR_WRITE) {
905                 if (FD_ISSET(vsst->afs_socket, &s->rfds))
906                         recv_afs_result(vsst);
907         } else if (FD_ISSET(vsst->afs_socket, &s->wfds)) {
908                 PARA_NOTICE_LOG("requesting new fd from afs\n");
909                 ret = send_buffer(vsst->afs_socket, "new");
910                 if (ret < 0)
911                         PARA_CRIT_LOG("%s\n", para_strerror(-ret));
912                 else
913                         vsst->afsss = AFS_SOCKET_AFD_PENDING;
914         }
915         for (i = 0; senders[i].name; i++) {
916                 if (!senders[i].post_select)
917                         continue;
918                 senders[i].post_select(&s->rfds, &s->wfds);
919         }
920         if ((vss_playing() && !(mmd->vss_status_flags & VSS_PLAYING)) ||
921                         (vss_next() && vss_playing()))
922                 tv_add(now, &vsst->announce_tv, &vsst->data_send_barrier);
923         vss_send(vsst);
924 }
925
926 /**
927  * Initialize the virtual streaming system task.
928  *
929  * \param afs_socket The fd for communication with afs.
930  *
931  * This also initializes all supported senders and starts streaming
932  * if the --autoplay command line flag was given.
933  */
934 void init_vss_task(int afs_socket)
935 {
936         static struct vss_task vss_task_struct, *vsst = &vss_task_struct;
937         int i;
938         char *hn = para_hostname(), *home = para_homedir();
939         long unsigned announce_time = conf.announce_time_arg > 0?
940                         conf.announce_time_arg : 300,
941                 autoplay_delay = conf.autoplay_delay_arg > 0?
942                         conf.autoplay_delay_arg : 0;
943         vsst->header_interval.tv_sec = 5; /* should this be configurable? */
944         vsst->afs_socket = afs_socket;
945         vsst->task.pre_select = vss_pre_select;
946         vsst->task.post_select = vss_post_select;
947         ms2tv(announce_time, &vsst->announce_tv);
948         PARA_INFO_LOG("announce timeval: %lums\n", tv2ms(&vsst->announce_tv));
949         INIT_LIST_HEAD(&fec_client_list);
950         for (i = 0; senders[i].name; i++) {
951                 PARA_NOTICE_LOG("initializing %s sender\n", senders[i].name);
952                 senders[i].init(&senders[i]);
953         }
954         free(hn);
955         free(home);
956         mmd->sender_cmd_data.cmd_num = -1;
957         make_empty_status_items(mmd->afd.verbose_ls_output);
958         if (conf.autoplay_given) {
959                 struct timeval tmp;
960                 mmd->vss_status_flags |= VSS_PLAYING;
961                 mmd->new_vss_status_flags |= VSS_PLAYING;
962                 ms2tv(autoplay_delay, &tmp);
963                 tv_add(now, &tmp, &vsst->autoplay_barrier);
964                 tv_add(&vsst->autoplay_barrier, &vsst->announce_tv,
965                         &vsst->data_send_barrier);
966         }
967         register_task(&vsst->task);
968 }