vss.c

   1 /*
   2  * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
   3  *
   4  *     This program is free software; you can redistribute it and/or modify
   5  *     it under the terms of the GNU General Public License as published by
   6  *     the Free Software Foundation; either version 2 of the License, or
   7  *     (at your option) any later version.
   8  *
   9  *     This program is distributed in the hope that it will be useful,
  10  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *     GNU General Public License for more details.
  13  *
  14  *     You should have received a copy of the GNU General Public License
  15  *     along with this program; if not, write to the Free Software
  16  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  17  */
  18
  19 /** \file vss.c the virtual streaming system
  20  *
  21  * This contains the audio sending part of para_server which is independent of
  22  * the current audio format, audio file selector and of the activated senders.
  23  */
  24
  25 #include "server.h"
  26 #include <sys/time.h> /* gettimeofday */
  27 #include "server.cmdline.h"
  28 #include "afs.h"
  29 #include "vss.h"
  30 #include "send.h"
  31 #include "error.h"
  32 #include "string.h"
  33 #include "fd.h"
  34
  35 extern const char *status_item_list[];
  36
  37 static struct timeval announce_tv;
  38 static struct timeval data_send_barrier;
  39 static struct timeval eof_barrier;
  40 static struct timeval autoplay_barrier;
  41
  42 extern struct misc_meta_data *mmd;
  43 extern struct audio_file_selector selectors[];
  44 extern struct sender senders[];
  45 static char *inbuf;
  46 static size_t inbuf_size;
  47
  48 static FILE *audio_file = NULL;
  49
  50 #if 1
  51         void mp3_init(struct audio_format_handler *);
  52 #endif
  53
  54 #ifdef HAVE_OGGVORBIS
  55         void ogg_init(struct audio_format_handler *);
  56 #endif
  57 #ifdef HAVE_FAAD
  58         void aac_afh_init(struct audio_format_handler *);
  59 #endif
  60
  61 /**
  62  * the list of supported  audio formats
  63  */
  64 static struct audio_format_handler afl[] = {
  65 #if 1
  66         {
  67                 .name = "mp3",
  68                 .init = mp3_init,
  69         },
  70 #endif
  71 #ifdef HAVE_OGGVORBIS
  72         {
  73                 .name = "ogg",
  74                 .init = ogg_init,
  75         },
  76 #endif
  77 #ifdef HAVE_FAAD
  78         {
  79                 .name = "aac",
  80                 .init = aac_afh_init,
  81         },
  82 #endif
  83         {
  84                 .name = NULL,
  85         }
  86 };
  87
  88 /** iterate over each supported audio format */
  89 #define FOR_EACH_AUDIO_FORMAT(i) for (i = 0; afl[i].name; i++)
  90
  91
  92
  93 /**
  94  * check if vss status flag \a P (playing) is set
  95  *
  96  * \return greater than zero if playing, zero otherwise.
  97  *
  98  */
  99 unsigned int vss_playing(void)
 100 {
 101         return mmd->new_vss_status_flags & VSS_PLAYING;
 102 }
 103
 104 /**
 105  * check if \a N (next) status flag is set
 106  *
 107  * \return greater than zero if set, zero if not.
 108  *
 109  */
 110 unsigned int vss_next(void)
 111 {
 112         return mmd->new_vss_status_flags & VSS_NEXT;
 113 }
 114
 115 /**
 116  * check if a reposition request is pending
 117  *
 118  * \return greater than zero if true, zero otherwise.
 119  *
 120  */
 121 unsigned int vss_repos(void)
 122 {
 123         return mmd->new_vss_status_flags & VSS_REPOS;
 124 }
 125
 126 /**
 127  * check if the vss is currently paused
 128  *
 129  * \return greater than zero if paused, zero otherwise.
 130  *
 131  */
 132 unsigned int vss_paused(void)
 133 {
 134         return !(mmd->new_vss_status_flags & VSS_NEXT)
 135                 && !(mmd->new_vss_status_flags & VSS_PLAYING);
 136 }
 137
 138 /**
 139  * get the name of the given audio format
 140  * \param i the audio format number
 141  *
 142  * This returns a pointer to statically allocated memory so it
 143  * must not be freed by the caller.
 144  */
 145 const char *audio_format_name(int i)
 146 {
 147         return i >= 0?  afl[i].name : "(none)";
 148 }
 149
 150 /**
 151  * initialize the virtual streaming system
 152  *
 153  * Call the init functions of all supported audio format handlers and
 154  * initialize all supported senders.
 155  */
 156 void vss_init(void)
 157 {
 158         int i;
 159         char *hn = para_hostname(), *home = para_homedir();
 160
 161         PARA_DEBUG_LOG("supported audio formats: %s\n",
 162                 SUPPORTED_AUDIO_FORMATS);
 163         for (i = 0; afl[i].name; i++) {
 164                 PARA_NOTICE_LOG("initializing %s handler\n",
 165                         afl[i].name);
 166                 afl[i].init(&afl[i]);
 167         }
 168         ms2tv(conf.announce_time_arg, &announce_tv);
 169         PARA_INFO_LOG("announce timeval: %lums\n", tv2ms(&announce_tv));
 170         for (i = 0; senders[i].name; i++) {
 171                 PARA_NOTICE_LOG("initializing %s sender\n", senders[i].name);
 172                 senders[i].init(&senders[i]);
 173         }
 174         free(hn);
 175         free(home);
 176         if (conf.autoplay_given) {
 177                 struct timeval now, tmp;
 178                 mmd->vss_status_flags |= VSS_PLAYING;
 179                 mmd->new_vss_status_flags |= VSS_PLAYING;
 180                 gettimeofday(&now, NULL);
 181                 ms2tv(conf.autoplay_delay_arg, &tmp);
 182                 tv_add(&now, &tmp, &autoplay_barrier);
 183         }
 184 }
 185
 186 static int get_file_info(int i)
 187 {
 188         return  afl[i].get_file_info(audio_file, &mmd->afi);
 189 }
 190
 191 /**
 192  * guess the audio format judging from filename
 193  *
 194  * \param name the filename
 195  *
 196  * \return This function returns -1 if it has no idea what kind of audio
 197  * file this might be. Otherwise the (non-negative) number of the audio format
 198  * is returned.
 199  */
 200 int guess_audio_format(const char *name)
 201 {
 202         int i,j, len = strlen(name);
 203
 204         FOR_EACH_AUDIO_FORMAT(i) {
 205                 for (j = 0; afl[i].suffixes[j]; j++) {
 206                         const char *p = afl[i].suffixes[j];
 207                         int plen = strlen(p);
 208                         if (len < plen + 1)
 209                                 continue;
 210                         if (name[len - plen - 1] != '.')
 211                                 continue;
 212                         if (strcasecmp(name + len - plen, p))
 213                                 continue;
 214 //                      PARA_DEBUG_LOG("might be %s\n", audio_format_name(i));
 215                         return i;
 216                 }
 217         }
 218         return -1;
 219 }
 220
 221 static int get_audio_format(int omit)
 222 {
 223         int i;
 224
 225         FOR_EACH_AUDIO_FORMAT(i) {
 226                 if (i == omit)
 227                         continue;
 228                 rewind(audio_file);
 229                 if (get_file_info(i) > 0)
 230                         return i;
 231                 rewind(audio_file);
 232         }
 233         return -E_AUDIO_FORMAT;
 234 }
 235
 236 /*
 237  * upddate shared mem
 238  */
 239 static int update_mmd(void)
 240 {
 241         int i;
 242         struct stat file_status;
 243
 244         i = guess_audio_format(mmd->filename);
 245         if (i < 0 || get_file_info(i) < 0)
 246                 i = get_audio_format(i);
 247         if (i < 0)
 248                 return i;
 249         mmd->audio_format = i;
 250         mmd->chunks_sent = 0;
 251         mmd->current_chunk = 0;
 252         mmd->offset = 0;
 253         if (fstat(fileno(audio_file), &file_status) == -1)
 254                 return -E_FSTAT;
 255         mmd->size = file_status.st_size;
 256         mmd->mtime = file_status.st_mtime;
 257         mmd->events++;
 258         PARA_NOTICE_LOG("next audio file: %s\n", mmd->filename);
 259         return 1;
 260 }
 261
 262 static void get_song(void)
 263 {
 264         char **sl = selectors[mmd->selector_num].get_audio_file_list(10);
 265         int i;
 266
 267         if (!sl)
 268                 goto err_out;
 269         for (i = 0; sl[i]; i++) {
 270                 struct timeval now;
 271                 PARA_INFO_LOG("trying %s\n", sl[i]);
 272                 if (strlen(sl[i]) >= _POSIX_PATH_MAX)
 273                         continue;
 274                 audio_file = fopen(sl[i], "r");
 275                 if (!audio_file)
 276                         continue;
 277                 strcpy(mmd->filename, sl[i]);
 278                 if (update_mmd() < 0) {
 279                         fclose(audio_file);
 280                         audio_file = NULL;
 281                         continue;
 282                 }
 283                 mmd->num_played++;
 284                 if (selectors[mmd->selector_num].update_audio_file)
 285                         selectors[mmd->selector_num].update_audio_file(sl[i]);
 286                 PARA_DEBUG_LOG("%s", "success\n");
 287                 mmd->new_vss_status_flags &= (~VSS_NEXT);
 288                 gettimeofday(&now, NULL);
 289                 tv_add(&now, &announce_tv, &data_send_barrier);
 290
 291                 goto free;
 292         }
 293         PARA_ERROR_LOG("%s", "no valid files found\n");
 294 err_out:
 295         mmd->new_vss_status_flags = VSS_NEXT;
 296 free:
 297         if (sl) {
 298                 for (i = 0; sl[i]; i++)
 299                         free(sl[i]);
 300                 free(sl);
 301         }
 302 }
 303
 304 static int chk_barrier(const char *bname, const struct timeval *now,
 305                 const struct timeval *barrier, struct timeval *diff,
 306                 int print_log)
 307 {
 308         long ms;
 309
 310         if (tv_diff(now, barrier, diff) > 0)
 311                 return 1;
 312         ms = tv2ms(diff);
 313         if (print_log && ms)
 314                 PARA_DEBUG_LOG("%s barrier: %lims left\n", bname, ms);
 315         return -1;
 316 }
 317
 318 static void vss_next_chunk_time(struct timeval *due)
 319 {
 320         struct timeval tmp;
 321
 322         tv_scale(mmd->chunks_sent, &mmd->afi.chunk_tv, &tmp);
 323         tv_add(&tmp, &mmd->stream_start, due);
 324 }
 325
 326 /*
 327  * != NULL: timeout for next chunk
 328  * NULL: nothing to do
 329  */
 330 static struct timeval *vss_compute_timeout(void)
 331 {
 332         static struct timeval the_timeout;
 333         struct timeval now, next_chunk;
 334
 335         if (vss_next() && mmd->audio_format >= 0) {
 336                 /* only sleep a bit, nec*/
 337                 the_timeout.tv_sec = 0;
 338                 the_timeout.tv_usec = 100;
 339                 return &the_timeout;
 340         }
 341         gettimeofday(&now, NULL);
 342         if (chk_barrier("autoplay_delay", &now, &autoplay_barrier,
 343                         &the_timeout, 1) < 0)
 344                 return &the_timeout;
 345         if (chk_barrier("eof", &now, &eof_barrier, &the_timeout, 1) < 0)
 346                 return &the_timeout;
 347         if (chk_barrier("data send", &now, &data_send_barrier,
 348                         &the_timeout, 1) < 0)
 349                 return &the_timeout;
 350         if (mmd->audio_format < 0 || !vss_playing() || !audio_file)
 351                 return NULL;
 352         vss_next_chunk_time(&next_chunk);
 353         if (chk_barrier(afl[mmd->audio_format].name, &now, &next_chunk,
 354                         &the_timeout, 0) < 0)
 355                 return &the_timeout;
 356         /* chunk is due or bof */
 357         the_timeout.tv_sec = 0;
 358         the_timeout.tv_usec = 0;
 359         return &the_timeout;
 360 }
 361
 362 static void vss_eof(struct audio_format_handler *af)
 363 {
 364         struct timeval now;
 365         int i;
 366         char *tmp;
 367
 368         if (!af || !audio_file) {
 369                 for (i = 0; senders[i].name; i++)
 370                         senders[i].shutdown_clients();
 371                 return;
 372         }
 373         gettimeofday(&now, NULL);
 374         tv_add(&mmd->afi.eof_tv, &now, &eof_barrier);
 375         fclose(audio_file);
 376         audio_file = NULL;
 377         mmd->audio_format = -1;
 378         af = NULL;
 379         mmd->chunks_sent = 0;
 380         mmd->offset = 0;
 381         mmd->afi.seconds_total = 0;
 382         free(mmd->afi.chunk_table);
 383         mmd->afi.chunk_table = NULL;
 384         PARA_ERROR_LOG("freeing header %p\n", mmd->afi.header);
 385         free(mmd->afi.header);
 386         mmd->afi.header = NULL;
 387         tmp  = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_AUDIO_INFO1],
 388                 status_item_list[SI_AUDIO_INFO2], status_item_list[SI_AUDIO_INFO3]);
 389         strcpy(mmd->afi.info_string, tmp);
 390         free(tmp);
 391         tmp  = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_DBINFO1],
 392                 status_item_list[SI_DBINFO2], status_item_list[SI_DBINFO3]);
 393         strcpy(mmd->selector_info, tmp);
 394         free(tmp);
 395         mmd->filename[0] = '\0';
 396         mmd->size = 0;
 397         mmd->events++;
 398 }
 399
 400 /**
 401  * get the header and of the current audio file
 402  *
 403  * \param header_len the length of the header is stored here
 404  *
 405  * \return a pointer to a buffer containing the header, or NULL, if no audio
 406  * file is selected or if the current audio format does not need special header
 407  * treamtment.
 408  *
 409  */
 410 char *vss_get_header(int *header_len)
 411 {
 412         if (mmd->audio_format < 0)
 413                 return NULL;
 414         *header_len = mmd->afi.header_len;
 415         return mmd->afi.header;
 416 }
 417
 418 /**
 419  * get the list of all supported audio formats
 420  *
 421  * \return a space separated list of all supported audio formats
 422  * It is not allocated at runtime, i.e. there is no need to free
 423  * the returned string in the caller.
 424  */
 425 const char *supported_audio_formats(void)
 426 {
 427         return SUPPORTED_AUDIO_FORMATS;
 428 }
 429
 430 /**
 431  * get the chunk time of the current audio file
 432  *
 433  * \return a pointer to a struct containing the chunk time, or NULL,
 434  * if currently no audio file is selected.
 435  */
 436 struct timeval *vss_chunk_time(void)
 437 {
 438         if (mmd->audio_format < 0)
 439                 return NULL;
 440         return &mmd->afi.chunk_tv;
 441 }
 442
 443 /**
 444  * compute the timeout for para_server's main select-loop
 445  *
 446  * This function gets called from para_server to determine the timeout value
 447  * for its main select loop.
 448  *
 449  * Before the timeout is computed, the current vss status flags are evaluated
 450  * and acted upon by calling appropriate functions from the lower layers.
 451  * Possible actions include
 452  *
 453  *      - request a new file list from the current audio file selector
 454  *      - shutdown of all senders (stop/pause command)
 455  *      - reposition the stream (ff/jmp command)
 456  *
 457  * \return A pointer to a struct timeval containing the timeout for the next
 458  * chunk of data to be sent, or NULL if we're not sending right now.
 459  */
 460 struct timeval *vss_preselect(void)
 461 {
 462         struct audio_format_handler *af = NULL;
 463         int i, format;
 464         struct timeval *ret;
 465 again:
 466         format = mmd->audio_format;
 467         if (format >= 0)
 468                 af = afl + format;
 469         else
 470                 for (i = 0; senders[i].name; i++)
 471                         senders[i].shutdown_clients();
 472         if (vss_next() && af) {
 473                 vss_eof(af);
 474                 return vss_compute_timeout();
 475         }
 476         if (vss_paused() || vss_repos()) {
 477                 for (i = 0; senders[i].name; i++)
 478                         senders[i].shutdown_clients();
 479                 if (af) {
 480                         struct timeval now;
 481                         gettimeofday(&now, NULL);
 482                         if (!vss_paused() || mmd->chunks_sent)
 483                                 tv_add(&mmd->afi.eof_tv, &now, &eof_barrier);
 484                         if (vss_repos())
 485                                 tv_add(&now, &announce_tv, &data_send_barrier);
 486                         if (mmd->new_vss_status_flags & VSS_NOMORE)
 487                                 mmd->new_vss_status_flags = VSS_NEXT;
 488                 }
 489                 mmd->chunks_sent = 0;
 490         }
 491         if (vss_repos()) {
 492                 mmd->new_vss_status_flags &= ~(VSS_REPOS);
 493                 mmd->current_chunk = mmd->repos_request;
 494         }
 495         ret = vss_compute_timeout();
 496         if (!ret && !audio_file && vss_playing() &&
 497                         !(mmd->new_vss_status_flags & VSS_NOMORE)) {
 498                 PARA_DEBUG_LOG("%s", "ready and playing, but no audio file\n");
 499                 get_song();
 500                 goto again;
 501         }
 502         return ret;
 503 }
 504
 505 /**
 506  * read a chunk of data from the current audio file
 507  *
 508  * \param current_chunk the chunk number to read
 509  *
 510  * \return The length of the chunk on success, zero on end of file, negative on
 511  * errors.  Note: If the current chunk is of length zero, but the end of the
 512  * file is not yet reached, this function returns -E_EMPTY_CHUNK.
 513  * */
 514 ssize_t vss_read_chunk(void)
 515 {
 516         ssize_t len;
 517         size_t pos;
 518         int ret;
 519         long unsigned cc = mmd->current_chunk;
 520
 521         if (cc >= mmd->afi.chunks_total) /* eof */
 522                 return 0;
 523         len = mmd->afi.chunk_table[cc + 1] - mmd->afi.chunk_table[cc];
 524         if (!len) /* nothing to send for this run */
 525                 return -E_EMPTY_CHUNK;
 526         pos = mmd->afi.chunk_table[cc];
 527         if (inbuf_size < len) {
 528                 PARA_INFO_LOG("increasing inbuf for chunk #%lu/%lu to %zu bytes\n",
 529                         cc, mmd->afi.chunks_total, len);
 530                 inbuf = para_realloc(inbuf, len);
 531                 inbuf_size = len;
 532         }
 533         ret = para_fseek(audio_file, pos, SEEK_SET);
 534         if (ret < 0)
 535                 return ret;
 536         return para_fread(inbuf, len, 1, audio_file);
 537 }
 538
 539 /**
 540  * main sending function
 541  *
 542  * This function gets called from para_server as soon as the next chunk of
 543  * data should be pushed out. It first calls the read_chunk() function of
 544  * the current audio format handler to obtain a pointer to the data to be
 545  * sent out as well as its length. This information is then passed to each
 546  * supported sender's send() function which does the actual sending.
 547  *
 548  * Return value: Positive return value on success, zero on eof and negative
 549  * on errors.
 550  */
 551 void vss_send_chunk(void)
 552 {
 553         int i;
 554         struct audio_format_handler *af;
 555         ssize_t ret;
 556         struct timeval now, due;
 557
 558         if (mmd->audio_format < 0 || !audio_file || !vss_playing())
 559                 return;
 560         af = &afl[mmd->audio_format];
 561         gettimeofday(&now, NULL);
 562         vss_next_chunk_time(&due);
 563         if (tv_diff(&due, &now, NULL) > 0)
 564                 return;
 565         if (chk_barrier("eof", &now, &eof_barrier, &due, 1) < 0)
 566                 return;
 567         if (chk_barrier("data send", &now, &data_send_barrier,
 568                         &due, 1) < 0)
 569                 return;
 570         ret= vss_read_chunk();
 571         mmd->new_vss_status_flags &= ~VSS_REPOS;
 572         if (!ret || (ret < 0 && ret != -E_EMPTY_CHUNK)) {
 573                 if (ret < 0) {
 574                         mmd->new_vss_status_flags = VSS_NEXT;
 575                         PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
 576                 } else
 577                         mmd->new_vss_status_flags |= VSS_NEXT;
 578                 vss_eof(af);
 579                 return;
 580         }
 581         /*
 582          * We call the send function also in case of empty chunks as they
 583          * might have still some data queued which can be sent in this case.
 584          */
 585         if (ret < 0)
 586                 ret = 0;
 587         if (!mmd->chunks_sent) {
 588                 struct timeval tmp;
 589                 gettimeofday(&mmd->stream_start, NULL);
 590                 tv_scale(mmd->current_chunk, &mmd->afi.chunk_tv, &tmp);
 591                 mmd->offset = tv2ms(&tmp);
 592                 mmd->events++;
 593         }
 594         for (i = 0; senders[i].name; i++)
 595                 senders[i].send(mmd->current_chunk, mmd->chunks_sent, inbuf, ret);
 596         mmd->new_vss_status_flags |= VSS_PLAYING;
 597         mmd->chunks_sent++;
 598         mmd->current_chunk++;
 599 }