user_list.c: Minor documentation impreovements.
[paraslash.git] / vss.c
diff --git a/vss.c b/vss.c
index 5dce4ca..d74cec3 100644 (file)
--- a/vss.c
+++ b/vss.c
@@ -1,10 +1,10 @@
 /*
- * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file vss.c the virtual streaming system
+/** \file vss.c The virtual streaming system.
  *
  * This contains the audio streaming code of para_server which is independent
  * of the current audio format, audio file selector and of the activated
 #include "net.h"
 #include "server.cmdline.h"
 #include "vss.h"
+#include "list.h"
 #include "send.h"
 #include "ipc.h"
 #include "fd.h"
 
-extern const char *status_item_list[];
-
 static struct timeval announce_tv;
 static struct timeval data_send_barrier;
 static struct timeval eof_barrier;
@@ -42,9 +41,9 @@ extern struct sender senders[];
 static char *map;
 
 /**
- * check if vss status flag \a P (playing) is set
+ * Check if vss status flag \a P (playing) is set.
  *
- * \return greater than zero if playing, zero otherwise.
+ * \return Greater than zero if playing, zero otherwise.
  *
  */
 unsigned int vss_playing(void)
@@ -53,9 +52,9 @@ unsigned int vss_playing(void)
 }
 
 /**
- * check if \a N (next) status flag is set
+ * Check if the \a N (next) status flag is set.
  *
- * \return greater than zero if set, zero if not.
+ * \return Greater than zero if set, zero if not.
  *
  */
 unsigned int vss_next(void)
@@ -64,9 +63,9 @@ unsigned int vss_next(void)
 }
 
 /**
- * check if a reposition request is pending
+ * Check if a reposition request is pending.
  *
- * \return greater than zero if true, zero otherwise.
+ * \return Greater than zero if true, zero otherwise.
  *
  */
 unsigned int vss_repos(void)
@@ -75,9 +74,9 @@ unsigned int vss_repos(void)
 }
 
 /**
- * check if the vss is currently paused
+ * Check if the vss is currently paused.
  *
- * \return greater than zero if paused, zero otherwise.
+ * \return Greater than zero if paused, zero otherwise.
  *
  */
 unsigned int vss_paused(void)
@@ -87,10 +86,22 @@ unsigned int vss_paused(void)
 }
 
 /**
- * initialize the virtual streaming system
+ * Check if the vss is currently stopped.
+ *
+ * \return Greater than zero if paused, zero otherwise.
  *
- * Call the init functions of all supported audio format handlers and
- * initialize all supported senders.
+ */
+unsigned int vss_stopped(void)
+{
+       return (mmd->new_vss_status_flags & VSS_NEXT)
+               && !(mmd->new_vss_status_flags & VSS_PLAYING);
+}
+
+/**
+ * Initialize the virtual streaming system.
+ *
+ * This also initializes all supported senders and starts streaming
+ * if the --autoplay command line flag was given.
  */
 void vss_init(void)
 {
@@ -167,8 +178,7 @@ static struct timeval *vss_compute_timeout(void)
        if (!vss_playing() || !map)
                return NULL;
        vss_next_chunk_time(&next_chunk);
-       if (chk_barrier(audio_format_name(mmd->afd.afsi.audio_format_id),
-                       &now, &next_chunk, &the_timeout, 0) < 0)
+       if (chk_barrier("chunk", &now, &next_chunk, &the_timeout, 0) < 0)
                return &the_timeout;
        /* chunk is due or bof */
        the_timeout.tv_sec = 0;
@@ -187,6 +197,8 @@ static void vss_eof(void)
                        senders[i].shutdown_clients();
                return;
        }
+       if (mmd->new_vss_status_flags & VSS_NOMORE)
+               mmd->new_vss_status_flags = VSS_NEXT;
        gettimeofday(&now, NULL);
        tv_add(&mmd->afd.afhi.eof_tv, &now, &eof_barrier);
        munmap(map, mmd->size);
@@ -196,15 +208,13 @@ static void vss_eof(void)
        mmd->afd.afhi.seconds_total = 0;
        free(mmd->afd.afhi.chunk_table);
        mmd->afd.afhi.chunk_table = NULL;
-       tmp  = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_AUDIO_INFO1],
-               status_item_list[SI_AUDIO_INFO2], status_item_list[SI_AUDIO_INFO3]);
-       strcpy(mmd->afd.afhi.info_string, tmp);
+       tmp  = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_AUDIO_FILE_INFO],
+               status_item_list[SI_TAGINFO1], status_item_list[SI_TAGINFO2]);
+       strncpy(mmd->afd.afhi.info_string, tmp, sizeof(mmd->afd.afhi.info_string));
+       mmd->afd.afhi.info_string[sizeof(mmd->afd.afhi.info_string) - 1] = '\0';
+       make_empty_status_items(mmd->afd.verbose_ls_output);
        free(tmp);
