2 * Copyright (C) 1997-2008 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"
33 static struct timeval announce_tv
;
34 static struct timeval data_send_barrier
;
35 static struct timeval eof_barrier
;
36 static struct timeval autoplay_barrier
;
38 extern struct misc_meta_data
*mmd
;
39 extern struct sender senders
[];
44 * Check if vss status flag \a P (playing) is set.
46 * \return Greater than zero if playing, zero otherwise.
49 unsigned int vss_playing(void)
51 return mmd
->new_vss_status_flags
& VSS_PLAYING
;
55 * Check if the \a N (next) status flag is set.
57 * \return Greater than zero if set, zero if not.
60 unsigned int vss_next(void)
62 return mmd
->new_vss_status_flags
& VSS_NEXT
;
66 * Check if a reposition request is pending.
68 * \return Greater than zero if true, zero otherwise.
71 unsigned int vss_repos(void)
73 return mmd
->new_vss_status_flags
& VSS_REPOS
;
77 * Check if the vss is currently paused.
79 * \return Greater than zero if paused, zero otherwise.
82 unsigned int vss_paused(void)
84 return !(mmd
->new_vss_status_flags
& VSS_NEXT
)
85 && !(mmd
->new_vss_status_flags
& VSS_PLAYING
);
89 * Check if the vss is currently stopped.
91 * \return Greater than zero if paused, zero otherwise.
94 unsigned int vss_stopped(void)
96 return (mmd
->new_vss_status_flags
& VSS_NEXT
)
97 && !(mmd
->new_vss_status_flags
& VSS_PLAYING
);
101 * Initialize the virtual streaming system.
103 * This also initializes all supported senders and starts streaming
104 * if the --autoplay command line flag was given.
109 char *hn
= para_hostname(), *home
= para_homedir();
110 long unsigned announce_time
= conf
.announce_time_arg
> 0?
111 conf
.announce_time_arg
: 300,
112 autoplay_delay
= conf
.autoplay_delay_arg
> 0?
113 conf
.autoplay_delay_arg
: 0;
114 ms2tv(announce_time
, &announce_tv
);
115 PARA_INFO_LOG("announce timeval: %lums\n", tv2ms(&announce_tv
));
116 for (i
= 0; senders
[i
].name
; i
++) {
117 PARA_NOTICE_LOG("initializing %s sender\n", senders
[i
].name
);
118 senders
[i
].init(&senders
[i
]);
122 if (conf
.autoplay_given
) {
123 struct timeval now
, tmp
;
124 mmd
->vss_status_flags
|= VSS_PLAYING
;
125 mmd
->new_vss_status_flags
|= VSS_PLAYING
;
126 gettimeofday(&now
, NULL
);
127 ms2tv(autoplay_delay
, &tmp
);
128 tv_add(&now
, &tmp
, &autoplay_barrier
);
132 static int chk_barrier(const char *bname
, const struct timeval
*now
,
133 const struct timeval
*barrier
, struct timeval
*diff
,
138 if (tv_diff(now
, barrier
, diff
) > 0)
142 PARA_DEBUG_LOG("%s barrier: %lims left\n", bname
, ms
);
146 static void vss_next_chunk_time(struct timeval
*due
)
150 tv_scale(mmd
->chunks_sent
, &mmd
->afd
.afhi
.chunk_tv
, &tmp
);
151 tv_add(&tmp
, &mmd
->stream_start
, due
);
155 * != NULL: timeout for next chunk
156 * NULL: nothing to do
158 static struct timeval
*vss_compute_timeout(void)
160 static struct timeval the_timeout
;
161 struct timeval now
, next_chunk
;
163 if (vss_next() && map
) {
164 /* only sleep a bit, nec*/
165 the_timeout
.tv_sec
= 0;
166 the_timeout
.tv_usec
= 100;
169 gettimeofday(&now
, NULL
);
170 if (chk_barrier("autoplay_delay", &now
, &autoplay_barrier
,
171 &the_timeout
, 1) < 0)
173 if (chk_barrier("eof", &now
, &eof_barrier
, &the_timeout
, 1) < 0)
175 if (chk_barrier("data send", &now
, &data_send_barrier
,
176 &the_timeout
, 1) < 0)
178 if (!vss_playing() || !map
)
180 vss_next_chunk_time(&next_chunk
);
181 if (chk_barrier("chunk", &now
, &next_chunk
, &the_timeout
, 0) < 0)
183 /* chunk is due or bof */
184 the_timeout
.tv_sec
= 0;
185 the_timeout
.tv_usec
= 0;
189 static void vss_eof(void)
196 for (i
= 0; senders
[i
].name
; i
++)
197 senders
[i
].shutdown_clients();
200 if (mmd
->new_vss_status_flags
& VSS_NOMORE
)
201 mmd
->new_vss_status_flags
= VSS_NEXT
;
202 gettimeofday(&now
, NULL
);
203 tv_add(&mmd
->afd
.afhi
.eof_tv
, &now
, &eof_barrier
);
204 munmap(map
, mmd
->size
);
206 mmd
->chunks_sent
= 0;
208 mmd
->afd
.afhi
.seconds_total
= 0;
209 free(mmd
->afd
.afhi
.chunk_table
);
210 mmd
->afd
.afhi
.chunk_table
= NULL
;
211 tmp
= make_message("%s:\n%s:\n%s:\n", status_item_list
[SI_AUDIO_FILE_INFO
],
212 status_item_list
[SI_TAGINFO1
], status_item_list
[SI_TAGINFO2
]);
213 strncpy(mmd
->afd
.afhi
.info_string
, tmp
, sizeof(mmd
->afd
.afhi
.info_string
));
214 mmd
->afd
.afhi
.info_string
[sizeof(mmd
->afd
.afhi
.info_string
) - 1] = '\0';
215 make_empty_status_items(mmd
->afd
.verbose_ls_output
);
223 * Get the header of the current audio file.
225 * \param header_len The length of the header is stored here.
227 * \return A pointer to a buffer containing the header, or NULL, if no audio
228 * file is selected or if the current audio format does not need special header
232 char *vss_get_header(size_t *header_len
)
234 if (!map
|| !mmd
->afd
.afhi
.header_len
)
236 *header_len
= mmd
->afd
.afhi
.header_len
;
237 return map
+ mmd
->afd
.afhi
.header_offset
;
241 * Get the list of all supported audio formats.
243 * \return Aa space separated list of all supported audio formats
244 * It is not allocated at runtime, i.e. there is no need to free
245 * the returned string in the caller.
247 const char *supported_audio_formats(void)
249 return SUPPORTED_AUDIO_FORMATS
;
253 * Get the chunk time of the current audio file.
255 * \return A pointer to a struct containing the chunk time, or NULL,
256 * if currently no audio file is selected.
258 struct timeval
*vss_chunk_time(void)
262 return &mmd
->afd
.afhi
.chunk_tv
;
265 /** The possible states of the afs socket. See \ref afs_socket. */
266 enum afs_socket_status
{
267 /** Socket is inactive. */
269 /** Socket fd was included in the write fd set for select(). */
270 AFS_SOCKET_CHECK_FOR_WRITE
,
271 /** vss wrote a request to the socket and waits for afs to reply. */
272 AFS_SOCKET_AFD_PENDING
275 static enum afs_socket_status afsss
;
278 * Compute the timeout for para_server's main select-loop.
280 * This function gets called from para_server to determine the timeout value
281 * for its main select loop.
283 * \param rfds The set of file descriptors to be checked for reading.
284 * \param wfds The set of file descriptors to be checked for writing.
285 * \param max_fileno The highest-numbered file descriptor.
287 * Before the timeout is computed, the current vss status flags are evaluated
288 * and acted upon by calling appropriate functions from the lower layers.
289 * Possible actions include
291 * - request a new audio file from afs,
292 * - shutdown of all senders (stop/pause command),
293 * - reposition the stream (ff/jmp command).
295 * \return A pointer to a struct timeval containing the timeout for the next
296 * chunk of data to be sent, or NULL if we're not sending right now.
298 struct timeval
*vss_preselect(fd_set
*rfds
, fd_set
*wfds
, int *max_fileno
)
303 para_fd_set(afs_socket
, rfds
, max_fileno
);
305 for (i
= 0; senders
[i
].name
; i
++)
306 senders
[i
].shutdown_clients();
310 return vss_compute_timeout();
313 if (vss_paused() || vss_repos()) {
314 for (i
= 0; senders
[i
].name
; i
++)
315 senders
[i
].shutdown_clients();
318 gettimeofday(&now
, NULL
);
319 if (!vss_paused() || mmd
->chunks_sent
)
320 tv_add(&mmd
->afd
.afhi
.eof_tv
, &now
, &eof_barrier
);
322 tv_add(&now
, &announce_tv
, &data_send_barrier
);
324 mmd
->chunks_sent
= 0;
327 mmd
->new_vss_status_flags
&= ~(VSS_REPOS
);
328 mmd
->current_chunk
= mmd
->repos_request
;
330 tv
= vss_compute_timeout();
333 if (!map
&& vss_playing() &&
334 !(mmd
->new_vss_status_flags
& VSS_NOMORE
)) {
335 if (afsss
== AFS_SOCKET_READY
||
336 afsss
== AFS_SOCKET_CHECK_FOR_WRITE
) {
337 PARA_DEBUG_LOG("ready and playing, but no audio file\n");
338 para_fd_set(afs_socket
, wfds
, max_fileno
);
339 afsss
= AFS_SOCKET_CHECK_FOR_WRITE
;
345 static int recv_afs_msg(int *fd
, uint32_t *code
, uint32_t *data
)
347 char control
[255], buf
[8];
348 struct msghdr msg
= {.msg_iov
= NULL
};
349 struct cmsghdr
*cmsg
;
355 iov
.iov_len
= sizeof(buf
);
358 msg
.msg_control
= control
;
359 msg
.msg_controllen
= sizeof(control
);
360 memset(buf
, 0, sizeof(buf
));
361 ret
= recvmsg(afs_socket
, &msg
, 0);
363 return -ERRNO_TO_PARA_ERROR(errno
);
364 afsss
= AFS_SOCKET_READY
;
365 if (iov
.iov_len
!= sizeof(buf
))
366 return -E_SHORT_AFS_READ
;
367 *code
= *(uint32_t*)buf
;
368 *data
= *(uint32_t*)(buf
+ 4);
369 for (cmsg
= CMSG_FIRSTHDR(&msg
); cmsg
; cmsg
= CMSG_NXTHDR(&msg
, cmsg
)) {
370 if (cmsg
->cmsg_level
!= SOL_SOCKET
371 || cmsg
->cmsg_type
!= SCM_RIGHTS
)
373 if ((cmsg
->cmsg_len
- CMSG_LEN(0)) / sizeof(int) != 1)
375 *fd
= *(int *)CMSG_DATA(cmsg
);
380 static void recv_afs_result(void)
382 int ret
, passed_fd
, shmid
;
383 uint32_t afs_code
= 0, afs_data
= 0;
387 mmd
->afd
.afhi
.chunk_table
= NULL
;
388 ret
= recv_afs_msg(&passed_fd
, &afs_code
, &afs_data
);
391 PARA_DEBUG_LOG("fd: %d, code: %u, shmid: %u\n", passed_fd
, afs_code
,
394 if (afs_code
!= NEXT_AUDIO_FILE
)
399 ret
= load_afd(shmid
, &mmd
->afd
);
403 ret
= fstat(passed_fd
, &statbuf
);
405 PARA_ERROR_LOG("fstat error:\n");
406 ret
= -ERRNO_TO_PARA_ERROR(errno
);
409 mmd
->size
= statbuf
.st_size
;
410 mmd
->mtime
= statbuf
.st_mtime
;
411 map
= para_mmap(mmd
->size
, PROT_READ
, MAP_PRIVATE
,
414 mmd
->chunks_sent
= 0;
415 mmd
->current_chunk
= 0;
419 mmd
->new_vss_status_flags
&= (~VSS_NEXT
);
420 gettimeofday(&now
, NULL
);
421 tv_add(&now
, &announce_tv
, &data_send_barrier
);
424 free(mmd
->afd
.afhi
.chunk_table
);
427 PARA_ERROR_LOG("%s\n", para_strerror(-ret
));
428 mmd
->new_vss_status_flags
= VSS_NEXT
;
431 void vss_post_select(fd_set
*rfds
, fd_set
*wfds
)
435 if (FD_ISSET(afs_socket
, rfds
))
437 if (afsss
!= AFS_SOCKET_CHECK_FOR_WRITE
|| !FD_ISSET(afs_socket
, wfds
))
439 PARA_NOTICE_LOG("requesting new fd from afs\n");
440 ret
= send_buffer(afs_socket
, "new");
441 afsss
= AFS_SOCKET_AFD_PENDING
;
444 static void get_chunk(long unsigned chunk_num
, char **buf
, size_t *len
)
446 size_t pos
= mmd
->afd
.afhi
.chunk_table
[chunk_num
];
448 *len
= mmd
->afd
.afhi
.chunk_table
[chunk_num
+ 1] - pos
;
452 * Get the data of the given chunk.
454 * \param chunk_num The number of the desired chunk.
455 * \param buf Chunk data.
456 * \param len Chunk length in bytes.
460 int vss_get_chunk(long unsigned chunk_num
, char **buf
, size_t *len
)
462 if (!map
|| !vss_playing())
464 if (chunk_num
>= mmd
->afd
.afhi
.chunks_total
)
466 get_chunk(chunk_num
, buf
, len
);
471 * Main sending function.
473 * This function gets called from para_server as soon as the next chunk of data
474 * should be pushed out. It obtains a pointer to the data to be sent out as
475 * well as its length from mmd->afd.afhi. This information is then passed to
476 * each supported sender's send() function which is supposed to send out the data
477 * to all connected clients.
479 void vss_send_chunk(void)
482 struct timeval now
, due
;
486 if (!map
|| !vss_playing())
488 gettimeofday(&now
, NULL
);
489 vss_next_chunk_time(&due
);
490 if (tv_diff(&due
, &now
, NULL
) > 0)
492 if (chk_barrier("eof", &now
, &eof_barrier
, &due
, 1) < 0)
494 if (chk_barrier("data send", &now
, &data_send_barrier
,
497 mmd
->new_vss_status_flags
&= ~VSS_REPOS
;
498 if (mmd
->current_chunk
>= mmd
->afd
.afhi
.chunks_total
) { /* eof */
499 mmd
->new_vss_status_flags
|= VSS_NEXT
;
503 * We call the send function also in case of empty chunks as they
504 * might have still some data queued which can be sent in this case.
506 if (!mmd
->chunks_sent
) {
508 gettimeofday(&mmd
->stream_start
, NULL
);
509 tv_scale(mmd
->current_chunk
, &mmd
->afd
.afhi
.chunk_tv
, &tmp
);
510 mmd
->offset
= tv2ms(&tmp
);
513 get_chunk(mmd
->current_chunk
, &buf
, &len
);
514 for (i
= 0; senders
[i
].name
; i
++)
515 senders
[i
].send(mmd
->current_chunk
, mmd
->chunks_sent
, buf
, len
);
516 mmd
->new_vss_status_flags
|= VSS_PLAYING
;
518 mmd
->current_chunk
++;