X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_modules.h;h=4e6cfdafeaa87cfb1b341a6011ee774400013b1c;hb=75f1d9dbef9df71e9e166743e9e28f86c71f65f5;hp=5652455bdfb543a584ee8b772202de306293891e;hpb=b0e17c5d959737a327277494cffecdfe0b8c0045;p=vlc diff --git a/include/vlc_modules.h b/include/vlc_modules.h index 5652455bdf..4e6cfdafea 100644 --- a/include/vlc_modules.h +++ b/include/vlc_modules.h @@ -21,23 +21,32 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ +/** + * \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_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 * ) ); -#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_config_get, ( const module_t *, unsigned * ) ); +VLC_EXPORT( void, module_config_free, ( module_config_t * ) ); -VLC_EXPORT( module_config_t *, module_GetConfig, ( const module_t *, unsigned * ) ); -VLC_EXPORT( void, module_PutConfig, ( module_config_t * ) ); +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) ); /* Return a NULL terminated array with the names of the modules that have a * certain capability. @@ -48,20 +57,20 @@ VLC_EXPORT(char **, __module_GetModulesNamesForCapability, ( vlc_object_t *p_this, const char * psz_capability, char ***psz_longname ) ); -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 ) ); +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 ) ); -#define module_GetMainModule(a) __module_GetMainModule(VLC_OBJECT(a)) -static inline module_t * __module_GetMainModule( vlc_object_t * p_this ) +#define module_get_main(a) __module_get_main(VLC_OBJECT(a)) +static inline module_t * __module_get_main( vlc_object_t * p_this ) { - return module_Find( p_this, "main" ); + return module_find( p_this, "main" ); } -static inline bool module_IsMainModule( module_t * p_module ) +static inline bool module_is_main( const module_t * p_module ) { - return !strcmp( module_GetObjName( p_module ), "main" ); + return !strcmp( module_get_object( p_module ), "main" ); }