crypt_common.c: Add missing doxygen documentation.
[paraslash.git] / afh_common.c
index 07e6a78..7696741 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1997-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2011 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -9,7 +9,7 @@
 #include <sys/mman.h> /* mmap */
 #include <sys/time.h> /* gettimeofday */
 #include <sys/types.h>
-#include <dirent.h>
+#include <regex.h>
 
 #include "para.h"
 #include "error.h"
@@ -25,7 +25,11 @@ void mp3_init(struct audio_format_handler *);
 #ifdef HAVE_FAAD
        void aac_afh_init(struct audio_format_handler *);
 #endif
+#ifdef HAVE_SPEEX
+       void spx_afh_init(struct audio_format_handler *);
+#endif
 
+void wma_afh_init(struct audio_format_handler *);
 /**
  * The list of supported audio formats.
  *
@@ -53,6 +57,16 @@ static struct audio_format_handler afl[] = {
                .name = "aac",
 #ifdef HAVE_FAAD
                .init = aac_afh_init,
+#endif
+       },
+       {
+               .name = "wma",
+               .init = wma_afh_init,
+       },
+       {
+               .name = "spx",
+#ifdef HAVE_SPEEX
+               .init = spx_afh_init,
 #endif
        },
        {
@@ -83,7 +97,7 @@ void afh_init(void)
        int i;
 
        PARA_INFO_LOG("supported audio formats: %s\n",
-               SUPPORTED_AUDIO_FORMATS);
+               SERVER_AUDIO_FORMATS);
        FOR_EACH_AUDIO_FORMAT(i) {
                PARA_NOTICE_LOG("initializing %s handler\n",
                        audio_format_name(i));
@@ -91,15 +105,14 @@ void afh_init(void)
        }
 }
 
-
 /**
  * Guess the audio format judging from filename.
  *
  * \param name The filename.
  *
- * \return This function returns -1 if it has no idea what kind of audio
- * file this might be. Otherwise the (non-negative) number of the audio format
- * is returned.
+ * \return This function returns \p -E_AUDIO_FORMAT if it has no idea what kind
+ * of audio file this might be. Otherwise the (non-negative) number of the
+ * audio format is returned.
  */
 int guess_audio_format(const char *name)
 {
@@ -119,22 +132,7 @@ int guess_audio_format(const char *name)
                        return i;
                }
        }
-       return -1;
-}
-
-char *make_taginfo(char *title, char *artist, char *album, char *year,
-               char *comment)
-{
-       return make_message("%s: %s, by %s\n" /* taginfo1 */
-               "%s: A: %s, Y: %s, C: %s\n", /* taginfo 2*/
-               status_item_list[SI_TAGINFO1],
-               (title && *title)? title : "(title tag not set)",
-               (artist && *artist)? artist : "(artist tag not set)",
-               status_item_list[SI_TAGINFO2],
-               (album && *album)?  album : "(album tag not set)",
-               (year && *year)? year : "????",
-               (comment && *comment)? comment : "(comment tag not set)"
-       );
+       return -E_AUDIO_FORMAT;
 }
 
 /**
@@ -161,24 +159,53 @@ int compute_afhi(const char *path, char *data, size_t size, int fd,
 {
        int ret, i, format;
 
-       afhi->header_offset = 0;
        afhi->header_len = 0;
+       afhi->techinfo = NULL;
+       afhi->tags.artist = NULL;
+       afhi->tags.title = NULL;
+       afhi->tags.year = NULL;
+       afhi->tags.album = NULL;
+       afhi->tags.comment = NULL;
        format = guess_audio_format(path);
 
        if (format >= 0) {
                ret = afl[format].get_file_info(data, size, fd, afhi);
-               if (ret >= 0)
-                       return format;
+               if (ret >= 0) {
+                       ret = format;
+                       goto success;
+               }
        }
        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, fd, afhi);
-               if (ret >= 0)
-                       return i;
+               if (ret >= 0) {
+                       ret = i;
+                       goto success;
+               }
                PARA_WARNING_LOG("%s\n", para_strerror(-ret));
        }
        return -E_AUDIO_FORMAT;
+success:
+       if (!afhi->techinfo)
+               afhi->techinfo = para_strdup(NULL);
+       if (!afhi->tags.artist)
+               afhi->tags.artist = para_strdup(NULL);
+       if (!afhi->tags.title)
+               afhi->tags.title = para_strdup(NULL);
+       if (!afhi->tags.year)
+               afhi->tags.year = para_strdup(NULL);
+       if (!afhi->tags.album)
+               afhi->tags.album = para_strdup(NULL);
+       if (!afhi->tags.comment)
+               afhi->tags.comment = para_strdup(NULL);
+       PARA_DEBUG_LOG("techinfo: %s\n", afhi->techinfo);
+       PARA_DEBUG_LOG("artist: %s\n", afhi->tags.artist);
+       PARA_DEBUG_LOG("title: %s\n", afhi->tags.title);
+       PARA_DEBUG_LOG("year: %s\n", afhi->tags.year);
+       PARA_DEBUG_LOG("album: %s\n", afhi->tags.album);
+       PARA_DEBUG_LOG("comment: %s\n", afhi->tags.comment);
+       return ret;
 }
 
 /**
@@ -191,12 +218,23 @@ int compute_afhi(const char *path, char *data, size_t size, int fd,
  */
 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)";
