1
/*****************************************************************************
2
* modules.h : Module management functions.
3
*****************************************************************************
4
* Copyright (C) 2001 the VideoLAN team
5
* $Id: 41def36da309b82e6423529326ed5d8b60ceb64e $
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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 50
32
/* The module handle type. */
33
#if defined(HAVE_DL_DYLD)
34
# if defined (HAVE_MACH_O_DYLD_H)
35
# include <mach-o/dyld.h>
37
typedef NSModule module_handle_t;
38
#elif defined(HAVE_IMAGE_H)
39
typedef int module_handle_t;
40
#elif defined(WIN32) || defined(UNDER_CE)
41
typedef void * module_handle_t;
42
#elif defined(HAVE_DL_DLOPEN)
43
typedef void * module_handle_t;
44
#elif defined(HAVE_DL_SHL_LOAD)
45
typedef shl_t module_handle_t;
48
/*****************************************************************************
49
* module_bank_t: the module bank
50
*****************************************************************************
51
* This variable is accessed by any function using modules.
52
*****************************************************************************/
58
#ifndef HAVE_SHARED_LIBVLC
59
module_symbols_t symbols;
63
vlc_bool_t b_builtins;
68
vlc_bool_t b_cache_dirty;
69
vlc_bool_t b_cache_delete;
72
module_cache_t **pp_cache;
75
module_cache_t **pp_loaded_cache;
78
/*****************************************************************************
79
* Module description structure
80
*****************************************************************************/
86
* Variables set by the module to identify itself
88
char *psz_shortname; /* Module name */
89
char *psz_longname; /* Module descriptive name */
90
char *psz_help; /* Long help string for "special" modules */
93
* Variables set by the module to tell us what it can do
95
char *psz_program; /* Program name which will activate the module */
97
char *pp_shortcuts[ MODULE_SHORTCUT_MAX ]; /* Shortcuts to the module */
99
char *psz_capability; /* Capability */
100
int i_score; /* Score for each capability */
101
uint32_t i_cpu; /* Required CPU capabilities */
103
vlc_bool_t b_unloadable; /* Can we be dlclosed? */
104
vlc_bool_t b_reentrant; /* Are we reentrant? */
105
vlc_bool_t b_submodule; /* Is this a submodule? */
108
int ( * pf_activate ) ( vlc_object_t * );
109
void ( * pf_deactivate ) ( vlc_object_t * );
112
* Variables set by the module to store its config options
114
module_config_t *p_config; /* Module configuration structure */
115
unsigned int i_config_items; /* number of configuration items */
116
unsigned int i_bool_items; /* number of bool config items */
119
* Variables used internally by the module manager
121
/* Plugin-specific stuff */
122
module_handle_t handle; /* Unique handle */
123
char * psz_filename; /* Module filename */
125
vlc_bool_t b_builtin; /* Set to true if the module is built in */
126
vlc_bool_t b_loaded; /* Set to true if the dll is loaded */
129
* Symbol table we send to the module so that it can access vlc symbols
131
module_symbols_t *p_symbols;
134
/*****************************************************************************
135
* Module cache description structure
136
*****************************************************************************/
137
struct module_cache_t
139
/* Mandatory cache entry header */
145
/* Optional extra data */
149
/*****************************************************************************
150
* Exported functions.
151
*****************************************************************************/
152
#define module_InitBank(a) __module_InitBank(VLC_OBJECT(a))
153
void __module_InitBank ( vlc_object_t * );
154
#define module_LoadMain(a) __module_LoadMain(VLC_OBJECT(a))
155
void __module_LoadMain ( vlc_object_t * );
156
#define module_LoadBuiltins(a) __module_LoadBuiltins(VLC_OBJECT(a))
157
void __module_LoadBuiltins ( vlc_object_t * );
158
#define module_LoadPlugins(a) __module_LoadPlugins(VLC_OBJECT(a))
159
void __module_LoadPlugins ( vlc_object_t * );
160
#define module_EndBank(a) __module_EndBank(VLC_OBJECT(a))
161
void __module_EndBank ( vlc_object_t * );
162
#define module_ResetBank(a) __module_ResetBank(VLC_OBJECT(a))
163
void __module_ResetBank ( vlc_object_t * );
165
#define module_Need(a,b,c,d) __module_Need(VLC_OBJECT(a),b,c,d)
166
VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char *, vlc_bool_t ) );
167
#define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
168
VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) );