Merge commit 'meins/master'
[paraslash.git] / afh_common.c
index 311e0c1..8c0eed2 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -75,6 +75,9 @@ static inline int next_audio_format(int format)
 /** Iterate over each supported audio format. */
 #define FOR_EACH_AUDIO_FORMAT(i) for (i = 0; afl[i].name; i = next_audio_format(i))
 
+/**
+ * Call the init function of each supported audio format handler.
+ */
 void afh_init(void)
 {
        int i;
@@ -88,15 +91,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)
 {
@@ -116,7 +118,40 @@ int guess_audio_format(const char *name)
                        return i;
                }
        }
-       return -E_BAD_AUDIO_FILE_SUFFIX;
+       return -E_AUDIO_FORMAT;
+}
+
+/**
+ * Pretty-print the given meta-info.
+ *
+ * \param title The title of the audio file.
+ * \param artist The artist.
+ * \param album The name of the album.
+ * \param year Year of release.
+ * \param comment Further comments.
+ *
+ * This function is called by each audio format handler to produce the tag info
+ * status items. Usually, the audio format handlers read this info from the
+ * audio file (id3 tags, vorbis comments, ...).
+ *
+ * It is OK to pass \p NULL pointers for any argument in which case a suitable
+ * string is inserted which indicates that this information is not available.
+ *
+ * \return The status item string. It must be freed by the caller.
+ */
+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", /* taginfo2 */
+               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)"
+       );
 }
 
 /**
@@ -125,6 +160,7 @@ int guess_audio_format(const char *name)
  * \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 fd The open file descriptor.
  * \param afhi Result pointer.
  *
  * \return The number of the audio format on success, \p -E_AUDIO_FORMAT if no
@@ -137,23 +173,27 @@ int guess_audio_format(const char *name)
  * 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 compute_afhi(const char *path, char *data, size_t size, int fd,
+               struct afh_info *afhi)
 {
-       int ret, i, format = guess_audio_format(path);
+       int ret, i, format;
+
+       afhi->header_offset = 0;
+       afhi->header_len = 0;
+       format = guess_audio_format(path);
 
        if (format >= 0) {
-               ret = afl[format].get_file_info(data, size, afhi);
+               ret = afl[format].get_file_info(data, size, fd, 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);
+               ret = afl[i].get_file_info(data, size, fd, afhi);
                if (ret >= 0)
                        return i;
-               PARA_WARNING_LOG("%s\n", PARA_STRERROR(-ret));
+               PARA_WARNING_LOG("%s\n", para_strerror(-ret));
        }
        return -E_AUDIO_FORMAT;
 }
@@ -173,3 +213,54 @@ const char *audio_format_name(int i)
        return i >= 0?  afl[i].name : "(none)";
 }
 
+/**
+ * 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)
+{
+       size_t pos = afhi->chunk_table[chunk_num];
+       *buf = map + pos;
+       *len = afhi->chunk_table[chunk_num + 1] - pos;
+}
+
+uint32_t afh_get_largest_chunk_size(struct afh_info *afhi)
+{
+       uint32_t n, largest = 0, *ct = afhi->chunk_table;
+
+       for (n = 1; n <= afhi->chunks_total; n++)
+               largest = PARA_MAX(largest, ct[n] - ct[n - 1]);
+       return largest;
+}
+
+/**
+ * Get the header of an audio file.
+ *
+ * \param afhi The audio file handler data describing the file.
+ * \param map The data of the 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.
+ */
+void afh_get_header(struct afh_info *afhi, void *map, const char **buf, size_t *len)
+{
+       if (!map || !afhi || !afhi->header_len) {
+               *buf = NULL;
+               *len = 0;
+               return;
+       }
+       *len = afhi->header_len;
+       *buf = map + afhi->header_offset;
+}