X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_modules.h;h=7d965bcd11ced7fdc71ac0ca6fa6afaef86a6331;hb=ec6ed81c26a20b84a0592d58176f9e778cbc3933;hp=d93289d8b0e4a7133602fb215128880ac604be7c;hpb=7bc113557a70b055540f9f9fb0a2d661ded7d97e;p=vlc diff --git a/include/vlc_modules.h b/include/vlc_modules.h index d93289d8b0..7d965bcd11 100644 --- a/include/vlc_modules.h +++ b/include/vlc_modules.h @@ -21,122 +21,47 @@ * 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 - */ -#ifndef __PLUGIN__FIXME___ -/* FIXME: scheduled for privatization */ -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 */ - - /* - * 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 ]; - - char *psz_capability; /**< Capability */ - int i_score; /**< Score for the capability */ - uint32_t i_cpu; /**< Required CPU capabilities */ - - 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? */ - - /* Callbacks */ - int ( * pf_activate ) ( vlc_object_t * ); - void ( * pf_deactivate ) ( vlc_object_t * ); - - /* - * 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 */ - - /* - * Variables used internally by the module manager - */ - /* Plugin-specific stuff */ - module_handle_t handle; /* Unique handle */ - char * psz_filename; /* Module filename */ - - 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 */ -}; -#endif - /***************************************************************************** * 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 ) ); +VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char *, bool ) ); #define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b) VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) ); #define module_Exists(a,b) __module_Exists(VLC_OBJECT(a),b) -VLC_EXPORT( vlc_bool_t, __module_Exists, ( vlc_object_t *, const char * ) ); +VLC_EXPORT( bool, __module_Exists, ( vlc_object_t *, const char * ) ); -/* Use only if you know what you're doing... */ -#define module_FindName(a,b) __module_FindName(VLC_OBJECT(a),b) -VLC_EXPORT( module_t *, __module_FindName, ( vlc_object_t *, const char * ) ); +#define module_Find(a,b) __module_Find(VLC_OBJECT(a),b) +VLC_EXPORT( module_t *, __module_Find, ( vlc_object_t *, const char * ) ); +VLC_EXPORT( void, module_Put, ( module_t *module ) ); -VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) ); -VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) ); -VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, void *value) ); +VLC_EXPORT( module_config_t *, module_GetConfig, ( const module_t *, unsigned * ) ); +VLC_EXPORT( void, module_PutConfig, ( module_config_t * ) ); -enum vlc_module_properties -{ - /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI! - * Append new items at the end ONLY. */ - VLC_MODULE_CPU_REQUIREMENT, - VLC_MODULE_SHORTCUT, - VLC_MODULE_SHORTNAME, - VLC_MODULE_DESCRIPTION, - VLC_MODULE_HELP, - VLC_MODULE_CAPABILITY, - VLC_MODULE_SCORE, - VLC_MODULE_PROGRAM, - VLC_MODULE_CB_OPEN, - VLC_MODULE_CB_CLOSE, - VLC_MODULE_UNLOADABLE, - VLC_MODULE_NAME -}; +/* Return a NULL terminated array with the names of the modules that have a + * certain capability. + * Free after uses both the string and the table. */ + #define module_GetModulesNamesForCapability(a,b,c) \ + __module_GetModulesNamesForCapability(VLC_OBJECT(a),b,c) +VLC_EXPORT(char **, __module_GetModulesNamesForCapability, + ( vlc_object_t *p_this, const char * psz_capability, + char ***psz_longname ) ); -VLC_EXPORT( vlc_bool_t, module_IsCapable, ( const module_t *m, const char *cap ) ); +VLC_EXPORT( bool, module_IsCapable, ( const module_t *m, const char *cap ) ); VLC_EXPORT( const char *, module_GetObjName, ( const module_t *m ) ); -VLC_EXPORT( const char *, module_GetName, ( const module_t *m, vlc_bool_t long_name ) ); -#define module_GetLongName( m ) module_GetName( m, VLC_TRUE ) +VLC_EXPORT( const char *, module_GetName, ( const module_t *m, bool long_name ) ); +#define module_GetLongName( m ) module_GetName( m, true ) VLC_EXPORT( const char *, module_GetHelp, ( const module_t *m ) ); + + +#define module_GetMainModule(a) __module_GetMainModule(VLC_OBJECT(a)) +static inline module_t * __module_GetMainModule( vlc_object_t * p_this ) +{ + return module_Find( p_this, "main" ); +} + +static inline bool module_IsMainModule( const module_t * p_module ) +{ + return !strcmp( module_GetObjName( p_module ), "main" ); +}