code.delx.au - pulseaudio/blob - 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 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 <pulsecore/core.h>
  31 #include <pulsecore/modinfo.h>
  32
  33 struct pa_module {
  34     pa_core *core;
  35     char *name, *argument;
  36     uint32_t index;
  37
  38     lt_dlhandle dl;
  39
  40     int (*init)(pa_module*m);
  41     void (*done)(pa_module*m);
  42
  43     void *userdata;
  44
  45     int n_used;
  46     pa_bool_t auto_unload;
  47     time_t last_used_time;
  48
  49     pa_bool_t unload_requested;
  50 };
  51
  52 pa_module* pa_module_load(pa_core *c, const char *name, const char*argument);
  53 void pa_module_unload(pa_core *c, pa_module *m);
  54 void pa_module_unload_by_index(pa_core *c, uint32_t idx);
  55
  56 void pa_module_unload_all(pa_core *c);
  57 void pa_module_unload_unused(pa_core *c);
  58
  59 void pa_module_unload_request(pa_module *m);
  60
  61 void pa_module_set_used(pa_module*m, int used);
  62
  63 #define PA_MODULE_AUTHOR(s)                                     \
  64     const char *pa__get_author(void) { return s; }              \
  65     struct __stupid_useless_struct_to_allow_trailing_semicolon
  66
  67 #define PA_MODULE_DESCRIPTION(s)                                \
  68     const char *pa__get_description(void) { return s; }         \
  69     struct __stupid_useless_struct_to_allow_trailing_semicolon
  70
  71 #define PA_MODULE_USAGE(s)                                      \
  72     const char *pa__get_usage(void) { return s; }               \
  73     struct __stupid_useless_struct_to_allow_trailing_semicolon
  74
  75 #define PA_MODULE_VERSION(s)                                    \
  76     const char * pa__get_version(void) { return s; }            \
  77     struct __stupid_useless_struct_to_allow_trailing_semicolon
  78
  79 #define PA_MODULE_LOAD_ONCE(b)                                  \
  80     pa_bool_t pa__load_once(void) { return b; }                 \
  81     struct __stupid_useless_struct_to_allow_trailing_semicolon
  82
  83 pa_modinfo *pa_module_get_info(pa_module *m);
  84
  85 #endif