-       mmd->afd.path[0] = '\0';
-       mmd->afd.afsi.lyrics_id = 0;
-       mmd->afd.afsi.image_id = 0;
        mmd->mtime = 0;
-       mmd->afd.attributes_string[0] = '\0';
        mmd->size = 0;
        mmd->events++;
 }
@@ -212,9 +222,9 @@ static void vss_eof(void)
 /**
  * Get the header of the current audio file.
  *
- * \param header_len the length of the header is stored here
+ * \param header_len The length of the header is stored here.
  *
- * \return a pointer to a buffer containing the header, or NULL, if no audio
+ * \return A pointer to a buffer containing the header, or NULL, if no audio
  * file is selected or if the current audio format does not need special header
  * treamtment.
  *
@@ -228,9 +238,9 @@ char *vss_get_header(size_t *header_len)
 }
 
 /**
- * get the list of all supported audio formats
+ * Get the list of all supported audio formats.
  *
- * \return a space separated list of all supported audio formats
+ * \return Aa space separated list of all supported audio formats
  * It is not allocated at runtime, i.e. there is no need to free
  * the returned string in the caller.
  */
@@ -240,9 +250,9 @@ const char *supported_audio_formats(void)
 }
 
 /**
- * get the chunk time of the current audio file
+ * Get the chunk time of the current audio file.
  *
- * \return a pointer to a struct containing the chunk time, or NULL,
+ * \return A pointer to a struct containing the chunk time, or NULL,
  * if currently no audio file is selected.
  */
 struct timeval *vss_chunk_time(void)
@@ -252,9 +262,13 @@ struct timeval *vss_chunk_time(void)
        return &mmd->afd.afhi.chunk_tv;
 }
 
+/** The possible states of the afs socket. See \ref afs_socket. */
 enum afs_socket_status {
+       /** Socket is inactive. */
        AFS_SOCKET_READY,
+       /** Socket fd was included in the write fd set for select(). */
        AFS_SOCKET_CHECK_FOR_WRITE,
+       /** vss wrote a request to the socket and waits for afs to reply. */
        AFS_SOCKET_AFD_PENDING
 };
 
@@ -266,6 +280,10 @@ static enum afs_socket_status afsss;
  * This function gets called from para_server to determine the timeout value
  * for its main select loop.
  *
+ * \param rfds The set of file descriptors to be checked for reading.
+ * \param wfds The set of file descriptors to be checked for writing.
+ * \param max_fileno The highest-numbered file descriptor.
+ *
  * Before the timeout is computed, the current vss status flags are evaluated
  * and acted upon by calling appropriate functions from the lower layers.
  * Possible actions include
@@ -302,8 +320,6 @@ struct timeval *vss_preselect(fd_set *rfds, fd_set *wfds, int *max_fileno)
                                tv_add(&mmd->afd.afhi.eof_tv, &now, &eof_barrier);
                        if (vss_repos())
                                tv_add(&now, &announce_tv, &data_send_barrier);
-                       if (mmd->new_vss_status_flags & VSS_NOMORE)
-                               mmd->new_vss_status_flags = VSS_NEXT;
                }
                mmd->chunks_sent = 0;
        }
