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 /*****************************************************************************
95 *****************************************************************************/
96 #ifdef HAVE_DYNAMIC_PLUGINS
97 static void AllocateAllPlugins ( vlc_object_t * );
98 static void AllocatePluginDir ( vlc_object_t *, const char *, int );
99 static int AllocatePluginFile ( vlc_object_t *, char *, int64_t, int64_t );
100 static module_t * AllocatePlugin( vlc_object_t *, char * );
102 static int AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
103 static void DeleteModule ( module_t *, bool );
104 #ifdef HAVE_DYNAMIC_PLUGINS
105 static void DupModule ( module_t * );
106 static void UndupModule ( module_t * );
112 * Creates a module bank structure which will be filled later
113 * on with all the modules found.
114 * \param p_this vlc object structure
117 void __module_InitBank( vlc_object_t *p_this )
119 module_bank_t *p_bank = NULL;
120 libvlc_global_data_t *p_libvlc_global = vlc_global();
122 vlc_mutex_t *lock = var_AcquireMutex( "libvlc" );
124 if( p_libvlc_global->p_module_bank == NULL )
126 p_bank = vlc_custom_create( p_this, sizeof(module_bank_t),
127 VLC_OBJECT_GENERIC, "module 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;
134 /* Everything worked, attach the object */
135 p_libvlc_global->p_module_bank = p_bank;
136 vlc_object_attach( p_bank, p_libvlc_global );
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_libvlc_global->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;
163 libvlc_global_data_t *p_libvlc_global = vlc_global();
165 vlc_mutex_t *lock = var_AcquireMutex( "libvlc" );
166 if( !p_libvlc_global->p_module_bank )
168 vlc_mutex_unlock( lock );
171 if( --p_libvlc_global->p_module_bank->i_usage )
173 vlc_mutex_unlock( lock );
176 vlc_mutex_unlock( lock );
178 /* Save the configuration */
179 config_AutoSaveConfigFile( p_this );
181 #ifdef HAVE_DYNAMIC_PLUGINS
182 # define p_bank p_libvlc_global->p_module_bank
183 if( p_bank->b_cache ) CacheSave( p_this );
184 while( p_bank->i_loaded_cache-- )
186 if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
189 p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module,
190 p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->b_used );
191 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
192 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
193 p_bank->pp_loaded_cache[p_bank->i_loaded_cache] = NULL;
196 if( p_bank->pp_loaded_cache )
198 free( p_bank->pp_loaded_cache );
199 p_bank->pp_loaded_cache = NULL;
201 while( p_bank->i_cache-- )
203 free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
204 free( p_bank->pp_cache[p_bank->i_cache] );
205 p_bank->pp_cache[p_bank->i_cache] = NULL;
207 if( p_bank->pp_cache )
209 free( p_bank->pp_cache );
210 p_bank->pp_cache = NULL;
215 vlc_object_detach( p_libvlc_global->p_module_bank );
217 while( vlc_internals( p_libvlc_global->p_module_bank )->i_children )
219 p_next = (module_t *)vlc_internals( p_libvlc_global->p_module_bank )->pp_children[0];
220 DeleteModule( p_next, true );
223 vlc_object_release( p_libvlc_global->p_module_bank );
224 p_libvlc_global->p_module_bank = NULL;
228 * Load all modules which we built with.
230 * Fills the module bank structure with the builtin modules.
231 * \param p_this vlc object structure
234 void __module_LoadBuiltins( vlc_object_t * p_this )
236 libvlc_global_data_t *p_libvlc_global = vlc_global();
238 vlc_mutex_t *lock = var_AcquireMutex( "libvlc" );
239 if( p_libvlc_global->p_module_bank->b_builtins )
241 vlc_mutex_unlock( lock );
244 p_libvlc_global->p_module_bank->b_builtins = true;
245 vlc_mutex_unlock( lock );
247 msg_Dbg( p_this, "checking builtin modules" );
248 ALLOCATE_ALL_BUILTINS();
254 * Load all plugin modules we can find.
255 * Fills the module bank structure with the plugin modules.
256 * \param p_this vlc object structure
259 void __module_LoadPlugins( vlc_object_t * p_this )
261 #ifdef HAVE_DYNAMIC_PLUGINS
262 libvlc_global_data_t *p_libvlc_global = vlc_global();
264 vlc_mutex_t *lock = var_AcquireMutex( "libvlc" );
265 if( p_libvlc_global->p_module_bank->b_plugins )
267 vlc_mutex_unlock( lock );
270 p_libvlc_global->p_module_bank->b_plugins = true;
271 vlc_mutex_unlock( lock );
273 msg_Dbg( p_this, "checking plugin modules" );
275 if( config_GetInt( p_this, "plugins-cache" ) )
276 p_libvlc_global->p_module_bank->b_cache = true;
278 if( p_libvlc_global->p_module_bank->b_cache ||
279 p_libvlc_global->p_module_bank->b_cache_delete ) CacheLoad( p_this );
281 AllocateAllPlugins( p_this );
286 * Checks whether a module implements a capability.
288 * \param m the module
289 * \param cap the capability to check
290 * \return TRUE if the module have the capability
292 bool module_IsCapable( const module_t *m, const char *cap )
294 return !strcmp( m->psz_capability, cap );
298 * Get the internal name of a module
300 * \param m the module
301 * \return the module name
303 const char *module_GetObjName( const module_t *m )
305 return m->psz_object_name;
309 * Get the human-friendly name of a module.
311 * \param m the module
312 * \param long_name TRUE to have the long name of the module
313 * \return the short or long name of the module
315 const char *module_GetName( const module_t *m, bool long_name )
317 if( long_name && ( m->psz_longname != NULL) )
318 return m->psz_longname;
320 return m->psz_shortname ?: m->psz_object_name;
324 * Get the help for a module
326 * \param m the module
329 const char *module_GetHelp( const module_t *m )
337 * Return the best module function, given a capability list.
338 * \param p_this the vlc object
339 * \param psz_capability list of capabilities needed
340 * \param psz_name name of the module asked
341 * \param b_strict TRUE yto use the strict mode
342 * \return the module or NULL in case of a failure
344 module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
345 const char *psz_name, bool b_strict )
347 typedef struct module_list_t module_list_t;
349 stats_TimerStart( p_this, "module_Need()", STATS_TIMER_MODULE_NEED );
356 module_list_t *p_next;
359 module_list_t *p_list, *p_first, *p_tmp;
362 int i_which_module, i_index = 0;
367 char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
368 bool b_force_backup = p_this->b_force;
371 /* Deal with variables */
372 if( psz_name && psz_name[0] == '$' )
375 var_Create( p_this, psz_name + 1, VLC_VAR_MODULE | VLC_VAR_DOINHERIT );
376 var_Get( p_this, psz_name + 1, &val );
377 psz_var = val.psz_string;
381 /* Count how many different shortcuts were asked for */
382 if( psz_name && *psz_name )
384 char *psz_parser, *psz_last_shortcut;
386 /* If the user wants none, give him none. */
387 if( !strcmp( psz_name, "none" ) )
390 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
391 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
392 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
397 psz_shortcuts = psz_last_shortcut = strdup( psz_name );
399 for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
401 if( *psz_parser == ',' )
405 psz_last_shortcut = psz_parser + 1;
409 /* Check if the user wants to override the "strict" mode */
410 if( psz_last_shortcut )
412 if( !strcmp(psz_last_shortcut, "none") )
417 else if( !strcmp(psz_last_shortcut, "any") )
425 /* Sort the modules and test them */
426 p_all = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
427 p_list = malloc( p_all->i_count * sizeof( module_list_t ) );
429 unsigned i_cpu = vlc_CPU();
431 /* Parse the module list for capabilities and probe each of them */
432 for( i_which_module = 0; i_which_module < p_all->i_count; i_which_module++ )
434 int i_shortcut_bonus = 0;
436 p_module = (module_t *)p_all->p_values[i_which_module].p_object;
438 /* Test that this module can do what we need */
439 if( !module_IsCapable( p_module, psz_capability ) )
441 /* Don't recurse through the sub-modules because vlc_list_find()
442 * will list them anyway. */
446 /* Test if we have the required CPU */
447 if( (p_module->i_cpu & i_cpu) != p_module->i_cpu )
452 /* If we required a shortcut, check this plugin provides it. */
453 if( i_shortcuts > 0 )
456 const char *psz_name = psz_shortcuts;
458 /* Let's drop modules with a <= 0 score (unless they are
459 * explicitly requested) */
460 b_trash = p_module->i_score <= 0;
462 for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
464 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
467 if( ( c = strchr( psz_name, '@' ) )
468 ? !strncasecmp( psz_name, p_module->pp_shortcuts[i],
470 : !strcasecmp( psz_name, p_module->pp_shortcuts[i] ) )
475 i_shortcut_bonus = i_short * 10000;
480 /* Go to the next shortcut... This is so lame! */
481 psz_name += strlen( psz_name ) + 1;
484 /* If we are in "strict" mode and we couldn't
485 * find the module in the list of provided shortcuts,
486 * then kick the bastard out of here!!! */
490 /* If we didn't require a shortcut, trash <= 0 scored plugins */
491 else if( p_module->i_score <= 0 )
498 /* Store this new module */
499 p_list[ i_index ].p_module = p_module;
500 p_list[ i_index ].i_score = p_module->i_score + i_shortcut_bonus;
501 p_list[ i_index ].b_force = i_shortcut_bonus && b_strict;
503 /* Add it to the modules-to-probe list */
506 p_list[ 0 ].p_next = NULL;
511 /* Ok, so at school you learned that quicksort is quick, and
512 * bubble sort sucks raw eggs. But that's when dealing with
513 * thousands of items. Here we have barely 50. */
514 module_list_t *p_newlist = p_first;
516 if( p_first->i_score < p_list[ i_index ].i_score )
518 p_list[ i_index ].p_next = p_first;
519 p_first = &p_list[ i_index ];
523 while( p_newlist->p_next != NULL &&
524 p_newlist->p_next->i_score >= p_list[ i_index ].i_score )
526 p_newlist = p_newlist->p_next;
529 p_list[ i_index ].p_next = p_newlist->p_next;
530 p_newlist->p_next = &p_list[ i_index ];
537 msg_Dbg( p_this, "looking for %s module: %i candidate%s", psz_capability,
538 i_index, i_index == 1 ? "" : "s" );
540 /* Lock all candidate modules */
542 while( p_tmp != NULL )
544 vlc_object_yield( p_tmp->p_module );
545 p_tmp = p_tmp->p_next;
548 /* We can release the list, interesting modules were yielded */
549 vlc_list_release( p_all );
551 /* Parse the linked list and use the first successful module */
553 while( p_tmp != NULL )
555 #ifdef HAVE_DYNAMIC_PLUGINS
556 /* Make sure the module is loaded in mem */
557 module_t *p_module = p_tmp->p_module;
558 if( p_module->b_submodule )
559 p_module = (module_t *)p_module->p_parent;
561 if( !p_module->b_builtin && !p_module->b_loaded )
563 module_t *p_new_module =
564 AllocatePlugin( p_this, p_module->psz_filename );
567 CacheMerge( p_this, p_module, p_new_module );
568 vlc_object_attach( p_new_module, p_module );
569 DeleteModule( p_new_module, true );
574 p_this->b_force = p_tmp->b_force;
575 if( p_tmp->p_module->pf_activate
576 && p_tmp->p_module->pf_activate( p_this ) == VLC_SUCCESS )
581 vlc_object_release( p_tmp->p_module );
582 p_tmp = p_tmp->p_next;
585 /* Store the locked module value */
588 p_module = p_tmp->p_module;
589 p_tmp = p_tmp->p_next;
596 /* Unlock the remaining modules */
597 while( p_tmp != NULL )
599 vlc_object_release( p_tmp->p_module );
600 p_tmp = p_tmp->p_next;
604 p_this->b_force = b_force_backup;
606 if( p_module != NULL )
608 msg_Dbg( p_this, "using %s module \"%s\"",
609 psz_capability, p_module->psz_object_name );
611 else if( p_first == NULL )
613 if( !strcmp( psz_capability, "access_demux" ) )
615 msg_Warn( p_this, "no %s module matched \"%s\"",
616 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
620 msg_Err( p_this, "no %s module matched \"%s\"",
621 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
623 msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
624 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
627 else if( psz_name != NULL && *psz_name )
629 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
630 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
633 msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
635 if( p_module && !p_this->psz_object_name )
637 /* This assumes that p_this is the object which will be using the
638 * module. That's not always the case ... but it is in most cases.
641 p_this->psz_object_name = strdup( psz_alias );
643 p_this->psz_object_name = strdup( p_module->psz_object_name );
646 free( psz_shortcuts );
649 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
650 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
651 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
653 /* Don't forget that the module is still locked */
660 * This function must be called by the thread that called module_Need, to
661 * decrease the reference count and allow for hiding of modules.
662 * \param p_this vlc object structure
663 * \param p_module the module structure
666 void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
668 /* Use the close method */
669 if( p_module->pf_deactivate )
671 p_module->pf_deactivate( p_this );
674 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
676 vlc_object_release( p_module );
680 * Get a pointer to a module_t given it's name.
682 * \param p_this vlc object structure
683 * \param psz_name the name of the module
684 * \return a pointer to the module or NULL in case of a failure
686 module_t *__module_Find( vlc_object_t *p_this, const char * psz_name )
690 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
691 for( i = 0 ; i < p_list->i_count; i++)
693 module_t *p_module = ((module_t *) p_list->p_values[i].p_object);
694 const char *psz_module_name = p_module->psz_object_name;
695 if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
697 /* We can release the list, and return yes */
698 vlc_object_yield( p_module );
699 vlc_list_release( p_list );
703 vlc_list_release( p_list );
709 * Release a module_t pointer from module_Find().
711 * \param module the module to release
714 void module_Put( module_t *module )
716 vlc_object_release( module );
721 * Tell if a module exists and release it in thic case
723 * \param p_this vlc object structure
724 * \param psz_name th name of the module
725 * \return TRUE if the module exists
727 bool __module_Exists( vlc_object_t *p_this, const char * psz_name )
729 module_t *p_module = __module_Find( p_this, psz_name );
732 module_Put( p_module );
742 * GetModuleNamesForCapability
744 * Return a NULL terminated array with the names of the modules
745 * that have a certain capability.
746 * Free after uses both the string and the table.
747 * \param p_this vlc object structure
748 * \param psz_capability the capability asked
749 * \param pppsz_longname an pointer to an array of string to contain
750 the long names of the modules. If set to NULL the function don't use it.
751 * \return the NULL terminated array
753 char ** __module_GetModulesNamesForCapability( vlc_object_t *p_this,
754 const char *psz_capability,
755 char ***pppsz_longname )
761 /* Do it in two passes : count the number of modules before */
762 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
763 for( i = 0 ; i < p_list->i_count; i++)
765 module_t *p_module = ((module_t *) p_list->p_values[i].p_object);
766 const char *psz_module_capability = p_module->psz_capability;
767 if( psz_module_capability && !strcmp( psz_module_capability, psz_capability ) )
771 psz_ret = malloc( sizeof(char*) * (count+1) );
773 *pppsz_longname = malloc( sizeof(char*) * (count+1) );
774 if( !psz_ret || ( pppsz_longname && *pppsz_longname == NULL ) )
777 free( *pppsz_longname );
778 *pppsz_longname = NULL;
779 vlc_list_release( p_list );
784 for( i = 0 ; i < p_list->i_count; i++)
786 module_t *p_module = ((module_t *) p_list->p_values[i].p_object);
787 const char *psz_module_capability = p_module->psz_capability;
788 if( psz_module_capability && !strcmp( psz_module_capability, psz_capability ) )
790 int k = -1; /* hack to handle submodules properly */
791 if( p_module->b_submodule )
793 while( p_module->pp_shortcuts[++k] != NULL );
796 psz_ret[j] = strdup( k>=0?p_module->pp_shortcuts[k]
797 :p_module->psz_object_name );
799 (*pppsz_longname)[j] = strdup( module_GetName( p_module, true ) );
803 psz_ret[count] = NULL;
805 vlc_list_release( p_list );
811 * Get the configuration of a module
813 * \param module the module
814 * \param psize the size of the configuration returned
815 * \return the configuration as an array
817 module_config_t *module_GetConfig( const module_t *module, unsigned *restrict psize )
820 unsigned size = module->confsize;
821 module_config_t *config = malloc( size * sizeof( *config ) );
823 assert( psize != NULL );
829 for( i = 0, j = 0; i < size; i++ )
831 const module_config_t *item = module->p_config + i;
832 if( item->b_internal /* internal option */
833 || item->b_unsaveable /* non-modifiable option */
834 || item->b_removed /* removed option */ )
837 memcpy( config + j, item, sizeof( *config ) );
846 * Release the configuration
848 * \param the configuration
851 void module_PutConfig( module_config_t *config )
856 /*****************************************************************************
857 * Following functions are local.
858 *****************************************************************************/
860 /*****************************************************************************
861 * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
863 *****************************************************************************/
864 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
868 bool escaped = false;
872 /* Alloc a buffer to store the path */
873 path = malloc( strlen( paths ) + 1 );
874 if( !path ) return NULL;
876 /* Look for PATH_SEP_CHAR (a ':' or a ';') */
877 for( i = 0, done = 0 ; paths[i]; i++ ) {
878 /* Take care of \\ and \: or \; escapement */
881 path[done++] = paths[i];
883 else if( paths[i] == '\\' )
885 else if( paths[i] == PATH_SEP_CHAR )
888 path[done++] = paths[i];
892 /* Return the remaining paths */
893 if( remaining_paths ) {
894 *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
900 /*****************************************************************************
901 * AllocateAllPlugins: load all plugin modules we can find.
902 *****************************************************************************/
903 #ifdef HAVE_DYNAMIC_PLUGINS
904 static void AllocateAllPlugins( vlc_object_t *p_this )
906 const char *vlcpath = vlc_global()->psz_vlcpath;
909 vlc_array_t *arraypaths = vlc_array_new();
911 /* Contruct the special search path for system that have a relocatable
912 * executable. Set it to <vlc path>/modules and <vlc path>/plugins. */
914 if( vlcpath && asprintf( &path, "%s" DIR_SEP "modules", vlcpath ) != -1 )
915 vlc_array_append( arraypaths, path );
916 if( vlcpath && asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
917 vlc_array_append( arraypaths, path );
919 vlc_array_append( arraypaths, strdup( PLUGIN_PATH ) );
922 /* If the user provided a plugin path, we add it to the list */
923 char *userpaths = config_GetPsz( p_this, "plugin-path" );
926 for( paths_iter = userpaths; paths_iter; )
928 path = copy_next_paths_token( paths_iter, &paths_iter );
930 vlc_array_append( arraypaths, path );
933 count = vlc_array_count( arraypaths );
934 for( i = 0 ; i < count ; i++ )
936 path = vlc_array_item_at_index( arraypaths, i );
940 msg_Dbg( p_this, "recursively browsing `%s'", path );
942 /* Don't go deeper than 5 subdirectories */
943 AllocatePluginDir( p_this, path, 5 );
948 vlc_array_destroy( arraypaths );
952 /*****************************************************************************
953 * AllocatePluginDir: recursively parse a directory to look for plugins
954 *****************************************************************************/
955 static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
958 /* FIXME: Needs to be ported to wide char on ALL Windows builds */
964 #if defined( UNDER_CE ) || defined( _MSC_VER )
966 wchar_t psz_wpath[MAX_PATH + 256];
967 wchar_t psz_wdir[MAX_PATH];
969 char psz_path[MAX_PATH + 256];
970 WIN32_FIND_DATA finddata;
976 struct dirent * file;
980 if( p_this->p_libvlc->b_die || i_maxdepth < 0 )
985 #if defined( UNDER_CE ) || defined( _MSC_VER )
987 MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
989 rc = GetFileAttributes( psz_wdir );
990 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
992 /* Parse all files in the directory */
993 swprintf( psz_wpath, L"%ls\\*", psz_wdir );
995 rc = GetFileAttributes( psz_dir );
996 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
999 /* Parse all files in the directory */
1000 sprintf( psz_path, "%s\\*", psz_dir );
1003 handle = FindFirstFile( psz_wpath, &finddata );
1005 handle = FindFirstFile( psz_path, &finddata );
1007 if( handle == INVALID_HANDLE_VALUE )
1009 /* Empty directory */
1013 /* Parse the directory and try to load all files it contains. */
1017 unsigned int i_len = wcslen( finddata.cFileName );
1018 swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
1019 sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
1021 unsigned int i_len = strlen( finddata.cFileName );
1022 sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
1025 /* Skip ".", ".." */
1026 if( !*finddata.cFileName || !strcmp( finddata.cFileName, "." )
1027 || !strcmp( finddata.cFileName, ".." ) )
1029 if( !FindNextFile( handle, &finddata ) ) break;
1034 if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
1036 if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
1039 AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
1041 else if( i_len > strlen( LIBEXT )
1042 /* We only load files ending with LIBEXT */
1043 && !strncasecmp( psz_path + strlen( psz_path)
1045 LIBEXT, strlen( LIBEXT ) ) )
1047 WIN32_FILE_ATTRIBUTE_DATA attrbuf;
1048 int64_t i_time = 0, i_size = 0;
1051 if( GetFileAttributesEx( psz_wpath, GetFileExInfoStandard,
1054 if( GetFileAttributesEx( psz_path, GetFileExInfoStandard,
1058 i_time = attrbuf.ftLastWriteTime.dwHighDateTime;
1060 i_time |= attrbuf.ftLastWriteTime.dwLowDateTime;
1061 i_size = attrbuf.nFileSizeHigh;
1063 i_size |= attrbuf.nFileSizeLow;
1065 psz_file = psz_path;
1067 AllocatePluginFile( p_this, psz_file, i_time, i_size );
1070 while( !p_this->p_libvlc->b_die && FindNextFile( handle, &finddata ) );
1072 /* Close the directory */
1073 FindClose( handle );
1076 dir = opendir( psz_dir );
1082 i_dirlen = strlen( psz_dir );
1084 /* Parse the directory and try to load all files it contains. */
1085 while( !p_this->p_libvlc->b_die && ( file = readdir( dir ) ) )
1087 struct stat statbuf;
1091 /* Skip ".", ".." */
1092 if( !*file->d_name || !strcmp( file->d_name, "." )
1093 || !strcmp( file->d_name, ".." ) )
1098 i_len = strlen( file->d_name );
1099 psz_file = malloc( i_dirlen + 1 + i_len + 1 );
1100 sprintf( psz_file, "%s"DIR_SEP"%s", psz_dir, file->d_name );
1102 i_stat = stat( psz_file, &statbuf );
1103 if( !i_stat && statbuf.st_mode & S_IFDIR )
1105 AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
1107 else if( i_len > strlen( LIBEXT )
1108 /* We only load files ending with LIBEXT */
1109 && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
1110 LIBEXT, strlen( LIBEXT ) ) )
1112 int64_t i_time = 0, i_size = 0;
1116 i_time = statbuf.st_mtime;
1117 i_size = statbuf.st_size;
1120 AllocatePluginFile( p_this, psz_file, i_time, i_size );
1126 /* Close the directory */
1132 /*****************************************************************************
1133 * AllocatePluginFile: load a module into memory and initialize it.
1134 *****************************************************************************
1135 * This function loads a dynamically loadable module and allocates a structure
1136 * for its information data. The module can then be handled by module_Need
1137 * and module_Unneed. It can be removed by DeleteModule.
1138 *****************************************************************************/
1139 static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
1140 int64_t i_file_time, int64_t i_file_size )
1142 module_t * p_module = NULL;
1143 module_cache_t *p_cache_entry = NULL;
1146 * Check our plugins cache first then load plugin if needed
1149 CacheFind( psz_file, i_file_time, i_file_size );
1151 if( !p_cache_entry )
1153 p_module = AllocatePlugin( p_this, psz_file );
1157 /* If junk dll, don't try to load it */
1158 if( p_cache_entry->b_junk )
1164 module_config_t *p_item = NULL, *p_end = NULL;
1166 p_module = p_cache_entry->p_module;
1167 p_module->b_loaded = false;
1169 /* For now we force loading if the module's config contains
1170 * callbacks or actions.
1171 * Could be optimized by adding an API call.*/
1172 for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
1173 p_item < p_end; p_item++ )
1175 if( p_item->pf_callback || p_item->i_action )
1177 p_module = AllocatePlugin( p_this, psz_file );
1181 if( p_module == p_cache_entry->p_module )
1182 p_cache_entry->b_used = true;
1188 libvlc_global_data_t *p_libvlc_global = vlc_global();
1190 /* Everything worked fine !
1191 * The module is ready to be added to the list. */
1192 p_module->b_builtin = false;
1194 /* msg_Dbg( p_this, "plugin \"%s\", %s",
1195 p_module->psz_object_name, p_module->psz_longname ); */
1197 vlc_object_attach( p_module, p_libvlc_global->p_module_bank );
1199 if( !p_libvlc_global->p_module_bank->b_cache )
1202 #define p_bank p_libvlc_global->p_module_bank
1203 /* Add entry to cache */
1205 realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1206 p_bank->pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1207 if( !p_bank->pp_cache[p_bank->i_cache] )
1209 p_bank->pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1210 p_bank->pp_cache[p_bank->i_cache]->i_time = i_file_time;
1211 p_bank->pp_cache[p_bank->i_cache]->i_size = i_file_size;
1212 p_bank->pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1213 p_bank->pp_cache[p_bank->i_cache]->b_used = true;
1214 p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
1218 return p_module ? 0 : -1;
1221 /*****************************************************************************
1222 * AllocatePlugin: load a module into memory and initialize it.
1223 *****************************************************************************
1224 * This function loads a dynamically loadable module and allocates a structure
1225 * for its information data. The module can then be handled by module_Need
1226 * and module_Unneed. It can be removed by DeleteModule.
1227 *****************************************************************************/
1228 static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
1230 module_t * p_module = NULL;
1231 module_handle_t handle;
1233 if( module_Load( p_this, psz_file, &handle ) )
1236 /* Now that we have successfully loaded the module, we can
1237 * allocate a structure for it */
1238 p_module = vlc_module_create( p_this );
1239 if( p_module == NULL )
1241 msg_Err( p_this, "out of memory" );
1242 module_Unload( handle );
1246 /* We need to fill these since they may be needed by module_Call() */
1247 p_module->psz_filename = psz_file;
1248 p_module->handle = handle;
1249 p_module->b_loaded = true;
1251 /* Initialize the module: fill p_module, default config */
1252 if( module_Call( p_module ) != 0 )
1254 /* We couldn't call module_init() */
1255 vlc_object_release( p_module );
1256 module_Unload( handle );
1260 DupModule( p_module );
1261 p_module->psz_filename = strdup( p_module->psz_filename );
1263 /* Everything worked fine ! The module is ready to be added to the list. */
1264 p_module->b_builtin = false;
1269 /*****************************************************************************
1270 * DupModule: make a plugin module standalone.
1271 *****************************************************************************
1272 * This function duplicates all strings in the module, so that the dynamic
1273 * object can be unloaded. It acts recursively on submodules.
1274 *****************************************************************************/
1275 static void DupModule( module_t *p_module )
1280 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1282 *pp_shortcut = strdup( *pp_shortcut );
1285 /* We strdup() these entries so that they are still valid when the
1286 * module is unloaded. */
1287 p_module->psz_capability = strdup( p_module->psz_capability );
1288 p_module->psz_shortname = p_module->psz_shortname ?
1289 strdup( p_module->psz_shortname ) : NULL;
1290 p_module->psz_longname = strdup( p_module->psz_longname );
1291 p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1294 for( i_submodule = 0; i_submodule < vlc_internals( p_module )->i_children; i_submodule++ )
1296 DupModule( (module_t*)vlc_internals( p_module )->pp_children[ i_submodule ] );
1300 /*****************************************************************************
1301 * UndupModule: free a duplicated module.
1302 *****************************************************************************
1303 * This function frees the allocations done in DupModule().
1304 *****************************************************************************/
1305 static void UndupModule( module_t *p_module )
1310 for( i_submodule = 0; i_submodule < vlc_internals( p_module )->i_children; i_submodule++ )
1312 UndupModule( (module_t*)vlc_internals( p_module )->pp_children[ i_submodule ] );
1315 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1317 free( *pp_shortcut );
1320 FREENULL( p_module->psz_object_name );
1321 free( p_module->psz_capability );
1322 free( p_module->psz_shortname );
1323 free( p_module->psz_longname );
1324 free( p_module->psz_help );
1327 #endif /* HAVE_DYNAMIC_PLUGINS */
1329 /*****************************************************************************
1330 * AllocateBuiltinModule: initialize a builtin module.
1331 *****************************************************************************
1332 * This function registers a builtin module and allocates a structure
1333 * for its information data. The module can then be handled by module_Need
1334 * and module_Unneed. It can be removed by DeleteModule.
1335 *****************************************************************************/
1336 static int AllocateBuiltinModule( vlc_object_t * p_this,
1337 int ( *pf_entry ) ( module_t * ) )
1339 module_t * p_module;
1341 /* Now that we have successfully loaded the module, we can
1342 * allocate a structure for it */
1343 p_module = vlc_module_create( p_this );
1344 if( p_module == NULL )
1346 msg_Err( p_this, "out of memory" );
1350 /* Initialize the module : fill p_module->psz_object_name, etc. */
1351 if( pf_entry( p_module ) != 0 )
1353 /* With a well-written module we shouldn't have to print an
1354 * additional error message here, but just make sure. */
1355 msg_Err( p_this, "failed calling entry point in builtin module" );
1356 vlc_object_release( p_module );
1360 /* Everything worked fine ! The module is ready to be added to the list. */
1361 p_module->b_builtin = true;
1363 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1364 p_module->psz_object_name, p_module->psz_longname ); */
1366 vlc_object_attach( p_module, vlc_global()->p_module_bank );
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_t * p_module, bool b_detach )
1381 vlc_object_detach( p_module );
1383 /* We free the structures that we strdup()ed in Allocate*Module(). */
1384 #ifdef HAVE_DYNAMIC_PLUGINS
1385 if( !p_module->b_builtin )
1387 if( p_module->b_loaded && p_module->b_unloadable )
1389 module_Unload( p_module->handle );
1391 UndupModule( p_module );
1392 free( p_module->psz_filename );
1396 /* Free and detach the object's children */
1397 while( vlc_internals( p_module )->i_children )
1399 vlc_object_t *p_this = vlc_internals( p_module )->pp_children[0];
1400 vlc_object_detach( p_this );
1401 vlc_object_release( p_this );
1404 config_Free( p_module );
1405 vlc_object_release( p_module );