Always write image_name and lyrics_name status output.
[paraslash.git] / vss.c
diff --git a/vss.c b/vss.c
index 826191bc100d5fb36bb9d0ed3482ff2dce36b21d..1ec0b5db8604415af3b90ad8cc93bbc892727173 100644 (file)
--- a/vss.c
+++ b/vss.c
@@ -4,7 +4,7 @@
  * 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
@@ -42,9 +42,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 +53,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 +64,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 +75,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 +87,10 @@ unsigned int vss_paused(void)
 }
 
 /**
- * initialize the virtual streaming system
+ * Initialize the virtual streaming system.
  *
- * Call the init functions of all supported audio format handlers and
- * initialize all supported senders.
+ * This also initializes all supported senders and starts streaming
+ * if the --autoplay command line flag was given.
  */
 void vss_init(void)
 {
@@ -182,7 +182,6 @@ static void vss_eof(void)
        int i;
        char *tmp;
 
-       PARA_NOTICE_LOG("EOF\n");
        if (!map) {
                for (i = 0; senders[i].name; i++)
                        senders[i].shutdown_clients();
@@ -199,13 +198,13 @@ static void vss_eof(void)
        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);
+       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';
        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++;
 }
@@ -213,9 +212,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.
  *
@@ -229,9 +228,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.
  */
@@ -241,9 +240,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)
@@ -267,6 +266,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
@@ -317,8 +320,9 @@ 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)) {
-               PARA_DEBUG_LOG("%s", "ready and playing, but no audio file\n");
-               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;
                }
@@ -348,7 +352,6 @@ static int recv_afs_msg(int *fd, uint32_t *code, uint32_t *data)
                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)
@@ -367,11 +370,10 @@ static void recv_afs_result(void)
        struct stat statbuf;
        struct timeval now;
 
-       PARA_NOTICE_LOG("recv\n");
        ret = recv_afs_msg(&passed_fd, &afs_code, &afs_data);
        if (ret < 0)
                goto err;
-       PARA_NOTICE_LOG("got the fd: %d, code: %u, shmid: %u\n",
+       PARA_DEBUG_LOG("got the fd: %d, code: %u, shmid: %u\n",
                passed_fd, afs_code, afs_data);
        ret = -E_BAD_AFS_CODE;
        if (afs_code != NEXT_AUDIO_FILE)
@@ -395,7 +397,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;
@@ -419,7 +420,7 @@ void vss_post_select(fd_set *rfds, fd_set *wfds)
                recv_afs_result();
        if (afsss != AFS_SOCKET_CHECK_FOR_WRITE || !FD_ISSET(afs_socket, wfds))
                return;
-       PARA_NOTICE_LOG("requesting new socket\n");
+       PARA_NOTICE_LOG("requesting new fd from afs\n");
        ret = send_buffer(afs_socket, "new");
        afsss = AFS_SOCKET_AFD_PENDING;
 }
@@ -429,10 +430,6 @@ static void get_chunk(long unsigned chunk_num, char **buf, size_t *len)
        size_t pos = mmd->afd.afhi.chunk_table[chunk_num];
        *buf = map + pos;
        *len = mmd->afd.afhi.chunk_table[chunk_num + 1] - pos;
-
-       if (chunk_num + 5 > mmd->afd.afhi.chunks_total)
-               PARA_NOTICE_LOG("chunk %lu/%lu\n, len: %zu\n", chunk_num,
-                       mmd->afd.afhi.chunks_total, *len);
 }
 
 /**
@@ -442,7 +439,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)
 {
@@ -455,13 +452,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)
 {