include/vlc_modules.h

   1 /*****************************************************************************
   2  * vlc_modules.h : Module descriptor and load functions
   3  *****************************************************************************
   4  * Copyright (C) 2001-2011 VLC authors and VideoLAN
   5  *
   6  * Authors: Samuel Hocevar <sam@zoy.org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License as published by
  10  * the Free Software Foundation; either version 2.1 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 #ifndef VLC_MODULES_H
  24 #define VLC_MODULES_H 1
  25
  26 /**
  27  * \file
  28  * This file defines functions for modules in vlc
  29  */
  30
  31 typedef int (*vlc_activate_t)(void *func, va_list args);
  32 typedef void (*vlc_deactivate_t)(void *func, va_list args);
  33
  34 /*****************************************************************************
  35  * Exported functions.
  36  *****************************************************************************/
  37
  38 VLC_API module_t * vlc_module_load( vlc_object_t *obj, const char *cap, const char *name, bool strict, vlc_activate_t probe, ... ) VLC_USED;
  39 #define vlc_module_load(o, c, n, ...) \
  40         vlc_module_load(VLC_OBJECT(o), c, n, __VA_ARGS__)
  41 VLC_API void vlc_module_unload( vlc_object_t *obj, module_t *,
  42                                 vlc_deactivate_t deinit, ... );
  43 #define vlc_module_unload(o, m, ...) \
  44         vlc_module_unload(VLC_OBJECT(o), m, __VA_ARGS__)
  45
  46 VLC_API module_t * module_need( vlc_object_t *, const char *, const char *, bool ) VLC_USED;
  47 #define module_need(a,b,c,d) module_need(VLC_OBJECT(a),b,c,d)
  48
  49 VLC_USED
  50 static inline module_t *module_need_var(vlc_object_t *obj, const char *cap,
  51                                         const char *varname)
  52 {
  53     char *list = var_InheritString(obj, varname);
  54     module_t *m = module_need(obj, cap, list, false);
  55
  56     free(list);
  57     return m;
  58 }
  59 #define module_need_var(a,b,c) module_need_var(VLC_OBJECT(a),b,c)
  60
  61 VLC_API void module_unneed( vlc_object_t *, module_t * );
  62 #define module_unneed(a,b) module_unneed(VLC_OBJECT(a),b)
  63 VLC_API bool module_exists(const char *) VLC_USED;
  64 VLC_API module_t * module_find(const char *) VLC_USED;
  65
  66 VLC_API module_config_t * module_config_get( const module_t *, unsigned * ) VLC_USED;
  67 VLC_API void module_config_free( module_config_t * );
  68
  69 VLC_API void module_list_free(module_t **);
  70 VLC_API module_t ** module_list_get(size_t *n) VLC_USED;
  71
  72 VLC_API bool module_provides( const module_t *m, const char *cap );
  73 VLC_API const char * module_get_object( const module_t *m ) VLC_USED;
  74 VLC_API const char * module_get_name( const module_t *m, bool long_name ) VLC_USED;
  75 #define module_GetLongName( m ) module_get_name( m, true )
  76 VLC_API const char * module_get_help( const module_t *m ) VLC_USED;
  77 VLC_API const char * module_get_capability( const module_t *m ) VLC_USED;
  78 VLC_API int module_get_score( const module_t *m ) VLC_USED;
  79 VLC_API const char * module_gettext( const module_t *, const char * ) VLC_USED;
  80
  81 VLC_USED static inline module_t *module_get_main (void)
  82 {
  83     return module_find ("core");
  84 }
  85 #define module_get_main(a) module_get_main()
  86
  87 VLC_USED static inline bool module_is_main( const module_t * p_module )
  88 {
  89     return !strcmp( module_get_object( p_module ), "core" );
  90 }
  91
  92 #endif /* VLC_MODULES_H */