1 /*****************************************************************************
2 * modules.h : Module descriptor and load 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 #define MODULE_SHORTCUT_MAX 50
26 /* The module handle type. */
27 #if defined(HAVE_DL_DYLD)
28 # if defined (HAVE_MACH_O_DYLD_H)
29 # include <mach-o/dyld.h>
31 typedef NSModule module_handle_t;
32 #elif defined(HAVE_IMAGE_H)
33 typedef int module_handle_t;
34 #elif defined(WIN32) || defined(UNDER_CE)
35 typedef void * module_handle_t;
36 #elif defined(HAVE_DL_DLOPEN)
37 typedef void * module_handle_t;
38 #elif defined(HAVE_DL_SHL_LOAD)
39 typedef shl_t module_handle_t;
50 * Variables set by the module to identify itself
52 const char *psz_shortname; /**< Module name */
53 const char *psz_longname; /**< Module descriptive name */
54 const char *psz_help; /**< Long help string for "special" modules */
57 * Variables set by the module to tell us what it can do
59 const char *psz_program; /**< Program name which will activate the module */
61 /** Shortcuts to the module */
62 const char *pp_shortcuts[ MODULE_SHORTCUT_MAX ];
64 const char *psz_capability; /**< Capability */
65 int i_score; /**< Score for the capability */
66 uint32_t i_cpu; /**< Required CPU capabilities */
68 vlc_bool_t b_unloadable; /**< Can we be dlclosed? */
69 vlc_bool_t b_reentrant; /**< Are we reentrant? */
70 vlc_bool_t b_submodule; /**< Is this a submodule? */
73 int ( * pf_activate ) ( vlc_object_t * );
74 void ( * pf_deactivate ) ( vlc_object_t * );
77 * Variables set by the module to store its config options
79 module_config_t *p_config; /* Module configuration structure */
80 size_t confsize; /* Number of module_config_t items */
81 unsigned int i_config_items; /* number of configuration items */
82 unsigned int i_bool_items; /* number of bool config items */
85 * Variables used internally by the module manager
87 /* Plugin-specific stuff */
88 module_handle_t handle; /* Unique handle */
89 char * psz_filename; /* Module filename */
91 vlc_bool_t b_builtin; /* Set to true if the module is built in */
92 vlc_bool_t b_loaded; /* Set to true if the dll is loaded */
95 * Symbol table we send to the module so that it can access vlc symbols
97 module_symbols_t *p_symbols;
100 /*****************************************************************************
101 * Exported functions.
102 *****************************************************************************/
103 #define module_Need(a,b,c,d) __module_Need(VLC_OBJECT(a),b,c,d)
104 VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char *, vlc_bool_t ) );
105 #define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
106 VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) );