git.sesse.net Git - vlc/blob - src/misc/modules.c

   1 /*****************************************************************************
   2  * modules.c : Builtin and plugin modules management functions
   3  *****************************************************************************
   4  * Copyright (C) 2001-2004 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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  25  *****************************************************************************/
  26
  27 /* Some faulty libcs have a broken struct dirent when _FILE_OFFSET_BITS
  28  * is set to 64. Don't try to be cleverer. */
  29 #ifdef _FILE_OFFSET_BITS
  30 #undef _FILE_OFFSET_BITS
  31 #endif
  32
  33 #include <stdlib.h>                                      /* free(), strtol() */
  34 #include <stdio.h>                                              /* sprintf() */
  35 #include <string.h>                                              /* strdup() */
  36
  37 #include <vlc/vlc.h>
  38 #include <vlc/input.h>
  39
  40 #ifdef HAVE_DIRENT_H
  41 #   include <dirent.h>
  42 #endif
  43
  44 #ifdef HAVE_SYS_TYPES_H
  45 #   include <sys/types.h>
  46 #endif
  47 #ifdef HAVE_SYS_STAT_H
  48 #   include <sys/stat.h>
  49 #endif
  50 #ifdef HAVE_UNISTD_H
  51 #   include <unistd.h>
  52 #endif
  53
  54 #if !defined(HAVE_DYNAMIC_PLUGINS)
  55     /* no support for plugins */
  56 #elif defined(HAVE_DL_DYLD)
  57 #   if defined(HAVE_MACH_O_DYLD_H)
  58 #       include <mach-o/dyld.h>
  59 #   endif
  60 #elif defined(HAVE_DL_BEOS)
  61 #   if defined(HAVE_IMAGE_H)
  62 #       include <image.h>
  63 #   endif
  64 #elif defined(HAVE_DL_WINDOWS)
  65 #   include <windows.h>
  66 #elif defined(HAVE_DL_DLOPEN)
  67 #   if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
  68 #       include <dlfcn.h>
  69 #   endif
  70 #   if defined(HAVE_SYS_DL_H)
  71 #       include <sys/dl.h>
  72 #   endif
  73 #elif defined(HAVE_DL_SHL_LOAD)
  74 #   if defined(HAVE_DL_H)
  75 #       include <dl.h>
  76 #   endif
  77 #endif
  78
  79 #include "vlc_error.h"
  80
  81 #include "vlc_interface.h"
  82 #include "intf_eject.h"
  83
  84 #include "vlc_playlist.h"
  85
  86 #include "vlc_video.h"
  87 #include "video_output.h"
  88 #include "vout_synchro.h"
  89 #include "vlc_spu.h"
  90
  91 #include "audio_output.h"
  92 #include "aout_internal.h"
  93
  94 #include "stream_output.h"
  95 #include "vlc_httpd.h"
  96 #include "vlc_acl.h"
  97 #include "vlc_tls.h"
  98 #include "vlc_md5.h"
  99 #include "vlc_xml.h"
 100
 101 #include "iso_lang.h"
 102 #include "charset.h"
 103
 104 #include "vlc_block.h"
 105
 106 #include "vlc_vlm.h"
 107
 108 #include "vlc_image.h"
 109 #include "vlc_osd.h"
 110
 111 #if defined( _MSC_VER ) && defined( UNDER_CE )
 112 #    include "modules_builtin_evc.h"
 113 #elif defined( _MSC_VER )
 114 #    include "modules_builtin_msvc.h"
 115 #else
 116 #    include "modules_builtin.h"
 117 #endif
 118 #include "network.h"
 119
 120 #if defined( WIN32 ) || defined( UNDER_CE )
 121     /* Avoid name collisions */
 122 #   define LoadModule(a,b,c) LoadVlcModule(a,b,c)
 123 #endif
 124
 125 /*****************************************************************************
 126  * Local prototypes
 127  *****************************************************************************/
 128 #ifdef HAVE_DYNAMIC_PLUGINS
 129 static void AllocateAllPlugins  ( vlc_object_t * );
 130 static void AllocatePluginDir   ( vlc_object_t *, const char *, int );
 131 static int  AllocatePluginFile  ( vlc_object_t *, char *, int64_t, int64_t );
 132 static module_t * AllocatePlugin( vlc_object_t *, char * );
 133 #endif
 134 static int  AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
 135 static int  DeleteModule ( module_t * );
 136 #ifdef HAVE_DYNAMIC_PLUGINS
 137 static void   DupModule        ( module_t * );
 138 static void   UndupModule      ( module_t * );
 139 static int    CallEntry        ( module_t * );
 140 static int    LoadModule       ( vlc_object_t *, char *, module_handle_t * );
 141 static void   CloseModule      ( module_handle_t );
 142 static void * GetSymbol        ( module_handle_t, const char * );
 143 static void   CacheLoad        ( vlc_object_t * );
 144 static int    CacheLoadConfig  ( module_t *, FILE * );
 145 static void   CacheSave        ( vlc_object_t * );
 146 static void   CacheSaveConfig  ( module_t *, FILE * );
 147 static char * CacheName        ( void );
 148 static void   CacheMerge       ( vlc_object_t *, module_t *, module_t * );
 149 static module_cache_t * CacheFind( vlc_object_t *, char *, int64_t, int64_t );
 150
 151 #if defined(HAVE_DL_WINDOWS)
 152 static char * GetWindowsError  ( void );
 153 #endif
 154 #endif
 155
 156
 157 /* Sub-version number
 158  * (only used to avoid breakage in dev version when cache structure changes) */
 159 #define CACHE_SUBVERSION_NUM 1
 160
 161 /*****************************************************************************
 162  * module_InitBank: create the module bank.
 163  *****************************************************************************
 164  * This function creates a module bank structure which will be filled later
 165  * on with all the modules found.
 166  *****************************************************************************/
 167 void __module_InitBank( vlc_object_t *p_this )
 168 {
 169     module_bank_t *p_bank;
 170     vlc_value_t  lockval;
 171
 172     var_Create( p_this->p_libvlc, "libvlc", VLC_VAR_MUTEX );
 173     var_Get( p_this->p_libvlc, "libvlc", &lockval );
 174     vlc_mutex_lock( lockval.p_address );
 175     if( p_this->p_libvlc->p_module_bank )
 176     {
 177         p_this->p_libvlc->p_module_bank->i_usage++;
 178         vlc_mutex_unlock( lockval.p_address );
 179         var_Destroy( p_this->p_libvlc, "libvlc" );
 180         return;
 181     }
 182     vlc_mutex_unlock( lockval.p_address );
 183     var_Destroy( p_this->p_libvlc, "libvlc" );
 184
 185     p_bank = vlc_object_create( p_this, sizeof(module_bank_t) );
 186     p_bank->psz_object_name = "module bank";
 187     p_bank->i_usage = 1;
 188     p_bank->i_cache = p_bank->i_loaded_cache = 0;
 189     p_bank->pp_cache = p_bank->pp_loaded_cache = 0;
 190     p_bank->b_cache = p_bank->b_cache_dirty =
 191         p_bank->b_cache_delete = VLC_FALSE;
 192
 193     /*
 194      * Store the symbols to be exported
 195      */
 196 #if defined (HAVE_DYNAMIC_PLUGINS) && !defined (HAVE_SHARED_LIBVLC)
 197     STORE_SYMBOLS( &p_bank->symbols );
 198 #endif
 199
 200     /* Everything worked, attach the object */
 201     p_this->p_libvlc->p_module_bank = p_bank;
 202     vlc_object_attach( p_bank, p_this->p_libvlc );
 203
 204     module_LoadMain( p_this );
 205
 206     return;
 207 }
 208
 209 /*****************************************************************************
 210  * module_ResetBank: reset the module bank.
 211  *****************************************************************************
 212  * This function resets the module bank by unloading all unused plugin
 213  * modules.
 214  *****************************************************************************/
 215 void __module_ResetBank( vlc_object_t *p_this )
 216 {
 217     msg_Err( p_this, "FIXME: module_ResetBank unimplemented" );
 218     return;
 219 }
 220
 221 /*****************************************************************************
 222  * module_EndBank: empty the module bank.
 223  *****************************************************************************
 224  * This function unloads all unused plugin modules and empties the module
 225  * bank in case of success.
 226  *****************************************************************************/
 227 void __module_EndBank( vlc_object_t *p_this )
 228 {
 229     module_t * p_next;
 230     vlc_value_t lockval;
 231
 232     var_Create( p_this->p_libvlc, "libvlc", VLC_VAR_MUTEX );
 233     var_Get( p_this->p_libvlc, "libvlc", &lockval );
 234     vlc_mutex_lock( lockval.p_address );
 235     if( !p_this->p_libvlc->p_module_bank )
 236     {
 237         vlc_mutex_unlock( lockval.p_address );
 238         var_Destroy( p_this->p_libvlc, "libvlc" );
 239         return;
 240     }
 241     if( --p_this->p_libvlc->p_module_bank->i_usage )
 242     {
 243         vlc_mutex_unlock( lockval.p_address );
 244         var_Destroy( p_this->p_libvlc, "libvlc" );
 245         return;
 246     }
 247     vlc_mutex_unlock( lockval.p_address );
 248     var_Destroy( p_this->p_libvlc, "libvlc" );
 249
 250     config_AutoSaveConfigFile( p_this );
 251
 252 #ifdef HAVE_DYNAMIC_PLUGINS
 253 #define p_bank p_this->p_libvlc->p_module_bank
 254     if( p_bank->b_cache ) CacheSave( p_this );
 255     while( p_bank->i_loaded_cache-- )
 256     {
 257         free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
 258         free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
 259     }
 260     if( p_bank->pp_loaded_cache )
 261         free( p_bank->pp_loaded_cache );
 262
 263     while( p_bank->i_cache-- )
 264     {
 265         free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
 266         free( p_bank->pp_cache[p_bank->i_cache] );
 267     }
 268     if( p_bank->pp_cache )
 269         free( p_bank->pp_cache );
 270 #undef p_bank
 271 #endif
 272
 273     vlc_object_detach( p_this->p_libvlc->p_module_bank );
 274
 275     while( p_this->p_libvlc->p_module_bank->i_children )
 276     {
 277         p_next = (module_t *)p_this->p_libvlc->p_module_bank->pp_children[0];
 278
 279         if( DeleteModule( p_next ) )
 280         {
 281             /* Module deletion failed */
 282             msg_Err( p_this, "module \"%s\" can't be removed, trying harder",
 283                      p_next->psz_object_name );
 284
 285             /* We just free the module by hand. Niahahahahaha. */
 286             vlc_object_detach( p_next );
 287             vlc_object_destroy( p_next );
 288         }
 289     }
 290
 291     vlc_object_destroy( p_this->p_libvlc->p_module_bank );
 292     p_this->p_libvlc->p_module_bank = NULL;
 293
 294     return;
 295 }
 296
 297 /*****************************************************************************
 298  * module_LoadMain: load the main program info into the module bank.
 299  *****************************************************************************
 300  * This function fills the module bank structure with the main module infos.
 301  * This is very useful as it will allow us to consider the main program just
 302  * as another module, and for instance the configuration options of main will
 303  * be available in the module bank structure just as for every other module.
 304  *****************************************************************************/
 305 void __module_LoadMain( vlc_object_t *p_this )
 306 {
 307     vlc_value_t lockval;
 308
 309     var_Create( p_this->p_libvlc, "libvlc", VLC_VAR_MUTEX );
 310     var_Get( p_this->p_libvlc, "libvlc", &lockval );
 311     vlc_mutex_lock( lockval.p_address );
 312     if( p_this->p_libvlc->p_module_bank->b_main )
 313     {
 314         vlc_mutex_unlock( lockval.p_address );
 315         var_Destroy( p_this->p_libvlc, "libvlc" );
 316         return;
 317     }
 318     p_this->p_libvlc->p_module_bank->b_main = VLC_TRUE;
 319     vlc_mutex_unlock( lockval.p_address );
 320     var_Destroy( p_this->p_libvlc, "libvlc" );
 321
 322     AllocateBuiltinModule( p_this, vlc_entry__main );
 323 }
 324
 325 /*****************************************************************************
 326  * module_LoadBuiltins: load all modules which we built with.
 327  *****************************************************************************
 328  * This function fills the module bank structure with the builtin modules.
 329  *****************************************************************************/
 330 void __module_LoadBuiltins( vlc_object_t * p_this )
 331 {
 332     vlc_value_t lockval;
 333
 334     var_Create( p_this->p_libvlc, "libvlc", VLC_VAR_MUTEX );
 335     var_Get( p_this->p_libvlc, "libvlc", &lockval );
 336     vlc_mutex_lock( lockval.p_address );
 337     if( p_this->p_libvlc->p_module_bank->b_builtins )
 338     {
 339         vlc_mutex_unlock( lockval.p_address );
 340         var_Destroy( p_this->p_libvlc, "libvlc" );
 341         return;
 342     }
 343     p_this->p_libvlc->p_module_bank->b_builtins = VLC_TRUE;
 344     vlc_mutex_unlock( lockval.p_address );
 345     var_Destroy( p_this->p_libvlc, "libvlc" );
 346
 347     msg_Dbg( p_this, "checking builtin modules" );
 348     ALLOCATE_ALL_BUILTINS();
 349 }
 350
 351 /*****************************************************************************
 352  * module_LoadPlugins: load all plugin modules we can find.
 353  *****************************************************************************
 354  * This function fills the module bank structure with the plugin modules.
 355  *****************************************************************************/
 356 void __module_LoadPlugins( vlc_object_t * p_this )
 357 {
 358 #ifdef HAVE_DYNAMIC_PLUGINS
 359     vlc_value_t lockval;
 360
 361     var_Create( p_this->p_libvlc, "libvlc", VLC_VAR_MUTEX );
 362     var_Get( p_this->p_libvlc, "libvlc", &lockval );
 363     vlc_mutex_lock( lockval.p_address );
 364     if( p_this->p_libvlc->p_module_bank->b_plugins )
 365     {
 366         vlc_mutex_unlock( lockval.p_address );
 367         var_Destroy( p_this->p_libvlc, "libvlc" );
 368         return;
 369     }
 370     p_this->p_libvlc->p_module_bank->b_plugins = VLC_TRUE;
 371     vlc_mutex_unlock( lockval.p_address );
 372     var_Destroy( p_this->p_libvlc, "libvlc" );
 373
 374     msg_Dbg( p_this, "checking plugin modules" );
 375
 376     if( config_GetInt( p_this, "plugins-cache" ) )
 377         p_this->p_libvlc->p_module_bank->b_cache = VLC_TRUE;
 378
 379     if( p_this->p_libvlc->p_module_bank->b_cache ||
 380         p_this->p_libvlc->p_module_bank->b_cache_delete ) CacheLoad( p_this );
 381
 382     AllocateAllPlugins( p_this );
 383 #endif
 384 }
 385
 386 /*****************************************************************************
 387  * module_Need: return the best module function, given a capability list.
 388  *****************************************************************************
 389  * This function returns the module that best fits the asked capabilities.
 390  *****************************************************************************/
 391 module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
 392                           const char *psz_name, vlc_bool_t b_strict )
 393 {
 394     typedef struct module_list_t module_list_t;
 395
 396     struct module_list_t
 397     {
 398         module_t *p_module;
 399         int i_score;
 400         vlc_bool_t b_force;
 401         module_list_t *p_next;
 402     };
 403
 404     module_list_t *p_list, *p_first, *p_tmp;
 405     vlc_list_t *p_all;
 406
 407     int i_which_module, i_index = 0;
 408     vlc_bool_t b_intf = VLC_FALSE;
 409
 410     module_t *p_module;
 411
 412     int   i_shortcuts = 0;
 413     char *psz_shortcuts = NULL, *psz_var = NULL;
 414     vlc_bool_t b_force_backup = p_this->b_force;
 415
 416
 417     /* Deal with variables */
 418     if( psz_name && psz_name[0] == '$' )
 419     {
 420         vlc_value_t val;
 421         var_Create( p_this, psz_name + 1, VLC_VAR_MODULE | VLC_VAR_DOINHERIT );
 422         var_Get( p_this, psz_name + 1, &val );
 423         psz_var = val.psz_string;
 424         psz_name = psz_var;
 425     }
 426
 427     /* Count how many different shortcuts were asked for */
 428     if( psz_name && *psz_name )
 429     {
 430         char *psz_parser, *psz_last_shortcut;
 431
 432         /* If the user wants none, give him none. */
 433         if( !strcmp( psz_name, "none" ) )
 434         {
 435             if( psz_var ) free( psz_var );
 436             return NULL;
 437         }
 438
 439         i_shortcuts++;
 440         psz_shortcuts = psz_last_shortcut = strdup( psz_name );
 441
 442         for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
 443         {
 444             if( *psz_parser == ',' )
 445             {
 446                  *psz_parser = '\0';
 447                  i_shortcuts++;
 448                  psz_last_shortcut = psz_parser + 1;
 449             }
 450         }
 451
 452         /* Check if the user wants to override the "strict" mode */
 453         if( psz_last_shortcut )
 454         {
 455             if( !strcmp(psz_last_shortcut, "none") )
 456             {
 457                 b_strict = VLC_TRUE;
 458                 i_shortcuts--;
 459             }
 460             else if( !strcmp(psz_last_shortcut, "any") )
 461             {
 462                 b_strict = VLC_FALSE;
 463                 i_shortcuts--;
 464             }
 465         }
 466     }
 467
 468     /* Sort the modules and test them */
 469     p_all = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
 470     p_list = malloc( p_all->i_count * sizeof( module_list_t ) );
 471     p_first = NULL;
 472
 473     /* Parse the module list for capabilities and probe each of them */
 474     for( i_which_module = 0; i_which_module < p_all->i_count; i_which_module++ )
 475     {
 476         int i_shortcut_bonus = 0;
 477
 478         p_module = (module_t *)p_all->p_values[i_which_module].p_object;
 479
 480         /* Test that this module can do what we need */
 481         if( strcmp( p_module->psz_capability, psz_capability ) )
 482         {
 483             /* Don't recurse through the sub-modules because vlc_list_find()
 484              * will list them anyway. */
 485             continue;
 486         }
 487
 488         /* Test if we have the required CPU */
 489         if( (p_module->i_cpu & p_this->p_libvlc->i_cpu) != p_module->i_cpu )
 490         {
 491             continue;
 492         }
 493
 494         /* If we required a shortcut, check this plugin provides it. */
 495         if( i_shortcuts > 0 )
 496         {
 497             vlc_bool_t b_trash;
 498             int i_dummy, i_short = i_shortcuts;
 499             char *psz_name = psz_shortcuts;
 500
 501             /* Let's drop modules with a <= 0 score (unless they are
 502              * explicitly requested) */
 503             b_trash = p_module->i_score <= 0;
 504
 505             while( i_short > 0 )
 506             {
 507                 for( i_dummy = 0; p_module->pp_shortcuts[i_dummy]; i_dummy++ )
 508                 {
 509                     if( !strcasecmp( psz_name,
 510                                      p_module->pp_shortcuts[i_dummy] ) )
 511                     {
 512                         /* Found it */
 513                         b_trash = VLC_FALSE;
 514                         i_shortcut_bonus = i_short * 10000;
 515                         break;
 516                     }
 517                 }
 518
 519                 if( i_shortcut_bonus )
 520                 {
 521                     /* We found it... remember ? */
 522                     break;
 523                 }
 524
 525                 /* Go to the next shortcut... This is so lame! */
 526                 while( *psz_name )
 527                 {
 528                     psz_name++;
 529                 }
 530                 psz_name++;
 531                 i_short--;
 532             }
 533
 534             /* If we are in "strict" mode and we couldn't
 535              * find the module in the list of provided shortcuts,
 536              * then kick the bastard out of here!!! */
 537             if( i_short == 0 && b_strict )
 538             {
 539                 b_trash = VLC_TRUE;
 540             }
 541
 542             if( b_trash )
 543             {
 544                 continue;
 545             }
 546         }
 547         /* If we didn't require a shortcut, trash <= 0 scored plugins */
 548         else if( p_module->i_score <= 0 )
 549         {
 550             continue;
 551         }
 552
 553         /* Special case: test if we requested a particular intf plugin */
 554         if( !i_shortcuts && p_module->psz_program
 555              && !strcmp( psz_capability, "interface" )
 556              && !strcmp( p_module->psz_program,
 557                          p_this->p_vlc->psz_object_name ) )
 558         {
 559             if( !b_intf )
 560             {
 561                 /* Remove previous non-matching plugins */
 562                 i_index = 0;
 563                 b_intf = VLC_TRUE;
 564             }
 565         }
 566         else if( b_intf )
 567         {
 568             /* This one doesn't match */
 569             continue;
 570         }
 571
 572         /* Store this new module */
 573         p_list[ i_index ].p_module = p_module;
 574         p_list[ i_index ].i_score = p_module->i_score + i_shortcut_bonus;
 575         p_list[ i_index ].b_force = !!i_shortcut_bonus;
 576
 577         /* Add it to the modules-to-probe list */
 578         if( i_index == 0 )
 579         {
 580             p_list[ 0 ].p_next = NULL;
 581             p_first = p_list;
 582         }
 583         else
 584         {
 585             /* Ok, so at school you learned that quicksort is quick, and
 586              * bubble sort sucks raw eggs. But that's when dealing with
 587              * thousands of items. Here we have barely 50. */
 588             module_list_t *p_newlist = p_first;
 589
 590             if( p_first->i_score < p_list[ i_index ].i_score )
 591             {
 592                 p_list[ i_index ].p_next = p_first;
 593                 p_first = &p_list[ i_index ];
 594             }
 595             else
 596             {
 597                 while( p_newlist->p_next != NULL &&
 598                     p_newlist->p_next->i_score >= p_list[ i_index ].i_score )
 599                 {
 600                     p_newlist = p_newlist->p_next;
 601                 }
 602
 603                 p_list[ i_index ].p_next = p_newlist->p_next;
 604                 p_newlist->p_next = &p_list[ i_index ];
 605             }
 606         }
 607
 608         i_index++;
 609     }
 610
 611     msg_Dbg( p_this, "looking for %s module: %i candidate%s", psz_capability,
 612                                             i_index, i_index == 1 ? "" : "s" );
 613
 614     /* Lock all candidate modules */
 615     p_tmp = p_first;
 616     while( p_tmp != NULL )
 617     {
 618         vlc_object_yield( p_tmp->p_module );
 619         p_tmp = p_tmp->p_next;
 620     }
 621
 622     /* We can release the list, interesting modules were yielded */
 623     vlc_list_release( p_all );
 624
 625     /* Parse the linked list and use the first successful module */
 626     p_tmp = p_first;
 627     while( p_tmp != NULL )
 628     {
 629 #ifdef HAVE_DYNAMIC_PLUGINS
 630         /* Make sure the module is loaded in mem */
 631         module_t *p_module = p_tmp->p_module->b_submodule ?
 632             (module_t *)p_tmp->p_module->p_parent : p_tmp->p_module;
 633         if( !p_module->b_builtin && !p_module->b_loaded )
 634         {
 635             module_t *p_new_module =
 636                 AllocatePlugin( p_this, p_module->psz_filename );
 637             if( p_new_module )
 638             {
 639                 CacheMerge( p_this, p_module, p_new_module );
 640                 vlc_object_attach( p_new_module, p_module );
 641                 DeleteModule( p_new_module );
 642             }
 643         }
 644 #endif
 645
 646         p_this->b_force = p_tmp->b_force;
 647         if( p_tmp->p_module->pf_activate
 648              && p_tmp->p_module->pf_activate( p_this ) == VLC_SUCCESS )
 649         {
 650             break;
 651         }
 652
 653         vlc_object_release( p_tmp->p_module );
 654         p_tmp = p_tmp->p_next;
 655     }
 656
 657     /* Store the locked module value */
 658     if( p_tmp != NULL )
 659     {
 660         p_module = p_tmp->p_module;
 661         p_tmp = p_tmp->p_next;
 662     }
 663     else
 664     {
 665         p_module = NULL;
 666     }
 667
 668     /* Unlock the remaining modules */
 669     while( p_tmp != NULL )
 670     {
 671         vlc_object_release( p_tmp->p_module );
 672         p_tmp = p_tmp->p_next;
 673     }
 674
 675     free( p_list );
 676     p_this->b_force = b_force_backup;
 677
 678     if( p_module != NULL )
 679     {
 680         msg_Dbg( p_module, "using %s module \"%s\"",
 681                  psz_capability, p_module->psz_object_name );
 682     }
 683     else if( p_first == NULL )
 684     {
 685         if( !strcmp( psz_capability, "access_demux" ) )
 686         {
 687             msg_Warn( p_this, "no %s module matched \"%s\"",
 688                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 689         }
 690         else
 691         {
 692             msg_Err( p_this, "no %s module matched \"%s\"",
 693                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 694         }
 695     }
 696     else if( psz_name != NULL && *psz_name )
 697     {
 698         msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
 699                   psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 700     }
 701
 702     if( psz_shortcuts )
 703     {
 704         free( psz_shortcuts );
 705     }
 706
 707     if( psz_var )
 708     {
 709         free( psz_var );
 710     }
 711
 712     /* Don't forget that the module is still locked */
 713     return p_module;
 714 }
 715
 716 /*****************************************************************************
 717  * module_Unneed: decrease the usage count of a module.
 718  *****************************************************************************
 719  * This function must be called by the thread that called module_Need, to
 720  * decrease the reference count and allow for hiding of modules.
 721  *****************************************************************************/
 722 void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
 723 {
 724     /* Use the close method */
 725     if( p_module->pf_deactivate )
 726     {
 727         p_module->pf_deactivate( p_this );
 728     }
 729
 730     msg_Dbg( p_module, "unlocking module \"%s\"", p_module->psz_object_name );
 731
 732     vlc_object_release( p_module );
 733
 734     return;
 735 }
 736
 737 /*****************************************************************************
 738  * Following functions are local.
 739  *****************************************************************************/
 740
 741 /*****************************************************************************
 742  * AllocateAllPlugins: load all plugin modules we can find.
 743  *****************************************************************************/
 744 #ifdef HAVE_DYNAMIC_PLUGINS
 745 static void AllocateAllPlugins( vlc_object_t *p_this )
 746 {
 747     /* Yes, there are two NULLs because we replace one with "plugin-path". */
 748 #if defined( WIN32 ) || defined( UNDER_CE )
 749     char *path[] = { "modules", "", "plugins", 0, 0 };
 750 #else
 751     char *path[] = { "modules", PLUGIN_PATH, "plugins", 0, 0 };
 752 #endif
 753
 754     char **ppsz_path = path;
 755     char *psz_fullpath;
 756
 757     /* If the user provided a plugin path, we add it to the list */
 758     path[ sizeof(path)/sizeof(char*) - 2 ] =
 759         config_GetPsz( p_this, "plugin-path" );
 760
 761     for( ; *ppsz_path != NULL ; ppsz_path++ )
 762     {
 763         if( !(*ppsz_path)[0] ) continue;
 764
 765 #if defined( SYS_BEOS ) || defined( SYS_DARWIN ) || defined( WIN32 )
 766
 767         /* Handle relative as well as absolute paths */
 768 #ifdef WIN32
 769         if( (*ppsz_path)[0] != '\\' && (*ppsz_path)[0] != '/' &&
 770             (*ppsz_path)[1] != ':' )
 771 #else
 772         if( (*ppsz_path)[0] != '/' )
 773 #endif
 774         {
 775             int i_dirlen = strlen( *ppsz_path );
 776             i_dirlen += strlen( p_this->p_libvlc->psz_vlcpath ) + 2;
 777
 778             psz_fullpath = malloc( i_dirlen );
 779             if( psz_fullpath == NULL )
 780             {
 781                 continue;
 782             }
 783 #ifdef WIN32
 784             sprintf( psz_fullpath, "%s\\%s",
 785                      p_this->p_libvlc->psz_vlcpath, *ppsz_path );
 786 #else
 787             sprintf( psz_fullpath, "%s/%s",
 788                      p_this->p_libvlc->psz_vlcpath, *ppsz_path );
 789 #endif
 790         }
 791         else
 792 #endif
 793         {
 794             psz_fullpath = strdup( *ppsz_path );
 795         }
 796
 797         msg_Dbg( p_this, "recursively browsing `%s'", psz_fullpath );
 798
 799         /* Don't go deeper than 5 subdirectories */
 800         AllocatePluginDir( p_this, psz_fullpath, 5 );
 801
 802         free( psz_fullpath );
 803     }
 804
 805     /* Free plugin-path */
 806     if( path[ sizeof(path)/sizeof(char*) - 2 ] )
 807         free( path[ sizeof(path)/sizeof(char*) - 2 ] );
 808     path[ sizeof(path)/sizeof(char*) - 2 ] = NULL;
 809 }
 810
 811 /*****************************************************************************
 812  * AllocatePluginDir: recursively parse a directory to look for plugins
 813  *****************************************************************************/
 814 static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
 815                                int i_maxdepth )
 816 {
 817 #if defined( UNDER_CE ) || defined( _MSC_VER )
 818 #ifdef UNDER_CE
 819     wchar_t psz_wpath[MAX_PATH + 256];
 820     wchar_t psz_wdir[MAX_PATH];
 821 #endif
 822     char psz_path[MAX_PATH + 256];
 823     WIN32_FIND_DATA finddata;
 824     HANDLE handle;
 825     int rc;
 826 #else
 827     int    i_dirlen;
 828     DIR *  dir;
 829     struct dirent * file;
 830 #endif
 831     char * psz_file;
 832
 833     if( p_this->p_vlc->b_die || i_maxdepth < 0 )
 834     {
 835         return;
 836     }
 837
 838 #if defined( UNDER_CE ) || defined( _MSC_VER )
 839 #ifdef UNDER_CE
 840     MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
 841
 842     rc = GetFileAttributes( psz_wdir );
 843     if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
 844
 845     /* Parse all files in the directory */
 846     swprintf( psz_wpath, L"%ls\\*", psz_wdir );
 847 #else
 848     rc = GetFileAttributes( psz_dir );
 849     if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
 850 #endif
 851
 852     /* Parse all files in the directory */
 853     sprintf( psz_path, "%s\\*", psz_dir );
 854
 855 #ifdef UNDER_CE
 856     handle = FindFirstFile( psz_wpath, &finddata );
 857 #else
 858     handle = FindFirstFile( psz_path, &finddata );
 859 #endif
 860     if( handle == INVALID_HANDLE_VALUE )
 861     {
 862         /* Empty directory */
 863         return;
 864     }
 865
 866     /* Parse the directory and try to load all files it contains. */
 867     do
 868     {
 869 #ifdef UNDER_CE
 870         unsigned int i_len = wcslen( finddata.cFileName );
 871         swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
 872         sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
 873 #else
 874         unsigned int i_len = strlen( finddata.cFileName );
 875         sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
 876 #endif
 877
 878         /* Skip ".", ".." and anything starting with "." */
 879         if( !*finddata.cFileName || *finddata.cFileName == '.' )
 880         {
 881             if( !FindNextFile( handle, &finddata ) ) break;
 882             continue;
 883         }
 884
 885 #ifdef UNDER_CE
 886         if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
 887 #else
 888         if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
 889 #endif
 890         {
 891             AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
 892         }
 893         else if( i_len > strlen( LIBEXT )
 894                   /* We only load files ending with LIBEXT */
 895                   && !strncasecmp( psz_path + strlen( psz_path)
 896                                    - strlen( LIBEXT ),
 897                                    LIBEXT, strlen( LIBEXT ) ) )
 898         {
 899             WIN32_FILE_ATTRIBUTE_DATA attrbuf;
 900             int64_t i_time = 0, i_size = 0;
 901
 902 #ifdef UNDER_CE
 903             if( GetFileAttributesEx( psz_wpath, GetFileExInfoStandard,
 904                                      &attrbuf ) )
 905 #else
 906             if( GetFileAttributesEx( psz_path, GetFileExInfoStandard,
 907                                      &attrbuf ) )
 908 #endif
 909             {
 910                 i_time = attrbuf.ftLastWriteTime.dwHighDateTime;
 911                 i_time <<= 32;
 912                 i_time |= attrbuf.ftLastWriteTime.dwLowDateTime;
 913                 i_size = attrbuf.nFileSizeHigh;
 914                 i_size <<= 32;
 915                 i_size |= attrbuf.nFileSizeLow;
 916             }
 917             psz_file = psz_path;
 918
 919             AllocatePluginFile( p_this, psz_file, i_time, i_size );
 920         }
 921     }
 922     while( !p_this->p_vlc->b_die && FindNextFile( handle, &finddata ) );
 923
 924     /* Close the directory */
 925     FindClose( handle );
 926
 927 #else
 928     dir = opendir( psz_dir );
 929     if( !dir )
 930     {
 931         return;
 932     }
 933
 934     i_dirlen = strlen( psz_dir );
 935
 936     /* Parse the directory and try to load all files it contains. */
 937     while( !p_this->p_vlc->b_die && (file = readdir( dir )) )
 938     {
 939         struct stat statbuf;
 940         unsigned int i_len;
 941         int i_stat;
 942
 943         /* Skip ".", ".." and anything starting with "." */
 944         if( !*file->d_name || *file->d_name == '.' )
 945         {
 946             continue;
 947         }
 948
 949         i_len = strlen( file->d_name );
 950         psz_file = malloc( i_dirlen + 1 + i_len + 1 );
 951 #ifdef WIN32
 952         sprintf( psz_file, "%s\\%s", psz_dir, file->d_name );
 953 #else
 954         sprintf( psz_file, "%s/%s", psz_dir, file->d_name );
 955 #endif
 956
 957         i_stat = stat( psz_file, &statbuf );
 958         if( !i_stat && statbuf.st_mode & S_IFDIR )
 959         {
 960             AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
 961         }
 962         else if( i_len > strlen( LIBEXT )
 963                   /* We only load files ending with LIBEXT */
 964                   && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
 965                                    LIBEXT, strlen( LIBEXT ) ) )
 966         {
 967             int64_t i_time = 0, i_size = 0;
 968
 969             if( !i_stat )
 970             {
 971                 i_time = statbuf.st_mtime;
 972                 i_size = statbuf.st_size;
 973             }
 974
 975             AllocatePluginFile( p_this, psz_file, i_time, i_size );
 976         }
 977
 978         free( psz_file );
 979     }
 980
 981     /* Close the directory */
 982     closedir( dir );
 983
 984 #endif
 985 }
 986
 987 /*****************************************************************************
 988  * AllocatePluginFile: load a module into memory and initialize it.
 989  *****************************************************************************
 990  * This function loads a dynamically loadable module and allocates a structure
 991  * for its information data. The module can then be handled by module_Need
 992  * and module_Unneed. It can be removed by DeleteModule.
 993  *****************************************************************************/
 994 static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
 995                                int64_t i_file_time, int64_t i_file_size )
 996 {
 997     module_t * p_module;
 998     module_cache_t *p_cache_entry = NULL;
 999
1000     /*
1001      * Check our plugins cache first then load plugin if needed
1002      */
1003     p_cache_entry =
1004         CacheFind( p_this, psz_file, i_file_time, i_file_size );
1005
1006     if( !p_cache_entry )
1007     {
1008         p_module = AllocatePlugin( p_this, psz_file );
1009     }
1010     else
1011     {
1012         /* If junk dll, don't try to load it */
1013         if( p_cache_entry->b_junk )
1014         {
1015             p_module = NULL;
1016         }
1017         else
1018         {
1019             module_config_t *p_item;
1020
1021             p_module = p_cache_entry->p_module;
1022             p_module->b_loaded = VLC_FALSE;
1023
1024             /* For now we force loading if the module's config contains
1025              * callbacks or actions.
1026              * Could be optimized by adding an API call.*/
1027             for( p_item = p_module->p_config;
1028                  p_item->i_type != CONFIG_HINT_END; p_item++ )
1029             {
1030                 if( p_item->pf_callback || p_item->i_action )
1031                     p_module = AllocatePlugin( p_this, psz_file );
1032             }
1033         }
1034     }
1035
1036     if( p_module )
1037     {
1038         /* Everything worked fine !
1039          * The module is ready to be added to the list. */
1040         p_module->b_builtin = VLC_FALSE;
1041
1042         /* msg_Dbg( p_this, "plugin \"%s\", %s",
1043                     p_module->psz_object_name, p_module->psz_longname ); */
1044
1045         vlc_object_attach( p_module, p_this->p_libvlc->p_module_bank );
1046     }
1047
1048     if( !p_this->p_libvlc->p_module_bank->b_cache ) return 0;
1049
1050     /* Add entry to cache */
1051 #define p_bank p_this->p_libvlc->p_module_bank
1052     p_bank->pp_cache =
1053         realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1054     p_bank->pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1055     p_bank->pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1056     p_bank->pp_cache[p_bank->i_cache]->i_time = i_file_time;
1057     p_bank->pp_cache[p_bank->i_cache]->i_size = i_file_size;
1058     p_bank->pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1059     p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
1060     p_bank->i_cache++;
1061
1062     return p_module ? 0 : -1;
1063 }
1064
1065 /*****************************************************************************
1066  * AllocatePlugin: load a module into memory and initialize it.
1067  *****************************************************************************
1068  * This function loads a dynamically loadable module and allocates a structure
1069  * for its information data. The module can then be handled by module_Need
1070  * and module_Unneed. It can be removed by DeleteModule.
1071  *****************************************************************************/
1072 static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
1073 {
1074     module_t * p_module;
1075     module_handle_t handle;
1076
1077     if( LoadModule( p_this, psz_file, &handle ) ) return NULL;
1078
1079     /* Now that we have successfully loaded the module, we can
1080      * allocate a structure for it */
1081     p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
1082     if( p_module == NULL )
1083     {
1084         msg_Err( p_this, "out of memory" );
1085         CloseModule( handle );
1086         return NULL;
1087     }
1088
1089     /* We need to fill these since they may be needed by CallEntry() */
1090     p_module->psz_filename = psz_file;
1091     p_module->handle = handle;
1092 #ifndef HAVE_SHARED_LIBVLC
1093     p_module->p_symbols = &p_this->p_libvlc->p_module_bank->symbols;
1094 #endif
1095     p_module->b_loaded = VLC_TRUE;
1096
1097     /* Initialize the module: fill p_module, default config */
1098     if( CallEntry( p_module ) != 0 )
1099     {
1100         /* We couldn't call module_init() */
1101         vlc_object_destroy( p_module );
1102         CloseModule( handle );
1103         return NULL;
1104     }
1105
1106     DupModule( p_module );
1107     p_module->psz_filename = strdup( p_module->psz_filename );
1108
1109     /* Everything worked fine ! The module is ready to be added to the list. */
1110     p_module->b_builtin = VLC_FALSE;
1111
1112     return p_module;
1113 }
1114
1115 /*****************************************************************************
1116  * DupModule: make a plugin module standalone.
1117  *****************************************************************************
1118  * This function duplicates all strings in the module, so that the dynamic
1119  * object can be unloaded. It acts recursively on submodules.
1120  *****************************************************************************/
1121 static void DupModule( module_t *p_module )
1122 {
1123     char **pp_shortcut;
1124     int i_submodule;
1125
1126     for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1127     {
1128         *pp_shortcut = strdup( *pp_shortcut );
1129     }
1130
1131     /* We strdup() these entries so that they are still valid when the
1132      * module is unloaded. */
1133     p_module->psz_object_name = strdup( p_module->psz_object_name );
1134     p_module->psz_capability = strdup( p_module->psz_capability );
1135     p_module->psz_shortname = p_module->psz_shortname ?
1136                                  strdup( p_module->psz_shortname ) : NULL;
1137     p_module->psz_longname = strdup( p_module->psz_longname );
1138
1139     if( p_module->psz_program != NULL )
1140     {
1141         p_module->psz_program = strdup( p_module->psz_program );
1142     }
1143
1144     for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1145     {
1146         DupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1147     }
1148 }
1149
1150 /*****************************************************************************
1151  * UndupModule: free a duplicated module.
1152  *****************************************************************************
1153  * This function frees the allocations done in DupModule().
1154  *****************************************************************************/
1155 static void UndupModule( module_t *p_module )
1156 {
1157     char **pp_shortcut;
1158     int i_submodule;
1159
1160     for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1161     {
1162         UndupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1163     }
1164
1165     for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1166     {
1167         free( *pp_shortcut );
1168     }
1169
1170     free( p_module->psz_object_name );
1171     free( p_module->psz_capability );
1172     if( p_module->psz_shortname ) free( p_module->psz_shortname );
1173     free( p_module->psz_longname );
1174
1175     if( p_module->psz_program != NULL )
1176     {
1177         free( p_module->psz_program );
1178     }
1179 }
1180
1181 #endif /* HAVE_DYNAMIC_PLUGINS */
1182
1183 /*****************************************************************************
1184  * AllocateBuiltinModule: initialize a builtin module.
1185  *****************************************************************************
1186  * This function registers a builtin module and allocates a structure
1187  * for its information data. The module can then be handled by module_Need
1188  * and module_Unneed. It can be removed by DeleteModule.
1189  *****************************************************************************/
1190 static int AllocateBuiltinModule( vlc_object_t * p_this,
1191                                   int ( *pf_entry ) ( module_t * ) )
1192 {
1193     module_t * p_module;
1194
1195     /* Now that we have successfully loaded the module, we can
1196      * allocate a structure for it */
1197     p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
1198     if( p_module == NULL )
1199     {
1200         msg_Err( p_this, "out of memory" );
1201         return -1;
1202     }
1203
1204     /* Initialize the module : fill p_module->psz_object_name, etc. */
1205     if( pf_entry( p_module ) != 0 )
1206     {
1207         /* With a well-written module we shouldn't have to print an
1208          * additional error message here, but just make sure. */
1209         msg_Err( p_this, "failed calling entry point in builtin module" );
1210         vlc_object_destroy( p_module );
1211         return -1;
1212     }
1213
1214     /* Everything worked fine ! The module is ready to be added to the list. */
1215     p_module->b_builtin = VLC_TRUE;
1216
1217     /* msg_Dbg( p_this, "builtin \"%s\", %s",
1218                 p_module->psz_object_name, p_module->psz_longname ); */
1219
1220     vlc_object_attach( p_module, p_this->p_libvlc->p_module_bank );
1221
1222     return 0;
1223 }
1224
1225 /*****************************************************************************
1226  * DeleteModule: delete a module and its structure.
1227  *****************************************************************************
1228  * This function can only be called if the module isn't being used.
1229  *****************************************************************************/
1230 static int DeleteModule( module_t * p_module )
1231 {
1232     vlc_object_detach( p_module );
1233
1234     /* We free the structures that we strdup()ed in Allocate*Module(). */
1235 #ifdef HAVE_DYNAMIC_PLUGINS
1236     if( !p_module->b_builtin )
1237     {
1238         if( p_module->b_loaded && p_module->b_unloadable )
1239         {
1240             CloseModule( p_module->handle );
1241         }
1242         UndupModule( p_module );
1243         free( p_module->psz_filename );
1244     }
1245 #endif
1246
1247     /* Free and detach the object's children */
1248     while( p_module->i_children )
1249     {
1250         vlc_object_t *p_this = p_module->pp_children[0];
1251         vlc_object_detach( p_this );
1252         vlc_object_destroy( p_this );
1253     }
1254
1255     config_Free( p_module );
1256     vlc_object_destroy( p_module );
1257
1258     return 0;
1259 }
1260
1261 #ifdef HAVE_DYNAMIC_PLUGINS
1262 /*****************************************************************************
1263  * CallEntry: call an entry point.
1264  *****************************************************************************
1265  * This function calls a symbol given its name and a module structure. The
1266  * symbol MUST refer to a function returning int and taking a module_t* as
1267  * an argument.
1268  *****************************************************************************/
1269 static int CallEntry( module_t * p_module )
1270 {
1271     static char *psz_name = "vlc_entry" MODULE_SUFFIX;
1272     int (* pf_symbol) ( module_t * p_module );
1273
1274     /* Try to resolve the symbol */
1275     pf_symbol = (int (*)(module_t *)) GetSymbol( p_module->handle, psz_name );
1276
1277     if( pf_symbol == NULL )
1278     {
1279 #if defined(HAVE_DL_DYLD) || defined(HAVE_DL_BEOS)
1280         msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s'",
1281                             psz_name, p_module->psz_filename );
1282 #elif defined(HAVE_DL_WINDOWS)
1283         char *psz_error = GetWindowsError();
1284         msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1285                             psz_name, p_module->psz_filename, psz_error );
1286         free( psz_error );
1287 #elif defined(HAVE_DL_DLOPEN)
1288         msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1289                             psz_name, p_module->psz_filename, dlerror() );
1290 #elif defined(HAVE_DL_SHL_LOAD)
1291         msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1292                             psz_name, p_module->psz_filename, strerror(errno) );
1293 #else
1294 #   error "Something is wrong in modules.c"
1295 #endif
1296         return -1;
1297     }
1298
1299     /* We can now try to call the symbol */
1300     if( pf_symbol( p_module ) != 0 )
1301     {
1302         /* With a well-written module we shouldn't have to print an
1303          * additional error message here, but just make sure. */
1304         msg_Err( p_module, "failed calling symbol \"%s\" in file `%s'",
1305                            psz_name, p_module->psz_filename );
1306         return -1;
1307     }
1308
1309     /* Everything worked fine, we can return */
1310     return 0;
1311 }
1312
1313 /*****************************************************************************
1314  * LoadModule: loads a dynamic library
1315  *****************************************************************************
1316  * This function loads a dynamically linked library using a system dependant
1317  * method. Will return 0 on success as well as the module handle.
1318  *****************************************************************************/
1319 static int LoadModule( vlc_object_t *p_this, char *psz_file,
1320                        module_handle_t *p_handle )
1321 {
1322     module_handle_t handle;
1323
1324 #if defined(HAVE_DL_DYLD)
1325     NSObjectFileImage image;
1326     NSObjectFileImageReturnCode ret;
1327
1328     ret = NSCreateObjectFileImageFromFile( psz_file, &image );
1329
1330     if( ret != NSObjectFileImageSuccess )
1331     {
1332         msg_Warn( p_this, "cannot create image from `%s'", psz_file );
1333         return -1;
1334     }
1335
1336     /* Open the dynamic module */
1337     handle = NSLinkModule( image, psz_file,
1338                            NSLINKMODULE_OPTION_RETURN_ON_ERROR );
1339
1340     if( !handle )
1341     {
1342         NSLinkEditErrors errors;
1343         const char *psz_file, *psz_err;
1344         int i_errnum;
1345         NSLinkEditError( &errors, &i_errnum, &psz_file, &psz_err );
1346         msg_Warn( p_this, "cannot link module `%s' (%s)", psz_file, psz_err );
1347         NSDestroyObjectFileImage( image );
1348         return -1;
1349     }
1350
1351     /* Destroy our image, we won't need it */
1352     NSDestroyObjectFileImage( image );
1353
1354 #elif defined(HAVE_DL_BEOS)
1355     handle = load_add_on( psz_file );
1356     if( handle < 0 )
1357     {
1358         msg_Warn( p_this, "cannot load module `%s'", psz_file );
1359         return -1;
1360     }
1361
1362 #elif defined(HAVE_DL_WINDOWS)
1363 #ifdef UNDER_CE
1364     {
1365         wchar_t psz_wfile[MAX_PATH];
1366         MultiByteToWideChar( CP_ACP, 0, psz_file, -1, psz_wfile, MAX_PATH );
1367         handle = LoadLibrary( psz_wfile );
1368     }
1369 #else
1370     handle = LoadLibrary( psz_file );
1371 #endif
1372     if( handle == NULL )
1373     {
1374         char *psz_err = GetWindowsError();
1375         msg_Warn( p_this, "cannot load module `%s' (%s)", psz_file, psz_err );
1376         free( psz_err );
1377         return -1;
1378     }
1379
1380 #elif defined(HAVE_DL_DLOPEN) && defined(RTLD_NOW)
1381     /* static is OK, we are called atomically */
1382
1383 #   if defined(SYS_LINUX)
1384     /* XXX HACK #1 - we should NOT open modules with RTLD_GLOBAL, or we
1385      * are going to get namespace collisions when two modules have common
1386      * public symbols, but ALSA is being a pest here. */
1387     if( strstr( psz_file, "alsa_plugin" ) )
1388     {
1389         handle = dlopen( psz_file, RTLD_NOW | RTLD_GLOBAL );
1390         if( handle == NULL )
1391         {
1392             msg_Warn( p_this, "cannot load module `%s' (%s)",
1393                               psz_file, dlerror() );
1394             return -1;
1395         }
1396     }
1397 #   endif
1398
1399     handle = dlopen( psz_file, RTLD_NOW );
1400     if( handle == NULL )
1401     {
1402         msg_Warn( p_this, "cannot load module `%s' (%s)",
1403                           psz_file, dlerror() );
1404         return -1;
1405     }
1406
1407 #elif defined(HAVE_DL_DLOPEN)
1408 #   if defined(DL_LAZY)
1409     handle = dlopen( psz_file, DL_LAZY );
1410 #   else
1411     handle = dlopen( psz_file, 0 );
1412 #   endif
1413     if( handle == NULL )
1414     {
1415         msg_Warn( p_this, "cannot load module `%s' (%s)",
1416                           psz_file, dlerror() );
1417         return -1;
1418     }
1419
1420 #elif defined(HAVE_DL_SHL_LOAD)
1421     handle = shl_load( psz_file, BIND_IMMEDIATE | BIND_NONFATAL, NULL );
1422     if( handle == NULL )
1423     {
1424         msg_Warn( p_this, "cannot load module `%s' (%s)",
1425                           psz_file, strerror(errno) );
1426         return -1;
1427     }
1428
1429 #else
1430 #   error "Something is wrong in modules.c"
1431
1432 #endif
1433
1434     *p_handle = handle;
1435     return 0;
1436 }
1437
1438 /*****************************************************************************
1439  * CloseModule: unload a dynamic library
1440  *****************************************************************************
1441  * This function unloads a previously opened dynamically linked library
1442  * using a system dependant method. No return value is taken in consideration,
1443  * since some libraries sometimes refuse to close properly.
1444  *****************************************************************************/
1445 static void CloseModule( module_handle_t handle )
1446 {
1447 #if defined(HAVE_DL_DYLD)
1448     NSUnLinkModule( handle, FALSE );
1449
1450 #elif defined(HAVE_DL_BEOS)
1451     unload_add_on( handle );
1452
1453 #elif defined(HAVE_DL_WINDOWS)
1454     FreeLibrary( handle );
1455
1456 #elif defined(HAVE_DL_DLOPEN)
1457     dlclose( handle );
1458
1459 #elif defined(HAVE_DL_SHL_LOAD)
1460     shl_unload( handle );
1461
1462 #endif
1463     return;
1464 }
1465
1466 /*****************************************************************************
1467  * GetSymbol: get a symbol from a dynamic library
1468  *****************************************************************************
1469  * This function queries a loaded library for a symbol specified in a
1470  * string, and returns a pointer to it. We don't check for dlerror() or
1471  * similar functions, since we want a non-NULL symbol anyway.
1472  *****************************************************************************/
1473 static void * _module_getsymbol( module_handle_t, const char * );
1474
1475 static void * GetSymbol( module_handle_t handle, const char * psz_function )
1476 {
1477     void * p_symbol = _module_getsymbol( handle, psz_function );
1478
1479     /* MacOS X dl library expects symbols to begin with "_". So do
1480      * some other operating systems. That's really lame, but hey, what
1481      * can we do ? */
1482     if( p_symbol == NULL )
1483     {
1484         char *psz_call = malloc( strlen( psz_function ) + 2 );
1485
1486         strcpy( psz_call + 1, psz_function );
1487         psz_call[ 0 ] = '_';
1488         p_symbol = _module_getsymbol( handle, psz_call );
1489         free( psz_call );
1490     }
1491
1492     return p_symbol;
1493 }
1494
1495 static void * _module_getsymbol( module_handle_t handle,
1496                                  const char * psz_function )
1497 {
1498 #if defined(HAVE_DL_DYLD)
1499     NSSymbol sym = NSLookupSymbolInModule( handle, psz_function );
1500     return NSAddressOfSymbol( sym );
1501
1502 #elif defined(HAVE_DL_BEOS)
1503     void * p_symbol;
1504     if( B_OK == get_image_symbol( handle, psz_function,
1505                                   B_SYMBOL_TYPE_TEXT, &p_symbol ) )
1506     {
1507         return p_symbol;
1508     }
1509     else
1510     {
1511         return NULL;
1512     }
1513
1514 #elif defined(HAVE_DL_WINDOWS) && defined(UNDER_CE)
1515     wchar_t psz_real[256];
1516     MultiByteToWideChar( CP_ACP, 0, psz_function, -1, psz_real, 256 );
1517
1518     return (void *)GetProcAddress( handle, psz_real );
1519
1520 #elif defined(HAVE_DL_WINDOWS) && defined(WIN32)
1521     return (void *)GetProcAddress( handle, (char *)psz_function );
1522
1523 #elif defined(HAVE_DL_DLOPEN)
1524     return dlsym( handle, psz_function );
1525
1526 #elif defined(HAVE_DL_SHL_LOAD)
1527     void *p_sym;
1528     shl_findsym( &handle, psz_function, TYPE_UNDEFINED, &p_sym );
1529     return p_sym;
1530
1531 #endif
1532 }
1533
1534 #if defined(HAVE_DL_WINDOWS)
1535 static char * GetWindowsError( void )
1536 {
1537 #if defined(UNDER_CE)
1538     wchar_t psz_tmp[MAX_PATH];
1539     char * psz_buffer = malloc( MAX_PATH );
1540 #else
1541     char * psz_tmp = malloc( MAX_PATH );
1542 #endif
1543     int i = 0, i_error = GetLastError();
1544
1545     FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
1546                    NULL, i_error, MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT),
1547                    (LPTSTR)psz_tmp, MAX_PATH, NULL );
1548
1549     /* Go to the end of the string */
1550     while( psz_tmp[i] && psz_tmp[i] != _T('\r') && psz_tmp[i] != _T('\n') )
1551     {
1552         i++;
1553     }
1554
1555     if( psz_tmp[i] )
1556     {
1557 #if defined(UNDER_CE)
1558         swprintf( psz_tmp + i, L" (error %i)", i_error );
1559         psz_tmp[ 255 ] = L'\0';
1560 #else
1561         snprintf( psz_tmp + i, 256 - i, " (error %i)", i_error );
1562         psz_tmp[ 255 ] = '\0';
1563 #endif
1564     }
1565
1566 #if defined(UNDER_CE)
1567     wcstombs( psz_buffer, psz_tmp, MAX_PATH );
1568     return psz_buffer;
1569 #else
1570     return psz_tmp;
1571 #endif
1572 }
1573 #endif /* HAVE_DL_WINDOWS */
1574
1575 /*****************************************************************************
1576  * LoadPluginsCache: loads the plugins cache file
1577  *****************************************************************************
1578  * This function will load the plugin cache if present and valid. This cache
1579  * will in turn be queried by AllocateAllPlugins() to see if it needs to
1580  * actually load the dynamically loadable module.
1581  * This allows us to only fully load plugins when they are actually used.
1582  *****************************************************************************/
1583 static void CacheLoad( vlc_object_t *p_this )
1584 {
1585     char *psz_filename, *psz_homedir;
1586     FILE *file;
1587     int i, j, i_size, i_read;
1588     char p_cachestring[sizeof(PLUGINSCACHE_DIR COPYRIGHT_MESSAGE)];
1589     char p_cachelang[6], p_lang[6];
1590     int i_cache;
1591     module_cache_t **pp_cache = 0;
1592     int32_t i_file_size, i_marker;
1593
1594     psz_homedir = p_this->p_vlc->psz_homedir;
1595     if( !psz_homedir )
1596     {
1597         msg_Err( p_this, "psz_homedir is null" );
1598         return;
1599     }
1600
1601     i_size = asprintf( &psz_filename, "%s/%s/%s/%s", psz_homedir, CONFIG_DIR,
1602                        PLUGINSCACHE_DIR, CacheName() );
1603     if( i_size <= 0 )
1604     {
1605         msg_Err( p_this, "out of memory" );
1606         return;
1607     }
1608
1609     if( p_this->p_libvlc->p_module_bank->b_cache_delete )
1610     {
1611 #if !defined( UNDER_CE )
1612         unlink( psz_filename );
1613 #else
1614         wchar_t psz_wf[MAX_PATH];
1615         MultiByteToWideChar( CP_ACP, 0, psz_filename, -1, psz_wf, MAX_PATH );
1616         DeleteFile( psz_wf );
1617 #endif
1618         msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
1619         free( psz_filename );
1620         return;
1621     }
1622
1623     msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
1624
1625     file = fopen( psz_filename, "rb" );
1626     if( !file )
1627     {
1628         msg_Warn( p_this, "could not open plugins cache file %s for reading",
1629                   psz_filename );
1630         free( psz_filename );
1631         return;
1632     }
1633     free( psz_filename );
1634
1635     /* Check the file size */
1636     i_read = fread( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1637     if( i_read != sizeof(i_file_size) )
1638     {
1639         msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1640                   "(too short)" );
1641         fclose( file );
1642         return;
1643     }
1644
1645     fseek( file, 0, SEEK_END );
1646     if( ftell( file ) != i_file_size )
1647     {
1648         msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1649                   "(corrupted size)" );
1650         fclose( file );
1651         return;
1652     }
1653     fseek( file, sizeof(i_file_size), SEEK_SET );
1654
1655     /* Check the file is a plugins cache */
1656     i_size = sizeof(PLUGINSCACHE_DIR COPYRIGHT_MESSAGE) - 1;
1657     i_read = fread( p_cachestring, sizeof(char), i_size, file );
1658     if( i_read != i_size ||
1659         memcmp( p_cachestring, PLUGINSCACHE_DIR COPYRIGHT_MESSAGE, i_size ) )
1660     {
1661         msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
1662         fclose( file );
1663         return;
1664     }
1665
1666     /* Check Sub-version number */
1667     i_read = fread( &i_marker, sizeof(char), sizeof(i_marker), file );
1668     if( i_read != sizeof(i_marker) || i_marker != CACHE_SUBVERSION_NUM )
1669     {
1670         msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1671                   "(corrupted header)" );
1672         fclose( file );
1673         return;
1674     }
1675
1676     /* Check the language hasn't changed */
1677     sprintf( p_lang, "%5.5s", _("C") ); i_size = 5;
1678     i_read = fread( p_cachelang, sizeof(char), i_size, file );
1679     if( i_read != i_size || memcmp( p_cachelang, p_lang, i_size ) )
1680     {
1681         msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1682                   "(language changed)" );
1683         fclose( file );
1684         return;
1685     }
1686
1687     /* Check header marker */
1688     i_read = fread( &i_marker, sizeof(char), sizeof(i_marker), file );
1689     if( i_read != sizeof(i_marker) ||
1690         i_marker != ftell( file ) - (int)sizeof(i_marker) )
1691     {
1692         msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1693                   "(corrupted header)" );
1694         fclose( file );
1695         return;
1696     }
1697
1698     p_this->p_libvlc->p_module_bank->i_loaded_cache = 0;
1699     fread( &i_cache, sizeof(char), sizeof(i_cache), file );
1700     if( i_cache )
1701         pp_cache = p_this->p_libvlc->p_module_bank->pp_loaded_cache =
1702                    malloc( i_cache * sizeof(void *) );
1703
1704 #define LOAD_IMMEDIATE(a) \
1705     if( fread( &a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
1706 #define LOAD_STRING(a) \
1707     { if( fread( &i_size, sizeof(char), sizeof(i_size), file ) \
1708           != sizeof(i_size) ) goto error; \
1709       if( i_size && i_size < 16384 ) { \
1710           a = malloc( i_size ); \
1711           if( fread( a, sizeof(char), i_size, file ) != (size_t)i_size ) \
1712               goto error; \
1713           if( a[i_size-1] ) { \
1714               free( a ); a = 0; \
1715               goto error; } \
1716       } else a = 0; \
1717     } while(0)
1718
1719
1720     for( i = 0; i < i_cache; i++ )
1721     {
1722         int16_t i_size;
1723         int i_submodules;
1724
1725         pp_cache[i] = malloc( sizeof(module_cache_t) );
1726         p_this->p_libvlc->p_module_bank->i_loaded_cache++;
1727
1728         /* Load common info */
1729         LOAD_STRING( pp_cache[i]->psz_file );
1730         LOAD_IMMEDIATE( pp_cache[i]->i_time );
1731         LOAD_IMMEDIATE( pp_cache[i]->i_size );
1732         LOAD_IMMEDIATE( pp_cache[i]->b_junk );
1733
1734         if( pp_cache[i]->b_junk ) continue;
1735
1736         pp_cache[i]->p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
1737
1738         /* Load additional infos */
1739         LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
1740         LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
1741         LOAD_STRING( pp_cache[i]->p_module->psz_longname );
1742         LOAD_STRING( pp_cache[i]->p_module->psz_program );
1743         for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1744         {
1745             LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
1746         }
1747         LOAD_STRING( pp_cache[i]->p_module->psz_capability );
1748         LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
1749         LOAD_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
1750         LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
1751         LOAD_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
1752         LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
1753
1754         /* Config stuff */
1755         if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
1756             goto error;
1757
1758         LOAD_STRING( pp_cache[i]->p_module->psz_filename );
1759
1760         LOAD_IMMEDIATE( i_submodules );
1761
1762         while( i_submodules-- )
1763         {
1764             module_t *p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE);
1765             vlc_object_attach( p_module, pp_cache[i]->p_module );
1766             p_module->b_submodule = VLC_TRUE;
1767
1768             LOAD_STRING( p_module->psz_object_name );
1769             LOAD_STRING( p_module->psz_shortname );
1770             LOAD_STRING( p_module->psz_longname );
1771             LOAD_STRING( p_module->psz_program );
1772             for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1773             {
1774                 LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
1775             }
1776             LOAD_STRING( p_module->psz_capability );
1777             LOAD_IMMEDIATE( p_module->i_score );
1778             LOAD_IMMEDIATE( p_module->i_cpu );
1779             LOAD_IMMEDIATE( p_module->b_unloadable );
1780             LOAD_IMMEDIATE( p_module->b_reentrant );
1781         }
1782     }
1783
1784     fclose( file );
1785     return;
1786
1787  error:
1788
1789     msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
1790
1791     /* TODO: cleanup */
1792     p_this->p_libvlc->p_module_bank->i_loaded_cache = 0;
1793
1794     fclose( file );
1795     return;
1796 }
1797
1798 int CacheLoadConfig( module_t *p_module, FILE *file )
1799 {
1800     int i, j, i_lines;
1801     int16_t i_size;
1802
1803     /* Calculate the structure length */
1804     LOAD_IMMEDIATE( p_module->i_config_items );
1805     LOAD_IMMEDIATE( p_module->i_bool_items );
1806
1807     LOAD_IMMEDIATE( i_lines );
1808
1809     /* Allocate memory */
1810     p_module->p_config =
1811         (module_config_t *)malloc( sizeof(module_config_t) * (i_lines + 1));
1812     if( p_module->p_config == NULL )
1813     {
1814         msg_Err( p_module, "config error: can't duplicate p_config" );
1815         return VLC_ENOMEM;
1816     }
1817
1818     /* Do the duplication job */
1819     for( i = 0; i < i_lines ; i++ )
1820     {
1821         LOAD_IMMEDIATE( p_module->p_config[i] );
1822
1823         LOAD_STRING( p_module->p_config[i].psz_type );
1824         LOAD_STRING( p_module->p_config[i].psz_name );
1825         LOAD_STRING( p_module->p_config[i].psz_text );
1826         LOAD_STRING( p_module->p_config[i].psz_longtext );
1827         LOAD_STRING( p_module->p_config[i].psz_current );
1828         LOAD_STRING( p_module->p_config[i].psz_value_orig );
1829
1830         p_module->p_config[i].psz_value =
1831             p_module->p_config[i].psz_value_orig ?
1832                 strdup( p_module->p_config[i].psz_value_orig ) : 0;
1833         p_module->p_config[i].i_value = p_module->p_config[i].i_value_orig;
1834         p_module->p_config[i].f_value = p_module->p_config[i].f_value_orig;
1835         p_module->p_config[i].i_value_saved = p_module->p_config[i].i_value;
1836         p_module->p_config[i].f_value_saved = p_module->p_config[i].f_value;
1837         p_module->p_config[i].psz_value_saved = 0;
1838         p_module->p_config[i].b_dirty = VLC_FALSE;
1839
1840         p_module->p_config[i].p_lock = &p_module->object_lock;
1841
1842         if( p_module->p_config[i].i_list )
1843         {
1844             if( p_module->p_config[i].ppsz_list )
1845             {
1846                 p_module->p_config[i].ppsz_list =
1847                     malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1848                 if( p_module->p_config[i].ppsz_list )
1849                 {
1850                     for( j = 0; j < p_module->p_config[i].i_list; j++ )
1851                         LOAD_STRING( p_module->p_config[i].ppsz_list[j] );
1852                     p_module->p_config[i].ppsz_list[j] = NULL;
1853                 }
1854             }
1855             if( p_module->p_config[i].ppsz_list_text )
1856             {
1857                 p_module->p_config[i].ppsz_list_text =
1858                     malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1859                 if( p_module->p_config[i].ppsz_list_text )
1860                 {
1861                   for( j = 0; j < p_module->p_config[i].i_list; j++ )
1862                       LOAD_STRING( p_module->p_config[i].ppsz_list_text[j] );
1863                   p_module->p_config[i].ppsz_list_text[j] = NULL;
1864                 }
1865             }
1866             if( p_module->p_config[i].pi_list )
1867             {
1868                 p_module->p_config[i].pi_list =
1869                     malloc( (p_module->p_config[i].i_list + 1) * sizeof(int) );
1870                 if( p_module->p_config[i].pi_list )
1871                 {
1872                     for( j = 0; j < p_module->p_config[i].i_list; j++ )
1873                         LOAD_IMMEDIATE( p_module->p_config[i].pi_list[j] );
1874                 }
1875             }
1876         }
1877
1878         if( p_module->p_config[i].i_action )
1879         {
1880             p_module->p_config[i].ppf_action =
1881                 malloc( p_module->p_config[i].i_action * sizeof(void *) );
1882             p_module->p_config[i].ppsz_action_text =
1883                 malloc( p_module->p_config[i].i_action * sizeof(char *) );
1884
1885             for( j = 0; j < p_module->p_config[i].i_action; j++ )
1886             {
1887                 p_module->p_config[i].ppf_action[j] = 0;
1888                 LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
1889             }
1890         }
1891
1892         LOAD_IMMEDIATE( p_module->p_config[i].pf_callback );
1893     }
1894
1895     p_module->p_config[i].i_type = CONFIG_HINT_END;
1896
1897     return VLC_SUCCESS;
1898
1899  error:
1900
1901     return VLC_EGENERIC;
1902 }
1903
1904 /*****************************************************************************
1905  * SavePluginsCache: saves the plugins cache to a file
1906  *****************************************************************************/
1907 static void CacheSave( vlc_object_t *p_this )
1908 {
1909     static char const psz_tag[] =
1910         "Signature: 8a477f597d28d172789f06886806bc55\r\n"
1911         "# This file is a cache directory tag created by VLC.\r\n"
1912         "# For information about cache directory tags, see:\r\n"
1913         "#   http://www.brynosaurus.com/cachedir/\r\n";
1914
1915     char *psz_filename, *psz_homedir;
1916     FILE *file;
1917     int i, j, i_cache;
1918     module_cache_t **pp_cache;
1919     int32_t i_file_size = 0;
1920
1921     psz_homedir = p_this->p_vlc->psz_homedir;
1922     if( !psz_homedir )
1923     {
1924         msg_Err( p_this, "psz_homedir is null" );
1925         return;
1926     }
1927     psz_filename =
1928        (char *)malloc( sizeof("/" CONFIG_DIR "/" PLUGINSCACHE_DIR "/" ) +
1929                        strlen(psz_homedir) + strlen(CacheName()) );
1930
1931     if( !psz_filename )
1932     {
1933         msg_Err( p_this, "out of memory" );
1934         return;
1935     }
1936
1937     sprintf( psz_filename, "%s/%s", psz_homedir, CONFIG_DIR );
1938
1939     config_CreateDir( p_this, psz_filename );
1940
1941     strcat( psz_filename, "/" PLUGINSCACHE_DIR );
1942
1943     config_CreateDir( p_this, psz_filename );
1944
1945     strcat( psz_filename, "/CACHEDIR.TAG" );
1946
1947     file = fopen( psz_filename, "wb" );
1948     if( file )
1949     {
1950         fwrite( psz_tag, 1, strlen(psz_tag), file );
1951         fclose( file );
1952     }
1953
1954     sprintf( psz_filename, "%s/%s/%s/%s", psz_homedir, CONFIG_DIR,
1955              PLUGINSCACHE_DIR, CacheName() );
1956
1957     msg_Dbg( p_this, "saving plugins cache file %s", psz_filename );
1958
1959     file = fopen( psz_filename, "wb" );
1960     if( !file )
1961     {
1962         msg_Warn( p_this, "could not open plugins cache file %s for writing",
1963                   psz_filename );
1964         free( psz_filename );
1965         return;
1966     }
1967     free( psz_filename );
1968
1969     /* Empty space for file size */
1970     fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1971
1972     /* Contains version number */
1973     fprintf( file, "%s", PLUGINSCACHE_DIR COPYRIGHT_MESSAGE );
1974
1975     /* Sub-version number (to avoid breakage in the dev version when cache
1976      * structure changes) */
1977     i_file_size = CACHE_SUBVERSION_NUM;
1978     fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1979
1980     /* Language */
1981     fprintf( file, "%5.5s", _("C") );
1982
1983     /* Header marker */
1984     i_file_size = ftell( file );
1985     fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1986
1987     i_cache = p_this->p_libvlc->p_module_bank->i_cache;
1988     pp_cache = p_this->p_libvlc->p_module_bank->pp_cache;
1989
1990     fwrite( &i_cache, sizeof(char), sizeof(i_cache), file );
1991
1992 #define SAVE_IMMEDIATE(a) \
1993     fwrite( &a, sizeof(char), sizeof(a), file )
1994 #define SAVE_STRING(a) \
1995     { i_size = a ? strlen( a ) + 1 : 0; \
1996       fwrite( &i_size, sizeof(char), sizeof(i_size), file ); \
1997       if( a ) fwrite( a, sizeof(char), i_size, file ); \
1998     } while(0)
1999
2000     for( i = 0; i < i_cache; i++ )
2001     {
2002         int16_t i_size;
2003         int32_t i_submodule;
2004
2005         /* Save common info */
2006         SAVE_STRING( pp_cache[i]->psz_file );
2007         SAVE_IMMEDIATE( pp_cache[i]->i_time );
2008         SAVE_IMMEDIATE( pp_cache[i]->i_size );
2009         SAVE_IMMEDIATE( pp_cache[i]->b_junk );
2010
2011         if( pp_cache[i]->b_junk ) continue;
2012
2013         /* Save additional infos */
2014         SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
2015         SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
2016         SAVE_STRING( pp_cache[i]->p_module->psz_longname );
2017         SAVE_STRING( pp_cache[i]->p_module->psz_program );
2018         for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
2019         {
2020             SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
2021         }
2022         SAVE_STRING( pp_cache[i]->p_module->psz_capability );
2023         SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
2024         SAVE_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
2025         SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
2026         SAVE_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
2027         SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
2028
2029         /* Config stuff */
2030         CacheSaveConfig( pp_cache[i]->p_module, file );
2031
2032         SAVE_STRING( pp_cache[i]->p_module->psz_filename );
2033
2034         i_submodule = pp_cache[i]->p_module->i_children;
2035         SAVE_IMMEDIATE( i_submodule );
2036         for( i_submodule = 0; i_submodule < pp_cache[i]->p_module->i_children;
2037              i_submodule++ )
2038         {
2039             module_t *p_module =
2040                 (module_t *)pp_cache[i]->p_module->pp_children[i_submodule];
2041
2042             SAVE_STRING( p_module->psz_object_name );
2043             SAVE_STRING( p_module->psz_shortname );
2044             SAVE_STRING( p_module->psz_longname );
2045             SAVE_STRING( p_module->psz_program );
2046             for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
2047             {
2048                 SAVE_STRING( p_module->pp_shortcuts[j] ); // FIX
2049             }
2050             SAVE_STRING( p_module->psz_capability );
2051             SAVE_IMMEDIATE( p_module->i_score );
2052             SAVE_IMMEDIATE( p_module->i_cpu );
2053             SAVE_IMMEDIATE( p_module->b_unloadable );
2054             SAVE_IMMEDIATE( p_module->b_reentrant );
2055         }
2056     }
2057
2058     /* Fill-up file size */
2059     i_file_size = ftell( file );
2060     fseek( file, 0, SEEK_SET );
2061     fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2062
2063     fclose( file );
2064
2065     return;
2066 }
2067
2068 void CacheSaveConfig( module_t *p_module, FILE *file )
2069 {
2070     int i, j, i_lines = 0;
2071     module_config_t *p_item;
2072     int16_t i_size;
2073
2074     SAVE_IMMEDIATE( p_module->i_config_items );
2075     SAVE_IMMEDIATE( p_module->i_bool_items );
2076
2077     for( p_item = p_module->p_config; p_item->i_type != CONFIG_HINT_END;
2078          p_item++ ) i_lines++;
2079
2080     SAVE_IMMEDIATE( i_lines );
2081
2082     for( i = 0; i < i_lines ; i++ )
2083     {
2084         SAVE_IMMEDIATE( p_module->p_config[i] );
2085
2086         SAVE_STRING( p_module->p_config[i].psz_type );
2087         SAVE_STRING( p_module->p_config[i].psz_name );
2088         SAVE_STRING( p_module->p_config[i].psz_text );
2089         SAVE_STRING( p_module->p_config[i].psz_longtext );
2090         SAVE_STRING( p_module->p_config[i].psz_current );
2091         SAVE_STRING( p_module->p_config[i].psz_value_orig );
2092
2093         if( p_module->p_config[i].i_list )
2094         {
2095             if( p_module->p_config[i].ppsz_list )
2096             {
2097                 for( j = 0; j < p_module->p_config[i].i_list; j++ )
2098                     SAVE_STRING( p_module->p_config[i].ppsz_list[j] );
2099             }
2100
2101             if( p_module->p_config[i].ppsz_list_text )
2102             {
2103                 for( j = 0; j < p_module->p_config[i].i_list; j++ )
2104                     SAVE_STRING( p_module->p_config[i].ppsz_list_text[j] );
2105             }
2106             if( p_module->p_config[i].pi_list )
2107             {
2108                 for( j = 0; j < p_module->p_config[i].i_list; j++ )
2109                     SAVE_IMMEDIATE( p_module->p_config[i].pi_list[j] );
2110             }
2111         }
2112
2113         for( j = 0; j < p_module->p_config[i].i_action; j++ )
2114             SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );
2115
2116         SAVE_IMMEDIATE( p_module->p_config[i].pf_callback );
2117     }
2118 }
2119
2120 /*****************************************************************************
2121  * CacheName: Return the cache file name for this platform.
2122  *****************************************************************************/
2123 static char *CacheName( void )
2124 {
2125     static char psz_cachename[32];
2126     static vlc_bool_t b_initialised = VLC_FALSE;
2127
2128     if( !b_initialised )
2129     {
2130         /* Code int size, pointer size and endianness in the filename */
2131         int32_t x = 0xbe00001e;
2132         sprintf( psz_cachename, "plugins-%.2x%.2x%.2x.dat", sizeof(int),
2133                  sizeof(void *), (unsigned int)((unsigned char *)&x)[0] );
2134         b_initialised = VLC_TRUE;
2135     }
2136
2137     return psz_cachename;
2138 }
2139
2140 /*****************************************************************************
2141  * CacheMerge: Merge a cache module descriptor with a full module descriptor.
2142  *****************************************************************************/
2143 static void CacheMerge( vlc_object_t *p_this, module_t *p_cache,
2144                         module_t *p_module )
2145 {
2146     int i_submodule;
2147
2148     p_cache->pf_activate = p_module->pf_activate;
2149     p_cache->pf_deactivate = p_module->pf_deactivate;
2150 #ifndef HAVE_SHARED_LIBVLC
2151     p_cache->p_symbols = p_module->p_symbols;
2152 #endif
2153     p_cache->handle = p_module->handle;
2154
2155     for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
2156     {
2157         module_t *p_child = (module_t*)p_module->pp_children[i_submodule];
2158         module_t *p_cchild = (module_t*)p_cache->pp_children[i_submodule];
2159         p_cchild->pf_activate = p_child->pf_activate;
2160         p_cchild->pf_deactivate = p_child->pf_deactivate;
2161 #ifndef HAVE_SHARED_LIBVLC
2162         p_cchild->p_symbols = p_child->p_symbols;
2163 #endif
2164     }
2165
2166     p_cache->b_loaded = VLC_TRUE;
2167     p_module->b_loaded = VLC_FALSE;
2168 }
2169
2170 /*****************************************************************************
2171  * FindPluginCache: finds the cache entry corresponding to a file
2172  *****************************************************************************/
2173 static module_cache_t *CacheFind( vlc_object_t *p_this, char *psz_file,
2174                                   int64_t i_time, int64_t i_size )
2175 {
2176     module_cache_t **pp_cache;
2177     int i_cache, i;
2178
2179     pp_cache = p_this->p_libvlc->p_module_bank->pp_loaded_cache;
2180     i_cache = p_this->p_libvlc->p_module_bank->i_loaded_cache;
2181
2182     for( i = 0; i < i_cache; i++ )
2183     {
2184         if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
2185             pp_cache[i]->i_time == i_time &&
2186             pp_cache[i]->i_size == i_size ) return pp_cache[i];
2187     }
2188
2189     return NULL;
2190 }
2191
2192 #endif /* HAVE_DYNAMIC_PLUGINS */