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