trivial doxygen cleanups
[paraslash.git] / vss.c
diff --git a/vss.c b/vss.c
index f9e2d6c..7892fb1 100644 (file)
--- a/vss.c
+++ b/vss.c
@@ -1,36 +1,26 @@
 /*
  * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
  *
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /** \file vss.c the virtual streaming system
  *
- * This contains the audio sending part of para_server which is independent of
- * the current audio format, audio file selector and of the activated senders.
+ * This contains the audio streaming code of para_server which is independent
+ * of the current audio format, audio file selector and of the activated
+ * senders.
  */
 
 #include "server.h"
+#include <sys/mman.h> /* mmap */
 #include <sys/time.h> /* gettimeofday */
 #include "server.cmdline.h"
-#include "db.h"
-#include "afh.h"
+#include "afs.h"
 #include "vss.h"
 #include "send.h"
 #include "error.h"
 #include "string.h"
+#include "fd.h"
 
 extern const char *status_item_list[];
 
@@ -43,7 +33,8 @@ extern struct misc_meta_data *mmd;
 extern struct audio_file_selector selectors[];
 extern struct sender senders[];
 
-static FILE *audio_file = NULL;
+static int audio_file;
+static char *map;
 
 #if 1
        void mp3_init(struct audio_format_handler *);
@@ -82,8 +73,12 @@ static struct audio_format_handler afl[] = {
                .name = NULL,
        }
 };
+
+/** iterate over each supported audio format */
 #define FOR_EACH_AUDIO_FORMAT(i) for (i = 0; afl[i].name; i++)
 
+
+
 /**
  * check if vss status flag \a P (playing) is set
  *
@@ -151,6 +146,10 @@ void vss_init(void)
 {
        int i;
        char *hn = para_hostname(), *home = para_homedir();
+       long unsigned announce_time = conf.announce_time_arg > 0?
+                       conf.announce_time_arg : 300,
+               autoplay_delay = conf.autoplay_delay_arg > 0?
+                       conf.autoplay_delay_arg : 0;
 
        PARA_DEBUG_LOG("supported audio formats: %s\n",
                SUPPORTED_AUDIO_FORMATS);
@@ -159,7 +158,7 @@ void vss_init(void)
                        afl[i].name);
                afl[i].init(&afl[i]);
        }
-       ms2tv(conf.announce_time_arg, &announce_tv);
+       ms2tv(announce_time, &announce_tv);
        PARA_INFO_LOG("announce timeval: %lums\n", tv2ms(&announce_tv));
        for (i = 0; senders[i].name; i++) {
                PARA_NOTICE_LOG("initializing %s sender\n", senders[i].name);
@@ -172,15 +171,14 @@ void vss_init(void)
                mmd->vss_status_flags |= VSS_PLAYING;
                mmd->new_vss_status_flags |= VSS_PLAYING;
                gettimeofday(&now, NULL);
-               ms2tv(conf.autoplay_delay_arg, &tmp);
+               ms2tv(autoplay_delay, &tmp);
                tv_add(&now, &tmp, &autoplay_barrier);
        }
 }
 
 static int get_file_info(int i)
 {
-       return  afl[i].get_file_info(audio_file, mmd->audio_file_info,
-               &mmd->chunks_total, &mmd->seconds_total);
+       return  afl[i].get_file_info(map, mmd->size, &mmd->afi);
 }
 
 /**
@@ -218,12 +216,10 @@ static int get_audio_format(int omit)
        int i;
 
        FOR_EACH_AUDIO_FORMAT(i) {
-               if (i == omit || !afl[i].get_file_info)
+               if (i == omit)
                        continue;
-               rewind(audio_file);
                if (get_file_info(i) > 0)
                        return i;
-               rewind(audio_file);
        }
        return -E_AUDIO_FORMAT;
 }
@@ -234,7 +230,6 @@ static int get_audio_format(int omit)
 static int update_mmd(void)
 {
        int i;
-       struct stat file_status;
 
        i = guess_audio_format(mmd->filename);
        if (i < 0 || get_file_info(i) < 0)
@@ -245,19 +240,15 @@ static int update_mmd(void)
        mmd->chunks_sent = 0;
        mmd->current_chunk = 0;
        mmd->offset = 0;
-       if (fstat(fileno(audio_file), &file_status) == -1)
-               return -E_FSTAT;
-       mmd->size = file_status.st_size;
-       mmd->mtime = file_status.st_mtime;
        mmd->events++;
-       PARA_NOTICE_LOG("next audio file: %s\n", mmd->filename);
        return 1;
 }
 
-static void get_song(void)
+static void vss_get_audio_file(void)
 {
        char **sl = selectors[mmd->selector_num].get_audio_file_list(10);
        int i;
+       struct stat file_status;
 
        if (!sl)
                goto err_out;
@@ -266,27 +257,37 @@ static void get_song(void)
                PARA_INFO_LOG("trying %s\n", sl[i]);
                if (strlen(sl[i]) >= _POSIX_PATH_MAX)
                        continue;
-               audio_file = fopen(sl[i], "r");
-               if (!audio_file)
+               audio_file = open(sl[i], O_RDONLY);
+               if (audio_file < 0)
+                       continue;
+               if (fstat(audio_file, &file_status) == -1 ||
+                               !file_status.st_size) {
+                       close(audio_file);
                        continue;
+               }
+               mmd->size = file_status.st_size;
+               mmd->mtime = file_status.st_mtime;
+               map = para_mmap(mmd->size, PROT_READ, MAP_PRIVATE,
+                       audio_file, 0);
                strcpy(mmd->filename, sl[i]);
-               if (update_mmd() < 0) {
-                       fclose(audio_file);
-                       audio_file = NULL;
+               mmd->afi.header_len = 0; /* default: no header */
+               if (update_mmd() < 0) { /* invalid file */
+                       close(audio_file);
+                       munmap(map, mmd->size);
+                       map = NULL;
                        continue;
                }
                mmd->num_played++;
                if (selectors[mmd->selector_num].update_audio_file)
                        selectors[mmd->selector_num].update_audio_file(sl[i]);
