src/pulsecore/modargs.h

   1 #ifndef foomodargshfoo
   2 #define foomodargshfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   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 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 <pulsecore/core.h>
  29
  30 typedef struct pa_modargs pa_modargs;
  31
  32 /* A generic parser for module arguments */
  33
  34 /* Parse the string args. The NULL-terminated array keys contains all valid arguments. */
  35 pa_modargs *pa_modargs_new(const char *args, const char* const keys[]);
  36 void pa_modargs_free(pa_modargs*ma);
  37
  38 /* Return the module argument for the specified name as a string. If
  39  * the argument was not specified, return def instead.*/
  40 const char *pa_modargs_get_value(pa_modargs *ma, const char *key, const char *def);
  41
  42 /* Return a module argument as unsigned 32bit value in *value */
  43 int pa_modargs_get_value_u32(pa_modargs *ma, const char *key, uint32_t *value);
  44 int pa_modargs_get_value_s32(pa_modargs *ma, const char *key, int32_t *value);
  45 int pa_modargs_get_value_boolean(pa_modargs *ma, const char *key, int *value);
  46
  47 /* Return sample spec data from the three arguments "rate", "format" and "channels" */
  48 int pa_modargs_get_sample_spec(pa_modargs *ma, pa_sample_spec *ss);
  49
  50 /* Return channel map data from the argument "channel_map" */
  51 int pa_modargs_get_channel_map(pa_modargs *ma, pa_channel_map *map);
  52
  53 /* Combination of pa_modargs_get_sample_spec() and
  54 pa_modargs_get_channel_map(). Not always suitable, since this routine
  55 initializes the map parameter based on the channels field of the ss
  56 structure if no channel_map is found, using pa_channel_map_init_auto() */
  57
  58 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);
  59
  60 #endif