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 {
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);
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);
99 
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, ...);
109  const char *base, const char *key,
110  snd_config_t **result);
111 
122 typedef int (*snd_config_expand_fcn_t)(snd_config_t **dst, const char *s, void *private_data);
123 
125  snd_config_expand_fcn_t fcn, void *private_data,
126  snd_config_t **result);
127 int snd_config_expand(snd_config_t *config, snd_config_t *root,
128  const char *args, snd_config_t *private_data,
129  snd_config_t **result);
131  snd_config_t *private_data, snd_config_t **result);
132 int snd_config_evaluate_string(snd_config_t **dst, const char *s,
133  snd_config_expand_fcn_t fcn, void *private_data);
134 
135 int snd_config_add(snd_config_t *config, snd_config_t *child);
136 int snd_config_add_before(snd_config_t *before, snd_config_t *child);
138 int snd_config_remove(snd_config_t *config);
139 int snd_config_delete(snd_config_t *config);
141 int snd_config_copy(snd_config_t **dst, snd_config_t *src);
143 int snd_config_merge(snd_config_t *dst, snd_config_t *src, int override);
144 
145 int snd_config_make(snd_config_t **config, const char *key,
146  snd_config_type_t type);
147 int snd_config_make_integer(snd_config_t **config, const char *key);
148 int snd_config_make_integer64(snd_config_t **config, const char *key);
149 int snd_config_make_real(snd_config_t **config, const char *key);
150 int snd_config_make_string(snd_config_t **config, const char *key);
151 int snd_config_make_pointer(snd_config_t **config, const char *key);
152 int snd_config_make_compound(snd_config_t **config, const char *key, int join);
153 int snd_config_make_path(snd_config_t **config, snd_config_t *root, const char *key,
154  int join, int override);
155 
156 int snd_config_imake_integer(snd_config_t **config, const char *key, const long value);
157 int snd_config_imake_integer64(snd_config_t **config, const char *key, const long long value);
158 int snd_config_imake_real(snd_config_t **config, const char *key, const double value);
159 int snd_config_imake_string(snd_config_t **config, const char *key, const char *ascii);
160 int snd_config_imake_safe_string(snd_config_t **config, const char *key, const char *ascii);
161 int snd_config_imake_pointer(snd_config_t **config, const char *key, const void *ptr);
162 
164 int snd_config_is_array(const snd_config_t *config);
165 int snd_config_is_empty(const snd_config_t *config);
166 
167 int snd_config_set_id(snd_config_t *config, const char *id);
168 int snd_config_set_integer(snd_config_t *config, long value);
169 int snd_config_set_integer64(snd_config_t *config, long long value);
170 int snd_config_set_real(snd_config_t *config, double value);
171 int snd_config_set_string(snd_config_t *config, const char *value);
172 int snd_config_set_ascii(snd_config_t *config, const char *ascii);
173 int snd_config_set_pointer(snd_config_t *config, const void *ptr);
174 int snd_config_get_id(const snd_config_t *config, const char **value);
175 int snd_config_get_integer(const snd_config_t *config, long *value);
176 int snd_config_get_integer64(const snd_config_t *config, long long *value);
177 int snd_config_get_real(const snd_config_t *config, double *value);
178 int snd_config_get_ireal(const snd_config_t *config, double *value);
179 int snd_config_get_string(const snd_config_t *config, const char **value);
180 int snd_config_get_ascii(const snd_config_t *config, char **value);
181 int snd_config_get_pointer(const snd_config_t *config, const void **value);
182 int snd_config_test_id(const snd_config_t *config, const char *id);
183 
188 
206 #define snd_config_for_each(pos, next, node) \
207  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))
208 
209 /* Misc functions */
210 
211 int snd_config_get_bool_ascii(const char *ascii);
212 int snd_config_get_bool(const snd_config_t *conf);
213 int snd_config_get_card(const snd_config_t *conf);
214 int snd_config_get_ctl_iface_ascii(const char *ascii);
215 int snd_config_get_ctl_iface(const snd_config_t *conf);
216 
217 /* Names functions */
218 
222 typedef struct snd_devname snd_devname_t;
223 
227 struct snd_devname {
228  char *name;
229  char *comment;
230  snd_devname_t *next;
231 };
232 
233 int snd_names_list(const char *iface, snd_devname_t **list);
234 void snd_names_list_free(snd_devname_t *list);
235 
238 #ifdef __cplusplus
239 }
240 #endif
241 
242 #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:3073
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:2802
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:4514
int snd_config_substitute(snd_config_t *dst, snd_config_t *src)
Substitutes one configuration node to another.
Definition: conf.c:1730
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:2697
int snd_config_set_string(snd_config_t *config, const char *value)
Changes the value of a string configuration node.
Definition: conf.c:3042
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:4832
int snd_config_get_bool_ascii(const char *ascii)
Gets the boolean value from the given ASCII string.
Definition: confmisc.c:89
const char * snd_config_topdir(void)
Returns the default top-level config directory.
Definition: conf.c:598
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:5229
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:2113
int snd_config_delete(snd_config_t *config)
Frees a configuration node.
Definition: conf.c:2381
int snd_config_make_integer64(snd_config_t **config, const char *key)
Creates a 64-bit-integer configuration node.
Definition: conf.c:2533
int snd_config_make_compound(snd_config_t **config, const char *key, int join)
Creates an empty compound configuration node.
Definition: conf.c:2645
int snd_config_copy(snd_config_t **dst, snd_config_t *src)
Creates a copy of a configuration node.
Definition: conf.c:5014
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_load_string(snd_config_t **config, const char *s, size_t size)
Loads a configuration tree from a string.
Definition: conf.c:2076
int snd_config_add_before(snd_config_t *before, snd_config_t *child)
Adds a child before another child configuration node.
Definition: conf.c:2221
int snd_config_update(void)
Updates snd_config by rereading the global configuration files (if needed).
Definition: conf.c:4675
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:5653
int snd_config_set_real(snd_config_t *config, double value)
Changes the value of a real-number configuration node.
Definition: conf.c:3016
int snd_config_update_free_global(void)
Frees the global configuration tree in snd_config.
Definition: conf.c:4780
int snd_config_load(snd_config_t *config, snd_input_t *in)
Loads a configuration tree.
Definition: conf.c:2055
int snd_config_get_pointer(const snd_config_t *config, const void **value)
Returns the value of a pointer configuration node.
Definition: conf.c:3289
int snd_config_set_id(snd_config_t *config, const char *id)
Sets the id of a configuration node.
Definition: conf.c:1908
int snd_config_update_ref(snd_config_t **top)
Updates snd_config and takes its reference.
Definition: conf.c:4696
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_string(const snd_config_t *config, const char **value)
Returns the value of a string configuration node.
Definition: conf.c:3268
int snd_config_imake_safe_string(snd_config_t **config, const char *key, const char *ascii)
Creates a string configuration node with the given initial value.
Definition: conf.c:2900
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:2580
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:3942
snd_config_type_t snd_config_get_type(const snd_config_t *config)
Returns the type of a configuration node.
Definition: conf.c:1812
int snd_config_add(snd_config_t *config, snd_config_t *child)
Adds a child to a compound configuration node.
Definition: conf.c:2142
int snd_config_set_integer(snd_config_t *config, long value)
Changes the value of an integer configuration node.
Definition: conf.c:2973
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:5686
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:3233
int snd_config_searchv(snd_config_t *config, snd_config_t **result,...)
Searches for a node in a configuration tree.
Definition: conf.c:3718
int snd_config_make_integer(snd_config_t **config, const char *key)
Creates an integer configuration node.
Definition: conf.c:2508
int snd_config_merge(snd_config_t *dst, snd_config_t *src, int override)
In-place merge of two config handles.
Definition: conf.c:2290
int snd_config_make_real(snd_config_t **config, const char *key)
Creates a real number configuration node.
Definition: conf.c:2555
int snd_config_update_free(snd_config_update_t *update)
Frees a private update structure.
Definition: conf.c:4758
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_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:2829
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:3325
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:2859
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:4864
int snd_config_get_ctl_iface(const snd_config_t *conf)
Gets the control interface index from a configuration node.
Definition: confmisc.c:203
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:3627
int snd_config_get_integer(const snd_config_t *config, long *value)
Returns the value of an integer configuration node.
Definition: conf.c:3167
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:4850
int snd_config_set_ascii(snd_config_t *config, const char *ascii)
Changes the value of a configuration node.
Definition: conf.c:3107
int snd_config_is_empty(const snd_config_t *config)
Returns if the compound has no fields (is empty).
Definition: conf.c:1862
int snd_config_make(snd_config_t **config, const char *key, snd_config_type_t type)
Creates a configuration node.
Definition: conf.c:2474
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:2948
void snd_config_unref(snd_config_t *top)
Unreference the config tree.
Definition: conf.c:4745
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:4812
int snd_config_get_real(const snd_config_t *config, double *value)
Returns the value of a real-number configuration node.
Definition: conf.c:3210
int snd_config_remove(snd_config_t *config)
Removes a configuration node from its tree.
Definition: conf.c:2350
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:5768
int snd_config_add_after(snd_config_t *after, snd_config_t *child)
Adds a child after another child configuration node.
Definition: conf.c:2180
int snd_config_make_pointer(snd_config_t **config, const char *key)
Creates a pointer configuration node.
Definition: conf.c:2602
int snd_config_get_id(const snd_config_t *config, const char **value)
Returns the id of a configuration node.
Definition: conf.c:1886
int snd_config_is_array(const snd_config_t *config)
Returns if the compound is an array (and count of items).
Definition: conf.c:1838
int snd_config_get_bool(const snd_config_t *conf)
Gets the boolean value from a configuration node.
Definition: confmisc.c:117
void snd_config_ref(snd_config_t *top)
Take the reference of the config tree.
Definition: conf.c:4725
int snd_config_delete_compound_members(const snd_config_t *config)
Deletes the children of a node.
Definition: conf.c:2435
int(* snd_config_expand_fcn_t)(snd_config_t **dst, const char *s, void *private_data)
custom expansion callback
Definition: conf.h:122
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:3399
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:3190
int snd_config_top(snd_config_t **config)
Creates a top level configuration node.
Definition: conf.c:1950
int snd_config_save(snd_config_t *config, snd_output_t *out)
Dumps the contents of a configuration node or tree.
Definition: conf.c:3426
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:2996
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:2772
@ 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:56
struct _snd_output snd_output_t
Internal structure for an output object.
Definition: output.h:56
Definition: conf.h:227
char * comment
Definition: conf.h:229
snd_devname_t * next
Definition: conf.h:230
char * name
Definition: conf.h:228