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