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
44 
45 #define SND_CONFIG_DLSYM_VERSION_HOOK _dlsym_config_hook_001
46 
48 typedef enum _snd_config_type {
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);
93 int snd_config_save(snd_config_t *config, snd_output_t *out);
94 int snd_config_update(void);
95 int snd_config_update_r(snd_config_t **top, snd_config_update_t **update, const char *path);
98 
100 void snd_config_ref(snd_config_t *top);
101 void snd_config_unref(snd_config_t *top);
102 
103 int snd_config_search(snd_config_t *config, const char *key,
104  snd_config_t **result);
105 int snd_config_searchv(snd_config_t *config,
106  snd_config_t **result, ...);
108  const char *base, const char *key,
109  snd_config_t **result);
110 
111 int snd_config_expand(snd_config_t *config, snd_config_t *root,
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 
117 int snd_config_add(snd_config_t *config, snd_config_t *child);
118 int snd_config_add_before(snd_config_t *before, snd_config_t *child);
120 int snd_config_remove(snd_config_t *config);
121 int snd_config_delete(snd_config_t *config);
123 int snd_config_copy(snd_config_t **dst, snd_config_t *src);
124 
125 int snd_config_make(snd_config_t **config, const char *key,
126  snd_config_type_t type);
127 int snd_config_make_integer(snd_config_t **config, const char *key);
128 int snd_config_make_integer64(snd_config_t **config, const char *key);
129 int snd_config_make_real(snd_config_t **config, const char *key);
130 int snd_config_make_string(snd_config_t **config, const char *key);
131 int snd_config_make_pointer(snd_config_t **config, const char *key);
132 int snd_config_make_compound(snd_config_t **config, const char *key, int join);
133 
134 int snd_config_imake_integer(snd_config_t **config, const char *key, const long value);
135 int snd_config_imake_integer64(snd_config_t **config, const char *key, const long long value);
136 int snd_config_imake_real(snd_config_t **config, const char *key, const double value);
137 int snd_config_imake_string(snd_config_t **config, const char *key, const char *ascii);
138 int snd_config_imake_safe_string(snd_config_t **config, const char *key, const char *ascii);
139 int snd_config_imake_pointer(snd_config_t **config, const char *key, const void *ptr);
140 
141 snd_config_type_t snd_config_get_type(const snd_config_t *config);
142 
143 int snd_config_set_id(snd_config_t *config, const char *id);
144 int snd_config_set_integer(snd_config_t *config, long value);
145 int snd_config_set_integer64(snd_config_t *config, long long value);
146 int snd_config_set_real(snd_config_t *config, double value);
147 int snd_config_set_string(snd_config_t *config, const char *value);
148 int snd_config_set_ascii(snd_config_t *config, const char *ascii);
149 int snd_config_set_pointer(snd_config_t *config, const void *ptr);
150 int snd_config_get_id(const snd_config_t *config, const char **value);
151 int snd_config_get_integer(const snd_config_t *config, long *value);
152 int snd_config_get_integer64(const snd_config_t *config, long long *value);
153 int snd_config_get_real(const snd_config_t *config, double *value);
154 int snd_config_get_ireal(const snd_config_t *config, double *value);
155 int snd_config_get_string(const snd_config_t *config, const char **value);
156 int snd_config_get_ascii(const snd_config_t *config, char **value);
157 int snd_config_get_pointer(const snd_config_t *config, const void **value);
158 int snd_config_test_id(const snd_config_t *config, const char *id);
159 
164 
182 #define snd_config_for_each(pos, next, node) \
183  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))
184 
185 /* Misc functions */
186 
187 int snd_config_get_bool_ascii(const char *ascii);
188 int snd_config_get_bool(const snd_config_t *conf);
189 int snd_config_get_ctl_iface_ascii(const char *ascii);
190 int snd_config_get_ctl_iface(const snd_config_t *conf);
191 
192 /* Names functions */
193 
197 typedef struct snd_devname snd_devname_t;
198 
202 struct snd_devname {
203  char *name;
204  char *comment;
205  snd_devname_t *next;
206 };
207 
208 int snd_names_list(const char *iface, snd_devname_t **list);
209 void snd_names_list_free(snd_devname_t *list);
210 
213 #ifdef __cplusplus
214 }
215 #endif
216 
217 #endif /* __ALSA_CONF_H */
snd_config_update_free
int snd_config_update_free(snd_config_update_t *update)
Frees a private update structure.
Definition: conf.c:4260
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:1802
snd_config_load
int snd_config_load(snd_config_t *config, snd_input_t *in)
Loads a configuration tree.
Definition: conf.c:1968
snd_config_make_integer
int snd_config_make_integer(snd_config_t **config, const char *key)
Creates an integer configuration node.
Definition: conf.c:2281
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:2478
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:2247
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_integer
int snd_config_get_integer(const snd_config_t *config, long *value)
Returns the value of an integer configuration node.
Definition: conf.c:2823
snd_config_make_string
int snd_config_make_string(snd_config_t **config, const char *key)
Creates a string configuration node.
Definition: conf.c:2353
snd_devname::comment
char * comment
Definition: conf.h:204
SND_CONFIG_TYPE_POINTER
@ SND_CONFIG_TYPE_POINTER
Definition: conf.h:58
snd_config_remove
int snd_config_remove(snd_config_t *config)
Removes a configuration node from its tree.
Definition: conf.c:2123
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:2652
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_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:1983
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:2604
snd_config_ref
void snd_config_ref(snd_config_t *top)
Take the reference of the config tree.
Definition: conf.c:4227
snd_config_unref
void snd_config_unref(snd_config_t *top)
Unreference the config tree.
Definition: conf.c:4247
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:4352
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:2729
snd_devname::name
char * name
Definition: conf.h:203
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:2328
snd_config_t
struct _snd_config snd_config_t
Internal structure for a configuration node object.
Definition: conf.h:69
snd_output_t
struct _snd_output snd_output_t
Internal structure for an output object.
Definition: output.h:54
snd_config_update
int snd_config_update(void)
Updates snd_config by rereading the global configuration files (if needed).
Definition: conf.c:4177
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:2012
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:2306
SND_CONFIG_TYPE_INTEGER64
@ SND_CONFIG_TYPE_INTEGER64
Definition: conf.h:52
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:2945
snd_config
snd_config_t * snd_config
Configuration top-level node (the global configuration).
Definition: conf.c:3597
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:3082
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:3281
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:5140
SND_CONFIG_TYPE_COMPOUND
@ SND_CONFIG_TYPE_COMPOUND
Definition: conf.h:60
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:2846
snd_input_t
struct _snd_input snd_input_t
Internal structure for an input object.
Definition: input.h:54
snd_config_delete
int snd_config_delete(snd_config_t *config)
Frees a configuration node.
Definition: conf.c:2154
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:2924
snd_config_make_pointer
int snd_config_make_pointer(snd_config_t **config, const char *key)
Creates a pointer configuration node.
Definition: conf.c:2375
snd_config_iterator_t
struct _snd_config_iterator * snd_config_iterator_t
Type for a configuration compound iterator.
Definition: conf.h:77
snd_config_update_free_global
int snd_config_update_free_global(void)
Frees the global configuration tree in snd_config.
Definition: conf.c:4282
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:1781
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:150
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:2091
SND_CONFIG_TYPE_STRING
@ SND_CONFIG_TYPE_STRING
Definition: conf.h:56
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:3055
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:4016
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:173
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:2889
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:2763
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:2672
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:2505
ptr
void * ptr
Definition: seq_event.h:199
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:2448
snd_config_update_ref
int snd_config_update_ref(snd_config_t **top)
Updates snd_config and takes its reference.
Definition: conf.c:4198
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:2208
snd_devname
Definition: conf.h:202
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:4314
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:2535
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:4723
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:1824
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:2698
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:2050
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:2981
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:2418
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:5222
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:4513
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:116
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:2629
snd_names_list_free
void snd_names_list_free(snd_devname_t *list)
This function is unimplemented.
Definition: names.c:53
snd_devname::next
snd_devname_t * next
Definition: conf.h:205
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:88
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:4334
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:3372
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:4366
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:2866
_snd_config_type
_snd_config_type
Configuration node type.
Definition: conf.h:48
SND_CONFIG_TYPE_INTEGER
@ SND_CONFIG_TYPE_INTEGER
Definition: conf.h:50
SND_CONFIG_TYPE_REAL
@ SND_CONFIG_TYPE_REAL
Definition: conf.h:54
snd_config_top
int snd_config_top(snd_config_t **config)
Creates a top level configuration node.
Definition: conf.c:1866