src/pulsecore/module.h

   1 #ifndef foomodulehfoo
   2 #define foomodulehfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   8
   9   Copyright 2004-2006 Lennart Poettering
  10
  11   PulseAudio is free software; you can redistribute it and/or modify
  12   it under the terms of the GNU Lesser General Public License as published
  13   by the Free Software Foundation; either version 2 of the License,
  14   or (at your option) any later version.
  15
  16   PulseAudio is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with PulseAudio; if not, write to the Free Software
  23   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  24   USA.
  25 ***/
  26
  27 #include <inttypes.h>
  28 #include <ltdl.h>
  29
  30 typedef struct pa_module pa_module;
  31
  32 #include <pulsecore/core.h>
  33 #include <pulsecore/modinfo.h>
  34
  35 struct pa_module {
  36     pa_core *core;
  37     char *name, *argument;
  38     uint32_t index;
  39
  40     lt_dlhandle dl;
  41
  42     int (*init)(pa_core *c, pa_module*m);
  43     void (*done)(pa_core *c, pa_module*m);
  44
  45     void *userdata;
  46
  47     int n_used;
  48     int auto_unload;
  49     time_t last_used_time;
  50
  51     int unload_requested;
  52 };
  53
  54 pa_module* pa_module_load(pa_core *c, const char *name, const char*argument);
  55 void pa_module_unload(pa_core *c, pa_module *m);
  56 void pa_module_unload_by_index(pa_core *c, uint32_t idx);
  57
  58 void pa_module_unload_all(pa_core *c);
  59 void pa_module_unload_unused(pa_core *c);
  60
  61 void pa_module_unload_request(pa_module *m);
  62
  63 void pa_module_set_used(pa_module*m, int used);
  64
  65 #define PA_MODULE_AUTHOR(s) const char * pa__get_author(void) { return s; }
  66 #define PA_MODULE_DESCRIPTION(s) const char * pa__get_description(void) { return s; }
  67 #define PA_MODULE_USAGE(s) const char * pa__get_usage(void) { return s; }
  68 #define PA_MODULE_VERSION(s) const char * pa__get_version(void) { return s; }
  69
  70 pa_modinfo *pa_module_get_info(pa_module *m);
  71
  72 #endif