ALSA project - the C library reference
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#ifndef __ALSA_CONF_H
29#define __ALSA_CONF_H
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
43#define SND_CONFIG_DLSYM_VERSION_EVALUATE _dlsym_config_evaluate_001
45#define SND_CONFIG_DLSYM_VERSION_HOOK _dlsym_config_hook_001
46
48typedef enum _snd_config_type {
62
69typedef struct _snd_config snd_config_t;
77typedef struct _snd_config_iterator *snd_config_iterator_t;
83typedef struct _snd_config_update snd_config_update_t;
84
86
87const char *snd_config_topdir(void);
88
89int snd_config_top(snd_config_t **config);
90
94int snd_config_update(void);
95int snd_config_update_r(snd_config_t **top, snd_config_update_t **update, const char *path);
98
102
103int snd_config_search(snd_config_t *config, const char *key,
104 snd_config_t **result);
106 snd_config_t **result, ...);
108 const char *base, const char *key,
109 snd_config_t **result);
110
112 const char *args, snd_config_t *private_data,
113 snd_config_t **result);
115 snd_config_t *private_data, snd_config_t **result);
116
117int snd_config_add(snd_config_t *config, snd_config_t *child);
124
125int snd_config_make(snd_config_t **config, const char *key,
126 snd_config_type_t type);
127int snd_config_make_integer(snd_config_t **config, const char *key);
128int snd_config_make_integer64(snd_config_t **config, const char *key);
129int snd_config_make_real(snd_config_t **config, const char *key);
130int snd_config_make_string(snd_config_t **config, const char *key);
131int snd_config_make_pointer(snd_config_t **config, const char *key);
132int snd_config_make_compound(snd_config_t **config, const char *key, int join);
133
134int snd_config_imake_integer(snd_config_t **config, const char *key, const long value);
135int snd_config_imake_integer64(snd_config_t **config, const char *key, const long long value);
136int snd_config_imake_real(snd_config_t **config, const char *key, const double value);
137int snd_config_imake_string(snd_config_t **config, const char *key, const char *ascii);
138int snd_config_imake_safe_string(snd_config_t **config, const char *key, const char *ascii);
139int snd_config_imake_pointer(snd_config_t **config, const char *key, const void *ptr);
140
142int snd_config_is_array(const snd_config_t *config);
143
144int snd_config_set_id(snd_config_t *config, const char *id);
145int snd_config_set_integer(snd_config_t *config, long value);
146int snd_config_set_integer64(snd_config_t *config, long long value);
147int snd_config_set_real(snd_config_t *config, double value);
148int snd_config_set_string(snd_config_t *config, const char *value);
149int snd_config_set_ascii(snd_config_t *config, const char *ascii);
150int snd_config_set_pointer(snd_config_t *config, const void *ptr);
151int snd_config_get_id(const snd_config_t *config, const char **value);
152int snd_config_get_integer(const snd_config_t *config, long *value);
153int snd_config_get_integer64(const snd_config_t *config, long long *value);
154int snd_config_get_real(const snd_config_t *config, double *value);
155int snd_config_get_ireal(const snd_config_t *config, double *value);
156int snd_config_get_string(const snd_config_t *config, const char **value);
157int snd_config_get_ascii(const snd_config_t *config, char **value);
158int snd_config_get_pointer(const snd_config_t *config, const void **value);
159int snd_config_test_id(const snd_config_t *config, const char *id);
160
165
183#define snd_config_for_each(pos, next, node) \
184 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))
185
186/* Misc functions */
187
188int snd_config_get_bool_ascii(const char *ascii);
189int snd_config_get_bool(const snd_config_t *conf);
190int snd_config_get_ctl_iface_ascii(const char *ascii);
192
193/* Names functions */
194
198typedef struct snd_devname snd_devname_t;
199
204 char *name;
205 char *comment;
206 snd_devname_t *next;
207};
208
209int snd_names_list(const char *iface, snd_devname_t **list);
210void snd_names_list_free(snd_devname_t *list);
211
214#ifdef __cplusplus
215}
216#endif
217
218#endif /* __ALSA_CONF_H */
int snd_config_set_pointer(snd_config_t *config, const void *ptr)
Changes the value of a pointer configuration node.
Definition: conf.c:2768
int snd_config_imake_integer64(snd_config_t **config, const char *key, const long long value)
Creates a 64-bit-integer configuration node with the given initial value.
Definition: conf.c:2517
int snd_config_update_r(snd_config_t **top, snd_config_update_t **update, const char *path)
Updates a configuration tree by rereading the configuration files (if needed).
Definition: conf.c:4055
int snd_config_set_string(snd_config_t *config, const char *value)
Changes the value of a string configuration node.
Definition: conf.c:2737
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:4373
int snd_config_get_bool_ascii(const char *ascii)
Gets the boolean value from the given ASCII string.
Definition: confmisc.c:88
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:4762
struct _snd_config snd_config_t
Internal structure for a configuration node object.
Definition: conf.h:69
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:2022
int snd_config_delete(snd_config_t *config)
Frees a configuration node.
Definition: conf.c:2193
int snd_config_make_integer64(snd_config_t **config, const char *key)
Creates a 64-bit-integer configuration node.
Definition: conf.c:2345
int snd_config_make_compound(snd_config_t **config, const char *key, int join)
Creates an empty compound configuration node.
Definition: conf.c:2457
int snd_config_copy(snd_config_t **dst, snd_config_t *src)
Creates a copy of a configuration node.
Definition: conf.c:4552
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:4405
int snd_config_add_before(snd_config_t *before, snd_config_t *child)
Adds a child before another child configuration node.
Definition: conf.c:2130
int snd_config_update(void)
Updates snd_config by rereading the global configuration files (if needed).
Definition: conf.c:4216
int snd_config_set_real(snd_config_t *config, double value)
Changes the value of a real-number configuration node.
Definition: conf.c:2711
int snd_config_update_free_global(void)
Frees the global configuration tree in snd_config.
Definition: conf.c:4321
int snd_config_load(snd_config_t *config, snd_input_t *in)
Loads a configuration tree.
Definition: conf.c:2007
int snd_config_get_pointer(const snd_config_t *config, const void **value)
Returns the value of a pointer configuration node.
Definition: conf.c:2984
int snd_config_set_id(snd_config_t *config, const char *id)
Sets the id of a configuration node.
Definition: conf.c:1863
int snd_config_update_ref(snd_config_t **top)
Updates snd_config and takes its reference.
Definition: conf.c:4237
int snd_config_get_ctl_iface_ascii(const char *ascii)
Gets the control interface index from the given ASCII string.
Definition: confmisc.c:150
int snd_config_get_string(const snd_config_t *config, const char **value)
Returns the value of a string configuration node.
Definition: conf.c:2963
void snd_names_list_free(snd_devname_t *list)
This function is unimplemented.
Definition: names.c:53
int snd_config_make_string(snd_config_t **config, const char *key)
Creates a string configuration node.
Definition: conf.c:2392
struct _snd_config_iterator * snd_config_iterator_t
Type for a configuration compound iterator.
Definition: conf.h:77
snd_config_t * snd_config
Configuration top-level node (the global configuration).
Definition: conf.c:3636
snd_config_type_t snd_config_get_type(const snd_config_t *config)
Returns the type of a configuration node.
Definition: conf.c:1781
int snd_config_add(snd_config_t *config, snd_config_t *child)
Adds a child to a compound configuration node.
Definition: conf.c:2051
int snd_config_set_integer(snd_config_t *config, long value)
Changes the value of an integer configuration node.
Definition: conf.c:2668
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:5179
int snd_config_get_ireal(const snd_config_t *config, double *value)
Returns the value of a real or integer configuration node.
Definition: conf.c:2928
int snd_config_searchv(snd_config_t *config, snd_config_t **result,...)
Searches for a node in a configuration tree.
Definition: conf.c:3411
int snd_config_make_integer(snd_config_t **config, const char *key)
Creates an integer configuration node.
Definition: conf.c:2320
int snd_config_make_real(snd_config_t **config, const char *key)
Creates a real number configuration node.
Definition: conf.c:2367
int snd_config_update_free(snd_config_update_t *update)
Frees a private update structure.
Definition: conf.c:4299
int snd_config_imake_real(snd_config_t **config, const char *key, const double value)
Creates a real number configuration node with the given initial value.
Definition: conf.c:2544
int snd_config_get_ascii(const snd_config_t *config, char **value)
Returns the value of a configuration node as a string.
Definition: conf.c:3020
snd_config_type_t
Configuration node type.
Definition: conf.h:48
int snd_config_imake_string(snd_config_t **config, const char *key, const char *ascii)
Creates a string configuration node with the given initial value.
Definition: conf.c:2574
int snd_config_get_ctl_iface(const snd_config_t *conf)
Gets the control interface index from a configuration node.
Definition: confmisc.c:173
struct _snd_config_update snd_config_update_t
Internal structure for a configuration private update object.
Definition: conf.h:83
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:3320
int snd_config_get_integer(const snd_config_t *config, long *value)
Returns the value of an integer configuration node.
Definition: conf.c:2862
snd_config_iterator_t snd_config_iterator_end(const snd_config_t *node)
Returns an iterator that ends a node's children list.
Definition: conf.c:4391
int snd_config_set_ascii(snd_config_t *config, const char *ascii)
Changes the value of a configuration node.
Definition: conf.c:2802
int snd_config_make(snd_config_t **config, const char *key, snd_config_type_t type)
Creates a configuration node.
Definition: conf.c:2286
int snd_config_imake_pointer(snd_config_t **config, const char *key, const void *ptr)
Creates a pointer configuration node with the given initial value.
Definition: conf.c:2643
void snd_config_unref(snd_config_t *top)
Unreference the config tree.
Definition: conf.c:4286
snd_config_iterator_t snd_config_iterator_first(const snd_config_t *node)
Returns an iterator pointing to a node's first child.
Definition: conf.c:4353
int snd_config_get_real(const snd_config_t *config, double *value)
Returns the value of a real-number configuration node.
Definition: conf.c:2905
int snd_config_remove(snd_config_t *config)
Removes a configuration node from its tree.
Definition: conf.c:2162
int snd_config_search_definition(snd_config_t *config, const char *base, const char *key, snd_config_t **result)
Searches for a definition in a configuration tree, using aliases and expanding hooks and arguments.
Definition: conf.c:5261
int snd_config_add_after(snd_config_t *after, snd_config_t *child)
Adds a child after another child configuration node.
Definition: conf.c:2089
int snd_config_make_pointer(snd_config_t **config, const char *key)
Creates a pointer configuration node.
Definition: conf.c:2414
int snd_config_get_id(const snd_config_t *config, const char **value)
Returns the id of a configuration node.
Definition: conf.c:1841
int snd_config_is_array(const snd_config_t *config)
Returns if the compound is an array.
Definition: conf.c:1806
int snd_config_get_bool(const snd_config_t *conf)
Gets the boolean value from a configuration node.
Definition: confmisc.c:116
void snd_config_ref(snd_config_t *top)
Take the reference of the config tree.
Definition: conf.c:4266
int snd_config_delete_compound_members(const snd_config_t *config)
Deletes the children of a node.
Definition: conf.c:2247
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:3094
int snd_names_list(const char *iface, snd_devname_t **list)
This function is unimplemented.
Definition: names.c:42
int snd_config_get_integer64(const snd_config_t *config, long long *value)
Returns the value of a 64-bit-integer configuration node.
Definition: conf.c:2885
int snd_config_top(snd_config_t **config)
Creates a top level configuration node.
Definition: conf.c:1905
int snd_config_save(snd_config_t *config, snd_output_t *out)
Dumps the contents of a configuration node or tree.
Definition: conf.c:3121
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:2691
int snd_config_imake_integer(snd_config_t **config, const char *key, const long value)
Creates an integer configuration node with the given initial value.
Definition: conf.c:2487
@ SND_CONFIG_TYPE_REAL
Definition: conf.h:54
@ SND_CONFIG_TYPE_INTEGER64
Definition: conf.h:52
@ SND_CONFIG_TYPE_COMPOUND
Definition: conf.h:60
@ SND_CONFIG_TYPE_STRING
Definition: conf.h:56
@ SND_CONFIG_TYPE_INTEGER
Definition: conf.h:50
@ SND_CONFIG_TYPE_POINTER
Definition: conf.h:58
struct _snd_input snd_input_t
Internal structure for an input object.
Definition: input.h:54
struct _snd_output snd_output_t
Internal structure for an output object.
Definition: output.h:54
void * ptr
Definition: seq_event.h:1
Definition: conf.h:203
char * comment
Definition: conf.h:205
snd_devname_t * next
Definition: conf.h:206
char * name
Definition: conf.h:204