@@ -316,7 +332,8 @@ struct timeval *vss_preselect(fd_set *rfds, fd_set *wfds, int *max_fileno)
                return tv;
        if (!map && vss_playing() &&
                        !(mmd->new_vss_status_flags & VSS_NOMORE)) {
-               if (afsss == AFS_SOCKET_READY) {
+               if (afsss == AFS_SOCKET_READY ||
+                               afsss == AFS_SOCKET_CHECK_FOR_WRITE) {
                        PARA_DEBUG_LOG("ready and playing, but no audio file\n");
                        para_fd_set(afs_socket, wfds, max_fileno);
                        afsss = AFS_SOCKET_CHECK_FOR_WRITE;
@@ -333,6 +350,7 @@ static int recv_afs_msg(int *fd, uint32_t *code, uint32_t *data)
        struct iovec iov;
        int ret = 0;
 
+       *fd = -1;
        iov.iov_base = buf;
        iov.iov_len = sizeof(buf);
        msg.msg_iov = &iov;
@@ -343,11 +361,11 @@ static int recv_afs_msg(int *fd, uint32_t *code, uint32_t *data)
        ret = recvmsg(afs_socket, &msg, 0);
        if (ret < 0)
                return -ERRNO_TO_PARA_ERROR(errno);
+       afsss = AFS_SOCKET_READY;
        if (iov.iov_len != sizeof(buf))
                return -E_SHORT_AFS_READ;
        *code = *(uint32_t*)buf;
        *data =  *(uint32_t*)(buf + 4);
-       cmsg = CMSG_FIRSTHDR(&msg);
        for (cmsg = CMSG_FIRSTHDR(&msg); cmsg; cmsg = CMSG_NXTHDR(&msg, cmsg)) {
                if (cmsg->cmsg_level != SOL_SOCKET
                        || cmsg->cmsg_type != SCM_RIGHTS)
@@ -361,27 +379,27 @@ static int recv_afs_msg(int *fd, uint32_t *code, uint32_t *data)
 
 static void recv_afs_result(void)
 {
-       int ret, passed_fd = -1, shmid;
+       int ret, passed_fd, shmid;
        uint32_t afs_code = 0, afs_data = 0;
        struct stat statbuf;
        struct timeval now;
 
+       mmd->afd.afhi.chunk_table = NULL;
        ret = recv_afs_msg(&passed_fd, &afs_code, &afs_data);
        if (ret < 0)
                goto err;
-       PARA_DEBUG_LOG("got the fd: %d, code: %u, shmid: %u\n",
-               passed_fd, afs_code, afs_data);
-       ret = -E_BAD_AFS_CODE;
+       PARA_DEBUG_LOG("fd: %d, code: %u, shmid: %u\n", passed_fd, afs_code,
+               afs_data);
+       ret = -E_NOFD;
        if (afs_code != NEXT_AUDIO_FILE)
                goto err;
-       afsss = AFS_SOCKET_READY;
+       if (passed_fd < 0)
+               goto err;
        shmid = afs_data;
        ret = load_afd(shmid, &mmd->afd);
        if (ret < 0)
                goto err;
        shm_destroy(shmid);
-       PARA_NOTICE_LOG("next audio file: %s (%lu chunks)\n", mmd->afd.path,
-               mmd->afd.afhi.chunks_total);
        ret = fstat(passed_fd, &statbuf);
        if (ret < 0) {
                PARA_ERROR_LOG("fstat error:\n");
@@ -393,7 +411,6 @@ static void recv_afs_result(void)
        map = para_mmap(mmd->size, PROT_READ, MAP_PRIVATE,
                passed_fd, 0);
        close(passed_fd);
-       mmd->afd.afhi.header_len = 0; /* default: no header */
        mmd->chunks_sent = 0;
        mmd->current_chunk = 0;
        mmd->offset = 0;
@@ -404,9 +421,11 @@ static void recv_afs_result(void)
        tv_add(&now, &announce_tv, &data_send_barrier);
        return;
 err:
+       free(mmd->afd.afhi.chunk_table);
        if (passed_fd >= 0)
                close(passed_fd);
-       PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
+       PARA_ERROR_LOG("%s\n", para_strerror(-ret));
+       mmd->new_vss_status_flags = VSS_NEXT;
 }
 
 void vss_post_select(fd_set *rfds, fd_set *wfds)
@@ -436,7 +455,7 @@ static void get_chunk(long unsigned chunk_num, char **buf, size_t *len)
  * \param buf Chunk data.
  * \param len Chunk length in bytes.
  *
- * \return Positive on success, negative on errors.
+ * \return Standard.
  */
 int vss_get_chunk(long unsigned chunk_num, char **buf, size_t *len)
 {
@@ -449,13 +468,13 @@ int vss_get_chunk(long unsigned chunk_num, char **buf, size_t *len)
 }
 
 /**
- * main sending function
+ * Main sending function.
  *
- * This function gets called from para_server as soon as the next chunk of
- * data should be pushed out. It first calls the read_chunk() function of
- * the current audio format handler to obtain a pointer to the data to be
- * sent out as well as its length. This information is then passed to each
- * supported sender's send() function which does the actual sending.
+ * This function gets called from para_server as soon as the next chunk of data
+ * should be pushed out. It obtains a pointer to the data to be sent out as
+ * well as its length from mmd->afd.afhi. This information is then passed to
+ * each supported sender's send() function which is supposed to send out the data
+ * to all connected clients.
  */
 void vss_send_chunk(void)
 {
@@ -482,8 +501,8 @@ void vss_send_chunk(void)
        }
        /*
         * We call the send function also in case of empty chunks as they
-        * might have still some data queued which can be sent in this case.
-        */
+        * might have still some data queued which can be sent in this case.
+        */
        if (!mmd->chunks_sent) {
                struct timeval tmp;
                gettimeofday(&mmd->stream_start, NULL);