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 #ifndef LIBVLC_MODULES_H
25 # define LIBVLC_MODULES_H 1
27 typedef struct module_cache_t module_cache_t;
29 /*****************************************************************************
30 * module_bank_t: the module bank
31 *****************************************************************************
32 * This variable is accessed by any function using modules.
33 *****************************************************************************/
34 typedef struct module_bank_t
40 module_cache_t **pp_cache;
43 module_cache_t **pp_loaded_cache;
48 /*****************************************************************************
49 * Module cache description structure
50 *****************************************************************************/
53 /* Mandatory cache entry header */
58 /* Optional extra data */
63 #define MODULE_SHORTCUT_MAX 20
65 /* The module handle type. */
66 #if defined(HAVE_DL_DYLD) && !defined(__x86_64__)
67 # if defined (HAVE_MACH_O_DYLD_H)
68 # include <mach-o/dyld.h>
70 typedef NSModule module_handle_t;
71 #elif defined(HAVE_IMAGE_H)
72 typedef int module_handle_t;
73 #elif defined(WIN32) || defined(UNDER_CE) || defined(__SYMBIAN32__)
74 typedef void * module_handle_t;
75 #elif defined(HAVE_DL_DLOPEN)
76 typedef void * module_handle_t;
80 * Internal module descriptor
84 char *psz_object_name;
85 gc_object_t vlc_gc_data;
90 unsigned submodule_count;
92 /** Shortcuts to the module */
97 * Variables set by the module to identify itself
99 char *psz_shortname; /**< Module name */
100 char *psz_longname; /**< Module descriptive name */
101 char *psz_help; /**< Long help string for "special" modules */
103 char *psz_capability; /**< Capability */
104 int i_score; /**< Score for the capability */
106 bool b_builtin; /* Set to true if the module is built in */
107 bool b_loaded; /* Set to true if the dll is loaded */
108 bool b_unloadable; /**< Can we be dlclosed? */
115 * Variables set by the module to store its config options
117 module_config_t *p_config; /* Module configuration structure */
118 size_t confsize; /* Number of module_config_t items */
119 unsigned int i_config_items; /* number of configuration items */
120 unsigned int i_bool_items; /* number of bool config items */
123 * Variables used internally by the module manager
125 /* Plugin-specific stuff */
126 module_handle_t handle; /* Unique handle */
127 char * psz_filename; /* Module filename */
128 char * domain; /* gettext domain */
131 module_t *vlc_module_create (void);
132 module_t *vlc_submodule_create (module_t *module);
134 void module_InitBank( vlc_object_t * );
135 #define module_InitBank(a) module_InitBank(VLC_OBJECT(a))
136 void module_LoadPlugins( vlc_object_t * );
137 #define module_LoadPlugins(a) module_LoadPlugins(VLC_OBJECT(a))
138 void module_EndBank( vlc_object_t *, bool );
139 #define module_EndBank(a,b) module_EndBank(VLC_OBJECT(a), b)
141 int vlc_bindtextdomain (const char *);
143 /* Low-level OS-dependent handler */
144 int module_Load (vlc_object_t *, const char *, module_handle_t *, bool);
145 void *module_Lookup (module_handle_t, const char *);
146 void module_Unload (module_handle_t);
149 void CacheMerge (vlc_object_t *, module_t *, module_t *);
150 void CacheDelete(vlc_object_t *, const char *);
151 size_t CacheLoad (vlc_object_t *, const char *, module_cache_t ***);
152 void CacheSave (vlc_object_t *, const char *, module_cache_t *const *, size_t);
153 module_t * CacheFind (module_bank_t *, const char *, time_t, off_t);
155 #endif /* !LIBVLC_MODULES_H */