code.delx.au - pulseaudio/blob - polyp/module.h

   1 #ifndef foomodulehfoo
   2 #define foomodulehfoo
   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 <ltdl.h>
  27
  28 #include "core.h"
  29 #include "modinfo.h"
  30
  31 struct pa_module {
  32     struct pa_core *core;
  33     char *name, *argument;
  34     uint32_t index;
  35
  36     lt_dlhandle dl;
  37
  38     int (*init)(struct pa_core *c, struct pa_module*m);
  39     void (*done)(struct pa_core *c, struct pa_module*m);
  40
  41     void *userdata;
  42
  43     int n_used;
  44     int auto_unload;
  45     time_t last_used_time;
  46
  47     int unload_requested;
  48 };
  49
  50 struct pa_module* pa_module_load(struct pa_core *c, const char *name, const char*argument);
  51 /* void pa_module_unload(struct pa_core *c, struct pa_module *m); */
  52 /* void pa_module_unload_by_index(struct pa_core *c, uint32_t index); */
  53
  54 void pa_module_unload_all(struct pa_core *c);
  55 void pa_module_unload_unused(struct pa_core *c);
  56
  57 void pa_module_unload_request(struct pa_module *m);
  58
  59 void pa_module_set_used(struct pa_module*m, int used);
  60
  61 #define PA_MODULE_AUTHOR(s) const char * pa__get_author(void) { return s; }
  62 #define PA_MODULE_DESCRIPTION(s) const char * pa__get_description(void) { return s; }
  63 #define PA_MODULE_USAGE(s) const char * pa__get_usage(void) { return s; }
  64 #define PA_MODULE_VERSION(s) const char * pa__get_version(void) { return s; }
  65
  66 struct pa_modinfo *pa_module_get_info(struct pa_module *m);
  67
  68 #endif