2 * Copyright (C) 1997-2012 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file afh_common.c Common audio format handler functions. */
9 #include <sys/mman.h> /* mmap */
10 #include <sys/time.h> /* gettimeofday */
11 #include <sys/types.h>
19 /* The mp3 audio format handler does not need any libs. */
20 void mp3_init(struct audio_format_handler *);
23 void ogg_init(struct audio_format_handler *);
26 void aac_afh_init(struct audio_format_handler *);
29 void spx_afh_init(struct audio_format_handler *);
32 void flac_afh_init(struct audio_format_handler *);
35 void wma_afh_init(struct audio_format_handler *);
37 * The list of supported audio formats.
39 * We always define the full array of audio formats even if some audio formats
40 * were not compiled in. This is because for each audio file the number of its
41 * audio format is stored in the database. We don't want that numbers to become
42 * stale just because the user installed a new version of paraslash that
43 * supports a different set of audio formats.
45 * It can still be easily detected whether an audio format is compiled in by
46 * checking if the init function pointer is not \p NULL.
48 static struct audio_format_handler afl[] = {
78 .init = flac_afh_init,
86 static inline int next_audio_format(int format)
89 if (!afl[format].name)
98 /** Iterate over each supported audio format. */
99 #define FOR_EACH_AUDIO_FORMAT(i) for (i = 0; afl[i].name; i = next_audio_format(i))
102 * Call the init function of each supported audio format handler.
108 PARA_INFO_LOG("supported audio formats: %s\n",
109 SERVER_AUDIO_FORMATS);
110 FOR_EACH_AUDIO_FORMAT(i) {
111 PARA_NOTICE_LOG("initializing %s handler\n",
112 audio_format_name(i));
113 afl[i].init(&afl[i]);
118 * Guess the audio format judging from filename.
120 * \param name The filename.
122 * \return This function returns \p -E_AUDIO_FORMAT if it has no idea what kind
123 * of audio file this might be. Otherwise the (non-negative) number of the
124 * audio format is returned.
126 int guess_audio_format(const char *name)
128 int i,j, len = strlen(name);
130 FOR_EACH_AUDIO_FORMAT(i) {
131 for (j = 0; afl[i].suffixes[j]; j++) {
132 const char *p = afl[i].suffixes[j];
133 int plen = strlen(p);
136 if (name[len - plen - 1] != '.')
138 if (strcasecmp(name + len - plen, p))
140 // PARA_DEBUG_LOG("might be %s\n", audio_format_name(i));
144 return -E_AUDIO_FORMAT;
148 * Call get_file_info() to obtain an afhi structure.
150 * \param path The full path of the audio file.
151 * \param data Pointer to the contents of the (mapped) file.
152 * \param size The file size in bytes.
153 * \param fd The open file descriptor.
154 * \param afhi Result pointer.
156 * \return The number of the audio format on success, \p -E_AUDIO_FORMAT if no
157 * compiled in audio format handler is able to handler the file.
159 * This function tries to find an audio format handler that can interpret the
160 * file given by \a data and \a size.
162 * It first tries to determine the audio format from the filename given by \a
163 * path. If this doesn't work, all other audio format handlers are tried until
164 * one is found that can handle the file.
166 int compute_afhi(const char *path, char *data, size_t size, int fd,
167 struct afh_info *afhi)
171 afhi->header_len = 0;
172 afhi->techinfo = NULL;
173 afhi->tags.artist = NULL;
174 afhi->tags.title = NULL;
175 afhi->tags.year = NULL;
176 afhi->tags.album = NULL;
177 afhi->tags.comment = NULL;
178 format = guess_audio_format(path);
181 ret = afl[format].get_file_info(data, size, fd, afhi);
187 FOR_EACH_AUDIO_FORMAT(i) {
188 if (i == format) /* we already tried this one to no avail */
190 ret = afl[i].get_file_info(data, size, fd, afhi);
195 PARA_WARNING_LOG("%s\n", para_strerror(-ret));
197 return -E_AUDIO_FORMAT;
200 afhi->techinfo = para_strdup(NULL);
201 if (!afhi->tags.artist)
202 afhi->tags.artist = para_strdup(NULL);
203 if (!afhi->tags.title)
204 afhi->tags.title = para_strdup(NULL);
205 if (!afhi->tags.year)
206 afhi->tags.year = para_strdup(NULL);
207 if (!afhi->tags.album)
208 afhi->tags.album = para_strdup(NULL);
209 if (!afhi->tags.comment)
210 afhi->tags.comment = para_strdup(NULL);
211 PARA_DEBUG_LOG("techinfo: %s\n", afhi->techinfo);
212 PARA_DEBUG_LOG("artist: %s\n", afhi->tags.artist);
213 PARA_DEBUG_LOG("title: %s\n", afhi->tags.title);
214 PARA_DEBUG_LOG("year: %s\n", afhi->tags.year);
215 PARA_DEBUG_LOG("album: %s\n", afhi->tags.album);
216 PARA_DEBUG_LOG("comment: %s\n", afhi->tags.comment);
221 * Get the name of the given audio format.
223 * \param i The audio format number.
225 * \return This returns a pointer to statically allocated memory so it
226 * must not be freed by the caller.
228 const char *audio_format_name(int i)
230 if (i < 0 || i >= ARRAY_SIZE(afl) - 1)
236 * Get one chunk of audio data.
238 * \param chunk_num The number of the chunk to get.
239 * \param afhi Describes the audio file.
240 * \param map The memory mapped audio file.
241 * \param buf Result pointer.
242 * \param len The length of the chunk in bytes.
244 * Upon return, \a buf will point so memory inside \a map. The returned buffer
245 * must therefore not be freed by the caller.
247 void afh_get_chunk(long unsigned chunk_num, struct afh_info *afhi,
248 void *map, const char **buf, size_t *len)
250 size_t pos = afhi->chunk_table[chunk_num];
252 *len = afhi->chunk_table[chunk_num + 1] - pos;
256 * Get the header of an audio file.
258 * \param afhi The audio file handler data describing the file.
259 * \param audio_format_id Determines the audio format handler.
260 * \param map The data of the audio file.
261 * \param mapsize The amount of bytes of the mmapped audio file.
262 * \param buf The length of the header is stored here.
263 * \param len Points to a buffer containing the header on return.
265 * This function sets \a buf to \p NULL and \a len to zero if \a map or \a
266 * afhi is \p NULL, or if the current audio format does not need special
269 * Otherwise, it is checked whether the audio format handler given by
270 * \a audio_format_id defines a ->get_header() method. If it does, this
271 * method is called to obtain the header. If ->get_header() is \p NULL,
272 * a reference to the first chunk of the audio file is returned.
274 * Once the header is no longer needed, the caller must call \ref
275 * afh_free_header() to free the resources allocated by this function.
277 void afh_get_header(struct afh_info *afhi, uint8_t audio_format_id,
278 void *map, size_t mapsize, char **buf, size_t *len)
280 struct audio_format_handler *afh = afl + audio_format_id;
282 if (!map || !afhi || !afhi->header_len) {
287 if (!afh->get_header) {
288 *len = afhi->header_len;
292 afh->get_header(map, mapsize, buf, len);
296 * Deallocate any resources obtained from afh_get_header().
298 * \param header_buf Pointer obtained via afh_get_header().
299 * \param audio_format_id Determines the audio format handler.
301 void afh_free_header(char *header_buf, uint8_t audio_format_id)
303 struct audio_format_handler *afh = afl + audio_format_id;