1 /*****************************************************************************
2 * modules.c : Builtin and plugin modules management functions
3 *****************************************************************************
4 * Copyright (C) 2001-2004 VideoLAN
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
25 *****************************************************************************/
27 /* Some faulty libcs have a broken struct dirent when _FILE_OFFSET_BITS
28 * is set to 64. Don't try to be cleverer. */
29 #ifdef _FILE_OFFSET_BITS
30 #undef _FILE_OFFSET_BITS
33 #include <stdlib.h> /* free(), strtol() */
34 #include <stdio.h> /* sprintf() */
35 #include <string.h> /* strdup() */
38 #include <vlc/input.h>
42 #elif defined( UNDER_CE )
43 # include <windows.h> /* GetFileAttributes() */
45 # include "../extras/dirent.h"
48 #ifdef HAVE_SYS_TYPES_H
49 # include <sys/types.h>
51 #ifdef HAVE_SYS_STAT_H
52 # include <sys/stat.h>
58 #define HAVE_DYNAMIC_PLUGINS
59 #if defined(HAVE_DL_DYLD)
60 # if defined(HAVE_MACH_O_DYLD_H)
61 # include <mach-o/dyld.h>
63 #elif defined(HAVE_DL_BEOS)
64 # if defined(HAVE_IMAGE_H)
67 #elif defined(HAVE_DL_WINDOWS)
69 #elif defined(HAVE_DL_DLOPEN)
70 # if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
73 # if defined(HAVE_SYS_DL_H)
76 #elif defined(HAVE_DL_SHL_LOAD)
77 # if defined(HAVE_DL_H)
81 # undef HAVE_DYNAMIC_PLUGINS
84 #include "vlc_error.h"
86 #include "vlc_interface.h"
87 #include "intf_eject.h"
89 #include "vlc_playlist.h"
91 #include "vlc_video.h"
92 #include "video_output.h"
93 #include "vout_synchro.h"
96 #include "audio_output.h"
97 #include "aout_internal.h"
99 #include "stream_output.h"
101 #include "vlc_httpd.h"
103 #include "iso_lang.h"
106 #include "vlc_block.h"
110 #ifdef HAVE_DYNAMIC_PLUGINS
111 # include "modules_plugin.h"
114 #if defined( UNDER_CE )
115 # include "modules_builtin_evc.h"
116 #elif defined( _MSC_VER )
117 # include "modules_builtin_msvc.h"
119 # include "modules_builtin.h"
123 #if defined( WIN32) || defined( UNDER_CE )
124 /* Avoid name collisions */
125 # define LoadModule(a,b,c) _LoadModule(a,b,c)
128 /*****************************************************************************
130 *****************************************************************************/
131 #ifdef HAVE_DYNAMIC_PLUGINS
132 static void AllocateAllPlugins ( vlc_object_t * );
133 static void AllocatePluginDir ( vlc_object_t *, const char *, int );
134 static int AllocatePluginFile ( vlc_object_t *, char *, int64_t, int64_t );
135 static module_t * AllocatePlugin( vlc_object_t *, char * );
137 static int AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
138 static int DeleteModule ( module_t * );
139 #ifdef HAVE_DYNAMIC_PLUGINS
140 static void DupModule ( module_t * );
141 static void UndupModule ( module_t * );
142 static int CallEntry ( module_t * );
143 static int LoadModule ( vlc_object_t *, char *, module_handle_t * );
144 static void CloseModule ( module_handle_t );
145 static void * GetSymbol ( module_handle_t, const char * );
146 static void CacheLoad ( vlc_object_t * );
147 static int CacheLoadConfig ( module_t *, FILE * );
148 static void CacheSave ( vlc_object_t * );
149 static void CacheSaveConfig ( module_t *, FILE * );
150 static void CacheMerge ( vlc_object_t *, module_t *, module_t * );
151 static module_cache_t * CacheFind( vlc_object_t *, char *, int64_t, int64_t );
153 #if defined(HAVE_DL_WINDOWS)
154 static char * GetWindowsError ( void );
158 /*****************************************************************************
159 * module_InitBank: create the module bank.
160 *****************************************************************************
161 * This function creates a module bank structure which will be filled later
162 * on with all the modules found.
163 *****************************************************************************/
164 void __module_InitBank( vlc_object_t *p_this )
166 module_bank_t *p_bank;
169 var_Create( p_this->p_libvlc, "libvlc", VLC_VAR_MUTEX );
170 var_Get( p_this->p_libvlc, "libvlc", &lockval );
171 vlc_mutex_lock( lockval.p_address );
172 if( p_this->p_libvlc->p_module_bank )
174 p_this->p_libvlc->p_module_bank->i_usage++;
175 vlc_mutex_unlock( lockval.p_address );
176 var_Destroy( p_this->p_libvlc, "libvlc" );
179 vlc_mutex_unlock( lockval.p_address );
180 var_Destroy( p_this->p_libvlc, "libvlc" );
182 p_bank = vlc_object_create( p_this, sizeof(module_bank_t) );
183 p_bank->psz_object_name = "module bank";
185 p_bank->i_cache = p_bank->i_loaded_cache = 0;
186 p_bank->pp_cache = p_bank->pp_loaded_cache = 0;
187 p_bank->b_cache = p_bank->b_cache_dirty =
188 p_bank->b_cache_delete = VLC_FALSE;
191 * Store the symbols to be exported
193 #ifdef HAVE_DYNAMIC_PLUGINS
194 STORE_SYMBOLS( &p_bank->symbols );
197 /* Everything worked, attach the object */
198 p_this->p_libvlc->p_module_bank = p_bank;
199 vlc_object_attach( p_bank, p_this->p_libvlc );
201 module_LoadMain( p_this );
206 /*****************************************************************************
207 * module_ResetBank: reset the module bank.
208 *****************************************************************************
209 * This function resets the module bank by unloading all unused plugin
211 *****************************************************************************/
212 void __module_ResetBank( vlc_object_t *p_this )
214 msg_Err( p_this, "FIXME: module_ResetBank unimplemented" );
218 /*****************************************************************************
219 * module_EndBank: empty the module bank.
220 *****************************************************************************
221 * This function unloads all unused plugin modules and empties the module
222 * bank in case of success.
223 *****************************************************************************/
224 void __module_EndBank( vlc_object_t *p_this )
229 var_Create( p_this->p_libvlc, "libvlc", VLC_VAR_MUTEX );
230 var_Get( p_this->p_libvlc, "libvlc", &lockval );
231 vlc_mutex_lock( lockval.p_address );
232 if( !p_this->p_libvlc->p_module_bank )
234 vlc_mutex_unlock( lockval.p_address );
235 var_Destroy( p_this->p_libvlc, "libvlc" );
238 if( --p_this->p_libvlc->p_module_bank->i_usage )
240 vlc_mutex_unlock( lockval.p_address );
241 var_Destroy( p_this->p_libvlc, "libvlc" );
244 vlc_mutex_unlock( lockval.p_address );
245 var_Destroy( p_this->p_libvlc, "libvlc" );
247 #ifdef HAVE_DYNAMIC_PLUGINS
248 #define p_bank p_this->p_libvlc->p_module_bank
249 if( p_bank->b_cache ) CacheSave( p_this );
250 while( p_bank->i_loaded_cache-- )
252 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
253 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
254 if( !p_bank->i_loaded_cache ) free( p_bank->pp_loaded_cache );
256 while( p_bank->i_cache-- )
258 free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
259 free( p_bank->pp_cache[p_bank->i_cache] );
260 if( !p_bank->i_cache ) free( p_bank->pp_cache );
265 vlc_object_detach( p_this->p_libvlc->p_module_bank );
267 while( p_this->p_libvlc->p_module_bank->i_children )
269 p_next = (module_t *)p_this->p_libvlc->p_module_bank->pp_children[0];
271 if( DeleteModule( p_next ) )
273 /* Module deletion failed */
274 msg_Err( p_this, "module \"%s\" can't be removed, trying harder",
275 p_next->psz_object_name );
277 /* We just free the module by hand. Niahahahahaha. */
278 vlc_object_detach( p_next );
279 vlc_object_destroy( p_next );
283 vlc_object_destroy( p_this->p_libvlc->p_module_bank );
288 /*****************************************************************************
289 * module_LoadMain: load the main program info into the module bank.
290 *****************************************************************************
291 * This function fills the module bank structure with the main module infos.
292 * This is very useful as it will allow us to consider the main program just
293 * as another module, and for instance the configuration options of main will
294 * be available in the module bank structure just as for every other module.
295 *****************************************************************************/
296 void __module_LoadMain( vlc_object_t *p_this )
298 AllocateBuiltinModule( p_this, vlc_entry__main );
301 /*****************************************************************************
302 * module_LoadBuiltins: load all modules which we built with.
303 *****************************************************************************
304 * This function fills the module bank structure with the builtin modules.
305 *****************************************************************************/
306 void __module_LoadBuiltins( vlc_object_t * p_this )
308 msg_Dbg( p_this, "checking builtin modules" );
309 ALLOCATE_ALL_BUILTINS();
312 /*****************************************************************************
313 * module_LoadPlugins: load all plugin modules we can find.
314 *****************************************************************************
315 * This function fills the module bank structure with the plugin modules.
316 *****************************************************************************/
317 void __module_LoadPlugins( vlc_object_t * p_this )
319 #ifdef HAVE_DYNAMIC_PLUGINS
320 msg_Dbg( p_this, "checking plugin modules" );
322 if( config_GetInt( p_this, "plugins-cache" ) )
323 p_this->p_libvlc->p_module_bank->b_cache = VLC_TRUE;
325 if( p_this->p_libvlc->p_module_bank->b_cache ||
326 p_this->p_libvlc->p_module_bank->b_cache_delete ) CacheLoad( p_this );
328 AllocateAllPlugins( p_this );
332 /*****************************************************************************
333 * module_Need: return the best module function, given a capability list.
334 *****************************************************************************
335 * This function returns the module that best fits the asked capabilities.
336 *****************************************************************************/
337 module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
338 const char *psz_name, vlc_bool_t b_strict )
340 typedef struct module_list_t module_list_t;
347 module_list_t *p_next;
350 module_list_t *p_list, *p_first, *p_tmp;
353 int i_which_module, i_index = 0;
354 vlc_bool_t b_intf = VLC_FALSE;
359 char *psz_shortcuts = NULL, *psz_var = NULL;
361 msg_Dbg( p_this, "looking for %s module", psz_capability );
363 /* Deal with variables */
364 if( psz_name && psz_name[0] == '$' )
367 var_Create( p_this, psz_name + 1, VLC_VAR_MODULE | VLC_VAR_DOINHERIT );
368 var_Get( p_this, psz_name + 1, &val );
369 psz_var = val.psz_string;
373 /* Count how many different shortcuts were asked for */
374 if( psz_name && *psz_name )
376 char *psz_parser, *psz_last_shortcut;
378 /* If the user wants none, give him none. */
379 if( !strcmp( psz_name, "none" ) )
381 if( psz_var ) free( psz_var );
386 psz_shortcuts = psz_last_shortcut = strdup( psz_name );
388 for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
390 if( *psz_parser == ',' )
394 psz_last_shortcut = psz_parser + 1;
398 /* Check if the user wants to override the "strict" mode */
399 if( psz_last_shortcut )
401 if( !strcmp(psz_last_shortcut, "none") )
406 else if( !strcmp(psz_last_shortcut, "any") )
408 b_strict = VLC_FALSE;
414 /* Sort the modules and test them */
415 p_all = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
416 p_list = malloc( p_all->i_count * sizeof( module_list_t ) );
419 /* Parse the module list for capabilities and probe each of them */
420 for( i_which_module = 0; i_which_module < p_all->i_count; i_which_module++ )
422 int i_shortcut_bonus = 0;
424 p_module = (module_t *)p_all->p_values[i_which_module].p_object;
426 /* Test that this module can do what we need */
427 if( strcmp( p_module->psz_capability, psz_capability ) )
429 /* Don't recurse through the sub-modules because vlc_list_find()
430 * will list them anyway. */
434 /* Test if we have the required CPU */
435 if( (p_module->i_cpu & p_this->p_libvlc->i_cpu) != p_module->i_cpu )
440 /* If we required a shortcut, check this plugin provides it. */
441 if( i_shortcuts > 0 )
444 int i_dummy, i_short = i_shortcuts;
445 char *psz_name = psz_shortcuts;
447 /* Let's drop modules with a <= 0 score (unless they are
448 * explicitly requested) */
449 b_trash = p_module->i_score <= 0;
453 for( i_dummy = 0; p_module->pp_shortcuts[i_dummy]; i_dummy++ )
455 if( !strcasecmp( psz_name,
456 p_module->pp_shortcuts[i_dummy] ) )
460 i_shortcut_bonus = i_short * 10000;
465 if( i_shortcut_bonus )
467 /* We found it... remember ? */
471 /* Go to the next shortcut... This is so lame! */
480 /* If we are in "strict" mode and we couldn't
481 * find the module in the list of provided shortcuts,
482 * then kick the bastard out of here!!! */
483 if( i_short == 0 && b_strict )
493 /* If we didn't require a shortcut, trash <= 0 scored plugins */
494 else if( p_module->i_score <= 0 )
499 /* Special case: test if we requested a particular intf plugin */
500 if( !i_shortcuts && p_module->psz_program
501 && !strcmp( p_module->psz_program,
502 p_this->p_vlc->psz_object_name ) )
506 /* Remove previous non-matching plugins */
513 /* This one doesn't match */
517 /* Store this new module */
518 p_list[ i_index ].p_module = p_module;
519 p_list[ i_index ].i_score = p_module->i_score + i_shortcut_bonus;
520 p_list[ i_index ].b_force = !!i_shortcut_bonus;
522 /* Add it to the modules-to-probe list */
525 p_list[ 0 ].p_next = NULL;
530 /* Ok, so at school you learned that quicksort is quick, and
531 * bubble sort sucks raw eggs. But that's when dealing with
532 * thousands of items. Here we have barely 50. */
533 module_list_t *p_newlist = p_first;
535 if( p_first->i_score < p_list[ i_index ].i_score )
537 p_list[ i_index ].p_next = p_first;
538 p_first = &p_list[ i_index ];
542 while( p_newlist->p_next != NULL &&
543 p_newlist->p_next->i_score >= p_list[ i_index ].i_score )
545 p_newlist = p_newlist->p_next;
548 p_list[ i_index ].p_next = p_newlist->p_next;
549 p_newlist->p_next = &p_list[ i_index ];
556 msg_Dbg( p_this, "probing %i candidate%s",
557 i_index, i_index == 1 ? "" : "s" );
559 /* Lock all candidate modules */
561 while( p_tmp != NULL )
563 vlc_object_yield( p_tmp->p_module );
564 p_tmp = p_tmp->p_next;
567 /* We can release the list, interesting modules were yielded */
568 vlc_list_release( p_all );
570 /* Parse the linked list and use the first successful module */
572 while( p_tmp != NULL )
574 #ifdef HAVE_DYNAMIC_PLUGINS
575 /* Make sure the module is loaded in mem */
576 module_t *p_module = p_tmp->p_module->b_submodule ?
577 (module_t *)p_tmp->p_module->p_parent : p_tmp->p_module;
578 if( !p_module->b_builtin && !p_module->b_loaded )
580 module_t *p_new_module =
581 AllocatePlugin( p_this, p_module->psz_filename );
584 CacheMerge( p_this, p_module, p_new_module );
585 vlc_object_attach( p_new_module, p_module );
586 DeleteModule( p_new_module );
591 p_this->b_force = p_tmp->b_force;
592 if( p_tmp->p_module->pf_activate
593 && p_tmp->p_module->pf_activate( p_this ) == VLC_SUCCESS )
598 vlc_object_release( p_tmp->p_module );
599 p_tmp = p_tmp->p_next;
602 /* Store the locked module value */
605 p_module = p_tmp->p_module;
606 p_tmp = p_tmp->p_next;
613 /* Unlock the remaining modules */
614 while( p_tmp != NULL )
616 vlc_object_release( p_tmp->p_module );
617 p_tmp = p_tmp->p_next;
621 p_this->b_force = VLC_FALSE;
623 if( p_module != NULL )
625 msg_Dbg( p_module, "using %s module \"%s\"",
626 psz_capability, p_module->psz_object_name );
628 else if( p_first == NULL )
630 if( !strcmp( psz_capability, "access_demux" ) )
632 msg_Warn( p_this, "no %s module matched \"%s\"",
633 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
637 msg_Err( p_this, "no %s module matched \"%s\"",
638 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
641 else if( psz_name != NULL && *psz_name )
643 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
644 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
649 free( psz_shortcuts );
657 /* Don't forget that the module is still locked */
661 /*****************************************************************************
662 * module_Unneed: decrease the usage count of a module.
663 *****************************************************************************
664 * This function must be called by the thread that called module_Need, to
665 * decrease the reference count and allow for hiding of modules.
666 *****************************************************************************/
667 void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
669 /* Use the close method */
670 if( p_module->pf_deactivate )
672 p_module->pf_deactivate( p_this );
675 msg_Dbg( p_module, "unlocking module \"%s\"", p_module->psz_object_name );
677 vlc_object_release( p_module );
682 /*****************************************************************************
683 * Following functions are local.
684 *****************************************************************************/
686 /*****************************************************************************
687 * AllocateAllPlugins: load all plugin modules we can find.
688 *****************************************************************************/
689 #ifdef HAVE_DYNAMIC_PLUGINS
690 static void AllocateAllPlugins( vlc_object_t *p_this )
692 /* Yes, there are two NULLs because we replace one with "plugin-path". */
694 char * path[] = { "modules", "", "plugins", 0, 0 };
696 char * path[] = { "modules", PLUGIN_PATH, "plugins", 0, 0 };
699 char ** ppsz_path = path;
702 /* If the user provided a plugin path, we add it to the list */
703 path[ sizeof(path)/sizeof(char*) - 2 ] =
704 config_GetPsz( p_this, "plugin-path" );
706 for( ; *ppsz_path != NULL ; ppsz_path++ )
708 if( !(*ppsz_path)[0] ) continue;
710 #if defined( SYS_BEOS ) || defined( SYS_DARWIN ) || defined( WIN32 )
712 /* Handle relative as well as absolute paths */
714 if( (*ppsz_path)[0] != '\\' && (*ppsz_path)[0] != '/' &&
715 (*ppsz_path)[1] != ':' )
717 if( (*ppsz_path)[0] != '/' )
720 int i_dirlen = strlen( *ppsz_path );
721 i_dirlen += strlen( p_this->p_libvlc->psz_vlcpath ) + 2;
723 psz_fullpath = malloc( i_dirlen );
724 if( psz_fullpath == NULL )
729 sprintf( psz_fullpath, "%s\\%s",
730 p_this->p_libvlc->psz_vlcpath, *ppsz_path );
732 sprintf( psz_fullpath, "%s/%s",
733 p_this->p_libvlc->psz_vlcpath, *ppsz_path );
739 psz_fullpath = strdup( *ppsz_path );
742 msg_Dbg( p_this, "recursively browsing `%s'", psz_fullpath );
744 /* Don't go deeper than 5 subdirectories */
745 AllocatePluginDir( p_this, psz_fullpath, 5 );
747 free( psz_fullpath );
750 /* Free plugin-path */
751 if( path[ sizeof(path)/sizeof(char*) - 2 ] )
752 free( path[ sizeof(path)/sizeof(char*) - 2 ] );
753 path[ sizeof(path)/sizeof(char*) - 2 ] = NULL;
756 /*****************************************************************************
757 * AllocatePluginDir: recursively parse a directory to look for plugins
758 *****************************************************************************/
759 static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
762 #if defined( UNDER_CE ) || defined( _MSC_VER )
764 wchar_t psz_wpath[MAX_PATH + 256];
765 wchar_t psz_wdir[MAX_PATH];
767 char psz_path[MAX_PATH + 256];
768 WIN32_FIND_DATA finddata;
774 struct dirent * file;
778 if( p_this->p_vlc->b_die || i_maxdepth < 0 )
783 #if defined( UNDER_CE ) || defined( _MSC_VER )
785 MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
787 rc = GetFileAttributes( psz_wdir );
788 if( !(rc & FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
790 /* Parse all files in the directory */
791 swprintf( psz_wpath, L"%ls\\*", psz_wdir );
793 rc = GetFileAttributes( psz_dir );
794 if( !(rc & FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
797 /* Parse all files in the directory */
798 sprintf( psz_path, "%s\\*", psz_dir );
801 handle = FindFirstFile( psz_wpath, &finddata );
803 handle = FindFirstFile( psz_path, &finddata );
805 if( handle == INVALID_HANDLE_VALUE )
807 /* Empty directory */
811 /* Parse the directory and try to load all files it contains. */
815 unsigned int i_len = wcslen( finddata.cFileName );
816 swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
817 sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
819 unsigned int i_len = strlen( finddata.cFileName );
820 sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
823 /* Skip ".", ".." and anything starting with "." */
824 if( !*finddata.cFileName || *finddata.cFileName == '.' )
826 if( !FindNextFile( handle, &finddata ) ) break;
831 if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
833 if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
836 AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
838 else if( i_len > strlen( LIBEXT )
839 /* We only load files ending with LIBEXT */
840 && !strncasecmp( psz_path + strlen( psz_path)
842 LIBEXT, strlen( LIBEXT ) ) )
846 AllocatePluginFile( p_this, psz_file, 0, 0 );
849 while( !p_this->p_vlc->b_die && FindNextFile( handle, &finddata ) );
851 /* Close the directory */
855 dir = opendir( psz_dir );
861 i_dirlen = strlen( psz_dir );
863 /* Parse the directory and try to load all files it contains. */
864 while( !p_this->p_vlc->b_die && (file = readdir( dir )) )
870 /* Skip ".", ".." and anything starting with "." */
871 if( !*file->d_name || *file->d_name == '.' )
876 i_len = strlen( file->d_name );
877 psz_file = malloc( i_dirlen + 1 + i_len + 1 );
879 sprintf( psz_file, "%s\\%s", psz_dir, file->d_name );
881 sprintf( psz_file, "%s/%s", psz_dir, file->d_name );
884 i_stat = stat( psz_file, &statbuf );
885 if( !i_stat && statbuf.st_mode & S_IFDIR )
887 AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
889 else if( i_len > strlen( LIBEXT )
890 /* We only load files ending with LIBEXT */
891 && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
892 LIBEXT, strlen( LIBEXT ) ) )
894 int64_t i_time = 0, i_size = 0;
898 i_time = statbuf.st_mtime;
899 i_size = statbuf.st_size;
902 AllocatePluginFile( p_this, psz_file, i_time, i_size );
908 /* Close the directory */
914 /*****************************************************************************
915 * AllocatePluginFile: load a module into memory and initialize it.
916 *****************************************************************************
917 * This function loads a dynamically loadable module and allocates a structure
918 * for its information data. The module can then be handled by module_Need
919 * and module_Unneed. It can be removed by DeleteModule.
920 *****************************************************************************/
921 static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
922 int64_t i_file_time, int64_t i_file_size )
925 module_cache_t *p_cache_entry = NULL;
928 * Check our plugins cache first then load plugin if needed
931 CacheFind( p_this, psz_file, i_file_time, i_file_size );
935 p_module = AllocatePlugin( p_this, psz_file );
939 /* If junk dll, don't try to load it */
940 if( p_cache_entry->b_junk )
946 module_config_t *p_item;
948 p_module = p_cache_entry->p_module;
949 p_module->b_loaded = VLC_FALSE;
951 /* For now we force loading if the module's config contains
952 * callbacks or actions.
953 * Could be optimized by adding an API call.*/
954 for( p_item = p_module->p_config;
955 p_item->i_type != CONFIG_HINT_END; p_item++ )
957 if( p_item->pf_callback || p_item->i_action )
958 p_module = AllocatePlugin( p_this, psz_file );
965 /* Everything worked fine !
966 * The module is ready to be added to the list. */
967 p_module->b_builtin = VLC_FALSE;
969 /* msg_Dbg( p_this, "plugin \"%s\", %s",
970 p_module->psz_object_name, p_module->psz_longname ); */
972 vlc_object_attach( p_module, p_this->p_libvlc->p_module_bank );
975 if( !p_this->p_libvlc->p_module_bank->b_cache ) return 0;
977 /* Add entry to cache */
978 #define p_bank p_this->p_libvlc->p_module_bank
980 realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
981 p_bank->pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
982 p_bank->pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
983 p_bank->pp_cache[p_bank->i_cache]->i_time = i_file_time;
984 p_bank->pp_cache[p_bank->i_cache]->i_size = i_file_size;
985 p_bank->pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
986 p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
989 return p_module ? 0 : -1;
992 /*****************************************************************************
993 * AllocatePlugin: load a module into memory and initialize it.
994 *****************************************************************************
995 * This function loads a dynamically loadable module and allocates a structure
996 * for its information data. The module can then be handled by module_Need
997 * and module_Unneed. It can be removed by DeleteModule.
998 *****************************************************************************/
999 static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
1001 module_t * p_module;
1002 module_handle_t handle;
1004 if( LoadModule( p_this, psz_file, &handle ) ) return NULL;
1006 /* Now that we have successfully loaded the module, we can
1007 * allocate a structure for it */
1008 p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
1009 if( p_module == NULL )
1011 msg_Err( p_this, "out of memory" );
1012 CloseModule( handle );
1016 /* We need to fill these since they may be needed by CallEntry() */
1017 p_module->psz_filename = psz_file;
1018 p_module->handle = handle;
1019 p_module->p_symbols = &p_this->p_libvlc->p_module_bank->symbols;
1020 p_module->b_loaded = VLC_TRUE;
1022 /* Initialize the module: fill p_module, default config */
1023 if( CallEntry( p_module ) != 0 )
1025 /* We couldn't call module_init() */
1026 vlc_object_destroy( p_module );
1027 CloseModule( handle );
1031 DupModule( p_module );
1032 p_module->psz_filename = strdup( p_module->psz_filename );
1034 /* Everything worked fine ! The module is ready to be added to the list. */
1035 p_module->b_builtin = VLC_FALSE;
1040 /*****************************************************************************
1041 * DupModule: make a plugin module standalone.
1042 *****************************************************************************
1043 * This function duplicates all strings in the module, so that the dynamic
1044 * object can be unloaded. It acts recursively on submodules.
1045 *****************************************************************************/
1046 static void DupModule( module_t *p_module )
1051 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1053 *pp_shortcut = strdup( *pp_shortcut );
1056 /* We strdup() these entries so that they are still valid when the
1057 * module is unloaded. */
1058 p_module->psz_object_name = strdup( p_module->psz_object_name );
1059 p_module->psz_capability = strdup( p_module->psz_capability );
1060 p_module->psz_shortname = strdup( p_module->psz_shortname );
1061 p_module->psz_longname = strdup( p_module->psz_longname );
1063 if( p_module->psz_program != NULL )
1065 p_module->psz_program = strdup( p_module->psz_program );
1068 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1070 DupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1074 /*****************************************************************************
1075 * UndupModule: free a duplicated module.
1076 *****************************************************************************
1077 * This function frees the allocations done in DupModule().
1078 *****************************************************************************/
1079 static void UndupModule( module_t *p_module )
1084 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1086 UndupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1089 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1091 free( *pp_shortcut );
1094 free( p_module->psz_object_name );
1095 free( p_module->psz_capability );
1096 free( p_module->psz_shortname );
1097 free( p_module->psz_longname );
1099 if( p_module->psz_program != NULL )
1101 free( p_module->psz_program );
1105 #endif /* HAVE_DYNAMIC_PLUGINS */
1107 /*****************************************************************************
1108 * AllocateBuiltinModule: initialize a builtin module.
1109 *****************************************************************************
1110 * This function registers a builtin module and allocates a structure
1111 * for its information data. The module can then be handled by module_Need
1112 * and module_Unneed. It can be removed by DeleteModule.
1113 *****************************************************************************/
1114 static int AllocateBuiltinModule( vlc_object_t * p_this,
1115 int ( *pf_entry ) ( module_t * ) )
1117 module_t * p_module;
1119 /* Now that we have successfully loaded the module, we can
1120 * allocate a structure for it */
1121 p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
1122 if( p_module == NULL )
1124 msg_Err( p_this, "out of memory" );
1128 /* Initialize the module : fill p_module->psz_object_name, etc. */
1129 if( pf_entry( p_module ) != 0 )
1131 /* With a well-written module we shouldn't have to print an
1132 * additional error message here, but just make sure. */
1133 msg_Err( p_this, "failed calling entry point in builtin module" );
1134 vlc_object_destroy( p_module );
1138 /* Everything worked fine ! The module is ready to be added to the list. */
1139 p_module->b_builtin = VLC_TRUE;
1141 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1142 p_module->psz_object_name, p_module->psz_longname ); */
1144 vlc_object_attach( p_module, p_this->p_libvlc->p_module_bank );
1149 /*****************************************************************************
1150 * DeleteModule: delete a module and its structure.
1151 *****************************************************************************
1152 * This function can only be called if the module isn't being used.
1153 *****************************************************************************/
1154 static int DeleteModule( module_t * p_module )
1156 vlc_object_detach( p_module );
1158 /* We free the structures that we strdup()ed in Allocate*Module(). */
1159 #ifdef HAVE_DYNAMIC_PLUGINS
1160 if( !p_module->b_builtin )
1162 if( p_module->b_loaded && p_module->b_unloadable )
1164 CloseModule( p_module->handle );
1166 UndupModule( p_module );
1167 free( p_module->psz_filename );
1171 /* Free and detach the object's children */
1172 while( p_module->i_children )
1174 vlc_object_t *p_this = p_module->pp_children[0];
1175 vlc_object_detach( p_this );
1176 vlc_object_destroy( p_this );
1179 config_Free( p_module );
1180 vlc_object_destroy( p_module );
1185 #ifdef HAVE_DYNAMIC_PLUGINS
1186 /*****************************************************************************
1187 * CallEntry: call an entry point.
1188 *****************************************************************************
1189 * This function calls a symbol given its name and a module structure. The
1190 * symbol MUST refer to a function returning int and taking a module_t* as
1192 *****************************************************************************/
1193 static int CallEntry( module_t * p_module )
1195 static char *psz_name = "vlc_entry" MODULE_SUFFIX;
1196 int (* pf_symbol) ( module_t * p_module );
1198 /* Try to resolve the symbol */
1199 pf_symbol = (int (*)(module_t *)) GetSymbol( p_module->handle, psz_name );
1201 if( pf_symbol == NULL )
1203 #if defined(HAVE_DL_DYLD) || defined(HAVE_DL_BEOS)
1204 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s'",
1205 psz_name, p_module->psz_filename );
1206 #elif defined(HAVE_DL_WINDOWS)
1207 char *psz_error = GetWindowsError();
1208 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1209 psz_name, p_module->psz_filename, psz_error );
1211 #elif defined(HAVE_DL_DLOPEN)
1212 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1213 psz_name, p_module->psz_filename, dlerror() );
1214 #elif defined(HAVE_DL_SHL_LOAD)
1215 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1216 psz_name, p_module->psz_filename, strerror(errno) );
1218 # error "Something is wrong in modules.c"
1223 /* We can now try to call the symbol */
1224 if( pf_symbol( p_module ) != 0 )
1226 /* With a well-written module we shouldn't have to print an
1227 * additional error message here, but just make sure. */
1228 msg_Err( p_module, "failed calling symbol \"%s\" in file `%s'",
1229 psz_name, p_module->psz_filename );
1233 /* Everything worked fine, we can return */
1237 /*****************************************************************************
1238 * LoadModule: loads a dynamic library
1239 *****************************************************************************
1240 * This function loads a dynamically linked library using a system dependant
1241 * method. Will return 0 on success as well as the module handle.
1242 *****************************************************************************/
1243 static int LoadModule( vlc_object_t *p_this, char *psz_file,
1244 module_handle_t *p_handle )
1246 module_handle_t handle;
1248 #if defined(HAVE_DL_DYLD)
1249 NSObjectFileImage image;
1250 NSObjectFileImageReturnCode ret;
1252 ret = NSCreateObjectFileImageFromFile( psz_file, &image );
1254 if( ret != NSObjectFileImageSuccess )
1256 msg_Warn( p_this, "cannot create image from `%s'", psz_file );
1260 /* Open the dynamic module */
1261 handle = NSLinkModule( image, psz_file,
1262 NSLINKMODULE_OPTION_RETURN_ON_ERROR );
1266 NSLinkEditErrors errors;
1267 const char *psz_file, *psz_err;
1269 NSLinkEditError( &errors, &i_errnum, &psz_file, &psz_err );
1270 msg_Warn( p_this, "cannot link module `%s' (%s)", psz_file, psz_err );
1271 NSDestroyObjectFileImage( image );
1275 /* Destroy our image, we won't need it */
1276 NSDestroyObjectFileImage( image );
1278 #elif defined(HAVE_DL_BEOS)
1279 handle = load_add_on( psz_file );
1282 msg_Warn( p_this, "cannot load module `%s'", psz_file );
1286 #elif defined(HAVE_DL_WINDOWS)
1289 wchar_t psz_wfile[MAX_PATH];
1290 MultiByteToWideChar( CP_ACP, 0, psz_file, -1, psz_wfile, MAX_PATH );
1291 handle = LoadLibrary( psz_wfile );
1294 handle = LoadLibrary( psz_file );
1296 if( handle == NULL )
1298 char *psz_err = GetWindowsError();
1299 msg_Warn( p_this, "cannot load module `%s' (%s)", psz_file, psz_err );
1304 #elif defined(HAVE_DL_DLOPEN) && defined(RTLD_NOW)
1305 /* static is OK, we are called atomically */
1306 static vlc_bool_t b_kde = VLC_FALSE;
1308 # if defined(SYS_LINUX)
1309 /* XXX HACK #1 - we should NOT open modules with RTLD_GLOBAL, or we
1310 * are going to get namespace collisions when two modules have common
1311 * public symbols, but ALSA is being a pest here. */
1312 if( strstr( psz_file, "alsa_plugin" ) )
1314 handle = dlopen( psz_file, RTLD_NOW | RTLD_GLOBAL );
1315 if( handle == NULL )
1317 msg_Warn( p_this, "cannot load module `%s' (%s)",
1318 psz_file, dlerror() );
1323 /* XXX HACK #2 - the ugly KDE workaround. It seems that libkdewhatever
1324 * causes dlopen() to segfault if libstdc++ is not loaded in the caller,
1325 * so we just load libstdc++. Bwahahaha! ph34r! -- Sam. */
1326 /* Update: FYI, this is Debian bug #180505, and seems to be fixed. */
1327 if( !b_kde && !strstr( psz_file, "kde" ) )
1329 dlopen( "libstdc++.so.6", RTLD_NOW )
1330 || dlopen( "libstdc++.so.5", RTLD_NOW )
1331 || dlopen( "libstdc++.so.4", RTLD_NOW )
1332 || dlopen( "libstdc++.so.3", RTLD_NOW );
1336 handle = dlopen( psz_file, RTLD_NOW );
1337 if( handle == NULL )
1339 msg_Warn( p_this, "cannot load module `%s' (%s)",
1340 psz_file, dlerror() );
1344 #elif defined(HAVE_DL_DLOPEN)
1345 # if defined(DL_LAZY)
1346 handle = dlopen( psz_file, DL_LAZY );
1348 handle = dlopen( psz_file, 0 );
1350 if( handle == NULL )
1352 msg_Warn( p_this, "cannot load module `%s' (%s)",
1353 psz_file, dlerror() );
1357 #elif defined(HAVE_DL_SHL_LOAD)
1358 handle = shl_load( psz_file, BIND_IMMEDIATE | BIND_NONFATAL, NULL );
1359 if( handle == NULL )
1361 msg_Warn( p_this, "cannot load module `%s' (%s)",
1362 psz_file, strerror(errno) );
1367 # error "Something is wrong in modules.c"
1375 /*****************************************************************************
1376 * CloseModule: unload a dynamic library
1377 *****************************************************************************
1378 * This function unloads a previously opened dynamically linked library
1379 * using a system dependant method. No return value is taken in consideration,
1380 * since some libraries sometimes refuse to close properly.
1381 *****************************************************************************/
1382 static void CloseModule( module_handle_t handle )
1384 #if defined(HAVE_DL_DYLD)
1385 NSUnLinkModule( handle, FALSE );
1387 #elif defined(HAVE_DL_BEOS)
1388 unload_add_on( handle );
1390 #elif defined(HAVE_DL_WINDOWS)
1391 FreeLibrary( handle );
1393 #elif defined(HAVE_DL_DLOPEN)
1396 #elif defined(HAVE_DL_SHL_LOAD)
1397 shl_unload( handle );
1403 /*****************************************************************************
1404 * GetSymbol: get a symbol from a dynamic library
1405 *****************************************************************************
1406 * This function queries a loaded library for a symbol specified in a
1407 * string, and returns a pointer to it. We don't check for dlerror() or
1408 * similar functions, since we want a non-NULL symbol anyway.
1409 *****************************************************************************/
1410 static void * _module_getsymbol( module_handle_t, const char * );
1412 static void * GetSymbol( module_handle_t handle, const char * psz_function )
1414 void * p_symbol = _module_getsymbol( handle, psz_function );
1416 /* MacOS X dl library expects symbols to begin with "_". So do
1417 * some other operating systems. That's really lame, but hey, what
1419 if( p_symbol == NULL )
1421 char *psz_call = malloc( strlen( psz_function ) + 2 );
1423 strcpy( psz_call + 1, psz_function );
1424 psz_call[ 0 ] = '_';
1425 p_symbol = _module_getsymbol( handle, psz_call );
1432 static void * _module_getsymbol( module_handle_t handle,
1433 const char * psz_function )
1435 #if defined(HAVE_DL_DYLD)
1436 NSSymbol sym = NSLookupSymbolInModule( handle, psz_function );
1437 return NSAddressOfSymbol( sym );
1439 #elif defined(HAVE_DL_BEOS)
1441 if( B_OK == get_image_symbol( handle, psz_function,
1442 B_SYMBOL_TYPE_TEXT, &p_symbol ) )
1451 #elif defined(HAVE_DL_WINDOWS) && defined(UNDER_CE)
1452 wchar_t psz_real[256];
1453 MultiByteToWideChar( CP_ACP, 0, psz_function, -1, psz_real, 256 );
1455 return (void *)GetProcAddress( handle, psz_real );
1457 #elif defined(HAVE_DL_WINDOWS) && defined(WIN32)
1458 return (void *)GetProcAddress( handle, (char *)psz_function );
1460 #elif defined(HAVE_DL_DLOPEN)
1461 return dlsym( handle, psz_function );
1463 #elif defined(HAVE_DL_SHL_LOAD)
1465 shl_findsym( &handle, psz_function, TYPE_UNDEFINED, &p_sym );
1471 #if defined(HAVE_DL_WINDOWS)
1472 static char * GetWindowsError( void )
1474 #if defined(UNDER_CE)
1475 wchar_t psz_tmp[256];
1476 char * psz_buffer = malloc( 256 );
1478 char * psz_tmp = malloc( 256 );
1480 int i = 0, i_error = GetLastError();
1482 FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
1483 NULL, i_error, MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT),
1484 (LPTSTR) psz_tmp, 256, NULL );
1486 /* Go to the end of the string */
1487 #if defined(UNDER_CE)
1488 while( psz_tmp[i] && psz_tmp[i] != L'\r' && psz_tmp[i] != L'\n' )
1490 while( psz_tmp[i] && psz_tmp[i] != '\r' && psz_tmp[i] != '\n' )
1498 #if defined(UNDER_CE)
1499 swprintf( psz_tmp + i, L" (error %i)", i_error );
1500 psz_tmp[ 255 ] = L'\0';
1502 snprintf( psz_tmp + i, 256 - i, " (error %i)", i_error );
1503 psz_tmp[ 255 ] = '\0';
1507 #if defined(UNDER_CE)
1508 WideCharToMultiByte( CP_ACP, WC_DEFAULTCHAR, psz_tmp, -1,
1509 psz_buffer, 256, NULL, NULL );
1515 #endif /* HAVE_DL_WINDOWS */
1517 /*****************************************************************************
1518 * LoadPluginsCache: loads the plugins cache file
1519 *****************************************************************************
1520 * This function will load the plugin cache if present and valid. This cache
1521 * will in turn be queried by AllocateAllPlugins() to see if it needs to
1522 * actually load the dynamically loadable module.
1523 * This allows us to only fully load plugins when they are actually used.
1524 *****************************************************************************/
1525 static void CacheLoad( vlc_object_t *p_this )
1527 char *psz_filename, *psz_homedir;
1529 int i, j, i_size, i_read;
1530 char p_cachestring[sizeof(PLUGINSCACHE_FILE COPYRIGHT_MESSAGE)];
1532 module_cache_t **pp_cache = 0;
1533 int32_t i_file_size;
1535 psz_homedir = p_this->p_vlc->psz_homedir;
1538 msg_Err( p_this, "psz_homedir is null" );
1542 (char *)malloc( sizeof("/" CONFIG_DIR "/" PLUGINSCACHE_FILE) +
1543 strlen(psz_homedir) );
1546 sprintf( psz_filename, "%s/" CONFIG_DIR "/" PLUGINSCACHE_FILE,
1551 msg_Err( p_this, "out of memory" );
1555 if( p_this->p_libvlc->p_module_bank->b_cache_delete )
1557 msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
1558 #if !defined( UNDER_CE )
1559 unlink( psz_filename );
1561 msg_Err( p_this, "FIXME, unlink not implemented" );
1566 msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
1568 file = fopen( psz_filename, "rb" );
1571 msg_Warn( p_this, "could not open plugins cache file %s for reading",
1573 free( psz_filename );
1576 free( psz_filename );
1578 /* Check the file size */
1579 i_read = fread( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1580 if( i_read != sizeof(i_file_size) )
1582 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1588 fseek( file, 0, SEEK_END );
1589 if( ftell( file ) != i_file_size )
1591 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1592 "(corrupted size)" );
1596 fseek( file, sizeof(i_file_size), SEEK_SET );
1598 /* Check the file is a plugins cache */
1599 i_size = sizeof(PLUGINSCACHE_FILE COPYRIGHT_MESSAGE) - 1;
1600 i_read = fread( p_cachestring, sizeof(char), i_size, file );
1601 if( i_read != i_size ||
1602 memcmp( p_cachestring, PLUGINSCACHE_FILE COPYRIGHT_MESSAGE, i_size ) )
1604 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
1609 p_this->p_libvlc->p_module_bank->i_loaded_cache = 0;
1610 fread( &i_cache, sizeof(char), sizeof(i_cache), file );
1611 pp_cache = p_this->p_libvlc->p_module_bank->pp_loaded_cache =
1612 malloc( i_cache * sizeof(void *) );
1614 #define LOAD_IMMEDIATE(a) \
1615 if( fread( &a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
1616 #define LOAD_STRING(a) \
1617 { if( fread( &i_size, sizeof(char), sizeof(i_size), file ) \
1618 != sizeof(i_size) ) goto error; \
1620 a = malloc( i_size ); \
1621 if( fread( a, sizeof(char), i_size, file ) != (size_t)i_size ) \
1627 for( i = 0; i < i_cache; i++ )
1632 pp_cache[i] = malloc( sizeof(module_cache_t) );
1633 p_this->p_libvlc->p_module_bank->i_loaded_cache++;
1635 /* Save common info */
1636 LOAD_STRING( pp_cache[i]->psz_file );
1637 LOAD_IMMEDIATE( pp_cache[i]->i_time );
1638 LOAD_IMMEDIATE( pp_cache[i]->i_size );
1639 LOAD_IMMEDIATE( pp_cache[i]->b_junk );
1641 if( pp_cache[i]->b_junk ) continue;
1643 pp_cache[i]->p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
1645 /* Save additional infos */
1646 LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
1647 LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
1648 LOAD_STRING( pp_cache[i]->p_module->psz_longname );
1649 LOAD_STRING( pp_cache[i]->p_module->psz_program );
1650 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1652 LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
1654 LOAD_STRING( pp_cache[i]->p_module->psz_capability );
1655 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
1656 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
1657 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
1658 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
1659 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
1662 if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
1665 LOAD_STRING( pp_cache[i]->p_module->psz_filename );
1667 LOAD_IMMEDIATE( i_submodules );
1669 while( i_submodules-- )
1671 module_t *p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE);
1672 vlc_object_attach( p_module, pp_cache[i]->p_module );
1673 p_module->b_submodule = VLC_TRUE;
1675 LOAD_STRING( p_module->psz_object_name );
1676 LOAD_STRING( p_module->psz_shortname );
1677 LOAD_STRING( p_module->psz_longname );
1678 LOAD_STRING( p_module->psz_program );
1679 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1681 LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
1683 LOAD_STRING( p_module->psz_capability );
1684 LOAD_IMMEDIATE( p_module->i_score );
1685 LOAD_IMMEDIATE( p_module->i_cpu );
1686 LOAD_IMMEDIATE( p_module->b_unloadable );
1687 LOAD_IMMEDIATE( p_module->b_reentrant );
1696 msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
1699 p_this->p_libvlc->p_module_bank->i_loaded_cache = 0;
1705 int CacheLoadConfig( module_t *p_module, FILE *file )
1710 /* Calculate the structure length */
1711 LOAD_IMMEDIATE( p_module->i_config_items );
1712 LOAD_IMMEDIATE( p_module->i_bool_items );
1714 LOAD_IMMEDIATE( i_lines );
1716 /* Allocate memory */
1717 p_module->p_config =
1718 (module_config_t *)malloc( sizeof(module_config_t) * (i_lines + 1));
1719 if( p_module->p_config == NULL )
1721 msg_Err( p_module, "config error: can't duplicate p_config" );
1725 /* Do the duplication job */
1726 for( i = 0; i < i_lines ; i++ )
1728 LOAD_IMMEDIATE( p_module->p_config[i] );
1730 LOAD_STRING( p_module->p_config[i].psz_type );
1731 LOAD_STRING( p_module->p_config[i].psz_name );
1732 LOAD_STRING( p_module->p_config[i].psz_text );
1733 LOAD_STRING( p_module->p_config[i].psz_longtext );
1734 LOAD_STRING( p_module->p_config[i].psz_value_orig );
1736 p_module->p_config[i].psz_value =
1737 p_module->p_config[i].psz_value_orig ?
1738 strdup( p_module->p_config[i].psz_value_orig ) : 0;
1739 p_module->p_config[i].i_value = p_module->p_config[i].i_value_orig;
1740 p_module->p_config[i].f_value = p_module->p_config[i].f_value_orig;
1742 p_module->p_config[i].p_lock = &p_module->object_lock;
1744 if( p_module->p_config[i].i_list )
1746 if( p_module->p_config[i].ppsz_list )
1748 p_module->p_config[i].ppsz_list =
1749 malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1750 if( p_module->p_config[i].ppsz_list )
1752 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1753 LOAD_STRING( p_module->p_config[i].ppsz_list[j] );
1754 p_module->p_config[i].ppsz_list[j] = NULL;
1757 if( p_module->p_config[i].ppsz_list_text )
1759 p_module->p_config[i].ppsz_list_text =
1760 malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1761 if( p_module->p_config[i].ppsz_list_text )
1763 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1764 LOAD_STRING( p_module->p_config[i].ppsz_list_text[j] );
1765 p_module->p_config[i].ppsz_list_text[j] = NULL;
1768 if( p_module->p_config[i].pi_list )
1770 p_module->p_config[i].pi_list =
1771 malloc( (p_module->p_config[i].i_list + 1) * sizeof(int) );
1772 if( p_module->p_config[i].pi_list )
1774 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1775 LOAD_IMMEDIATE( p_module->p_config[i].pi_list[j] );
1780 if( p_module->p_config[i].i_action )
1782 p_module->p_config[i].ppf_action =
1783 malloc( p_module->p_config[i].i_action * sizeof(void *) );
1784 p_module->p_config[i].ppsz_action_text =
1785 malloc( p_module->p_config[i].i_action * sizeof(char *) );
1787 for( j = 0; j < p_module->p_config[i].i_action; j++ )
1789 p_module->p_config[i].ppf_action[j] = 0;
1790 LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
1794 LOAD_IMMEDIATE( p_module->p_config[i].pf_callback );
1797 p_module->p_config[i].i_type = CONFIG_HINT_END;
1803 return VLC_EGENERIC;
1806 /*****************************************************************************
1807 * SavePluginsCache: saves the plugins cache to a file
1808 *****************************************************************************/
1809 static void CacheSave( vlc_object_t *p_this )
1811 char *psz_filename, *psz_homedir;
1814 module_cache_t **pp_cache;
1815 int32_t i_file_size = 0;
1817 psz_homedir = p_this->p_vlc->psz_homedir;
1820 msg_Err( p_this, "psz_homedir is null" );
1824 (char *)malloc( sizeof("/" CONFIG_DIR "/" PLUGINSCACHE_FILE) +
1825 strlen(psz_homedir) );
1828 sprintf( psz_filename, "%s/" CONFIG_DIR, psz_homedir );
1832 msg_Err( p_this, "out of memory" );
1836 config_CreateDir( p_this, psz_filename );
1838 strcat( psz_filename, "/" PLUGINSCACHE_FILE );
1840 msg_Dbg( p_this, "saving plugins cache file %s", psz_filename );
1842 file = fopen( psz_filename, "wb" );
1845 msg_Warn( p_this, "could not open plugins cache file %s for writing",
1847 free( psz_filename );
1850 free( psz_filename );
1852 /* Empty space for file size */
1853 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1855 /* Contains version number */
1856 fprintf( file, PLUGINSCACHE_FILE COPYRIGHT_MESSAGE );
1858 i_cache = p_this->p_libvlc->p_module_bank->i_cache;
1859 pp_cache = p_this->p_libvlc->p_module_bank->pp_cache;
1861 fwrite( &i_cache, sizeof(char), sizeof(i_cache), file );
1863 #define SAVE_IMMEDIATE(a) \
1864 fwrite( &a, sizeof(char), sizeof(a), file )
1865 #define SAVE_STRING(a) \
1866 { i_size = a ? strlen( a ) + 1 : 0; \
1867 fwrite( &i_size, sizeof(char), sizeof(i_size), file ); \
1868 if( a ) fwrite( a, sizeof(char), i_size, file ); \
1871 for( i = 0; i < i_cache; i++ )
1874 int32_t i_submodule;
1876 /* Save common info */
1877 SAVE_STRING( pp_cache[i]->psz_file );
1878 SAVE_IMMEDIATE( pp_cache[i]->i_time );
1879 SAVE_IMMEDIATE( pp_cache[i]->i_size );
1880 SAVE_IMMEDIATE( pp_cache[i]->b_junk );
1882 if( pp_cache[i]->b_junk ) continue;
1884 /* Save additional infos */
1885 SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
1886 SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
1887 SAVE_STRING( pp_cache[i]->p_module->psz_longname );
1888 SAVE_STRING( pp_cache[i]->p_module->psz_program );
1889 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1891 SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
1893 SAVE_STRING( pp_cache[i]->p_module->psz_capability );
1894 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
1895 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
1896 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
1897 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
1898 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
1901 CacheSaveConfig( pp_cache[i]->p_module, file );
1903 SAVE_STRING( pp_cache[i]->p_module->psz_filename );
1905 i_submodule = pp_cache[i]->p_module->i_children;
1906 SAVE_IMMEDIATE( i_submodule );
1907 for( i_submodule = 0; i_submodule < pp_cache[i]->p_module->i_children;
1910 module_t *p_module =
1911 (module_t *)pp_cache[i]->p_module->pp_children[i_submodule];
1913 SAVE_STRING( p_module->psz_object_name );
1914 SAVE_STRING( p_module->psz_shortname );
1915 SAVE_STRING( p_module->psz_longname );
1916 SAVE_STRING( p_module->psz_program );
1917 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1919 SAVE_STRING( p_module->pp_shortcuts[j] ); // FIX
1921 SAVE_STRING( p_module->psz_capability );
1922 SAVE_IMMEDIATE( p_module->i_score );
1923 SAVE_IMMEDIATE( p_module->i_cpu );
1924 SAVE_IMMEDIATE( p_module->b_unloadable );
1925 SAVE_IMMEDIATE( p_module->b_reentrant );
1929 /* Fill-up file size */
1930 i_file_size = ftell( file );
1931 fseek( file, 0, SEEK_SET );
1932 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1939 void CacheSaveConfig( module_t *p_module, FILE *file )
1941 int i, j, i_lines = 0;
1942 module_config_t *p_item;
1945 SAVE_IMMEDIATE( p_module->i_config_items );
1946 SAVE_IMMEDIATE( p_module->i_bool_items );
1948 for( p_item = p_module->p_config; p_item->i_type != CONFIG_HINT_END;
1949 p_item++ ) i_lines++;
1951 SAVE_IMMEDIATE( i_lines );
1953 for( i = 0; i < i_lines ; i++ )
1955 SAVE_IMMEDIATE( p_module->p_config[i] );
1957 SAVE_STRING( p_module->p_config[i].psz_type );
1958 SAVE_STRING( p_module->p_config[i].psz_name );
1959 SAVE_STRING( p_module->p_config[i].psz_text );
1960 SAVE_STRING( p_module->p_config[i].psz_longtext );
1961 SAVE_STRING( p_module->p_config[i].psz_value_orig );
1963 if( p_module->p_config[i].i_list )
1965 if( p_module->p_config[i].ppsz_list )
1967 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1968 SAVE_STRING( p_module->p_config[i].ppsz_list[j] );
1971 if( p_module->p_config[i].ppsz_list_text )
1973 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1974 SAVE_STRING( p_module->p_config[i].ppsz_list_text[j] );
1976 if( p_module->p_config[i].pi_list )
1978 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1979 SAVE_IMMEDIATE( p_module->p_config[i].pi_list[j] );
1983 for( j = 0; j < p_module->p_config[i].i_action; j++ )
1984 SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );
1986 SAVE_IMMEDIATE( p_module->p_config[i].pf_callback );
1990 /*****************************************************************************
1991 * CacheMerge: Merge a cache module descriptor with a full module descriptor.
1992 *****************************************************************************/
1993 static void CacheMerge( vlc_object_t *p_this, module_t *p_cache,
1994 module_t *p_module )
1998 p_cache->pf_activate = p_module->pf_activate;
1999 p_cache->pf_deactivate = p_module->pf_deactivate;
2000 p_cache->p_symbols = p_module->p_symbols;
2001 p_cache->handle = p_module->handle;
2003 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
2005 module_t *p_child = (module_t*)p_module->pp_children[i_submodule];
2006 module_t *p_cchild = (module_t*)p_cache->pp_children[i_submodule];
2007 p_cchild->pf_activate = p_child->pf_activate;
2008 p_cchild->pf_deactivate = p_child->pf_deactivate;
2009 p_cchild->p_symbols = p_child->p_symbols;
2012 p_cache->b_loaded = VLC_TRUE;
2013 p_module->b_loaded = VLC_FALSE;
2016 /*****************************************************************************
2017 * FindPluginCache: finds the cache entry corresponding to a file
2018 *****************************************************************************/
2019 static module_cache_t *CacheFind( vlc_object_t *p_this, char *psz_file,
2020 int64_t i_time, int64_t i_size )
2022 module_cache_t **pp_cache;
2025 pp_cache = p_this->p_libvlc->p_module_bank->pp_loaded_cache;
2026 i_cache = p_this->p_libvlc->p_module_bank->i_loaded_cache;
2028 for( i = 0; i < i_cache; i++ )
2030 if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
2031 pp_cache[i]->i_time == i_time &&
2032 pp_cache[i]->i_size == i_size ) return pp_cache[i];
2038 #endif /* HAVE_DYNAMIC_PLUGINS */