src/pulsecore/modargs.h

   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, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #include <inttypes.h>
  26 #include <pulse/sample.h>
  27 #include <pulse/channelmap.h>
  28 #include <pulse/proplist.h>
  29 #include <pulsecore/macro.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 void pa_modargs_free(pa_modargs*ma);
  38
  39 /* Return the module argument for the specified name as a string. If
  40  * the argument was not specified, return def instead.*/
  41 const char *pa_modargs_get_value(pa_modargs *ma, const char *key, const char *def);
  42
  43 /* Return a module argument as unsigned 32bit value in *value */
  44 int pa_modargs_get_value_u32(pa_modargs *ma, const char *key, uint32_t *value);
  45 int pa_modargs_get_value_s32(pa_modargs *ma, const char *key, int32_t *value);
  46 int pa_modargs_get_value_boolean(pa_modargs *ma, const char *key, pa_bool_t *value);
  47
  48 /* Return sample spec data from the three arguments "rate", "format" and "channels" */
  49 int pa_modargs_get_sample_spec(pa_modargs *ma, pa_sample_spec *ss);
  50
  51 /* Return channel map data from the argument "channel_map" if name is NULL, otherwise read from the specified argument */
  52 int pa_modargs_get_channel_map(pa_modargs *ma, const char *name, pa_channel_map *map);
  53
  54 /* Combination of pa_modargs_get_sample_spec() and
  55 pa_modargs_get_channel_map(). Not always suitable, since this routine
  56 initializes the map parameter based on the channels field of the ss
  57 structure if no channel_map is found, using pa_channel_map_init_auto() */
  58
  59 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);
  60
  61 int pa_modargs_get_proplist(pa_modargs *ma, const char *name, pa_proplist *p, pa_update_mode_t m);
  62
  63 /* Iterate through the module argument list. The user should allocate a
  64  * state variable of type void* and initialize it with NULL. A pointer
  65  * to this variable should then be passed to pa_modargs_iterate()
  66  * which should be called in a loop until it returns NULL which
  67  * signifies EOL. On each invication this function will return the
  68  * key string for the next entry. The keys in the argument list do not
  69  * have any particular order. */
  70 const char *pa_modargs_iterate(pa_modargs *ma, void **state);
  71
  72 #endif