]> git.sesse.net Git - vlc/blobdiff - include/vlc_modules.h
Remove VLC_OBJECT_LIBVLC
[vlc] / include / vlc_modules.h
index fa8f7ec135490a70150104c8f251df9e1c50b1e3..4e6cfdafeaa87cfb1b341a6011ee774400013b1c 100644 (file)
  * 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 *, vlc_bool_t ) );
-#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 * ) );
 
-#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 ) );
+#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 * ) );
 
-VLC_EXPORT( module_config_t *, module_GetConfig, ( const module_t *, unsigned * ) );
-VLC_EXPORT( void, module_PutConfig, ( module_config_t * ) );
+#define module_find(a,b) __module_find(VLC_OBJECT(a),b)
+VLC_EXPORT( module_t *, __module_find, ( vlc_object_t *, const char * ) );
 
+VLC_EXPORT( module_config_t *, module_config_get, ( const module_t *, unsigned * ) );
+VLC_EXPORT( void, module_config_free, ( 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.
@@ -52,30 +57,20 @@ 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) );
+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 ) );
+
 
-enum vlc_module_properties
+#define module_get_main(a) __module_get_main(VLC_OBJECT(a))
+static inline module_t * __module_get_main( vlc_object_t * p_this )
 {
-    /* 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( p_this, "main" );
+}
 
-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 ) );
+static inline bool module_is_main( const module_t * p_module )
+{
+    return !strcmp( module_get_object( p_module ), "main" );
+}