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 31 typedef 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. */ 36 pa_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. */ 38 int pa_modargs_append(pa_modargs *ma, const char *args, const char* const* valid_keys); 39 void 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.*/ 43 const 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. */ 47 int pa_modargs_get_value_u32(pa_modargs *ma, const char *key, uint32_t *value); 48 int pa_modargs_get_value_s32(pa_modargs *ma, const char *key, int32_t *value); 49 int pa_modargs_get_value_u64(pa_modargs *ma, const char *key, uint64_t *value); 50 int pa_modargs_get_value_boolean(pa_modargs *ma, const char *key, bool *value); 51 52 /* Return a module argument as double value in *value. If the argument was not 53 * specified, *value remains unchanged. */ 54 int pa_modargs_get_value_double(pa_modargs *ma, const char *key, double *value); 55 56 /* Return a module argument as pa_volume_t value in *value. If the argument 57 * was not specified, *value remains unchanged. */ 58 int pa_modargs_get_value_volume(pa_modargs *ma, const char *key, pa_volume_t *value); 59 60 /* Return sample rate from the "rate" argument. If the argument was not 61 * specified, *rate remains unchanged. */ 62 int pa_modargs_get_sample_rate(pa_modargs *ma, uint32_t *rate); 63 64 /* Return sample spec data from the three arguments "rate", "format" and 65 * "channels". If the argument was not specified, *ss remains unchanged. */ 66 int pa_modargs_get_sample_spec(pa_modargs *ma, pa_sample_spec *ss); 67 68 /* Return channel map data from the argument "channel_map" if name is NULL, 69 * otherwise read from the specified argument. If the argument was not 70 * specified, *map remains unchanged. */ 71 int pa_modargs_get_channel_map(pa_modargs *ma, const char *name, pa_channel_map *map); 72 73 /* Return resample method from the argument "resample_method". If the argument 74 * was not specified, *method remains unchanged. */ 75 int pa_modargs_get_resample_method(pa_modargs *ma, pa_resample_method_t *method); 76 77 /* Combination of pa_modargs_get_sample_spec() and 78 pa_modargs_get_channel_map(). Not always suitable, since this routine 79 initializes the map parameter based on the channels field of the ss 80 structure if no channel_map is found, using pa_channel_map_init_auto() */ 81 82 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); 83 84 /* Return alternate sample rate from "alternate_sample_rate" parameter. If the 85 * argument was not specified, *alternate_rate remains unchanged. */ 86 int pa_modargs_get_alternate_sample_rate(pa_modargs *ma, uint32_t *alternate_rate); 87 88 int pa_modargs_get_proplist(pa_modargs *ma, const char *name, pa_proplist *p, pa_update_mode_t m); 89 90 /* Iterate through the module argument list. The user should allocate a 91 * state variable of type void* and initialize it with NULL. A pointer 92 * to this variable should then be passed to pa_modargs_iterate() 93 * which should be called in a loop until it returns NULL which 94 * signifies EOL. On each invocation this function will return the 95 * key string for the next entry. The keys in the argument list do not 96 * have any particular order. */ 97 const char *pa_modargs_iterate(pa_modargs *ma, void **state); 98 99 /* Remove entry by key. Returns 0 if successful, -1 otherwise */ 100 int pa_modargs_remove_key(pa_modargs *ma, const char *key); 101 102 /* Add all key/value pairs from src that are is not already present in dst, to dst. 103 * Returns 0 if there were no errors, -1 otherwise. */ 104 int pa_modargs_merge_missing(pa_modargs *dst, pa_modargs *src, const char* const valid_keys[]); 105 106 #endif 107