vss.c: Remove some unused code.
[paraslash.git] / 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 "afs_common.h"
28 #include "vss.h"
29 #include "send.h"
30 #include "ipc.h"
31 #include "fd.h"
32
33 extern const char *status_item_list[];
34
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;
39
40 extern struct misc_meta_data *mmd;
41 extern struct audio_file_selector selectors[];
42 extern struct sender senders[];
43
44 static int audio_file;
45 static char *map;
46
47 /* The mp3 audio format handler does not need any libs. */
48 void mp3_init(struct audio_format_handler *);
49
50 #ifdef HAVE_OGGVORBIS
51 void ogg_init(struct audio_format_handler *);
52 #endif
53 #ifdef HAVE_FAAD
54 void aac_afh_init(struct audio_format_handler *);
55 #endif
56
57 /**
58 * The list of supported audio formats.
59 *
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.
65 *
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.
68 */
69 static struct audio_format_handler afl[] = {
70 {
71 .name = "mp3",
72 .init = mp3_init,
73 },
74 {
75 .name = "ogg",
76 #ifdef HAVE_OGGVORBIS
77 .init = ogg_init,
78 #endif
79 },
80 {
81 .name = "aac",
82 #ifdef HAVE_FAAD
83 .init = aac_afh_init,
84 #endif
85 },
86 {
87 .name = NULL,
88 }
89 };
90
91 static inline int next_audio_format(int format)
92 {
93 for (;;) {
94 if (!afl[format].name)
95 return format;
96 format++;
97 if (afl[format].init)
98 return format;
99 }
100
101 }
102
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))
105
106
107 /**
108 * check if vss status flag \a P (playing) is set
109 *
110 * \return greater than zero if playing, zero otherwise.
111 *
112 */
113 unsigned int vss_playing(void)
114 {
115 return mmd->new_vss_status_flags & VSS_PLAYING;
116 }
117
118 /**
119 * check if \a N (next) status flag is set
120 *
121 * \return greater than zero if set, zero if not.
122 *
123 */
124 unsigned int vss_next(void)
125 {
126 return mmd->new_vss_status_flags & VSS_NEXT;
127 }
128
129 /**
130 * check if a reposition request is pending
131 *
132 * \return greater than zero if true, zero otherwise.
133 *
134 */
135 unsigned int vss_repos(void)
136 {
137 return mmd->new_vss_status_flags & VSS_REPOS;
138 }
139
140 /**
141 * check if the vss is currently paused
142 *
143 * \return greater than zero if paused, zero otherwise.
144 *
145 */
146 unsigned int vss_paused(void)
147 {
148 return !(mmd->new_vss_status_flags & VSS_NEXT)
149 && !(mmd->new_vss_status_flags & VSS_PLAYING);
150 }
151
152 /**
153 * Get the name of the given audio format.
154 *
155 * \param i The audio format number.
156 *
157 * This returns a pointer to statically allocated memory so it
158 * must not be freed by the caller.
159 */
160 const char *audio_format_name(int i)
161 {
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)";
165 }
166
167 /**
168 * initialize the virtual streaming system
169 *
170 * Call the init functions of all supported audio format handlers and
171 * initialize all supported senders.
172 */
173 void vss_init(void)
174 {
175 int i;
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;
181
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",
186 afl[i].name);
187 afl[i].init(&afl[i]);
188 }
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]);
194 }
195 free(hn);
196 free(home);
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);
204 }
205 }
206
207 /**
208 * guess the audio format judging from filename
209 *
210 * \param name the filename
211 *
212 * \return This function returns -1 if it has no idea what kind of audio
213 * file this might be. Otherwise the (non-negative) number of the audio format
214 * is returned.
215 */
216 int guess_audio_format(const char *name)
217 {
218 int i,j, len = strlen(name);
219
220 FOR_EACH_AUDIO_FORMAT(i) {
221 for (j = 0; afl[i].suffixes[j]; j++) {
222 const char *p = afl[i].suffixes[j];
223 int plen = strlen(p);
224 if (len < plen + 1)
225 continue;
226 if (name[len - plen - 1] != '.')
227 continue;
228 if (strcasecmp(name + len - plen, p))
229 continue;
230 // PARA_DEBUG_LOG("might be %s\n", audio_format_name(i));
231 return i;
232 }
233 }
234 return -E_BAD_AUDIO_FILE_SUFFIX;
235 }
236
237 /**
238 * Call get_file_info() to obtain an afhi structure.
239 *
240 * \param path The full path of the audio file.
241 * \param data Pointer to the contents of the (mapped) file.
242 * \param size The file size in bytes.
243 * \param afhi Result pointer.
244 *
245 * \return The number of the audio format on success, \p -E_AUDIO_FORMAT if no
246 * compiled in audio format handler is able to handler the file.
247 *
248 * This function tries to find an audio format handler that can interpret the
249 * file given by \a data and \a size.
250 *
251 * It first tries to determine the audio format from the filename given by \a
252 * path. If this doesn't work, all other audio format handlers are tried until
253 * one is found that can handle the file.
254 */
255 int compute_afhi(const char *path, char *data, size_t size,
256 struct audio_format_info *afhi)
257 {
258 int ret, i, format = guess_audio_format(path);
259
260 if (format >= 0) {
261 ret = afl[format].get_file_info(data, size, afhi);
262 if (ret >= 0)
263 return format;
264 }
265 FOR_EACH_AUDIO_FORMAT(i) {
266 if (i == format) /* we already tried this one to no avail */
267 continue;
268 ret = afl[i].get_file_info(data, size, afhi);
269 if (ret >= 0)
270 return i;
271 PARA_WARNING_LOG("%s\n", PARA_STRERROR(-ret));
272 }
273 return -E_AUDIO_FORMAT;
274 }
275
276 static int chk_barrier(const char *bname, const struct timeval *now,
277 const struct timeval *barrier, struct timeval *diff,
278 int print_log)
279 {
280 long ms;
281
282 if (tv_diff(now, barrier, diff) > 0)
283 return 1;
284 ms = tv2ms(diff);
285 if (print_log && ms)
286 PARA_DEBUG_LOG("%s barrier: %lims left\n", bname, ms);
287 return -1;
288 }
289
290 static void vss_next_chunk_time(struct timeval *due)
291 {
292 struct timeval tmp;
293
294 tv_scale(mmd->chunks_sent, &mmd->afi.chunk_tv, &tmp);
295 tv_add(&tmp, &mmd->stream_start, due);
296 }
297
298 /*
299 * != NULL: timeout for next chunk
300 * NULL: nothing to do
301 */
302 static struct timeval *vss_compute_timeout(void)
303 {
304 static struct timeval the_timeout;
305 struct timeval now, next_chunk;
306
307 if (vss_next() && mmd->audio_format >= 0) {
308 /* only sleep a bit, nec*/
309 the_timeout.tv_sec = 0;
310 the_timeout.tv_usec = 100;
311 return &the_timeout;
312 }
313 gettimeofday(&now, NULL);
314 if (chk_barrier("autoplay_delay", &now, &autoplay_barrier,
315 &the_timeout, 1) < 0)
316 return &the_timeout;
317 if (chk_barrier("eof", &now, &eof_barrier, &the_timeout, 1) < 0)
318 return &the_timeout;
319 if (chk_barrier("data send", &now, &data_send_barrier,
320 &the_timeout, 1) < 0)
321 return &the_timeout;
322 if (mmd->audio_format < 0 || !vss_playing() || !map)
323 return NULL;
324 vss_next_chunk_time(&next_chunk);
325 if (chk_barrier(afl[mmd->audio_format].name, &now, &next_chunk,
326 &the_timeout, 0) < 0)
327 return &the_timeout;
328 /* chunk is due or bof */
329 the_timeout.tv_sec = 0;
330 the_timeout.tv_usec = 0;
331 return &the_timeout;
332 }
333
334 static void vss_eof(void)
335 {
336 struct timeval now;
337 int i;
338 char *tmp;
339
340 if (!map) {
341 for (i = 0; senders[i].name; i++)
342 senders[i].shutdown_clients();
343 return;
344 }
345 gettimeofday(&now, NULL);
346 tv_add(&mmd->afi.eof_tv, &now, &eof_barrier);
347 munmap(map, mmd->size);
348 map = NULL;
349 close(audio_file);
350 mmd->audio_format = -1;
351 mmd->chunks_sent = 0;
352 mmd->offset = 0;
353 mmd->afi.seconds_total = 0;
354 free(mmd->afi.chunk_table);
355 mmd->afi.chunk_table = NULL;
356 tmp = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_AUDIO_INFO1],
357 status_item_list[SI_AUDIO_INFO2], status_item_list[SI_AUDIO_INFO3]);
358 strcpy(mmd->afi.info_string, tmp);
359 free(tmp);
360 tmp = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_DBINFO1],
361 status_item_list[SI_DBINFO2], status_item_list[SI_DBINFO3]);
362 strcpy(mmd->selector_info, tmp);
363 free(tmp);
364 mmd->filename[0] = '\0';
365 mmd->size = 0;
366 mmd->events++;
367 }
368
369 /**
370 * Get the header of the current audio file.
371 *
372 * \param header_len the length of the header is stored here
373 *
374 * \return a pointer to a buffer containing the header, or NULL, if no audio
375 * file is selected or if the current audio format does not need special header
376 * treamtment.
377 *
378 */
379 char *vss_get_header(size_t *header_len)
380 {
381 if (mmd->audio_format < 0 || !map || !mmd->afi.header_len)
382 return NULL;
383 *header_len = mmd->afi.header_len;
384 return map + mmd->afi.header_offset;
385 }
386
387 /**
388 * get the list of all supported audio formats
389 *
390 * \return a space separated list of all supported audio formats
391 * It is not allocated at runtime, i.e. there is no need to free
392 * the returned string in the caller.
393 */
394 const char *supported_audio_formats(void)
395 {
396 return SUPPORTED_AUDIO_FORMATS;
397 }
398
399 /**
400 * get the chunk time of the current audio file
401 *
402 * \return a pointer to a struct containing the chunk time, or NULL,
403 * if currently no audio file is selected.
404 */
405 struct timeval *vss_chunk_time(void)
406 {
407 if (mmd->audio_format < 0)
408 return NULL;
409 return &mmd->afi.chunk_tv;
410 }
411
412 enum afs_socket_status {
413 AFS_SOCKET_READY,
414 AFS_SOCKET_CHECK_FOR_WRITE,
415 AFS_SOCKET_AFD_PENDING
416 };
417
418 static enum afs_socket_status afsss;
419
420 /**
421 * compute the timeout for para_server's main select-loop
422 *
423 * This function gets called from para_server to determine the timeout value
424 * for its main select loop.
425 *
426 * Before the timeout is computed, the current vss status flags are evaluated
427 * and acted upon by calling appropriate functions from the lower layers.
428 * Possible actions include
429 *
430 * - request a new file list from the current audio file selector
431 * - shutdown of all senders (stop/pause command)
432 * - reposition the stream (ff/jmp command)
433 *
434 * \return A pointer to a struct timeval containing the timeout for the next
435 * chunk of data to be sent, or NULL if we're not sending right now.
436 */
437 struct timeval *vss_preselect(fd_set *rfds, fd_set *wfds, int *max_fileno)
438 {
439 struct audio_format_handler *af = NULL;
440 int i, format;
441 struct timeval *ret;
442
443 para_fd_set(afs_socket, rfds, max_fileno);
444
445 //again:
446 format = mmd->audio_format;
447 if (format >= 0)
448 af = afl + format;
449 else
450 for (i = 0; senders[i].name; i++)
451 senders[i].shutdown_clients();
452 if (vss_next() && af) {
453 vss_eof();
454 return vss_compute_timeout();
455 }
456 if (vss_paused() || vss_repos()) {
457 for (i = 0; senders[i].name; i++)
458 senders[i].shutdown_clients();
459 if (af) {
460 struct timeval now;
461 gettimeofday(&now, NULL);
462 if (!vss_paused() || mmd->chunks_sent)
463 tv_add(&mmd->afi.eof_tv, &now, &eof_barrier);
464 if (vss_repos())
465 tv_add(&now, &announce_tv, &data_send_barrier);
466 if (mmd->new_vss_status_flags & VSS_NOMORE)
467 mmd->new_vss_status_flags = VSS_NEXT;
468 }
469 mmd->chunks_sent = 0;
470 }
471 if (vss_repos()) {
472 mmd->new_vss_status_flags &= ~(VSS_REPOS);
473 mmd->current_chunk = mmd->repos_request;
474 }
475 ret = vss_compute_timeout();
476 if (!ret && !map && vss_playing() &&
477 !(mmd->new_vss_status_flags & VSS_NOMORE)) {
478 PARA_DEBUG_LOG("%s", "ready and playing, but no audio file\n");
479 //vss_get_audio_file();
480 if (afsss == AFS_SOCKET_READY) {
481 para_fd_set(afs_socket, wfds, max_fileno);
482 afsss = AFS_SOCKET_CHECK_FOR_WRITE;
483 }
484 // goto again;
485 }
486 return ret;
487 }
488
489 static int recv_afs_msg(int *fd, uint32_t *code, uint32_t *data)
490 {
491 char control[255], buf[8];
492 struct msghdr msg = {.msg_iov = NULL};
493 struct cmsghdr *cmsg;
494 struct iovec iov;
495 int ret = 0;
496
497 iov.iov_base = buf;
498 iov.iov_len = sizeof(buf);
499 msg.msg_iov = &iov;
500 msg.msg_iovlen = 1;
501 msg.msg_control = control;
502 msg.msg_controllen = sizeof(control);
503 memset(buf, 0, sizeof(buf));
504 ret = recvmsg(afs_socket, &msg, 0);
505 if (ret < 0)
506 return -ERRNO_TO_PARA_ERROR(errno);
507 if (iov.iov_len != sizeof(buf))
508 return -E_SHORT_AFS_READ;
509 *code = *(uint32_t*)buf;
510 *data = *(uint32_t*)(buf + 4);
511 cmsg = CMSG_FIRSTHDR(&msg);
512 for (cmsg = CMSG_FIRSTHDR(&msg); cmsg; cmsg = CMSG_NXTHDR(&msg, cmsg)) {
513 if (cmsg->cmsg_level != SOL_SOCKET
514 || cmsg->cmsg_type != SCM_RIGHTS)
515 continue;
516 if ((cmsg->cmsg_len - CMSG_LEN(0)) / sizeof(int) != 1)
517 continue;
518 *fd = *(int *)CMSG_DATA(cmsg);
519 }
520 return 1;
521 }
522
523 static void recv_afs_result(void)
524 {
525 int ret, passed_fd = -1, shmid;
526 uint32_t afs_code = 0, afs_data = 0;
527 struct stat statbuf;
528 struct timeval now;
529
530 ret = recv_afs_msg(&passed_fd, &afs_code, &afs_data);
531 if (ret < 0)
532 goto err;
533 PARA_NOTICE_LOG("got the fd: %d, code: %u, shmid: %u\n",
534 passed_fd, afs_code, afs_data);
535 ret = -E_BAD_AFS_CODE;
536 if (afs_code != NEXT_AUDIO_FILE)
537 goto err;
538 afsss = AFS_SOCKET_READY;
539 shmid = afs_data;
540 ret = load_afd(shmid, &mmd->afd);
541 if (ret < 0)
542 goto err;
543 shm_destroy(shmid);
544 PARA_NOTICE_LOG("next audio file: %s (%lu chunks)\n", mmd->afd.path,
545 mmd->afd.afhi.chunks_total);
546 ret = fstat(passed_fd, &statbuf);
547 if (ret < 0) {
548 ret = -ERRNO_TO_PARA_ERROR(errno);
549 goto err;
550 }
551 mmd->size = statbuf.st_size;
552 mmd->mtime = statbuf.st_mtime;
553 map = para_mmap(mmd->size, PROT_READ, MAP_PRIVATE,
554 passed_fd, 0);
555 strcpy(mmd->filename, mmd->afd.path); /* FIXME: check length */
556 mmd->afi.header_len = 0; /* default: no header */
557 mmd->audio_format = mmd->afd.afsi.audio_format_id;
558 mmd->chunks_sent = 0;
559 mmd->current_chunk = 0;
560 mmd->offset = 0;
561 mmd->events++;
562 mmd->num_played++;
563 mmd->afi = mmd->afd.afhi;
564 mmd->new_vss_status_flags &= (~VSS_NEXT);
565 gettimeofday(&now, NULL);
566 tv_add(&now, &announce_tv, &data_send_barrier);
567 return;
568 err:
569 if (passed_fd >= 0)
570 close(passed_fd);
571 PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
572 }
573
574 void vss_post_select(fd_set *rfds, fd_set *wfds)
575 {
576 int ret;
577
578 if (FD_ISSET(afs_socket, rfds))
579 recv_afs_result();
580 if (afsss != AFS_SOCKET_CHECK_FOR_WRITE || !FD_ISSET(afs_socket, wfds))
581 return;
582 ret = send_buffer(afs_socket, "new");
583 afsss = AFS_SOCKET_AFD_PENDING;
584 }
585
586 static void get_chunk(long unsigned chunk_num, char **buf, size_t *len)
587 {
588 size_t pos = mmd->afi.chunk_table[chunk_num];
589 *buf = map + pos;
590 *len = mmd->afi.chunk_table[chunk_num + 1] - pos;
591 }
592
593 /**
594 * Get the data of the given chunk.
595 *
596 * \param chunk_num The number of the desired chunk.
597 * \param buf Chunk data.
598 * \param len Chunk length in bytes.
599 *
600 * \return Positive on success, negative on errors.
601 */
602 int vss_get_chunk(long unsigned chunk_num, char **buf, size_t *len)
603 {
604 if (mmd->audio_format < 0 || !map || !vss_playing())
605 return -E_CHUNK;
606 if (chunk_num >= mmd->afi.chunks_total)
607 return -E_CHUNK;
608 get_chunk(chunk_num, buf, len);
609 return 1;
610 }
611
612 /**
613 * main sending function
614 *
615 * This function gets called from para_server as soon as the next chunk of
616 * data should be pushed out. It first calls the read_chunk() function of
617 * the current audio format handler to obtain a pointer to the data to be
618 * sent out as well as its length. This information is then passed to each
619 * supported sender's send() function which does the actual sending.
620 */
621 void vss_send_chunk(void)
622 {
623 int i;
624 struct audio_format_handler *af;
625 struct timeval now, due;
626
627 if (mmd->audio_format < 0 || !map || !vss_playing())
628 return;
629 af = &afl[mmd->audio_format];
630 gettimeofday(&now, NULL);
631 vss_next_chunk_time(&due);
632 if (tv_diff(&due, &now, NULL) > 0)
633 return;
634 if (chk_barrier("eof", &now, &eof_barrier, &due, 1) < 0)
635 return;
636 if (chk_barrier("data send", &now, &data_send_barrier,
637 &due, 1) < 0)
638 return;
639 mmd->new_vss_status_flags &= ~VSS_REPOS;
640 if (mmd->current_chunk >= mmd->afi.chunks_total) { /* eof */
641 mmd->new_vss_status_flags |= VSS_NEXT;
642 return vss_eof();
643 }
644 /*
645 * We call the send function also in case of empty chunks as they
646 * might have still some data queued which can be sent in this case.
647 */
648 if (!mmd->chunks_sent) {
649 struct timeval tmp;
650 gettimeofday(&mmd->stream_start, NULL);
651 tv_scale(mmd->current_chunk, &mmd->afi.chunk_tv, &tmp);
652 mmd->offset = tv2ms(&tmp);
653 mmd->events++;
654 }
655 for (i = 0; senders[i].name; i++) {
656 char *buf;
657 size_t len;
658 get_chunk(mmd->current_chunk, &buf, &len);
659 senders[i].send(mmd->current_chunk, mmd->chunks_sent, buf, len);
660 }
661 mmd->new_vss_status_flags |= VSS_PLAYING;
662 mmd->chunks_sent++;
663 mmd->current_chunk++;
664 }