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 *, bool );
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_t *lock = var_AcquireMutex( "libvlc" );
125 if( p_module_bank == NULL )
127 p_bank = vlc_custom_create( p_this, sizeof(module_bank_t),
128 VLC_OBJECT_GENERIC, "module bank");
130 p_bank->i_cache = p_bank->i_loaded_cache = 0;
131 p_bank->pp_cache = p_bank->pp_loaded_cache = NULL;
132 p_bank->b_cache = p_bank->b_cache_dirty =
133 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( 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_t * p_next = NULL;
164 vlc_mutex_t *lock = var_AcquireMutex( "libvlc" );
167 vlc_mutex_unlock( lock );
170 if( --p_module_bank->i_usage )
172 vlc_mutex_unlock( lock );
175 vlc_mutex_unlock( lock );
177 /* Save the configuration */
178 config_AutoSaveConfigFile( p_this );
180 #ifdef HAVE_DYNAMIC_PLUGINS
181 # define p_bank p_module_bank
182 if( p_bank->b_cache ) CacheSave( p_this );
183 while( p_bank->i_loaded_cache-- )
185 if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
188 p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module,
189 p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->b_used );
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;
214 while( vlc_internals( p_module_bank )->i_children )
216 p_next = (module_t *)vlc_internals( p_module_bank )->pp_children[0];
217 DeleteModule( p_next, true );
220 vlc_object_release( p_module_bank );
221 p_module_bank = NULL;
225 * Load all modules which we built with.
227 * Fills the module bank structure with the builtin modules.
228 * \param p_this vlc object structure
231 void __module_LoadBuiltins( vlc_object_t * p_this )
233 vlc_mutex_t *lock = var_AcquireMutex( "libvlc" );
234 if( p_module_bank->b_builtins )
236 vlc_mutex_unlock( lock );
239 p_module_bank->b_builtins = true;
240 vlc_mutex_unlock( lock );
242 msg_Dbg( p_this, "checking builtin modules" );
243 ALLOCATE_ALL_BUILTINS();
249 * Load all plugin modules we can find.
250 * Fills the module bank structure with the plugin modules.
251 * \param p_this vlc object structure
254 void __module_LoadPlugins( vlc_object_t * p_this )
256 #ifdef HAVE_DYNAMIC_PLUGINS
257 vlc_mutex_t *lock = var_AcquireMutex( "libvlc" );
258 if( p_module_bank->b_plugins )
260 vlc_mutex_unlock( lock );
263 p_module_bank->b_plugins = true;
264 vlc_mutex_unlock( lock );
266 msg_Dbg( p_this, "checking plugin modules" );
268 if( config_GetInt( p_this, "plugins-cache" ) )
269 p_module_bank->b_cache = true;
271 if( p_module_bank->b_cache ||
272 p_module_bank->b_cache_delete ) CacheLoad( p_this );
274 AllocateAllPlugins( p_this );
279 * Checks whether a module implements a capability.
281 * \param m the module
282 * \param cap the capability to check
283 * \return TRUE if the module have the capability
285 bool module_IsCapable( const module_t *m, const char *cap )
287 return !strcmp( m->psz_capability, cap );
291 * Get the internal name of a module
293 * \param m the module
294 * \return the module name
296 const char *module_GetObjName( const module_t *m )
298 return m->psz_object_name;
302 * Get the human-friendly name of a module.
304 * \param m the module
305 * \param long_name TRUE to have the long name of the module
306 * \return the short or long name of the module
308 const char *module_GetName( const module_t *m, bool long_name )
310 if( long_name && ( m->psz_longname != NULL) )
311 return m->psz_longname;
313 return m->psz_shortname ?: m->psz_object_name;
317 * Get the help for a module
319 * \param m the module
322 const char *module_GetHelp( const module_t *m )
330 * Return the best module function, given a capability list.
331 * \param p_this the vlc object
332 * \param psz_capability list of capabilities needed
333 * \param psz_name name of the module asked
334 * \param b_strict TRUE yto use the strict mode
335 * \return the module or NULL in case of a failure
337 module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
338 const char *psz_name, bool b_strict )
340 typedef struct module_list_t module_list_t;
342 stats_TimerStart( p_this, "module_Need()", STATS_TIMER_MODULE_NEED );
349 module_list_t *p_next;
352 module_list_t *p_list, *p_first, *p_tmp;
355 int i_which_module, i_index = 0;
360 char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
361 bool b_force_backup = p_this->b_force;
364 /* Deal with variables */
365 if( psz_name && psz_name[0] == '$' )
367 psz_name = psz_var = var_CreateGetString( p_this, psz_name + 1 );
370 /* Count how many different shortcuts were asked for */
371 if( psz_name && *psz_name )
373 char *psz_parser, *psz_last_shortcut;
375 /* If the user wants none, give him none. */
376 if( !strcmp( psz_name, "none" ) )
379 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
380 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
381 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
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") )
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 ) );
418 unsigned i_cpu = vlc_CPU();
420 /* Parse the module list for capabilities and probe each of them */
421 for( i_which_module = 0; i_which_module < p_all->i_count; i_which_module++ )
423 int i_shortcut_bonus = 0;
425 p_module = (module_t *)p_all->p_values[i_which_module].p_object;
427 /* Test that this module can do what we need */
428 if( !module_IsCapable( p_module, psz_capability ) )
430 /* Don't recurse through the sub-modules because vlc_list_find()
431 * will list them anyway. */
435 /* Test if we have the required CPU */
436 if( (p_module->i_cpu & i_cpu) != p_module->i_cpu )
441 /* If we required a shortcut, check this plugin provides it. */
442 if( i_shortcuts > 0 )
445 const 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;
451 for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
453 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
456 if( ( c = strchr( psz_name, '@' ) )
457 ? !strncasecmp( psz_name, p_module->pp_shortcuts[i],
459 : !strcasecmp( psz_name, p_module->pp_shortcuts[i] ) )
464 i_shortcut_bonus = i_short * 10000;
469 /* Go to the next shortcut... This is so lame! */
470 psz_name += strlen( psz_name ) + 1;
473 /* If we are in "strict" mode and we couldn't
474 * find the module in the list of provided shortcuts,
475 * then kick the bastard out of here!!! */
479 /* If we didn't require a shortcut, trash <= 0 scored plugins */
480 else if( p_module->i_score <= 0 )
487 /* Store this new module */
488 p_list[ i_index ].p_module = p_module;
489 p_list[ i_index ].i_score = p_module->i_score + i_shortcut_bonus;
490 p_list[ i_index ].b_force = i_shortcut_bonus && b_strict;
492 /* Add it to the modules-to-probe list */
495 p_list[ 0 ].p_next = NULL;
500 /* Ok, so at school you learned that quicksort is quick, and
501 * bubble sort sucks raw eggs. But that's when dealing with
502 * thousands of items. Here we have barely 50. */
503 module_list_t *p_newlist = p_first;
505 if( p_first->i_score < p_list[ i_index ].i_score )
507 p_list[ i_index ].p_next = p_first;
508 p_first = &p_list[ i_index ];
512 while( p_newlist->p_next != NULL &&
513 p_newlist->p_next->i_score >= p_list[ i_index ].i_score )
515 p_newlist = p_newlist->p_next;
518 p_list[ i_index ].p_next = p_newlist->p_next;
519 p_newlist->p_next = &p_list[ i_index ];
526 msg_Dbg( p_this, "looking for %s module: %i candidate%s", psz_capability,
527 i_index, i_index == 1 ? "" : "s" );
529 /* Lock all candidate modules */
531 while( p_tmp != NULL )
533 vlc_object_yield( p_tmp->p_module );
534 p_tmp = p_tmp->p_next;
537 /* We can release the list, interesting modules were yielded */
538 vlc_list_release( p_all );
540 /* Parse the linked list and use the first successful module */
542 while( p_tmp != NULL )
544 #ifdef HAVE_DYNAMIC_PLUGINS
545 /* Make sure the module is loaded in mem */
546 module_t *p_module = p_tmp->p_module;
547 if( p_module->b_submodule )
548 p_module = (module_t *)p_module->p_parent;
550 if( !p_module->b_builtin && !p_module->b_loaded )
552 module_t *p_new_module =
553 AllocatePlugin( p_this, p_module->psz_filename );
556 CacheMerge( p_this, p_module, p_new_module );
557 vlc_object_attach( p_new_module, p_module );
558 DeleteModule( p_new_module, true );
563 p_this->b_force = p_tmp->b_force;
564 if( p_tmp->p_module->pf_activate
565 && p_tmp->p_module->pf_activate( p_this ) == VLC_SUCCESS )
570 vlc_object_release( p_tmp->p_module );
571 p_tmp = p_tmp->p_next;
574 /* Store the locked module value */
577 p_module = p_tmp->p_module;
578 p_tmp = p_tmp->p_next;
585 /* Unlock the remaining modules */
586 while( p_tmp != NULL )
588 vlc_object_release( p_tmp->p_module );
589 p_tmp = p_tmp->p_next;
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 );
600 else if( p_first == NULL )
602 if( !strcmp( psz_capability, "access_demux" ) )
604 msg_Warn( p_this, "no %s module matched \"%s\"",
605 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
609 msg_Err( p_this, "no %s module matched \"%s\"",
610 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
612 msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
613 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
616 else if( psz_name != NULL && *psz_name )
618 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
619 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
622 msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
624 if( p_module && !p_this->psz_object_name )
626 /* This assumes that p_this is the object which will be using the
627 * module. That's not always the case ... but it is in most cases.
630 p_this->psz_object_name = strdup( psz_alias );
632 p_this->psz_object_name = strdup( p_module->psz_object_name );
635 free( psz_shortcuts );
638 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
639 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
640 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
642 /* Don't forget that the module is still locked */
649 * This function must be called by the thread that called module_Need, to
650 * decrease the reference count and allow for hiding of modules.
651 * \param p_this vlc object structure
652 * \param p_module the module structure
655 void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
657 /* Use the close method */
658 if( p_module->pf_deactivate )
660 p_module->pf_deactivate( p_this );
663 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
665 vlc_object_release( p_module );
669 * Get a pointer to a module_t given it's name.
671 * \param p_this vlc object structure
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( vlc_object_t *p_this, const char * psz_name )
679 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
680 for( i = 0 ; i < p_list->i_count; i++)
682 module_t *p_module = ((module_t *) p_list->p_values[i].p_object);
683 const char *psz_module_name = p_module->psz_object_name;
684 if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
686 /* We can release the list, and return yes */
687 vlc_object_yield( p_module );
688 vlc_list_release( p_list );
692 vlc_list_release( p_list );
698 * Release a module_t pointer from module_Find().
700 * \param module the module to release
703 void module_Put( module_t *module )
705 vlc_object_release( module );
710 * Tell if a module exists and release it in thic case
712 * \param p_this vlc object structure
713 * \param psz_name th name of the module
714 * \return TRUE if the module exists
716 bool __module_Exists( vlc_object_t *p_this, const char * psz_name )
718 module_t *p_module = __module_Find( p_this, psz_name );
721 module_Put( p_module );
731 * GetModuleNamesForCapability
733 * Return a NULL terminated array with the names of the modules
734 * that have a certain capability.
735 * Free after uses both the string and the table.
736 * \param p_this vlc object structure
737 * \param psz_capability the capability asked
738 * \param pppsz_longname an pointer to an array of string to contain
739 the long names of the modules. If set to NULL the function don't use it.
740 * \return the NULL terminated array
742 char ** __module_GetModulesNamesForCapability( vlc_object_t *p_this,
743 const char *psz_capability,
744 char ***pppsz_longname )
750 /* Do it in two passes : count the number of modules before */
751 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
752 for( i = 0 ; i < p_list->i_count; i++)
754 module_t *p_module = ((module_t *) p_list->p_values[i].p_object);
755 const char *psz_module_capability = p_module->psz_capability;
756 if( psz_module_capability && !strcmp( psz_module_capability, psz_capability ) )
760 psz_ret = malloc( sizeof(char*) * (count+1) );
762 *pppsz_longname = malloc( sizeof(char*) * (count+1) );
763 if( !psz_ret || ( pppsz_longname && *pppsz_longname == NULL ) )
766 free( *pppsz_longname );
767 *pppsz_longname = NULL;
768 vlc_list_release( p_list );
773 for( i = 0 ; i < p_list->i_count; i++)
775 module_t *p_module = ((module_t *) p_list->p_values[i].p_object);
776 const char *psz_module_capability = p_module->psz_capability;
777 if( psz_module_capability && !strcmp( psz_module_capability, psz_capability ) )
779 int k = -1; /* hack to handle submodules properly */
780 if( p_module->b_submodule )
782 while( p_module->pp_shortcuts[++k] != NULL );
785 psz_ret[j] = strdup( k>=0?p_module->pp_shortcuts[k]
786 :p_module->psz_object_name );
788 (*pppsz_longname)[j] = strdup( module_GetName( p_module, true ) );
792 psz_ret[count] = NULL;
794 vlc_list_release( p_list );
800 * Get the configuration of a module
802 * \param module the module
803 * \param psize the size of the configuration returned
804 * \return the configuration as an array
806 module_config_t *module_GetConfig( const module_t *module, unsigned *restrict psize )
809 unsigned size = module->confsize;
810 module_config_t *config = malloc( size * sizeof( *config ) );
812 assert( psize != NULL );
818 for( i = 0, j = 0; i < size; i++ )
820 const module_config_t *item = module->p_config + i;
821 if( item->b_internal /* internal option */
822 || item->b_unsaveable /* non-modifiable option */
823 || item->b_removed /* removed option */ )
826 memcpy( config + j, item, sizeof( *config ) );
835 * Release the configuration
837 * \param the configuration
840 void module_PutConfig( module_config_t *config )
845 /*****************************************************************************
846 * Following functions are local.
847 *****************************************************************************/
849 /*****************************************************************************
850 * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
852 *****************************************************************************/
853 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
857 bool escaped = false;
861 /* Alloc a buffer to store the path */
862 path = malloc( strlen( paths ) + 1 );
863 if( !path ) return NULL;
865 /* Look for PATH_SEP_CHAR (a ':' or a ';') */
866 for( i = 0, done = 0 ; paths[i]; i++ )
868 /* Take care of \\ and \: or \; escapement */
872 path[done++] = paths[i];
875 else if( paths[i] == '/' )
878 else if( paths[i] == '\\' )
881 else if( paths[i] == PATH_SEP_CHAR )
884 path[done++] = paths[i];
888 /* Return the remaining paths */
889 if( remaining_paths ) {
890 *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
896 /*****************************************************************************
897 * AllocateAllPlugins: load all plugin modules we can find.
898 *****************************************************************************/
899 #ifdef HAVE_DYNAMIC_PLUGINS
900 static void AllocateAllPlugins( vlc_object_t *p_this )
902 const char *vlcpath = vlc_global()->psz_vlcpath;
905 vlc_array_t *arraypaths = vlc_array_new();
907 /* Contruct the special search path for system that have a relocatable
908 * executable. Set it to <vlc path>/modules and <vlc path>/plugins. */
910 if( vlcpath && asprintf( &path, "%s" DIR_SEP "modules", vlcpath ) != -1 )
911 vlc_array_append( arraypaths, path );
912 if( vlcpath && asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
913 vlc_array_append( arraypaths, path );
915 vlc_array_append( arraypaths, strdup( PLUGIN_PATH ) );
918 /* If the user provided a plugin path, we add it to the list */
919 char *userpaths = config_GetPsz( p_this, "plugin-path" );
922 for( paths_iter = userpaths; paths_iter; )
924 path = copy_next_paths_token( paths_iter, &paths_iter );
926 vlc_array_append( arraypaths, path );
929 count = vlc_array_count( arraypaths );
930 for( i = 0 ; i < count ; i++ )
932 path = vlc_array_item_at_index( arraypaths, i );
936 msg_Dbg( p_this, "recursively browsing `%s'", path );
938 /* Don't go deeper than 5 subdirectories */
939 AllocatePluginDir( p_this, path, 5 );
944 vlc_array_destroy( arraypaths );
948 /*****************************************************************************
949 * AllocatePluginDir: recursively parse a directory to look for plugins
950 *****************************************************************************/
951 static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
954 /* FIXME: Needs to be ported to wide char on ALL Windows builds */
960 #if defined( UNDER_CE ) || defined( _MSC_VER )
962 wchar_t psz_wpath[MAX_PATH + 256];
963 wchar_t psz_wdir[MAX_PATH];
965 char psz_path[MAX_PATH + 256];
966 WIN32_FIND_DATA finddata;
972 struct dirent * file;
976 if( p_this->p_libvlc->b_die || i_maxdepth < 0 )
981 #if defined( UNDER_CE ) || defined( _MSC_VER )
983 MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
985 rc = GetFileAttributes( psz_wdir );
986 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
988 /* Parse all files in the directory */
989 swprintf( psz_wpath, L"%ls\\*", psz_wdir );
991 rc = GetFileAttributes( psz_dir );
992 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
995 /* Parse all files in the directory */
996 sprintf( psz_path, "%s\\*", psz_dir );
999 handle = FindFirstFile( psz_wpath, &finddata );
1001 handle = FindFirstFile( psz_path, &finddata );
1003 if( handle == INVALID_HANDLE_VALUE )
1005 /* Empty directory */
1009 /* Parse the directory and try to load all files it contains. */
1013 unsigned int i_len = wcslen( finddata.cFileName );
1014 swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
1015 sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
1017 unsigned int i_len = strlen( finddata.cFileName );
1018 sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
1021 /* Skip ".", ".." */
1022 if( !*finddata.cFileName || !strcmp( finddata.cFileName, "." )
1023 || !strcmp( finddata.cFileName, ".." ) )
1025 if( !FindNextFile( handle, &finddata ) ) break;
1030 if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
1032 if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
1035 AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
1037 else if( i_len > strlen( LIBEXT )
1038 /* We only load files ending with LIBEXT */
1039 && !strncasecmp( psz_path + strlen( psz_path)
1041 LIBEXT, strlen( LIBEXT ) ) )
1043 WIN32_FILE_ATTRIBUTE_DATA attrbuf;
1044 int64_t i_time = 0, i_size = 0;
1047 if( GetFileAttributesEx( psz_wpath, GetFileExInfoStandard,
1050 if( GetFileAttributesEx( psz_path, GetFileExInfoStandard,
1054 i_time = attrbuf.ftLastWriteTime.dwHighDateTime;
1056 i_time |= attrbuf.ftLastWriteTime.dwLowDateTime;
1057 i_size = attrbuf.nFileSizeHigh;
1059 i_size |= attrbuf.nFileSizeLow;
1061 psz_file = psz_path;
1063 AllocatePluginFile( p_this, psz_file, i_time, i_size );
1066 while( !p_this->p_libvlc->b_die && FindNextFile( handle, &finddata ) );
1068 /* Close the directory */
1069 FindClose( handle );
1072 dir = opendir( psz_dir );
1078 i_dirlen = strlen( psz_dir );
1080 /* Parse the directory and try to load all files it contains. */
1081 while( !p_this->p_libvlc->b_die && ( file = readdir( dir ) ) )
1083 struct stat statbuf;
1087 /* Skip ".", ".." */
1088 if( !*file->d_name || !strcmp( file->d_name, "." )
1089 || !strcmp( file->d_name, ".." ) )
1094 i_len = strlen( file->d_name );
1095 psz_file = malloc( i_dirlen + 1 + i_len + 1 );
1096 sprintf( psz_file, "%s"DIR_SEP"%s", psz_dir, file->d_name );
1098 i_stat = stat( psz_file, &statbuf );
1099 if( !i_stat && statbuf.st_mode & S_IFDIR )
1101 AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
1103 else if( i_len > strlen( LIBEXT )
1104 /* We only load files ending with LIBEXT */
1105 && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
1106 LIBEXT, strlen( LIBEXT ) ) )
1108 int64_t i_time = 0, i_size = 0;
1112 i_time = statbuf.st_mtime;
1113 i_size = statbuf.st_size;
1116 AllocatePluginFile( p_this, psz_file, i_time, i_size );
1122 /* Close the directory */
1128 /*****************************************************************************
1129 * AllocatePluginFile: load a module into memory and initialize it.
1130 *****************************************************************************
1131 * This function loads a dynamically loadable module and allocates a structure
1132 * for its information data. The module can then be handled by module_Need
1133 * and module_Unneed. It can be removed by DeleteModule.
1134 *****************************************************************************/
1135 static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
1136 int64_t i_file_time, int64_t i_file_size )
1138 module_t * p_module = NULL;
1139 module_cache_t *p_cache_entry = NULL;
1142 * Check our plugins cache first then load plugin if needed
1145 CacheFind( psz_file, i_file_time, i_file_size );
1147 if( !p_cache_entry )
1149 p_module = AllocatePlugin( p_this, psz_file );
1153 /* If junk dll, don't try to load it */
1154 if( p_cache_entry->b_junk )
1160 module_config_t *p_item = NULL, *p_end = NULL;
1162 p_module = p_cache_entry->p_module;
1163 p_module->b_loaded = false;
1165 /* For now we force loading if the module's config contains
1166 * callbacks or actions.
1167 * Could be optimized by adding an API call.*/
1168 for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
1169 p_item < p_end; p_item++ )
1171 if( p_item->pf_callback || p_item->i_action )
1173 p_module = AllocatePlugin( p_this, psz_file );
1177 if( p_module == p_cache_entry->p_module )
1178 p_cache_entry->b_used = true;
1184 /* Everything worked fine !
1185 * The module is ready to be added to the list. */
1186 p_module->b_builtin = false;
1188 /* msg_Dbg( p_this, "plugin \"%s\", %s",
1189 p_module->psz_object_name, p_module->psz_longname ); */
1191 vlc_object_attach( p_module, p_module_bank );
1193 if( !p_module_bank->b_cache )
1196 #define p_bank p_module_bank
1197 /* Add entry to cache */
1199 realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1200 p_bank->pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1201 if( !p_bank->pp_cache[p_bank->i_cache] )
1203 p_bank->pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1204 p_bank->pp_cache[p_bank->i_cache]->i_time = i_file_time;
1205 p_bank->pp_cache[p_bank->i_cache]->i_size = i_file_size;
1206 p_bank->pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1207 p_bank->pp_cache[p_bank->i_cache]->b_used = true;
1208 p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
1213 return p_module ? 0 : -1;
1216 /*****************************************************************************
1217 * AllocatePlugin: load a module into memory and initialize it.
1218 *****************************************************************************
1219 * This function loads a dynamically loadable module and allocates a structure
1220 * for its information data. The module can then be handled by module_Need
1221 * and module_Unneed. It can be removed by DeleteModule.
1222 *****************************************************************************/
1223 static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
1225 module_t * p_module = NULL;
1226 module_handle_t handle;
1228 if( module_Load( p_this, psz_file, &handle ) )
1231 /* Now that we have successfully loaded the module, we can
1232 * allocate a structure for it */
1233 p_module = vlc_module_create( p_this );
1234 if( p_module == NULL )
1236 module_Unload( handle );
1240 /* We need to fill these since they may be needed by module_Call() */
1241 p_module->psz_filename = psz_file;
1242 p_module->handle = handle;
1243 p_module->b_loaded = true;
1245 /* Initialize the module: fill p_module, default config */
1246 if( module_Call( VLC_OBJECT(p_module), p_module ) != 0 )
1248 /* We couldn't call module_init() */
1249 vlc_object_release( p_module );
1250 module_Unload( handle );
1254 DupModule( p_module );
1255 p_module->psz_filename = strdup( p_module->psz_filename );
1257 /* Everything worked fine ! The module is ready to be added to the list. */
1258 p_module->b_builtin = false;
1263 /*****************************************************************************
1264 * DupModule: make a plugin module standalone.
1265 *****************************************************************************
1266 * This function duplicates all strings in the module, so that the dynamic
1267 * object can be unloaded. It acts recursively on submodules.
1268 *****************************************************************************/
1269 static void DupModule( module_t *p_module )
1274 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1276 *pp_shortcut = strdup( *pp_shortcut );
1279 /* We strdup() these entries so that they are still valid when the
1280 * module is unloaded. */
1281 p_module->psz_capability = strdup( p_module->psz_capability );
1282 p_module->psz_shortname = p_module->psz_shortname ?
1283 strdup( p_module->psz_shortname ) : NULL;
1284 p_module->psz_longname = strdup( p_module->psz_longname );
1285 p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1288 for( i_submodule = 0; i_submodule < vlc_internals( p_module )->i_children; i_submodule++ )
1290 DupModule( (module_t*)vlc_internals( p_module )->pp_children[ i_submodule ] );
1294 /*****************************************************************************
1295 * UndupModule: free a duplicated module.
1296 *****************************************************************************
1297 * This function frees the allocations done in DupModule().
1298 *****************************************************************************/
1299 static void UndupModule( module_t *p_module )
1304 for( i_submodule = 0; i_submodule < vlc_internals( p_module )->i_children; i_submodule++ )
1306 UndupModule( (module_t*)vlc_internals( p_module )->pp_children[ i_submodule ] );
1309 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1311 free( *pp_shortcut );
1314 FREENULL( p_module->psz_object_name );
1315 free( p_module->psz_capability );
1316 free( p_module->psz_shortname );
1317 free( p_module->psz_longname );
1318 free( p_module->psz_help );
1321 #endif /* HAVE_DYNAMIC_PLUGINS */
1323 /*****************************************************************************
1324 * AllocateBuiltinModule: initialize a builtin module.
1325 *****************************************************************************
1326 * This function registers a builtin module and allocates a structure
1327 * for its information data. The module can then be handled by module_Need
1328 * and module_Unneed. It can be removed by DeleteModule.
1329 *****************************************************************************/
1330 static int AllocateBuiltinModule( vlc_object_t * p_this,
1331 int ( *pf_entry ) ( module_t * ) )
1333 module_t * p_module;
1335 /* Now that we have successfully loaded the module, we can
1336 * allocate a structure for it */
1337 p_module = vlc_module_create( p_this );
1338 if( p_module == NULL )
1341 /* Initialize the module : fill p_module->psz_object_name, etc. */
1342 if( pf_entry( p_module ) != 0 )
1344 /* With a well-written module we shouldn't have to print an
1345 * additional error message here, but just make sure. */
1346 msg_Err( p_this, "failed calling entry point in builtin module" );
1347 vlc_object_release( p_module );
1351 /* Everything worked fine ! The module is ready to be added to the list. */
1352 p_module->b_builtin = true;
1354 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1355 p_module->psz_object_name, p_module->psz_longname ); */
1357 vlc_object_attach( p_module, p_module_bank );
1362 /*****************************************************************************
1363 * DeleteModule: delete a module and its structure.
1364 *****************************************************************************
1365 * This function can only be called if the module isn't being used.
1366 *****************************************************************************/
1367 static void DeleteModule( module_t * p_module, bool b_detach )
1372 vlc_object_detach( p_module );
1374 /* We free the structures that we strdup()ed in Allocate*Module(). */
1375 #ifdef HAVE_DYNAMIC_PLUGINS
1376 if( !p_module->b_builtin )
1378 if( p_module->b_loaded && p_module->b_unloadable )
1380 module_Unload( p_module->handle );
1382 UndupModule( p_module );
1383 free( p_module->psz_filename );
1387 /* Free and detach the object's children */
1388 while( vlc_internals( p_module )->i_children )
1390 vlc_object_t *p_this = vlc_internals( p_module )->pp_children[0];
1391 vlc_object_detach( p_this );
1392 vlc_object_release( p_this );
1395 config_Free( p_module );
1396 vlc_object_release( p_module );