1 /*****************************************************************************
2 * modules.c : Builtin and plugin modules management functions
3 *****************************************************************************
4 * Copyright (C) 2001-2007 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 *****************************************************************************/
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
35 /* Some faulty libcs have a broken struct dirent when _FILE_OFFSET_BITS
36 * is set to 64. Don't try to be cleverer. */
37 #ifdef _FILE_OFFSET_BITS
38 #undef _FILE_OFFSET_BITS
41 #include <stdlib.h> /* free(), strtol() */
42 #include <stdio.h> /* sprintf() */
43 #include <string.h> /* strdup() */
50 #ifdef HAVE_SYS_TYPES_H
51 # include <sys/types.h>
53 #ifdef HAVE_SYS_STAT_H
54 # include <sys/stat.h>
60 #if !defined(HAVE_DYNAMIC_PLUGINS)
61 /* no support for plugins */
62 #elif defined(HAVE_DL_DYLD)
63 # if defined(HAVE_MACH_O_DYLD_H)
64 # include <mach-o/dyld.h>
66 #elif defined(HAVE_DL_BEOS)
67 # if defined(HAVE_IMAGE_H)
70 #elif defined(HAVE_DL_WINDOWS)
72 #elif defined(HAVE_DL_DLOPEN)
73 # if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
76 # if defined(HAVE_SYS_DL_H)
79 #elif defined(HAVE_DL_SHL_LOAD)
80 # if defined(HAVE_DL_H)
85 #include "config/configuration.h"
87 #include "vlc_charset.h"
88 #include "vlc_arrays.h"
90 #include "modules/modules.h"
91 #include "modules/builtin.h"
93 module_bank_t *p_module_bank;
95 /*****************************************************************************
97 *****************************************************************************/
98 #ifdef HAVE_DYNAMIC_PLUGINS
99 static void AllocateAllPlugins ( vlc_object_t * );
100 static void AllocatePluginDir ( vlc_object_t *, const char *, int );
101 static int AllocatePluginFile ( vlc_object_t *, char *, int64_t, int64_t );
102 static module_t * AllocatePlugin( vlc_object_t *, char * );
104 static int AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
105 static void DeleteModule ( module_t * );
106 #ifdef HAVE_DYNAMIC_PLUGINS
107 static void DupModule ( module_t * );
108 static void UndupModule ( module_t * );
114 * Creates a module bank structure which will be filled later
115 * on with all the modules found.
116 * \param p_this vlc object structure
119 void __module_InitBank( vlc_object_t *p_this )
121 module_bank_t *p_bank = NULL;
123 vlc_mutex_lock( &global_lock );
125 if( p_module_bank == NULL )
127 p_bank = calloc (1, sizeof(*p_bank));
129 p_bank->i_cache = p_bank->i_loaded_cache = 0;
130 p_bank->pp_cache = p_bank->pp_loaded_cache = NULL;
131 p_bank->b_cache = p_bank->b_cache_dirty =
132 p_bank->b_cache_delete = false;
135 /* Everything worked, attach the object */
136 p_module_bank = p_bank;
138 /* Fills the module bank structure with the main module infos.
139 * This is very useful as it will allow us to consider the main
140 * library just as another module, and for instance the configuration
141 * options of main will be available in the module bank structure just
142 * as for every other module. */
143 AllocateBuiltinModule( p_this, vlc_entry__main );
146 p_module_bank->i_usage++;
148 vlc_mutex_unlock( &global_lock );
155 * Unloads all unused plugin modules and empties the module
156 * bank in case of success.
157 * \param p_this vlc object structure
160 void __module_EndBank( vlc_object_t *p_this )
162 module_bank_t *p_bank;
164 vlc_mutex_lock( &global_lock );
165 p_bank = p_module_bank;
166 assert (p_bank != NULL);
167 if( --p_bank->i_usage > 0 )
169 vlc_mutex_unlock( &global_lock );
172 /*FIXME: For thread safety, we need to:
173 p_module_bank = NULL; - immediately, but that will crash the cache */
174 vlc_mutex_unlock( &global_lock );
176 /* Save the configuration */
177 config_AutoSaveConfigFile( p_this );
179 #ifdef HAVE_DYNAMIC_PLUGINS
180 if( p_bank->b_cache ) CacheSave( p_this );
181 while( p_bank->i_loaded_cache-- )
183 if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
186 p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module );
187 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
188 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
189 p_bank->pp_loaded_cache[p_bank->i_loaded_cache] = NULL;
192 if( p_bank->pp_loaded_cache )
194 free( p_bank->pp_loaded_cache );
195 p_bank->pp_loaded_cache = NULL;
197 while( p_bank->i_cache-- )
199 free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
200 free( p_bank->pp_cache[p_bank->i_cache] );
201 p_bank->pp_cache[p_bank->i_cache] = NULL;
203 if( p_bank->pp_cache )
205 free( p_bank->pp_cache );
206 p_bank->pp_cache = NULL;
210 while( p_bank->head != NULL )
211 DeleteModule( p_bank->head );
213 p_module_bank = NULL; /* FIXME: do this inside the lock */
218 * Load all modules which we built with.
220 * Fills the module bank structure with the builtin modules.
221 * \param p_this vlc object structure
224 void __module_LoadBuiltins( vlc_object_t * p_this )
226 vlc_mutex_lock( &global_lock );
227 if( p_module_bank->b_builtins )
229 vlc_mutex_unlock( &global_lock );
232 p_module_bank->b_builtins = true;
233 vlc_mutex_unlock( &global_lock );
235 msg_Dbg( p_this, "checking builtin modules" );
236 ALLOCATE_ALL_BUILTINS();
242 * Load all plugin modules we can find.
243 * Fills the module bank structure with the plugin modules.
244 * \param p_this vlc object structure
247 void __module_LoadPlugins( vlc_object_t * p_this )
249 #ifdef HAVE_DYNAMIC_PLUGINS
250 vlc_mutex_lock( &global_lock );
251 if( p_module_bank->b_plugins )
253 vlc_mutex_unlock( &global_lock );
256 p_module_bank->b_plugins = true;
257 vlc_mutex_unlock( &global_lock );
259 msg_Dbg( p_this, "checking plugin modules" );
261 if( config_GetInt( p_this, "plugins-cache" ) )
262 p_module_bank->b_cache = true;
264 if( p_module_bank->b_cache ||
265 p_module_bank->b_cache_delete ) CacheLoad( p_this );
267 AllocateAllPlugins( p_this );
272 * Checks whether a module implements a capability.
274 * \param m the module
275 * \param cap the capability to check
276 * \return TRUE if the module have the capability
278 bool module_provides( const module_t *m, const char *cap )
280 return !strcmp( m->psz_capability, cap );
284 * Get the internal name of a module
286 * \param m the module
287 * \return the module name
289 const char *module_get_object( const module_t *m )
291 return m->psz_object_name;
295 * Get the human-friendly name of a module.
297 * \param m the module
298 * \param long_name TRUE to have the long name of the module
299 * \return the short or long name of the module
301 const char *module_get_name( const module_t *m, bool long_name )
303 if( long_name && ( m->psz_longname != NULL) )
304 return m->psz_longname;
306 return m->psz_shortname ?: m->psz_object_name;
310 * Get the help for a module
312 * \param m the module
315 const char *module_get_help( const module_t *m )
320 module_t *module_hold (module_t *m)
322 vlc_hold (&m->vlc_gc_data);
326 void module_release (module_t *m)
328 vlc_release (&m->vlc_gc_data);
332 * Frees the flat list of VLC modules.
333 * @param list list obtained by module_list_get
334 * @param length number of items on the list
337 void module_list_free (module_t **list)
342 for (size_t i = 0; list[i] != NULL; i++)
343 module_release (list[i]);
348 * Gets the flat list of VLC modules.
349 * @param n [OUT] pointer to the number of modules or NULL
350 * @return NULL-terminated table of module pointers
351 * (release with module_list_free()), or NULL in case of error.
353 module_t **module_list_get (size_t *n)
355 /* TODO: this whole module lookup is quite inefficient */
356 /* Remove this and improve module_need */
357 module_t **tab = NULL;
360 for (module_t *mod = p_module_bank->head; mod; mod = mod->next)
363 nt = realloc (tab, (i + 2 + mod->submodule_count) * sizeof (*tab));
366 module_list_free (tab);
371 tab[i++] = module_hold (mod);
372 for (module_t *subm = mod->submodule; subm; subm = subm->next)
373 tab[i++] = module_hold (subm);
381 typedef struct module_list_t
388 static int modulecmp (const void *a, const void *b)
390 const module_list_t *la = a, *lb = b;
391 /* Note that qsort() uses _ascending_ order,
392 * so the smallest module is the one with the biggest score. */
393 return lb->i_score - la->i_score;
399 * Return the best module function, given a capability list.
401 * If the p_this object doesn't have it's psz_object_name set, then
402 * psz_object_name will be set to the module's name, unless the user
403 * provided an alias using the "module name@alias" syntax in which case
404 * psz_object_name will be set to the alias.
406 * \param p_this the vlc object
407 * \param psz_capability list of capabilities needed
408 * \param psz_name name of the module asked
409 * \param b_strict TRUE yto use the strict mode
410 * \return the module or NULL in case of a failure
412 module_t * __module_need( vlc_object_t *p_this, const char *psz_capability,
413 const char *psz_name, bool b_strict )
415 stats_TimerStart( p_this, "module_need()", STATS_TIMER_MODULE_NEED );
417 module_list_t *p_list;
420 char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
421 bool b_force_backup = p_this->b_force;
423 /* Deal with variables */
424 if( psz_name && psz_name[0] == '$' )
426 psz_name = psz_var = var_CreateGetString( p_this, psz_name + 1 );
429 /* Count how many different shortcuts were asked for */
430 if( psz_name && *psz_name )
432 char *psz_parser, *psz_last_shortcut;
434 /* If the user wants none, give him none. */
435 if( !strcmp( psz_name, "none" ) )
438 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
439 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
440 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
445 psz_shortcuts = psz_last_shortcut = strdup( psz_name );
447 for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
449 if( *psz_parser == ',' )
453 psz_last_shortcut = psz_parser + 1;
457 /* Check if the user wants to override the "strict" mode */
458 if( psz_last_shortcut )
460 if( !strcmp(psz_last_shortcut, "none") )
465 else if( !strcmp(psz_last_shortcut, "any") )
473 /* Sort the modules and test them */
475 module_t **p_all = module_list_get (&count);
476 p_list = malloc( count * sizeof( module_list_t ) );
477 unsigned i_cpu = vlc_CPU();
479 /* Parse the module list for capabilities and probe each of them */
481 for (size_t i = 0; (p_module = p_all[i]) != NULL; i++)
483 bool b_shortcut_bonus = false;
485 /* Test that this module can do what we need */
486 if( !module_provides( p_module, psz_capability ) )
488 /* Test if we have the required CPU */
489 if( (p_module->i_cpu & i_cpu) != p_module->i_cpu )
492 /* If we required a shortcut, check this plugin provides it. */
493 if( i_shortcuts > 0 )
495 const char *psz_name = psz_shortcuts;
497 for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
499 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
502 if( ( c = strchr( psz_name, '@' ) )
503 ? !strncasecmp( psz_name, p_module->pp_shortcuts[i],
505 : !strcasecmp( psz_name, p_module->pp_shortcuts[i] ) )
510 b_shortcut_bonus = true;
515 /* Go to the next shortcut... This is so lame! */
516 psz_name += strlen( psz_name ) + 1;
519 /* If we are in "strict" mode and we couldn't
520 * find the module in the list of provided shortcuts,
521 * then kick the bastard out of here!!! */
525 /* If we didn't require a shortcut, trash <= 0 scored plugins */
526 else if( p_module->i_score <= 0 )
532 /* Store this new module */
533 p_list[count].p_module = module_hold (p_module);
534 p_list[count].i_score = p_module->i_score;
535 if( b_shortcut_bonus )
536 p_list[count].i_score += 10000;
537 p_list[count].b_force = b_shortcut_bonus && b_strict;
541 /* We can release the list, interesting modules are held */
542 module_list_free (p_all);
544 /* Sort candidates by descending score */
545 qsort (p_list, count, sizeof (p_list[0]), modulecmp);
546 msg_Dbg( p_this, "looking for %s module: %i candidate%s", psz_capability,
547 count, count == 1 ? "" : "s" );
549 /* Parse the linked list and use the first successful module */
551 for (size_t i = 0; (i < count) && (p_module == NULL); i++)
553 module_t *p_cand = p_list[i].p_module;
554 #ifdef HAVE_DYNAMIC_PLUGINS
555 /* Make sure the module is loaded in mem */
556 module_t *p_real = p_cand->b_submodule ? p_cand->parent : p_cand;
558 if( !p_real->b_builtin && !p_real->b_loaded )
560 module_t *p_new_module =
561 AllocatePlugin( p_this, p_real->psz_filename );
564 CacheMerge( p_this, p_real, p_new_module );
565 DeleteModule( p_new_module );
570 p_this->b_force = p_list[i].b_force;
571 if( p_cand->pf_activate
572 && p_cand->pf_activate( p_this ) == VLC_SUCCESS )
575 /* Release the remaining modules */
577 module_release (p_list[i].p_module);
580 module_release( p_cand );
584 p_this->b_force = b_force_backup;
586 if( p_module != NULL )
588 msg_Dbg( p_this, "using %s module \"%s\"",
589 psz_capability, p_module->psz_object_name );
590 if( !p_this->psz_object_name )
592 /* This assumes that p_this is the object which will be using the
593 * module. That's not always the case ... but it is in most cases.
596 p_this->psz_object_name = strdup( psz_alias );
598 p_this->psz_object_name = strdup( p_module->psz_object_name );
601 else if( count == 0 )
603 if( !strcmp( psz_capability, "access_demux" )
604 || !strcmp( psz_capability, "vout_window" ) )
606 msg_Dbg( p_this, "no %s module matched \"%s\"",
607 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
611 msg_Err( p_this, "no %s module matched \"%s\"",
612 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
614 msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
615 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
618 else if( psz_name != NULL && *psz_name )
620 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
621 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
624 msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
626 free( psz_shortcuts );
629 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
630 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
631 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
633 /* Don't forget that the module is still locked */
640 * This function must be called by the thread that called module_need, to
641 * decrease the reference count and allow for hiding of modules.
642 * \param p_this vlc object structure
643 * \param p_module the module structure
646 void __module_unneed( vlc_object_t * p_this, module_t * p_module )
648 /* Use the close method */
649 if( p_module->pf_deactivate )
651 p_module->pf_deactivate( p_this );
654 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
656 module_release( p_module );
660 * Get a pointer to a module_t given it's name.
662 * \param p_this vlc object structure
663 * \param psz_name the name of the module
664 * \return a pointer to the module or NULL in case of a failure
666 module_t *__module_find( vlc_object_t *p_this, const char * psz_name )
668 module_t **list, *module;
670 list = module_list_get (NULL);
674 for (size_t i = 0; (module = list[i]) != NULL; i++)
676 const char *psz_module_name = module->psz_object_name;
678 if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
680 module_hold (module);
684 module_list_free (list);
689 * Tell if a module exists and release it in thic case
691 * \param p_this vlc object structure
692 * \param psz_name th name of the module
693 * \return TRUE if the module exists
695 bool __module_exists( vlc_object_t *p_this, const char * psz_name )
697 module_t *p_module = __module_find( p_this, psz_name );
699 module_release (p_module);
700 return p_module != NULL;
704 * GetModuleNamesForCapability
706 * Return a NULL terminated array with the names of the modules
707 * that have a certain capability.
708 * Free after uses both the string and the table.
709 * \param p_this vlc object structure
710 * \param psz_capability the capability asked
711 * \param pppsz_longname an pointer to an array of string to contain
712 the long names of the modules. If set to NULL the function don't use it.
713 * \return the NULL terminated array
715 char ** __module_GetModulesNamesForCapability( vlc_object_t *p_this,
716 const char *psz_capability,
717 char ***pppsz_longname )
722 module_t **list = module_list_get (NULL);
724 /* Do it in two passes : count the number of modules before */
725 for (size_t i = 0; list[i]; i++)
727 module_t *p_module = list[i];
728 const char *psz_module_capability = p_module->psz_capability;
730 if( psz_module_capability && !strcmp( psz_module_capability, psz_capability ) )
734 psz_ret = malloc( sizeof(char*) * (count+1) );
736 *pppsz_longname = malloc( sizeof(char*) * (count+1) );
737 if( !psz_ret || ( pppsz_longname && *pppsz_longname == NULL ) )
740 free( *pppsz_longname );
741 *pppsz_longname = NULL;
742 module_list_free (list);
746 for (size_t i = 0, j = 0; list[i]; i++)
748 module_t *p_module = list[i];
749 const char *psz_module_capability = p_module->psz_capability;
751 if( psz_module_capability && !strcmp( psz_module_capability, psz_capability ) )
753 int k = -1; /* hack to handle submodules properly */
754 if( p_module->b_submodule )
756 while( p_module->pp_shortcuts[++k] != NULL );
759 psz_ret[j] = strdup( k>=0?p_module->pp_shortcuts[k]
760 :p_module->psz_object_name );
762 (*pppsz_longname)[j] = strdup( module_get_name( p_module, true ) );
766 psz_ret[count] = NULL;
768 module_list_free (list);
774 * Get the configuration of a module
776 * \param module the module
777 * \param psize the size of the configuration returned
778 * \return the configuration as an array
780 module_config_t *module_config_get( const module_t *module, unsigned *restrict psize )
783 unsigned size = module->confsize;
784 module_config_t *config = malloc( size * sizeof( *config ) );
786 assert( psize != NULL );
792 for( i = 0, j = 0; i < size; i++ )
794 const module_config_t *item = module->p_config + i;
795 if( item->b_internal /* internal option */
796 || item->b_unsaveable /* non-modifiable option */
797 || item->b_removed /* removed option */ )
800 memcpy( config + j, item, sizeof( *config ) );
809 * Release the configuration
811 * \param the configuration
814 void module_config_free( module_config_t *config )
819 /*****************************************************************************
820 * Following functions are local.
821 *****************************************************************************/
823 /*****************************************************************************
824 * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
826 *****************************************************************************/
827 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
831 bool escaped = false;
835 /* Alloc a buffer to store the path */
836 path = malloc( strlen( paths ) + 1 );
837 if( !path ) return NULL;
839 /* Look for PATH_SEP_CHAR (a ':' or a ';') */
840 for( i = 0, done = 0 ; paths[i]; i++ )
842 /* Take care of \\ and \: or \; escapement */
846 path[done++] = paths[i];
849 else if( paths[i] == '/' )
852 else if( paths[i] == '\\' )
855 else if( paths[i] == PATH_SEP_CHAR )
858 path[done++] = paths[i];
862 /* Return the remaining paths */
863 if( remaining_paths ) {
864 *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
870 extern char *psz_vlcpath = NULL;
872 /*****************************************************************************
873 * AllocateAllPlugins: load all plugin modules we can find.
874 *****************************************************************************/
875 #ifdef HAVE_DYNAMIC_PLUGINS
876 static void AllocateAllPlugins( vlc_object_t *p_this )
878 const char *vlcpath = psz_vlcpath;
881 vlc_array_t *arraypaths = vlc_array_new();
883 /* Contruct the special search path for system that have a relocatable
884 * executable. Set it to <vlc path>/modules and <vlc path>/plugins. */
886 if( vlcpath && asprintf( &path, "%s" DIR_SEP "modules", vlcpath ) != -1 )
887 vlc_array_append( arraypaths, path );
888 if( vlcpath && asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
889 vlc_array_append( arraypaths, path );
891 vlc_array_append( arraypaths, strdup( PLUGIN_PATH ) );
894 /* If the user provided a plugin path, we add it to the list */
895 char *userpaths = config_GetPsz( p_this, "plugin-path" );
898 for( paths_iter = userpaths; paths_iter; )
900 path = copy_next_paths_token( paths_iter, &paths_iter );
902 vlc_array_append( arraypaths, path );
905 count = vlc_array_count( arraypaths );
906 for( i = 0 ; i < count ; i++ )
908 path = vlc_array_item_at_index( arraypaths, i );
912 msg_Dbg( p_this, "recursively browsing `%s'", path );
914 /* Don't go deeper than 5 subdirectories */
915 AllocatePluginDir( p_this, path, 5 );
920 vlc_array_destroy( arraypaths );
924 /*****************************************************************************
925 * AllocatePluginDir: recursively parse a directory to look for plugins
926 *****************************************************************************/
927 static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
930 /* FIXME: Needs to be ported to wide char on ALL Windows builds */
936 #if defined( UNDER_CE ) || defined( _MSC_VER )
938 wchar_t psz_wpath[MAX_PATH + 256];
939 wchar_t psz_wdir[MAX_PATH];
941 char psz_path[MAX_PATH + 256];
942 WIN32_FIND_DATA finddata;
948 struct dirent * file;
952 if( p_this->p_libvlc->b_die || i_maxdepth < 0 )
957 #if defined( UNDER_CE ) || defined( _MSC_VER )
959 MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
961 rc = GetFileAttributes( psz_wdir );
962 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
964 /* Parse all files in the directory */
965 swprintf( psz_wpath, L"%ls\\*", psz_wdir );
967 rc = GetFileAttributes( psz_dir );
968 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
971 /* Parse all files in the directory */
972 sprintf( psz_path, "%s\\*", psz_dir );
975 handle = FindFirstFile( psz_wpath, &finddata );
977 handle = FindFirstFile( psz_path, &finddata );
979 if( handle == INVALID_HANDLE_VALUE )
981 /* Empty directory */
985 /* Parse the directory and try to load all files it contains. */
989 unsigned int i_len = wcslen( finddata.cFileName );
990 swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
991 sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
993 unsigned int i_len = strlen( finddata.cFileName );
994 sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
998 if( !*finddata.cFileName || !strcmp( finddata.cFileName, "." )
999 || !strcmp( finddata.cFileName, ".." ) )
1001 if( !FindNextFile( handle, &finddata ) ) break;
1006 if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
1008 if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
1011 AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
1013 else if( i_len > strlen( LIBEXT )
1014 /* We only load files ending with LIBEXT */
1015 && !strncasecmp( psz_path + strlen( psz_path)
1017 LIBEXT, strlen( LIBEXT ) ) )
1019 WIN32_FILE_ATTRIBUTE_DATA attrbuf;
1020 int64_t i_time = 0, i_size = 0;
1023 if( GetFileAttributesEx( psz_wpath, GetFileExInfoStandard,
1026 if( GetFileAttributesEx( psz_path, GetFileExInfoStandard,
1030 i_time = attrbuf.ftLastWriteTime.dwHighDateTime;
1032 i_time |= attrbuf.ftLastWriteTime.dwLowDateTime;
1033 i_size = attrbuf.nFileSizeHigh;
1035 i_size |= attrbuf.nFileSizeLow;
1037 psz_file = psz_path;
1039 AllocatePluginFile( p_this, psz_file, i_time, i_size );
1042 while( !p_this->p_libvlc->b_die && FindNextFile( handle, &finddata ) );
1044 /* Close the directory */
1045 FindClose( handle );
1048 dir = opendir( psz_dir );
1054 i_dirlen = strlen( psz_dir );
1056 /* Parse the directory and try to load all files it contains. */
1057 while( !p_this->p_libvlc->b_die && ( file = readdir( dir ) ) )
1059 struct stat statbuf;
1063 /* Skip ".", ".." */
1064 if( !*file->d_name || !strcmp( file->d_name, "." )
1065 || !strcmp( file->d_name, ".." ) )
1070 i_len = strlen( file->d_name );
1071 psz_file = malloc( i_dirlen + 1 + i_len + 1 );
1072 sprintf( psz_file, "%s"DIR_SEP"%s", psz_dir, file->d_name );
1074 i_stat = stat( psz_file, &statbuf );
1075 if( !i_stat && statbuf.st_mode & S_IFDIR )
1077 AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
1079 else if( i_len > strlen( LIBEXT )
1080 /* We only load files ending with LIBEXT */
1081 && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
1082 LIBEXT, strlen( LIBEXT ) ) )
1084 int64_t i_time = 0, i_size = 0;
1088 i_time = statbuf.st_mtime;
1089 i_size = statbuf.st_size;
1092 AllocatePluginFile( p_this, psz_file, i_time, i_size );
1098 /* Close the directory */
1104 /*****************************************************************************
1105 * AllocatePluginFile: load a module into memory and initialize it.
1106 *****************************************************************************
1107 * This function loads a dynamically loadable module and allocates a structure
1108 * for its information data. The module can then be handled by module_need
1109 * and module_unneed. It can be removed by DeleteModule.
1110 *****************************************************************************/
1111 static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
1112 int64_t i_file_time, int64_t i_file_size )
1114 module_t * p_module = NULL;
1115 module_cache_t *p_cache_entry = NULL;
1118 * Check our plugins cache first then load plugin if needed
1121 CacheFind( psz_file, i_file_time, i_file_size );
1123 if( !p_cache_entry )
1125 p_module = AllocatePlugin( p_this, psz_file );
1129 /* If junk dll, don't try to load it */
1130 if( p_cache_entry->b_junk )
1136 module_config_t *p_item = NULL, *p_end = NULL;
1138 p_module = p_cache_entry->p_module;
1139 p_module->b_loaded = false;
1141 /* For now we force loading if the module's config contains
1142 * callbacks or actions.
1143 * Could be optimized by adding an API call.*/
1144 for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
1145 p_item < p_end; p_item++ )
1147 if( p_item->pf_callback || p_item->i_action )
1149 p_module = AllocatePlugin( p_this, psz_file );
1153 if( p_module == p_cache_entry->p_module )
1154 p_cache_entry->b_used = true;
1160 /* Everything worked fine !
1161 * The module is ready to be added to the list. */
1162 p_module->b_builtin = false;
1164 /* msg_Dbg( p_this, "plugin \"%s\", %s",
1165 p_module->psz_object_name, p_module->psz_longname ); */
1166 p_module->next = p_module_bank->head;
1167 p_module_bank->head = p_module;
1169 if( !p_module_bank->b_cache )
1172 #define p_bank p_module_bank
1173 /* Add entry to cache */
1175 realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1176 p_bank->pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1177 if( !p_bank->pp_cache[p_bank->i_cache] )
1179 p_bank->pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1180 p_bank->pp_cache[p_bank->i_cache]->i_time = i_file_time;
1181 p_bank->pp_cache[p_bank->i_cache]->i_size = i_file_size;
1182 p_bank->pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1183 p_bank->pp_cache[p_bank->i_cache]->b_used = true;
1184 p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
1189 return p_module ? 0 : -1;
1192 /*****************************************************************************
1193 * AllocatePlugin: load a module into memory and initialize it.
1194 *****************************************************************************
1195 * This function loads a dynamically loadable module and allocates a structure
1196 * for its information data. The module can then be handled by module_need
1197 * and module_unneed. It can be removed by DeleteModule.
1198 *****************************************************************************/
1199 static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
1201 module_t * p_module = NULL;
1202 module_handle_t handle;
1204 if( module_Load( p_this, psz_file, &handle ) )
1207 /* Now that we have successfully loaded the module, we can
1208 * allocate a structure for it */
1209 p_module = vlc_module_create( p_this );
1210 if( p_module == NULL )
1212 module_Unload( handle );
1216 /* We need to fill these since they may be needed by module_Call() */
1217 p_module->psz_filename = psz_file;
1218 p_module->handle = handle;
1219 p_module->b_loaded = true;
1221 /* Initialize the module: fill p_module, default config */
1222 if( module_Call( p_this, p_module ) != 0 )
1224 /* We couldn't call module_init() */
1225 module_release( p_module );
1226 module_Unload( handle );
1230 DupModule( p_module );
1231 p_module->psz_filename = strdup( p_module->psz_filename );
1233 /* Everything worked fine ! The module is ready to be added to the list. */
1234 p_module->b_builtin = false;
1239 /*****************************************************************************
1240 * DupModule: make a plugin module standalone.
1241 *****************************************************************************
1242 * This function duplicates all strings in the module, so that the dynamic
1243 * object can be unloaded. It acts recursively on submodules.
1244 *****************************************************************************/
1245 static void DupModule( module_t *p_module )
1249 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1251 *pp_shortcut = strdup( *pp_shortcut );
1254 /* We strdup() these entries so that they are still valid when the
1255 * module is unloaded. */
1256 p_module->psz_capability = strdup( p_module->psz_capability );
1257 p_module->psz_shortname = p_module->psz_shortname ?
1258 strdup( p_module->psz_shortname ) : NULL;
1259 p_module->psz_longname = strdup( p_module->psz_longname );
1260 p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1263 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1267 /*****************************************************************************
1268 * UndupModule: free a duplicated module.
1269 *****************************************************************************
1270 * This function frees the allocations done in DupModule().
1271 *****************************************************************************/
1272 static void UndupModule( module_t *p_module )
1276 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1279 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1281 free( *pp_shortcut );
1284 free( p_module->psz_capability );
1285 FREENULL( p_module->psz_shortname );
1286 free( p_module->psz_longname );
1287 FREENULL( p_module->psz_help );
1290 #endif /* HAVE_DYNAMIC_PLUGINS */
1292 /*****************************************************************************
1293 * AllocateBuiltinModule: initialize a builtin module.
1294 *****************************************************************************
1295 * This function registers a builtin module and allocates a structure
1296 * for its information data. The module can then be handled by module_need
1297 * and module_unneed. It can be removed by DeleteModule.
1298 *****************************************************************************/
1299 static int AllocateBuiltinModule( vlc_object_t * p_this,
1300 int ( *pf_entry ) ( module_t * ) )
1302 module_t * p_module;
1304 /* Now that we have successfully loaded the module, we can
1305 * allocate a structure for it */
1306 p_module = vlc_module_create( p_this );
1307 if( p_module == NULL )
1310 /* Initialize the module : fill p_module->psz_object_name, etc. */
1311 if( pf_entry( p_module ) != 0 )
1313 /* With a well-written module we shouldn't have to print an
1314 * additional error message here, but just make sure. */
1315 msg_Err( p_this, "failed calling entry point in builtin module" );
1316 module_release( p_module );
1320 /* Everything worked fine ! The module is ready to be added to the list. */
1321 p_module->b_builtin = true;
1323 p_module->next = p_module_bank->head;
1324 p_module_bank->head = p_module;
1327 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1328 p_module->psz_object_name, p_module->psz_longname ); */
1333 /*****************************************************************************
1334 * DeleteModule: delete a module and its structure.
1335 *****************************************************************************
1336 * This function can only be called if the module isn't being used.
1337 *****************************************************************************/
1338 static void DeleteModule( module_t * p_module )
1342 /* Unlist the module (if it is in the list) */
1343 module_t **pp_self = &p_module_bank->head;
1344 while (*pp_self != NULL && *pp_self != p_module)
1345 pp_self = &((*pp_self)->next);
1347 *pp_self = p_module->next;
1349 /* We free the structures that we strdup()ed in Allocate*Module(). */
1350 #ifdef HAVE_DYNAMIC_PLUGINS
1351 if( !p_module->b_builtin )
1353 if( p_module->b_loaded && p_module->b_unloadable )
1355 module_Unload( p_module->handle );
1357 UndupModule( p_module );
1358 free( p_module->psz_filename );
1362 /* Free and detach the object's children */
1363 while (p_module->submodule)
1365 module_t *submodule = p_module->submodule;
1366 p_module->submodule = submodule->next;
1367 module_release (submodule);
1370 config_Free( p_module );
1371 module_release( p_module );