1 /*****************************************************************************
2 * modules.h : Module management functions.
3 *****************************************************************************
4 * Copyright (C) 2001 the VideoLAN team
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 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
25 # error This header file can only be included from LibVLC.
28 #ifndef LIBVLC_MODULES_H
29 # define LIBVLC_MODULES_H 1
32 /* Number of tries before we unload an unused module */
33 #define MODULE_HIDE_DELAY 50
35 /*****************************************************************************
36 * module_bank_t: the module bank
37 *****************************************************************************
38 * This variable is accessed by any function using modules.
39 *****************************************************************************/
49 module_cache_t **pp_cache;
52 module_cache_t **pp_loaded_cache;
57 /*****************************************************************************
58 * Module cache description structure
59 *****************************************************************************/
62 /* Mandatory cache entry header */
67 /* Optional extra data */
72 #define MODULE_SHORTCUT_MAX 20
74 /* The module handle type. */
75 #if defined(HAVE_DL_DYLD) && !defined(__x86_64__)
76 # if defined (HAVE_MACH_O_DYLD_H)
77 # include <mach-o/dyld.h>
79 typedef NSModule module_handle_t;
80 #elif defined(HAVE_IMAGE_H)
81 typedef int module_handle_t;
82 #elif defined(WIN32) || defined(UNDER_CE)
83 typedef void * module_handle_t;
84 #elif defined(HAVE_DL_DLOPEN)
85 typedef void * module_handle_t;
86 #elif defined(HAVE_DL_SHL_LOAD)
87 typedef shl_t module_handle_t;
91 * Internal module descriptor
95 char *psz_object_name;
96 gc_object_t vlc_gc_data;
101 unsigned submodule_count;
103 /** Shortcuts to the module */
104 unsigned i_shortcuts;
108 * Variables set by the module to identify itself
110 char *psz_shortname; /**< Module name */
111 char *psz_longname; /**< Module descriptive name */
112 char *psz_help; /**< Long help string for "special" modules */
114 char *psz_capability; /**< Capability */
115 int i_score; /**< Score for the capability */
117 bool b_builtin; /* Set to true if the module is built in */
118 bool b_loaded; /* Set to true if the dll is loaded */
119 bool b_unloadable; /**< Can we be dlclosed? */
120 bool b_submodule; /**< Is this a submodule? */
123 int ( * pf_activate ) ( vlc_object_t * );
124 void ( * pf_deactivate ) ( vlc_object_t * );
127 * Variables set by the module to store its config options
129 module_config_t *p_config; /* Module configuration structure */
130 size_t confsize; /* Number of module_config_t items */
131 unsigned int i_config_items; /* number of configuration items */
132 unsigned int i_bool_items; /* number of bool config items */
135 * Variables used internally by the module manager
137 /* Plugin-specific stuff */
138 module_handle_t handle; /* Unique handle */
139 char * psz_filename; /* Module filename */
140 char * domain; /* gettext domain */
143 module_t *vlc_module_create (vlc_object_t *);
144 module_t *vlc_submodule_create (module_t *module);
146 void module_InitBank( vlc_object_t * );
147 #define module_InitBank(a) module_InitBank(VLC_OBJECT(a))
148 void module_LoadPlugins( vlc_object_t * );
149 #define module_LoadPlugins(a) module_LoadPlugins(VLC_OBJECT(a))
150 void module_EndBank( vlc_object_t *, bool );
151 #define module_EndBank(a,b) module_EndBank(VLC_OBJECT(a), b)
153 int vlc_bindtextdomain (const char *);
155 /* Low-level OS-dependent handler */
156 int module_Load (vlc_object_t *, const char *, module_handle_t *);
157 int module_Call (vlc_object_t *obj, module_t *);
158 void module_Unload (module_handle_t);
161 void CacheMerge (vlc_object_t *, module_t *, module_t *);
162 void CacheDelete(vlc_object_t *, const char *);
163 void CacheLoad (vlc_object_t *, module_bank_t *, const char *);
164 void CacheSave (vlc_object_t *, const char *, module_cache_t *const *, size_t);
165 module_cache_t * CacheFind (module_bank_t *, const char *, int64_t, int64_t);
167 #endif /* !LIBVLC_MODULES_H */