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
32 extern "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
48 typedef enum _snd_config_type {
50 SND_CONFIG_TYPE_INTEGER,
52 SND_CONFIG_TYPE_INTEGER64,
54 SND_CONFIG_TYPE_REAL,
56 SND_CONFIG_TYPE_STRING,
58 SND_CONFIG_TYPE_POINTER,
60 SND_CONFIG_TYPE_COMPOUND = 1024
61} snd_config_type_t;
62
69 typedef struct _snd_config snd_config_t;
77 typedef struct _snd_config_iterator *snd_config_iterator_t;
83 typedef struct _snd_config_update snd_config_update_t;
84
85 extern snd_config_t *snd_config;
86
87 const char *snd_config_topdir(void);
88
89 int snd_config_top(snd_config_t **config);
90
91 int snd_config_load(snd_config_t *config, snd_input_t *in);
92 int snd_config_load_string(snd_config_t **config, const char *s, size_t size);
93 int snd_config_load_override(snd_config_t *config, snd_input_t *in);
94 int snd_config_save(snd_config_t *config, snd_output_t *out);
95 int snd_config_update(void);
96 int snd_config_update_r(snd_config_t **top, snd_config_update_t **update, const char *path);
97 int snd_config_update_free(snd_config_update_t *update);
98 int snd_config_update_free_global(void);
99
100 int snd_config_update_ref(snd_config_t **top);
101 void snd_config_ref(snd_config_t *top);
102 void snd_config_unref(snd_config_t *top);
103
104 int snd_config_search(snd_config_t *config, const char *key,
105 snd_config_t **result);
106 int snd_config_searchv(snd_config_t *config,
107 snd_config_t **result, ...);
108 int snd_config_search_definition(snd_config_t *config,
109 const char *base, const char *key,
110 snd_config_t **result);
111
112 typedef int (*snd_config_expand_fcn_t)(snd_config_t **dst, const char *s, void *private_data);
113
114 int snd_config_expand_custom(snd_config_t *config, snd_config_t *root,
115 snd_config_expand_fcn_t fcn, void *private_data,
116 snd_config_t **result);
117 int snd_config_expand(snd_config_t *config, snd_config_t *root,
118 const char *args, snd_config_t *private_data,
119 snd_config_t **result);
120 int snd_config_evaluate(snd_config_t *config, snd_config_t *root,
121 snd_config_t *private_data, snd_config_t **result);
122 int snd_config_evaluate_string(snd_config_t **dst, const char *s,
123 snd_config_expand_fcn_t fcn, void *private_data);
124
125 int snd_config_add(snd_config_t *config, snd_config_t *child);
126 int snd_config_add_before(snd_config_t *before, snd_config_t *child);
127 int snd_config_add_after(snd_config_t *after, snd_config_t *child);
128 int snd_config_remove(snd_config_t *config);
129 int snd_config_delete(snd_config_t *config);
130 int snd_config_delete_compound_members(const snd_config_t *config);
131 int snd_config_copy(snd_config_t **dst, snd_config_t *src);
132 int snd_config_substitute(snd_config_t *dst, snd_config_t *src);
133 int snd_config_merge(snd_config_t *dst, snd_config_t *src, int override);
134
135 int snd_config_make(snd_config_t **config, const char *key,
136 snd_config_type_t type);
137 int snd_config_make_integer(snd_config_t **config, const char *key);
138 int snd_config_make_integer64(snd_config_t **config, const char *key);
139 int snd_config_make_real(snd_config_t **config, const char *key);
140 int snd_config_make_string(snd_config_t **config, const char *key);
141 int snd_config_make_pointer(snd_config_t **config, const char *key);
142 int snd_config_make_compound(snd_config_t **config, const char *key, int join);
143 int snd_config_make_path(snd_config_t **config, snd_config_t *root, const char *key,
144 int join, int override);
145
146 int snd_config_imake_integer(snd_config_t **config, const char *key, const long value);
147 int snd_config_imake_integer64(snd_config_t **config, const char *key, const long long value);
148 int snd_config_imake_real(snd_config_t **config, const char *key, const double value);
149 int snd_config_imake_string(snd_config_t **config, const char *key, const char *ascii);
150 int snd_config_imake_safe_string(snd_config_t **config, const char *key, const char *ascii);
151 int snd_config_imake_pointer(snd_config_t **config, const char *key, const void *ptr);
152
153 snd_config_type_t snd_config_get_type(const snd_config_t *config);
154 int snd_config_is_array(const snd_config_t *config);
155 int snd_config_is_empty(const snd_config_t *config);
156
157 int snd_config_set_id(snd_config_t *config, const char *id);
158 int snd_config_set_integer(snd_config_t *config, long value);
159 int snd_config_set_integer64(snd_config_t *config, long long value);
160 int snd_config_set_real(snd_config_t *config, double value);
161 int snd_config_set_string(snd_config_t *config, const char *value);
162 int snd_config_set_ascii(snd_config_t *config, const char *ascii);
163 int snd_config_set_pointer(snd_config_t *config, const void *ptr);
164 int snd_config_get_id(const snd_config_t *config, const char **value);
165 int snd_config_get_integer(const snd_config_t *config, long *value);
166 int snd_config_get_integer64(const snd_config_t *config, long long *value);
167 int snd_config_get_real(const snd_config_t *config, double *value);
168 int snd_config_get_ireal(const snd_config_t *config, double *value);
169 int snd_config_get_string(const snd_config_t *config, const char **value);
170 int snd_config_get_ascii(const snd_config_t *config, char **value);
171 int snd_config_get_pointer(const snd_config_t *config, const void **value);
172 int snd_config_test_id(const snd_config_t *config, const char *id);
173
174 snd_config_iterator_t snd_config_iterator_first(const snd_config_t *node);
175 snd_config_iterator_t snd_config_iterator_next(const snd_config_iterator_t iterator);
176 snd_config_iterator_t snd_config_iterator_end(const snd_config_t *node);
177 snd_config_t *snd_config_iterator_entry(const snd_config_iterator_t iterator);
178
196#define snd_config_for_each(pos, next, node) \
197 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))
198
199/* Misc functions */
200
201 int snd_config_get_bool_ascii(const char *ascii);
202 int snd_config_get_bool(const snd_config_t *conf);
203 int snd_config_get_card(const snd_config_t *conf);
204 int snd_config_get_ctl_iface_ascii(const char *ascii);
205 int snd_config_get_ctl_iface(const snd_config_t *conf);
206
207/* Names functions */
208
212 typedef struct snd_devname snd_devname_t;
213
217 struct snd_devname {
218 char *name;
219 char *comment;
220 snd_devname_t *next;
221};
222
223 int snd_names_list(const char *iface, snd_devname_t **list);
224 void snd_names_list_free(snd_devname_t *list);
225
228#ifdef __cplusplus
229}
230#endif
231
232#endif /* __ALSA_CONF_H */
snd_config_set_pointer
int snd_config_set_pointer(snd_config_t *config, const void *ptr)
Changes the value of a pointer configuration node.
Definition: conf.c:3048
snd_config_imake_integer64
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:2797
snd_config_update_r
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:4490
snd_config_substitute
int snd_config_substitute(snd_config_t *dst, snd_config_t *src)
Substitutes one configuration node to another.
Definition: conf.c:1725
snd_config_make_path
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:2692
snd_config_set_string
int snd_config_set_string(snd_config_t *config, const char *value)
Changes the value of a string configuration node.
Definition: conf.c:3017
snd_config_iterator_next
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:4808
snd_config_get_bool_ascii
int snd_config_get_bool_ascii(const char *ascii)
Gets the boolean value from the given ASCII string.
Definition: confmisc.c:89
snd_config_evaluate
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:5205
snd_config_t
struct _snd_config snd_config_t
Internal structure for a configuration node object.
Definition: conf.h:69
snd_config_load_override
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:2108
snd_config_delete
int snd_config_delete(snd_config_t *config)
Frees a configuration node.
Definition: conf.c:2376
snd_config_make_integer64
int snd_config_make_integer64(snd_config_t **config, const char *key)
Creates a 64-bit-integer configuration node.
Definition: conf.c:2528
snd_config_make_compound
int snd_config_make_compound(snd_config_t **config, const char *key, int join)
Creates an empty compound configuration node.
Definition: conf.c:2640
snd_config_copy
int snd_config_copy(snd_config_t **dst, snd_config_t *src)
Creates a copy of a configuration node.
Definition: conf.c:4990
snd_config_iterator_entry
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:4840
snd_config_load_string
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:2071
snd_config_add_before
int snd_config_add_before(snd_config_t *before, snd_config_t *child)
Adds a child before another child configuration node.
Definition: conf.c:2216
snd_config_update
int snd_config_update(void)
Updates snd_config by rereading the global configuration files (if needed).
Definition: conf.c:4651
snd_config_expand_custom
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:5629
snd_config_set_real
int snd_config_set_real(snd_config_t *config, double value)
Changes the value of a real-number configuration node.
Definition: conf.c:2991
snd_config_update_free_global
int snd_config_update_free_global(void)
Frees the global configuration tree in snd_config.
Definition: conf.c:4756
snd_config_load
int snd_config_load(snd_config_t *config, snd_input_t *in)
Loads a configuration tree.
Definition: conf.c:2050
snd_config_get_pointer
int snd_config_get_pointer(const snd_config_t *config, const void **value)
Returns the value of a pointer configuration node.
Definition: conf.c:3264
snd_config_set_id
int snd_config_set_id(snd_config_t *config, const char *id)
Sets the id of a configuration node.
Definition: conf.c:1903
snd_config_update_ref
int snd_config_update_ref(snd_config_t **top)
Updates snd_config and takes its reference.
Definition: conf.c:4672
snd_config_get_ctl_iface_ascii
int snd_config_get_ctl_iface_ascii(const char *ascii)
Gets the control interface index from the given ASCII string.
Definition: confmisc.c:180
snd_config_get_string
int snd_config_get_string(const snd_config_t *config, const char **value)
Returns the value of a string configuration node.
Definition: conf.c:3243
snd_names_list_free
void snd_names_list_free(snd_devname_t *list)
This function is unimplemented.
Definition: names.c:53
snd_config_make_string
int snd_config_make_string(snd_config_t **config, const char *key)
Creates a string configuration node.
Definition: conf.c:2575
snd_config_iterator_t
struct _snd_config_iterator * snd_config_iterator_t
Type for a configuration compound iterator.
Definition: conf.h:77
snd_config
snd_config_t * snd_config
Configuration top-level node (the global configuration).
Definition: conf.c:3918
snd_config_get_type
snd_config_type_t snd_config_get_type(const snd_config_t *config)
Returns the type of a configuration node.
Definition: conf.c:1807
snd_config_add
int snd_config_add(snd_config_t *config, snd_config_t *child)
Adds a child to a compound configuration node.
Definition: conf.c:2137
snd_config_set_integer
int snd_config_set_integer(snd_config_t *config, long value)
Changes the value of an integer configuration node.
Definition: conf.c:2948
snd_config_expand
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:5662
snd_config_get_ireal
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:3208
snd_config_searchv
int snd_config_searchv(snd_config_t *config, snd_config_t **result,...)
Searches for a node in a configuration tree.
Definition: conf.c:3693
snd_config_make_integer
int snd_config_make_integer(snd_config_t **config, const char *key)
Creates an integer configuration node.
Definition: conf.c:2503
snd_config_merge
int snd_config_merge(snd_config_t *dst, snd_config_t *src, int override)
In-place merge of two config handles.
Definition: conf.c:2285
snd_config_make_real
int snd_config_make_real(snd_config_t **config, const char *key)
Creates a real number configuration node.
Definition: conf.c:2550
snd_config_update_free
int snd_config_update_free(snd_config_update_t *update)
Frees a private update structure.
Definition: conf.c:4734
snd_config_get_card
int snd_config_get_card(const snd_config_t *conf)
Gets the card number from a configuration node.
Definition: confmisc.c:151
snd_config_imake_real
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:2824
snd_config_get_ascii
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:3300
snd_config_type_t
snd_config_type_t
Configuration node type.
Definition: conf.h:48
snd_config_imake_string
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:2854
snd_config_get_ctl_iface
int snd_config_get_ctl_iface(const snd_config_t *conf)
Gets the control interface index from a configuration node.
Definition: confmisc.c:203
snd_config_update_t
struct _snd_config_update snd_config_update_t
Internal structure for a configuration private update object.
Definition: conf.h:83
snd_config_search
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:3602
snd_config_get_integer
int snd_config_get_integer(const snd_config_t *config, long *value)
Returns the value of an integer configuration node.
Definition: conf.c:3142
snd_config_iterator_end
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:4826
snd_config_set_ascii
int snd_config_set_ascii(snd_config_t *config, const char *ascii)
Changes the value of a configuration node.
Definition: conf.c:3082
snd_config_is_empty
int snd_config_is_empty(const snd_config_t *config)
Returns if the compound has no fields (is empty).
Definition: conf.c:1857
snd_config_make
int snd_config_make(snd_config_t **config, const char *key, snd_config_type_t type)
Creates a configuration node.
Definition: conf.c:2469
snd_config_imake_pointer
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:2923
snd_config_unref
void snd_config_unref(snd_config_t *top)
Unreference the config tree.
Definition: conf.c:4721
snd_config_iterator_first
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:4788
snd_config_get_real
int snd_config_get_real(const snd_config_t *config, double *value)
Returns the value of a real-number configuration node.
Definition: conf.c:3185
snd_config_remove
int snd_config_remove(snd_config_t *config)
Removes a configuration node from its tree.
Definition: conf.c:2345
snd_config_search_definition
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:5744
snd_config_add_after
int snd_config_add_after(snd_config_t *after, snd_config_t *child)
Adds a child after another child configuration node.
Definition: conf.c:2175
snd_config_make_pointer
int snd_config_make_pointer(snd_config_t **config, const char *key)
Creates a pointer configuration node.
Definition: conf.c:2597
snd_config_get_id
int snd_config_get_id(const snd_config_t *config, const char **value)
Returns the id of a configuration node.
Definition: conf.c:1881
snd_config_is_array
int snd_config_is_array(const snd_config_t *config)
Returns if the compound is an array (and count of items).
Definition: conf.c:1833
snd_config_get_bool
int snd_config_get_bool(const snd_config_t *conf)
Gets the boolean value from a configuration node.
Definition: confmisc.c:117
snd_config_ref
void snd_config_ref(snd_config_t *top)
Take the reference of the config tree.
Definition: conf.c:4701
snd_config_delete_compound_members
int snd_config_delete_compound_members(const snd_config_t *config)
Deletes the children of a node.
Definition: conf.c:2430
snd_config_test_id
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:3374
snd_names_list
int snd_names_list(const char *iface, snd_devname_t **list)
This function is unimplemented.
Definition: names.c:42
snd_config_get_integer64
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:3165
snd_config_top
int snd_config_top(snd_config_t **config)
Creates a top level configuration node.
Definition: conf.c:1945
snd_config_save
int snd_config_save(snd_config_t *config, snd_output_t *out)
Dumps the contents of a configuration node or tree.
Definition: conf.c:3401
snd_config_set_integer64
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:2971
snd_config_imake_integer
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:2767
SND_CONFIG_TYPE_REAL
@ SND_CONFIG_TYPE_REAL
Definition: conf.h:54
SND_CONFIG_TYPE_INTEGER64
@ SND_CONFIG_TYPE_INTEGER64
Definition: conf.h:52
SND_CONFIG_TYPE_COMPOUND
@ SND_CONFIG_TYPE_COMPOUND
Definition: conf.h:60
SND_CONFIG_TYPE_STRING
@ SND_CONFIG_TYPE_STRING
Definition: conf.h:56
SND_CONFIG_TYPE_INTEGER
@ SND_CONFIG_TYPE_INTEGER
Definition: conf.h:50
SND_CONFIG_TYPE_POINTER
@ SND_CONFIG_TYPE_POINTER
Definition: conf.h:58
snd_input_t
struct _snd_input snd_input_t
Internal structure for an input object.
Definition: input.h:56
snd_output_t
struct _snd_output snd_output_t
Internal structure for an output object.
Definition: output.h:56
ptr
void * ptr
Definition: seq_event.h:1
snd_devname
Definition: conf.h:217
snd_devname::comment
char * comment
Definition: conf.h:219
snd_devname::next
snd_devname_t * next
Definition: conf.h:220
snd_devname::name
char * name
Definition: conf.h:218