src/polypcore/modargs.h

   1 #ifndef foomodargshfoo
   2 #define foomodargshfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of polypaudio.
   8
   9   polypaudio 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   polypaudio 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 polypaudio; 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 <polyp/sample.h>
  27 #include "core.h"
  28
  29 typedef struct pa_modargs pa_modargs;
  30
  31 /* A generic parser for module arguments */
  32
  33 /* Parse the string args. The NULL-terminated array keys contains all valid arguments. */
  34 pa_modargs *pa_modargs_new(const char *args, const char* const keys[]);
  35 void pa_modargs_free(pa_modargs*ma);
  36
  37 /* Return the module argument for the specified name as a string. If
  38  * the argument was not specified, return def instead.*/
  39 const char *pa_modargs_get_value(pa_modargs *ma, const char *key, const char *def);
  40
  41 /* Return a module argument as unsigned 32bit value in *value */
  42 int pa_modargs_get_value_u32(pa_modargs *ma, const char *key, uint32_t *value);
  43 int pa_modargs_get_value_s32(pa_modargs *ma, const char *key, int32_t *value);
  44 int pa_modargs_get_value_boolean(pa_modargs *ma, const char *key, int *value);
  45
  46 /* Return sample spec data from the three arguments "rate", "format" and "channels" */
  47 int pa_modargs_get_sample_spec(pa_modargs *ma, pa_sample_spec *ss);
  48
  49 #endif