1/**
2 * \file include/conf.h
3 * \brief Application interface library for the ALSA driver
4 * \author Jaroslav Kysela <perex@perex.cz>
5 * \author Abramo Bagnara <abramo@alsa-project.org>
6 * \author Takashi Iwai <tiwai@suse.de>
7 * \date 1998-2001
8 *
9 * Application interface library for the ALSA driver
10 */
11/*
12 * This library is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Lesser General Public License as
14 * published by the Free Software Foundation; either version 2.1 of
15 * the License, or (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Lesser General Public License for more details.
21 *
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this library; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 *
26 */
27
28#ifndef __ALSA_CONF_H
29#define __ALSA_CONF_H
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35/**
36 * \defgroup Config Configuration Interface
37 * The configuration functions and types allow you to read, enumerate,
38 * modify and write the contents of ALSA configuration files.
39 * \{
40 */
41
42/** \brief \c dlsym version for the config evaluate callback. */
43#define SND_CONFIG_DLSYM_VERSION_EVALUATE _dlsym_config_evaluate_001
44/** \brief \c dlsym version for the config hook callback. */
45#define SND_CONFIG_DLSYM_VERSION_HOOK _dlsym_config_hook_001
46
47/** \brief Configuration node type. */
48typedef enum _snd_config_type {
49 /** Integer number. */
50 SND_CONFIG_TYPE_INTEGER,
51 /** 64-bit integer number. */
52 SND_CONFIG_TYPE_INTEGER64,
53 /** Real number. */
54 SND_CONFIG_TYPE_REAL,
55 /** Character string. */
56 SND_CONFIG_TYPE_STRING,
57 /** Pointer (runtime only, cannot be saved). */
58 SND_CONFIG_TYPE_POINTER,
59 /** Compound node. */
60 SND_CONFIG_TYPE_COMPOUND = 1024
61} snd_config_type_t;
62
63/**
64 * \brief Internal structure for a configuration node object.
65 *
66 * The ALSA library uses a pointer to this structure as a handle to a
67 * configuration node. Applications don't access its contents directly.
68 */
69typedef struct _snd_config snd_config_t;
70/**
71 * \brief Type for a configuration compound iterator.
72 *
73 * The ALSA library uses this pointer type as a handle to a configuration
74 * compound iterator. Applications don't directly access the contents of
75 * the structure pointed to by this type.
76 */
77typedef struct _snd_config_iterator *snd_config_iterator_t;
78/**
79 * \brief Internal structure for a configuration private update object.
80 *
81 * The ALSA library uses this structure to save private update information.
82 */
83typedef struct _snd_config_update snd_config_update_t;
84
85extern snd_config_t *snd_config;
86
87int snd_config_top(snd_config_t **config);
88
89int snd_config_load(snd_config_t *config, snd_input_t *in);
90int snd_config_load_override(snd_config_t *config, snd_input_t *in);
91int snd_config_save(snd_config_t *config, snd_output_t *out);
92int snd_config_update(void);
93int snd_config_update_r(snd_config_t **top, snd_config_update_t **update, const char *path);
94int snd_config_update_free(snd_config_update_t *update);
95int snd_config_update_free_global(void);
96
97int snd_config_update_ref(snd_config_t **top);
98void snd_config_ref(snd_config_t *top);
99void snd_config_unref(snd_config_t *top);
100
101int snd_config_search(snd_config_t *config, const char *key,
102 snd_config_t **result);
103int snd_config_searchv(snd_config_t *config,
104 snd_config_t **result, ...);
105int snd_config_search_definition(snd_config_t *config,
106 const char *base, const char *key,
107 snd_config_t **result);
108
109int snd_config_expand(snd_config_t *config, snd_config_t *root,
110 const char *args, snd_config_t *private_data,
111 snd_config_t **result);
112int snd_config_evaluate(snd_config_t *config, snd_config_t *root,
113 snd_config_t *private_data, snd_config_t **result);
114
115int snd_config_add(snd_config_t *config, snd_config_t *leaf);
116int snd_config_delete(snd_config_t *config);
117int snd_config_delete_compound_members(const snd_config_t *config);
118int snd_config_copy(snd_config_t **dst, snd_config_t *src);
119
120int snd_config_make(snd_config_t **config, const char *key,
121 snd_config_type_t type);
122int snd_config_make_integer(snd_config_t **config, const char *key);
123int snd_config_make_integer64(snd_config_t **config, const char *key);
124int snd_config_make_real(snd_config_t **config, const char *key);
125int snd_config_make_string(snd_config_t **config, const char *key);
126int snd_config_make_pointer(snd_config_t **config, const char *key);
127int snd_config_make_compound(snd_config_t **config, const char *key, int join);
128
129int snd_config_imake_integer(snd_config_t **config, const char *key, const long value);
130int snd_config_imake_integer64(snd_config_t **config, const char *key, const long long value);
131int snd_config_imake_real(snd_config_t **config, const char *key, const double value);
132int snd_config_imake_string(snd_config_t **config, const char *key, const char *ascii);
133int snd_config_imake_safe_string(snd_config_t **config, const char *key, const char *ascii);
134int snd_config_imake_pointer(snd_config_t **config, const char *key, const void *ptr);
135
136snd_config_type_t snd_config_get_type(const snd_config_t *config);
137
138int snd_config_set_id(snd_config_t *config, const char *id);
139int snd_config_set_integer(snd_config_t *config, long value);
140int snd_config_set_integer64(snd_config_t *config, long long value);
141int snd_config_set_real(snd_config_t *config, double value);
142int snd_config_set_string(snd_config_t *config, const char *value);
143int snd_config_set_ascii(snd_config_t *config, const char *ascii);
144int snd_config_set_pointer(snd_config_t *config, const void *ptr);
145int snd_config_get_id(const snd_config_t *config, const char **value);
146int snd_config_get_integer(const snd_config_t *config, long *value);
147int snd_config_get_integer64(const snd_config_t *config, long long *value);
148int snd_config_get_real(const snd_config_t *config, double *value);
149int snd_config_get_ireal(const snd_config_t *config, double *value);
150int snd_config_get_string(const snd_config_t *config, const char **value);
151int snd_config_get_ascii(const snd_config_t *config, char **value);
152int snd_config_get_pointer(const snd_config_t *config, const void **value);
153int snd_config_test_id(const snd_config_t *config, const char *id);
154
155snd_config_iterator_t snd_config_iterator_first(const snd_config_t *node);
156snd_config_iterator_t snd_config_iterator_next(const snd_config_iterator_t iterator);
157snd_config_iterator_t snd_config_iterator_end(const snd_config_t *node);
158snd_config_t *snd_config_iterator_entry(const snd_config_iterator_t iterator);
159
160/**
161 * \brief Helper macro to iterate over the children of a compound node.
162 * \param[in,out] pos Iterator variable for the current node.
163 * \param[in,out] next Temporary iterator variable for the next node.
164 * \param[in] node Handle to the compound configuration node to iterate over.
165 *
166 * Use this macro like a \c for statement, e.g.:
167 * \code
168 * snd_config_iterator_t pos, next;
169 * snd_config_for_each(pos, next, node) {
170 * snd_config_t *entry = snd_config_iterator_entry(pos);
171 * ...
172 * }
173 * \endcode
174 *
175 * This macro allows deleting or removing the current node.
176 */
177#define snd_config_for_each(pos, next, node) \
178 for (pos = snd_config_iterator_first(node), next = snd_config_iterator_next(pos); pos != snd_config_iterator_end(node); pos = next, next = snd_config_iterator_next(pos))
179
180/* Misc functions */
181
182int snd_config_get_bool_ascii(const char *ascii);
183int snd_config_get_bool(const snd_config_t *conf);
184int snd_config_get_ctl_iface_ascii(const char *ascii);
185int snd_config_get_ctl_iface(const snd_config_t *conf);
186
187/* Names functions */
188
189/**
190 * Device-name list element
191 */
192typedef struct snd_devname snd_devname_t;
193
194/**
195 * Device-name list element (definition)
196 */
197struct snd_devname {
198 char *name; /**< Device name string */
199 char *comment; /**< Comments */
200 snd_devname_t *next; /**< Next pointer */
201};
202
203int snd_names_list(const char *iface, snd_devname_t **list);
204void snd_names_list_free(snd_devname_t *list);
205
206/** \} */
207
208#ifdef __cplusplus
209}
210#endif
211
212#endif /* __ALSA_CONF_H */
213