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
17 #include <sys/mman.h> /* mmap */
18 #include <sys/time.h> /* gettimeofday */
19 #include "server.cmdline.h"
20 #include "afs_common.h"
27 extern const char *status_item_list
[];
29 static struct timeval announce_tv
;
30 static struct timeval data_send_barrier
;
31 static struct timeval eof_barrier
;
32 static struct timeval autoplay_barrier
;
34 extern struct misc_meta_data
*mmd
;
35 extern struct audio_file_selector selectors
[];
36 extern struct sender senders
[];
38 static int audio_file
;
41 /* The mp3 audio format handler does not need any libs. */
42 void mp3_init(struct audio_format_handler
*);
45 void ogg_init(struct audio_format_handler
*);
48 void aac_afh_init(struct audio_format_handler
*);
52 * The list of supported audio formats.
54 * We always define the full array of audio formats even if some audio formats
55 * were not compiled in. This is because for each audio file the number of its
56 * audio format is stored in the databse. We don't want that numbers to become
57 * stale just because the user installed a new version of paraslash that
58 * supports a different set of audio formats.
60 * It can still be easily detected whether an audio format is compiled in by
61 * checking if the init function pointer is not \p NULL.
63 static struct audio_format_handler afl
[] = {
85 static inline int next_audio_format(int format
)
88 if (!afl
[format
].name
)
97 /** Iterate over each supported audio format. */
98 #define FOR_EACH_AUDIO_FORMAT(i) for (i = 0; afl[i].name; i = next_audio_format(i))
102 * check if vss status flag \a P (playing) is set
104 * \return greater than zero if playing, zero otherwise.
107 unsigned int vss_playing(void)
109 return mmd
->new_vss_status_flags
& VSS_PLAYING
;
113 * check if \a N (next) status flag is set
115 * \return greater than zero if set, zero if not.
118 unsigned int vss_next(void)
120 return mmd
->new_vss_status_flags
& VSS_NEXT
;
124 * check if a reposition request is pending
126 * \return greater than zero if true, zero otherwise.
129 unsigned int vss_repos(void)
131 return mmd
->new_vss_status_flags
& VSS_REPOS
;
135 * check if the vss is currently paused
137 * \return greater than zero if paused, zero otherwise.
140 unsigned int vss_paused(void)
142 return !(mmd
->new_vss_status_flags
& VSS_NEXT
)
143 && !(mmd
->new_vss_status_flags
& VSS_PLAYING
);
147 * Get the name of the given audio format.
149 * \param i The audio format number.
151 * This returns a pointer to statically allocated memory so it
152 * must not be freed by the caller.
154 const char *audio_format_name(int i
)
156 assert(i
>= 0 && i
< ARRAY_SIZE(afl
));
161 * initialize the virtual streaming system
163 * Call the init functions of all supported audio format handlers and
164 * initialize all supported senders.
169 char *hn
= para_hostname(), *home
= para_homedir();
170 long unsigned announce_time
= conf
.announce_time_arg
> 0?
171 conf
.announce_time_arg
: 300,
172 autoplay_delay
= conf
.autoplay_delay_arg
> 0?
173 conf
.autoplay_delay_arg
: 0;
175 PARA_DEBUG_LOG("supported audio formats: %s\n",
176 SUPPORTED_AUDIO_FORMATS
);
177 FOR_EACH_AUDIO_FORMAT(i
) {
178 PARA_NOTICE_LOG("initializing %s handler\n",
180 afl
[i
].init(&afl
[i
]);
182 ms2tv(announce_time
, &announce_tv
);
183 PARA_INFO_LOG("announce timeval: %lums\n", tv2ms(&announce_tv
));
184 for (i
= 0; senders
[i
].name
; i
++) {
185 PARA_NOTICE_LOG("initializing %s sender\n", senders
[i
].name
);
186 senders
[i
].init(&senders
[i
]);
190 if (conf
.autoplay_given
) {
191 struct timeval now
, tmp
;
192 mmd
->vss_status_flags
|= VSS_PLAYING
;
193 mmd
->new_vss_status_flags
|= VSS_PLAYING
;
194 gettimeofday(&now
, NULL
);
195 ms2tv(autoplay_delay
, &tmp
);
196 tv_add(&now
, &tmp
, &autoplay_barrier
);
200 static int get_file_info(int i
)
202 return afl
[i
].get_file_info(map
, mmd
->size
, &mmd
->afi
);
206 * guess the audio format judging from filename
208 * \param name the filename
210 * \return This function returns -1 if it has no idea what kind of audio
211 * file this might be. Otherwise the (non-negative) number of the audio format
214 int guess_audio_format(const char *name
)
216 int i
,j
, len
= strlen(name
);
218 FOR_EACH_AUDIO_FORMAT(i
) {
219 for (j
= 0; afl
[i
].suffixes
[j
]; j
++) {
220 const char *p
= afl
[i
].suffixes
[j
];
221 int plen
= strlen(p
);
224 if (name
[len
- plen
- 1] != '.')
226 if (strcasecmp(name
+ len
- plen
, p
))
228 // PARA_DEBUG_LOG("might be %s\n", audio_format_name(i));
235 static int get_audio_format(int omit
)
239 FOR_EACH_AUDIO_FORMAT(i
) {
242 if (get_file_info(i
) > 0)
245 return -E_AUDIO_FORMAT
;
249 * Call get_file_info() to obtain an afhi structure.
251 * \param path The full path of the audio file.
252 * \param data Pointer to the contents of the (mapped) file.
253 * \param size The file size in bytes.
254 * \param afhi Result pointer.
256 * \return The number of the audio format on success, \p -E_AUDIO_FORMAT if no
257 * compiled in audio format handler is able to handler the file.
259 * This function tries to find an audio format handler that can interpret the
260 * file given by \a data and \a size.
262 * It first tries to determine the audio format from the filename given by \a
263 * path. If this doesn't work, all other audio format handlers are tried until
264 * one is found that can handle the file.
266 int compute_afhi(const char *path
, char *data
, size_t size
,
267 struct audio_format_info
*afhi
)
269 int ret
, i
, format
= guess_audio_format(path
);
272 ret
= afl
[format
].get_file_info(data
, size
, afhi
);
276 FOR_EACH_AUDIO_FORMAT(i
) {
277 if (i
== format
) /* we already tried this one to no avail */
279 ret
= afl
[i
].get_file_info(data
, size
, afhi
);
282 PARA_WARNING_LOG("%s\n", PARA_STRERROR(-ret
));
284 return -E_AUDIO_FORMAT
;
290 static int update_mmd(void)
294 i
= guess_audio_format(mmd
->filename
);
295 if (i
< 0 || get_file_info(i
) < 0)
296 i
= get_audio_format(i
);
299 mmd
->audio_format
= i
;
300 mmd
->chunks_sent
= 0;
301 mmd
->current_chunk
= 0;
307 static void vss_get_audio_file(void)
309 char **sl
= selectors
[mmd
->selector_num
].get_audio_file_list(10);
311 struct stat file_status
;
315 for (i
= 0; sl
[i
]; i
++) {
317 PARA_INFO_LOG("trying %s\n", sl
[i
]);
318 if (strlen(sl
[i
]) >= _POSIX_PATH_MAX
)
320 audio_file
= open(sl
[i
], O_RDONLY
);
323 if (fstat(audio_file
, &file_status
) == -1 ||
324 !file_status
.st_size
) {
328 mmd
->size
= file_status
.st_size
;
329 mmd
->mtime
= file_status
.st_mtime
;
330 map
= para_mmap(mmd
->size
, PROT_READ
, MAP_PRIVATE
,
332 strcpy(mmd
->filename
, sl
[i
]);
333 mmd
->afi
.header_len
= 0; /* default: no header */
334 if (update_mmd() < 0) { /* invalid file */
336 munmap(map
, mmd
->size
);
341 if (selectors
[mmd
->selector_num
].update_audio_file
)
342 selectors
[mmd
->selector_num
].update_audio_file(sl
[i
]);
343 PARA_NOTICE_LOG("next audio file: %s\n", mmd
->filename
);
344 mmd
->new_vss_status_flags
&= (~VSS_NEXT
);
345 gettimeofday(&now
, NULL
);
346 tv_add(&now
, &announce_tv
, &data_send_barrier
);
350 PARA_ERROR_LOG("%s", "no valid files found\n");
351 mmd
->new_vss_status_flags
= VSS_NEXT
;
354 for (i
= 0; sl
[i
]; i
++)
360 static int chk_barrier(const char *bname
, const struct timeval
*now
,
361 const struct timeval
*barrier
, struct timeval
*diff
,
366 if (tv_diff(now
, barrier
, diff
) > 0)
370 PARA_DEBUG_LOG("%s barrier: %lims left\n", bname
, ms
);
374 static void vss_next_chunk_time(struct timeval
*due
)
378 tv_scale(mmd
->chunks_sent
, &mmd
->afi
.chunk_tv
, &tmp
);
379 tv_add(&tmp
, &mmd
->stream_start
, due
);
383 * != NULL: timeout for next chunk
384 * NULL: nothing to do
386 static struct timeval
*vss_compute_timeout(void)
388 static struct timeval the_timeout
;
389 struct timeval now
, next_chunk
;
391 if (vss_next() && mmd
->audio_format
>= 0) {
392 /* only sleep a bit, nec*/
393 the_timeout
.tv_sec
= 0;
394 the_timeout
.tv_usec
= 100;
397 gettimeofday(&now
, NULL
);
398 if (chk_barrier("autoplay_delay", &now
, &autoplay_barrier
,
399 &the_timeout
, 1) < 0)
401 if (chk_barrier("eof", &now
, &eof_barrier
, &the_timeout
, 1) < 0)
403 if (chk_barrier("data send", &now
, &data_send_barrier
,
404 &the_timeout
, 1) < 0)
406 if (mmd
->audio_format
< 0 || !vss_playing() || !map
)
408 vss_next_chunk_time(&next_chunk
);
409 if (chk_barrier(afl
[mmd
->audio_format
].name
, &now
, &next_chunk
,
410 &the_timeout
, 0) < 0)
412 /* chunk is due or bof */
413 the_timeout
.tv_sec
= 0;
414 the_timeout
.tv_usec
= 0;
418 static void vss_eof(void)
425 for (i
= 0; senders
[i
].name
; i
++)
426 senders
[i
].shutdown_clients();
429 gettimeofday(&now
, NULL
);
430 tv_add(&mmd
->afi
.eof_tv
, &now
, &eof_barrier
);
431 munmap(map
, mmd
->size
);
434 mmd
->audio_format
= -1;
435 mmd
->chunks_sent
= 0;
437 mmd
->afi
.seconds_total
= 0;
438 free(mmd
->afi
.chunk_table
);
439 mmd
->afi
.chunk_table
= NULL
;
440 tmp
= make_message("%s:\n%s:\n%s:\n", status_item_list
[SI_AUDIO_INFO1
],
441 status_item_list
[SI_AUDIO_INFO2
], status_item_list
[SI_AUDIO_INFO3
]);
442 strcpy(mmd
->afi
.info_string
, tmp
);
444 tmp
= make_message("%s:\n%s:\n%s:\n", status_item_list
[SI_DBINFO1
],
445 status_item_list
[SI_DBINFO2
], status_item_list
[SI_DBINFO3
]);
446 strcpy(mmd
->selector_info
, tmp
);
448 mmd
->filename
[0] = '\0';
454 * Get the header of the current audio file.
456 * \param header_len the length of the header is stored here
458 * \return a pointer to a buffer containing the header, or NULL, if no audio
459 * file is selected or if the current audio format does not need special header
463 char *vss_get_header(size_t *header_len
)
465 if (mmd
->audio_format
< 0 || !map
|| !mmd
->afi
.header_len
)
467 *header_len
= mmd
->afi
.header_len
;
468 return map
+ mmd
->afi
.header_offset
;
472 * get the list of all supported audio formats
474 * \return a space separated list of all supported audio formats
475 * It is not allocated at runtime, i.e. there is no need to free
476 * the returned string in the caller.
478 const char *supported_audio_formats(void)
480 return SUPPORTED_AUDIO_FORMATS
;
484 * get the chunk time of the current audio file
486 * \return a pointer to a struct containing the chunk time, or NULL,
487 * if currently no audio file is selected.
489 struct timeval
*vss_chunk_time(void)
491 if (mmd
->audio_format
< 0)
493 return &mmd
->afi
.chunk_tv
;
497 * compute the timeout for para_server's main select-loop
499 * This function gets called from para_server to determine the timeout value
500 * for its main select loop.
502 * Before the timeout is computed, the current vss status flags are evaluated
503 * and acted upon by calling appropriate functions from the lower layers.
504 * Possible actions include
506 * - request a new file list from the current audio file selector
507 * - shutdown of all senders (stop/pause command)
508 * - reposition the stream (ff/jmp command)
510 * \return A pointer to a struct timeval containing the timeout for the next
511 * chunk of data to be sent, or NULL if we're not sending right now.
513 struct timeval
*vss_preselect(void)
515 struct audio_format_handler
*af
= NULL
;
519 format
= mmd
->audio_format
;
523 for (i
= 0; senders
[i
].name
; i
++)
524 senders
[i
].shutdown_clients();
525 if (vss_next() && af
) {
527 return vss_compute_timeout();
529 if (vss_paused() || vss_repos()) {
530 for (i
= 0; senders
[i
].name
; i
++)
531 senders
[i
].shutdown_clients();
534 gettimeofday(&now
, NULL
);
535 if (!vss_paused() || mmd
->chunks_sent
)
536 tv_add(&mmd
->afi
.eof_tv
, &now
, &eof_barrier
);
538 tv_add(&now
, &announce_tv
, &data_send_barrier
);
539 if (mmd
->new_vss_status_flags
& VSS_NOMORE
)
540 mmd
->new_vss_status_flags
= VSS_NEXT
;
542 mmd
->chunks_sent
= 0;
545 mmd
->new_vss_status_flags
&= ~(VSS_REPOS
);
546 mmd
->current_chunk
= mmd
->repos_request
;
548 ret
= vss_compute_timeout();
549 if (!ret
&& !map
&& vss_playing() &&
550 !(mmd
->new_vss_status_flags
& VSS_NOMORE
)) {
551 PARA_DEBUG_LOG("%s", "ready and playing, but no audio file\n");
552 vss_get_audio_file();
558 static void get_chunk(long unsigned chunk_num
, char **buf
, size_t *len
)
560 size_t pos
= mmd
->afi
.chunk_table
[chunk_num
];
562 *len
= mmd
->afi
.chunk_table
[chunk_num
+ 1] - pos
;
566 * Get the data of the given chunk.
568 * \param chunk_num The number of the desired chunk.
569 * \param buf Chunk data.
570 * \param len Chunk length in bytes.
572 * \return Positive on success, negative on errors.
574 int vss_get_chunk(long unsigned chunk_num
, char **buf
, size_t *len
)
576 if (mmd
->audio_format
< 0 || !map
|| !vss_playing())
578 if (chunk_num
>= mmd
->afi
.chunks_total
)
580 get_chunk(chunk_num
, buf
, len
);
585 * main sending function
587 * This function gets called from para_server as soon as the next chunk of
588 * data should be pushed out. It first calls the read_chunk() function of
589 * the current audio format handler to obtain a pointer to the data to be
590 * sent out as well as its length. This information is then passed to each
591 * supported sender's send() function which does the actual sending.
593 void vss_send_chunk(void)
596 struct audio_format_handler
*af
;
597 struct timeval now
, due
;
599 if (mmd
->audio_format
< 0 || !map
|| !vss_playing())
601 af
= &afl
[mmd
->audio_format
];
602 gettimeofday(&now
, NULL
);
603 vss_next_chunk_time(&due
);
604 if (tv_diff(&due
, &now
, NULL
) > 0)
606 if (chk_barrier("eof", &now
, &eof_barrier
, &due
, 1) < 0)
608 if (chk_barrier("data send", &now
, &data_send_barrier
,
611 mmd
->new_vss_status_flags
&= ~VSS_REPOS
;
612 if (mmd
->current_chunk
>= mmd
->afi
.chunks_total
) { /* eof */
613 mmd
->new_vss_status_flags
|= VSS_NEXT
;
617 * We call the send function also in case of empty chunks as they
618 * might have still some data queued which can be sent in this case.
620 if (!mmd
->chunks_sent
) {
622 gettimeofday(&mmd
->stream_start
, NULL
);
623 tv_scale(mmd
->current_chunk
, &mmd
->afi
.chunk_tv
, &tmp
);
624 mmd
->offset
= tv2ms(&tmp
);
627 for (i
= 0; senders
[i
].name
; i
++) {
630 get_chunk(mmd
->current_chunk
, &buf
, &len
);
631 senders
[i
].send(mmd
->current_chunk
, mmd
->chunks_sent
, buf
, len
);
633 mmd
->new_vss_status_flags
|= VSS_PLAYING
;
635 mmd
->current_chunk
++;