-               PARA_DEBUG_LOG("%s", "success\n");
+               PARA_NOTICE_LOG("next audio file: %s\n", mmd->filename);
                mmd->new_vss_status_flags &= (~VSS_NEXT);
                gettimeofday(&now, NULL);
                tv_add(&now, &announce_tv, &data_send_barrier);
-
                goto free;
        }
-       PARA_ERROR_LOG("%s", "no valid files found\n");
 err_out:
+       PARA_ERROR_LOG("%s", "no valid files found\n");
        mmd->new_vss_status_flags = VSS_NEXT;
 free:
        if (sl) {
@@ -314,7 +315,7 @@ static void vss_next_chunk_time(struct timeval *due)
 {
        struct timeval tmp;
 
-       tv_scale(mmd->chunks_sent, &afl[mmd->audio_format].chunk_tv, &tmp);
+       tv_scale(mmd->chunks_sent, &mmd->afi.chunk_tv, &tmp);
        tv_add(&tmp, &mmd->stream_start, due);
 }
 
@@ -342,7 +343,7 @@ static struct timeval *vss_compute_timeout(void)
        if (chk_barrier("data send", &now, &data_send_barrier,
                        &the_timeout, 1) < 0)
                return &the_timeout;
-       if (mmd->audio_format < 0 || !vss_playing() || !audio_file)
+       if (mmd->audio_format < 0 || !vss_playing() || !map)
                return NULL;
        vss_next_chunk_time(&next_chunk);
        if (chk_barrier(afl[mmd->audio_format].name, &now, &next_chunk,
@@ -354,29 +355,31 @@ static struct timeval *vss_compute_timeout(void)
        return &the_timeout;
 }
 
-static void vss_eof(struct audio_format_handler *af)
+static void vss_eof(void)
 {
        struct timeval now;
        int i;
        char *tmp;
 
-       if (!af || !audio_file) {
+       if (!map) {
                for (i = 0; senders[i].name; i++)
                        senders[i].shutdown_clients();
                return;
        }
        gettimeofday(&now, NULL);
-       tv_add(&af->eof_tv, &now, &eof_barrier);
-       af->close_audio_file();
-       audio_file = NULL;
+       tv_add(&mmd->afi.eof_tv, &now, &eof_barrier);
+       munmap(map, mmd->size);
+       map = NULL;
+       close(audio_file);
        mmd->audio_format = -1;
-       af = NULL;
        mmd->chunks_sent = 0;
        mmd->offset = 0;
-       mmd->seconds_total = 0;
+       mmd->afi.seconds_total = 0;
+       free(mmd->afi.chunk_table);
+       mmd->afi.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->audio_file_info, tmp);
+       strcpy(mmd->afi.info_string, tmp);
        free(tmp);
        tmp  = make_message("%s:\n%s:\n%s:\n", status_item_list[SI_DBINFO1],
                status_item_list[SI_DBINFO2], status_item_list[SI_DBINFO3]);
@@ -397,15 +400,21 @@ static void vss_eof(struct audio_format_handler *af)
  * treamtment.
  *
  */
-char *vss_get_header(int *header_len)
+char *vss_get_header(unsigned *header_len)
 {
-       *header_len = 0;
-       if (mmd->audio_format < 0)
-               return NULL;
-       if (!afl[mmd->audio_format].get_header_info)
+       if (mmd->audio_format < 0 || !map || !mmd->afi.header_len)
                return NULL;
-       return afl[mmd->audio_format].get_header_info(header_len);
+       *header_len = mmd->afi.header_len;
+       return map + mmd->afi.header_offset;
 }
+
+/**
+ * get the list of all supported audio formats
+ *
+ * \return a 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.
+ */
 const char *supported_audio_formats(void)
 {
        return SUPPORTED_AUDIO_FORMATS;
@@ -421,7 +430,7 @@ struct timeval *vss_chunk_time(void)
 {
        if (mmd->audio_format < 0)
                return NULL;
-       return &afl[mmd->audio_format].chunk_tv;
+       return &mmd->afi.chunk_tv;
 }
 
 /**
@@ -454,7 +463,7 @@ again:
                for (i = 0; senders[i].name; i++)
                        senders[i].shutdown_clients();
        if (vss_next() && af) {
-               vss_eof(af);
+               vss_eof();
                return vss_compute_timeout();
        }
        if (vss_paused() || vss_repos()) {
@@ -464,7 +473,7 @@ again:
                        struct timeval now;
                        gettimeofday(&now, NULL);
                        if (!vss_paused() || mmd->chunks_sent)
-                               tv_add(&af->eof_tv, &now, &eof_barrier);
+                               tv_add(&mmd->afi.eof_tv, &now, &eof_barrier);
                        if (vss_repos())
                                tv_add(&now, &announce_tv, &data_send_barrier);
                        if (mmd->new_vss_status_flags & VSS_NOMORE)
@@ -472,17 +481,15 @@ again:
                }
                mmd->chunks_sent = 0;
        }
-       if (af && vss_repos() && mmd->current_chunk != mmd->repos_request)
-               af->reposition_stream(mmd->repos_request);
        if (vss_repos()) {
                mmd->new_vss_status_flags &= ~(VSS_REPOS);
                mmd->current_chunk = mmd->repos_request;
        }
        ret = vss_compute_timeout();
-       if (!ret && !audio_file && vss_playing() &&
+       if (!ret && !map && vss_playing() &&
                        !(mmd->new_vss_status_flags & VSS_NOMORE)) {
                PARA_DEBUG_LOG("%s", "ready and playing, but no audio file\n");
-               get_song();
+               vss_get_audio_file();
                goto again;
        }
        return ret;
@@ -496,20 +503,16 @@ again:
  * 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.
- *
- * Return value: Positive return value on success, zero on eof and negative
- * on errors.
  */
-
 void vss_send_chunk(void)
 {
        int i;
        struct audio_format_handler *af;
-       char *buf;
-       ssize_t ret;
+       ssize_t pos;
+       size_t len;
        struct timeval now, due;
 
-       if (mmd->audio_format < 0 || !audio_file || !vss_playing())
+       if (mmd->audio_format < 0 || !map || !vss_playing())
                return;
        af = &afl[mmd->audio_format];
        gettimeofday(&now, NULL);
@@ -521,25 +524,27 @@ void vss_send_chunk(void)
        if (chk_barrier("data send", &now, &data_send_barrier,
                        &due, 1) < 0)
                return;
-       buf = af->read_chunk(mmd->current_chunk, &ret);
        mmd->new_vss_status_flags &= ~VSS_REPOS;
-       if (!buf) {
-               if (ret < 0)
-                       mmd->new_vss_status_flags = VSS_NEXT;
-               else
-                       mmd->new_vss_status_flags |= VSS_NEXT;
-               vss_eof(af);
-               return;
+       if (mmd->current_chunk >= mmd->afi.chunks_total) { /* eof */
+               mmd->new_vss_status_flags |= VSS_NEXT;
+               return vss_eof();
        }
+       pos = mmd->afi.chunk_table[mmd->current_chunk];
+       len = mmd->afi.chunk_table[mmd->current_chunk + 1] - pos;
+       /*
+        * 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.
+        */
        if (!mmd->chunks_sent) {
                struct timeval tmp;
                gettimeofday(&mmd->stream_start, NULL);
-               tv_scale(mmd->current_chunk, &af->chunk_tv, &tmp);
+               tv_scale(mmd->current_chunk, &mmd->afi.chunk_tv, &tmp);
                mmd->offset = tv2ms(&tmp);
                mmd->events++;
        }
        for (i = 0; senders[i].name; i++)
-               senders[i].send(mmd->current_chunk, mmd->chunks_sent, buf, ret);
+               senders[i].send(mmd->current_chunk, mmd->chunks_sent,
+                       map + pos, len);
        mmd->new_vss_status_flags |= VSS_PLAYING;
        mmd->chunks_sent++;
        mmd->current_chunk++;