0b2506b07ef3dd5d536a92e324c7d71338c1b791
[vlc.git] / include / modules.h
1 /*****************************************************************************
2  * modules.h : Module management functions.
3  *****************************************************************************
4  * Copyright (C) 2001 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Module #defines.
26  *****************************************************************************/
27
28 /* Number of tries before we unload an unused module */
29 #define MODULE_HIDE_DELAY 50
30 #define MODULE_SHORTCUT_MAX 50
31
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>
36 #   endif
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;
46 #endif
47
48 /*****************************************************************************
49  * module_bank_t: the module bank
50  *****************************************************************************
51  * This variable is accessed by any function using modules.
52  *****************************************************************************/
53 struct module_bank_t
54 {
55     VLC_COMMON_MEMBERS
56
57     int              i_usage;
58     module_symbols_t symbols;
59
60     vlc_bool_t       b_main;
61     vlc_bool_t       b_builtins;
62     vlc_bool_t       b_plugins;
63
64     /* Plugins cache */
65     vlc_bool_t     b_cache;
66     vlc_bool_t     b_cache_dirty;
67     vlc_bool_t     b_cache_delete;
68
69     int            i_cache;
70     module_cache_t **pp_cache;
71
72     int            i_loaded_cache;
73     module_cache_t **pp_loaded_cache;
74 };
75
76 /*****************************************************************************
77  * Module description structure
78  *****************************************************************************/
79 struct module_t
80 {
81     VLC_COMMON_MEMBERS
82
83     /*
84      * Variables set by the module to identify itself
85      */
86     char *psz_shortname;                                      /* Module name */
87     char *psz_longname;                           /* Module descriptive name */
88
89     /*
90      * Variables set by the module to tell us what it can do
91      */
92     char *psz_program;        /* Program name which will activate the module */
93
94     char *pp_shortcuts[ MODULE_SHORTCUT_MAX ];    /* Shortcuts to the module */
95
96     char    *psz_capability;                                   /* Capability */
97     int      i_score;                           /* Score for each capability */
98     uint32_t i_cpu;                             /* Required CPU capabilities */
99
100     vlc_bool_t b_unloadable;                          /* Can we be dlclosed? */
101     vlc_bool_t b_reentrant;                             /* Are we reentrant? */
102     vlc_bool_t b_submodule;                          /* Is this a submodule? */
103
104     /* Callbacks */
105     int  ( * pf_activate )   ( vlc_object_t * );
106     void ( * pf_deactivate ) ( vlc_object_t * );
107
108     /*
109      * Variables set by the module to store its config options
110      */
111     module_config_t *p_config;             /* Module configuration structure */
112     unsigned int     i_config_items;        /* number of configuration items */
113     unsigned int     i_bool_items;            /* number of bool config items */
114
115     /*
116      * Variables used internally by the module manager
117      */
118     /* Plugin-specific stuff */
119     module_handle_t     handle;                             /* Unique handle */
120     char *              psz_filename;                     /* Module filename */
121
122     vlc_bool_t          b_builtin;  /* Set to true if the module is built in */
123     vlc_bool_t          b_loaded;        /* Set to true if the dll is loaded */
124
125     /*
126      * Symbol table we send to the module so that it can access vlc symbols
127      */
128     module_symbols_t *p_symbols;
129 };
130
131 /*****************************************************************************
132  * Module cache description structure
133  *****************************************************************************/
134 struct module_cache_t
135 {
136     /* Mandatory cache entry header */
137     char       *psz_file;
138     int64_t    i_time;
139     int64_t    i_size;
140     vlc_bool_t b_junk;
141
142     /* Optional extra data */
143     module_t *p_module;
144 };
145
146 /*****************************************************************************
147  * Exported functions.
148  *****************************************************************************/
149 #define module_InitBank(a)     __module_InitBank(VLC_OBJECT(a))
150 void  __module_InitBank        ( vlc_object_t * );
151 #define module_LoadMain(a)     __module_LoadMain(VLC_OBJECT(a))
152 void  __module_LoadMain        ( vlc_object_t * );
153 #define module_LoadBuiltins(a) __module_LoadBuiltins(VLC_OBJECT(a))
154 void  __module_LoadBuiltins    ( vlc_object_t * );
155 #define module_LoadPlugins(a)  __module_LoadPlugins(VLC_OBJECT(a))
156 void  __module_LoadPlugins     ( vlc_object_t * );
157 #define module_EndBank(a)      __module_EndBank(VLC_OBJECT(a))
158 void  __module_EndBank         ( vlc_object_t * );
159 #define module_ResetBank(a)    __module_ResetBank(VLC_OBJECT(a))
160 void  __module_ResetBank       ( vlc_object_t * );
161
162 #define module_Need(a,b,c,d) __module_Need(VLC_OBJECT(a),b,c,d)
163 VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char *, vlc_bool_t ) );
164 #define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
165 VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) );
166