modules: added a hack to work-around the buggy 64bit runtime on OS X Leopard
[vlc.git] / src / modules / modules.c
1 /*****************************************************************************
2  * modules.c : Builtin and plugin modules management functions
3  *****************************************************************************
4  * Copyright (C) 2001-2007 the VideoLAN team
5  * $Id$
6  *
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>
11  *
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.
16  *
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.
21  *
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  *****************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33 #include "libvlc.h"
34
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
39 #endif
40
41 #include <stdlib.h>                                      /* free(), strtol() */
42 #include <stdio.h>                                              /* sprintf() */
43 #include <string.h>                                              /* strdup() */
44 #include <assert.h>
45
46 #ifdef HAVE_DIRENT_H
47 #   include <dirent.h>
48 #endif
49
50 #ifdef HAVE_SYS_TYPES_H
51 #   include <sys/types.h>
52 #endif
53 #ifdef HAVE_SYS_STAT_H
54 #   include <sys/stat.h>
55 #endif
56 #ifdef HAVE_UNISTD_H
57 #   include <unistd.h>
58 #endif
59
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>
65 #   endif
66 #elif defined(HAVE_DL_BEOS)
67 #   if defined(HAVE_IMAGE_H)
68 #       include <image.h>
69 #   endif
70 #elif defined(HAVE_DL_WINDOWS)
71 #   include <windows.h>
72 #elif defined(HAVE_DL_DLOPEN)
73 #   if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
74 #       include <dlfcn.h>
75 #   endif
76 #   if defined(HAVE_SYS_DL_H)
77 #       include <sys/dl.h>
78 #   endif
79 #elif defined(HAVE_DL_SHL_LOAD)
80 #   if defined(HAVE_DL_H)
81 #       include <dl.h>
82 #   endif
83 #endif
84
85 #include "config/configuration.h"
86
87 #include "vlc_charset.h"
88 #include "vlc_arrays.h"
89
90 #include "modules/modules.h"
91
92 static module_bank_t *p_module_bank = NULL;
93 static vlc_mutex_t module_lock = VLC_STATIC_MUTEX;
94
95 int vlc_entry__main( module_t * );
96
97 /*****************************************************************************
98  * Local prototypes
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 *,
103                                unsigned );
104 static int  AllocatePluginFile( vlc_object_t *, module_bank_t *, const char *,
105                                 int64_t, int64_t );
106 static module_t * AllocatePlugin( vlc_object_t *, const char * );
107 #endif
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 * );
113 #endif
114
115 /**
116  * Init bank
117  *
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
121  * \return nothing
122  */
123 void __module_InitBank( vlc_object_t *p_this )
124 {
125     module_bank_t *p_bank = NULL;
126
127     vlc_mutex_lock( &module_lock );
128
129     if( p_module_bank == NULL )
130     {
131         p_bank = calloc (1, sizeof(*p_bank));
132         p_bank->i_usage = 1;
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;
136         p_bank->head = NULL;
137
138         /* Everything worked, attach the object */
139         p_module_bank = p_bank;
140
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 );
147     }
148     else
149         p_module_bank->i_usage++;
150
151     /* We do retain the module bank lock until the plugins are loaded as well.
152      * This is ugly, this staged loading approach is needed: LibVLC gets
153      * some configuration parameters relevant to loading the plugins from
154      * the main (builtin) module. The module bank becomes shared read-only data
155      * once it is ready, so we need to fully serialize initialization.
156      * DO NOT UNCOMMENT the following line unless you managed to squeeze
157      * module_LoadPlugins() before you unlock the mutex. */
158     /*vlc_mutex_unlock( &module_lock );*/
159 }
160
161 #undef module_EndBank
162 /**
163  * Unloads all unused plugin modules and empties the module
164  * bank in case of success.
165  * \param p_this vlc object structure
166  * \return nothing
167  */
168 void module_EndBank( vlc_object_t *p_this, bool b_plugins )
169 {
170     module_bank_t *p_bank = p_module_bank;
171
172     assert (p_bank != NULL);
173
174     /* Save the configuration */
175     if( !config_GetInt( p_this, "ignore-config" ) )
176         config_AutoSaveConfigFile( p_this );
177
178     /* If plugins were _not_ loaded, then the caller still has the bank lock
179      * from module_InitBank(). */
180     if( b_plugins )
181         vlc_mutex_lock( &module_lock );
182     /*else
183         vlc_assert_locked( &module_lock ); not for static mutexes :( */
184
185     if( --p_bank->i_usage > 0 )
186     {
187         vlc_mutex_unlock( &module_lock );
188         return;
189     }
190     p_module_bank = NULL;
191     vlc_mutex_unlock( &module_lock );
192
193 #ifdef HAVE_DYNAMIC_PLUGINS
194     if( p_bank->b_cache )
195         CacheSave( p_this, p_bank );
196     while( p_bank->i_loaded_cache-- )
197     {
198         if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
199         {
200             DeleteModule( p_bank,
201                     p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module );
202             free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
203             free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
204             p_bank->pp_loaded_cache[p_bank->i_loaded_cache] = NULL;
205         }
206     }
207     if( p_bank->pp_loaded_cache )
208     {
209         free( p_bank->pp_loaded_cache );
210         p_bank->pp_loaded_cache = NULL;
211     }
212     while( p_bank->i_cache-- )
213     {
214         free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
215         free( p_bank->pp_cache[p_bank->i_cache] );
216         p_bank->pp_cache[p_bank->i_cache] = NULL;
217     }
218     if( p_bank->pp_cache )
219     {
220         free( p_bank->pp_cache );
221         p_bank->pp_cache = NULL;
222     }
223 #endif
224
225     while( p_bank->head != NULL )
226         DeleteModule( p_bank, p_bank->head );
227
228     free( p_bank );
229 }
230
231 #undef module_LoadPlugins
232 /**
233  * Loads module descriptions for all available plugins.
234  * Fills the module bank structure with the plugin modules.
235  *
236  * \param p_this vlc object structure
237  * \return nothing
238  */
239 void module_LoadPlugins( vlc_object_t * p_this, bool b_cache_delete )
240 {
241     module_bank_t *p_bank = p_module_bank;
242
243     assert( p_bank );
244     /*vlc_assert_locked( &module_lock ); not for static mutexes :( */
245
246 #ifdef HAVE_DYNAMIC_PLUGINS
247     if( p_bank->i_usage == 1 )
248     {
249         msg_Dbg( p_this, "checking plugin modules" );
250         p_module_bank->b_cache = config_GetInt( p_this, "plugins-cache" ) > 0;
251
252         if( p_module_bank->b_cache || b_cache_delete )
253             CacheLoad( p_this, p_module_bank, b_cache_delete );
254         AllocateAllPlugins( p_this, p_module_bank );
255     }
256 #endif
257     p_module_bank->b_plugins = true;
258     vlc_mutex_unlock( &module_lock );
259 }
260
261 /**
262  * Checks whether a module implements a capability.
263  *
264  * \param m the module
265  * \param cap the capability to check
266  * \return TRUE if the module have the capability
267  */
268 bool module_provides( const module_t *m, const char *cap )
269 {
270     return !strcmp( m->psz_capability, cap );
271 }
272
273 /**
274  * Get the internal name of a module
275  *
276  * \param m the module
277  * \return the module name
278  */
279 const char *module_get_object( const module_t *m )
280 {
281     return m->psz_object_name;
282 }
283
284 /**
285  * Get the human-friendly name of a module.
286  *
287  * \param m the module
288  * \param long_name TRUE to have the long name of the module
289  * \return the short or long name of the module
290  */
291 const char *module_get_name( const module_t *m, bool long_name )
292 {
293     if( long_name && ( m->psz_longname != NULL) )
294         return m->psz_longname;
295
296     return m->psz_shortname ? m->psz_shortname : m->psz_object_name;
297 }
298
299 /**
300  * Get the help for a module
301  *
302  * \param m the module
303  * \return the help
304  */
305 const char *module_get_help( const module_t *m )
306 {
307     return m->psz_help;
308 }
309
310 /**
311  * Get the capability for a module
312  *
313  * \param m the module
314  * return the capability
315  */
316 const char *module_get_capability( const module_t *m )
317 {
318     return m->psz_capability;
319 }
320
321 /**
322  * Get the score for a module
323  *
324  * \param m the module
325  * return the score for the capability
326  */
327 int module_get_score( const module_t *m )
328 {
329     return m->i_score;
330 }
331
332 module_t *module_hold (module_t *m)
333 {
334     vlc_hold (&m->vlc_gc_data);
335     return m;
336 }
337
338 void module_release (module_t *m)
339 {
340     vlc_release (&m->vlc_gc_data);
341 }
342
343 /**
344  * Frees the flat list of VLC modules.
345  * @param list list obtained by module_list_get()
346  * @param length number of items on the list
347  * @return nothing.
348  */
349 void module_list_free (module_t **list)
350 {
351     if (list == NULL)
352         return;
353
354     for (size_t i = 0; list[i] != NULL; i++)
355          module_release (list[i]);
356     free (list);
357 }
358
359 /**
360  * Gets the flat list of VLC modules.
361  * @param n [OUT] pointer to the number of modules or NULL
362  * @return NULL-terminated table of module pointers
363  *         (release with module_list_free()), or NULL in case of error.
364  */
365 module_t **module_list_get (size_t *n)
366 {
367     /* TODO: this whole module lookup is quite inefficient */
368     /* Remove this and improve module_need */
369     module_t **tab = NULL;
370     size_t i = 0;
371
372     assert (p_module_bank);
373     for (module_t *mod = p_module_bank->head; mod; mod = mod->next)
374     {
375          module_t **nt;
376          nt  = realloc (tab, (i + 2 + mod->submodule_count) * sizeof (*tab));
377          if (nt == NULL)
378          {
379              module_list_free (tab);
380              return NULL;
381          }
382
383          tab = nt;
384          tab[i++] = module_hold (mod);
385          for (module_t *subm = mod->submodule; subm; subm = subm->next)
386              tab[i++] = module_hold (subm);
387          tab[i] = NULL;
388     }
389     if (n != NULL)
390         *n = i;
391     return tab;
392 }
393
394 typedef struct module_list_t
395 {
396     module_t *p_module;
397     int16_t  i_score;
398     bool     b_force;
399 } module_list_t;
400
401 static int modulecmp (const void *a, const void *b)
402 {
403     const module_list_t *la = a, *lb = b;
404     /* Note that qsort() uses _ascending_ order,
405      * so the smallest module is the one with the biggest score. */
406     return lb->i_score - la->i_score;
407 }
408
409 /**
410  * module Need
411  *
412  * Return the best module function, given a capability list.
413  *
414  * If the p_this object doesn't have it's psz_object_name set, then
415  * psz_object_name will be set to the module's name, unless the user
416  * provided an alias using the "module name@alias" syntax in which case
417  * psz_object_name will be set to the alias.
418  *
419  * \param p_this the vlc object
420  * \param psz_capability list of capabilities needed
421  * \param psz_name name of the module asked
422  * \param b_strict TRUE yto use the strict mode
423  * \return the module or NULL in case of a failure
424  */
425 module_t * __module_need( vlc_object_t *p_this, const char *psz_capability,
426                           const char *psz_name, bool b_strict )
427 {
428     stats_TimerStart( p_this, "module_need()", STATS_TIMER_MODULE_NEED );
429
430     module_list_t *p_list;
431     module_t *p_module;
432     int i_shortcuts = 0;
433     char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
434     bool b_force_backup = p_this->b_force;
435
436     /* Deal with variables */
437     if( psz_name && psz_name[0] == '$' )
438     {
439         psz_name = psz_var = var_CreateGetString( p_this, psz_name + 1 );
440     }
441
442     /* Count how many different shortcuts were asked for */
443     if( psz_name && *psz_name )
444     {
445         char *psz_parser, *psz_last_shortcut;
446
447         /* If the user wants none, give him none. */
448         if( !strcmp( psz_name, "none" ) )
449         {
450             free( psz_var );
451             stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
452             stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
453             stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
454             return NULL;
455         }
456
457         i_shortcuts++;
458         psz_shortcuts = psz_last_shortcut = strdup( psz_name );
459
460         for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
461         {
462             if( *psz_parser == ',' )
463             {
464                  *psz_parser = '\0';
465                  i_shortcuts++;
466                  psz_last_shortcut = psz_parser + 1;
467             }
468         }
469
470         /* Check if the user wants to override the "strict" mode */
471         if( psz_last_shortcut )
472         {
473             if( !strcmp(psz_last_shortcut, "none") )
474             {
475                 b_strict = true;
476                 i_shortcuts--;
477             }
478             else if( !strcmp(psz_last_shortcut, "any") )
479             {
480                 b_strict = false;
481                 i_shortcuts--;
482             }
483         }
484     }
485
486     /* Sort the modules and test them */
487     size_t count;
488     module_t **p_all = module_list_get (&count);
489     p_list = malloc( count * sizeof( module_list_t ) );
490     unsigned i_cpu = vlc_CPU();
491
492     /* Parse the module list for capabilities and probe each of them */
493     count = 0;
494     for (size_t i = 0; (p_module = p_all[i]) != NULL; i++)
495     {
496         bool b_shortcut_bonus = false;
497
498         /* Test that this module can do what we need */
499         if( !module_provides( p_module, psz_capability ) )
500             continue;
501         /* Test if we have the required CPU */
502         if( (p_module->i_cpu & i_cpu) != p_module->i_cpu )
503             continue;
504
505         /* If we required a shortcut, check this plugin provides it. */
506         if( i_shortcuts > 0 )
507         {
508             const char *psz_name = psz_shortcuts;
509
510             for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
511             {
512                 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
513                 {
514                     char *c;
515                     if( ( c = strchr( psz_name, '@' ) )
516                         ? !strncasecmp( psz_name, p_module->pp_shortcuts[i],
517                                         c-psz_name )
518                         : !strcasecmp( psz_name, p_module->pp_shortcuts[i] ) )
519                     {
520                         /* Found it */
521                         if( c && c[1] )
522                             psz_alias = c+1;
523                         b_shortcut_bonus = true;
524                         goto found_shortcut;
525                     }
526                 }
527
528                 /* Go to the next shortcut... This is so lame! */
529                 psz_name += strlen( psz_name ) + 1;
530             }
531
532             /* If we are in "strict" mode and we couldn't
533              * find the module in the list of provided shortcuts,
534              * then kick the bastard out of here!!! */
535             if( b_strict )
536                 continue;
537         }
538
539         /* Trash <= 0 scored plugins (they can only be selected by shortcut) */
540         if( p_module->i_score <= 0 )
541             continue;
542
543 found_shortcut:
544         /* Store this new module */
545         p_list[count].p_module = module_hold (p_module);
546         p_list[count].i_score = p_module->i_score;
547         if( b_shortcut_bonus )
548             p_list[count].i_score += 10000;
549         p_list[count].b_force = b_shortcut_bonus && b_strict;
550         count++;
551     }
552
553     /* We can release the list, interesting modules are held */
554     module_list_free (p_all);
555
556     /* Sort candidates by descending score */
557     qsort (p_list, count, sizeof (p_list[0]), modulecmp);
558     msg_Dbg( p_this, "looking for %s module: %zu candidate%s", psz_capability,
559              count, count == 1 ? "" : "s" );
560
561     /* Parse the linked list and use the first successful module */
562     p_module = NULL;
563     for (size_t i = 0; (i < count) && (p_module == NULL); i++)
564     {
565         module_t *p_cand = p_list[i].p_module;
566 #ifdef HAVE_DYNAMIC_PLUGINS
567         /* Make sure the module is loaded in mem */
568         module_t *p_real = p_cand->b_submodule ? p_cand->parent : p_cand;
569
570         if( !p_real->b_builtin && !p_real->b_loaded )
571         {
572             module_t *p_new_module =
573                 AllocatePlugin( p_this, p_real->psz_filename );
574             if( p_new_module )
575             {
576                 CacheMerge( p_this, p_real, p_new_module );
577                 DeleteModule( p_module_bank, p_new_module );
578             }
579         }
580 #endif
581
582         p_this->b_force = p_list[i].b_force;
583         if( p_cand->pf_activate
584          && p_cand->pf_activate( p_this ) == VLC_SUCCESS )
585         {
586             p_module = p_cand;
587             /* Release the remaining modules */
588             while (++i < count)
589                 module_release (p_list[i].p_module);
590         }
591         else
592             module_release( p_cand );
593     }
594
595     free( p_list );
596     p_this->b_force = b_force_backup;
597
598     if( p_module != NULL )
599     {
600         msg_Dbg( p_this, "using %s module \"%s\"",
601                  psz_capability, p_module->psz_object_name );
602         if( !p_this->psz_object_name )
603         {
604             /* This assumes that p_this is the object which will be using the
605              * module. That's not always the case ... but it is in most cases.
606              */
607             if( psz_alias )
608                 p_this->psz_object_name = strdup( psz_alias );
609             else
610                 p_this->psz_object_name = strdup( p_module->psz_object_name );
611         }
612     }
613     else if( count == 0 )
614     {
615         if( !strcmp( psz_capability, "access_demux" )
616          || !strcmp( psz_capability, "stream_filter" )
617          || !strcmp( psz_capability, "vout_window" ) )
618         {
619             msg_Dbg( p_this, "no %s module matched \"%s\"",
620                 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
621         }
622         else
623         {
624             msg_Err( p_this, "no %s module matched \"%s\"",
625                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
626
627             msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
628                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
629         }
630     }
631     else if( psz_name != NULL && *psz_name )
632     {
633         msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
634                   psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
635     }
636     else
637         msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
638
639     free( psz_shortcuts );
640     free( psz_var );
641
642     stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
643     stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
644     stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
645
646     /* Don't forget that the module is still locked */
647     return p_module;
648 }
649
650 /**
651  * Module unneed
652  *
653  * This function must be called by the thread that called module_need, to
654  * decrease the reference count and allow for hiding of modules.
655  * \param p_this vlc object structure
656  * \param p_module the module structure
657  * \return nothing
658  */
659 void __module_unneed( vlc_object_t * p_this, module_t * p_module )
660 {
661     /* Use the close method */
662     if( p_module->pf_deactivate )
663     {
664         p_module->pf_deactivate( p_this );
665     }
666
667     msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
668
669     module_release( p_module );
670 }
671
672 /**
673  * Get a pointer to a module_t given it's name.
674  *
675  * \param psz_name the name of the module
676  * \return a pointer to the module or NULL in case of a failure
677  */
678 module_t *module_find( const char * psz_name )
679 {
680     module_t **list, *module;
681
682     list = module_list_get (NULL);
683     if (!list)
684         return NULL;
685
686     for (size_t i = 0; (module = list[i]) != NULL; i++)
687     {
688         const char *psz_module_name = module->psz_object_name;
689
690         if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
691         {
692             module_hold (module);
693             break;
694         }
695     }
696     module_list_free (list);
697     return module;
698 }
699
700 /**
701  * Tell if a module exists and release it in thic case
702  *
703  * \param psz_name th name of the module
704  * \return TRUE if the module exists
705  */
706 bool module_exists (const char * psz_name)
707 {
708     module_t *p_module = module_find (psz_name);
709     if( p_module )
710         module_release (p_module);
711     return p_module != NULL;
712 }
713
714 /**
715  * Get a pointer to a module_t that matches a shortcut.
716  * This is a temporary hack for SD. Do not re-use (generally multiple modules
717  * can have the same shortcut, so this is *broken* - use module_need()!).
718  *
719  * \param psz_shortcut shortcut of the module
720  * \param psz_cap capability of the module
721  * \return a pointer to the module or NULL in case of a failure
722  */
723 module_t *module_find_by_shortcut (const char *psz_shortcut)
724 {
725     module_t **list, *module;
726
727     list = module_list_get (NULL);
728     if (!list)
729         return NULL;
730
731     for (size_t i = 0; (module = list[i]) != NULL; i++)
732     {
733         for (size_t j = 0;
734              (module->pp_shortcuts[j] != NULL) && (j < MODULE_SHORTCUT_MAX);
735              j++)
736         {
737             if (!strcmp (module->pp_shortcuts[j], psz_shortcut))
738             {
739                 module_hold (module);
740                 goto out;
741              }
742         }
743     }
744 out:
745     module_list_free (list);
746     return module;
747 }
748
749 /**
750  * GetModuleNamesForCapability
751  *
752  * Return a NULL terminated array with the names of the modules
753  * that have a certain capability.
754  * Free after uses both the string and the table.
755  * \param psz_capability the capability asked
756  * \param pppsz_longname an pointer to an array of string to contain
757     the long names of the modules. If set to NULL the function don't use it.
758  * \return the NULL terminated array
759  */
760 char ** module_GetModulesNamesForCapability( const char *psz_capability,
761                                              char ***pppsz_longname )
762 {
763     size_t count = 0;
764     char **psz_ret;
765
766     module_t **list = module_list_get (NULL);
767
768     /* Proceed in two passes: count the number of modules first */
769     for (size_t i = 0; list[i]; i++)
770     {
771         module_t *p_module = list[i];
772         const char *psz_module_capability = p_module->psz_capability;
773
774         if( psz_module_capability
775          && !strcmp( psz_module_capability, psz_capability ) )
776             count++;
777     }
778
779     /* Then get the names */
780     psz_ret = malloc( sizeof(char*) * (count+1) );
781     if( pppsz_longname )
782         *pppsz_longname = malloc( sizeof(char*) * (count+1) );
783     if( !psz_ret || ( pppsz_longname && *pppsz_longname == NULL ) )
784     {
785         free( psz_ret );
786         if( pppsz_longname )
787         {
788             free( *pppsz_longname );
789             *pppsz_longname = NULL;
790         }
791         module_list_free (list);
792         return NULL;
793     }
794
795     for (size_t i = 0, j = 0; list[i]; i++)
796     {
797         module_t *p_module = list[i];
798         const char *psz_module_capability = p_module->psz_capability;
799
800         if( psz_module_capability
801          && !strcmp( psz_module_capability, psz_capability ) )
802         {
803             /* Explicit hack: Use the last shortcut. It _should_ be
804              * different from the object name, at least if the object
805              * contains multiple submodules with the same capability. */
806             unsigned k = 0;
807             while( p_module->pp_shortcuts[k] != NULL )
808                 k++;
809             assert( k > 0); /* pp_shortcuts[0] is always set */
810             psz_ret[j] = strdup( p_module->pp_shortcuts[k - 1] );
811             if( pppsz_longname )
812                 (*pppsz_longname)[j] = strdup( module_get_name( p_module, true ) );
813             j++;
814         }
815     }
816     psz_ret[count] = NULL;
817
818     module_list_free (list);
819
820     return psz_ret;
821 }
822
823 /**
824  * Get the configuration of a module
825  *
826  * \param module the module
827  * \param psize the size of the configuration returned
828  * \return the configuration as an array
829  */
830 module_config_t *module_config_get( const module_t *module, unsigned *restrict psize )
831 {
832     unsigned i,j;
833     unsigned size = module->confsize;
834     module_config_t *config = malloc( size * sizeof( *config ) );
835
836     assert( psize != NULL );
837     *psize = 0;
838
839     if( !config )
840         return NULL;
841
842     for( i = 0, j = 0; i < size; i++ )
843     {
844         const module_config_t *item = module->p_config + i;
845         if( item->b_internal /* internal option */
846          || item->b_unsaveable /* non-modifiable option */
847          || item->b_removed /* removed option */ )
848             continue;
849
850         memcpy( config + j, item, sizeof( *config ) );
851         j++;
852     }
853     *psize = j;
854
855     return config;
856 }
857
858 /**
859  * Release the configuration
860  *
861  * \param the configuration
862  * \return nothing
863  */
864 void module_config_free( module_config_t *config )
865 {
866     free( config );
867 }
868
869 /*****************************************************************************
870  * Following functions are local.
871  *****************************************************************************/
872
873  /*****************************************************************************
874  * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
875  * return first path.
876  *****************************************************************************/
877 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
878 {
879     char * path;
880     int i, done;
881     bool escaped = false;
882
883     assert( paths );
884
885     /* Alloc a buffer to store the path */
886     path = malloc( strlen( paths ) + 1 );
887     if( !path ) return NULL;
888
889     /* Look for PATH_SEP_CHAR (a ':' or a ';') */
890     for( i = 0, done = 0 ; paths[i]; i++ )
891     {
892         /* Take care of \\ and \: or \; escapement */
893         if( escaped )
894         {
895             escaped = false;
896             path[done++] = paths[i];
897         }
898 #ifdef WIN32
899         else if( paths[i] == '/' )
900             escaped = true;
901 #else
902         else if( paths[i] == '\\' )
903             escaped = true;
904 #endif
905         else if( paths[i] == PATH_SEP_CHAR )
906             break;
907         else
908             path[done++] = paths[i];
909     }
910     path[done] = 0;
911
912     /* Return the remaining paths */
913     if( remaining_paths ) {
914         *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
915     }
916
917     return path;
918 }
919
920 char *psz_vlcpath = NULL;
921
922 /*****************************************************************************
923  * AllocateAllPlugins: load all plugin modules we can find.
924  *****************************************************************************/
925 #ifdef HAVE_DYNAMIC_PLUGINS
926 static void AllocateAllPlugins( vlc_object_t *p_this, module_bank_t *p_bank )
927 {
928     const char *vlcpath = psz_vlcpath;
929     int count,i;
930     char * path;
931     vlc_array_t *arraypaths = vlc_array_new();
932
933     /* Contruct the special search path for system that have a relocatable
934      * executable. Set it to <vlc path>/modules and <vlc path>/plugins. */
935
936     if( vlcpath && asprintf( &path, "%s" DIR_SEP "modules", vlcpath ) != -1 )
937         vlc_array_append( arraypaths, path );
938     if( vlcpath && asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
939         vlc_array_append( arraypaths, path );
940 #ifndef WIN32
941     vlc_array_append( arraypaths, strdup( PLUGIN_PATH ) );
942 #endif
943
944     /* If the user provided a plugin path, we add it to the list */
945     char *userpaths = config_GetPsz( p_this, "plugin-path" );
946     char *paths_iter;
947
948     for( paths_iter = userpaths; paths_iter; )
949     {
950         path = copy_next_paths_token( paths_iter, &paths_iter );
951         if( path )
952             vlc_array_append( arraypaths, path );
953     }
954
955     count = vlc_array_count( arraypaths );
956     for( i = 0 ; i < count ; i++ )
957     {
958         path = vlc_array_item_at_index( arraypaths, i );
959         if( !path )
960             continue;
961
962         msg_Dbg( p_this, "recursively browsing `%s'", path );
963
964         /* Don't go deeper than 5 subdirectories */
965         AllocatePluginDir( p_this, p_bank, path, 5 );
966
967         free( path );
968     }
969
970     vlc_array_destroy( arraypaths );
971     free( userpaths );
972 }
973
974 /*****************************************************************************
975  * AllocatePluginDir: recursively parse a directory to look for plugins
976  *****************************************************************************/
977 static void AllocatePluginDir( vlc_object_t *p_this, module_bank_t *p_bank,
978                                const char *psz_dir, unsigned i_maxdepth )
979 {
980 /* FIXME: Needs to be ported to wide char on ALL Windows builds */
981 #ifdef WIN32
982 # undef opendir
983 # undef closedir
984 # undef readdir
985 #endif
986 #if defined( UNDER_CE ) || defined( _MSC_VER )
987 #ifdef UNDER_CE
988     wchar_t psz_wpath[MAX_PATH + 256];
989     wchar_t psz_wdir[MAX_PATH];
990 #endif
991     char psz_path[MAX_PATH + 256];
992     WIN32_FIND_DATA finddata;
993     HANDLE handle;
994     int rc;
995 #else
996     int    i_dirlen;
997     DIR *  dir;
998     struct dirent * file;
999 #endif
1000     char * psz_file;
1001
1002     if( i_maxdepth == 0 )
1003         return;
1004
1005 #if defined( UNDER_CE ) || defined( _MSC_VER )
1006 #ifdef UNDER_CE
1007     MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
1008
1009     rc = GetFileAttributes( psz_wdir );
1010     if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
1011
1012     /* Parse all files in the directory */
1013     swprintf( psz_wpath, L"%ls\\*", psz_wdir );
1014 #else
1015     rc = GetFileAttributes( psz_dir );
1016     if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
1017 #endif
1018
1019     /* Parse all files in the directory */
1020     sprintf( psz_path, "%s\\*", psz_dir );
1021
1022 #ifdef UNDER_CE
1023     handle = FindFirstFile( psz_wpath, &finddata );
1024 #else
1025     handle = FindFirstFile( psz_path, &finddata );
1026 #endif
1027     if( handle == INVALID_HANDLE_VALUE )
1028     {
1029         /* Empty directory */
1030         return;
1031     }
1032
1033     /* Parse the directory and try to load all files it contains. */
1034     do
1035     {
1036 #ifdef UNDER_CE
1037         unsigned int i_len = wcslen( finddata.cFileName );
1038         swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
1039         sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
1040 #else
1041         unsigned int i_len = strlen( finddata.cFileName );
1042         sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
1043 #endif
1044
1045         /* Skip ".", ".." */
1046         if( !*finddata.cFileName || !strcmp( finddata.cFileName, "." )
1047          || !strcmp( finddata.cFileName, ".." ) )
1048         {
1049             if( !FindNextFile( handle, &finddata ) ) break;
1050             continue;
1051         }
1052
1053 #ifdef UNDER_CE
1054         if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
1055 #else
1056         if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
1057 #endif
1058         {
1059             AllocatePluginDir( p_this, p_bank, psz_path, i_maxdepth - 1 );
1060         }
1061         else if( i_len > strlen( LIBEXT )
1062                   /* We only load files ending with LIBEXT */
1063                   && !strncasecmp( psz_path + strlen( psz_path)
1064                                    - strlen( LIBEXT ),
1065                                    LIBEXT, strlen( LIBEXT ) ) )
1066         {
1067             WIN32_FILE_ATTRIBUTE_DATA attrbuf;
1068             int64_t i_time = 0, i_size = 0;
1069
1070 #ifdef UNDER_CE
1071             if( GetFileAttributesEx( psz_wpath, GetFileExInfoStandard,
1072                                      &attrbuf ) )
1073 #else
1074             if( GetFileAttributesEx( psz_path, GetFileExInfoStandard,
1075                                      &attrbuf ) )
1076 #endif
1077             {
1078                 i_time = attrbuf.ftLastWriteTime.dwHighDateTime;
1079                 i_time <<= 32;
1080                 i_time |= attrbuf.ftLastWriteTime.dwLowDateTime;
1081                 i_size = attrbuf.nFileSizeHigh;
1082                 i_size <<= 32;
1083                 i_size |= attrbuf.nFileSizeLow;
1084             }
1085             psz_file = psz_path;
1086
1087             AllocatePluginFile( p_this, p_bank, psz_file, i_time, i_size );
1088         }
1089     }
1090     while( !p_this->p_libvlc->b_die && FindNextFile( handle, &finddata ) );
1091
1092     /* Close the directory */
1093     FindClose( handle );
1094
1095 #else
1096     dir = opendir( psz_dir );
1097     if( !dir )
1098     {
1099         return;
1100     }
1101
1102     i_dirlen = strlen( psz_dir );
1103
1104     /* Parse the directory and try to load all files it contains. */
1105     while( !p_this->p_libvlc->b_die && ( file = readdir( dir ) ) )
1106     {
1107         struct stat statbuf;
1108         unsigned int i_len;
1109         int i_stat;
1110
1111         /* Skip ".", ".." */
1112         if( !*file->d_name || !strcmp( file->d_name, "." )
1113          || !strcmp( file->d_name, ".." ) )
1114         {
1115             continue;
1116         }
1117
1118         i_len = strlen( file->d_name );
1119         psz_file = malloc( i_dirlen + 1 + i_len + 1 );
1120         sprintf( psz_file, "%s"DIR_SEP"%s", psz_dir, file->d_name );
1121
1122         i_stat = stat( psz_file, &statbuf );
1123         if( !i_stat && statbuf.st_mode & S_IFDIR )
1124         {
1125             AllocatePluginDir( p_this, p_bank, psz_file, i_maxdepth - 1 );
1126         }
1127         else if( i_len > strlen( LIBEXT )
1128                   /* We only load files ending with LIBEXT */
1129                   && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
1130                                    LIBEXT, strlen( LIBEXT ) ) )
1131         {
1132             int64_t i_time = 0, i_size = 0;
1133
1134             if( !i_stat )
1135             {
1136                 i_time = statbuf.st_mtime;
1137                 i_size = statbuf.st_size;
1138             }
1139
1140             AllocatePluginFile( p_this, p_bank, psz_file, i_time, i_size );
1141         }
1142
1143         free( psz_file );
1144     }
1145
1146     /* Close the directory */
1147     closedir( dir );
1148
1149 #endif
1150 }
1151
1152 /*****************************************************************************
1153  * AllocatePluginFile: load a module into memory and initialize it.
1154  *****************************************************************************
1155  * This function loads a dynamically loadable module and allocates a structure
1156  * for its information data. The module can then be handled by module_need
1157  * and module_unneed. It can be removed by DeleteModule.
1158  *****************************************************************************/
1159 static int AllocatePluginFile( vlc_object_t * p_this, module_bank_t *p_bank,
1160                                const char *psz_file,
1161                                int64_t i_file_time, int64_t i_file_size )
1162 {
1163     module_t * p_module = NULL;
1164     module_cache_t *p_cache_entry = NULL;
1165
1166     /*
1167      * Check our plugins cache first then load plugin if needed
1168      */
1169     p_cache_entry = CacheFind( p_bank, psz_file, i_file_time, i_file_size );
1170     if( !p_cache_entry )
1171     {
1172         p_module = AllocatePlugin( p_this, psz_file );
1173     }
1174     else
1175     /* If junk dll, don't try to load it */
1176     if( p_cache_entry->b_junk )
1177         return -1;
1178     else
1179     {
1180         module_config_t *p_item = NULL, *p_end = NULL;
1181
1182         p_module = p_cache_entry->p_module;
1183         p_module->b_loaded = false;
1184
1185         /* For now we force loading if the module's config contains
1186          * callbacks or actions.
1187          * Could be optimized by adding an API call.*/
1188         for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
1189              p_item < p_end; p_item++ )
1190         {
1191             if( p_item->pf_callback || p_item->i_action )
1192             {
1193                 p_module = AllocatePlugin( p_this, psz_file );
1194                 break;
1195             }
1196         }
1197         if( p_module == p_cache_entry->p_module )
1198             p_cache_entry->b_used = true;
1199     }
1200
1201     if( p_module == NULL )
1202         return -1;
1203
1204     /* Everything worked fine !
1205      * The module is ready to be added to the list. */
1206     p_module->b_builtin = false;
1207
1208     /* msg_Dbg( p_this, "plugin \"%s\", %s",
1209                 p_module->psz_object_name, p_module->psz_longname ); */
1210     p_module->next = p_bank->head;
1211     p_bank->head = p_module;
1212
1213     if( !p_module_bank->b_cache )
1214         return 0;
1215
1216     /* Add entry to cache */
1217     module_cache_t **pp_cache = p_bank->pp_cache;
1218
1219     pp_cache = realloc( pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1220     if( pp_cache == NULL )
1221         return -1;
1222     pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1223     if( pp_cache[p_bank->i_cache] == NULL )
1224         return -1;
1225     pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1226     pp_cache[p_bank->i_cache]->i_time = i_file_time;
1227     pp_cache[p_bank->i_cache]->i_size = i_file_size;
1228     pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1229     pp_cache[p_bank->i_cache]->b_used = true;
1230     pp_cache[p_bank->i_cache]->p_module = p_module;
1231     p_bank->pp_cache = pp_cache;
1232     p_bank->i_cache++;
1233     return  0;
1234 }
1235
1236 /*****************************************************************************
1237  * AllocatePlugin: load a module into memory and initialize it.
1238  *****************************************************************************
1239  * This function loads a dynamically loadable module and allocates a structure
1240  * for its information data. The module can then be handled by module_need
1241  * and module_unneed. It can be removed by DeleteModule.
1242  *****************************************************************************/
1243 static module_t * AllocatePlugin( vlc_object_t * p_this, const char *psz_file )
1244 {
1245     module_t * p_module = NULL;
1246     module_handle_t handle;
1247
1248     if( module_Load( p_this, psz_file, &handle ) )
1249         return NULL;
1250
1251     /* Now that we have successfully loaded the module, we can
1252      * allocate a structure for it */
1253     p_module = vlc_module_create( p_this );
1254     if( p_module == NULL )
1255     {
1256         module_Unload( handle );
1257         return NULL;
1258     }
1259
1260     p_module->psz_filename = strdup( psz_file );
1261     p_module->handle = handle;
1262     p_module->b_loaded = true;
1263
1264     /* Initialize the module: fill p_module, default config */
1265     if( module_Call( p_this, p_module ) != 0 )
1266     {
1267         /* We couldn't call module_init() */
1268         free( p_module->psz_filename );
1269         module_release( p_module );
1270         module_Unload( handle );
1271         return NULL;
1272     }
1273
1274     DupModule( p_module );
1275
1276     /* Everything worked fine ! The module is ready to be added to the list. */
1277     p_module->b_builtin = false;
1278
1279     return p_module;
1280 }
1281
1282 /*****************************************************************************
1283  * DupModule: make a plugin module standalone.
1284  *****************************************************************************
1285  * This function duplicates all strings in the module, so that the dynamic
1286  * object can be unloaded. It acts recursively on submodules.
1287  *****************************************************************************/
1288 static void DupModule( module_t *p_module )
1289 {
1290     char **pp_shortcut;
1291
1292     for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1293     {
1294         *pp_shortcut = strdup( *pp_shortcut );
1295     }
1296
1297     /* We strdup() these entries so that they are still valid when the
1298      * module is unloaded. */
1299     p_module->psz_capability = strdup( p_module->psz_capability );
1300     p_module->psz_shortname = p_module->psz_shortname ?
1301                                  strdup( p_module->psz_shortname ) : NULL;
1302     p_module->psz_longname = strdup( p_module->psz_longname );
1303     p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1304                                             : NULL;
1305
1306     for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1307         DupModule (subm);
1308 }
1309
1310 /*****************************************************************************
1311  * UndupModule: free a duplicated module.
1312  *****************************************************************************
1313  * This function frees the allocations done in DupModule().
1314  *****************************************************************************/
1315 static void UndupModule( module_t *p_module )
1316 {
1317     char **pp_shortcut;
1318
1319     for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1320         UndupModule (subm);
1321
1322     for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1323     {
1324         free( *pp_shortcut );
1325     }
1326
1327     free( p_module->psz_capability );
1328     FREENULL( p_module->psz_shortname );
1329     free( p_module->psz_longname );
1330     FREENULL( p_module->psz_help );
1331 }
1332
1333 #endif /* HAVE_DYNAMIC_PLUGINS */
1334
1335 /*****************************************************************************
1336  * AllocateBuiltinModule: initialize a builtin module.
1337  *****************************************************************************
1338  * This function registers a builtin module and allocates a structure
1339  * for its information data. The module can then be handled by module_need
1340  * and module_unneed. It can be removed by DeleteModule.
1341  *****************************************************************************/
1342 static int AllocateBuiltinModule( vlc_object_t * p_this,
1343                                   int ( *pf_entry ) ( module_t * ) )
1344 {
1345     module_t * p_module;
1346
1347     /* Now that we have successfully loaded the module, we can
1348      * allocate a structure for it */
1349     p_module = vlc_module_create( p_this );
1350     if( p_module == NULL )
1351         return -1;
1352
1353     /* Initialize the module : fill p_module->psz_object_name, etc. */
1354     if( pf_entry( p_module ) != 0 )
1355     {
1356         /* With a well-written module we shouldn't have to print an
1357          * additional error message here, but just make sure. */
1358         msg_Err( p_this, "failed calling entry point in builtin module" );
1359         module_release( p_module );
1360         return -1;
1361     }
1362
1363     /* Everything worked fine ! The module is ready to be added to the list. */
1364     p_module->b_builtin = true;
1365     /* LOCK */
1366     p_module->next = p_module_bank->head;
1367     p_module_bank->head = p_module;
1368     /* UNLOCK */
1369
1370     /* msg_Dbg( p_this, "builtin \"%s\", %s",
1371                 p_module->psz_object_name, p_module->psz_longname ); */
1372
1373     return 0;
1374 }
1375
1376 /*****************************************************************************
1377  * DeleteModule: delete a module and its structure.
1378  *****************************************************************************
1379  * This function can only be called if the module isn't being used.
1380  *****************************************************************************/
1381 static void DeleteModule( module_bank_t *p_bank, module_t * p_module )
1382 {
1383     assert( p_module );
1384
1385     /* Unlist the module (if it is in the list) */
1386     module_t **pp_self = &p_bank->head;
1387     while (*pp_self != NULL && *pp_self != p_module)
1388         pp_self = &((*pp_self)->next);
1389     if (*pp_self)
1390         *pp_self = p_module->next;
1391
1392     /* We free the structures that we strdup()ed in Allocate*Module(). */
1393 #ifdef HAVE_DYNAMIC_PLUGINS
1394     if( !p_module->b_builtin )
1395     {
1396         if( p_module->b_loaded && p_module->b_unloadable )
1397         {
1398             #if defined( __APPLE__ ) && defined ( __x86_64__ )
1399                 if( strcmp( p_module->psz_object_name, "macosx" ) )
1400             #endif
1401                 module_Unload( p_module->handle );
1402         }
1403         UndupModule( p_module );
1404         free( p_module->psz_filename );
1405     }
1406 #endif
1407
1408     /* Free and detach the object's children */
1409     while (p_module->submodule)
1410     {
1411         module_t *submodule = p_module->submodule;
1412         p_module->submodule = submodule->next;
1413         module_release (submodule);
1414     }
1415
1416     config_Free( p_module );
1417     module_release( p_module );
1418 }