]> git.sesse.net Git - vlc/blobdiff - include/vlc_modules.h
Fix seeking with broken file or without index (close #1687)
[vlc] / include / vlc_modules.h
index 9b4caa94e1d53e96ef97011ceb87caeb49a62e72..7d965bcd11ced7fdc71ac0ca6fa6afaef86a6331 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
-
-#define MODULE_SHORTCUT_MAX 50
-
-/* The module handle type. */
-#if defined(HAVE_DL_DYLD)
-#   if defined (HAVE_MACH_O_DYLD_H)
-#       include <mach-o/dyld.h>
-#   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 ];
+/*****************************************************************************
+ * Exported functions.
+ *****************************************************************************/
 
-    const char    *psz_capability;                           /**< Capability */
-    int      i_score;                          /**< Score for the capability */
-    uint32_t i_cpu;                           /**< Required CPU capabilities */
+#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_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? */
+#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 ) );
 
-    /* Callbacks */
-    int  ( * pf_activate )   ( vlc_object_t * );
-    void ( * pf_deactivate ) ( vlc_object_t * );
+VLC_EXPORT( module_config_t *, module_GetConfig, ( const module_t *, unsigned * ) );
+VLC_EXPORT( void, module_PutConfig, ( module_config_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 */
+/* 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 ) );
 
-    /*
-     * Variables used internally by the module manager
-     */
-    /* Plugin-specific stuff */
-    module_handle_t     handle;                             /* Unique handle */
-    char *              psz_filename;                     /* Module filename */
+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_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 */
 
-    /*
-     * Symbol table we send to the module so that it can access vlc symbols
-     */
-    module_symbols_t *p_symbols;
-};
+#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" );
+}
 
-/*****************************************************************************
- * 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_Exist(a,b) __module_Exists(VLC_OBJECT(a),b)
-VLC_EXPORT( vlc_bool_t,  __module_Exists, ( vlc_object_t *, const char * ) );
+static inline bool module_IsMainModule( const module_t * p_module )
+{
+    return !strcmp( module_GetObjName( p_module ), "main" );
+}