.ico Version of the fancy new logo.
[paraslash.git] / vss.c
diff --git a/vss.c b/vss.c
index 1bb6ff86995c256c0f4230259dc0641a8899bd91..5b7ed320aaaa38885f208dda80ad51d690999b2c 100644 (file)
--- a/vss.c
+++ b/vss.c
@@ -1,31 +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 <sys/types.h>
+#include <dirent.h>
+
+#include "para.h"
+#include "afh.h"
+#include "server.h"
 #include "server.cmdline.h"
-#include "afs.h"
+#include "afs_common.h"
 #include "vss.h"
 #include "send.h"
 #include "error.h"
@@ -42,14 +37,12 @@ static struct timeval autoplay_barrier;
 extern struct misc_meta_data *mmd;
 extern struct audio_file_selector selectors[];
 extern struct sender senders[];
-static char *inbuf;
-static size_t inbuf_size;
 
-static FILE *audio_file = NULL;
+static int audio_file;
+static char *map;
 
-#if 1
-       void mp3_init(struct audio_format_handler *);
-#endif
+/* The mp3 audio format handler does not need any libs. */
+void mp3_init(struct audio_format_handler *);
 
 #ifdef HAVE_OGGVORBIS
        void ogg_init(struct audio_format_handler *);
@@ -59,35 +52,53 @@ static FILE *audio_file = NULL;
 #endif
 
 /**
- * the list of supported  audio formats
+ * The list of supported  audio formats.
+ *
+ * We always define the full array of audio formats even if some audio formats
+ * were not compiled in. This is because for each audio file the number of its
+ * audio format is stored in the databse. We don't want that numbers to become
+ * stale just because the user installed a new version of paraslash that
+ * supports a different set of audio formats.
+ *
+ * It can still be easily detected whether an audio format is compiled in by
+ * checking if the init function pointer is not \p NULL.
  */
 static struct audio_format_handler afl[] = {
-#if 1
        {
                .name = "mp3",
                .init = mp3_init,
        },
-#endif
-#ifdef HAVE_OGGVORBIS
        {
                .name = "ogg",
+#ifdef HAVE_OGGVORBIS
                .init = ogg_init,
-       },
 #endif
-#ifdef HAVE_FAAD
+       },
        {
                .name = "aac",
+#ifdef HAVE_FAAD
                .init = aac_afh_init,
-       },
 #endif
+       },
        {
                .name = NULL,
        }
 };
 
-/** iterate over each supported audio format */
-#define FOR_EACH_AUDIO_FORMAT(i) for (i = 0; afl[i].name; i++)
+static inline int next_audio_format(int format)
+{
+       for (;;) {
+               if (!afl[format].name)
+                       return format;
+               format++;
+               if (afl[format].init)
+                       return format;
+       }
 
+}
+
+/** Iterate over each supported audio format. */
+#define FOR_EACH_AUDIO_FORMAT(i) for (i = 0; afl[i].name; i = next_audio_format(i))
 
 
 /**
@@ -136,14 +147,17 @@ unsigned int vss_paused(void)
 }
 
 /**
- * get the name of the given audio format
- * \param i the audio format number
+ * Get the name of the given audio format.
+ *
+ * \param i The audio format number.
  *
  * This returns a pointer to statically allocated memory so it
  * must not be freed by the caller.
  */
 const char *audio_format_name(int i)
 {
+       //PARA_NOTICE_LOG("array size: %u¸ requested: %d\n", ARRAY_SIZE(afl), i);
+       assert(i < 0 || i < ARRAY_SIZE(afl) - 1);
        return i >= 0?  afl[i].name : "(none)";
 }
 
@@ -157,15 +171,19 @@ 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);
-       for (i = 0; afl[i].name; i++) {
+       FOR_EACH_AUDIO_FORMAT(i) {
                PARA_NOTICE_LOG("initializing %s handler\n",
                        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);
@@ -178,14 +196,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->afi);
+       return  afl[i].get_file_info(map, mmd->size, &mmd->afi);
 }
 
 /**
@@ -215,7 +233,7 @@ int guess_audio_format(const char *name)
                        return i;
                }
        }
-       return -1;
+       return -E_BAD_AUDIO_FILE_SUFFIX;
 }
 
 static int get_audio_format(int omit)
@@ -225,10 +243,47 @@ static int get_audio_format(int omit)
        FOR_EACH_AUDIO_FORMAT(i) {
                if (i == omit)
                        continue;
-               rewind(audio_file);
                if (get_file_info(i) > 0)
                        return i;
-               rewind(audio_file);
+       }
+       return -E_AUDIO_FORMAT;
+}
+
+/**
+ * Call get_file_info() to obtain an afhi structure.
+ *
+ * \param path The full path of the audio file.
+ * \param data Pointer to the contents of the (mapped) file.
+ * \param size The file size in bytes.
+ * \param afhi Result pointer.
+ *
+ * \return The number of the audio format on success, \p -E_AUDIO_FORMAT if no
+ * compiled in audio format handler is able to handler the file.
+ *
+ * This function tries to find an audio format handler that can interpret the
+ * file given by \a data and \a size.
+ *
+ * It first tries to determine the audio format from the filename given by \a
+ * path. If this doesn't work, all other audio format handlers are tried until
+ * one is found that can handle the file.
+ */
+int compute_afhi(const char *path, char *data, size_t size,
+               struct audio_format_info *afhi)
+{
+       int ret, i, format = guess_audio_format(path);
+
+       if (format >= 0) {
+               ret = afl[format].get_file_info(data, size, afhi);
+               if (ret >= 0)
+                       return format;
+       }
+       FOR_EACH_AUDIO_FORMAT(i) {
+               if (i == format) /* we already tried this one to no avail */
+                       continue;
+               ret = afl[i].get_file_info(data, size, afhi);
+               if (ret >= 0)
+                       return i;
+               PARA_WARNING_LOG("%s\n", PARA_STRERROR(-ret));
        }
        return -E_AUDIO_FORMAT;
 }
