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"
92 static module_bank_t *p_module_bank = NULL;
93 static vlc_mutex_t module_lock = VLC_STATIC_MUTEX;
95 int vlc_entry__main( module_t * );
97 /*****************************************************************************
99 *****************************************************************************/
100 #ifdef HAVE_DYNAMIC_PLUGINS
101 static void AllocateAllPlugins( vlc_object_t *, module_bank_t * );
102 static void AllocatePluginDir( vlc_object_t *, module_bank_t *, const char *,
104 static int AllocatePluginFile( vlc_object_t *, module_bank_t *, const char *,
106 static module_t * AllocatePlugin( vlc_object_t *, const char * );
108 static int AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
109 static void DeleteModule ( module_bank_t *, module_t * );
110 #ifdef HAVE_DYNAMIC_PLUGINS
111 static void DupModule ( module_t * );
112 static void UndupModule ( module_t * );
118 * Creates a module bank structure which will be filled later
119 * on with all the modules found.
120 * \param p_this vlc object structure
123 void __module_InitBank( vlc_object_t *p_this )
125 module_bank_t *p_bank = NULL;
127 vlc_mutex_lock( &module_lock );
129 if( p_module_bank == NULL )
131 p_bank = calloc (1, sizeof(*p_bank));
133 p_bank->i_cache = p_bank->i_loaded_cache = 0;
134 p_bank->pp_cache = p_bank->pp_loaded_cache = NULL;
135 p_bank->b_cache = p_bank->b_cache_dirty = false;
138 /* Everything worked, attach the object */
139 p_module_bank = p_bank;
141 /* Fills the module bank structure with the main module infos.
142 * This is very useful as it will allow us to consider the main
143 * library just as another module, and for instance the configuration
144 * options of main will be available in the module bank structure just
145 * as for every other module. */
146 AllocateBuiltinModule( p_this, vlc_entry__main );
149 p_module_bank->i_usage++;
151 vlc_mutex_unlock( &module_lock );
158 * Unloads all unused plugin modules and empties the module
159 * bank in case of success.
160 * \param p_this vlc object structure
163 void __module_EndBank( vlc_object_t *p_this )
165 module_bank_t *p_bank;
167 /* Save the configuration */
168 config_AutoSaveConfigFile( p_this );
170 vlc_mutex_lock( &module_lock );
171 p_bank = p_module_bank;
172 assert (p_bank != NULL);
173 if( --p_bank->i_usage > 0 )
175 vlc_mutex_unlock( &module_lock );
178 p_module_bank = NULL;
179 vlc_mutex_unlock( &module_lock );
181 #ifdef HAVE_DYNAMIC_PLUGINS
182 if( p_bank->b_cache )
183 CacheSave( p_this, p_bank );
184 while( p_bank->i_loaded_cache-- )
186 if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
188 DeleteModule( p_bank,
189 p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module );
190 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
191 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
192 p_bank->pp_loaded_cache[p_bank->i_loaded_cache] = NULL;
195 if( p_bank->pp_loaded_cache )
197 free( p_bank->pp_loaded_cache );
198 p_bank->pp_loaded_cache = NULL;
200 while( p_bank->i_cache-- )
202 free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
203 free( p_bank->pp_cache[p_bank->i_cache] );
204 p_bank->pp_cache[p_bank->i_cache] = NULL;
206 if( p_bank->pp_cache )
208 free( p_bank->pp_cache );
209 p_bank->pp_cache = NULL;
213 while( p_bank->head != NULL )
214 DeleteModule( p_bank, p_bank->head );
219 #undef module_LoadPlugins
223 * Load all plugin modules we can find.
224 * Fills the module bank structure with the plugin modules.
225 * \param p_this vlc object structure
228 void module_LoadPlugins( vlc_object_t * p_this, bool b_cache_delete )
230 #ifdef HAVE_DYNAMIC_PLUGINS
231 vlc_mutex_lock( &module_lock );
232 if( p_module_bank->b_plugins )
234 vlc_mutex_unlock( &module_lock );
237 p_module_bank->b_plugins = true;
238 vlc_mutex_unlock( &module_lock );
240 msg_Dbg( p_this, "checking plugin modules" );
241 p_module_bank->b_cache = config_GetInt( p_this, "plugins-cache" ) > 0;
243 if( p_module_bank->b_cache || b_cache_delete )
244 CacheLoad( p_this, p_module_bank, b_cache_delete );
246 /* FIXME: race - do this under the lock */
247 AllocateAllPlugins( p_this, p_module_bank );
252 * Checks whether a module implements a capability.
254 * \param m the module
255 * \param cap the capability to check
256 * \return TRUE if the module have the capability
258 bool module_provides( const module_t *m, const char *cap )
260 return !strcmp( m->psz_capability, cap );
264 * Get the internal name of a module
266 * \param m the module
267 * \return the module name
269 const char *module_get_object( const module_t *m )
271 return m->psz_object_name;
275 * Get the human-friendly name of a module.
277 * \param m the module
278 * \param long_name TRUE to have the long name of the module
279 * \return the short or long name of the module
281 const char *module_get_name( const module_t *m, bool long_name )
283 if( long_name && ( m->psz_longname != NULL) )
284 return m->psz_longname;
286 return m->psz_shortname ?: m->psz_object_name;
290 * Get the help for a module
292 * \param m the module
295 const char *module_get_help( const module_t *m )
301 * Get the capability for a module
303 * \param m the module
304 * return the capability
306 const char *module_get_capability( const module_t *m )
308 return m->psz_capability;
312 * Get the score for a module
314 * \param m the module
315 * return the score for the capability
317 int module_get_score( const module_t *m )
322 module_t *module_hold (module_t *m)
324 vlc_hold (&m->vlc_gc_data);
328 void module_release (module_t *m)
330 vlc_release (&m->vlc_gc_data);
334 * Frees the flat list of VLC modules.
335 * @param list list obtained by module_list_get()
336 * @param length number of items on the list
339 void module_list_free (module_t **list)
344 for (size_t i = 0; list[i] != NULL; i++)
345 module_release (list[i]);
350 * Gets the flat list of VLC modules.
351 * @param n [OUT] pointer to the number of modules or NULL
352 * @return NULL-terminated table of module pointers
353 * (release with module_list_free()), or NULL in case of error.
355 module_t **module_list_get (size_t *n)
357 /* TODO: this whole module lookup is quite inefficient */
358 /* Remove this and improve module_need */
359 module_t **tab = NULL;
362 assert (p_module_bank);
363 for (module_t *mod = p_module_bank->head; mod; mod = mod->next)
366 nt = realloc (tab, (i + 2 + mod->submodule_count) * sizeof (*tab));
369 module_list_free (tab);
374 tab[i++] = module_hold (mod);
375 for (module_t *subm = mod->submodule; subm; subm = subm->next)
376 tab[i++] = module_hold (subm);
384 typedef struct module_list_t
391 static int modulecmp (const void *a, const void *b)
393 const module_list_t *la = a, *lb = b;
394 /* Note that qsort() uses _ascending_ order,
395 * so the smallest module is the one with the biggest score. */
396 return lb->i_score - la->i_score;
402 * Return the best module function, given a capability list.
404 * If the p_this object doesn't have it's psz_object_name set, then
405 * psz_object_name will be set to the module's name, unless the user
406 * provided an alias using the "module name@alias" syntax in which case
407 * psz_object_name will be set to the alias.
409 * \param p_this the vlc object
410 * \param psz_capability list of capabilities needed
411 * \param psz_name name of the module asked
412 * \param b_strict TRUE yto use the strict mode
413 * \return the module or NULL in case of a failure
415 module_t * __module_need( vlc_object_t *p_this, const char *psz_capability,
416 const char *psz_name, bool b_strict )
418 stats_TimerStart( p_this, "module_need()", STATS_TIMER_MODULE_NEED );
420 module_list_t *p_list;
423 char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
424 bool b_force_backup = p_this->b_force;
426 /* Deal with variables */
427 if( psz_name && psz_name[0] == '$' )
429 psz_name = psz_var = var_CreateGetString( p_this, psz_name + 1 );
432 /* Count how many different shortcuts were asked for */
433 if( psz_name && *psz_name )
435 char *psz_parser, *psz_last_shortcut;
437 /* If the user wants none, give him none. */
438 if( !strcmp( psz_name, "none" ) )
441 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
442 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
443 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
448 psz_shortcuts = psz_last_shortcut = strdup( psz_name );
450 for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
452 if( *psz_parser == ',' )
456 psz_last_shortcut = psz_parser + 1;
460 /* Check if the user wants to override the "strict" mode */
461 if( psz_last_shortcut )
463 if( !strcmp(psz_last_shortcut, "none") )
468 else if( !strcmp(psz_last_shortcut, "any") )
476 /* Sort the modules and test them */
478 module_t **p_all = module_list_get (&count);
479 p_list = malloc( count * sizeof( module_list_t ) );
480 unsigned i_cpu = vlc_CPU();
482 /* Parse the module list for capabilities and probe each of them */
484 for (size_t i = 0; (p_module = p_all[i]) != NULL; i++)
486 bool b_shortcut_bonus = false;
488 /* Test that this module can do what we need */
489 if( !module_provides( p_module, psz_capability ) )
491 /* Test if we have the required CPU */
492 if( (p_module->i_cpu & i_cpu) != p_module->i_cpu )
495 /* If we required a shortcut, check this plugin provides it. */
496 if( i_shortcuts > 0 )
498 const char *psz_name = psz_shortcuts;
500 for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
502 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
505 if( ( c = strchr( psz_name, '@' ) )
506 ? !strncasecmp( psz_name, p_module->pp_shortcuts[i],
508 : !strcasecmp( psz_name, p_module->pp_shortcuts[i] ) )
513 b_shortcut_bonus = true;
518 /* Go to the next shortcut... This is so lame! */
519 psz_name += strlen( psz_name ) + 1;
522 /* If we are in "strict" mode and we couldn't
523 * find the module in the list of provided shortcuts,
524 * then kick the bastard out of here!!! */
528 /* If we didn't require a shortcut, trash <= 0 scored plugins */
529 else if( p_module->i_score <= 0 )
535 /* Store this new module */
536 p_list[count].p_module = module_hold (p_module);
537 p_list[count].i_score = p_module->i_score;
538 if( b_shortcut_bonus )
539 p_list[count].i_score += 10000;
540 p_list[count].b_force = b_shortcut_bonus && b_strict;
544 /* We can release the list, interesting modules are held */
545 module_list_free (p_all);
547 /* Sort candidates by descending score */
548 qsort (p_list, count, sizeof (p_list[0]), modulecmp);
550 /* FIXME: Remove this hack after finding a general solution for %z's */
551 msg_Dbg( p_this, "looking for %s module: %u candidate%s", psz_capability,
552 count, count == 1 ? "" : "s" );
554 msg_Dbg( p_this, "looking for %s module: %zu candidate%s", psz_capability,
555 count, count == 1 ? "" : "s" );
558 /* Parse the linked list and use the first successful module */
560 for (size_t i = 0; (i < count) && (p_module == NULL); i++)
562 module_t *p_cand = p_list[i].p_module;
563 #ifdef HAVE_DYNAMIC_PLUGINS
564 /* Make sure the module is loaded in mem */
565 module_t *p_real = p_cand->b_submodule ? p_cand->parent : p_cand;
567 if( !p_real->b_builtin && !p_real->b_loaded )
569 module_t *p_new_module =
570 AllocatePlugin( p_this, p_real->psz_filename );
573 CacheMerge( p_this, p_real, p_new_module );
574 DeleteModule( p_module_bank, p_new_module );
579 p_this->b_force = p_list[i].b_force;
580 if( p_cand->pf_activate
581 && p_cand->pf_activate( p_this ) == VLC_SUCCESS )
584 /* Release the remaining modules */
586 module_release (p_list[i].p_module);
589 module_release( p_cand );
593 p_this->b_force = b_force_backup;
595 if( p_module != NULL )
597 msg_Dbg( p_this, "using %s module \"%s\"",
598 psz_capability, p_module->psz_object_name );
599 if( !p_this->psz_object_name )
601 /* This assumes that p_this is the object which will be using the
602 * module. That's not always the case ... but it is in most cases.
605 p_this->psz_object_name = strdup( psz_alias );
607 p_this->psz_object_name = strdup( p_module->psz_object_name );
610 else if( count == 0 )
612 if( !strcmp( psz_capability, "access_demux" )
613 || !strcmp( psz_capability, "stream_filter" )
614 || !strcmp( psz_capability, "vout_window" ) )
616 msg_Dbg( p_this, "no %s module matched \"%s\"",
617 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
621 msg_Err( p_this, "no %s module matched \"%s\"",
622 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
624 msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
625 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
628 else if( psz_name != NULL && *psz_name )
630 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
631 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
634 msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
636 free( psz_shortcuts );
639 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
640 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
641 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
643 /* Don't forget that the module is still locked */
650 * This function must be called by the thread that called module_need, to
651 * decrease the reference count and allow for hiding of modules.
652 * \param p_this vlc object structure
653 * \param p_module the module structure
656 void __module_unneed( vlc_object_t * p_this, module_t * p_module )
658 /* Use the close method */
659 if( p_module->pf_deactivate )
661 p_module->pf_deactivate( p_this );
664 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
666 module_release( p_module );
670 * Get a pointer to a module_t given it's name.
672 * \param psz_name the name of the module
673 * \return a pointer to the module or NULL in case of a failure
675 module_t *module_find( const char * psz_name )
677 module_t **list, *module;
679 list = module_list_get (NULL);
683 for (size_t i = 0; (module = list[i]) != NULL; i++)
685 const char *psz_module_name = module->psz_object_name;
687 if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
689 module_hold (module);
693 module_list_free (list);
698 * Tell if a module exists and release it in thic case
700 * \param psz_name th name of the module
701 * \return TRUE if the module exists
703 bool module_exists (const char * psz_name)
705 module_t *p_module = module_find (psz_name);
707 module_release (p_module);
708 return p_module != NULL;
712 * Get a pointer to a module_t that matches a shortcut.
713 * This is a temporary hack for SD. Do not re-use (generally multiple modules
714 * can have the same shortcut, so this is *broken* - use module_need()!).
716 * \param psz_shortcut shortcut of the module
717 * \param psz_cap capability of the module
718 * \return a pointer to the module or NULL in case of a failure
720 module_t *module_find_by_shortcut (const char *psz_shortcut)
722 module_t **list, *module;
724 list = module_list_get (NULL);
728 for (size_t i = 0; (module = list[i]) != NULL; i++)
731 (module->pp_shortcuts[j] != NULL) && (j < MODULE_SHORTCUT_MAX);
734 if (!strcmp (module->pp_shortcuts[j], psz_shortcut))
736 module_hold (module);
742 module_list_free (list);
747 * GetModuleNamesForCapability
749 * Return a NULL terminated array with the names of the modules
750 * that have a certain capability.
751 * Free after uses both the string and the table.
752 * \param psz_capability the capability asked
753 * \param pppsz_longname an pointer to an array of string to contain
754 the long names of the modules. If set to NULL the function don't use it.
755 * \return the NULL terminated array
757 char ** module_GetModulesNamesForCapability( const char *psz_capability,
758 char ***pppsz_longname )
763 module_t **list = module_list_get (NULL);
765 /* Do it in two passes : count the number of modules before */
766 for (size_t i = 0; list[i]; i++)
768 module_t *p_module = list[i];
769 const char *psz_module_capability = p_module->psz_capability;
771 if( psz_module_capability && !strcmp( psz_module_capability, psz_capability ) )
775 psz_ret = malloc( sizeof(char*) * (count+1) );
777 *pppsz_longname = malloc( sizeof(char*) * (count+1) );
778 if( !psz_ret || ( pppsz_longname && *pppsz_longname == NULL ) )
783 free( *pppsz_longname );
784 *pppsz_longname = NULL;
786 module_list_free (list);
790 for (size_t i = 0, j = 0; list[i]; i++)
792 module_t *p_module = list[i];
793 const char *psz_module_capability = p_module->psz_capability;
795 if( psz_module_capability && !strcmp( psz_module_capability, psz_capability ) )
797 int k = -1; /* hack to handle submodules properly */
798 if( p_module->b_submodule )
800 while( p_module->pp_shortcuts[++k] != NULL );
803 psz_ret[j] = strdup( k>=0?p_module->pp_shortcuts[k]
804 :p_module->psz_object_name );
806 (*pppsz_longname)[j] = strdup( module_get_name( p_module, true ) );
810 psz_ret[count] = NULL;
812 module_list_free (list);
818 * Get the configuration of a module
820 * \param module the module
821 * \param psize the size of the configuration returned
822 * \return the configuration as an array
824 module_config_t *module_config_get( const module_t *module, unsigned *restrict psize )
827 unsigned size = module->confsize;
828 module_config_t *config = malloc( size * sizeof( *config ) );
830 assert( psize != NULL );
836 for( i = 0, j = 0; i < size; i++ )
838 const module_config_t *item = module->p_config + i;
839 if( item->b_internal /* internal option */
840 || item->b_unsaveable /* non-modifiable option */
841 || item->b_removed /* removed option */ )
844 memcpy( config + j, item, sizeof( *config ) );
853 * Release the configuration
855 * \param the configuration
858 void module_config_free( module_config_t *config )
863 /*****************************************************************************
864 * Following functions are local.
865 *****************************************************************************/
867 /*****************************************************************************
868 * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
870 *****************************************************************************/
871 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
875 bool escaped = false;
879 /* Alloc a buffer to store the path */
880 path = malloc( strlen( paths ) + 1 );
881 if( !path ) return NULL;
883 /* Look for PATH_SEP_CHAR (a ':' or a ';') */
884 for( i = 0, done = 0 ; paths[i]; i++ )
886 /* Take care of \\ and \: or \; escapement */
890 path[done++] = paths[i];
893 else if( paths[i] == '/' )
896 else if( paths[i] == '\\' )
899 else if( paths[i] == PATH_SEP_CHAR )
902 path[done++] = paths[i];
906 /* Return the remaining paths */
907 if( remaining_paths ) {
908 *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
914 char *psz_vlcpath = NULL;
916 /*****************************************************************************
917 * AllocateAllPlugins: load all plugin modules we can find.
918 *****************************************************************************/
919 #ifdef HAVE_DYNAMIC_PLUGINS
920 static void AllocateAllPlugins( vlc_object_t *p_this, module_bank_t *p_bank )
922 const char *vlcpath = psz_vlcpath;
925 vlc_array_t *arraypaths = vlc_array_new();
927 /* Contruct the special search path for system that have a relocatable
928 * executable. Set it to <vlc path>/modules and <vlc path>/plugins. */
930 if( vlcpath && asprintf( &path, "%s" DIR_SEP "modules", vlcpath ) != -1 )
931 vlc_array_append( arraypaths, path );
932 if( vlcpath && asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
933 vlc_array_append( arraypaths, path );
935 vlc_array_append( arraypaths, strdup( PLUGIN_PATH ) );
938 /* If the user provided a plugin path, we add it to the list */
939 char *userpaths = config_GetPsz( p_this, "plugin-path" );
942 for( paths_iter = userpaths; paths_iter; )
944 path = copy_next_paths_token( paths_iter, &paths_iter );
946 vlc_array_append( arraypaths, path );
949 count = vlc_array_count( arraypaths );
950 for( i = 0 ; i < count ; i++ )
952 path = vlc_array_item_at_index( arraypaths, i );
956 msg_Dbg( p_this, "recursively browsing `%s'", path );
958 /* Don't go deeper than 5 subdirectories */
959 AllocatePluginDir( p_this, p_bank, path, 5 );
964 vlc_array_destroy( arraypaths );
968 /*****************************************************************************
969 * AllocatePluginDir: recursively parse a directory to look for plugins
970 *****************************************************************************/
971 static void AllocatePluginDir( vlc_object_t *p_this, module_bank_t *p_bank,
972 const char *psz_dir, unsigned i_maxdepth )
974 /* FIXME: Needs to be ported to wide char on ALL Windows builds */
980 #if defined( UNDER_CE ) || defined( _MSC_VER )
982 wchar_t psz_wpath[MAX_PATH + 256];
983 wchar_t psz_wdir[MAX_PATH];
985 char psz_path[MAX_PATH + 256];
986 WIN32_FIND_DATA finddata;
992 struct dirent * file;
996 if( i_maxdepth == 0 )
999 #if defined( UNDER_CE ) || defined( _MSC_VER )
1001 MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
1003 rc = GetFileAttributes( psz_wdir );
1004 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
1006 /* Parse all files in the directory */
1007 swprintf( psz_wpath, L"%ls\\*", psz_wdir );
1009 rc = GetFileAttributes( psz_dir );
1010 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
1013 /* Parse all files in the directory */
1014 sprintf( psz_path, "%s\\*", psz_dir );
1017 handle = FindFirstFile( psz_wpath, &finddata );
1019 handle = FindFirstFile( psz_path, &finddata );
1021 if( handle == INVALID_HANDLE_VALUE )
1023 /* Empty directory */
1027 /* Parse the directory and try to load all files it contains. */
1031 unsigned int i_len = wcslen( finddata.cFileName );
1032 swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
1033 sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
1035 unsigned int i_len = strlen( finddata.cFileName );
1036 sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
1039 /* Skip ".", ".." */
1040 if( !*finddata.cFileName || !strcmp( finddata.cFileName, "." )
1041 || !strcmp( finddata.cFileName, ".." ) )
1043 if( !FindNextFile( handle, &finddata ) ) break;
1048 if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
1050 if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
1053 AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
1055 else if( i_len > strlen( LIBEXT )
1056 /* We only load files ending with LIBEXT */
1057 && !strncasecmp( psz_path + strlen( psz_path)
1059 LIBEXT, strlen( LIBEXT ) ) )
1061 WIN32_FILE_ATTRIBUTE_DATA attrbuf;
1062 int64_t i_time = 0, i_size = 0;
1065 if( GetFileAttributesEx( psz_wpath, GetFileExInfoStandard,
1068 if( GetFileAttributesEx( psz_path, GetFileExInfoStandard,
1072 i_time = attrbuf.ftLastWriteTime.dwHighDateTime;
1074 i_time |= attrbuf.ftLastWriteTime.dwLowDateTime;
1075 i_size = attrbuf.nFileSizeHigh;
1077 i_size |= attrbuf.nFileSizeLow;
1079 psz_file = psz_path;
1081 AllocatePluginFile( p_this, psz_file, i_time, i_size );
1084 while( !p_this->p_libvlc->b_die && FindNextFile( handle, &finddata ) );
1086 /* Close the directory */
1087 FindClose( handle );
1090 dir = opendir( psz_dir );
1096 i_dirlen = strlen( psz_dir );
1098 /* Parse the directory and try to load all files it contains. */
1099 while( !p_this->p_libvlc->b_die && ( file = readdir( dir ) ) )
1101 struct stat statbuf;
1105 /* Skip ".", ".." */
1106 if( !*file->d_name || !strcmp( file->d_name, "." )
1107 || !strcmp( file->d_name, ".." ) )
1112 i_len = strlen( file->d_name );
1113 psz_file = malloc( i_dirlen + 1 + i_len + 1 );
1114 sprintf( psz_file, "%s"DIR_SEP"%s", psz_dir, file->d_name );
1116 i_stat = stat( psz_file, &statbuf );
1117 if( !i_stat && statbuf.st_mode & S_IFDIR )
1119 AllocatePluginDir( p_this, p_bank, psz_file, i_maxdepth - 1 );
1121 else if( i_len > strlen( LIBEXT )
1122 /* We only load files ending with LIBEXT */
1123 && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
1124 LIBEXT, strlen( LIBEXT ) ) )
1126 int64_t i_time = 0, i_size = 0;
1130 i_time = statbuf.st_mtime;
1131 i_size = statbuf.st_size;
1134 AllocatePluginFile( p_this, p_bank, psz_file, i_time, i_size );
1140 /* Close the directory */
1146 /*****************************************************************************
1147 * AllocatePluginFile: load a module into memory and initialize it.
1148 *****************************************************************************
1149 * This function loads a dynamically loadable module and allocates a structure
1150 * for its information data. The module can then be handled by module_need
1151 * and module_unneed. It can be removed by DeleteModule.
1152 *****************************************************************************/
1153 static int AllocatePluginFile( vlc_object_t * p_this, module_bank_t *p_bank,
1154 const char *psz_file,
1155 int64_t i_file_time, int64_t i_file_size )
1157 module_t * p_module = NULL;
1158 module_cache_t *p_cache_entry = NULL;
1161 * Check our plugins cache first then load plugin if needed
1163 p_cache_entry = CacheFind( p_bank, psz_file, i_file_time, i_file_size );
1164 if( !p_cache_entry )
1166 p_module = AllocatePlugin( p_this, psz_file );
1170 /* If junk dll, don't try to load it */
1171 if( p_cache_entry->b_junk )
1177 module_config_t *p_item = NULL, *p_end = NULL;
1179 p_module = p_cache_entry->p_module;
1180 p_module->b_loaded = false;
1182 /* For now we force loading if the module's config contains
1183 * callbacks or actions.
1184 * Could be optimized by adding an API call.*/
1185 for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
1186 p_item < p_end; p_item++ )
1188 if( p_item->pf_callback || p_item->i_action )
1190 p_module = AllocatePlugin( p_this, psz_file );
1194 if( p_module == p_cache_entry->p_module )
1195 p_cache_entry->b_used = true;
1201 /* Everything worked fine !
1202 * The module is ready to be added to the list. */
1203 p_module->b_builtin = false;
1205 /* msg_Dbg( p_this, "plugin \"%s\", %s",
1206 p_module->psz_object_name, p_module->psz_longname ); */
1207 p_module->next = p_bank->head;
1208 p_bank->head = p_module;
1210 if( !p_module_bank->b_cache )
1213 /* Add entry to cache */
1215 realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1216 p_bank->pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1217 if( !p_bank->pp_cache[p_bank->i_cache] )
1219 p_bank->pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1220 p_bank->pp_cache[p_bank->i_cache]->i_time = i_file_time;
1221 p_bank->pp_cache[p_bank->i_cache]->i_size = i_file_size;
1222 p_bank->pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1223 p_bank->pp_cache[p_bank->i_cache]->b_used = true;
1224 p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
1228 return p_module ? 0 : -1;
1231 /*****************************************************************************
1232 * AllocatePlugin: load a module into memory and initialize it.
1233 *****************************************************************************
1234 * This function loads a dynamically loadable module and allocates a structure
1235 * for its information data. The module can then be handled by module_need
1236 * and module_unneed. It can be removed by DeleteModule.
1237 *****************************************************************************/
1238 static module_t * AllocatePlugin( vlc_object_t * p_this, const char *psz_file )
1240 module_t * p_module = NULL;
1241 module_handle_t handle;
1243 if( module_Load( p_this, psz_file, &handle ) )
1246 /* Now that we have successfully loaded the module, we can
1247 * allocate a structure for it */
1248 p_module = vlc_module_create( p_this );
1249 if( p_module == NULL )
1251 module_Unload( handle );
1255 p_module->psz_filename = strdup( psz_file );
1256 p_module->handle = handle;
1257 p_module->b_loaded = true;
1259 /* Initialize the module: fill p_module, default config */
1260 if( module_Call( p_this, p_module ) != 0 )
1262 /* We couldn't call module_init() */
1263 free( p_module->psz_filename );
1264 module_release( p_module );
1265 module_Unload( handle );
1269 DupModule( p_module );
1271 /* Everything worked fine ! The module is ready to be added to the list. */
1272 p_module->b_builtin = false;
1277 /*****************************************************************************
1278 * DupModule: make a plugin module standalone.
1279 *****************************************************************************
1280 * This function duplicates all strings in the module, so that the dynamic
1281 * object can be unloaded. It acts recursively on submodules.
1282 *****************************************************************************/
1283 static void DupModule( module_t *p_module )
1287 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1289 *pp_shortcut = strdup( *pp_shortcut );
1292 /* We strdup() these entries so that they are still valid when the
1293 * module is unloaded. */
1294 p_module->psz_capability = strdup( p_module->psz_capability );
1295 p_module->psz_shortname = p_module->psz_shortname ?
1296 strdup( p_module->psz_shortname ) : NULL;
1297 p_module->psz_longname = strdup( p_module->psz_longname );
1298 p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1301 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1305 /*****************************************************************************
1306 * UndupModule: free a duplicated module.
1307 *****************************************************************************
1308 * This function frees the allocations done in DupModule().
1309 *****************************************************************************/
1310 static void UndupModule( module_t *p_module )
1314 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1317 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1319 free( *pp_shortcut );
1322 free( p_module->psz_capability );
1323 FREENULL( p_module->psz_shortname );
1324 free( p_module->psz_longname );
1325 FREENULL( p_module->psz_help );
1328 #endif /* HAVE_DYNAMIC_PLUGINS */
1330 /*****************************************************************************
1331 * AllocateBuiltinModule: initialize a builtin module.
1332 *****************************************************************************
1333 * This function registers a builtin module and allocates a structure
1334 * for its information data. The module can then be handled by module_need
1335 * and module_unneed. It can be removed by DeleteModule.
1336 *****************************************************************************/
1337 static int AllocateBuiltinModule( vlc_object_t * p_this,
1338 int ( *pf_entry ) ( module_t * ) )
1340 module_t * p_module;
1342 /* Now that we have successfully loaded the module, we can
1343 * allocate a structure for it */
1344 p_module = vlc_module_create( p_this );
1345 if( p_module == NULL )
1348 /* Initialize the module : fill p_module->psz_object_name, etc. */
1349 if( pf_entry( p_module ) != 0 )
1351 /* With a well-written module we shouldn't have to print an
1352 * additional error message here, but just make sure. */
1353 msg_Err( p_this, "failed calling entry point in builtin module" );
1354 module_release( p_module );
1358 /* Everything worked fine ! The module is ready to be added to the list. */
1359 p_module->b_builtin = true;
1361 p_module->next = p_module_bank->head;
1362 p_module_bank->head = p_module;
1365 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1366 p_module->psz_object_name, p_module->psz_longname ); */
1371 /*****************************************************************************
1372 * DeleteModule: delete a module and its structure.
1373 *****************************************************************************
1374 * This function can only be called if the module isn't being used.
1375 *****************************************************************************/
1376 static void DeleteModule( module_bank_t *p_bank, module_t * p_module )
1380 /* Unlist the module (if it is in the list) */
1381 module_t **pp_self = &p_bank->head;
1382 while (*pp_self != NULL && *pp_self != p_module)
1383 pp_self = &((*pp_self)->next);
1385 *pp_self = p_module->next;
1387 /* We free the structures that we strdup()ed in Allocate*Module(). */
1388 #ifdef HAVE_DYNAMIC_PLUGINS
1389 if( !p_module->b_builtin )
1391 if( p_module->b_loaded && p_module->b_unloadable )
1393 module_Unload( p_module->handle );
1395 UndupModule( p_module );
1396 free( p_module->psz_filename );
1400 /* Free and detach the object's children */
1401 while (p_module->submodule)
1403 module_t *submodule = p_module->submodule;
1404 p_module->submodule = submodule->next;
1405 module_release (submodule);
1408 config_Free( p_module );
1409 module_release( p_module );