X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_modules.h;h=e810f87f4e58ae5a78a24a0c948b0847be9af613;hb=12ade3e3bc975d5426ba4af155b7372c31093b31;hp=20509091b7ce515356dab116c339a37ed15f34f7;hpb=449fd28aaf007c6411251dae9d0dbfdc65b135d1;p=vlc diff --git a/include/vlc_modules.h b/include/vlc_modules.h index 20509091b7..e810f87f4e 100644 --- a/include/vlc_modules.h +++ b/include/vlc_modules.h @@ -21,61 +21,51 @@ * 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 +/** + * \file + * This file defines functions for modules in vlc + */ /***************************************************************************** * 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 *, 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( bool, __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_t *, module_need, ( vlc_object_t *, const char *, const char *, bool ) ); +#define module_need(a,b,c,d) module_need(VLC_OBJECT(a),b,c,d) +VLC_EXPORT( void, module_unneed, ( vlc_object_t *, module_t * ) ); +#define module_unneed(a,b) module_unneed(VLC_OBJECT(a),b) +VLC_EXPORT( bool, module_exists, (const char *) ); +VLC_EXPORT( module_t *, module_find, (const char *) ); -VLC_EXPORT( module_config_t *, module_GetConfig, ( const module_t *, unsigned * ) ); -VLC_EXPORT( void, module_PutConfig, ( module_config_t * ) ); +int module_start(vlc_object_t *, module_t *); +#define module_start(o, m) module_start(VLC_OBJECT(o),m) +void module_stop(vlc_object_t *, module_t *); +#define module_stop(o, m) module_stop(VLC_OBJECT(o),m) +VLC_EXPORT( module_config_t *, module_config_get, ( const module_t *, unsigned * ) ); +VLC_EXPORT( void, module_config_free, ( 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 *, module_hold, (module_t *module) ); +VLC_EXPORT( void, module_release, (module_t *module) ); +VLC_EXPORT( void, module_list_free, (module_t **) ); +VLC_EXPORT( module_t **, module_list_get, (size_t *n) ); -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( bool, module_provides, ( const module_t *m, const char *cap ) ); +VLC_EXPORT( const char *, module_get_object, ( const module_t *m ) ); +VLC_EXPORT( const char *, module_get_name, ( const module_t *m, bool long_name ) ); +#define module_GetLongName( m ) module_get_name( m, true ) +VLC_EXPORT( const char *, module_get_help, ( const module_t *m ) ); +VLC_EXPORT( const char *, module_get_capability, ( const module_t *m ) ); +VLC_EXPORT( int, module_get_score, ( const module_t *m ) ); +VLC_EXPORT( const char *, module_gettext, ( const module_t *, const char * ) ); -enum vlc_module_properties +static inline module_t *module_get_main (void) { - /* 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 module_find ("main"); +} +#define module_get_main(a) module_get_main() -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, bool long_name ) ); -#define module_GetLongName( m ) module_GetName( m, true ) -VLC_EXPORT( const char *, module_GetHelp, ( const module_t *m ) ); +static inline bool module_is_main( const module_t * p_module ) +{ + return !strcmp( module_get_object( p_module ), "main" ); +}