X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_modules.h;h=fa8f7ec135490a70150104c8f251df9e1c50b1e3;hb=cc4cca2fd565125ad3260c934df9c88892e375f2;hp=95f432494cd60a28f9dc55b62596a2d6c26ba77a;hpb=cba87f6d3e1c5e0956441178854bf77c9ac3122c;p=vlc diff --git a/include/vlc_modules.h b/include/vlc_modules.h index 95f432494c..fa8f7ec135 100644 --- a/include/vlc_modules.h +++ b/include/vlc_modules.h @@ -25,77 +25,6 @@ #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 - */ -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 ]; - - const 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 */ -}; - /***************************************************************************** * Exported functions. *****************************************************************************/ @@ -106,11 +35,28 @@ 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 * ) ); +#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_config_t *, module_GetConfig, ( const module_t *, unsigned * ) ); +VLC_EXPORT( void, module_PutConfig, ( module_config_t * ) ); + + +/* 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( 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) ); -enum +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. */ @@ -128,3 +74,8 @@ enum VLC_MODULE_NAME }; +VLC_EXPORT( vlc_bool_t, 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_GetHelp, ( const module_t *m ) );