ALSA project - the C library reference
Loading...
Searching...
No Matches
conf.h
Go to the documentation of this file.
1
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 *
26 */
27
28#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
29/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
30#include <alsa/asoundlib.h>
31#endif
32
33#ifndef __ALSA_CONF_H
34#define __ALSA_CONF_H
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
48#define SND_CONFIG_DLSYM_VERSION_EVALUATE _dlsym_config_evaluate_001
50#define SND_CONFIG_DLSYM_VERSION_HOOK _dlsym_config_hook_001
51
53typedef enum _snd_config_type {
55 SND_CONFIG_TYPE_INTEGER,
57 SND_CONFIG_TYPE_INTEGER64,
59 SND_CONFIG_TYPE_REAL,
61 SND_CONFIG_TYPE_STRING,
63 SND_CONFIG_TYPE_POINTER,
65 SND_CONFIG_TYPE_COMPOUND = 1024
66} snd_config_type_t;
67
74typedef struct _snd_config snd_config_t;
82typedef struct _snd_config_iterator *snd_config_iterator_t;
88typedef struct _snd_config_update snd_config_update_t;
89
90extern snd_config_t *snd_config;
91
92const char *snd_config_topdir(void);
93
94int snd_config_top(snd_config_t **config);
95
96int snd_config_load(snd_config_t *config, snd_input_t *in);
97int snd_config_load_string(snd_config_t **config, const char *s, size_t size);
98int snd_config_load_override(snd_config_t *config, snd_input_t *in);
99int snd_config_save(snd_config_t *config, snd_output_t *out);
100int snd_config_update(void);
101int snd_config_update_r(snd_config_t **top, snd_config_update_t **update, const char *path);
102int snd_config_update_free(snd_config_update_t *update);
104
105int snd_config_update_ref(snd_config_t **top);
106void snd_config_ref(snd_config_t *top);
107void snd_config_unref(snd_config_t *top);
108
109int snd_config_search(snd_config_t *config, const char *key,
110 snd_config_t **result);
111int snd_config_searchv(snd_config_t *config,
112 snd_config_t **result, ...);
113int snd_config_search_definition(snd_config_t *config,
114 const char *base, const char *key,
115 snd_config_t **result);
116
127typedef int (*snd_config_expand_fcn_t)(snd_config_t **dst, const char *s, void *private_data);
128
129int snd_config_expand_custom(snd_config_t *config, snd_config_t *root,
130 snd_config_expand_fcn_t fcn, void *private_data,
131 snd_config_t **result);
132int snd_config_expand(snd_config_t *config, snd_config_t *root,
133 const char *args, snd_config_t *private_data,
134 snd_config_t **result);
135int snd_config_evaluate(snd_config_t *config, snd_config_t *root,
136 snd_config_t *private_data, snd_config_t **result);
137int snd_config_evaluate_string(snd_config_t **dst, const char *s,
138 snd_config_expand_fcn_t fcn, void *private_data);
139
140int snd_config_add(snd_config_t *config, snd_config_t *child);
141int snd_config_add_before(snd_config_t *before, snd_config_t *child);
142int snd_config_add_after(snd_config_t *after, snd_config_t *child);
143int snd_config_remove(snd_config_t *config);
144int snd_config_delete(snd_config_t *config);
145int snd_config_delete_compound_members(const snd_config_t *config);
146int snd_config_copy(snd_config_t **dst, snd_config_t *src);
147int snd_config_substitute(snd_config_t *dst, snd_config_t *src);
148int snd_config_merge(snd_config_t *dst, snd_config_t *src, int override);
149
150int snd_config_make(snd_config_t **config, const char *key,
151 snd_config_type_t type);
152int snd_config_make_integer(snd_config_t **config, const char *key);
153int snd_config_make_integer64(snd_config_t **config, const char *key);
154int snd_config_make_real(snd_config_t **config, const char *key);
155int snd_config_make_string(snd_config_t **config, const char *key);
156int snd_config_make_pointer(snd_config_t **config, const char *key);
157int snd_config_make_compound(snd_config_t **config, const char *key, int join);
158int snd_config_make_path(snd_config_t **config, snd_config_t *root, const char *key,
159 int join, int override);
160
161int snd_config_imake_integer(snd_config_t **config, const char *key, const long value);
162int snd_config_imake_integer64(snd_config_t **config, const char *key, const long long value);
163int snd_config_imake_real(snd_config_t **config, const char *key, const double value);
164int snd_config_imake_string(snd_config_t **config, const char *key, const char *ascii);
165int snd_config_imake_safe_string(snd_config_t **config, const char *key, const char *ascii);
166int snd_config_imake_pointer(snd_config_t **config, const char *key, const void *ptr);
167
168snd_config_type_t snd_config_get_type(const snd_config_t *config);
169int snd_config_is_array(const snd_config_t *config);
170int snd_config_is_empty(const snd_config_t *config);
171
172int snd_config_set_id(snd_config_t *config, const char *id);
173int snd_config_set_integer(snd_config_t *config, long value);
174int snd_config_set_integer64(snd_config_t *config, long long value);
175int snd_config_set_real(snd_config_t *config, double value);
176int snd_config_set_string(snd_config_t *config, const char *value);
177int snd_config_set_ascii(snd_config_t *config, const char *ascii);
178int snd_config_set_pointer(snd_config_t *config, const void *ptr);
179int snd_config_get_id(const snd_config_t *config, const char **value);
180int snd_config_get_integer(const snd_config_t *config, long *value);
181int snd_config_get_integer64(const snd_config_t *config, long long *value);
182int snd_config_get_real(const snd_config_t *config, double *value);
183int snd_config_get_ireal(const snd_config_t *config, double *value);
184int snd_config_get_string(const snd_config_t *config, const char **value);
185int snd_config_get_ascii(const snd_config_t *config, char **value);
186int snd_config_get_pointer(const snd_config_t *config, const void **value);
187int snd_config_test_id(const snd_config_t *config, const char *id);
188
189snd_config_iterator_t snd_config_iterator_first(const snd_config_t *node);
190snd_config_iterator_t snd_config_iterator_next(const snd_config_iterator_t iterator);
191snd_config_iterator_t snd_config_iterator_end(const snd_config_t *node);
192snd_config_t *snd_config_iterator_entry(const snd_config_iterator_t iterator);
193
211#define snd_config_for_each(pos, next, node) \
212 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))
213
214/* Misc functions */
215
216int snd_config_get_bool_ascii(const char *ascii);
217int snd_config_get_bool(const snd_config_t *conf);
218int snd_config_get_card(const snd_config_t *conf);
219int snd_config_get_ctl_iface_ascii(const char *ascii);
220int snd_config_get_ctl_iface(const snd_config_t *conf);
221
222/* Names functions */
223
227typedef struct snd_devname snd_devname_t;
228
232struct snd_devname {
233 char *name;
234 char *comment;
235 snd_devname_t *next;
236};
237
238int snd_names_list(const char *iface, snd_devname_t **list);
239void snd_names_list_free(snd_devname_t *list);
240
243#ifdef __cplusplus
244}
245#endif
246
247#endif /* __ALSA_CONF_H */
int snd_config_make_integer(snd_config_t **config, const char *id)
Creates an integer configuration node.
Definition conf.c:2506
int snd_config_substitute(snd_config_t *dst, snd_config_t *src)
Substitutes one configuration node to another.
Definition conf.c:1727
int snd_config_get_ascii(const snd_config_t *config, char **ascii)
Returns the value of a configuration node as a string.
Definition conf.c:3323
int snd_config_make_path(snd_config_t **config, snd_config_t *root, const char *key, int join, int override)
Creates an empty compound configuration node in the path.
Definition conf.c:2695
int snd_config_set_string(snd_config_t *config, const char *value)
Changes the value of a string configuration node.
Definition conf.c:3040
snd_config_iterator_t snd_config_iterator_next(const snd_config_iterator_t iterator)
Returns an iterator pointing to the next sibling.
Definition conf.c:4830
int snd_config_evaluate(snd_config_t *config, snd_config_t *root, snd_config_t *private_data, snd_config_t **result)
Evaluates a configuration node at runtime.
Definition conf.c:5227
int snd_config_load_override(snd_config_t *config, snd_input_t *in)
Loads a configuration tree and overrides existing configuration nodes.
Definition conf.c:2112
int snd_config_delete(snd_config_t *config)
Frees a configuration node.
Definition conf.c:2379
snd_config_iterator_t snd_config_iterator_first(const snd_config_t *config)
Returns an iterator pointing to a node's first child.
Definition conf.c:4810
int snd_config_copy(snd_config_t **dst, snd_config_t *src)
Creates a copy of a configuration node.
Definition conf.c:5012
int snd_config_imake_integer(snd_config_t **config, const char *id, const long value)
Creates an integer configuration node with the given initial value.
Definition conf.c:2770
snd_config_t * snd_config_iterator_entry(const snd_config_iterator_t iterator)
Returns the configuration node handle pointed to by an iterator.
Definition conf.c:4862
int snd_config_search_definition(snd_config_t *config, const char *base, const char *name, snd_config_t **result)
Searches for a definition in a configuration tree, using aliases and expanding hooks and arguments.
Definition conf.c:5766
int snd_config_load_string(snd_config_t **config, const char *s, size_t size)
Loads a configuration tree from a string.
Definition conf.c:2075
int snd_config_add_before(snd_config_t *before, snd_config_t *child)
Adds a child before another child configuration node.
Definition conf.c:2220
int snd_config_update(void)
Updates snd_config by rereading the global configuration files (if needed).
Definition conf.c:4673
int snd_config_expand_custom(snd_config_t *config, snd_config_t *root, snd_config_expand_fcn_t fcn, void *private_data, snd_config_t **result)
Expands a configuration node, applying arguments and functions.
Definition conf.c:5651
int snd_config_imake_safe_string(snd_config_t **config, const char *id, const char *value)
Creates a string configuration node with the given initial value.
Definition conf.c:2898
int snd_config_set_real(snd_config_t *config, double value)
Changes the value of a real-number configuration node.
Definition conf.c:3014
int snd_config_get_real(const snd_config_t *config, double *ptr)
Returns the value of a real-number configuration node.
Definition conf.c:3208
int snd_config_get_ireal(const snd_config_t *config, double *ptr)
Returns the value of a real or integer configuration node.
Definition conf.c:3231
int snd_config_update_free_global(void)
Frees the global configuration tree in snd_config.
Definition conf.c:4778
int snd_config_load(snd_config_t *config, snd_input_t *in)
Loads a configuration tree.
Definition conf.c:2054
int snd_config_set_id(snd_config_t *config, const char *id)
Sets the id of a configuration node.
Definition conf.c:1907
int snd_config_update_ref(snd_config_t **top)
Updates snd_config and takes its reference.
Definition conf.c:4694
const char * snd_config_topdir(void)
Returns the default top-level config directory.
Definition conf.c:595
int snd_config_make_pointer(snd_config_t **config, const char *id)
Creates a pointer configuration node.
Definition conf.c:2600
snd_config_iterator_t snd_config_iterator_end(const snd_config_t *config)
Returns an iterator that ends a node's children list.
Definition conf.c:4848
snd_config_t * snd_config
Configuration top-level node (the global configuration).
Definition conf.c:3940
int snd_config_get_integer(const snd_config_t *config, long *ptr)
Returns the value of an integer configuration node.
Definition conf.c:3165
snd_config_type_t snd_config_get_type(const snd_config_t *config)
Returns the type of a configuration node.
Definition conf.c:1811
int snd_config_set_integer(snd_config_t *config, long value)
Changes the value of an integer configuration node.
Definition conf.c:2971
int snd_config_expand(snd_config_t *config, snd_config_t *root, const char *args, snd_config_t *private_data, snd_config_t **result)
Expands a configuration node, applying arguments and functions.
Definition conf.c:5684
int snd_config_searchv(snd_config_t *config, snd_config_t **result,...)
Searches for a node in a configuration tree.
Definition conf.c:3716
int snd_config_imake_pointer(snd_config_t **config, const char *id, const void *value)
Creates a pointer configuration node with the given initial value.
Definition conf.c:2946
int snd_config_get_pointer(const snd_config_t *config, const void **ptr)
Returns the value of a pointer configuration node.
Definition conf.c:3287
int snd_config_merge(snd_config_t *dst, snd_config_t *src, int override)
In-place merge of two config handles.
Definition conf.c:2289
void snd_config_ref(snd_config_t *cfg)
Take the reference of the config tree.
Definition conf.c:4723
int snd_config_make_compound(snd_config_t **config, const char *id, int join)
Creates an empty compound configuration node.
Definition conf.c:2643
int snd_config_update_free(snd_config_update_t *update)
Frees a private update structure.
Definition conf.c:4756
int snd_config_add(snd_config_t *parent, snd_config_t *child)
Adds a child to a compound configuration node.
Definition conf.c:2141
int snd_config_update_r(snd_config_t **_top, snd_config_update_t **_update, const char *cfgs)
Updates a configuration tree by rereading the configuration files (if needed).
Definition conf.c:4512
int snd_config_imake_real(snd_config_t **config, const char *id, const double value)
Creates a real number configuration node with the given initial value.
Definition conf.c:2827
int snd_config_imake_string(snd_config_t **config, const char *id, const char *value)
Creates a string configuration node with the given initial value.
Definition conf.c:2857
int snd_config_search(snd_config_t *config, const char *key, snd_config_t **result)
Searches for a node in a configuration tree.
Definition conf.c:3625
int snd_config_set_ascii(snd_config_t *config, const char *ascii)
Changes the value of a configuration node.
Definition conf.c:3105
int snd_config_make_string(snd_config_t **config, const char *id)
Creates a string configuration node.
Definition conf.c:2578
int snd_config_is_empty(const snd_config_t *config)
Returns if the compound has no fields (is empty).
Definition conf.c:1861
int snd_config_imake_integer64(snd_config_t **config, const char *id, const long long value)
Creates a 64-bit-integer configuration node with the given initial value.
Definition conf.c:2800
int snd_config_get_string(const snd_config_t *config, const char **ptr)
Returns the value of a string configuration node.
Definition conf.c:3266
void snd_config_unref(snd_config_t *cfg)
Unreference the config tree.
Definition conf.c:4743
int snd_config_remove(snd_config_t *config)
Removes a configuration node from its tree.
Definition conf.c:2348
int snd_config_make(snd_config_t **config, const char *id, snd_config_type_t type)
Creates a configuration node.
Definition conf.c:2472
int snd_config_make_integer64(snd_config_t **config, const char *id)
Creates a 64-bit-integer configuration node.
Definition conf.c:2531
int snd_config_add_after(snd_config_t *after, snd_config_t *child)
Adds a child after another child configuration node.
Definition conf.c:2179
int snd_config_get_integer64(const snd_config_t *config, long long *ptr)
Returns the value of a 64-bit-integer configuration node.
Definition conf.c:3188
int snd_config_is_array(const snd_config_t *config)
Returns if the compound is an array (and count of items).
Definition conf.c:1837
int snd_config_make_real(snd_config_t **config, const char *id)
Creates a real number configuration node.
Definition conf.c:2553
int snd_config_get_id(const snd_config_t *config, const char **id)
Returns the id of a configuration node.
Definition conf.c:1885
int snd_config_set_pointer(snd_config_t *config, const void *value)
Changes the value of a pointer configuration node.
Definition conf.c:3071
int snd_config_delete_compound_members(const snd_config_t *config)
Deletes the children of a node.
Definition conf.c:2433
int snd_config_test_id(const snd_config_t *config, const char *id)
Compares the id of a configuration node to a given string.
Definition conf.c:3397
int snd_config_top(snd_config_t **config)
Creates a top level configuration node.
Definition conf.c:1949
int snd_config_save(snd_config_t *config, snd_output_t *out)
Dumps the contents of a configuration node or tree.
Definition conf.c:3424
int snd_config_set_integer64(snd_config_t *config, long long value)
Changes the value of a 64-bit-integer configuration node.
Definition conf.c:2994
int snd_config_evaluate_string(snd_config_t **dst, const char *s, snd_config_expand_fcn_t fcn, void *private_data)
Evaluate an math expression in the string.
Definition confeval.c:261
int snd_config_get_bool_ascii(const char *ascii)
Gets the boolean value from the given ASCII string.
Definition confmisc.c:89
int snd_config_get_ctl_iface_ascii(const char *ascii)
Gets the control interface index from the given ASCII string.
Definition confmisc.c:180
int snd_config_get_card(const snd_config_t *conf)
Gets the card number from a configuration node.
Definition confmisc.c:151
int snd_config_get_ctl_iface(const snd_config_t *conf)
Gets the control interface index from a configuration node.
Definition confmisc.c:203
int snd_config_get_bool(const snd_config_t *conf)
Gets the boolean value from a configuration node.
Definition confmisc.c:117
void snd_names_list_free(snd_devname_t *list)
This function is unimplemented.
Definition names.c:53
int snd_names_list(const char *iface, snd_devname_t **list)
This function is unimplemented.
Definition names.c:42