1 /*****************************************************************************
2 * modules.h : Module management functions.
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
5 * $Id: modules.h,v 1.63 2003/01/19 03:16:24 sam Exp $
7 * Authors: Samuel Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
28 /* Number of tries before we unload an unused module */
29 #define MODULE_HIDE_DELAY 50
30 #define MODULE_SHORTCUT_MAX 10
32 /* The module handle type. */
34 typedef int module_handle_t;
36 typedef void * module_handle_t;
39 /*****************************************************************************
40 * module_bank_t: the module bank
41 *****************************************************************************
42 * This variable is accessed by any function using modules.
43 *****************************************************************************/
48 module_symbols_t symbols;
51 /*****************************************************************************
52 * Module description structure
53 *****************************************************************************/
59 * Variables set by the module to identify itself
61 char *psz_longname; /* Module descriptive name */
64 * Variables set by the module to tell us what it can do
66 char *psz_program; /* Program name which will activate the module */
68 char *pp_shortcuts[ MODULE_SHORTCUT_MAX ]; /* Shortcuts to the module */
70 char *psz_capability; /* Capability */
71 int i_score; /* Score for each capability */
72 uint32_t i_cpu; /* Required CPU capabilities */
74 vlc_bool_t b_unloadable; /* Can we be dlclosed? */
75 vlc_bool_t b_reentrant; /* Are we reentrant? */
76 vlc_bool_t b_submodule; /* Is this a submodule? */
79 int ( * pf_activate ) ( vlc_object_t * );
80 void ( * pf_deactivate ) ( vlc_object_t * );
83 * Variables set by the module to store its config options
85 module_config_t *p_config; /* Module configuration structure */
86 unsigned int i_config_items; /* number of configuration items */
87 unsigned int i_bool_items; /* number of bool config items */
90 * Variables used internally by the module manager
92 /* Plugin-specific stuff */
93 module_handle_t handle; /* Unique handle */
94 char * psz_filename; /* Module filename */
96 vlc_bool_t b_builtin; /* Set to true if the module is built in */
99 * Symbol table we send to the module so that it can access vlc symbols
101 module_symbols_t *p_symbols;
104 /*****************************************************************************
105 * Exported functions.
106 *****************************************************************************/
107 #define module_InitBank(a) __module_InitBank(VLC_OBJECT(a))
108 void __module_InitBank ( vlc_object_t * );
109 #define module_LoadMain(a) __module_LoadMain(VLC_OBJECT(a))
110 void __module_LoadMain ( vlc_object_t * );
111 #define module_LoadBuiltins(a) __module_LoadBuiltins(VLC_OBJECT(a))
112 void __module_LoadBuiltins ( vlc_object_t * );
113 #define module_LoadPlugins(a) __module_LoadPlugins(VLC_OBJECT(a))
114 void __module_LoadPlugins ( vlc_object_t * );
115 #define module_EndBank(a) __module_EndBank(VLC_OBJECT(a))
116 void __module_EndBank ( vlc_object_t * );
117 #define module_ResetBank(a) __module_ResetBank(VLC_OBJECT(a))
118 void __module_ResetBank ( vlc_object_t * );
120 #define module_Need(a,b,c) __module_Need(VLC_OBJECT(a),b,c)
121 VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char * ) );
122 #define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
123 VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) );