src/pulsecore/module.h

   1 #ifndef foomodulehfoo
   2 #define foomodulehfoo
   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 <ltdl.h>
  27
  28 typedef struct pa_module pa_module;
  29
  30 #include <pulse/proplist.h>
  31
  32 #include <pulsecore/core.h>
  33
  34 struct pa_module {
  35     pa_core *core;
  36     char *name, *argument;
  37     uint32_t index;
  38
  39     lt_dlhandle dl;
  40
  41     int (*init)(pa_module*m);
  42     void (*done)(pa_module*m);
  43     int (*get_n_used)(pa_module *m);
  44
  45     void *userdata;
  46
  47     pa_bool_t load_once:1;
  48     pa_bool_t unload_requested:1;
  49
  50     pa_proplist *proplist;
  51 };
  52
  53 pa_module* pa_module_load(pa_core *c, const char *name, const char*argument);
  54
  55 void pa_module_unload(pa_core *c, pa_module *m, pa_bool_t force);
  56 void pa_module_unload_by_index(pa_core *c, uint32_t idx, pa_bool_t force);
  57
  58 void pa_module_unload_request(pa_module *m, pa_bool_t force);
  59 void pa_module_unload_request_by_index(pa_core *c, uint32_t idx, pa_bool_t force);
  60
  61 void pa_module_unload_all(pa_core *c);
  62
  63 int pa_module_get_n_used(pa_module*m);
  64
  65 void pa_module_update_proplist(pa_module *m, pa_update_mode_t mode, pa_proplist *p);
  66
  67 #define PA_MODULE_AUTHOR(s)                                     \
  68     const char *pa__get_author(void) { return s; }              \
  69     struct __stupid_useless_struct_to_allow_trailing_semicolon
  70
  71 #define PA_MODULE_DESCRIPTION(s)                                \
  72     const char *pa__get_description(void) { return s; }         \
  73     struct __stupid_useless_struct_to_allow_trailing_semicolon
  74
  75 #define PA_MODULE_USAGE(s)                                      \
  76     const char *pa__get_usage(void) { return s; }               \
  77     struct __stupid_useless_struct_to_allow_trailing_semicolon
  78
  79 #define PA_MODULE_VERSION(s)                                    \
  80     const char * pa__get_version(void) { return s; }            \
  81     struct __stupid_useless_struct_to_allow_trailing_semicolon
  82
  83 #define PA_MODULE_DEPRECATED(s)                                 \
  84     const char * pa__get_deprecated(void) { return s; }         \
  85     struct __stupid_useless_struct_to_allow_trailing_semicolon
  86
  87 #define PA_MODULE_LOAD_ONCE(b)                                  \
  88     pa_bool_t pa__load_once(void) { return b; }                 \
  89     struct __stupid_useless_struct_to_allow_trailing_semicolon
  90
  91 #endif