X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_modules.h;h=d152f256bd9c66e0b14647981b55244fb49ff00e;hb=e2b3a9bfc60d366ac1ad532601e9a65ef54532e0;hp=7f724bdf5f7a209c0bf822df7293d5c2f4346eee;hpb=fbf4c8060d35617e39b50ae739307152d02ed951;p=vlc diff --git a/include/vlc_modules.h b/include/vlc_modules.h index 7f724bdf5f..d152f256bd 100644 --- a/include/vlc_modules.h +++ b/include/vlc_modules.h @@ -1,110 +1,77 @@ /***************************************************************************** - * modules.h : Module descriptor and load functions + * vlc_modules.h : Module descriptor and load functions ***************************************************************************** - * Copyright (C) 2001 the VideoLAN team + * Copyright (C) 2001-2011 VLC authors and VideoLAN * $Id$ * * Authors: Samuel Hocevar * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#if !defined( __LIBVLC__ ) - #error You are not libvlc or one of its plugins. You cannot include this file -#endif - -#define MODULE_SHORTCUT_MAX 50 - -/* The module handle type. */ -#if defined(HAVE_DL_DYLD) -# if defined (HAVE_MACH_O_DYLD_H) -# include -# endif -typedef NSModule module_handle_t; -#elif defined(HAVE_IMAGE_H) -typedef int module_handle_t; -#elif defined(WIN32) || defined(UNDER_CE) -typedef void * module_handle_t; -#elif defined(HAVE_DL_DLOPEN) -typedef void * module_handle_t; -#elif defined(HAVE_DL_SHL_LOAD) -typedef shl_t module_handle_t; -#endif - /** - * Module descriptor + * \file + * This file defines functions for modules in vlc */ -struct module_t -{ - VLC_COMMON_MEMBERS - /* - * Variables set by the module to identify itself - */ - const char *psz_shortname; /**< Module name */ - const char *psz_longname; /**< Module descriptive name */ - const char *psz_help; /**< Long help string for "special" modules */ +typedef int (*vlc_activate_t)(void *func, va_list args); +typedef void (*vlc_deactivate_t)(void *func, va_list args); - /* - * Variables set by the module to tell us what it can do - */ - const char *psz_program; /**< Program name which will activate the module */ - - /** Shortcuts to the module */ - const char *pp_shortcuts[ MODULE_SHORTCUT_MAX ]; +/***************************************************************************** + * Exported functions. + *****************************************************************************/ - const char *psz_capability; /**< Capability */ - int i_score; /**< Score for the capability */ - uint32_t i_cpu; /**< Required CPU capabilities */ +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; +#define vlc_module_load(o,c,n,s,...) \ + vlc_module_load(VLC_OBJECT(o),c,n,s,__VA_ARGS__) +VLC_API void vlc_module_unload( module_t *, vlc_deactivate_t deinit, ... ); - vlc_bool_t b_unloadable; /**< Can we be dlclosed? */ - vlc_bool_t b_reentrant; /**< Are we reentrant? */ - vlc_bool_t b_submodule; /**< Is this a submodule? */ +VLC_API module_t * module_need( vlc_object_t *, const char *, const char *, bool ) VLC_USED; +#define module_need(a,b,c,d) module_need(VLC_OBJECT(a),b,c,d) +VLC_API void module_unneed( vlc_object_t *, module_t * ); +#define module_unneed(a,b) module_unneed(VLC_OBJECT(a),b) +VLC_API bool module_exists(const char *) VLC_USED; +VLC_API module_t * module_find(const char *) VLC_USED; - /* Callbacks */ - int ( * pf_activate ) ( vlc_object_t * ); - void ( * pf_deactivate ) ( vlc_object_t * ); +int module_start(vlc_object_t *, const module_t *); +#define module_start(o, m) module_start(VLC_OBJECT(o),m) +void module_stop(vlc_object_t *, const module_t *); +#define module_stop(o, m) module_stop(VLC_OBJECT(o),m) - /* - * Variables set by the module to store its config options - */ - module_config_t *p_config; /* Module configuration structure */ - size_t confsize; /* Number of module_config_t items */ - unsigned int i_config_items; /* number of configuration items */ - unsigned int i_bool_items; /* number of bool config items */ +VLC_API module_config_t * module_config_get( const module_t *, unsigned * ) VLC_USED; +VLC_API void module_config_free( module_config_t * ); - /* - * Variables used internally by the module manager - */ - /* Plugin-specific stuff */ - module_handle_t handle; /* Unique handle */ - char * psz_filename; /* Module filename */ +VLC_API void module_list_free(module_t **); +VLC_API module_t ** module_list_get(size_t *n) VLC_USED; - vlc_bool_t b_builtin; /* Set to true if the module is built in */ - vlc_bool_t b_loaded; /* Set to true if the dll is loaded */ +VLC_API bool module_provides( const module_t *m, const char *cap ); +VLC_API const char * module_get_object( const module_t *m ) VLC_USED; +VLC_API const char * module_get_name( const module_t *m, bool long_name ) VLC_USED; +#define module_GetLongName( m ) module_get_name( m, true ) +VLC_API const char * module_get_help( const module_t *m ) VLC_USED; +VLC_API const char * module_get_capability( const module_t *m ) VLC_USED; +VLC_API int module_get_score( const module_t *m ) VLC_USED; +VLC_API const char * module_gettext( const module_t *, const char * ) VLC_USED; - /* - * Symbol table we send to the module so that it can access vlc symbols - */ - module_symbols_t *p_symbols; -}; +VLC_USED static inline module_t *module_get_main (void) +{ + return module_find ("main"); +} +#define module_get_main(a) module_get_main() -/***************************************************************************** - * Exported functions. - *****************************************************************************/ -#define module_Need(a,b,c,d) __module_Need(VLC_OBJECT(a),b,c,d) -VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char *, vlc_bool_t ) ); -#define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b) -VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) ); +VLC_USED static inline bool module_is_main( const module_t * p_module ) +{ + return !strcmp( module_get_object( p_module ), "main" ); +}