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"
32 extern const char *status_item_list[];
34 static struct timeval announce_tv;
35 static struct timeval data_send_barrier;
36 static struct timeval eof_barrier;
37 static struct timeval autoplay_barrier;
39 extern struct misc_meta_data *mmd;
40 extern struct sender senders[];
45 * check if vss status flag \a P (playing) is set
47 * \return greater than zero if playing, zero otherwise.
50 unsigned int vss_playing(void)
52 return mmd->new_vss_status_flags & VSS_PLAYING;
56 * check if \a N (next) status flag is set
58 * \return greater than zero if set, zero if not.
61 unsigned int vss_next(void)
63 return mmd->new_vss_status_flags & VSS_NEXT;
67 * check if a reposition request is pending
69 * \return greater than zero if true, zero otherwise.
72 unsigned int vss_repos(void)
74 return mmd->new_vss_status_flags & VSS_REPOS;
78 * check if the vss is currently paused
80 * \return greater than zero if paused, zero otherwise.
83 unsigned int vss_paused(void)
85 return !(mmd->new_vss_status_flags & VSS_NEXT)
86 && !(mmd->new_vss_status_flags & VSS_PLAYING);
90 * initialize the virtual streaming system
92 * Call the init functions of all supported audio format handlers and
93 * initialize all supported senders.
98 char *hn = para_hostname(), *home = para_homedir();
99 long unsigned announce_time = conf.announce_time_arg > 0?
100 conf.announce_time_arg : 300,
101 autoplay_delay = conf.autoplay_delay_arg > 0?
102 conf.autoplay_delay_arg : 0;
103 ms2tv(announce_time, &announce_tv);
104 PARA_INFO_LOG("announce timeval: %lums\n", tv2ms(&announce_tv));
105 for (i = 0; senders[i].name; i++) {
106 PARA_NOTICE_LOG("initializing %s sender\n", senders[i].name);
107 senders[i].init(&senders[i]);
111 if (conf.autoplay_given) {
112 struct timeval now, tmp;
113 mmd->vss_status_flags |= VSS_PLAYING;
114 mmd->new_vss_status_flags |= VSS_PLAYING;
115 gettimeofday(&now, NULL);
116 ms2tv(autoplay_delay, &tmp);
117 tv_add(&now, &tmp, &autoplay_barrier);
121 static int chk_barrier(const char *bname, const struct timeval *now,
122 const struct timeval *barrier, struct timeval *diff,
127 if (tv_diff(now, barrier, diff) > 0)
131 PARA_DEBUG_LOG("%s barrier: %lims left\n", bname, ms);
135 static void vss_next_chunk_time(struct timeval *due)
139 tv_scale(mmd->chunks_sent, &mmd->afd.afhi.chunk_tv, &tmp);
140 tv_add(&tmp, &mmd->stream_start, due);
144 * != NULL: timeout for next chunk
145 * NULL: nothing to do
147 static struct timeval *vss_compute_timeout(void)
149 static struct timeval the_timeout;
150 struct timeval now, next_chunk;
152 if (vss_next() && map) {
153 /* only sleep a bit, nec*/
154 the_timeout.tv_sec = 0;
155 the_timeout.tv_usec = 100;
158 gettimeofday(&now, NULL);
159 if (chk_barrier("autoplay_delay", &now, &autoplay_barrier,
160 &the_timeout, 1) < 0)
162 if (chk_barrier("eof", &now, &eof_barrier, &the_timeout, 1) < 0)
164 if (chk_barrier("data send", &now, &data_send_barrier,
165 &the_timeout, 1) < 0)
167 if (!vss_playing() || !map)
169 vss_next_chunk_time(&next_chunk);
170 if (chk_barrier(audio_format_name(mmd->afd.afsi.audio_format_id),
171 &now, &next_chunk, &the_timeout, 0) < 0)
173 /* chunk is due or bof */
174 the_timeout.tv_sec = 0;
175 the_timeout.tv_usec = 0;
179 static void vss_eof(void)
186 for (i = 0; senders[i].name; i++)
187 senders[i].shutdown_clients();
190 gettimeofday(&now, NULL);
191 tv_add(&mmd->afd.afhi.eof_tv, &now, &eof_barrier);
192 munmap(map, mmd->size);
194 mmd->chunks_sent = 0;
196 mmd->afd.afhi.seconds_total = 0;
197 free(mmd->afd.afhi.chunk_table);
198 mmd->afd.afhi.chunk_table = NULL;
199 tmp = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_AUDIO_INFO1],
200 status_item_list[SI_AUDIO_INFO2], status_item_list[SI_AUDIO_INFO3]);
201 strcpy(mmd->afd.afhi.info_string, tmp);
203 mmd->afd.path[0] = '\0';
204 mmd->afd.afsi.lyrics_id = 0;
205 mmd->afd.afsi.image_id = 0;
207 mmd->afd.attributes_string[0] = '\0';
213 * Get the header of the current audio file.
215 * \param header_len the length of the header is stored here
217 * \return a pointer to a buffer containing the header, or NULL, if no audio
218 * file is selected or if the current audio format does not need special header
222 char *vss_get_header(size_t *header_len)
224 if (!map || !mmd->afd.afhi.header_len)
226 *header_len = mmd->afd.afhi.header_len;
227 return map + mmd->afd.afhi.header_offset;
231 * get the list of all supported audio formats
233 * \return a space separated list of all supported audio formats
234 * It is not allocated at runtime, i.e. there is no need to free
235 * the returned string in the caller.
237 const char *supported_audio_formats(void)
239 return SUPPORTED_AUDIO_FORMATS;
243 * get the chunk time of the current audio file
245 * \return a pointer to a struct containing the chunk time, or NULL,
246 * if currently no audio file is selected.
248 struct timeval *vss_chunk_time(void)
252 return &mmd->afd.afhi.chunk_tv;
255 enum afs_socket_status {
257 AFS_SOCKET_CHECK_FOR_WRITE,
258 AFS_SOCKET_AFD_PENDING
261 static enum afs_socket_status afsss;
264 * Compute the timeout for para_server's main select-loop.
266 * This function gets called from para_server to determine the timeout value
267 * for its main select loop.
269 * Before the timeout is computed, the current vss status flags are evaluated
270 * and acted upon by calling appropriate functions from the lower layers.
271 * Possible actions include
273 * - request a new audio file from afs,
274 * - shutdown of all senders (stop/pause command),
275 * - reposition the stream (ff/jmp command).
277 * \return A pointer to a struct timeval containing the timeout for the next
278 * chunk of data to be sent, or NULL if we're not sending right now.
280 struct timeval *vss_preselect(fd_set *rfds, fd_set *wfds, int *max_fileno)
285 para_fd_set(afs_socket, rfds, max_fileno);
287 for (i = 0; senders[i].name; i++)
288 senders[i].shutdown_clients();
292 return vss_compute_timeout();
295 if (vss_paused() || vss_repos()) {
296 for (i = 0; senders[i].name; i++)
297 senders[i].shutdown_clients();
300 gettimeofday(&now, NULL);
301 if (!vss_paused() || mmd->chunks_sent)
302 tv_add(&mmd->afd.afhi.eof_tv, &now, &eof_barrier);
304 tv_add(&now, &announce_tv, &data_send_barrier);
305 if (mmd->new_vss_status_flags & VSS_NOMORE)
306 mmd->new_vss_status_flags = VSS_NEXT;
308 mmd->chunks_sent = 0;
311 mmd->new_vss_status_flags &= ~(VSS_REPOS);
312 mmd->current_chunk = mmd->repos_request;
314 tv = vss_compute_timeout();
317 if (!map && vss_playing() &&
318 !(mmd->new_vss_status_flags & VSS_NOMORE)) {
319 PARA_DEBUG_LOG("ready and playing, but no audio file\n");
320 if (afsss == AFS_SOCKET_READY) {
321 para_fd_set(afs_socket, wfds, max_fileno);
322 afsss = AFS_SOCKET_CHECK_FOR_WRITE;
328 static int recv_afs_msg(int *fd, uint32_t *code, uint32_t *data)
330 char control[255], buf[8];
331 struct msghdr msg = {.msg_iov = NULL};
332 struct cmsghdr *cmsg;
337 iov.iov_len = sizeof(buf);
340 msg.msg_control = control;
341 msg.msg_controllen = sizeof(control);
342 memset(buf, 0, sizeof(buf));
343 ret = recvmsg(afs_socket, &msg, 0);
345 return -ERRNO_TO_PARA_ERROR(errno);
346 if (iov.iov_len != sizeof(buf))
347 return -E_SHORT_AFS_READ;
348 *code = *(uint32_t*)buf;
349 *data = *(uint32_t*)(buf + 4);
350 cmsg = CMSG_FIRSTHDR(&msg);
351 for (cmsg = CMSG_FIRSTHDR(&msg); cmsg; cmsg = CMSG_NXTHDR(&msg, cmsg)) {
352 if (cmsg->cmsg_level != SOL_SOCKET
353 || cmsg->cmsg_type != SCM_RIGHTS)
355 if ((cmsg->cmsg_len - CMSG_LEN(0)) / sizeof(int) != 1)
357 *fd = *(int *)CMSG_DATA(cmsg);
362 static void recv_afs_result(void)
364 int ret, passed_fd = -1, shmid;
365 uint32_t afs_code = 0, afs_data = 0;
369 ret = recv_afs_msg(&passed_fd, &afs_code, &afs_data);
372 PARA_DEBUG_LOG("got the fd: %d, code: %u, shmid: %u\n",
373 passed_fd, afs_code, afs_data);
374 ret = -E_BAD_AFS_CODE;
375 if (afs_code != NEXT_AUDIO_FILE)
377 afsss = AFS_SOCKET_READY;
379 ret = load_afd(shmid, &mmd->afd);
383 PARA_NOTICE_LOG("next audio file: %s (%lu chunks)\n", mmd->afd.path,
384 mmd->afd.afhi.chunks_total);
385 ret = fstat(passed_fd, &statbuf);
387 PARA_ERROR_LOG("fstat error:\n");
388 ret = -ERRNO_TO_PARA_ERROR(errno);
391 mmd->size = statbuf.st_size;
392 mmd->mtime = statbuf.st_mtime;
393 map = para_mmap(mmd->size, PROT_READ, MAP_PRIVATE,
396 mmd->afd.afhi.header_len = 0; /* default: no header */
397 mmd->chunks_sent = 0;
398 mmd->current_chunk = 0;
402 mmd->new_vss_status_flags &= (~VSS_NEXT);
403 gettimeofday(&now, NULL);
404 tv_add(&now, &announce_tv, &data_send_barrier);
409 PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
412 void vss_post_select(fd_set *rfds, fd_set *wfds)
416 if (FD_ISSET(afs_socket, rfds))
418 if (afsss != AFS_SOCKET_CHECK_FOR_WRITE || !FD_ISSET(afs_socket, wfds))
420 PARA_NOTICE_LOG("requesting new fd from afs\n");
421 ret = send_buffer(afs_socket, "new");
422 afsss = AFS_SOCKET_AFD_PENDING;
425 static void get_chunk(long unsigned chunk_num, char **buf, size_t *len)
427 size_t pos = mmd->afd.afhi.chunk_table[chunk_num];
429 *len = mmd->afd.afhi.chunk_table[chunk_num + 1] - pos;
433 * Get the data of the given chunk.
435 * \param chunk_num The number of the desired chunk.
436 * \param buf Chunk data.
437 * \param len Chunk length in bytes.
439 * \return Positive on success, negative on errors.
441 int vss_get_chunk(long unsigned chunk_num, char **buf, size_t *len)
443 if (!map || !vss_playing())
445 if (chunk_num >= mmd->afd.afhi.chunks_total)
447 get_chunk(chunk_num, buf, len);
452 * main sending function
454 * This function gets called from para_server as soon as the next chunk of
455 * data should be pushed out. It first calls the read_chunk() function of
456 * the current audio format handler to obtain a pointer to the data to be
457 * sent out as well as its length. This information is then passed to each
458 * supported sender's send() function which does the actual sending.
460 void vss_send_chunk(void)
463 struct timeval now, due;
467 if (!map || !vss_playing())
469 gettimeofday(&now, NULL);
470 vss_next_chunk_time(&due);
471 if (tv_diff(&due, &now, NULL) > 0)
473 if (chk_barrier("eof", &now, &eof_barrier, &due, 1) < 0)
475 if (chk_barrier("data send", &now, &data_send_barrier,
478 mmd->new_vss_status_flags &= ~VSS_REPOS;
479 if (mmd->current_chunk >= mmd->afd.afhi.chunks_total) { /* eof */
480 mmd->new_vss_status_flags |= VSS_NEXT;
484 * We call the send function also in case of empty chunks as they
485 * might have still some data queued which can be sent in this case.
487 if (!mmd->chunks_sent) {
489 gettimeofday(&mmd->stream_start, NULL);
490 tv_scale(mmd->current_chunk, &mmd->afd.afhi.chunk_tv, &tmp);
491 mmd->offset = tv2ms(&tmp);
494 get_chunk(mmd->current_chunk, &buf, &len);
495 for (i = 0; senders[i].name; i++)
496 senders[i].send(mmd->current_chunk, mmd->chunks_sent, buf, len);
497 mmd->new_vss_status_flags |= VSS_PLAYING;
499 mmd->current_chunk++;