@@ -239,7 +294,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)
@@ -250,19 +304,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;
@@ -271,27 +321,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) {
@@ -347,7 +407,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,
@@ -359,31 +419,28 @@ 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(&mmd->afi.eof_tv, &now, &eof_barrier);
-       fclose(audio_file);
-       audio_file = NULL;
+       munmap(map, mmd->size);
+       map = NULL;
+       close(audio_file);
        mmd->audio_format = -1;
-       af = NULL;
        mmd->chunks_sent = 0;
        mmd->offset = 0;
        mmd->afi.seconds_total = 0;
        free(mmd->afi.chunk_table);
        mmd->afi.chunk_table = NULL;
-       PARA_ERROR_LOG("freeing header %p\n", mmd->afi.header);
-       free(mmd->afi.header);
-       mmd->afi.header = 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->afi.info_string, tmp);
@@ -398,7 +455,7 @@ static void vss_eof(struct audio_format_handler *af)
 }
 
 /**
- * get the header and of the current audio file
+ * Get the header of the current audio file.
  *
  * \param header_len the length of the header is stored here
  *
@@ -407,12 +464,12 @@ static void vss_eof(struct audio_format_handler *af)
  * treamtment.
  *
  */
-char *vss_get_header(int *header_len)
+char *vss_get_header(size_t *header_len)
 {
-       if (mmd->audio_format < 0)
+       if (mmd->audio_format < 0 || !map || !mmd->afi.header_len)
                return NULL;
        *header_len = mmd->afi.header_len;
-       return mmd->afi.header;
+       return map + mmd->afi.header_offset;
 }
 
 /**
@@ -470,7 +527,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()) {
@@ -493,45 +550,39 @@ again:
                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;
 }
 
+static void get_chunk(long unsigned chunk_num, char **buf, size_t *len)
+{
+       size_t pos = mmd->afi.chunk_table[chunk_num];
+       *buf = map + pos;
+       *len = mmd->afi.chunk_table[chunk_num + 1] - pos;
+}
+
 /**
- * read a chunk of data from the current audio file
+ * Get the data of the given chunk.
  *
- * \return The length of the chunk on success, zero on end of file, negative on
- * errors.  Note: If the current chunk is of length zero, but the end of the
- * file is not yet reached, this function returns -E_EMPTY_CHUNK.
+ * \param chunk_num The number of the desired chunk.
+ * \param buf Chunk data.
+ * \param len Chunk length in bytes.
+ *
+ * \return Positive on success, negative on errors.
  */
-ssize_t vss_read_chunk(void)
+int vss_get_chunk(long unsigned chunk_num, char **buf, size_t *len)
 {
-       ssize_t len;
-       size_t pos;
-       int ret;
-       long unsigned cc = mmd->current_chunk;
-
-       if (cc >= mmd->afi.chunks_total) /* eof */
-               return 0;
-       len = mmd->afi.chunk_table[cc + 1] - mmd->afi.chunk_table[cc];
-       if (!len) /* nothing to send for this run */
-               return -E_EMPTY_CHUNK;
-       pos = mmd->afi.chunk_table[cc];
-       if (inbuf_size < len) {
-               PARA_INFO_LOG("increasing inbuf for chunk #%lu/%lu to %zu bytes\n",
-                       cc, mmd->afi.chunks_total, len);
-               inbuf = para_realloc(inbuf, len);
-               inbuf_size = len;
-       }
-       ret = para_fseek(audio_file, pos, SEEK_SET);
-       if (ret < 0)
-               return ret;
-       return para_fread(inbuf, len, 1, audio_file);
+       if (mmd->audio_format < 0 || !map || !vss_playing())
+               return -E_CHUNK;
+       if (chunk_num >= mmd->afi.chunks_total)
+               return -E_CHUNK;
+       get_chunk(chunk_num, buf, len);
+       return 1;
 }
 
 /**
@@ -547,10 +598,9 @@ void vss_send_chunk(void)
 {
        int i;
        struct audio_format_handler *af;
-       ssize_t ret;
        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);
@@ -562,23 +612,15 @@ void vss_send_chunk(void)
        if (chk_barrier("data send", &now, &data_send_barrier,
                        &due, 1) < 0)
                return;
-       ret= vss_read_chunk();
        mmd->new_vss_status_flags &= ~VSS_REPOS;
-       if (!ret || (ret < 0 && ret != -E_EMPTY_CHUNK)) {
-               if (ret < 0) {
-                       mmd->new_vss_status_flags = VSS_NEXT;
-                       PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
-               } 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();
        }
        /*
         * 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 (ret < 0)
-               ret = 0;
        if (!mmd->chunks_sent) {
                struct timeval tmp;
                gettimeofday(&mmd->stream_start, NULL);
@@ -586,8 +628,12 @@ void vss_send_chunk(void)
                mmd->offset = tv2ms(&tmp);
                mmd->events++;
        }
-       for (i = 0; senders[i].name; i++)
-               senders[i].send(mmd->current_chunk, mmd->chunks_sent, inbuf, ret);
+       for (i = 0; senders[i].name; i++) {
+               char *buf;
+               size_t len;
+               get_chunk(mmd->current_chunk, &buf, &len);
+               senders[i].send(mmd->current_chunk, mmd->chunks_sent, buf, len);
+       }
        mmd->new_vss_status_flags |= VSS_PLAYING;
        mmd->chunks_sent++;
        mmd->current_chunk++;