2 * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
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.
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.
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.
19 /** \file vss.c the virtual streaming system
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.
26 #include <sys/time.h> /* gettimeofday */
27 #include "server.cmdline.h"
36 extern const char *status_item_list[];
38 static struct timeval announce_tv;
39 static struct timeval data_send_barrier;
40 static struct timeval eof_barrier;
41 static struct timeval autoplay_barrier;
43 extern struct misc_meta_data *mmd;
44 extern struct audio_file_selector selectors[];
45 extern struct sender senders[];
47 static size_t *chunk_table, inbuf_size;
49 static FILE *audio_file = NULL;
52 void mp3_init(struct audio_format_handler *);
56 void ogg_init(struct audio_format_handler *);
59 void aac_afh_init(struct audio_format_handler *);
63 * the list of supported audio formats
65 static struct audio_format_handler afl[] = {
89 /** iterate over each supported audio format */
90 #define FOR_EACH_AUDIO_FORMAT(i) for (i = 0; afl[i].name; i++)
95 * check if vss status flag \a P (playing) is set
97 * \return greater than zero if playing, zero otherwise.
100 unsigned int vss_playing(void)
102 return mmd->new_vss_status_flags & VSS_PLAYING;
106 * check if \a N (next) status flag is set
108 * \return greater than zero if set, zero if not.
111 unsigned int vss_next(void)
113 return mmd->new_vss_status_flags & VSS_NEXT;
117 * check if a reposition request is pending
119 * \return greater than zero if true, zero otherwise.
122 unsigned int vss_repos(void)
124 return mmd->new_vss_status_flags & VSS_REPOS;
128 * check if the vss is currently paused
130 * \return greater than zero if paused, zero otherwise.
133 unsigned int vss_paused(void)
135 return !(mmd->new_vss_status_flags & VSS_NEXT)
136 && !(mmd->new_vss_status_flags & VSS_PLAYING);
140 * get the name of the given audio format
141 * \param i the audio format number
143 * This returns a pointer to statically allocated memory so it
144 * must not be freed by the caller.
146 const char *audio_format_name(int i)
148 return i >= 0? afl[i].name : "(none)";
152 * initialize the virtual streaming system
154 * Call the init functions of all supported audio format handlers and
155 * initialize all supported senders.
160 char *hn = para_hostname(), *home = para_homedir();
162 PARA_DEBUG_LOG("supported audio formats: %s\n",
163 SUPPORTED_AUDIO_FORMATS);
164 for (i = 0; afl[i].name; i++) {
165 PARA_NOTICE_LOG("initializing %s handler\n",
167 afl[i].init(&afl[i]);
169 ms2tv(conf.announce_time_arg, &announce_tv);
170 PARA_INFO_LOG("announce timeval: %lums\n", tv2ms(&announce_tv));
171 for (i = 0; senders[i].name; i++) {
172 PARA_NOTICE_LOG("initializing %s sender\n", senders[i].name);
173 senders[i].init(&senders[i]);
177 if (conf.autoplay_given) {
178 struct timeval now, tmp;
179 mmd->vss_status_flags |= VSS_PLAYING;
180 mmd->new_vss_status_flags |= VSS_PLAYING;
181 gettimeofday(&now, NULL);
182 ms2tv(conf.autoplay_delay_arg, &tmp);
183 tv_add(&now, &tmp, &autoplay_barrier);
187 static int get_file_info(int i)
189 return afl[i].get_file_info(audio_file, mmd->audio_file_info,
190 &mmd->chunks_total, &mmd->seconds_total, &chunk_table);
194 * guess the audio format judging from filename
196 * \param name the filename
198 * \return This function returns -1 if it has no idea what kind of audio
199 * file this might be. Otherwise the (non-negative) number of the audio format
202 int guess_audio_format(const char *name)
204 int i,j, len = strlen(name);
206 FOR_EACH_AUDIO_FORMAT(i) {
207 for (j = 0; afl[i].suffixes[j]; j++) {
208 const char *p = afl[i].suffixes[j];
209 int plen = strlen(p);
212 if (name[len - plen - 1] != '.')
214 if (strcasecmp(name + len - plen, p))
216 // PARA_DEBUG_LOG("might be %s\n", audio_format_name(i));
223 static int get_audio_format(int omit)
227 FOR_EACH_AUDIO_FORMAT(i) {
231 if (get_file_info(i) > 0)
235 return -E_AUDIO_FORMAT;
241 static int update_mmd(void)
244 struct stat file_status;
246 i = guess_audio_format(mmd->filename);
247 if (i < 0 || get_file_info(i) < 0)
248 i = get_audio_format(i);
251 mmd->audio_format = i;
252 mmd->chunks_sent = 0;
253 mmd->current_chunk = 0;
255 if (fstat(fileno(audio_file), &file_status) == -1)
257 mmd->size = file_status.st_size;
258 mmd->mtime = file_status.st_mtime;
260 PARA_NOTICE_LOG("next audio file: %s\n", mmd->filename);
264 static void get_song(void)
266 char **sl = selectors[mmd->selector_num].get_audio_file_list(10);
271 for (i = 0; sl[i]; i++) {
273 PARA_INFO_LOG("trying %s\n", sl[i]);
274 if (strlen(sl[i]) >= _POSIX_PATH_MAX)
276 audio_file = fopen(sl[i], "r");
279 strcpy(mmd->filename, sl[i]);
280 if (update_mmd() < 0) {
286 if (selectors[mmd->selector_num].update_audio_file)
287 selectors[mmd->selector_num].update_audio_file(sl[i]);
288 PARA_DEBUG_LOG("%s", "success\n");
289 mmd->new_vss_status_flags &= (~VSS_NEXT);
290 gettimeofday(&now, NULL);
291 tv_add(&now, &announce_tv, &data_send_barrier);
295 PARA_ERROR_LOG("%s", "no valid files found\n");
297 mmd->new_vss_status_flags = VSS_NEXT;
300 for (i = 0; sl[i]; i++)
306 static int chk_barrier(const char *bname, const struct timeval *now,
307 const struct timeval *barrier, struct timeval *diff,
312 if (tv_diff(now, barrier, diff) > 0)
316 PARA_DEBUG_LOG("%s barrier: %lims left\n", bname, ms);
320 static void vss_next_chunk_time(struct timeval *due)
324 tv_scale(mmd->chunks_sent, &afl[mmd->audio_format].chunk_tv, &tmp);
325 tv_add(&tmp, &mmd->stream_start, due);
329 * != NULL: timeout for next chunk
330 * NULL: nothing to do
332 static struct timeval *vss_compute_timeout(void)
334 static struct timeval the_timeout;
335 struct timeval now, next_chunk;
337 if (vss_next() && mmd->audio_format >= 0) {
338 /* only sleep a bit, nec*/
339 the_timeout.tv_sec = 0;
340 the_timeout.tv_usec = 100;
343 gettimeofday(&now, NULL);
344 if (chk_barrier("autoplay_delay", &now, &autoplay_barrier,
345 &the_timeout, 1) < 0)
347 if (chk_barrier("eof", &now, &eof_barrier, &the_timeout, 1) < 0)
349 if (chk_barrier("data send", &now, &data_send_barrier,
350 &the_timeout, 1) < 0)
352 if (mmd->audio_format < 0 || !vss_playing() || !audio_file)
354 vss_next_chunk_time(&next_chunk);
355 if (chk_barrier(afl[mmd->audio_format].name, &now, &next_chunk,
356 &the_timeout, 0) < 0)
358 /* chunk is due or bof */
359 the_timeout.tv_sec = 0;
360 the_timeout.tv_usec = 0;
364 static void vss_eof(struct audio_format_handler *af)
370 if (!af || !audio_file) {
371 for (i = 0; senders[i].name; i++)
372 senders[i].shutdown_clients();
375 gettimeofday(&now, NULL);
376 tv_add(&af->eof_tv, &now, &eof_barrier);
377 af->close_audio_file();
379 mmd->audio_format = -1;
381 mmd->chunks_sent = 0;
383 mmd->seconds_total = 0;
384 tmp = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_AUDIO_INFO1],
385 status_item_list[SI_AUDIO_INFO2], status_item_list[SI_AUDIO_INFO3]);
386 strcpy(mmd->audio_file_info, tmp);
388 tmp = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_DBINFO1],
389 status_item_list[SI_DBINFO2], status_item_list[SI_DBINFO3]);
390 strcpy(mmd->selector_info, tmp);
392 mmd->filename[0] = '\0';
398 * get the header and of the current audio file
400 * \param header_len the length of the header is stored here
402 * \return a pointer to a buffer containing the header, or NULL, if no audio
403 * file is selected or if the current audio format does not need special header
407 char *vss_get_header(int *header_len)
410 if (mmd->audio_format < 0)
412 if (!afl[mmd->audio_format].get_header_info)
414 return afl[mmd->audio_format].get_header_info(header_len);
418 * get the list of all supported audio formats
420 * \return a space separated list of all supported audio formats
421 * It is not allocated at runtime, i.e. there is no need to free
422 * the returned string in the caller.
424 const char *supported_audio_formats(void)
426 return SUPPORTED_AUDIO_FORMATS;
430 * get the chunk time of the current audio file
432 * \return a pointer to a struct containing the chunk time, or NULL,
433 * if currently no audio file is selected.
435 struct timeval *vss_chunk_time(void)
437 if (mmd->audio_format < 0)
439 return &afl[mmd->audio_format].chunk_tv;
443 * compute the timeout for para_server's main select-loop
445 * This function gets called from para_server to determine the timeout value
446 * for its main select loop.
448 * Before the timeout is computed, the current vss status flags are evaluated
449 * and acted upon by calling appropriate functions from the lower layers.
450 * Possible actions include
452 * - request a new file list from the current audio file selector
453 * - shutdown of all senders (stop/pause command)
454 * - reposition the stream (ff/jmp command)
456 * \return A pointer to a struct timeval containing the timeout for the next
457 * chunk of data to be sent, or NULL if we're not sending right now.
459 struct timeval *vss_preselect(void)
461 struct audio_format_handler *af = NULL;
465 format = mmd->audio_format;
469 for (i = 0; senders[i].name; i++)
470 senders[i].shutdown_clients();
471 if (vss_next() && af) {
473 return vss_compute_timeout();
475 if (vss_paused() || vss_repos()) {
476 for (i = 0; senders[i].name; i++)
477 senders[i].shutdown_clients();
480 gettimeofday(&now, NULL);
481 if (!vss_paused() || mmd->chunks_sent)
482 tv_add(&af->eof_tv, &now, &eof_barrier);
484 tv_add(&now, &announce_tv, &data_send_barrier);
485 if (mmd->new_vss_status_flags & VSS_NOMORE)
486 mmd->new_vss_status_flags = VSS_NEXT;
488 mmd->chunks_sent = 0;
491 mmd->new_vss_status_flags &= ~(VSS_REPOS);
492 mmd->current_chunk = mmd->repos_request;
494 ret = vss_compute_timeout();
495 if (!ret && !audio_file && vss_playing() &&
496 !(mmd->new_vss_status_flags & VSS_NOMORE)) {
497 PARA_DEBUG_LOG("%s", "ready and playing, but no audio file\n");
505 * read a chunk of data from the current audio file
507 * \param current_chunk the chunk number to read
509 * \return The length of the chunk on success, zero on end of file, negative on
510 * errors. Note: If the current chunk is of length zero, but the end of the
511 * file is not yet reached, this function returns -E_EMPTY_CHUNK.
513 ssize_t vss_read_chunk(void)
518 long unsigned cc = mmd->current_chunk;
520 if (cc >= mmd->chunks_total) /* eof */
522 len = chunk_table[cc + 1] - chunk_table[cc];
523 if (!len) /* nothing to send for this run */
524 return -E_EMPTY_CHUNK;
525 pos = chunk_table[cc];
526 if (inbuf_size < len) {
527 PARA_INFO_LOG("increasing inbuf for chunk #%lu/%lu to %zu bytes\n",
528 cc, mmd->chunks_total, len);
529 inbuf = para_realloc(inbuf, len);
532 ret = para_fseek(audio_file, pos, SEEK_SET);
535 return para_fread(inbuf, len, 1, audio_file);
539 * main sending function
541 * This function gets called from para_server as soon as the next chunk of
542 * data should be pushed out. It first calls the read_chunk() function of
543 * the current audio format handler to obtain a pointer to the data to be
544 * sent out as well as its length. This information is then passed to each
545 * supported sender's send() function which does the actual sending.
547 * Return value: Positive return value on success, zero on eof and negative
550 void vss_send_chunk(void)
553 struct audio_format_handler *af;
555 struct timeval now, due;
557 if (mmd->audio_format < 0 || !audio_file || !vss_playing())
559 af = &afl[mmd->audio_format];
560 gettimeofday(&now, NULL);
561 vss_next_chunk_time(&due);
562 if (tv_diff(&due, &now, NULL) > 0)
564 if (chk_barrier("eof", &now, &eof_barrier, &due, 1) < 0)
566 if (chk_barrier("data send", &now, &data_send_barrier,
569 ret= vss_read_chunk();
570 mmd->new_vss_status_flags &= ~VSS_REPOS;
571 if (!ret || (ret < 0 && ret != -E_EMPTY_CHUNK)) {
573 mmd->new_vss_status_flags = VSS_NEXT;
574 PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
576 mmd->new_vss_status_flags |= VSS_NEXT;
581 * We call the send function also in case of empty chunks as they
582 * might have still some data queued which can be sent in this case.
586 if (!mmd->chunks_sent) {
588 gettimeofday(&mmd->stream_start, NULL);
589 tv_scale(mmd->current_chunk, &af->chunk_tv, &tmp);
590 mmd->offset = tv2ms(&tmp);
593 for (i = 0; senders[i].name; i++)
594 senders[i].send(mmd->current_chunk, mmd->chunks_sent, inbuf, ret);
595 mmd->new_vss_status_flags |= VSS_PLAYING;
597 mmd->current_chunk++;