2 * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file vss.c the virtual streaming system
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
14 #include <sys/mman.h> /* mmap */
15 #include <sys/time.h> /* gettimeofday */
16 #include <sys/types.h>
26 #include "server.cmdline.h"
27 #include "afs_common.h"
33 extern const char *status_item_list[];
35 static struct timeval announce_tv;
36 static struct timeval data_send_barrier;
37 static struct timeval eof_barrier;
38 static struct timeval autoplay_barrier;
40 extern struct misc_meta_data *mmd;
41 extern struct audio_file_selector selectors[];
42 extern struct sender senders[];
44 static int audio_file;
47 /* The mp3 audio format handler does not need any libs. */
48 void mp3_init(struct audio_format_handler *);
51 void ogg_init(struct audio_format_handler *);
54 void aac_afh_init(struct audio_format_handler *);
58 * The list of supported audio formats.
60 * We always define the full array of audio formats even if some audio formats
61 * were not compiled in. This is because for each audio file the number of its
62 * audio format is stored in the databse. We don't want that numbers to become
63 * stale just because the user installed a new version of paraslash that
64 * supports a different set of audio formats.
66 * It can still be easily detected whether an audio format is compiled in by
67 * checking if the init function pointer is not \p NULL.
69 static struct audio_format_handler afl[] = {
91 static inline int next_audio_format(int format)
94 if (!afl[format].name)
103 /** Iterate over each supported audio format. */
104 #define FOR_EACH_AUDIO_FORMAT(i) for (i = 0; afl[i].name; i = next_audio_format(i))
108 * check if vss status flag \a P (playing) is set
110 * \return greater than zero if playing, zero otherwise.
113 unsigned int vss_playing(void)
115 return mmd->new_vss_status_flags & VSS_PLAYING;
119 * check if \a N (next) status flag is set
121 * \return greater than zero if set, zero if not.
124 unsigned int vss_next(void)
126 return mmd->new_vss_status_flags & VSS_NEXT;
130 * check if a reposition request is pending
132 * \return greater than zero if true, zero otherwise.
135 unsigned int vss_repos(void)
137 return mmd->new_vss_status_flags & VSS_REPOS;
141 * check if the vss is currently paused
143 * \return greater than zero if paused, zero otherwise.
146 unsigned int vss_paused(void)
148 return !(mmd->new_vss_status_flags & VSS_NEXT)
149 && !(mmd->new_vss_status_flags & VSS_PLAYING);
153 * Get the name of the given audio format.
155 * \param i The audio format number.
157 * This returns a pointer to statically allocated memory so it
158 * must not be freed by the caller.
160 const char *audio_format_name(int i)
162 //PARA_NOTICE_LOG("array size: %u¸ requested: %d\n", ARRAY_SIZE(afl), i);
163 assert(i < 0 || i < ARRAY_SIZE(afl) - 1);
164 return i >= 0? afl[i].name : "(none)";
168 * initialize the virtual streaming system
170 * Call the init functions of all supported audio format handlers and
171 * initialize all supported senders.
176 char *hn = para_hostname(), *home = para_homedir();
177 long unsigned announce_time = conf.announce_time_arg > 0?
178 conf.announce_time_arg : 300,
179 autoplay_delay = conf.autoplay_delay_arg > 0?
180 conf.autoplay_delay_arg : 0;
182 PARA_DEBUG_LOG("supported audio formats: %s\n",
183 SUPPORTED_AUDIO_FORMATS);
184 FOR_EACH_AUDIO_FORMAT(i) {
185 PARA_NOTICE_LOG("initializing %s handler\n",
187 afl[i].init(&afl[i]);
189 ms2tv(announce_time, &announce_tv);
190 PARA_INFO_LOG("announce timeval: %lums\n", tv2ms(&announce_tv));
191 for (i = 0; senders[i].name; i++) {
192 PARA_NOTICE_LOG("initializing %s sender\n", senders[i].name);
193 senders[i].init(&senders[i]);
197 if (conf.autoplay_given) {
198 struct timeval now, tmp;
199 mmd->vss_status_flags |= VSS_PLAYING;
200 mmd->new_vss_status_flags |= VSS_PLAYING;
201 gettimeofday(&now, NULL);
202 ms2tv(autoplay_delay, &tmp);
203 tv_add(&now, &tmp, &autoplay_barrier);
207 static int get_file_info(int i)
209 return afl[i].get_file_info(map, mmd->size, &mmd->afi);
213 * guess the audio format judging from filename
215 * \param name the filename
217 * \return This function returns -1 if it has no idea what kind of audio
218 * file this might be. Otherwise the (non-negative) number of the audio format
221 int guess_audio_format(const char *name)
223 int i,j, len = strlen(name);
225 FOR_EACH_AUDIO_FORMAT(i) {
226 for (j = 0; afl[i].suffixes[j]; j++) {
227 const char *p = afl[i].suffixes[j];
228 int plen = strlen(p);
231 if (name[len - plen - 1] != '.')
233 if (strcasecmp(name + len - plen, p))
235 // PARA_DEBUG_LOG("might be %s\n", audio_format_name(i));
239 return -E_BAD_AUDIO_FILE_SUFFIX;
242 static int get_audio_format(int omit)
246 FOR_EACH_AUDIO_FORMAT(i) {
249 if (get_file_info(i) > 0)
252 return -E_AUDIO_FORMAT;
256 * Call get_file_info() to obtain an afhi structure.
258 * \param path The full path of the audio file.
259 * \param data Pointer to the contents of the (mapped) file.
260 * \param size The file size in bytes.
261 * \param afhi Result pointer.
263 * \return The number of the audio format on success, \p -E_AUDIO_FORMAT if no
264 * compiled in audio format handler is able to handler the file.
266 * This function tries to find an audio format handler that can interpret the
267 * file given by \a data and \a size.
269 * It first tries to determine the audio format from the filename given by \a
270 * path. If this doesn't work, all other audio format handlers are tried until
271 * one is found that can handle the file.
273 int compute_afhi(const char *path, char *data, size_t size,
274 struct audio_format_info *afhi)
276 int ret, i, format = guess_audio_format(path);
279 ret = afl[format].get_file_info(data, size, afhi);
283 FOR_EACH_AUDIO_FORMAT(i) {
284 if (i == format) /* we already tried this one to no avail */
286 ret = afl[i].get_file_info(data, size, afhi);
289 PARA_WARNING_LOG("%s\n", PARA_STRERROR(-ret));
291 return -E_AUDIO_FORMAT;
297 static int update_mmd(void)
301 i = guess_audio_format(mmd->filename);
302 if (i < 0 || get_file_info(i) < 0)
303 i = get_audio_format(i);
306 mmd->audio_format = i;
307 mmd->chunks_sent = 0;
308 mmd->current_chunk = 0;
314 static void vss_get_audio_file(void)
316 char **sl = selectors[mmd->selector_num].get_audio_file_list(10);
318 struct stat file_status;
322 for (i = 0; sl[i]; i++) {
324 PARA_INFO_LOG("trying %s\n", sl[i]);
325 if (strlen(sl[i]) >= _POSIX_PATH_MAX)
327 audio_file = open(sl[i], O_RDONLY);
330 if (fstat(audio_file, &file_status) == -1 ||
331 !file_status.st_size) {
335 mmd->size = file_status.st_size;
336 mmd->mtime = file_status.st_mtime;
337 map = para_mmap(mmd->size, PROT_READ, MAP_PRIVATE,
339 strcpy(mmd->filename, sl[i]);
340 mmd->afi.header_len = 0; /* default: no header */
341 if (update_mmd() < 0) { /* invalid file */
343 munmap(map, mmd->size);
348 if (selectors[mmd->selector_num].update_audio_file)
349 selectors[mmd->selector_num].update_audio_file(sl[i]);
350 PARA_NOTICE_LOG("next audio file: %s\n", mmd->filename);
351 mmd->new_vss_status_flags &= (~VSS_NEXT);
352 gettimeofday(&now, NULL);
353 tv_add(&now, &announce_tv, &data_send_barrier);
357 PARA_ERROR_LOG("%s", "no valid files found\n");
358 mmd->new_vss_status_flags = VSS_NEXT;
361 for (i = 0; sl[i]; i++)
367 static int chk_barrier(const char *bname, const struct timeval *now,
368 const struct timeval *barrier, struct timeval *diff,
373 if (tv_diff(now, barrier, diff) > 0)
377 PARA_DEBUG_LOG("%s barrier: %lims left\n", bname, ms);
381 static void vss_next_chunk_time(struct timeval *due)
385 tv_scale(mmd->chunks_sent, &mmd->afi.chunk_tv, &tmp);
386 tv_add(&tmp, &mmd->stream_start, due);
390 * != NULL: timeout for next chunk
391 * NULL: nothing to do
393 static struct timeval *vss_compute_timeout(void)
395 static struct timeval the_timeout;
396 struct timeval now, next_chunk;
398 if (vss_next() && mmd->audio_format >= 0) {
399 /* only sleep a bit, nec*/
400 the_timeout.tv_sec = 0;
401 the_timeout.tv_usec = 100;
404 gettimeofday(&now, NULL);
405 if (chk_barrier("autoplay_delay", &now, &autoplay_barrier,
406 &the_timeout, 1) < 0)
408 if (chk_barrier("eof", &now, &eof_barrier, &the_timeout, 1) < 0)
410 if (chk_barrier("data send", &now, &data_send_barrier,
411 &the_timeout, 1) < 0)
413 if (mmd->audio_format < 0 || !vss_playing() || !map)
415 vss_next_chunk_time(&next_chunk);
416 if (chk_barrier(afl[mmd->audio_format].name, &now, &next_chunk,
417 &the_timeout, 0) < 0)
419 /* chunk is due or bof */
420 the_timeout.tv_sec = 0;
421 the_timeout.tv_usec = 0;
425 static void vss_eof(void)
432 for (i = 0; senders[i].name; i++)
433 senders[i].shutdown_clients();
436 gettimeofday(&now, NULL);
437 tv_add(&mmd->afi.eof_tv, &now, &eof_barrier);
438 munmap(map, mmd->size);
441 mmd->audio_format = -1;
442 mmd->chunks_sent = 0;
444 mmd->afi.seconds_total = 0;
445 free(mmd->afi.chunk_table);
446 mmd->afi.chunk_table = NULL;
447 tmp = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_AUDIO_INFO1],
448 status_item_list[SI_AUDIO_INFO2], status_item_list[SI_AUDIO_INFO3]);
449 strcpy(mmd->afi.info_string, tmp);
451 tmp = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_DBINFO1],
452 status_item_list[SI_DBINFO2], status_item_list[SI_DBINFO3]);
453 strcpy(mmd->selector_info, tmp);
455 mmd->filename[0] = '\0';
461 * Get the header of the current audio file.
463 * \param header_len the length of the header is stored here
465 * \return a pointer to a buffer containing the header, or NULL, if no audio
466 * file is selected or if the current audio format does not need special header
470 char *vss_get_header(size_t *header_len)
472 if (mmd->audio_format < 0 || !map || !mmd->afi.header_len)
474 *header_len = mmd->afi.header_len;
475 return map + mmd->afi.header_offset;
479 * get the list of all supported audio formats
481 * \return a space separated list of all supported audio formats
482 * It is not allocated at runtime, i.e. there is no need to free
483 * the returned string in the caller.
485 const char *supported_audio_formats(void)
487 return SUPPORTED_AUDIO_FORMATS;
491 * get the chunk time of the current audio file
493 * \return a pointer to a struct containing the chunk time, or NULL,
494 * if currently no audio file is selected.
496 struct timeval *vss_chunk_time(void)
498 if (mmd->audio_format < 0)
500 return &mmd->afi.chunk_tv;
503 enum afs_socket_status {
505 AFS_SOCKET_CHECK_FOR_WRITE,
506 AFS_SOCKET_AFD_PENDING
509 static enum afs_socket_status afsss;
512 * compute the timeout for para_server's main select-loop
514 * This function gets called from para_server to determine the timeout value
515 * for its main select loop.
517 * Before the timeout is computed, the current vss status flags are evaluated
518 * and acted upon by calling appropriate functions from the lower layers.
519 * Possible actions include
521 * - request a new file list from the current audio file selector
522 * - shutdown of all senders (stop/pause command)
523 * - reposition the stream (ff/jmp command)
525 * \return A pointer to a struct timeval containing the timeout for the next
526 * chunk of data to be sent, or NULL if we're not sending right now.
528 struct timeval *vss_preselect(fd_set *rfds, fd_set *wfds, int *max_fileno)
530 struct audio_format_handler *af = NULL;
534 para_fd_set(afs_socket, rfds, max_fileno);
537 format = mmd->audio_format;
541 for (i = 0; senders[i].name; i++)
542 senders[i].shutdown_clients();
543 if (vss_next() && af) {
545 return vss_compute_timeout();
547 if (vss_paused() || vss_repos()) {
548 for (i = 0; senders[i].name; i++)
549 senders[i].shutdown_clients();
552 gettimeofday(&now, NULL);
553 if (!vss_paused() || mmd->chunks_sent)
554 tv_add(&mmd->afi.eof_tv, &now, &eof_barrier);
556 tv_add(&now, &announce_tv, &data_send_barrier);
557 if (mmd->new_vss_status_flags & VSS_NOMORE)
558 mmd->new_vss_status_flags = VSS_NEXT;
560 mmd->chunks_sent = 0;
563 mmd->new_vss_status_flags &= ~(VSS_REPOS);
564 mmd->current_chunk = mmd->repos_request;
566 ret = vss_compute_timeout();
567 if (!ret && !map && vss_playing() &&
568 !(mmd->new_vss_status_flags & VSS_NOMORE)) {
569 PARA_DEBUG_LOG("%s", "ready and playing, but no audio file\n");
570 //vss_get_audio_file();
571 if (afsss == AFS_SOCKET_READY) {
572 para_fd_set(afs_socket, wfds, max_fileno);
573 afsss = AFS_SOCKET_CHECK_FOR_WRITE;
580 static int recv_afs_msg(int *fd, uint32_t *code, uint32_t *data)
582 char control[255], buf[8];
583 struct msghdr msg = {.msg_iov = NULL};
584 struct cmsghdr *cmsg;
589 iov.iov_len = sizeof(buf);
592 msg.msg_control = control;
593 msg.msg_controllen = sizeof(control);
594 memset(buf, 0, sizeof(buf));
595 ret = recvmsg(afs_socket, &msg, 0);
597 return -ERRNO_TO_PARA_ERROR(errno);
598 if (iov.iov_len != sizeof(buf))
599 return -E_SHORT_AFS_READ;
600 *code = *(uint32_t*)buf;
601 *data = *(uint32_t*)(buf + 4);
602 cmsg = CMSG_FIRSTHDR(&msg);
603 for (cmsg = CMSG_FIRSTHDR(&msg); cmsg; cmsg = CMSG_NXTHDR(&msg, cmsg)) {
604 if (cmsg->cmsg_level != SOL_SOCKET
605 || cmsg->cmsg_type != SCM_RIGHTS)
607 if ((cmsg->cmsg_len - CMSG_LEN(0)) / sizeof(int) != 1)
609 *fd = *(int *)CMSG_DATA(cmsg);
614 static void recv_afs_result(void)
616 int ret, passed_fd = -1, shmid;
617 uint32_t afs_code = 0, afs_data = 0;
621 ret = recv_afs_msg(&passed_fd, &afs_code, &afs_data);
624 PARA_NOTICE_LOG("got the fd: %d, code: %u, shmid: %u\n",
625 passed_fd, afs_code, afs_data);
626 ret = -E_BAD_AFS_CODE;
627 if (afs_code != NEXT_AUDIO_FILE)
629 afsss = AFS_SOCKET_READY;
631 ret = load_afd(shmid, &mmd->afd);
635 PARA_NOTICE_LOG("next audio file: %s (%lu chunks)\n", mmd->afd.path,
636 mmd->afd.afhi.chunks_total);
637 ret = fstat(passed_fd, &statbuf);
639 ret = -ERRNO_TO_PARA_ERROR(errno);
642 mmd->size = statbuf.st_size;
643 mmd->mtime = statbuf.st_mtime;
644 map = para_mmap(mmd->size, PROT_READ, MAP_PRIVATE,
646 strcpy(mmd->filename, mmd->afd.path); /* FIXME: check length */
647 mmd->afi.header_len = 0; /* default: no header */
648 mmd->audio_format = mmd->afd.afsi.audio_format_id;
649 mmd->chunks_sent = 0;
650 mmd->current_chunk = 0;
654 mmd->afi = mmd->afd.afhi;
655 mmd->new_vss_status_flags &= (~VSS_NEXT);
656 gettimeofday(&now, NULL);
657 tv_add(&now, &announce_tv, &data_send_barrier);
662 PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
665 void vss_post_select(fd_set *rfds, fd_set *wfds)
669 if (FD_ISSET(afs_socket, rfds))
671 if (afsss != AFS_SOCKET_CHECK_FOR_WRITE || !FD_ISSET(afs_socket, wfds))
673 ret = send_buffer(afs_socket, "new");
674 afsss = AFS_SOCKET_AFD_PENDING;
677 static void get_chunk(long unsigned chunk_num, char **buf, size_t *len)
679 size_t pos = mmd->afi.chunk_table[chunk_num];
681 *len = mmd->afi.chunk_table[chunk_num + 1] - pos;
685 * Get the data of the given chunk.
687 * \param chunk_num The number of the desired chunk.
688 * \param buf Chunk data.
689 * \param len Chunk length in bytes.
691 * \return Positive on success, negative on errors.
693 int vss_get_chunk(long unsigned chunk_num, char **buf, size_t *len)
695 if (mmd->audio_format < 0 || !map || !vss_playing())
697 if (chunk_num >= mmd->afi.chunks_total)
699 get_chunk(chunk_num, buf, len);
704 * main sending function
706 * This function gets called from para_server as soon as the next chunk of
707 * data should be pushed out. It first calls the read_chunk() function of
708 * the current audio format handler to obtain a pointer to the data to be
709 * sent out as well as its length. This information is then passed to each
710 * supported sender's send() function which does the actual sending.
712 void vss_send_chunk(void)
715 struct audio_format_handler *af;
716 struct timeval now, due;
718 if (mmd->audio_format < 0 || !map || !vss_playing())
720 af = &afl[mmd->audio_format];
721 gettimeofday(&now, NULL);
722 vss_next_chunk_time(&due);
723 if (tv_diff(&due, &now, NULL) > 0)
725 if (chk_barrier("eof", &now, &eof_barrier, &due, 1) < 0)
727 if (chk_barrier("data send", &now, &data_send_barrier,
730 mmd->new_vss_status_flags &= ~VSS_REPOS;
731 if (mmd->current_chunk >= mmd->afi.chunks_total) { /* eof */
732 mmd->new_vss_status_flags |= VSS_NEXT;
736 * We call the send function also in case of empty chunks as they
737 * might have still some data queued which can be sent in this case.
739 if (!mmd->chunks_sent) {
741 gettimeofday(&mmd->stream_start, NULL);
742 tv_scale(mmd->current_chunk, &mmd->afi.chunk_tv, &tmp);
743 mmd->offset = tv2ms(&tmp);
746 for (i = 0; senders[i].name; i++) {
749 get_chunk(mmd->current_chunk, &buf, &len);
750 senders[i].send(mmd->current_chunk, mmd->chunks_sent, buf, len);
752 mmd->new_vss_status_flags |= VSS_PLAYING;
754 mmd->current_chunk++;