vss.c

   1 /*
   2  * Copyright (C) 1997-2007 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 <sys/mman.h> /* mmap */
  15 #include <sys/time.h> /* gettimeofday */
  16 #include <sys/types.h>
  17 #include <dirent.h>
  18
  19 #include "para.h"
  20 #include "error.h"
  21 #include "string.h"
  22 #include "afh.h"
  23 #include "afs.h"
  24 #include "server.h"
  25 #include "net.h"
  26 #include "server.cmdline.h"
  27 #include "vss.h"
  28 #include "send.h"
  29 #include "ipc.h"
  30 #include "fd.h"
  31
  32 extern const char *status_item_list[];
  33
  34 static struct timeval announce_tv;
  35 static struct timeval data_send_barrier;
  36 static struct timeval eof_barrier;
  37 static struct timeval autoplay_barrier;
  38
  39 extern struct misc_meta_data *mmd;
  40 extern struct sender senders[];
  41
  42 static char *map;
  43
  44 /**
  45  * check if vss status flag \a P (playing) is set
  46  *
  47  * \return greater than zero if playing, zero otherwise.
  48  *
  49  */
  50 unsigned int vss_playing(void)
  51 {
  52         return mmd->new_vss_status_flags & VSS_PLAYING;
  53 }
  54
  55 /**
  56  * check if \a N (next) status flag is set
  57  *
  58  * \return greater than zero if set, zero if not.
  59  *
  60  */
  61 unsigned int vss_next(void)
  62 {
  63         return mmd->new_vss_status_flags & VSS_NEXT;
  64 }
  65
  66 /**
  67  * check if a reposition request is pending
  68  *
  69  * \return greater than zero if true, zero otherwise.
  70  *
  71  */
  72 unsigned int vss_repos(void)
  73 {
  74         return mmd->new_vss_status_flags & VSS_REPOS;
  75 }
  76
  77 /**
  78  * check if the vss is currently paused
  79  *
  80  * \return greater than zero if paused, zero otherwise.
  81  *
  82  */
  83 unsigned int vss_paused(void)
  84 {
  85         return !(mmd->new_vss_status_flags & VSS_NEXT)
  86                 && !(mmd->new_vss_status_flags & VSS_PLAYING);
  87 }
  88
  89 /**
  90  * initialize the virtual streaming system
  91  *
  92  * Call the init functions of all supported audio format handlers and
  93  * initialize all supported senders.
  94  */
  95 void vss_init(void)
  96 {
  97         int i;
  98         char *hn = para_hostname(), *home = para_homedir();
  99         long unsigned announce_time = conf.announce_time_arg > 0?
 100                         conf.announce_time_arg : 300,
 101                 autoplay_delay = conf.autoplay_delay_arg > 0?
 102                         conf.autoplay_delay_arg : 0;
 103         ms2tv(announce_time, &announce_tv);
 104         PARA_INFO_LOG("announce timeval: %lums\n", tv2ms(&announce_tv));
 105         for (i = 0; senders[i].name; i++) {
 106                 PARA_NOTICE_LOG("initializing %s sender\n", senders[i].name);
 107                 senders[i].init(&senders[i]);
 108         }
 109         free(hn);
 110         free(home);
 111         if (conf.autoplay_given) {
 112                 struct timeval now, tmp;
 113                 mmd->vss_status_flags |= VSS_PLAYING;
 114                 mmd->new_vss_status_flags |= VSS_PLAYING;
 115                 gettimeofday(&now, NULL);
 116                 ms2tv(autoplay_delay, &tmp);
 117                 tv_add(&now, &tmp, &autoplay_barrier);
 118         }
 119 }
 120
 121 static int chk_barrier(const char *bname, const struct timeval *now,
 122                 const struct timeval *barrier, struct timeval *diff,
 123                 int print_log)
 124 {
 125         long ms;
 126
 127         if (tv_diff(now, barrier, diff) > 0)
 128                 return 1;
 129         ms = tv2ms(diff);
 130         if (print_log && ms)
 131                 PARA_DEBUG_LOG("%s barrier: %lims left\n", bname, ms);
 132         return -1;
 133 }
 134
 135 static void vss_next_chunk_time(struct timeval *due)
 136 {
 137         struct timeval tmp;
 138
 139         tv_scale(mmd->chunks_sent, &mmd->afi.chunk_tv, &tmp);
 140         tv_add(&tmp, &mmd->stream_start, due);
 141 }
 142
 143 /*
 144  * != NULL: timeout for next chunk
 145  * NULL: nothing to do
 146  */
 147 static struct timeval *vss_compute_timeout(void)
 148 {
 149         static struct timeval the_timeout;
 150         struct timeval now, next_chunk;
 151
 152         if (vss_next() && mmd->audio_format >= 0) {
 153                 /* only sleep a bit, nec*/
 154                 the_timeout.tv_sec = 0;
 155                 the_timeout.tv_usec = 100;
 156                 return &the_timeout;
 157         }
 158         gettimeofday(&now, NULL);
 159         if (chk_barrier("autoplay_delay", &now, &autoplay_barrier,
 160                         &the_timeout, 1) < 0)
 161                 return &the_timeout;
 162         if (chk_barrier("eof", &now, &eof_barrier, &the_timeout, 1) < 0)
 163                 return &the_timeout;
 164         if (chk_barrier("data send", &now, &data_send_barrier,
 165                         &the_timeout, 1) < 0)
 166                 return &the_timeout;
 167         if (mmd->audio_format < 0 || !vss_playing() || !map)
 168                 return NULL;
 169         vss_next_chunk_time(&next_chunk);
 170         if (chk_barrier(audio_format_name(mmd->audio_format), &now, &next_chunk,
 171                         &the_timeout, 0) < 0)
 172                 return &the_timeout;
 173         /* chunk is due or bof */
 174         the_timeout.tv_sec = 0;
 175         the_timeout.tv_usec = 0;
 176         return &the_timeout;
 177 }
 178
 179 static void vss_eof(void)
 180 {
 181         struct timeval now;
 182         int i;
 183         char *tmp;
 184
 185         PARA_NOTICE_LOG("EOF\n");
 186         if (!map) {
 187                 for (i = 0; senders[i].name; i++)
 188                         senders[i].shutdown_clients();
 189                 return;
 190         }
 191         gettimeofday(&now, NULL);
 192         tv_add(&mmd->afi.eof_tv, &now, &eof_barrier);
 193         munmap(map, mmd->size);
 194         map = NULL;
 195         mmd->audio_format = -1;
 196         mmd->chunks_sent = 0;
 197         mmd->offset = 0;
 198         mmd->afi.seconds_total = 0;
 199         free(mmd->afi.chunk_table);
 200         mmd->afi.chunk_table = NULL;
 201         tmp  = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_AUDIO_INFO1],
 202                 status_item_list[SI_AUDIO_INFO2], status_item_list[SI_AUDIO_INFO3]);
 203         strcpy(mmd->afi.info_string, tmp);
 204         free(tmp);
 205         tmp  = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_DBINFO1],
 206                 status_item_list[SI_DBINFO2], status_item_list[SI_DBINFO3]);
 207         strcpy(mmd->selector_info, tmp);
 208         free(tmp);
 209         mmd->filename[0] = '\0';
 210         mmd->size = 0;
 211         mmd->events++;
 212 }
 213
 214 /**
 215  * Get the header of the current audio file.
 216  *
 217  * \param header_len the length of the header is stored here
 218  *
 219  * \return a pointer to a buffer containing the header, or NULL, if no audio
 220  * file is selected or if the current audio format does not need special header
 221  * treamtment.
 222  *
 223  */
 224 char *vss_get_header(size_t *header_len)
 225 {
 226         if (mmd->audio_format < 0 || !map || !mmd->afi.header_len)
 227                 return NULL;
 228         *header_len = mmd->afi.header_len;
 229         return map + mmd->afi.header_offset;
 230 }
 231
 232 /**
 233  * get the list of all supported audio formats
 234  *
 235  * \return a space separated list of all supported audio formats
 236  * It is not allocated at runtime, i.e. there is no need to free
 237  * the returned string in the caller.
 238  */
 239 const char *supported_audio_formats(void)
 240 {
 241         return SUPPORTED_AUDIO_FORMATS;
 242 }
 243
 244 /**
 245  * get the chunk time of the current audio file
 246  *
 247  * \return a pointer to a struct containing the chunk time, or NULL,
 248  * if currently no audio file is selected.
 249  */
 250 struct timeval *vss_chunk_time(void)
 251 {
 252         if (mmd->audio_format < 0)
 253                 return NULL;
 254         return &mmd->afi.chunk_tv;
 255 }
 256
 257 enum afs_socket_status {
 258         AFS_SOCKET_READY,
 259         AFS_SOCKET_CHECK_FOR_WRITE,
 260         AFS_SOCKET_AFD_PENDING
 261 };
 262
 263 static enum afs_socket_status afsss;
 264
 265 /**
 266  * Compute the timeout for para_server's main select-loop.
 267  *
 268  * This function gets called from para_server to determine the timeout value
 269  * for its main select loop.
 270  *
 271  * Before the timeout is computed, the current vss status flags are evaluated
 272  * and acted upon by calling appropriate functions from the lower layers.
 273  * Possible actions include
 274  *
 275  *      - request a new audio file from afs,
 276  *      - shutdown of all senders (stop/pause command),
 277  *      - reposition the stream (ff/jmp command).
 278  *
 279  * \return A pointer to a struct timeval containing the timeout for the next
 280  * chunk of data to be sent, or NULL if we're not sending right now.
 281  */
 282 struct timeval *vss_preselect(fd_set *rfds, fd_set *wfds, int *max_fileno)
 283 {
 284         int i;
 285         struct timeval *tv;
 286
 287         para_fd_set(afs_socket, rfds, max_fileno);
 288         if (!map)
 289                 for (i = 0; senders[i].name; i++)
 290                         senders[i].shutdown_clients();
 291         else {
 292                 if (vss_next()) {
 293                         vss_eof();
 294                         return vss_compute_timeout();
 295                 }
 296         }
 297         if (vss_paused() || vss_repos()) {
 298                 for (i = 0; senders[i].name; i++)
 299                         senders[i].shutdown_clients();
 300                 if (map) {
 301                         struct timeval now;
 302                         gettimeofday(&now, NULL);
 303                         if (!vss_paused() || mmd->chunks_sent)
 304                                 tv_add(&mmd->afi.eof_tv, &now, &eof_barrier);
 305                         if (vss_repos())
 306                                 tv_add(&now, &announce_tv, &data_send_barrier);
 307                         if (mmd->new_vss_status_flags & VSS_NOMORE)
 308                                 mmd->new_vss_status_flags = VSS_NEXT;
 309                 }
 310                 mmd->chunks_sent = 0;
 311         }
 312         if (vss_repos()) {
 313                 mmd->new_vss_status_flags &= ~(VSS_REPOS);
 314                 mmd->current_chunk = mmd->repos_request;
 315         }
 316         tv = vss_compute_timeout();
 317         if (tv)
 318                 return tv;
 319         if (!map && vss_playing() &&
 320                         !(mmd->new_vss_status_flags & VSS_NOMORE)) {
 321                 PARA_DEBUG_LOG("%s", "ready and playing, but no audio file\n");
 322                 if (afsss == AFS_SOCKET_READY) {
 323                         para_fd_set(afs_socket, wfds, max_fileno);
 324                         afsss = AFS_SOCKET_CHECK_FOR_WRITE;
 325                 }
 326         }
 327         return tv;
 328 }
 329
 330 static int recv_afs_msg(int *fd, uint32_t *code, uint32_t *data)
 331 {
 332         char control[255], buf[8];
 333         struct msghdr msg = {.msg_iov = NULL};
 334         struct cmsghdr *cmsg;
 335         struct iovec iov;
 336         int ret = 0;
 337
 338         iov.iov_base = buf;
 339         iov.iov_len = sizeof(buf);
 340         msg.msg_iov = &iov;
 341         msg.msg_iovlen = 1;
 342         msg.msg_control = control;
 343         msg.msg_controllen = sizeof(control);
 344         memset(buf, 0, sizeof(buf));
 345         ret = recvmsg(afs_socket, &msg, 0);
 346         if (ret < 0)
 347                 return -ERRNO_TO_PARA_ERROR(errno);
 348         if (iov.iov_len != sizeof(buf))
 349                 return -E_SHORT_AFS_READ;
 350         *code = *(uint32_t*)buf;
 351         *data =  *(uint32_t*)(buf + 4);
 352         cmsg = CMSG_FIRSTHDR(&msg);
 353         for (cmsg = CMSG_FIRSTHDR(&msg); cmsg; cmsg = CMSG_NXTHDR(&msg, cmsg)) {
 354                 if (cmsg->cmsg_level != SOL_SOCKET
 355                         || cmsg->cmsg_type != SCM_RIGHTS)
 356                 continue;
 357                 if ((cmsg->cmsg_len - CMSG_LEN(0)) / sizeof(int) != 1)
 358                 continue;
 359                 *fd = *(int *)CMSG_DATA(cmsg);
 360         }
 361         return 1;
 362 }
 363
 364 static void recv_afs_result(void)
 365 {
 366         int ret, passed_fd = -1, shmid;
 367         uint32_t afs_code = 0, afs_data = 0;
 368         struct stat statbuf;
 369         struct timeval now;
 370
 371         PARA_NOTICE_LOG("recv\n");
 372         ret = recv_afs_msg(&passed_fd, &afs_code, &afs_data);
 373         if (ret < 0)
 374                 goto err;
 375         PARA_NOTICE_LOG("got the fd: %d, code: %u, shmid: %u\n",
 376                 passed_fd, afs_code, afs_data);
 377         ret = -E_BAD_AFS_CODE;
 378         if (afs_code != NEXT_AUDIO_FILE)
 379                 goto err;
 380         afsss = AFS_SOCKET_READY;
 381         shmid = afs_data;
 382         ret = load_afd(shmid, &mmd->afd);
 383         if (ret < 0)
 384                 goto err;
 385         shm_destroy(shmid);
 386         PARA_NOTICE_LOG("next audio file: %s (%lu chunks)\n", mmd->afd.path,
 387                 mmd->afd.afhi.chunks_total);
 388         ret = fstat(passed_fd, &statbuf);
 389         if (ret < 0) {
 390                 PARA_ERROR_LOG("fstat error:\n");
 391                 ret = -ERRNO_TO_PARA_ERROR(errno);
 392                 goto err;
 393         }
 394         mmd->size = statbuf.st_size;
 395         mmd->mtime = statbuf.st_mtime;
 396         map = para_mmap(mmd->size, PROT_READ, MAP_PRIVATE,
 397                 passed_fd, 0);
 398         close(passed_fd);
 399         strcpy(mmd->filename, mmd->afd.path); /* FIXME: check length */
 400         mmd->afi.header_len = 0; /* default: no header */
 401         mmd->audio_format = mmd->afd.afsi.audio_format_id;
 402         mmd->chunks_sent = 0;
 403         mmd->current_chunk = 0;
 404         mmd->offset = 0;
 405         mmd->events++;
 406         mmd->num_played++;
 407         mmd->afi = mmd->afd.afhi;
 408         mmd->new_vss_status_flags &= (~VSS_NEXT);
 409         gettimeofday(&now, NULL);
 410         tv_add(&now, &announce_tv, &data_send_barrier);
 411         return;
 412 err:
 413         if (passed_fd >= 0)
 414                 close(passed_fd);
 415         PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
 416 }
 417
 418 void vss_post_select(fd_set *rfds, fd_set *wfds)
 419 {
 420         int ret;
 421
 422         if (FD_ISSET(afs_socket, rfds))
 423                 recv_afs_result();
 424         if (afsss != AFS_SOCKET_CHECK_FOR_WRITE || !FD_ISSET(afs_socket, wfds))
 425                 return;
 426         PARA_NOTICE_LOG("requesting new socket\n");
 427         ret = send_buffer(afs_socket, "new");
 428         afsss = AFS_SOCKET_AFD_PENDING;
 429 }
 430
 431 static void get_chunk(long unsigned chunk_num, char **buf, size_t *len)
 432 {
 433         size_t pos = mmd->afi.chunk_table[chunk_num];
 434         *buf = map + pos;
 435         *len = mmd->afi.chunk_table[chunk_num + 1] - pos;
 436
 437         if (chunk_num + 5 > mmd->afd.afhi.chunks_total)
 438                 PARA_NOTICE_LOG("chunk %lu/%lu\n, len: %zu\n", chunk_num,
 439                         mmd->afd.afhi.chunks_total, *len);
 440 }
 441
 442 /**
 443  * Get the data of the given chunk.
 444  *
 445  * \param chunk_num The number of the desired chunk.
 446  * \param buf Chunk data.
 447  * \param len Chunk length in bytes.
 448  *
 449  * \return Positive on success, negative on errors.
 450  */
 451 int vss_get_chunk(long unsigned chunk_num, char **buf, size_t *len)
 452 {
 453         if (mmd->audio_format < 0 || !map || !vss_playing())
 454                 return -E_CHUNK;
 455         if (chunk_num >= mmd->afi.chunks_total)
 456                 return -E_CHUNK;
 457         get_chunk(chunk_num, buf, len);
 458         return 1;
 459 }
 460
 461 /**
 462  * main sending function
 463  *
 464  * This function gets called from para_server as soon as the next chunk of
 465  * data should be pushed out. It first calls the read_chunk() function of
 466  * the current audio format handler to obtain a pointer to the data to be
 467  * sent out as well as its length. This information is then passed to each
 468  * supported sender's send() function which does the actual sending.
 469  */
 470 void vss_send_chunk(void)
 471 {
 472         int i;
 473         struct timeval now, due;
 474         char *buf;
 475         size_t len;
 476
 477         if (mmd->audio_format < 0 || !map || !vss_playing())
 478                 return;
 479         gettimeofday(&now, NULL);
 480         vss_next_chunk_time(&due);
 481         if (tv_diff(&due, &now, NULL) > 0)
 482                 return;
 483         if (chk_barrier("eof", &now, &eof_barrier, &due, 1) < 0)
 484                 return;
 485         if (chk_barrier("data send", &now, &data_send_barrier,
 486                         &due, 1) < 0)
 487                 return;
 488         mmd->new_vss_status_flags &= ~VSS_REPOS;
 489         if (mmd->current_chunk >= mmd->afi.chunks_total) { /* eof */
 490                 mmd->new_vss_status_flags |= VSS_NEXT;
 491                 return vss_eof();
 492         }
 493         /*
 494          * We call the send function also in case of empty chunks as they
 495          * might have still some data queued which can be sent in this case.
 496          */
 497         if (!mmd->chunks_sent) {
 498                 struct timeval tmp;
 499                 gettimeofday(&mmd->stream_start, NULL);
 500                 tv_scale(mmd->current_chunk, &mmd->afi.chunk_tv, &tmp);
 501                 mmd->offset = tv2ms(&tmp);
 502                 mmd->events++;
 503         }
 504         get_chunk(mmd->current_chunk, &buf, &len);
 505         for (i = 0; senders[i].name; i++)
 506                 senders[i].send(mmd->current_chunk, mmd->chunks_sent, buf, len);
 507         mmd->new_vss_status_flags |= VSS_PLAYING;
 508         mmd->chunks_sent++;
 509         mmd->current_chunk++;
 510 }