]>
code.delx.au - pulseaudio/blob - src/pulsecore/modargs.h
504b9cd70b030444618b4efc2bed9401aed709a9
7 This file is part of PulseAudio.
9 Copyright 2004-2006 Lennart Poettering
11 PulseAudio is free software; you can redistribute it and/or modify
12 it under the terms of the GNU Lesser General Public License as published
13 by the Free Software Foundation; either version 2 of the License,
14 or (at your option) any later version.
16 PulseAudio is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
21 You should have received a copy of the GNU Lesser General Public License
22 along with PulseAudio; if not, write to the Free Software
23 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
28 #include <pulse/sample.h>
29 #include <pulse/channelmap.h>
30 #include <pulsecore/core.h>
31 #include <pulsecore/macro.h>
33 typedef struct pa_modargs pa_modargs
;
35 /* A generic parser for module arguments */
37 /* Parse the string args. The NULL-terminated array keys contains all valid arguments. */
38 pa_modargs
*pa_modargs_new(const char *args
, const char* const keys
[]);
39 void pa_modargs_free(pa_modargs
*ma
);
41 /* Return the module argument for the specified name as a string. If
42 * the argument was not specified, return def instead.*/
43 const char *pa_modargs_get_value(pa_modargs
*ma
, const char *key
, const char *def
);
45 /* Return a module argument as unsigned 32bit value in *value */
46 int pa_modargs_get_value_u32(pa_modargs
*ma
, const char *key
, uint32_t *value
);
47 int pa_modargs_get_value_s32(pa_modargs
*ma
, const char *key
, int32_t *value
);
48 int pa_modargs_get_value_boolean(pa_modargs
*ma
, const char *key
, pa_bool_t
*value
);
50 /* Return sample spec data from the three arguments "rate", "format" and "channels" */
51 int pa_modargs_get_sample_spec(pa_modargs
*ma
, pa_sample_spec
*ss
);
53 /* Return channel map data from the argument "channel_map" if name is NULL, otherwise read from the specified argument */
54 int pa_modargs_get_channel_map(pa_modargs
*ma
, const char *name
, pa_channel_map
*map
);
56 /* Combination of pa_modargs_get_sample_spec() and
57 pa_modargs_get_channel_map(). Not always suitable, since this routine
58 initializes the map parameter based on the channels field of the ss
59 structure if no channel_map is found, using pa_channel_map_init_auto() */
61 int 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
);