1 /*****************************************************************************
2 * modules.c : Builtin and plugin modules management functions
3 *****************************************************************************
4 * Copyright (C) 2001-2004 the VideoLAN team
7 * Authors: Sam Hocevar <sam@zoy.org>
8 * Ethan C. Baldridge <BaldridgeE@cadmus.com>
9 * Hans-Peter Jansen <hpj@urpla.net>
10 * Gildas Bazin <gbazin@videolan.org>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
29 /* Some faulty libcs have a broken struct dirent when _FILE_OFFSET_BITS
30 * is set to 64. Don't try to be cleverer. */
31 #ifdef _FILE_OFFSET_BITS
32 #undef _FILE_OFFSET_BITS
35 #include <stdlib.h> /* free(), strtol() */
36 #include <stdio.h> /* sprintf() */
37 #include <string.h> /* strdup() */
39 #include <vlc/input.h>
45 #ifdef HAVE_SYS_TYPES_H
46 # include <sys/types.h>
48 #ifdef HAVE_SYS_STAT_H
49 # include <sys/stat.h>
55 #if !defined(HAVE_DYNAMIC_PLUGINS)
56 /* no support for plugins */
57 #elif defined(HAVE_DL_DYLD)
58 # if defined(HAVE_MACH_O_DYLD_H)
59 # include <mach-o/dyld.h>
61 #elif defined(HAVE_DL_BEOS)
62 # if defined(HAVE_IMAGE_H)
65 #elif defined(HAVE_DL_WINDOWS)
67 #elif defined(HAVE_DL_DLOPEN)
68 # if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
71 # if defined(HAVE_SYS_DL_H)
74 #elif defined(HAVE_DL_SHL_LOAD)
75 # if defined(HAVE_DL_H)
80 #include "vlc_error.h"
82 #include "vlc_interface.h"
83 #include "vlc_interaction.h"
84 #include "intf_eject.h"
86 #include "vlc_playlist.h"
88 #include "vlc_video.h"
89 #include "video_output.h"
90 #include "vout_synchro.h"
93 #include "audio_output.h"
94 #include "aout_internal.h"
96 #include "stream_output.h"
97 #include "vlc_httpd.h"
104 #include "iso_lang.h"
107 #include "vlc_block.h"
111 #include "vlc_image.h"
114 #include "vlc_update.h"
115 #include "vlc_strings.h"
116 #include "vlc_streaming.h"
118 #if defined( _MSC_VER ) && defined( UNDER_CE )
119 # include "modules_builtin_evc.h"
120 #elif defined( _MSC_VER )
121 # include "modules_builtin_msvc.h"
123 # include "modules_builtin.h"
127 #if defined( WIN32 ) || defined( UNDER_CE )
128 /* Avoid name collisions */
129 # define LoadModule(a,b,c) LoadVlcModule(a,b,c)
132 /*****************************************************************************
134 *****************************************************************************/
135 #ifdef HAVE_DYNAMIC_PLUGINS
136 static void AllocateAllPlugins ( vlc_object_t * );
137 static void AllocatePluginDir ( vlc_object_t *, const char *, int );
138 static int AllocatePluginFile ( vlc_object_t *, char *, int64_t, int64_t );
139 static module_t * AllocatePlugin( vlc_object_t *, char * );
141 static int AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
142 static int DeleteModule ( module_t * );
143 #ifdef HAVE_DYNAMIC_PLUGINS
144 static void DupModule ( module_t * );
145 static void UndupModule ( module_t * );
146 static int CallEntry ( module_t * );
147 static int LoadModule ( vlc_object_t *, char *, module_handle_t * );
148 static void CloseModule ( module_handle_t );
149 static void * GetSymbol ( module_handle_t, const char * );
150 static void CacheLoad ( vlc_object_t * );
151 static int CacheLoadConfig ( module_t *, FILE * );
152 static void CacheSave ( vlc_object_t * );
153 static void CacheSaveConfig ( module_t *, FILE * );
154 static char * CacheName ( void );
155 static void CacheMerge ( vlc_object_t *, module_t *, module_t * );
156 static module_cache_t * CacheFind( vlc_object_t *, char *, int64_t, int64_t );
158 #if defined(HAVE_DL_WINDOWS)
159 static char * GetWindowsError ( void );
164 /* Sub-version number
165 * (only used to avoid breakage in dev version when cache structure changes) */
166 #define CACHE_SUBVERSION_NUM 1
168 /*****************************************************************************
169 * module_InitBank: create the module bank.
170 *****************************************************************************
171 * This function creates a module bank structure which will be filled later
172 * on with all the modules found.
173 *****************************************************************************/
174 void __module_InitBank( vlc_object_t *p_this )
176 module_bank_t *p_bank;
179 var_Create( p_this->p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
180 var_Get( p_this->p_libvlc_global, "libvlc", &lockval );
181 vlc_mutex_lock( lockval.p_address );
182 if( p_this->p_libvlc_global->p_module_bank )
184 p_this->p_libvlc_global->p_module_bank->i_usage++;
185 vlc_mutex_unlock( lockval.p_address );
186 var_Destroy( p_this->p_libvlc_global, "libvlc" );
189 vlc_mutex_unlock( lockval.p_address );
190 var_Destroy( p_this->p_libvlc_global, "libvlc" );
192 p_bank = vlc_object_create( p_this, sizeof(module_bank_t) );
193 p_bank->psz_object_name = "module bank";
195 p_bank->i_cache = p_bank->i_loaded_cache = 0;
196 p_bank->pp_cache = p_bank->pp_loaded_cache = 0;
197 p_bank->b_cache = p_bank->b_cache_dirty =
198 p_bank->b_cache_delete = VLC_FALSE;
201 * Store the symbols to be exported
203 #if defined (HAVE_DYNAMIC_PLUGINS) && !defined (HAVE_SHARED_LIBVLC)
204 STORE_SYMBOLS( &p_bank->symbols );
207 /* Everything worked, attach the object */
208 p_this->p_libvlc_global->p_module_bank = p_bank;
209 vlc_object_attach( p_bank, p_this->p_libvlc_global );
211 module_LoadMain( p_this );
216 /*****************************************************************************
217 * module_ResetBank: reset the module bank.
218 *****************************************************************************
219 * This function resets the module bank by unloading all unused plugin
221 *****************************************************************************/
222 void __module_ResetBank( vlc_object_t *p_this )
224 msg_Err( p_this, "FIXME: module_ResetBank unimplemented" );
228 /*****************************************************************************
229 * module_EndBank: empty the module bank.
230 *****************************************************************************
231 * This function unloads all unused plugin modules and empties the module
232 * bank in case of success.
233 *****************************************************************************/
234 void __module_EndBank( vlc_object_t *p_this )
239 var_Create( p_this->p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
240 var_Get( p_this->p_libvlc_global, "libvlc", &lockval );
241 vlc_mutex_lock( lockval.p_address );
242 if( !p_this->p_libvlc_global->p_module_bank )
244 vlc_mutex_unlock( lockval.p_address );
245 var_Destroy( p_this->p_libvlc_global, "libvlc" );
248 if( --p_this->p_libvlc_global->p_module_bank->i_usage )
250 vlc_mutex_unlock( lockval.p_address );
251 var_Destroy( p_this->p_libvlc_global, "libvlc" );
254 vlc_mutex_unlock( lockval.p_address );
255 var_Destroy( p_this->p_libvlc_global, "libvlc" );
257 config_AutoSaveConfigFile( p_this );
259 #ifdef HAVE_DYNAMIC_PLUGINS
260 #define p_bank p_this->p_libvlc_global->p_module_bank
261 if( p_bank->b_cache ) CacheSave( p_this );
262 while( p_bank->i_loaded_cache-- )
264 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
265 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
267 if( p_bank->pp_loaded_cache )
268 free( p_bank->pp_loaded_cache );
270 while( p_bank->i_cache-- )
272 free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
273 free( p_bank->pp_cache[p_bank->i_cache] );
275 if( p_bank->pp_cache )
276 free( p_bank->pp_cache );
280 vlc_object_detach( p_this->p_libvlc_global->p_module_bank );
282 while( p_this->p_libvlc_global->p_module_bank->i_children )
284 p_next = (module_t *)p_this->p_libvlc_global->p_module_bank->pp_children[0];
286 if( DeleteModule( p_next ) )
288 /* Module deletion failed */
289 msg_Err( p_this, "module \"%s\" can't be removed, trying harder",
290 p_next->psz_object_name );
292 /* We just free the module by hand. Niahahahahaha. */
293 vlc_object_detach( p_next );
294 vlc_object_destroy( p_next );
298 vlc_object_destroy( p_this->p_libvlc_global->p_module_bank );
299 p_this->p_libvlc_global->p_module_bank = NULL;
304 /*****************************************************************************
305 * module_LoadMain: load the main program info into the module bank.
306 *****************************************************************************
307 * This function fills the module bank structure with the main module infos.
308 * This is very useful as it will allow us to consider the main program just
309 * as another module, and for instance the configuration options of main will
310 * be available in the module bank structure just as for every other module.
311 *****************************************************************************/
312 void __module_LoadMain( vlc_object_t *p_this )
316 var_Create( p_this->p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
317 var_Get( p_this->p_libvlc_global, "libvlc", &lockval );
318 vlc_mutex_lock( lockval.p_address );
319 if( p_this->p_libvlc_global->p_module_bank->b_main )
321 vlc_mutex_unlock( lockval.p_address );
322 var_Destroy( p_this->p_libvlc_global, "libvlc" );
325 p_this->p_libvlc_global->p_module_bank->b_main = VLC_TRUE;
326 vlc_mutex_unlock( lockval.p_address );
327 var_Destroy( p_this->p_libvlc_global, "libvlc" );
329 AllocateBuiltinModule( p_this, vlc_entry__main );
332 /*****************************************************************************
333 * module_LoadBuiltins: load all modules which we built with.
334 *****************************************************************************
335 * This function fills the module bank structure with the builtin modules.
336 *****************************************************************************/
337 void __module_LoadBuiltins( vlc_object_t * p_this )
341 var_Create( p_this->p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
342 var_Get( p_this->p_libvlc_global, "libvlc", &lockval );
343 vlc_mutex_lock( lockval.p_address );
344 if( p_this->p_libvlc_global->p_module_bank->b_builtins )
346 vlc_mutex_unlock( lockval.p_address );
347 var_Destroy( p_this->p_libvlc_global, "libvlc" );
350 p_this->p_libvlc_global->p_module_bank->b_builtins = VLC_TRUE;
351 vlc_mutex_unlock( lockval.p_address );
352 var_Destroy( p_this->p_libvlc_global, "libvlc" );
354 msg_Dbg( p_this, "checking builtin modules" );
355 ALLOCATE_ALL_BUILTINS();
358 /*****************************************************************************
359 * module_LoadPlugins: load all plugin modules we can find.
360 *****************************************************************************
361 * This function fills the module bank structure with the plugin modules.
362 *****************************************************************************/
363 void __module_LoadPlugins( vlc_object_t * p_this )
365 #ifdef HAVE_DYNAMIC_PLUGINS
368 var_Create( p_this->p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
369 var_Get( p_this->p_libvlc_global, "libvlc", &lockval );
370 vlc_mutex_lock( lockval.p_address );
371 if( p_this->p_libvlc_global->p_module_bank->b_plugins )
373 vlc_mutex_unlock( lockval.p_address );
374 var_Destroy( p_this->p_libvlc_global, "libvlc" );
377 p_this->p_libvlc_global->p_module_bank->b_plugins = VLC_TRUE;
378 vlc_mutex_unlock( lockval.p_address );
379 var_Destroy( p_this->p_libvlc_global, "libvlc" );
381 msg_Dbg( p_this, "checking plugin modules" );
383 if( config_GetInt( p_this, "plugins-cache" ) )
384 p_this->p_libvlc_global->p_module_bank->b_cache = VLC_TRUE;
386 if( p_this->p_libvlc_global->p_module_bank->b_cache ||
387 p_this->p_libvlc_global->p_module_bank->b_cache_delete ) CacheLoad( p_this );
389 AllocateAllPlugins( p_this );
393 /*****************************************************************************
394 * module_Need: return the best module function, given a capability list.
395 *****************************************************************************
396 * This function returns the module that best fits the asked capabilities.
397 *****************************************************************************/
398 module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
399 const char *psz_name, vlc_bool_t b_strict )
401 typedef struct module_list_t module_list_t;
408 module_list_t *p_next;
411 module_list_t *p_list, *p_first, *p_tmp;
414 int i_which_module, i_index = 0;
415 vlc_bool_t b_intf = VLC_FALSE;
420 char *psz_shortcuts = NULL, *psz_var = NULL;
421 vlc_bool_t b_force_backup = p_this->b_force;
424 /* Deal with variables */
425 if( psz_name && psz_name[0] == '$' )
428 var_Create( p_this, psz_name + 1, VLC_VAR_MODULE | VLC_VAR_DOINHERIT );
429 var_Get( p_this, psz_name + 1, &val );
430 psz_var = val.psz_string;
434 /* Count how many different shortcuts were asked for */
435 if( psz_name && *psz_name )
437 char *psz_parser, *psz_last_shortcut;
439 /* If the user wants none, give him none. */
440 if( !strcmp( psz_name, "none" ) )
442 if( psz_var ) free( psz_var );
447 psz_shortcuts = psz_last_shortcut = strdup( psz_name );
449 for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
451 if( *psz_parser == ',' )
455 psz_last_shortcut = psz_parser + 1;
459 /* Check if the user wants to override the "strict" mode */
460 if( psz_last_shortcut )
462 if( !strcmp(psz_last_shortcut, "none") )
467 else if( !strcmp(psz_last_shortcut, "any") )
469 b_strict = VLC_FALSE;
475 /* Sort the modules and test them */
476 p_all = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
477 p_list = malloc( p_all->i_count * sizeof( module_list_t ) );
480 /* Parse the module list for capabilities and probe each of them */
481 for( i_which_module = 0; i_which_module < p_all->i_count; i_which_module++ )
483 int i_shortcut_bonus = 0;
485 p_module = (module_t *)p_all->p_values[i_which_module].p_object;
487 /* Test that this module can do what we need */
488 if( strcmp( p_module->psz_capability, psz_capability ) )
490 /* Don't recurse through the sub-modules because vlc_list_find()
491 * will list them anyway. */
495 /* Test if we have the required CPU */
496 if( (p_module->i_cpu & p_this->p_libvlc_global->i_cpu) != p_module->i_cpu )
501 /* If we required a shortcut, check this plugin provides it. */
502 if( i_shortcuts > 0 )
505 int i_dummy, i_short = i_shortcuts;
506 char *psz_name = psz_shortcuts;
508 /* Let's drop modules with a <= 0 score (unless they are
509 * explicitly requested) */
510 b_trash = p_module->i_score <= 0;
514 for( i_dummy = 0; p_module->pp_shortcuts[i_dummy]; i_dummy++ )
516 if( !strcasecmp( psz_name,
517 p_module->pp_shortcuts[i_dummy] ) )
521 i_shortcut_bonus = i_short * 10000;
526 if( i_shortcut_bonus )
528 /* We found it... remember ? */
532 /* Go to the next shortcut... This is so lame! */
541 /* If we are in "strict" mode and we couldn't
542 * find the module in the list of provided shortcuts,
543 * then kick the bastard out of here!!! */
544 if( i_short == 0 && b_strict )
554 /* If we didn't require a shortcut, trash <= 0 scored plugins */
555 else if( p_module->i_score <= 0 )
560 /* Special case: test if we requested a particular intf plugin */
561 if( !i_shortcuts && p_module->psz_program
562 && !strcmp( psz_capability, "interface" )
563 && !strcmp( p_module->psz_program,
564 p_this->p_libvlc->psz_object_name ) )
568 /* Remove previous non-matching plugins */
575 /* This one doesn't match */
579 /* Store this new module */
580 p_list[ i_index ].p_module = p_module;
581 p_list[ i_index ].i_score = p_module->i_score + i_shortcut_bonus;
582 p_list[ i_index ].b_force = i_shortcut_bonus && b_strict;
584 /* Add it to the modules-to-probe list */
587 p_list[ 0 ].p_next = NULL;
592 /* Ok, so at school you learned that quicksort is quick, and
593 * bubble sort sucks raw eggs. But that's when dealing with
594 * thousands of items. Here we have barely 50. */
595 module_list_t *p_newlist = p_first;
597 if( p_first->i_score < p_list[ i_index ].i_score )
599 p_list[ i_index ].p_next = p_first;
600 p_first = &p_list[ i_index ];
604 while( p_newlist->p_next != NULL &&
605 p_newlist->p_next->i_score >= p_list[ i_index ].i_score )
607 p_newlist = p_newlist->p_next;
610 p_list[ i_index ].p_next = p_newlist->p_next;
611 p_newlist->p_next = &p_list[ i_index ];
618 msg_Dbg( p_this, "looking for %s module: %i candidate%s", psz_capability,
619 i_index, i_index == 1 ? "" : "s" );
621 /* Lock all candidate modules */
623 while( p_tmp != NULL )
625 vlc_object_yield( p_tmp->p_module );
626 p_tmp = p_tmp->p_next;
629 /* We can release the list, interesting modules were yielded */
630 vlc_list_release( p_all );
632 /* Parse the linked list and use the first successful module */
634 while( p_tmp != NULL )
636 #ifdef HAVE_DYNAMIC_PLUGINS
637 /* Make sure the module is loaded in mem */
638 module_t *p_module = p_tmp->p_module->b_submodule ?
639 (module_t *)p_tmp->p_module->p_parent : p_tmp->p_module;
640 if( !p_module->b_builtin && !p_module->b_loaded )
642 module_t *p_new_module =
643 AllocatePlugin( p_this, p_module->psz_filename );
646 CacheMerge( p_this, p_module, p_new_module );
647 vlc_object_attach( p_new_module, p_module );
648 DeleteModule( p_new_module );
653 p_this->b_force = p_tmp->b_force;
654 if( p_tmp->p_module->pf_activate
655 && p_tmp->p_module->pf_activate( p_this ) == VLC_SUCCESS )
660 vlc_object_release( p_tmp->p_module );
661 p_tmp = p_tmp->p_next;
664 /* Store the locked module value */
667 p_module = p_tmp->p_module;
668 p_tmp = p_tmp->p_next;
675 /* Unlock the remaining modules */
676 while( p_tmp != NULL )
678 vlc_object_release( p_tmp->p_module );
679 p_tmp = p_tmp->p_next;
683 p_this->b_force = b_force_backup;
685 if( p_module != NULL )
687 msg_Dbg( p_this, "using %s module \"%s\"",
688 psz_capability, p_module->psz_object_name );
690 else if( p_first == NULL )
692 if( !strcmp( psz_capability, "access_demux" ) )
694 msg_Warn( p_this, "no %s module matched \"%s\"",
695 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
699 msg_Err( p_this, "no %s module matched \"%s\"",
700 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
703 else if( psz_name != NULL && *psz_name )
705 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
706 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
711 free( psz_shortcuts );
719 /* Don't forget that the module is still locked */
723 /*****************************************************************************
724 * module_Unneed: decrease the usage count of a module.
725 *****************************************************************************
726 * This function must be called by the thread that called module_Need, to
727 * decrease the reference count and allow for hiding of modules.
728 *****************************************************************************/
729 void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
731 /* Use the close method */
732 if( p_module->pf_deactivate )
734 p_module->pf_deactivate( p_this );
737 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
739 vlc_object_release( p_module );
744 /*****************************************************************************
745 * Following functions are local.
746 *****************************************************************************/
748 /*****************************************************************************
749 * AllocateAllPlugins: load all plugin modules we can find.
750 *****************************************************************************/
751 #ifdef HAVE_DYNAMIC_PLUGINS
752 static void AllocateAllPlugins( vlc_object_t *p_this )
754 /* Yes, there are two NULLs because we replace one with "plugin-path". */
755 #if defined( WIN32 ) || defined( UNDER_CE )
756 const char *path[] = { "modules", "", "plugins", NULL, NULL };
758 const char *path[] = { "modules", PLUGIN_PATH, "plugins", NULL, NULL };
761 const char *const *ppsz_path;
763 /* If the user provided a plugin path, we add it to the list */
764 char *userpath = config_GetPsz( p_this, "plugin-path" );
765 path[sizeof(path)/sizeof(path[0]) - 2] = userpath;
767 for (ppsz_path = path; *ppsz_path != NULL; ppsz_path++)
771 if (!**ppsz_path) continue;
773 #if defined( SYS_BEOS ) || defined( __APPLE__ ) || defined( WIN32 )
775 /* Handle relative as well as absolute paths */
777 if( (*ppsz_path)[0] != '\\' && (*ppsz_path)[0] != '/' &&
778 (*ppsz_path)[1] != ':' )
780 if( (*ppsz_path)[0] != '/' )
783 if( 0>= asprintf(&psz_fullpath, "%s"DIR_SEP"%s",
784 p_this->p_libvlc_global->psz_vlcpath, *ppsz_path) )
789 psz_fullpath = strdup( *ppsz_path );
791 if( psz_fullpath == NULL )
794 msg_Dbg( p_this, "recursively browsing `%s'", psz_fullpath );
796 /* Don't go deeper than 5 subdirectories */
797 AllocatePluginDir( p_this, psz_fullpath, 5 );
799 free( psz_fullpath );
802 /* Free plugin-path */
803 if( userpath != NULL )
807 /*****************************************************************************
808 * AllocatePluginDir: recursively parse a directory to look for plugins
809 *****************************************************************************/
810 static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
813 #if defined( UNDER_CE ) || defined( _MSC_VER )
815 wchar_t psz_wpath[MAX_PATH + 256];
816 wchar_t psz_wdir[MAX_PATH];
818 char psz_path[MAX_PATH + 256];
819 WIN32_FIND_DATA finddata;
825 struct dirent * file;
829 if( p_this->p_libvlc->b_die || i_maxdepth < 0 )
834 #if defined( UNDER_CE ) || defined( _MSC_VER )
836 MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
838 rc = GetFileAttributes( psz_wdir );
839 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
841 /* Parse all files in the directory */
842 swprintf( psz_wpath, L"%ls\\*", psz_wdir );
844 rc = GetFileAttributes( psz_dir );
845 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
848 /* Parse all files in the directory */
849 sprintf( psz_path, "%s\\*", psz_dir );
852 handle = FindFirstFile( psz_wpath, &finddata );
854 handle = FindFirstFile( psz_path, &finddata );
856 if( handle == INVALID_HANDLE_VALUE )
858 /* Empty directory */
862 /* Parse the directory and try to load all files it contains. */
866 unsigned int i_len = wcslen( finddata.cFileName );
867 swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
868 sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
870 unsigned int i_len = strlen( finddata.cFileName );
871 sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
875 if( !*finddata.cFileName || !strcmp( finddata.cFileName, "." )
876 || !strcmp( finddata.cFileName, ".." ) )
878 if( !FindNextFile( handle, &finddata ) ) break;
883 if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
885 if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
888 AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
890 else if( i_len > strlen( LIBEXT )
891 /* We only load files ending with LIBEXT */
892 && !strncasecmp( psz_path + strlen( psz_path)
894 LIBEXT, strlen( LIBEXT ) ) )
896 WIN32_FILE_ATTRIBUTE_DATA attrbuf;
897 int64_t i_time = 0, i_size = 0;
900 if( GetFileAttributesEx( psz_wpath, GetFileExInfoStandard,
903 if( GetFileAttributesEx( psz_path, GetFileExInfoStandard,
907 i_time = attrbuf.ftLastWriteTime.dwHighDateTime;
909 i_time |= attrbuf.ftLastWriteTime.dwLowDateTime;
910 i_size = attrbuf.nFileSizeHigh;
912 i_size |= attrbuf.nFileSizeLow;
916 AllocatePluginFile( p_this, psz_file, i_time, i_size );
919 while( !p_this->p_libvlc->b_die && FindNextFile( handle, &finddata ) );
921 /* Close the directory */
925 dir = opendir( psz_dir );
931 i_dirlen = strlen( psz_dir );
933 /* Parse the directory and try to load all files it contains. */
934 while( !p_this->p_libvlc->b_die && (file = readdir( dir )) )
941 if( !*file->d_name || !strcmp( file->d_name, "." )
942 || !strcmp( file->d_name, ".." ) )
947 i_len = strlen( file->d_name );
948 psz_file = malloc( i_dirlen + 1 + i_len + 1 );
950 sprintf( psz_file, "%s\\%s", psz_dir, file->d_name );
952 sprintf( psz_file, "%s/%s", psz_dir, file->d_name );
955 i_stat = stat( psz_file, &statbuf );
956 if( !i_stat && statbuf.st_mode & S_IFDIR )
958 AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
960 else if( i_len > strlen( LIBEXT )
961 /* We only load files ending with LIBEXT */
962 && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
963 LIBEXT, strlen( LIBEXT ) ) )
965 int64_t i_time = 0, i_size = 0;
969 i_time = statbuf.st_mtime;
970 i_size = statbuf.st_size;
973 AllocatePluginFile( p_this, psz_file, i_time, i_size );
979 /* Close the directory */
985 /*****************************************************************************
986 * AllocatePluginFile: load a module into memory and initialize it.
987 *****************************************************************************
988 * This function loads a dynamically loadable module and allocates a structure
989 * for its information data. The module can then be handled by module_Need
990 * and module_Unneed. It can be removed by DeleteModule.
991 *****************************************************************************/
992 static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
993 int64_t i_file_time, int64_t i_file_size )
996 module_cache_t *p_cache_entry = NULL;
999 * Check our plugins cache first then load plugin if needed
1002 CacheFind( p_this, psz_file, i_file_time, i_file_size );
1004 if( !p_cache_entry )
1006 p_module = AllocatePlugin( p_this, psz_file );
1010 /* If junk dll, don't try to load it */
1011 if( p_cache_entry->b_junk )
1017 module_config_t *p_item;
1019 p_module = p_cache_entry->p_module;
1020 p_module->b_loaded = VLC_FALSE;
1022 /* For now we force loading if the module's config contains
1023 * callbacks or actions.
1024 * Could be optimized by adding an API call.*/
1025 for( p_item = p_module->p_config;
1026 p_item->i_type != CONFIG_HINT_END; p_item++ )
1028 if( p_item->pf_callback || p_item->i_action )
1029 p_module = AllocatePlugin( p_this, psz_file );
1036 /* Everything worked fine !
1037 * The module is ready to be added to the list. */
1038 p_module->b_builtin = VLC_FALSE;
1040 /* msg_Dbg( p_this, "plugin \"%s\", %s",
1041 p_module->psz_object_name, p_module->psz_longname ); */
1043 vlc_object_attach( p_module, p_this->p_libvlc_global->p_module_bank );
1046 if( !p_this->p_libvlc_global->p_module_bank->b_cache ) return 0;
1048 /* Add entry to cache */
1049 #define p_bank p_this->p_libvlc_global->p_module_bank
1051 realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1052 p_bank->pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1053 p_bank->pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1054 p_bank->pp_cache[p_bank->i_cache]->i_time = i_file_time;
1055 p_bank->pp_cache[p_bank->i_cache]->i_size = i_file_size;
1056 p_bank->pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1057 p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
1060 return p_module ? 0 : -1;
1063 /*****************************************************************************
1064 * AllocatePlugin: load a module into memory and initialize it.
1065 *****************************************************************************
1066 * This function loads a dynamically loadable module and allocates a structure
1067 * for its information data. The module can then be handled by module_Need
1068 * and module_Unneed. It can be removed by DeleteModule.
1069 *****************************************************************************/
1070 static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
1072 module_t * p_module;
1073 module_handle_t handle;
1075 if( LoadModule( p_this, psz_file, &handle ) ) return NULL;
1077 /* Now that we have successfully loaded the module, we can
1078 * allocate a structure for it */
1079 p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
1080 if( p_module == NULL )
1082 msg_Err( p_this, "out of memory" );
1083 CloseModule( handle );
1087 /* We need to fill these since they may be needed by CallEntry() */
1088 p_module->psz_filename = psz_file;
1089 p_module->handle = handle;
1090 #ifndef HAVE_SHARED_LIBVLC
1091 p_module->p_symbols = &p_this->p_libvlc_global->p_module_bank->symbols;
1093 p_module->b_loaded = VLC_TRUE;
1095 /* Initialize the module: fill p_module, default config */
1096 if( CallEntry( p_module ) != 0 )
1098 /* We couldn't call module_init() */
1099 vlc_object_destroy( p_module );
1100 CloseModule( handle );
1104 DupModule( p_module );
1105 p_module->psz_filename = strdup( p_module->psz_filename );
1107 /* Everything worked fine ! The module is ready to be added to the list. */
1108 p_module->b_builtin = VLC_FALSE;
1113 /*****************************************************************************
1114 * DupModule: make a plugin module standalone.
1115 *****************************************************************************
1116 * This function duplicates all strings in the module, so that the dynamic
1117 * object can be unloaded. It acts recursively on submodules.
1118 *****************************************************************************/
1119 static void DupModule( module_t *p_module )
1121 const char **pp_shortcut;
1124 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1126 *pp_shortcut = strdup( *pp_shortcut );
1129 /* We strdup() these entries so that they are still valid when the
1130 * module is unloaded. */
1131 p_module->psz_object_name = strdup( p_module->psz_object_name );
1132 p_module->psz_capability = strdup( p_module->psz_capability );
1133 p_module->psz_shortname = p_module->psz_shortname ?
1134 strdup( p_module->psz_shortname ) : NULL;
1135 p_module->psz_longname = strdup( p_module->psz_longname );
1137 if( p_module->psz_program != NULL )
1139 p_module->psz_program = strdup( p_module->psz_program );
1142 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1144 DupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1148 /*****************************************************************************
1149 * UndupModule: free a duplicated module.
1150 *****************************************************************************
1151 * This function frees the allocations done in DupModule().
1152 *****************************************************************************/
1153 static void UndupModule( module_t *p_module )
1155 const char **pp_shortcut;
1158 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1160 UndupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1163 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1165 free( (void *)*pp_shortcut );
1168 free( (void *)p_module->psz_object_name );
1169 free( (void *)p_module->psz_capability );
1170 if( p_module->psz_shortname ) free( (void *)p_module->psz_shortname );
1171 free( (void *)p_module->psz_longname );
1173 if( p_module->psz_program != NULL )
1175 free( (void *)p_module->psz_program );
1179 #endif /* HAVE_DYNAMIC_PLUGINS */
1181 /*****************************************************************************
1182 * AllocateBuiltinModule: initialize a builtin module.
1183 *****************************************************************************
1184 * This function registers a builtin module and allocates a structure
1185 * for its information data. The module can then be handled by module_Need
1186 * and module_Unneed. It can be removed by DeleteModule.
1187 *****************************************************************************/
1188 static int AllocateBuiltinModule( vlc_object_t * p_this,
1189 int ( *pf_entry ) ( module_t * ) )
1191 module_t * p_module;
1193 /* Now that we have successfully loaded the module, we can
1194 * allocate a structure for it */
1195 p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
1196 if( p_module == NULL )
1198 msg_Err( p_this, "out of memory" );
1202 /* Initialize the module : fill p_module->psz_object_name, etc. */
1203 if( pf_entry( p_module ) != 0 )
1205 /* With a well-written module we shouldn't have to print an
1206 * additional error message here, but just make sure. */
1207 msg_Err( p_this, "failed calling entry point in builtin module" );
1208 vlc_object_destroy( p_module );
1212 /* Everything worked fine ! The module is ready to be added to the list. */
1213 p_module->b_builtin = VLC_TRUE;
1215 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1216 p_module->psz_object_name, p_module->psz_longname ); */
1218 vlc_object_attach( p_module, p_this->p_libvlc_global->p_module_bank );
1223 /*****************************************************************************
1224 * DeleteModule: delete a module and its structure.
1225 *****************************************************************************
1226 * This function can only be called if the module isn't being used.
1227 *****************************************************************************/
1228 static int DeleteModule( module_t * p_module )
1230 vlc_object_detach( p_module );
1232 /* We free the structures that we strdup()ed in Allocate*Module(). */
1233 #ifdef HAVE_DYNAMIC_PLUGINS
1234 if( !p_module->b_builtin )
1236 if( p_module->b_loaded && p_module->b_unloadable )
1238 CloseModule( p_module->handle );
1240 UndupModule( p_module );
1241 free( p_module->psz_filename );
1245 /* Free and detach the object's children */
1246 while( p_module->i_children )
1248 vlc_object_t *p_this = p_module->pp_children[0];
1249 vlc_object_detach( p_this );
1250 vlc_object_destroy( p_this );
1253 config_Free( p_module );
1254 vlc_object_destroy( p_module );
1259 #ifdef HAVE_DYNAMIC_PLUGINS
1260 /*****************************************************************************
1261 * CallEntry: call an entry point.
1262 *****************************************************************************
1263 * This function calls a symbol given its name and a module structure. The
1264 * symbol MUST refer to a function returning int and taking a module_t* as
1266 *****************************************************************************/
1267 static int CallEntry( module_t * p_module )
1269 static const char * const psz_name = "vlc_entry" MODULE_SUFFIX;
1270 int (* pf_symbol) ( module_t * p_module );
1272 /* Try to resolve the symbol */
1273 pf_symbol = (int (*)(module_t *)) GetSymbol( p_module->handle, psz_name );
1275 if( pf_symbol == NULL )
1277 #if defined(HAVE_DL_DYLD) || defined(HAVE_DL_BEOS)
1278 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s'",
1279 psz_name, p_module->psz_filename );
1280 #elif defined(HAVE_DL_WINDOWS)
1281 char *psz_error = GetWindowsError();
1282 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1283 psz_name, p_module->psz_filename, psz_error );
1285 #elif defined(HAVE_DL_DLOPEN)
1286 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1287 psz_name, p_module->psz_filename, dlerror() );
1288 #elif defined(HAVE_DL_SHL_LOAD)
1289 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1290 psz_name, p_module->psz_filename, strerror(errno) );
1292 # error "Something is wrong in modules.c"
1297 /* We can now try to call the symbol */
1298 if( pf_symbol( p_module ) != 0 )
1300 /* With a well-written module we shouldn't have to print an
1301 * additional error message here, but just make sure. */
1302 msg_Err( p_module, "Failed to call symbol \"%s\" in file `%s'",
1303 psz_name, p_module->psz_filename );
1307 /* Everything worked fine, we can return */
1311 /*****************************************************************************
1312 * LoadModule: loads a dynamic library
1313 *****************************************************************************
1314 * This function loads a dynamically linked library using a system dependant
1315 * method. Will return 0 on success as well as the module handle.
1316 *****************************************************************************/
1317 static int LoadModule( vlc_object_t *p_this, char *psz_file,
1318 module_handle_t *p_handle )
1320 module_handle_t handle;
1322 #if defined(HAVE_DL_DYLD)
1323 NSObjectFileImage image;
1324 NSObjectFileImageReturnCode ret;
1326 ret = NSCreateObjectFileImageFromFile( psz_file, &image );
1328 if( ret != NSObjectFileImageSuccess )
1330 msg_Warn( p_this, "cannot create image from `%s'", psz_file );
1334 /* Open the dynamic module */
1335 handle = NSLinkModule( image, psz_file,
1336 NSLINKMODULE_OPTION_RETURN_ON_ERROR );
1340 NSLinkEditErrors errors;
1341 const char *psz_file, *psz_err;
1343 NSLinkEditError( &errors, &i_errnum, &psz_file, &psz_err );
1344 msg_Warn( p_this, "cannot link module `%s' (%s)", psz_file, psz_err );
1345 NSDestroyObjectFileImage( image );
1349 /* Destroy our image, we won't need it */
1350 NSDestroyObjectFileImage( image );
1352 #elif defined(HAVE_DL_BEOS)
1353 handle = load_add_on( psz_file );
1356 msg_Warn( p_this, "cannot load module `%s'", psz_file );
1360 #elif defined(HAVE_DL_WINDOWS)
1363 wchar_t psz_wfile[MAX_PATH];
1364 MultiByteToWideChar( CP_ACP, 0, psz_file, -1, psz_wfile, MAX_PATH );
1365 handle = LoadLibrary( psz_wfile );
1368 handle = LoadLibrary( psz_file );
1370 if( handle == NULL )
1372 char *psz_err = GetWindowsError();
1373 msg_Warn( p_this, "cannot load module `%s' (%s)", psz_file, psz_err );
1378 #elif defined(HAVE_DL_DLOPEN) && defined(RTLD_NOW)
1379 /* static is OK, we are called atomically */
1381 # if defined(SYS_LINUX)
1382 /* XXX HACK #1 - we should NOT open modules with RTLD_GLOBAL, or we
1383 * are going to get namespace collisions when two modules have common
1384 * public symbols, but ALSA is being a pest here. */
1385 if( strstr( psz_file, "alsa_plugin" ) )
1387 handle = dlopen( psz_file, RTLD_NOW | RTLD_GLOBAL );
1388 if( handle == NULL )
1390 msg_Warn( p_this, "cannot load module `%s' (%s)",
1391 psz_file, dlerror() );
1397 handle = dlopen( psz_file, RTLD_NOW );
1398 if( handle == NULL )
1400 msg_Warn( p_this, "cannot load module `%s' (%s)",
1401 psz_file, dlerror() );
1405 #elif defined(HAVE_DL_DLOPEN)
1406 # if defined(DL_LAZY)
1407 handle = dlopen( psz_file, DL_LAZY );
1409 handle = dlopen( psz_file, 0 );
1411 if( handle == NULL )
1413 msg_Warn( p_this, "cannot load module `%s' (%s)",
1414 psz_file, dlerror() );
1418 #elif defined(HAVE_DL_SHL_LOAD)
1419 handle = shl_load( psz_file, BIND_IMMEDIATE | BIND_NONFATAL, NULL );
1420 if( handle == NULL )
1422 msg_Warn( p_this, "cannot load module `%s' (%s)",
1423 psz_file, strerror(errno) );
1428 # error "Something is wrong in modules.c"
1436 /*****************************************************************************
1437 * CloseModule: unload a dynamic library
1438 *****************************************************************************
1439 * This function unloads a previously opened dynamically linked library
1440 * using a system dependant method. No return value is taken in consideration,
1441 * since some libraries sometimes refuse to close properly.
1442 *****************************************************************************/
1443 static void CloseModule( module_handle_t handle )
1445 #if defined(HAVE_DL_DYLD)
1446 NSUnLinkModule( handle, FALSE );
1448 #elif defined(HAVE_DL_BEOS)
1449 unload_add_on( handle );
1451 #elif defined(HAVE_DL_WINDOWS)
1452 FreeLibrary( handle );
1454 #elif defined(HAVE_DL_DLOPEN)
1457 #elif defined(HAVE_DL_SHL_LOAD)
1458 shl_unload( handle );
1464 /*****************************************************************************
1465 * GetSymbol: get a symbol from a dynamic library
1466 *****************************************************************************
1467 * This function queries a loaded library for a symbol specified in a
1468 * string, and returns a pointer to it. We don't check for dlerror() or
1469 * similar functions, since we want a non-NULL symbol anyway.
1470 *****************************************************************************/
1471 static void * _module_getsymbol( module_handle_t, const char * );
1473 static void * GetSymbol( module_handle_t handle, const char * psz_function )
1475 void * p_symbol = _module_getsymbol( handle, psz_function );
1477 /* MacOS X dl library expects symbols to begin with "_". So do
1478 * some other operating systems. That's really lame, but hey, what
1480 if( p_symbol == NULL )
1482 char *psz_call = malloc( strlen( psz_function ) + 2 );
1484 strcpy( psz_call + 1, psz_function );
1485 psz_call[ 0 ] = '_';
1486 p_symbol = _module_getsymbol( handle, psz_call );
1493 static void * _module_getsymbol( module_handle_t handle,
1494 const char * psz_function )
1496 #if defined(HAVE_DL_DYLD)
1497 NSSymbol sym = NSLookupSymbolInModule( handle, psz_function );
1498 return NSAddressOfSymbol( sym );
1500 #elif defined(HAVE_DL_BEOS)
1502 if( B_OK == get_image_symbol( handle, psz_function,
1503 B_SYMBOL_TYPE_TEXT, &p_symbol ) )
1512 #elif defined(HAVE_DL_WINDOWS) && defined(UNDER_CE)
1513 wchar_t psz_real[256];
1514 MultiByteToWideChar( CP_ACP, 0, psz_function, -1, psz_real, 256 );
1516 return (void *)GetProcAddress( handle, psz_real );
1518 #elif defined(HAVE_DL_WINDOWS) && defined(WIN32)
1519 return (void *)GetProcAddress( handle, (char *)psz_function );
1521 #elif defined(HAVE_DL_DLOPEN)
1522 return dlsym( handle, psz_function );
1524 #elif defined(HAVE_DL_SHL_LOAD)
1526 shl_findsym( &handle, psz_function, TYPE_UNDEFINED, &p_sym );
1532 #if defined(HAVE_DL_WINDOWS)
1533 static char * GetWindowsError( void )
1535 #if defined(UNDER_CE)
1536 wchar_t psz_tmp[MAX_PATH];
1537 char * psz_buffer = malloc( MAX_PATH );
1539 char * psz_tmp = malloc( MAX_PATH );
1541 int i = 0, i_error = GetLastError();
1543 FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
1544 NULL, i_error, MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT),
1545 (LPTSTR)psz_tmp, MAX_PATH, NULL );
1547 /* Go to the end of the string */
1548 while( psz_tmp[i] && psz_tmp[i] != _T('\r') && psz_tmp[i] != _T('\n') )
1555 #if defined(UNDER_CE)
1556 swprintf( psz_tmp + i, L" (error %i)", i_error );
1557 psz_tmp[ 255 ] = L'\0';
1559 snprintf( psz_tmp + i, 256 - i, " (error %i)", i_error );
1560 psz_tmp[ 255 ] = '\0';
1564 #if defined(UNDER_CE)
1565 wcstombs( psz_buffer, psz_tmp, MAX_PATH );
1571 #endif /* HAVE_DL_WINDOWS */
1573 /*****************************************************************************
1574 * LoadPluginsCache: loads the plugins cache file
1575 *****************************************************************************
1576 * This function will load the plugin cache if present and valid. This cache
1577 * will in turn be queried by AllocateAllPlugins() to see if it needs to
1578 * actually load the dynamically loadable module.
1579 * This allows us to only fully load plugins when they are actually used.
1580 *****************************************************************************/
1581 static void CacheLoad( vlc_object_t *p_this )
1583 char *psz_filename, *psz_homedir;
1585 int i, j, i_size, i_read;
1586 char p_cachestring[sizeof(PLUGINSCACHE_DIR COPYRIGHT_MESSAGE)];
1587 char p_cachelang[6], p_lang[6];
1589 module_cache_t **pp_cache = 0;
1590 int32_t i_file_size, i_marker;
1592 psz_homedir = p_this->p_libvlc->psz_homedir;
1595 msg_Err( p_this, "psz_homedir is null" );
1599 i_size = asprintf( &psz_filename, "%s/%s/%s/%s", psz_homedir, CONFIG_DIR,
1600 PLUGINSCACHE_DIR, CacheName() );
1603 msg_Err( p_this, "out of memory" );
1607 if( p_this->p_libvlc_global->p_module_bank->b_cache_delete )
1609 #if !defined( UNDER_CE )
1610 unlink( psz_filename );
1612 wchar_t psz_wf[MAX_PATH];
1613 MultiByteToWideChar( CP_ACP, 0, psz_filename, -1, psz_wf, MAX_PATH );
1614 DeleteFile( psz_wf );
1616 msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
1617 free( psz_filename );
1621 msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
1623 file = utf8_fopen( psz_filename, "rb" );
1626 msg_Warn( p_this, "could not open plugins cache file %s for reading",
1628 free( psz_filename );
1631 free( psz_filename );
1633 /* Check the file size */
1634 i_read = fread( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1635 if( i_read != sizeof(i_file_size) )
1637 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1643 fseek( file, 0, SEEK_END );
1644 if( ftell( file ) != i_file_size )
1646 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1647 "(corrupted size)" );
1651 fseek( file, sizeof(i_file_size), SEEK_SET );
1653 /* Check the file is a plugins cache */
1654 i_size = sizeof(PLUGINSCACHE_DIR COPYRIGHT_MESSAGE) - 1;
1655 i_read = fread( p_cachestring, sizeof(char), i_size, file );
1656 if( i_read != i_size ||
1657 memcmp( p_cachestring, PLUGINSCACHE_DIR COPYRIGHT_MESSAGE, i_size ) )
1659 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
1664 /* Check Sub-version number */
1665 i_read = fread( &i_marker, sizeof(char), sizeof(i_marker), file );
1666 if( i_read != sizeof(i_marker) || i_marker != CACHE_SUBVERSION_NUM )
1668 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1669 "(corrupted header)" );
1674 /* Check the language hasn't changed */
1675 sprintf( p_lang, "%5.5s", _("C") ); i_size = 5;
1676 i_read = fread( p_cachelang, sizeof(char), i_size, file );
1677 if( i_read != i_size || memcmp( p_cachelang, p_lang, i_size ) )
1679 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1680 "(language changed)" );
1685 /* Check header marker */
1686 i_read = fread( &i_marker, sizeof(char), sizeof(i_marker), file );
1687 if( i_read != sizeof(i_marker) ||
1688 i_marker != ftell( file ) - (int)sizeof(i_marker) )
1690 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1691 "(corrupted header)" );
1696 p_this->p_libvlc_global->p_module_bank->i_loaded_cache = 0;
1697 fread( &i_cache, sizeof(char), sizeof(i_cache), file );
1699 pp_cache = p_this->p_libvlc_global->p_module_bank->pp_loaded_cache =
1700 malloc( i_cache * sizeof(void *) );
1702 #define LOAD_IMMEDIATE(a) \
1703 if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
1704 #define LOAD_STRING(a) \
1705 { if( fread( &i_size, sizeof(char), sizeof(i_size), file ) \
1706 != sizeof(i_size) ) goto error; \
1707 if( i_size && i_size < 16384 ) { \
1708 a = malloc( i_size ); \
1709 if( fread( (void *)a, sizeof(char), i_size, file ) != (size_t)i_size ) \
1711 if( a[i_size-1] ) { \
1712 free( (void *)a ); a = 0; \
1718 for( i = 0; i < i_cache; i++ )
1723 pp_cache[i] = malloc( sizeof(module_cache_t) );
1724 p_this->p_libvlc_global->p_module_bank->i_loaded_cache++;
1726 /* Load common info */
1727 LOAD_STRING( pp_cache[i]->psz_file );
1728 LOAD_IMMEDIATE( pp_cache[i]->i_time );
1729 LOAD_IMMEDIATE( pp_cache[i]->i_size );
1730 LOAD_IMMEDIATE( pp_cache[i]->b_junk );
1732 if( pp_cache[i]->b_junk ) continue;
1734 pp_cache[i]->p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
1736 /* Load additional infos */
1737 LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
1738 LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
1739 LOAD_STRING( pp_cache[i]->p_module->psz_longname );
1740 LOAD_STRING( pp_cache[i]->p_module->psz_program );
1741 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1743 LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
1745 LOAD_STRING( pp_cache[i]->p_module->psz_capability );
1746 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
1747 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
1748 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
1749 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
1750 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
1753 if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
1756 LOAD_STRING( pp_cache[i]->p_module->psz_filename );
1758 LOAD_IMMEDIATE( i_submodules );
1760 while( i_submodules-- )
1762 module_t *p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE);
1763 vlc_object_attach( p_module, pp_cache[i]->p_module );
1764 p_module->b_submodule = VLC_TRUE;
1766 LOAD_STRING( p_module->psz_object_name );
1767 LOAD_STRING( p_module->psz_shortname );
1768 LOAD_STRING( p_module->psz_longname );
1769 LOAD_STRING( p_module->psz_program );
1770 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1772 LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
1774 LOAD_STRING( p_module->psz_capability );
1775 LOAD_IMMEDIATE( p_module->i_score );
1776 LOAD_IMMEDIATE( p_module->i_cpu );
1777 LOAD_IMMEDIATE( p_module->b_unloadable );
1778 LOAD_IMMEDIATE( p_module->b_reentrant );
1787 msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
1790 p_this->p_libvlc_global->p_module_bank->i_loaded_cache = 0;
1796 int CacheLoadConfig( module_t *p_module, FILE *file )
1801 /* Calculate the structure length */
1802 LOAD_IMMEDIATE( p_module->i_config_items );
1803 LOAD_IMMEDIATE( p_module->i_bool_items );
1805 LOAD_IMMEDIATE( i_lines );
1807 /* Allocate memory */
1808 p_module->p_config =
1809 (module_config_t *)malloc( sizeof(module_config_t) * (i_lines + 1));
1810 if( p_module->p_config == NULL )
1812 msg_Err( p_module, "config error: can't duplicate p_config" );
1816 /* Do the duplication job */
1817 for( i = 0; i < i_lines ; i++ )
1819 LOAD_IMMEDIATE( p_module->p_config[i] );
1821 LOAD_STRING( p_module->p_config[i].psz_type );
1822 LOAD_STRING( p_module->p_config[i].psz_name );
1823 LOAD_STRING( p_module->p_config[i].psz_text );
1824 LOAD_STRING( p_module->p_config[i].psz_longtext );
1825 LOAD_STRING( p_module->p_config[i].psz_current );
1826 LOAD_STRING( p_module->p_config[i].psz_value_orig );
1828 p_module->p_config[i].psz_value =
1829 p_module->p_config[i].psz_value_orig ?
1830 strdup( p_module->p_config[i].psz_value_orig ) : 0;
1831 p_module->p_config[i].i_value = p_module->p_config[i].i_value_orig;
1832 p_module->p_config[i].f_value = p_module->p_config[i].f_value_orig;
1833 p_module->p_config[i].i_value_saved = p_module->p_config[i].i_value;
1834 p_module->p_config[i].f_value_saved = p_module->p_config[i].f_value;
1835 p_module->p_config[i].psz_value_saved = 0;
1836 p_module->p_config[i].b_dirty = VLC_FALSE;
1838 p_module->p_config[i].p_lock = &p_module->object_lock;
1840 if( p_module->p_config[i].i_list )
1842 if( p_module->p_config[i].ppsz_list )
1844 p_module->p_config[i].ppsz_list =
1845 malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1846 if( p_module->p_config[i].ppsz_list )
1848 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1849 LOAD_STRING( p_module->p_config[i].ppsz_list[j] );
1850 p_module->p_config[i].ppsz_list[j] = NULL;
1853 if( p_module->p_config[i].ppsz_list_text )
1855 p_module->p_config[i].ppsz_list_text =
1856 malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1857 if( p_module->p_config[i].ppsz_list_text )
1859 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1860 LOAD_STRING( p_module->p_config[i].ppsz_list_text[j] );
1861 p_module->p_config[i].ppsz_list_text[j] = NULL;
1864 if( p_module->p_config[i].pi_list )
1866 p_module->p_config[i].pi_list =
1867 malloc( (p_module->p_config[i].i_list + 1) * sizeof(int) );
1868 if( p_module->p_config[i].pi_list )
1870 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1871 LOAD_IMMEDIATE( p_module->p_config[i].pi_list[j] );
1876 if( p_module->p_config[i].i_action )
1878 p_module->p_config[i].ppf_action =
1879 malloc( p_module->p_config[i].i_action * sizeof(void *) );
1880 p_module->p_config[i].ppsz_action_text =
1881 malloc( p_module->p_config[i].i_action * sizeof(char *) );
1883 for( j = 0; j < p_module->p_config[i].i_action; j++ )
1885 p_module->p_config[i].ppf_action[j] = 0;
1886 LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
1890 LOAD_IMMEDIATE( p_module->p_config[i].pf_callback );
1893 p_module->p_config[i].i_type = CONFIG_HINT_END;
1899 return VLC_EGENERIC;
1902 /*****************************************************************************
1903 * SavePluginsCache: saves the plugins cache to a file
1904 *****************************************************************************/
1905 static void CacheSave( vlc_object_t *p_this )
1907 static char const psz_tag[] =
1908 "Signature: 8a477f597d28d172789f06886806bc55\r\n"
1909 "# This file is a cache directory tag created by VLC.\r\n"
1910 "# For information about cache directory tags, see:\r\n"
1911 "# http://www.brynosaurus.com/cachedir/\r\n";
1913 char *psz_filename, *psz_homedir;
1916 module_cache_t **pp_cache;
1917 int32_t i_file_size = 0;
1919 psz_homedir = p_this->p_libvlc->psz_homedir;
1922 msg_Err( p_this, "psz_homedir is null" );
1926 (char *)malloc( sizeof("/" CONFIG_DIR "/" PLUGINSCACHE_DIR "/" ) +
1927 strlen(psz_homedir) + strlen(CacheName()) );
1931 msg_Err( p_this, "out of memory" );
1935 sprintf( psz_filename, "%s/%s", psz_homedir, CONFIG_DIR );
1937 config_CreateDir( p_this, psz_filename );
1939 strcat( psz_filename, "/" PLUGINSCACHE_DIR );
1941 config_CreateDir( p_this, psz_filename );
1943 strcat( psz_filename, "/CACHEDIR.TAG" );
1945 file = utf8_fopen( psz_filename, "wb" );
1948 fwrite( psz_tag, 1, strlen(psz_tag), file );
1952 sprintf( psz_filename, "%s/%s/%s/%s", psz_homedir, CONFIG_DIR,
1953 PLUGINSCACHE_DIR, CacheName() );
1955 msg_Dbg( p_this, "saving plugins cache file %s", psz_filename );
1957 file = utf8_fopen( psz_filename, "wb" );
1960 msg_Warn( p_this, "could not open plugins cache file %s for writing",
1962 free( psz_filename );
1965 free( psz_filename );
1967 /* Empty space for file size */
1968 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1970 /* Contains version number */
1971 fprintf( file, "%s", PLUGINSCACHE_DIR COPYRIGHT_MESSAGE );
1973 /* Sub-version number (to avoid breakage in the dev version when cache
1974 * structure changes) */
1975 i_file_size = CACHE_SUBVERSION_NUM;
1976 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1979 fprintf( file, "%5.5s", _("C") );
1982 i_file_size = ftell( file );
1983 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1985 i_cache = p_this->p_libvlc_global->p_module_bank->i_cache;
1986 pp_cache = p_this->p_libvlc_global->p_module_bank->pp_cache;
1988 fwrite( &i_cache, sizeof(char), sizeof(i_cache), file );
1990 #define SAVE_IMMEDIATE(a) \
1991 fwrite( &a, sizeof(char), sizeof(a), file )
1992 #define SAVE_STRING(a) \
1993 { i_size = a ? strlen( a ) + 1 : 0; \
1994 fwrite( &i_size, sizeof(char), sizeof(i_size), file ); \
1995 if( a ) fwrite( a, sizeof(char), i_size, file ); \
1998 for( i = 0; i < i_cache; i++ )
2001 int32_t i_submodule;
2003 /* Save common info */
2004 SAVE_STRING( pp_cache[i]->psz_file );
2005 SAVE_IMMEDIATE( pp_cache[i]->i_time );
2006 SAVE_IMMEDIATE( pp_cache[i]->i_size );
2007 SAVE_IMMEDIATE( pp_cache[i]->b_junk );
2009 if( pp_cache[i]->b_junk ) continue;
2011 /* Save additional infos */
2012 SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
2013 SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
2014 SAVE_STRING( pp_cache[i]->p_module->psz_longname );
2015 SAVE_STRING( pp_cache[i]->p_module->psz_program );
2016 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
2018 SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
2020 SAVE_STRING( pp_cache[i]->p_module->psz_capability );
2021 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
2022 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
2023 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
2024 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
2025 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
2028 CacheSaveConfig( pp_cache[i]->p_module, file );
2030 SAVE_STRING( pp_cache[i]->p_module->psz_filename );
2032 i_submodule = pp_cache[i]->p_module->i_children;
2033 SAVE_IMMEDIATE( i_submodule );
2034 for( i_submodule = 0; i_submodule < pp_cache[i]->p_module->i_children;
2037 module_t *p_module =
2038 (module_t *)pp_cache[i]->p_module->pp_children[i_submodule];
2040 SAVE_STRING( p_module->psz_object_name );
2041 SAVE_STRING( p_module->psz_shortname );
2042 SAVE_STRING( p_module->psz_longname );
2043 SAVE_STRING( p_module->psz_program );
2044 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
2046 SAVE_STRING( p_module->pp_shortcuts[j] ); // FIX
2048 SAVE_STRING( p_module->psz_capability );
2049 SAVE_IMMEDIATE( p_module->i_score );
2050 SAVE_IMMEDIATE( p_module->i_cpu );
2051 SAVE_IMMEDIATE( p_module->b_unloadable );
2052 SAVE_IMMEDIATE( p_module->b_reentrant );
2056 /* Fill-up file size */
2057 i_file_size = ftell( file );
2058 fseek( file, 0, SEEK_SET );
2059 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2066 void CacheSaveConfig( module_t *p_module, FILE *file )
2068 int i, j, i_lines = 0;
2069 module_config_t *p_item;
2072 SAVE_IMMEDIATE( p_module->i_config_items );
2073 SAVE_IMMEDIATE( p_module->i_bool_items );
2075 for( p_item = p_module->p_config; p_item->i_type != CONFIG_HINT_END;
2076 p_item++ ) i_lines++;
2078 SAVE_IMMEDIATE( i_lines );
2080 for( i = 0; i < i_lines ; i++ )
2082 SAVE_IMMEDIATE( p_module->p_config[i] );
2084 SAVE_STRING( p_module->p_config[i].psz_type );
2085 SAVE_STRING( p_module->p_config[i].psz_name );
2086 SAVE_STRING( p_module->p_config[i].psz_text );
2087 SAVE_STRING( p_module->p_config[i].psz_longtext );
2088 SAVE_STRING( p_module->p_config[i].psz_current );
2089 SAVE_STRING( p_module->p_config[i].psz_value_orig );
2091 if( p_module->p_config[i].i_list )
2093 if( p_module->p_config[i].ppsz_list )
2095 for( j = 0; j < p_module->p_config[i].i_list; j++ )
2096 SAVE_STRING( p_module->p_config[i].ppsz_list[j] );
2099 if( p_module->p_config[i].ppsz_list_text )
2101 for( j = 0; j < p_module->p_config[i].i_list; j++ )
2102 SAVE_STRING( p_module->p_config[i].ppsz_list_text[j] );
2104 if( p_module->p_config[i].pi_list )
2106 for( j = 0; j < p_module->p_config[i].i_list; j++ )
2107 SAVE_IMMEDIATE( p_module->p_config[i].pi_list[j] );
2111 for( j = 0; j < p_module->p_config[i].i_action; j++ )
2112 SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );
2114 SAVE_IMMEDIATE( p_module->p_config[i].pf_callback );
2118 /*****************************************************************************
2119 * CacheName: Return the cache file name for this platform.
2120 *****************************************************************************/
2121 static char *CacheName( void )
2123 static char psz_cachename[32];
2125 /* Code int size, pointer size and endianness in the filename */
2126 int32_t x = 0xbe00001e;
2127 sprintf( psz_cachename, "plugins-%.2x%.2x%.2x.dat", (int)sizeof(int),
2128 (int)sizeof(void *), (unsigned int)((unsigned char *)&x)[0] );
2129 return psz_cachename;
2132 /*****************************************************************************
2133 * CacheMerge: Merge a cache module descriptor with a full module descriptor.
2134 *****************************************************************************/
2135 static void CacheMerge( vlc_object_t *p_this, module_t *p_cache,
2136 module_t *p_module )
2140 p_cache->pf_activate = p_module->pf_activate;
2141 p_cache->pf_deactivate = p_module->pf_deactivate;
2142 #ifndef HAVE_SHARED_LIBVLC
2143 p_cache->p_symbols = p_module->p_symbols;
2145 p_cache->handle = p_module->handle;
2147 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
2149 module_t *p_child = (module_t*)p_module->pp_children[i_submodule];
2150 module_t *p_cchild = (module_t*)p_cache->pp_children[i_submodule];
2151 p_cchild->pf_activate = p_child->pf_activate;
2152 p_cchild->pf_deactivate = p_child->pf_deactivate;
2153 #ifndef HAVE_SHARED_LIBVLC
2154 p_cchild->p_symbols = p_child->p_symbols;
2158 p_cache->b_loaded = VLC_TRUE;
2159 p_module->b_loaded = VLC_FALSE;
2162 /*****************************************************************************
2163 * FindPluginCache: finds the cache entry corresponding to a file
2164 *****************************************************************************/
2165 static module_cache_t *CacheFind( vlc_object_t *p_this, char *psz_file,
2166 int64_t i_time, int64_t i_size )
2168 module_cache_t **pp_cache;
2171 pp_cache = p_this->p_libvlc_global->p_module_bank->pp_loaded_cache;
2172 i_cache = p_this->p_libvlc_global->p_module_bank->i_loaded_cache;
2174 for( i = 0; i < i_cache; i++ )
2176 if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
2177 pp_cache[i]->i_time == i_time &&
2178 pp_cache[i]->i_size == i_size ) return pp_cache[i];
2184 #endif /* HAVE_DYNAMIC_PLUGINS */