* modules.h : Module management functions.
*****************************************************************************
* Copyright (C) 2001 VideoLAN
+ * $Id: modules.h,v 1.63 2003/01/19 03:16:24 sam Exp $
*
* 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
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
*****************************************************************************/
+/*****************************************************************************
+ * Module #defines.
+ *****************************************************************************/
+
/* Number of tries before we unload an unused module */
-#define MODULE_HIDE_DELAY 10
+#define MODULE_HIDE_DELAY 50
+#define MODULE_SHORTCUT_MAX 10
/* The module handle type. */
#ifdef SYS_BEOS
#endif
/*****************************************************************************
- * Configuration structure
- *****************************************************************************/
-typedef struct module_config_s
-{
- 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;
-
-/*****************************************************************************
- * Bank and module description structures
+ * module_bank_t: the module bank
+ *****************************************************************************
+ * This variable is accessed by any function using modules.
*****************************************************************************/
-
-/* The main module structure */
-typedef struct module_s
-{
- boolean_t b_builtin; /* Set to true if the module is built in */
-
- module_handle_t handle; /* Unique handle to refer to the module */
- char * psz_filename; /* Module filename */
-
- char * psz_name; /* Module _unique_ name */
- char * psz_longname; /* Module descriptive name */
- char * psz_version; /* Module version */
-
- int i_usage; /* Reference counter */
- int i_unused_delay; /* Delay until module is unloaded */
-
- struct module_s * next; /* Next module */
- struct module_s * prev; /* Previous module */
-
- u32 i_capabilities; /* Capability list */
-
- module_config_t * p_config; /* Module configuration structure table */
-
-} module_t;
-
-/* The module bank structure */
-typedef struct module_bank_s
+struct module_bank_t
{
- module_t * first; /* First module of the bank */
+ VLC_COMMON_MEMBERS
- vlc_mutex_t lock; /* Global lock -- you can't imagine how awful it
- is to design thread-safe linked lists. */
-} module_bank_t;
+ module_symbols_t symbols;
+};
/*****************************************************************************
- * Stuff for handling dynamic modules
+ * Module description structure
*****************************************************************************/
-
-/* Function to load a dynamic module, returns 0 if successful. */
-static __inline__ int
-module_load( char * psz_filename, module_handle_t * handle )
+struct module_t
{
-#ifdef SYS_BEOS
- *handle = load_add_on( psz_filename );
- return( *handle >= 0 );
-#else
- *handle = dlopen( psz_filename, RTLD_NOW | RTLD_GLOBAL );
- return( *handle != NULL );
-#endif
-}
+ VLC_COMMON_MEMBERS
+
+ /*
+ * Variables set by the module to identify itself
+ */
+ char *psz_longname; /* Module descriptive name */
+
+ /*
+ * 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 */
-/* Unload a dynamic module. */
-static __inline__ void
-module_unload( module_handle_t handle )
-{
-#ifdef SYS_BEOS
- unload_add_on( handle );
-#else
- dlclose( handle );
-#endif
- return;
-}
+ vlc_bool_t b_builtin; /* Set to true if the module is built in */
-/* Get a given symbol from a module. */
-static __inline__ void *
-module_getsymbol( module_handle_t handle, char * psz_function )
-{
-#ifdef SYS_BEOS
- void * p_symbol;
- get_image_symbol( handle, psz_function, B_SYMBOL_TYPE_TEXT, &p_symbol );
- return( p_symbol );
-#else
- return( dlsym( handle, psz_function ) );
-#endif
-}
-
-/* Wrapper to dlerror() for systems that don't have it. */
-static __inline__ char *
-module_error( void )
-{
-#ifdef SYS_BEOS
- return( "failed" );
-#else
- return( dlerror() );
-#endif
-}
+ /*
+ * Symbol table we send to the module so that it can access vlc symbols
+ */
+ module_symbols_t *p_symbols;
+};
/*****************************************************************************
* Exported functions.
*****************************************************************************/
-module_bank_t * module_InitBank ( void );
-int module_DestroyBank ( module_bank_t * p_bank );
-int 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) __module_Need(VLC_OBJECT(a),b,c)
+VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char * ) );
+#define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
+VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) );