doxygen: add some missing docstrings.
[disorder] / lib / uaudio-apis.c
1 /*
2 * This file is part of DisOrder.
3 * Copyright (C) 2009 Richard Kettlewell
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 /** @file lib/uaudio-apis.c
20 * @brief Audio API list
21 */
22
23 #include "common.h"
24 #include "uaudio.h"
25 #include "log.h"
26
27 /** @brief List of known APIs
28 *
29 * Terminated by a null pointer.
30 *
31 * The first one will be used as a default, so putting ALSA before OSS
32 * constitutes a policy decision.
33 */
34 const struct uaudio *const uaudio_apis[] = {
35 #if HAVE_COREAUDIO_AUDIOHARDWARE_H
36 &uaudio_coreaudio,
37 #endif
38 #if HAVE_ALSA_ASOUNDLIB_H
39 &uaudio_alsa,
40 #endif
41 #if HAVE_SYS_SOUNDCARD_H || EMPEG_HOST
42 &uaudio_oss,
43 #endif
44 &uaudio_rtp,
45 &uaudio_command,
46 NULL,
47 };
48
49 /** @brief Look up an audio API by name */
50 const struct uaudio *uaudio_find(const char *name) {
51 int n;
52
53 for(n = 0; uaudio_apis[n]; ++n)
54 if(!strcmp(uaudio_apis[n]->name, name))
55 return uaudio_apis[n];
56 if(!strcmp(name, "network"))
57 return &uaudio_rtp;
58 disorder_fatal(0, "cannot find audio API '%s'", name);
59 }
60
61 /*
62 Local Variables:
63 c-basic-offset:2
64 comment-column:40
65 fill-column:79
66 indent-tabs-mode:nil
67 End:
68 */