1 /*****************************************************************************
2 * modules.h : Module management functions.
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
5 * $Id: modules.h,v 1.51 2002/05/30 08:17:04 gbazin Exp $
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
28 /* Number of tries before we unload an unused module */
29 #define MODULE_HIDE_DELAY 50
30 #define MODULE_SHORTCUT_MAX 10
32 /* The module handle type. */
34 typedef int module_handle_t;
36 typedef void * module_handle_t;
39 /*****************************************************************************
40 * Module capabilities.
41 *****************************************************************************/
42 static inline char *GetCapabilityName( unsigned int i_capa )
44 /* The sole purpose of this inline function and the ugly #defines
45 * around it is to avoid having two places to modify when adding a
47 static char *pp_capa[] =
50 #define MODULE_CAPABILITY_MAIN 0 /* Main */
52 #define MODULE_CAPABILITY_INTF 1 /* Interface */
54 #define MODULE_CAPABILITY_ACCESS 2 /* Input */
56 #define MODULE_CAPABILITY_DEMUX 3 /* Input */
58 #define MODULE_CAPABILITY_NETWORK 4 /* Network */
60 #define MODULE_CAPABILITY_DECODER 5 /* Audio or video decoder */
62 #define MODULE_CAPABILITY_MOTION 6 /* Motion compensation */
64 #define MODULE_CAPABILITY_IDCT 7 /* IDCT transformation */
66 #define MODULE_CAPABILITY_AOUT 8 /* Audio output */
68 #define MODULE_CAPABILITY_VOUT 9 /* Video output */
69 "chroma transformation",
70 #define MODULE_CAPABILITY_CHROMA 10 /* colorspace conversion */
72 #define MODULE_CAPABILITY_IMDCT 11 /* IMDCT transformation */
74 #define MODULE_CAPABILITY_DOWNMIX 12 /* AC3 downmix */
76 #define MODULE_CAPABILITY_MEMCPY 13 /* memcpy */
78 #define MODULE_CAPABILITY_MAX 14 /* Total number of capabilities */
81 return pp_capa[ (i_capa) > MODULE_CAPABILITY_MAX ? MODULE_CAPABILITY_MAX :
85 /*****************************************************************************
86 * module_bank_t, p_module_bank (global variable)
87 *****************************************************************************
88 * This global variable is accessed by any function using modules.
89 *****************************************************************************/
90 typedef struct module_bank_s
92 struct module_s * first; /* First module in the bank */
93 int i_count; /* Number of allocated modules */
95 vlc_mutex_t lock; /* Global lock -- you can't imagine how awful *
96 it is to design thread-safe linked lists */
100 extern module_bank_t *p_module_bank;
102 # define p_module_bank (p_symbols->p_module_bank)
105 /*****************************************************************************
106 * Module description structure
107 *****************************************************************************/
108 typedef struct module_s
111 * Variables set by the module to identify itself
113 char *psz_name; /* Module _unique_ name */
114 char *psz_longname; /* Module descriptive name */
117 * Variables set by the module to tell us what it can do
119 char *psz_program; /* Program name which will activate the module */
120 char *pp_shortcuts[ MODULE_SHORTCUT_MAX ]; /* Shortcuts to the module */
122 u32 i_capabilities; /* Capability list */
123 int pi_score[ MODULE_CAPABILITY_MAX ]; /* Score for each capability */
125 u32 i_cpu_capabilities; /* Required CPU capabilities */
127 struct module_functions_s *p_functions; /* Capability functions */
130 * Variables set by the module to store its config options
132 struct module_config_s *p_config; /* Module configuration structure */
133 vlc_mutex_t config_lock; /* lock used to modify the config */
134 unsigned int i_config_items; /* number of configuration items */
135 unsigned int i_bool_items; /* number of bool config items */
138 * Variables used internally by the module manager
140 boolean_t b_builtin; /* Set to true if the module is built in */
146 module_handle_t handle; /* Unique handle */
147 char * psz_filename; /* Module filename */
153 int ( *pf_deactivate ) ( struct module_s * );
159 int i_usage; /* Reference counter */
160 int i_unused_delay; /* Delay until module is unloaded */
162 struct module_s *next; /* Next module */
163 struct module_s *prev; /* Previous module */
166 * Symbol table we send to the module so that it can access vlc symbols
168 struct module_symbols_s *p_symbols;
172 /*****************************************************************************
173 * Module functions description structure
174 *****************************************************************************/
175 typedef struct function_list_s
179 /* Interface plugin */
182 int ( * pf_open ) ( struct intf_thread_s * );
183 void ( * pf_close )( struct intf_thread_s * );
184 void ( * pf_run ) ( struct intf_thread_s * );
190 int ( * pf_open ) ( struct input_thread_s * );
191 void ( * pf_close )( struct input_thread_s * );
192 ssize_t ( * pf_read ) ( struct input_thread_s *, byte_t *, size_t );
193 void ( * pf_seek ) ( struct input_thread_s *, off_t );
194 int ( * pf_set_program ) ( struct input_thread_s *,
195 struct pgrm_descriptor_s * );
196 int ( * pf_set_area ) ( struct input_thread_s *,
197 struct input_area_s * );
203 int ( * pf_init ) ( struct input_thread_s * );
204 void ( * pf_end ) ( struct input_thread_s * );
205 int ( * pf_demux )( struct input_thread_s * );
206 int ( * pf_rewind ) ( struct input_thread_s * );
212 int ( * pf_open )( struct network_socket_s * );
215 /* Audio output plugin */
218 int ( * pf_open ) ( struct aout_thread_s * );
219 int ( * pf_setformat ) ( struct aout_thread_s * );
220 int ( * pf_getbufinfo ) ( struct aout_thread_s *, int );
221 void ( * pf_play ) ( struct aout_thread_s *, byte_t *, int );
222 void ( * pf_close ) ( struct aout_thread_s * );
225 /* Video output plugin */
228 int ( * pf_create ) ( struct vout_thread_s * );
229 int ( * pf_init ) ( struct vout_thread_s * );
230 void ( * pf_end ) ( struct vout_thread_s * );
231 void ( * pf_destroy ) ( struct vout_thread_s * );
232 int ( * pf_manage ) ( struct vout_thread_s * );
233 void ( * pf_render ) ( struct vout_thread_s *,
234 struct picture_s * );
235 void ( * pf_display ) ( struct vout_thread_s *,
236 struct picture_s * );
239 /* Motion compensation plugin */
242 void ( * ppppf_motion[2][2][4] ) ( yuv_data_t *, yuv_data_t *,
249 void ( * pf_idct_init ) ( void ** );
250 void ( * pf_sparse_idct_add )( dctelem_t *, yuv_data_t *, int,
252 void ( * pf_idct_add ) ( dctelem_t *, yuv_data_t *, int,
254 void ( * pf_sparse_idct_copy )( dctelem_t *, yuv_data_t *, int,
256 void ( * pf_idct_copy ) ( dctelem_t *, yuv_data_t *, int,
258 void ( * pf_norm_scan ) ( u8 ppi_scan[2][64] );
261 /* Chroma transformation plugin */
264 int ( * pf_init ) ( struct vout_thread_s * );
265 void ( * pf_end ) ( struct vout_thread_s * );
271 void ( * pf_imdct_init ) ( struct imdct_s * );
272 void ( * pf_imdct_256 ) ( struct imdct_s *,
273 float data[], float delay[] );
274 void ( * pf_imdct_256_nol )( struct imdct_s *,
275 float data[], float delay[] );
276 void ( * pf_imdct_512 ) ( struct imdct_s *,
277 float data[], float delay[] );
278 void ( * pf_imdct_512_nol )( struct imdct_s *,
279 float data[], float delay[] );
280 // void ( * pf_fft_64p ) ( struct complex_s * );
284 /* AC3 downmix plugin */
287 void ( * pf_downmix_3f_2r_to_2ch ) ( float *, struct dm_par_s * );
288 void ( * pf_downmix_3f_1r_to_2ch ) ( float *, struct dm_par_s * );
289 void ( * pf_downmix_2f_2r_to_2ch ) ( float *, struct dm_par_s * );
290 void ( * pf_downmix_2f_1r_to_2ch ) ( float *, struct dm_par_s * );
291 void ( * pf_downmix_3f_0r_to_2ch ) ( float *, struct dm_par_s * );
292 void ( * pf_stream_sample_2ch_to_s16 ) ( s16 *, float *, float * );
293 void ( * pf_stream_sample_1ch_to_s16 ) ( s16 *, float * );
297 /* Decoder plugins */
300 int ( * pf_probe)( u8 * p_es );
301 int ( * pf_run ) ( struct decoder_config_s * p_config );
307 void* ( * pf_memcpy ) ( void *, const void *, size_t );
308 void* ( * pf_memset ) ( void *, int, size_t );
315 typedef struct module_functions_s
317 /* XXX: The order here has to be the same as above for the #defines */
318 function_list_t intf;
319 function_list_t access;
320 function_list_t demux;
321 function_list_t network;
323 function_list_t motion;
324 function_list_t idct;
325 function_list_t aout;
326 function_list_t vout;
327 function_list_t chroma;
328 function_list_t imdct;
329 function_list_t downmix;
330 function_list_t memcpy;
332 } module_functions_t;
334 typedef struct module_functions_s * p_module_functions_t;
336 /*****************************************************************************
337 * Exported functions.
338 *****************************************************************************/
340 void module_InitBank ( void );
341 void module_LoadMain ( void );
342 void module_LoadBuiltins ( void );
343 void module_LoadPlugins ( void );
344 void module_EndBank ( void );
345 void module_ResetBank ( void );
346 void module_ManageBank ( void );
347 module_t * module_Need ( int, char *, void * );
348 void module_Unneed ( module_t * );
351 # define module_Need p_symbols->module_Need
352 # define module_Unneed p_symbols->module_Unneed