/*****************************************************************************
* modules.h : Module management functions.
*****************************************************************************
- * Copyright (C) 2001 VideoLAN
+ * Copyright (C) 2001 the VideoLAN team
+ * $Id$
*
* Authors: Samuel Hocevar <sam@zoy.org>
*
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
- *
+ *
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+/*****************************************************************************
+ * Module #defines.
*****************************************************************************/
/* Number of tries before we unload an unused module */
#define MODULE_HIDE_DELAY 50
+#define MODULE_SHORTCUT_MAX 50
/* The module handle type. */
-#ifdef SYS_BEOS
-typedef int module_handle_t;
-#else
-typedef void * module_handle_t;
+#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
/*****************************************************************************
- * Configuration structure
+ * module_bank_t: the module bank
+ *****************************************************************************
+ * This variable is accessed by any function using modules.
*****************************************************************************/
-typedef struct module_config_s
+struct module_bank_t
{
- int i_type; /* Configuration widget type */
- char * psz_text; /* Text commenting or describing the widget */
- char * psz_name; /* Variable name */
- void * p_getlist; /* Function to call to get a choice list */
- void * p_change; /* Function to call when commiting a change */
-} module_config_t;
+ VLC_COMMON_MEMBERS
-/*****************************************************************************
- * Bank and module description structures
- *****************************************************************************/
-
-/* The main module structure */
-typedef struct module_s
-{
- boolean_t b_builtin; /* Set to true if the module is built in */
+ int i_usage;
+#ifndef HAVE_SHARED_LIBVLC
+ module_symbols_t symbols;
+#endif
- module_handle_t handle; /* Unique handle to refer to the module */
- char * psz_filename; /* Module filename */
+ vlc_bool_t b_main;
+ vlc_bool_t b_builtins;
+ vlc_bool_t b_plugins;
- char * psz_name; /* Module _unique_ name */
- char * psz_longname; /* Module descriptive name */
- char * psz_version; /* Module version */
+ /* Plugins cache */
+ vlc_bool_t b_cache;
+ vlc_bool_t b_cache_dirty;
+ vlc_bool_t b_cache_delete;
- int i_usage; /* Reference counter */
- int i_unused_delay; /* Delay until module is unloaded */
+ int i_cache;
+ module_cache_t **pp_cache;
- struct module_s * next; /* Next module */
- struct module_s * prev; /* Previous module */
+ int i_loaded_cache;
+ module_cache_t **pp_loaded_cache;
+};
- u32 i_capabilities; /* Capability list */
+/*****************************************************************************
+ * Module description structure
+ *****************************************************************************/
+struct module_t
+{
+ VLC_COMMON_MEMBERS
+
+ /*
+ * Variables set by the module to identify itself
+ */
+ char *psz_shortname; /* Module name */
+ char *psz_longname; /* Module descriptive name */
+ char *psz_help; /* Long help string for "special" modules */
+
+ /*
+ * Variables set by the module to tell us what it can do
+ */
+ char *psz_program; /* Program name which will activate the module */
+
+ char *pp_shortcuts[ MODULE_SHORTCUT_MAX ]; /* Shortcuts to the module */
+
+ char *psz_capability; /* Capability */
+ int i_score; /* Score for each 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 */
+ 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 */
- module_config_t * p_config; /* Module configuration structure table */
+ 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 */
-} module_t;
+ /*
+ * Symbol table we send to the module so that it can access vlc symbols
+ */
+ module_symbols_t *p_symbols;
+};
-/* The module bank structure */
-typedef struct module_bank_s
+/*****************************************************************************
+ * Module cache description structure
+ *****************************************************************************/
+struct module_cache_t
{
- module_t * first; /* First module of the bank */
+ /* Mandatory cache entry header */
+ char *psz_file;
+ int64_t i_time;
+ int64_t i_size;
+ vlc_bool_t b_junk;
- vlc_mutex_t lock; /* Global lock -- you can't imagine how awful it
- is to design thread-safe linked lists. */
-} module_bank_t;
+ /* Optional extra data */
+ module_t *p_module;
+};
/*****************************************************************************
* Exported functions.
*****************************************************************************/
-module_bank_t * module_CreateBank ( void );
-void module_InitBank ( module_bank_t * p_bank );
-void module_DestroyBank ( module_bank_t * p_bank );
-void module_ResetBank ( module_bank_t * p_bank );
-void module_ManageBank ( module_bank_t * p_bank );
-
-int module_Need ( module_t * p_module );
-int module_Unneed ( module_t * p_module );
+#define module_InitBank(a) __module_InitBank(VLC_OBJECT(a))
+void __module_InitBank ( vlc_object_t * );
+#define module_LoadMain(a) __module_LoadMain(VLC_OBJECT(a))
+void __module_LoadMain ( vlc_object_t * );
+#define module_LoadBuiltins(a) __module_LoadBuiltins(VLC_OBJECT(a))
+void __module_LoadBuiltins ( vlc_object_t * );
+#define module_LoadPlugins(a) __module_LoadPlugins(VLC_OBJECT(a))
+void __module_LoadPlugins ( vlc_object_t * );
+#define module_EndBank(a) __module_EndBank(VLC_OBJECT(a))
+void __module_EndBank ( vlc_object_t * );
+#define module_ResetBank(a) __module_ResetBank(VLC_OBJECT(a))
+void __module_ResetBank ( vlc_object_t * );
+
+#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 * ) );
projects / vlc / blobdiff