conf.h
Go to the documentation of this file.
/*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef __ALSA_CONF_H
#define __ALSA_CONF_H
#ifdef __cplusplus
extern "C" {
#endif
#define SND_CONFIG_DLSYM_VERSION_EVALUATE _dlsym_config_evaluate_001
#define SND_CONFIG_DLSYM_VERSION_HOOK _dlsym_config_hook_001
typedef enum _snd_config_type {
SND_CONFIG_TYPE_INTEGER,
SND_CONFIG_TYPE_INTEGER64,
SND_CONFIG_TYPE_REAL,
SND_CONFIG_TYPE_STRING,
SND_CONFIG_TYPE_POINTER,
SND_CONFIG_TYPE_COMPOUND = 1024
} snd_config_type_t;
typedef struct _snd_config snd_config_t;
typedef struct _snd_config_iterator *snd_config_iterator_t;
typedef struct _snd_config_update snd_config_update_t;
extern snd_config_t *snd_config;
const char *snd_config_topdir(void);
int snd_config_top(snd_config_t **config);
int snd_config_load(snd_config_t *config, snd_input_t *in);
int snd_config_load_string(snd_config_t **config, const char *s, size_t size);
int snd_config_load_override(snd_config_t *config, snd_input_t *in);
int snd_config_save(snd_config_t *config, snd_output_t *out);
int snd_config_update(void);
int snd_config_update_r(snd_config_t **top, snd_config_update_t **update, const char *path);
int snd_config_update_free(snd_config_update_t *update);
int snd_config_update_free_global(void);
int snd_config_update_ref(snd_config_t **top);
void snd_config_ref(snd_config_t *top);
void snd_config_unref(snd_config_t *top);
int snd_config_search(snd_config_t *config, const char *key,
snd_config_t **result);
int snd_config_searchv(snd_config_t *config,
snd_config_t **result, ...);
int snd_config_search_definition(snd_config_t *config,
const char *base, const char *key,
snd_config_t **result);
typedef int (*snd_config_expand_fcn_t)(snd_config_t **dst, const char *s, void *private_data);
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);
int snd_config_expand(snd_config_t *config, snd_config_t *root,
const char *args, snd_config_t *private_data,
snd_config_t **result);
int snd_config_evaluate(snd_config_t *config, snd_config_t *root,
snd_config_t *private_data, snd_config_t **result);
int snd_config_evaluate_string(snd_config_t **dst, const char *s,
snd_config_expand_fcn_t fcn, void *private_data);
int snd_config_add(snd_config_t *config, snd_config_t *child);
int snd_config_add_before(snd_config_t *before, snd_config_t *child);
int snd_config_add_after(snd_config_t *after, snd_config_t *child);
int snd_config_remove(snd_config_t *config);
int snd_config_delete(snd_config_t *config);
int snd_config_delete_compound_members(const snd_config_t *config);
int snd_config_copy(snd_config_t **dst, snd_config_t *src);
int snd_config_merge(snd_config_t *dst, snd_config_t *src, int override);
int snd_config_make(snd_config_t **config, const char *key,
snd_config_type_t type);
int snd_config_make_integer(snd_config_t **config, const char *key);
int snd_config_make_integer64(snd_config_t **config, const char *key);
int snd_config_make_real(snd_config_t **config, const char *key);
int snd_config_make_string(snd_config_t **config, const char *key);
int snd_config_make_pointer(snd_config_t **config, const char *key);
int snd_config_make_compound(snd_config_t **config, const char *key, int join);
int snd_config_make_path(snd_config_t **config, snd_config_t *root, const char *key,
int join, int override);
int snd_config_imake_integer(snd_config_t **config, const char *key, const long value);
int snd_config_imake_integer64(snd_config_t **config, const char *key, const long long value);
int snd_config_imake_real(snd_config_t **config, const char *key, const double value);
int snd_config_imake_string(snd_config_t **config, const char *key, const char *ascii);
int snd_config_imake_safe_string(snd_config_t **config, const char *key, const char *ascii);
int snd_config_imake_pointer(snd_config_t **config, const char *key, const void *ptr);
snd_config_type_t snd_config_get_type(const snd_config_t *config);
int snd_config_is_array(const snd_config_t *config);
int snd_config_is_empty(const snd_config_t *config);
int snd_config_set_id(snd_config_t *config, const char *id);
int snd_config_set_integer(snd_config_t *config, long value);
int snd_config_set_integer64(snd_config_t *config, long long value);
int snd_config_set_real(snd_config_t *config, double value);
int snd_config_set_string(snd_config_t *config, const char *value);
int snd_config_set_ascii(snd_config_t *config, const char *ascii);
int snd_config_set_pointer(snd_config_t *config, const void *ptr);
int snd_config_get_id(const snd_config_t *config, const char **value);
int snd_config_get_integer(const snd_config_t *config, long *value);
int snd_config_get_integer64(const snd_config_t *config, long long *value);
int snd_config_get_real(const snd_config_t *config, double *value);
int snd_config_get_ireal(const snd_config_t *config, double *value);
int snd_config_get_string(const snd_config_t *config, const char **value);
int snd_config_get_ascii(const snd_config_t *config, char **value);
int snd_config_get_pointer(const snd_config_t *config, const void **value);
int snd_config_test_id(const snd_config_t *config, const char *id);
snd_config_iterator_t snd_config_iterator_first(const snd_config_t *node);
snd_config_iterator_t snd_config_iterator_next(const snd_config_iterator_t iterator);
snd_config_iterator_t snd_config_iterator_end(const snd_config_t *node);
snd_config_t *snd_config_iterator_entry(const snd_config_iterator_t iterator);
#define snd_config_for_each(pos, next, node) \
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))
/* Misc functions */
int snd_config_get_bool_ascii(const char *ascii);
int snd_config_get_bool(const snd_config_t *conf);
int snd_config_get_card(const snd_config_t *conf);
int snd_config_get_ctl_iface_ascii(const char *ascii);
int snd_config_get_ctl_iface(const snd_config_t *conf);
/* Names functions */
typedef struct snd_devname snd_devname_t;
struct snd_devname {
char *name;
char *comment;
snd_devname_t *next;
};
int snd_names_list(const char *iface, snd_devname_t **list);
void snd_names_list_free(snd_devname_t *list);
#ifdef __cplusplus
}
#endif
#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:3050
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:2799
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:4492
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:2694
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:3019
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:4810
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:5207
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:2110
snd_config_delete
int snd_config_delete(snd_config_t *config)
Frees a configuration node.
Definition: conf.c:2378
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:2530
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:2642
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:4992
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:2073
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:2218
snd_config_update
int snd_config_update(void)
Updates snd_config by rereading the global configuration files (if needed).
Definition: conf.c:4653
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:5631
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:2993
snd_config_update_free_global
int snd_config_update_free_global(void)
Frees the global configuration tree in snd_config.
Definition: conf.c:4758
snd_config_load
int snd_config_load(snd_config_t *config, snd_input_t *in)
Loads a configuration tree.
Definition: conf.c:2052
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:3266
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:1905
snd_config_update_ref
int snd_config_update_ref(snd_config_t **top)
Updates snd_config and takes its reference.
Definition: conf.c:4674
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:3245
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:2577
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:3920
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:1809
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:2139
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:2950
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:5664
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:3210
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:3695
snd_config_make_integer
int snd_config_make_integer(snd_config_t **config, const char *key)
Creates an integer configuration node.
Definition: conf.c:2505
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:2287
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:2552
snd_config_update_free
int snd_config_update_free(snd_config_update_t *update)
Frees a private update structure.
Definition: conf.c:4736
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:2826
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:3302
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:2856
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:4842
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:3604
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:3144
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:4828
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:3084
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:1859
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:2471
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:2925
snd_config_unref
void snd_config_unref(snd_config_t *top)
Unreference the config tree.
Definition: conf.c:4723
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:4790
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:3187
snd_config_remove
int snd_config_remove(snd_config_t *config)
Removes a configuration node from its tree.
Definition: conf.c:2347
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:5746
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:2177
snd_config_make_pointer
int snd_config_make_pointer(snd_config_t **config, const char *key)
Creates a pointer configuration node.
Definition: conf.c:2599
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:1883
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:1835
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:4703
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:2432
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:3376
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:3167
snd_config_top
int snd_config_top(snd_config_t **config)
Creates a top level configuration node.
Definition: conf.c:1947
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:3403
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:2973
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:2769
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:54
snd_output_t
struct _snd_output snd_output_t
Internal structure for an output object.
Definition: output.h:54
ptr
void * ptr
Definition: seq_event.h:1
snd_devname
Definition: conf.h:216
snd_devname::comment
char * comment
Definition: conf.h:218
snd_devname::next
snd_devname_t * next
Definition: conf.h:219
snd_devname::name
char * name
Definition: conf.h:217