Plugins depend on the core symbols list, not the whole library
[vlc.git] / src / modules / 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
25 # error This header file can only be included from LibVLC.
26 #endif
27
28 #ifndef __LIBVLC_MODULES_H
29 # define __LIBVLC_MODULES_H 1
30
31
32 /* Number of tries before we unload an unused module */
33 #define MODULE_HIDE_DELAY 50
34
35 /*****************************************************************************
36  * module_bank_t: the module bank
37  *****************************************************************************
38  * This variable is accessed by any function using modules.
39  *****************************************************************************/
40 struct module_bank_t
41 {
42     unsigned         i_usage;
43
44     bool             b_builtins;
45     bool             b_plugins;
46
47     /* Plugins cache */
48     bool             b_cache;
49     bool             b_cache_dirty;
50
51     int            i_cache;
52     module_cache_t **pp_cache;
53
54     int            i_loaded_cache;
55     module_cache_t **pp_loaded_cache;
56
57     module_t       *head;
58 };
59
60 /*****************************************************************************
61  * Module cache description structure
62  *****************************************************************************/
63 struct module_cache_t
64 {
65     /* Mandatory cache entry header */
66     char       *psz_file;
67     int64_t    i_time;
68     int64_t    i_size;
69     bool b_junk;
70
71     /* Optional extra data */
72     module_t *p_module;
73     bool b_used;
74 };
75
76
77 #define MODULE_SHORTCUT_MAX 50
78
79 /* The module handle type. */
80 #if defined(HAVE_DL_DYLD)
81 #   if defined (HAVE_MACH_O_DYLD_H)
82 #       include <mach-o/dyld.h>
83 #   endif
84 typedef NSModule module_handle_t;
85 #elif defined(HAVE_IMAGE_H)
86 typedef int module_handle_t;
87 #elif defined(WIN32) || defined(UNDER_CE)
88 typedef void * module_handle_t;
89 #elif defined(HAVE_DL_DLOPEN)
90 typedef void * module_handle_t;
91 #elif defined(HAVE_DL_SHL_LOAD)
92 typedef shl_t module_handle_t;
93 #endif
94
95 /**
96  * Internal module descriptor
97  */
98 struct module_t
99 {
100     char       *psz_object_name;
101     module_t   *next;
102     module_t   *submodule;
103     module_t   *parent;
104     unsigned    submodule_count;
105     gc_object_t vlc_gc_data;
106     vlc_mutex_t lock;
107
108     /*
109      * Variables set by the module to identify itself
110      */
111     char *psz_shortname;                              /**< Module name */
112     char *psz_longname;                   /**< Module descriptive name */
113     char *psz_help;        /**< Long help string for "special" modules */
114
115     /** Shortcuts to the module */
116     char *pp_shortcuts[ MODULE_SHORTCUT_MAX ];
117
118     char    *psz_capability;                                 /**< Capability */
119     int      i_score;                          /**< Score for the capability */
120     uint32_t i_cpu;                           /**< Required CPU capabilities */
121
122     bool b_unloadable;                        /**< Can we be dlclosed? */
123     bool b_reentrant;                           /**< Are we reentrant? */
124     bool b_submodule;                        /**< Is this a submodule? */
125
126     /* Callbacks */
127     int  ( * pf_activate )   ( vlc_object_t * );
128     void ( * pf_deactivate ) ( vlc_object_t * );
129
130     /*
131      * Variables set by the module to store its config options
132      */
133     module_config_t *p_config;             /* Module configuration structure */
134     size_t           confsize;            /* Number of module_config_t items */
135     unsigned int     i_config_items;        /* number of configuration items */
136     unsigned int     i_bool_items;            /* number of bool config items */
137
138     /*
139      * Variables used internally by the module manager
140      */
141     /* Plugin-specific stuff */
142     module_handle_t     handle;                             /* Unique handle */
143     char *              psz_filename;                     /* Module filename */
144
145     bool          b_builtin;  /* Set to true if the module is built in */
146     bool          b_loaded;        /* Set to true if the dll is loaded */
147 };
148
149 module_t *vlc_module_create (vlc_object_t *);
150 module_t *vlc_submodule_create (module_t *module);
151
152 #define module_InitBank(a)     __module_InitBank(VLC_OBJECT(a))
153 void  __module_InitBank        ( vlc_object_t * );
154 void module_LoadPlugins( vlc_object_t *, bool );
155 #define module_LoadPlugins(a,b) module_LoadPlugins(VLC_OBJECT(a),b)
156 #define module_EndBank(a)      __module_EndBank(VLC_OBJECT(a))
157 void  __module_EndBank         ( vlc_object_t * );
158
159 /* Low-level OS-dependent handler */
160 int  module_Load   (vlc_object_t *, const char *, module_handle_t *);
161 int  module_Call   (vlc_object_t *obj, module_t *);
162 void module_Unload (module_handle_t);
163
164 /* Plugins cache */
165 void   CacheMerge (vlc_object_t *, module_t *, module_t *);
166 void   CacheLoad  (vlc_object_t *, module_bank_t *, bool);
167 void   CacheSave  (vlc_object_t *, module_bank_t *);
168 module_cache_t * CacheFind (module_bank_t *, const char *, int64_t, int64_t);
169
170 #endif /* !__LIBVLC_MODULES_H */