afh_common.c

   1 /*
   2  * Copyright (C) 1997-2012 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file afh_common.c Common audio format handler functions. */
   8
   9 #include <sys/mman.h> /* mmap */
  10 #include <sys/time.h> /* gettimeofday */
  11 #include <sys/types.h>
  12 #include <regex.h>
  13
  14 #include "para.h"
  15 #include "error.h"
  16 #include "string.h"
  17 #include "afh.h"
  18
  19 /* The mp3 audio format handler does not need any libs. */
  20 void mp3_init(struct audio_format_handler *);
  21
  22 #ifdef HAVE_OGGVORBIS
  23         void ogg_init(struct audio_format_handler *);
  24 #endif
  25 #ifdef HAVE_FAAD
  26         void aac_afh_init(struct audio_format_handler *);
  27 #endif
  28 #ifdef HAVE_SPEEX
  29         void spx_afh_init(struct audio_format_handler *);
  30 #endif
  31 #ifdef HAVE_FLAC
  32         void flac_afh_init(struct audio_format_handler *);
  33 #endif
  34
  35 void wma_afh_init(struct audio_format_handler *);
  36
  37 /** The list of all status items */
  38 const char *status_item_list[] = {STATUS_ITEM_ARRAY};
  39
  40 /**
  41  * The list of supported audio formats.
  42  *
  43  * We always define the full array of audio formats even if some audio formats
  44  * were not compiled in. This is because for each audio file the number of its
  45  * audio format is stored in the database. We don't want that numbers to become
  46  * stale just because the user installed a new version of paraslash that
  47  * supports a different set of audio formats.
  48  *
  49  * It can still be easily detected whether an audio format is compiled in by
  50  * checking if the init function pointer is not \p NULL.
  51  */
  52 static struct audio_format_handler afl[] = {
  53         {
  54                 .name = "mp3",
  55                 .init = mp3_init,
  56         },
  57         {
  58                 .name = "ogg",
  59 #ifdef HAVE_OGGVORBIS
  60                 .init = ogg_init,
  61 #endif
  62         },
  63         {
  64                 .name = "aac",
  65 #ifdef HAVE_FAAD
  66                 .init = aac_afh_init,
  67 #endif
  68         },
  69         {
  70                 .name = "wma",
  71                 .init = wma_afh_init,
  72         },
  73         {
  74                 .name = "spx",
  75 #ifdef HAVE_SPEEX
  76                 .init = spx_afh_init,
  77 #endif
  78         },
  79         {
  80                 .name = "flac",
  81 #ifdef HAVE_FLAC
  82                 .init = flac_afh_init,
  83 #endif
  84         },
  85         {
  86                 .name = NULL,
  87         }
  88 };
  89
  90 static inline int next_audio_format(int format)
  91 {
  92         for (;;) {
  93                 if (!afl[format].name)
  94                         return format;
  95                 format++;
  96                 if (afl[format].init)
  97                         return format;
  98         }
  99
 100 }
 101
 102 /** Iterate over each supported audio format. */
 103 #define FOR_EACH_AUDIO_FORMAT(i) for (i = 0; afl[i].name; i = next_audio_format(i))
 104
 105 /**
 106  * Call the init function of each supported audio format handler.
 107  */
 108 void afh_init(void)
 109 {
 110         int i;
 111
 112         PARA_INFO_LOG("supported audio formats: %s\n",
 113                 SERVER_AUDIO_FORMATS);
 114         FOR_EACH_AUDIO_FORMAT(i) {
 115                 PARA_NOTICE_LOG("initializing %s handler\n",
 116                         audio_format_name(i));
 117                 afl[i].init(&afl[i]);
 118         }
 119 }
 120
 121 /**
 122  * Guess the audio format judging from filename.
 123  *
 124  * \param name The filename.
 125  *
 126  * \return This function returns \p -E_AUDIO_FORMAT if it has no idea what kind
 127  * of audio file this might be. Otherwise the (non-negative) number of the
 128  * audio format is returned.
 129  */
 130 int guess_audio_format(const char *name)
 131 {
 132         int i,j, len = strlen(name);
 133
 134         FOR_EACH_AUDIO_FORMAT(i) {
 135                 for (j = 0; afl[i].suffixes[j]; j++) {
 136                         const char *p = afl[i].suffixes[j];
 137                         int plen = strlen(p);
 138                         if (len < plen + 1)
 139                                 continue;
 140                         if (name[len - plen - 1] != '.')
 141                                 continue;
 142                         if (strcasecmp(name + len - plen, p))
 143                                 continue;
 144 //                      PARA_DEBUG_LOG("might be %s\n", audio_format_name(i));
 145                         return i;
 146                 }
 147         }
 148         return -E_AUDIO_FORMAT;
 149 }
 150
 151 /**
 152  * Call get_file_info() to obtain an afhi structure.
 153  *
 154  * \param path The full path of the audio file.
 155  * \param data Pointer to the contents of the (mapped) file.
 156  * \param size The file size in bytes.
 157  * \param fd The open file descriptor.
 158  * \param afhi Result pointer.
 159  *
 160  * \return The number of the audio format on success, \p -E_AUDIO_FORMAT if no
 161  * compiled in audio format handler is able to handler the file.
 162  *
 163  * This function tries to find an audio format handler that can interpret the
 164  * file given by \a data and \a size.
 165  *
 166  * It first tries to determine the audio format from the filename given by \a
 167  * path. If this doesn't work, all other audio format handlers are tried until
 168  * one is found that can handle the file.
 169  */
 170 int compute_afhi(const char *path, char *data, size_t size, int fd,
 171                 struct afh_info *afhi)
 172 {
 173         int ret, i, format;
 174
 175         afhi->header_len = 0;
 176         afhi->techinfo = NULL;
 177         afhi->tags.artist = NULL;
 178         afhi->tags.title = NULL;
 179         afhi->tags.year = NULL;
 180         afhi->tags.album = NULL;
 181         afhi->tags.comment = NULL;
 182         format = guess_audio_format(path);
 183
 184         if (format >= 0) {
 185                 ret = afl[format].get_file_info(data, size, fd, afhi);
 186                 if (ret >= 0) {
 187                         ret = format;
 188                         goto success;
 189                 }
 190         }
 191         FOR_EACH_AUDIO_FORMAT(i) {
 192                 if (i == format) /* we already tried this one to no avail */
 193                         continue;
 194                 ret = afl[i].get_file_info(data, size, fd, afhi);
 195                 if (ret >= 0) {
 196                         ret = i;
 197                         goto success;
 198                 }
 199                 PARA_WARNING_LOG("%s\n", para_strerror(-ret));
 200         }
 201         return -E_AUDIO_FORMAT;
 202 success:
 203         if (!afhi->techinfo)
 204                 afhi->techinfo = para_strdup(NULL);
 205         if (!afhi->tags.artist)
 206                 afhi->tags.artist = para_strdup(NULL);
 207         if (!afhi->tags.title)
 208                 afhi->tags.title = para_strdup(NULL);
 209         if (!afhi->tags.year)
 210                 afhi->tags.year = para_strdup(NULL);
 211         if (!afhi->tags.album)
 212                 afhi->tags.album = para_strdup(NULL);
 213         if (!afhi->tags.comment)
 214                 afhi->tags.comment = para_strdup(NULL);
 215         PARA_DEBUG_LOG("techinfo: %s\n", afhi->techinfo);
 216         PARA_DEBUG_LOG("artist: %s\n", afhi->tags.artist);
 217         PARA_DEBUG_LOG("title: %s\n", afhi->tags.title);
 218         PARA_DEBUG_LOG("year: %s\n", afhi->tags.year);
 219         PARA_DEBUG_LOG("album: %s\n", afhi->tags.album);
 220         PARA_DEBUG_LOG("comment: %s\n", afhi->tags.comment);
 221         return ret;
 222 }
 223
 224 /**
 225  * Deallocate contents of a filled-in ahi structure
 226  *
 227  * \param afhi The structure to clear.
 228  *
 229  * The given pointer is kept, everything else is freed.
 230  */
 231 void clear_afhi(struct afh_info *afhi)
 232 {
 233         if (!afhi)
 234                 return;
 235         free(afhi->chunk_table);
 236         free(afhi->techinfo);
 237         free(afhi->tags.artist);
 238         free(afhi->tags.title);
 239         free(afhi->tags.year);
 240         free(afhi->tags.album);
 241         free(afhi->tags.comment);
 242 }
 243
 244 /**
 245  * Get the name of the given audio format.
 246  *
 247  * \param i The audio format number.
 248  *
 249  * \return This returns a pointer to statically allocated memory so it
 250  * must not be freed by the caller.
 251  */
 252 const char *audio_format_name(int i)
 253 {
 254         if (i < 0 || i >= ARRAY_SIZE(afl) - 1)
 255                 return "???";
 256         return afl[i].name;
 257 }
 258
 259 /**
 260  * Get one chunk of audio data.
 261  *
 262  * \param chunk_num The number of the chunk to get.
 263  * \param afhi Describes the audio file.
 264  * \param map The memory mapped audio file.
 265  * \param buf Result pointer.
 266  * \param len The length of the chunk in bytes.
 267  *
 268  * Upon return, \a buf will point so memory inside \a map. The returned buffer
 269  * must therefore not be freed by the caller.
 270  */
 271 void afh_get_chunk(long unsigned chunk_num, struct afh_info *afhi,
 272                 void *map, const char **buf, size_t *len)
 273 {
 274         size_t pos = afhi->chunk_table[chunk_num];
 275         *buf = map + pos;
 276         *len = afhi->chunk_table[chunk_num + 1] - pos;
 277 }
 278
 279 /**
 280  * Get the header of an audio file.
 281  *
 282  * \param afhi The audio file handler data describing the file.
 283  * \param audio_format_id Determines the audio format handler.
 284  * \param map The data of the audio file.
 285  * \param mapsize The amount of bytes of the mmapped audio file.
 286  * \param buf The length of the header is stored here.
 287  * \param len Points to a buffer containing the header on return.
 288  *
 289  * This function sets \a buf to \p NULL and \a len to zero if \a map or \a
 290  * afhi is \p NULL, or if the current audio format does not need special
 291  * header treatment.
 292  *
 293  * Otherwise, it is checked whether the audio format handler given by
 294  * \a audio_format_id defines a ->get_header() method. If it does, this
 295  * method is called to obtain the header. If ->get_header() is \p NULL,
 296  * a reference to the first chunk of the audio file is returned.
 297  *
 298  * Once the header is no longer needed, the caller must call \ref
 299  * afh_free_header() to free the resources allocated by this function.
 300  */
 301 void afh_get_header(struct afh_info *afhi, uint8_t audio_format_id,
 302                 void *map, size_t mapsize, char **buf, size_t *len)
 303 {
 304         struct audio_format_handler *afh = afl + audio_format_id;
 305
 306         if (!map || !afhi || !afhi->header_len) {
 307                 *buf = NULL;
 308                 *len = 0;
 309                 return;
 310         }
 311         if (!afh->get_header) {
 312                 *len = afhi->header_len;
 313                 *buf = map;
 314                 return;
 315         }
 316         afh->get_header(map, mapsize, buf, len);
 317 }
 318
 319 /**
 320  * Deallocate any resources obtained from afh_get_header().
 321  *
 322  * \param header_buf Pointer obtained via afh_get_header().
 323  * \param audio_format_id Determines the audio format handler.
 324  */
 325 void afh_free_header(char *header_buf, uint8_t audio_format_id)
 326 {
 327         struct audio_format_handler *afh = afl + audio_format_id;
 328
 329         if (afh->get_header)
 330                 free(header_buf);
 331 }