net.c: Cosmetics.
[paraslash.git] / afh_common.c
1 /*
2  * Copyright (C) 1997-2007 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 <dirent.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
29 /**
30  * The list of supported audio formats.
31  *
32  * We always define the full array of audio formats even if some audio formats
33  * were not compiled in. This is because for each audio file the number of its
34  * audio format is stored in the database. We don't want that numbers to become
35  * stale just because the user installed a new version of paraslash that
36  * supports a different set of audio formats.
37  *
38  * It can still be easily detected whether an audio format is compiled in by
39  * checking if the init function pointer is not \p NULL.
40  */
41 static struct audio_format_handler afl[] = {
42         {
43                 .name = "mp3",
44                 .init = mp3_init,
45         },
46         {
47                 .name = "ogg",
48 #ifdef HAVE_OGGVORBIS
49                 .init = ogg_init,
50 #endif
51         },
52         {
53                 .name = "aac",
54 #ifdef HAVE_FAAD
55                 .init = aac_afh_init,
56 #endif
57         },
58         {
59                 .name = NULL,
60         }
61 };
62
63 static inline int next_audio_format(int format)
64 {
65         for (;;) {
66                 if (!afl[format].name)
67                         return format;
68                 format++;
69                 if (afl[format].init)
70                         return format;
71         }
72
73 }
74
75 /** Iterate over each supported audio format. */
76 #define FOR_EACH_AUDIO_FORMAT(i) for (i = 0; afl[i].name; i = next_audio_format(i))
77
78 void afh_init(void)
79 {
80         int i;
81
82         PARA_INFO_LOG("supported audio formats: %s\n",
83                 SUPPORTED_AUDIO_FORMATS);
84         FOR_EACH_AUDIO_FORMAT(i) {
85                 PARA_NOTICE_LOG("initializing %s handler\n",
86                         audio_format_name(i));
87                 afl[i].init(&afl[i]);
88         }
89 }
90
91
92 /**
93  * Guess the audio format judging from filename.
94  *
95  * \param name The filename.
96  *
97  * \return This function returns -1 if it has no idea what kind of audio
98  * file this might be. Otherwise the (non-negative) number of the audio format
99  * is returned.
100  */
101 int guess_audio_format(const char *name)
102 {
103         int i,j, len = strlen(name);
104
105         FOR_EACH_AUDIO_FORMAT(i) {
106                 for (j = 0; afl[i].suffixes[j]; j++) {
107                         const char *p = afl[i].suffixes[j];
108                         int plen = strlen(p);
109                         if (len < plen + 1)
110                                 continue;
111                         if (name[len - plen - 1] != '.')
112                                 continue;
113                         if (strcasecmp(name + len - plen, p))
114                                 continue;
115 //                      PARA_DEBUG_LOG("might be %s\n", audio_format_name(i));
116                         return i;
117                 }
118         }
119         return -E_BAD_AUDIO_FILE_SUFFIX;
120 }
121
122 /**
123  * Call get_file_info() to obtain an afhi structure.
124  *
125  * \param path The full path of the audio file.
126  * \param data Pointer to the contents of the (mapped) file.
127  * \param size The file size in bytes.
128  * \param afhi Result pointer.
129  *
130  * \return The number of the audio format on success, \p -E_AUDIO_FORMAT if no
131  * compiled in audio format handler is able to handler the file.
132  *
133  * This function tries to find an audio format handler that can interpret the
134  * file given by \a data and \a size.
135  *
136  * It first tries to determine the audio format from the filename given by \a
137  * path. If this doesn't work, all other audio format handlers are tried until
138  * one is found that can handle the file.
139  */
140 int compute_afhi(const char *path, char *data, size_t size,
141                 struct afh_info *afhi)
142 {
143         int ret, i, format = guess_audio_format(path);
144
145         if (format >= 0) {
146                 ret = afl[format].get_file_info(data, size, afhi);
147                 if (ret >= 0)
148                         return format;
149         }
150         FOR_EACH_AUDIO_FORMAT(i) {
151                 if (i == format) /* we already tried this one to no avail */
152                         continue;
153                 ret = afl[i].get_file_info(data, size, afhi);
154                 if (ret >= 0)
155                         return i;
156                 PARA_WARNING_LOG("%s\n", PARA_STRERROR(-ret));
157         }
158         return -E_AUDIO_FORMAT;
159 }
160
161 /**
162  * Get the name of the given audio format.
163  *
164  * \param i The audio format number.
165  *
166  * This returns a pointer to statically allocated memory so it
167  * must not be freed by the caller.
168  */
169 const char *audio_format_name(int i)
170 {
171         //PARA_NOTICE_LOG("array size: %u¸ requested: %d\n", ARRAY_SIZE(afl), i);
172         assert(i < 0 || i < ARRAY_SIZE(afl) - 1);
173         return i >= 0?  afl[i].name : "(none)";
174 }
175