]> git.sesse.net Git - vlc/blobdiff - include/vlc_modules.h
Use var_InheritString for --decklink-video-connection.
[vlc] / include / vlc_modules.h
index c280485368571a0277363d10bf784021a7d9f103..e810f87f4e58ae5a78a24a0c948b0847be9af613 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
-
-#if 1
-/* FIXME: scheduled for privatization */
-#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
+ * \file
+ * This file defines functions for modules in vlc
  */
-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 */
-
-    /** Shortcuts to the module */
-    const char *pp_shortcuts[ MODULE_SHORTCUT_MAX ];
-
-    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 */
-};
-#endif
 
 /*****************************************************************************
  * 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 * ) );
-
-/* Use only if you know what you're doing... */
-#define module_FindName(a,b) __module_FindName(VLC_OBJECT(a),b)
-VLC_EXPORT( module_t *, __module_FindName, ( vlc_object_t *, const char * ) );
-VLC_EXPORT( void, module_Put, ( module_t *module ) );
 
-
-/* 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 vlc_module_properties
+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 *) );
+
+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 * ) );
+
+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( 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 * ) );
+
+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( 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" );
+}