1#ifndef foomodargshfoo
2#define foomodargshfoo
3
4/***
5  This file is part of PulseAudio.
6
7  Copyright 2004-2006 Lennart Poettering
8
9  PulseAudio is free software; you can redistribute it and/or modify
10  it under the terms of the GNU Lesser General Public License as published
11  by the Free Software Foundation; either version 2.1 of the License,
12  or (at your option) any later version.
13
14  PulseAudio is distributed in the hope that it will be useful, but
15  WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  General Public License for more details.
18
19  You should have received a copy of the GNU Lesser General Public License
20  along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
21***/
22
23#include <inttypes.h>
24#include <pulse/sample.h>
25#include <pulse/channelmap.h>
26#include <pulse/proplist.h>
27#include <pulse/volume.h>
28#include <pulsecore/macro.h>
29#include <pulsecore/resampler.h>
30
31typedef struct pa_modargs pa_modargs;
32
33/* A generic parser for module arguments */
34
35/* Parse the string args. The NULL-terminated array keys contains all valid arguments. */
36pa_modargs *pa_modargs_new(const char *args, const char* const keys[]);
37/* Parse the string args, and add any keys that are not already present. */
38int pa_modargs_append(pa_modargs *ma, const char *args, const char* const* valid_keys);
39void pa_modargs_free(pa_modargs*ma);
40
41/* Return the module argument for the specified name as a string. If
42 * the argument was not specified, return def instead.*/
43const char *pa_modargs_get_value(pa_modargs *ma, const char *key, const char *def);
44
45/* Return a module argument as unsigned 32bit value in *value. If the argument
46 * was not specified, *value remains unchanged. */
47int pa_modargs_get_value_u32(pa_modargs *ma, const char *key, uint32_t *value);
48int pa_modargs_get_value_s32(pa_modargs *ma, const char *key, int32_t *value);
49int pa_modargs_get_value_boolean(pa_modargs *ma, const char *key, bool *value);
50
51/* Return a module argument as double value in *value. If the argument was not
52 * specified, *value remains unchanged. */
53int pa_modargs_get_value_double(pa_modargs *ma, const char *key, double *value);
54
55/* Return a module argument as pa_volume_t value in *value. If the argument
56 * was not specified, *value remains unchanged. */
57int pa_modargs_get_value_volume(pa_modargs *ma, const char *key, pa_volume_t *value);
58
59/* Return sample rate from the "rate" argument. If the argument was not
60 * specified, *rate remains unchanged. */
61int pa_modargs_get_sample_rate(pa_modargs *ma, uint32_t *rate);
62
63/* Return sample spec data from the three arguments "rate", "format" and
64 * "channels". If the argument was not specified, *ss remains unchanged. */
65int pa_modargs_get_sample_spec(pa_modargs *ma, pa_sample_spec *ss);
66
67/* Return channel map data from the argument "channel_map" if name is NULL,
68 * otherwise read from the specified argument. If the argument was not
69 * specified, *map remains unchanged. */
70int pa_modargs_get_channel_map(pa_modargs *ma, const char *name, pa_channel_map *map);
71
72/* Return resample method from the argument "resample_method". If the argument
73 * was not specified, *method remains unchanged. */
74int pa_modargs_get_resample_method(pa_modargs *ma, pa_resample_method_t *method);
75
76/* Combination of pa_modargs_get_sample_spec() and
77pa_modargs_get_channel_map(). Not always suitable, since this routine
78initializes the map parameter based on the channels field of the ss
79structure if no channel_map is found, using pa_channel_map_init_auto() */
80
81int pa_modargs_get_sample_spec_and_channel_map(pa_modargs *ma, pa_sample_spec *ss, pa_channel_map *map, pa_channel_map_def_t def);
82
83/* Return alternate sample rate from "alternate_sample_rate" parameter. If the
84 * argument was not specified, *alternate_rate remains unchanged. */
85int pa_modargs_get_alternate_sample_rate(pa_modargs *ma, uint32_t *alternate_rate);
86
87int pa_modargs_get_proplist(pa_modargs *ma, const char *name, pa_proplist *p, pa_update_mode_t m);
88
89/* Iterate through the module argument list. The user should allocate a
90 * state variable of type void* and initialize it with NULL. A pointer
91 * to this variable should then be passed to pa_modargs_iterate()
92 * which should be called in a loop until it returns NULL which
93 * signifies EOL. On each invocation this function will return the
94 * key string for the next entry. The keys in the argument list do not
95 * have any particular order. */
96const char *pa_modargs_iterate(pa_modargs *ma, void **state);
97
98/* Remove entry by key. Returns 0 if successful, -1 otherwise */
99int pa_modargs_remove_key(pa_modargs *ma, const char *key);
100
101/* Add all key/value pairs from src that are is not already present in dst, to dst.
102 * Returns 0 if there were no errors, -1 otherwise. */
103int pa_modargs_merge_missing(pa_modargs *dst, pa_modargs *src, const char* const valid_keys[]);
104
105#endif
106