+       if (i < 0 || i >= ARRAY_SIZE(afl) - 1)
+               return "???";
+       return afl[i].name;
 }
 
-
+/**
+ * Get one chunk of audio data.
+ *
+ * \param chunk_num The number of the chunk to get.
+ * \param afhi Describes the audio file.
+ * \param map The memory mapped audio file.
+ * \param buf Result pointer.
+ * \param len The length of the chunk in bytes.
+ *
+ * Upon return, \a buf will point so memory inside \a map. The returned buffer
+ * must therefore not be freed by the caller.
+ */
 void afh_get_chunk(long unsigned chunk_num, struct afh_info *afhi,
                void *map, const char **buf, size_t *len)
 {
@@ -209,20 +247,52 @@ void afh_get_chunk(long unsigned chunk_num, struct afh_info *afhi,
  * Get the header of an audio file.
  *
  * \param afhi The audio file handler data describing the file.
+ * \param audio_format_id Determines the audio format handler.
  * \param map The data of the audio file.
+ * \param mapsize The amount of bytes of the mmapped audio file.
  * \param buf The length of the header is stored here.
  * \param len Points to a buffer containing the header on return.
  *
  * This function sets \a buf to \p NULL and \a len to zero if \a map or \a
  * afhi is \p NULL, or if the current audio format does not need special
- * header treamtment.
+ * header treatment.
+ *
+ * Otherwise, it is checked whether the audio format handler given by
+ * \a audio_format_id defines a ->get_header() method. If it does, this
+ * method is called to obtain the header. If ->get_header() is \p NULL,
+ * a reference to the first chunk of the audio file is returned.
+ *
+ * Once the header is no longer needed, the caller must call \ref
+ * afh_free_header() to free the resources allocated by this function.
  */
-void afh_get_header(struct afh_info *afhi, void *map, const char **buf, size_t *len)
+void afh_get_header(struct afh_info *afhi, uint8_t audio_format_id,
+               void *map, size_t mapsize, char **buf, size_t *len)
 {
-       if (!map || !afhi || ! afhi->header_len) {
+       struct audio_format_handler *afh = afl + audio_format_id;
+
+       if (!map || !afhi || !afhi->header_len) {
                *buf = NULL;
                *len = 0;
+               return;
+       }
+       if (!afh->get_header) {
+               *len = afhi->header_len;
+               *buf = map;
+               return;
        }
-       *len = afhi->header_len;
-       *buf = map + afhi->header_offset;
+       afh->get_header(map, mapsize, buf, len);
+}
+
+/**
+ * Deallocate any resources obtained from afh_get_header().
+ *
+ * \param header_buf Pointer obtained via afh_get_header().
+ * \param audio_format_id Determines the audio format handler.
+ */
+void afh_free_header(char *header_buf, uint8_t audio_format_id)
+{
+       struct audio_format_handler *afh = afl + audio_format_id;
+
+       if (afh->get_header)
+               free(header_buf);
 }