time.c: Add GPL header and improve documentation.

[paraslash.git] / vss.c

diff --git a/vss.c b/vss.c
index c15fbd7e6898537f2c9e6a26ee067c61ab7455da..3ba5994b5123dd58573f6b049dd5420b23309ba3 100644 (file)
--- a/vss.c
+++ b/vss.c
@@ -11,11 +11,13 @@
  * senders.
  */
 
+#include "para.h"
+#include "afh.h"
 #include "server.h"
 #include <sys/mman.h> /* mmap */
 #include <sys/time.h> /* gettimeofday */
 #include "server.cmdline.h"
-#include "afs.h"
+#include "afs_common.h"
 #include "vss.h"
 #include "send.h"
 #include "error.h"
@@ -36,9 +38,8 @@ extern struct sender senders[];
 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 *);
@@ -48,35 +49,53 @@ static char *map;
 #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))
 
 
 /**
@@ -125,14 +144,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)";
 }
 
@@ -153,7 +175,7 @@ void vss_init(void)
 
        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]);
@@ -224,6 +246,45 @@ static int get_audio_format(int omit)
        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;
+}
+
 /*
  * upddate shared mem
  */
@@ -391,7 +452,7 @@ static void vss_eof(void)
 }
 
 /**
- * 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
  *