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