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 VideoLAN
   5  * $Id: modules.c,v 1.108 2002/12/13 01:56:30 gbazin Exp $
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *          Ethan C. Baldridge <BaldridgeE@cadmus.com>
   9  *          Hans-Peter Jansen <hpj@urpla.net>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /* Some faulty libcs have a broken struct dirent when _FILE_OFFSET_BITS
  27  * is set to 64. Don't try to be cleverer. */
  28 #ifdef _FILE_OFFSET_BITS
  29 #undef _FILE_OFFSET_BITS
  30 #endif
  31
  32 #include <stdlib.h>                                      /* free(), strtol() */
  33 #include <stdio.h>                                              /* sprintf() */
  34 #include <string.h>                                              /* strdup() */
  35
  36 #include <vlc/vlc.h>
  37
  38 #ifdef HAVE_DIRENT_H
  39 #   include <dirent.h>
  40 #elif defined( UNDER_CE )
  41 #   include <windows.h>                               /* GetFileAttributes() */
  42 #else
  43 #   include "../extras/dirent.h"
  44 #endif
  45
  46 #ifdef HAVE_SYS_TYPES_H
  47 #   include <sys/types.h>
  48 #endif
  49 #ifdef HAVE_SYS_STAT_H
  50 #   include <sys/stat.h>
  51 #endif
  52 #ifdef HAVE_UNISTD_H
  53 #   include <unistd.h>
  54 #endif
  55
  56 #if defined(HAVE_DLFCN_H)                                /* Linux, BSD, Hurd */
  57 #   include <dlfcn.h>                        /* dlopen(), dlsym(), dlclose() */
  58 #   define HAVE_DYNAMIC_PLUGINS
  59 #elif defined(HAVE_IMAGE_H)                                          /* BeOS */
  60 #   include <image.h>
  61 #   define HAVE_DYNAMIC_PLUGINS
  62 #elif defined(UNDER_CE)
  63 #   define HAVE_DYNAMIC_PLUGINS
  64 #elif defined(WIN32)
  65 #   define HAVE_DYNAMIC_PLUGINS
  66 #else
  67 #   undef HAVE_DYNAMIC_PLUGINS
  68 #endif
  69
  70 #include "error.h"
  71 #include "netutils.h"
  72
  73 #include "interface.h"
  74 #include "vlc_playlist.h"
  75 #include "intf_eject.h"
  76
  77 #include "stream_control.h"
  78 #include "input_ext-intf.h"
  79 #include "input_ext-dec.h"
  80 #include "input_ext-plugins.h"
  81
  82 #include "video.h"
  83 #include "video_output.h"
  84
  85 #include "audio_output.h"
  86 #include "aout_internal.h"
  87
  88 #include "stream_output.h"
  89
  90 #include "iso_lang.h"
  91
  92 #if defined( UNDER_CE )
  93 #   define MYCHAR wchar_t
  94 #else
  95 #   define MYCHAR char
  96 #endif
  97
  98 #ifdef HAVE_DYNAMIC_PLUGINS
  99 #   include "modules_plugin.h"
 100 #endif
 101
 102 #if defined( UNDER_CE )
 103 #    include "modules_builtin_evc.h"
 104 #elif defined( _MSC_VER )
 105 #    include "modules_builtin_msvc.h"
 106 #else
 107 #    include "modules_builtin.h"
 108 #endif
 109
 110 /*****************************************************************************
 111  * Local prototypes
 112  *****************************************************************************/
 113 #ifdef HAVE_DYNAMIC_PLUGINS
 114 static void AllocateAllPlugins   ( vlc_object_t * );
 115 static void AllocatePluginDir    ( vlc_object_t *, const MYCHAR *, int );
 116 static int  AllocatePluginFile   ( vlc_object_t *, MYCHAR * );
 117 #endif
 118 static int  AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
 119 static int  DeleteModule ( module_t * );
 120 #ifdef HAVE_DYNAMIC_PLUGINS
 121 static void DupModule    ( module_t * );
 122 static void UndupModule  ( module_t * );
 123 static int  CallEntry    ( module_t * );
 124 #endif
 125
 126 /*****************************************************************************
 127  * module_InitBank: create the module bank.
 128  *****************************************************************************
 129  * This function creates a module bank structure which will be filled later
 130  * on with all the modules found.
 131  *****************************************************************************/
 132 void __module_InitBank( vlc_object_t *p_this )
 133 {
 134     module_bank_t *p_bank;
 135
 136     p_bank = vlc_object_create( p_this, sizeof(module_bank_t) );
 137     p_bank->psz_object_name = "module bank";
 138
 139     /*
 140      * Store the symbols to be exported
 141      */
 142 #ifdef HAVE_DYNAMIC_PLUGINS
 143     STORE_SYMBOLS( &p_bank->symbols );
 144 #endif
 145
 146     /* Everything worked, attach the object */
 147     p_this->p_libvlc->p_module_bank = p_bank;
 148     vlc_object_attach( p_bank, p_this->p_libvlc );
 149
 150     return;
 151 }
 152
 153 /*****************************************************************************
 154  * module_ResetBank: reset the module bank.
 155  *****************************************************************************
 156  * This function resets the module bank by unloading all unused plugin
 157  * modules.
 158  *****************************************************************************/
 159 void __module_ResetBank( vlc_object_t *p_this )
 160 {
 161     msg_Err( p_this, "FIXME: module_ResetBank unimplemented" );
 162     return;
 163 }
 164
 165 /*****************************************************************************
 166  * module_EndBank: empty the module bank.
 167  *****************************************************************************
 168  * This function unloads all unused plugin modules and empties the module
 169  * bank in case of success.
 170  *****************************************************************************/
 171 void __module_EndBank( vlc_object_t *p_this )
 172 {
 173     module_t * p_next;
 174
 175     vlc_object_detach( p_this->p_libvlc->p_module_bank );
 176
 177     while( p_this->p_libvlc->p_module_bank->i_children )
 178     {
 179         p_next = (module_t *)p_this->p_libvlc->p_module_bank->pp_children[0];
 180
 181         if( DeleteModule( p_next ) )
 182         {
 183             /* Module deletion failed */
 184             msg_Err( p_this, "module \"%s\" can't be removed, trying harder",
 185                      p_next->psz_object_name );
 186
 187             /* We just free the module by hand. Niahahahahaha. */
 188             vlc_object_detach( p_next );
 189             vlc_object_destroy( p_next );
 190         }
 191     }
 192
 193     vlc_object_destroy( p_this->p_libvlc->p_module_bank );
 194
 195     return;
 196 }
 197
 198 /*****************************************************************************
 199  * module_LoadMain: load the main program info into the module bank.
 200  *****************************************************************************
 201  * This function fills the module bank structure with the main module infos.
 202  * This is very useful as it will allow us to consider the main program just
 203  * as another module, and for instance the configuration options of main will
 204  * be available in the module bank structure just as for every other module.
 205  *****************************************************************************/
 206 void __module_LoadMain( vlc_object_t *p_this )
 207 {
 208     AllocateBuiltinModule( p_this, vlc_entry__main );
 209 }
 210
 211 /*****************************************************************************
 212  * module_LoadBuiltins: load all modules which we built with.
 213  *****************************************************************************
 214  * This function fills the module bank structure with the builtin modules.
 215  *****************************************************************************/
 216 void __module_LoadBuiltins( vlc_object_t * p_this )
 217 {
 218     msg_Dbg( p_this, "checking builtin modules" );
 219     ALLOCATE_ALL_BUILTINS();
 220 }
 221
 222 /*****************************************************************************
 223  * module_LoadPlugins: load all plugin modules we can find.
 224  *****************************************************************************
 225  * This function fills the module bank structure with the plugin modules.
 226  *****************************************************************************/
 227 void __module_LoadPlugins( vlc_object_t * p_this )
 228 {
 229 #ifdef HAVE_DYNAMIC_PLUGINS
 230     msg_Dbg( p_this, "checking plugin modules" );
 231     AllocateAllPlugins( p_this );
 232 #endif
 233 }
 234
 235 /*****************************************************************************
 236  * module_Need: return the best module function, given a capability list.
 237  *****************************************************************************
 238  * This function returns the module that best fits the asked capabilities.
 239  *****************************************************************************/
 240 module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
 241                           const char *psz_name )
 242 {
 243     typedef struct module_list_t module_list_t;
 244
 245     struct module_list_t
 246     {
 247         module_t *p_module;
 248         int i_score;
 249         module_list_t *p_next;
 250     };
 251
 252     module_list_t *p_list, *p_first, *p_tmp;
 253     vlc_list_t all;
 254
 255     int i_which_module, i_index = 0;
 256     vlc_bool_t b_intf = VLC_FALSE;
 257
 258     module_t *p_module;
 259
 260     int   i_shortcuts = 0;
 261     char *psz_shortcuts = NULL, *psz_var = NULL;
 262
 263     msg_Dbg( p_this, "looking for %s module", psz_capability );
 264
 265     /* Deal with variables */
 266     if( psz_name && psz_name[0] == '$' )
 267     {
 268         psz_var = config_GetPsz( p_this, psz_name + 1 );
 269         psz_name = psz_var;
 270     }
 271
 272     /* Count how many different shortcuts were asked for */
 273     if( psz_name && *psz_name )
 274     {
 275         char *psz_parser;
 276
 277         /* If the user wants none, give him none. */
 278         if( !strcmp( psz_name, "none" ) )
 279         {
 280             if( psz_var ) free( psz_var );
 281             return NULL;
 282         }
 283
 284         i_shortcuts++;
 285         psz_shortcuts = strdup( psz_name );
 286
 287         for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
 288         {
 289             if( *psz_parser == ',' )
 290             {
 291                  *psz_parser = '\0';
 292                  i_shortcuts++;
 293             }
 294         }
 295     }
 296
 297     /* Sort the modules and test them */
 298     all = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
 299     p_list = malloc( all.i_count * sizeof( module_list_t ) );
 300     p_first = NULL;
 301
 302     /* Parse the module list for capabilities and probe each of them */
 303     for( i_which_module = 0; i_which_module < all.i_count; i_which_module++ )
 304     {
 305         module_t * p_submodule = NULL;
 306         int i_shortcut_bonus = 0, i_submodule;
 307
 308         p_module = (module_t *)all.p_values[i_which_module].p_object;
 309
 310         /* Test that this module can do what we need */
 311         if( strcmp( p_module->psz_capability, psz_capability ) )
 312         {
 313             for( i_submodule = 0;
 314                  i_submodule < p_module->i_children;
 315                  i_submodule++ )
 316             {
 317                 if( !strcmp( ((module_t*)p_module->pp_children[ i_submodule ])
 318                                            ->psz_capability, psz_capability ) )
 319                 {
 320                     p_submodule =
 321                             (module_t*)p_module->pp_children[ i_submodule ];
 322                     break;
 323                 }
 324             }
 325
 326             if( p_submodule == NULL )
 327             {
 328                 continue;
 329             }
 330
 331             p_module = p_submodule;
 332         }
 333
 334         /* Test if we have the required CPU */
 335         if( (p_module->i_cpu & p_this->p_libvlc->i_cpu) != p_module->i_cpu )
 336         {
 337             continue;
 338         }
 339
 340         /* If we required a shortcut, check this plugin provides it. */
 341         if( i_shortcuts )
 342         {
 343             vlc_bool_t b_trash = VLC_TRUE;
 344             int i_dummy, i_short = i_shortcuts;
 345             char *psz_name = psz_shortcuts;
 346
 347             while( i_short )
 348             {
 349                 for( i_dummy = 0;
 350                      b_trash && p_module->pp_shortcuts[i_dummy];
 351                      i_dummy++ )
 352                 {
 353                     b_trash = ( strcmp(psz_name, "any") || !p_module->i_score )
 354                         && strcmp( psz_name, p_module->pp_shortcuts[i_dummy] );
 355                 }
 356
 357                 if( !b_trash )
 358                 {
 359                     i_shortcut_bonus = i_short * 10000;
 360                     break;
 361                 }
 362
 363                 /* Go to the next shortcut... This is so lame! */
 364                 while( *psz_name )
 365                 {
 366                     psz_name++;
 367                 }
 368                 psz_name++;
 369                 i_short--;
 370             }
 371
 372             if( b_trash )
 373             {
 374                 continue;
 375             }
 376         }
 377         /* If we didn't require a shortcut, trash zero-scored plugins */
 378         else if( !p_module->i_score )
 379         {
 380             continue;
 381         }
 382
 383         /* Special case: test if we requested a particular intf plugin */
 384         if( p_module->psz_program
 385              && !strcmp( p_module->psz_program,
 386                          p_this->p_vlc->psz_object_name ) )
 387         {
 388             if( !b_intf )
 389             {
 390                 /* Remove previous non-matching plugins */
 391                 i_index = 0;
 392                 b_intf = VLC_TRUE;
 393             }
 394         }
 395         else if( b_intf )
 396         {
 397             /* This one doesn't match */
 398             continue;
 399         }
 400
 401         /* Store this new module */
 402         p_list[ i_index ].p_module = p_module;
 403         p_list[ i_index ].i_score = p_module->i_score + i_shortcut_bonus;
 404
 405         /* Add it to the modules-to-probe list */
 406         if( i_index == 0 )
 407         {
 408             p_list[ 0 ].p_next = NULL;
 409             p_first = p_list;
 410         }
 411         else
 412         {
 413             /* Ok, so at school you learned that quicksort is quick, and
 414              * bubble sort sucks raw eggs. But that's when dealing with
 415              * thousands of items. Here we have barely 50. */
 416             module_list_t *p_newlist = p_first;
 417
 418             if( p_first->i_score < p_list[ i_index ].i_score )
 419             {
 420                 p_list[ i_index ].p_next = p_first;
 421                 p_first = &p_list[ i_index ];
 422             }
 423             else
 424             {
 425                 while( p_newlist->p_next != NULL &&
 426                     p_newlist->p_next->i_score >= p_list[ i_index ].i_score )
 427                 {
 428                     p_newlist = p_newlist->p_next;
 429                 }
 430
 431                 p_list[ i_index ].p_next = p_newlist->p_next;
 432                 p_newlist->p_next = &p_list[ i_index ];
 433             }
 434         }
 435
 436         i_index++;
 437     }
 438
 439     msg_Dbg( p_this, "probing %i candidate%s",
 440                      i_index, i_index == 1 ? "" : "s" );
 441
 442     /* Lock all candidate modules */
 443     p_tmp = p_first;
 444     while( p_tmp != NULL )
 445     {
 446         vlc_object_yield( p_tmp->p_module );
 447         p_tmp = p_tmp->p_next;
 448     }
 449
 450     /* We can release the list, interesting modules were yielded */
 451     vlc_list_release( &all );
 452
 453     /* Parse the linked list and use the first successful module */
 454     p_tmp = p_first;
 455     while( p_tmp != NULL )
 456     {
 457         if( p_tmp->p_module->pf_activate
 458              && p_tmp->p_module->pf_activate( p_this ) == VLC_SUCCESS )
 459         {
 460             break;
 461         }
 462
 463         vlc_object_release( p_tmp->p_module );
 464         p_tmp = p_tmp->p_next;
 465     }
 466
 467     /* Store the locked module value */
 468     if( p_tmp != NULL )
 469     {
 470         p_module = p_tmp->p_module;
 471         p_tmp = p_tmp->p_next;
 472     }
 473     else
 474     {
 475         p_module = NULL;
 476     }
 477
 478     /* Unlock the remaining modules */
 479     while( p_tmp != NULL )
 480     {
 481         vlc_object_release( p_tmp->p_module );
 482         p_tmp = p_tmp->p_next;
 483     }
 484
 485     free( p_list );
 486
 487     if( p_module != NULL )
 488     {
 489         msg_Dbg( p_module, "using %s module \"%s\"",
 490                  psz_capability, p_module->psz_object_name );
 491     }
 492     else if( p_first == NULL )
 493     {
 494         msg_Err( p_this, "no %s module matched \"%s\"",
 495                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 496     }
 497     else if( psz_name != NULL && *psz_name )
 498     {
 499         msg_Err( p_this, "no %s module matching \"%s\" could be loaded",
 500                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 501     }
 502
 503     if( psz_shortcuts )
 504     {
 505         free( psz_shortcuts );
 506     }
 507
 508     if( psz_var )
 509     {
 510         free( psz_var );
 511     }
 512
 513     /* Don't forget that the module is still locked */
 514     return p_module;
 515 }
 516
 517 /*****************************************************************************
 518  * module_Unneed: decrease the usage count of a module.
 519  *****************************************************************************
 520  * This function must be called by the thread that called module_Need, to
 521  * decrease the reference count and allow for hiding of modules.
 522  *****************************************************************************/
 523 void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
 524 {
 525     /* Use the close method */
 526     if( p_module->pf_deactivate )
 527     {
 528         p_module->pf_deactivate( p_this );
 529     }
 530
 531     msg_Dbg( p_module, "unlocking module \"%s\"", p_module->psz_object_name );
 532
 533     vlc_object_release( p_module );
 534
 535     return;
 536 }
 537
 538 /*****************************************************************************
 539  * Following functions are local.
 540  *****************************************************************************/
 541
 542 /*****************************************************************************
 543  * AllocateAllPlugins: load all plugin modules we can find.
 544  *****************************************************************************/
 545 #ifdef HAVE_DYNAMIC_PLUGINS
 546 static void AllocateAllPlugins( vlc_object_t *p_this )
 547 {
 548     /* Yes, there are two NULLs because we replace one with "plugin-path". */
 549     char *          path[] = { "modules", PLUGIN_PATH, "plugins", NULL,
 550                                NULL };
 551
 552     char **         ppsz_path = path;
 553     char *          psz_fullpath;
 554 #if defined( SYS_BEOS ) || defined( SYS_DARWIN )
 555     char *          psz_vlcpath = system_GetProgramPath();
 556     int             i_vlclen = strlen( psz_vlcpath );
 557     vlc_bool_t      b_notinroot;
 558 #endif
 559
 560 #if defined( UNDER_CE )
 561     wchar_t         psz_dir[MAX_PATH];
 562 #endif
 563
 564     /* If the user provided a plugin path, we add it to the list */
 565     path[ sizeof(path)/sizeof(char*) - 2 ] = config_GetPsz( p_this,
 566                                                             "plugin-path" );
 567
 568     for( ; *ppsz_path != NULL ; ppsz_path++ )
 569     {
 570 #if defined( SYS_BEOS ) || defined( SYS_DARWIN )
 571         /* Store strlen(*ppsz_path) for later use. */
 572         int i_dirlen = strlen( *ppsz_path );
 573
 574         b_notinroot = VLC_FALSE;
 575         /* Under BeOS, we need to add beos_GetProgramPath() to access
 576          * files under the current directory */
 577         if( ( i_dirlen > 1 ) && strncmp( *ppsz_path, "/", 1 ) )
 578         {
 579             i_dirlen += i_vlclen + 2;
 580             b_notinroot = VLC_TRUE;
 581
 582             psz_fullpath = malloc( i_dirlen );
 583             if( psz_fullpath == NULL )
 584             {
 585                 continue;
 586             }
 587             sprintf( psz_fullpath, "%s/%s", psz_vlcpath, *ppsz_path );
 588         }
 589         else
 590 #endif
 591         {
 592             psz_fullpath = *ppsz_path;
 593         }
 594
 595         msg_Dbg( p_this, "recursively browsing `%s'", psz_fullpath );
 596
 597         /* Don't go deeper than 5 subdirectories */
 598 #if defined( UNDER_CE )
 599         MultiByteToWideChar( CP_ACP, 0, psz_fullpath, -1, psz_dir, MAX_PATH );
 600         AllocatePluginDir( p_this, psz_dir, 5 );
 601 #else
 602         AllocatePluginDir( p_this, psz_fullpath, 5 );
 603 #endif
 604
 605 #if defined( SYS_BEOS ) || defined( SYS_DARWIN )
 606         if( b_notinroot )
 607         {
 608             free( psz_fullpath );
 609         }
 610 #endif
 611     }
 612
 613     /* Free plugin-path */
 614     free( path[ sizeof(path)/sizeof(char*) - 2 ] );
 615     path[ sizeof(path)/sizeof(char*) - 2 ] = NULL;
 616 }
 617
 618 /*****************************************************************************
 619  * AllocatePluginDir: recursively parse a directory to look for plugins
 620  *****************************************************************************/
 621 static void AllocatePluginDir( vlc_object_t *p_this, const MYCHAR *psz_dir,
 622                                int i_maxdepth )
 623 {
 624 #ifdef UNDER_CE
 625     MYCHAR psz_path[MAX_PATH + 256];
 626     WIN32_FIND_DATA finddata;
 627     HANDLE handle;
 628     unsigned int rc;
 629 #else
 630     int    i_dirlen;
 631     DIR *  dir;
 632     char * psz_file;
 633     struct dirent * file;
 634 #endif
 635
 636     if( i_maxdepth < 0 )
 637     {
 638         return;
 639     }
 640
 641 #ifdef UNDER_CE
 642     rc = GetFileAttributes( psz_dir );
 643     if( !(rc & FILE_ATTRIBUTE_DIRECTORY) )
 644     {
 645         /* Not a directory */
 646         return;
 647     }
 648
 649     /* Parse all files in the directory */
 650     swprintf( psz_path, L"%s\\*.*", psz_dir );
 651     handle = FindFirstFile( psz_path, &finddata );
 652     if( handle == INVALID_HANDLE_VALUE )
 653     {
 654         /* Empty directory */
 655         return;
 656     }
 657
 658     /* Parse the directory and try to load all files it contains. */
 659     do
 660     {
 661         unsigned int i_len = wcslen( finddata.cFileName );
 662
 663         swprintf( psz_path, L"%s\\%s", psz_dir, finddata.cFileName );
 664
 665         if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
 666         {
 667             AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
 668         }
 669         else if( i_len > strlen( LIBEXT ) )
 670         {
 671             AllocatePluginFile( p_this, psz_path );
 672         }
 673     }
 674     while( FindNextFile( handle, &finddata ) );
 675
 676     /* Close the directory */
 677     FindClose( handle );
 678
 679 #else
 680     dir = opendir( psz_dir );
 681     if( !dir )
 682     {
 683         return;
 684     }
 685
 686     i_dirlen = strlen( psz_dir );
 687
 688     /* Parse the directory and try to load all files it contains. */
 689     while( (file = readdir( dir )) )
 690     {
 691         struct stat statbuf;
 692         unsigned int i_len;
 693
 694         /* Skip ".", ".." and anything starting with "." */
 695         if( !*file->d_name || *file->d_name == '.' )
 696         {
 697             continue;
 698         }
 699
 700         i_len = strlen( file->d_name );
 701         psz_file = malloc( i_dirlen + 1 + i_len + 1 );
 702         sprintf( psz_file, "%s/%s", psz_dir, file->d_name );
 703
 704         if( !stat( psz_file, &statbuf ) && statbuf.st_mode & S_IFDIR )
 705         {
 706             AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
 707         }
 708         else if( i_len > strlen( LIBEXT )
 709                   /* We only load files ending with LIBEXT */
 710                   && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
 711                                    LIBEXT, strlen( LIBEXT ) ) )
 712         {
 713             AllocatePluginFile( p_this, psz_file );
 714         }
 715
 716         free( psz_file );
 717     }
 718
 719     /* Close the directory */
 720     closedir( dir );
 721
 722 #endif
 723 }
 724
 725 /*****************************************************************************
 726  * AllocatePluginFile: load a module into memory and initialize it.
 727  *****************************************************************************
 728  * This function loads a dynamically loadable module and allocates a structure
 729  * for its information data. The module can then be handled by module_Need
 730  * and module_Unneed. It can be removed by DeleteModule.
 731  *****************************************************************************/
 732 static int AllocatePluginFile( vlc_object_t * p_this, MYCHAR * psz_file )
 733 {
 734     module_t * p_module;
 735     module_handle_t handle;
 736
 737 #ifdef UNDER_CE
 738     char psz_filename[MAX_PATH];
 739     WideCharToMultiByte( CP_ACP, WC_DEFAULTCHAR, psz_file, -1,
 740                          psz_filename, MAX_PATH, NULL, NULL );
 741 #else
 742     char * psz_filename = psz_file;
 743 #endif
 744
 745     /* Try to dynamically load the module. */
 746     if( module_load( psz_file, &handle ) )
 747     {
 748         char psz_buffer[256];
 749
 750         /* The plugin module couldn't be opened */
 751         msg_Warn( p_this, "cannot open `%s' (%s)",
 752                   psz_filename, module_error( psz_buffer ) );
 753         return -1;
 754     }
 755
 756     /* Now that we have successfully loaded the module, we can
 757      * allocate a structure for it */
 758     p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
 759     if( p_module == NULL )
 760     {
 761         msg_Err( p_this, "out of memory" );
 762         module_unload( handle );
 763         return -1;
 764     }
 765
 766     /* We need to fill these since they may be needed by CallEntry() */
 767     p_module->psz_filename = psz_filename;
 768     p_module->handle = handle;
 769     p_module->p_symbols = &p_this->p_libvlc->p_module_bank->symbols;
 770
 771     /* Initialize the module: fill p_module->psz_object_name, default config */
 772     if( CallEntry( p_module ) != 0 )
 773     {
 774         /* We couldn't call module_init() */
 775         vlc_object_destroy( p_module );
 776         module_unload( handle );
 777         return -1;
 778     }
 779
 780     DupModule( p_module );
 781     p_module->psz_filename = strdup( p_module->psz_filename );
 782     p_module->psz_longname = strdup( p_module->psz_longname );
 783
 784     /* Everything worked fine ! The module is ready to be added to the list. */
 785     p_module->b_builtin = VLC_FALSE;
 786
 787     /* msg_Dbg( p_this, "plugin \"%s\", %s",
 788                 p_module->psz_object_name, p_module->psz_longname ); */
 789
 790     vlc_object_attach( p_module, p_this->p_libvlc->p_module_bank );
 791
 792     return 0;
 793 }
 794
 795 /*****************************************************************************
 796  * DupModule: make a plugin module standalone.
 797  *****************************************************************************
 798  * This function duplicates all strings in the module, so that the dynamic
 799  * object can be unloaded. It acts recursively on submodules.
 800  *****************************************************************************/
 801 static void DupModule( module_t *p_module )
 802 {
 803     char **pp_shortcut;
 804     int i_submodule;
 805
 806     for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
 807     {
 808         *pp_shortcut = strdup( *pp_shortcut );
 809     }
 810
 811     /* We strdup() these entries so that they are still valid when the
 812      * module is unloaded. */
 813     p_module->psz_object_name = strdup( p_module->psz_object_name );
 814     p_module->psz_capability = strdup( p_module->psz_capability );
 815
 816     if( p_module->psz_program != NULL )
 817     {
 818         p_module->psz_program = strdup( p_module->psz_program );
 819     }
 820
 821     for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
 822     {
 823         DupModule( (module_t*)p_module->pp_children[ i_submodule ] );
 824     }
 825 }
 826
 827 /*****************************************************************************
 828  * UndupModule: free a duplicated module.
 829  *****************************************************************************
 830  * This function frees the allocations done in DupModule().
 831  *****************************************************************************/
 832 static void UndupModule( module_t *p_module )
 833 {
 834     char **pp_shortcut;
 835     int i_submodule;
 836
 837     for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
 838     {
 839         UndupModule( (module_t*)p_module->pp_children[ i_submodule ] );
 840     }
 841
 842     for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
 843     {
 844         free( *pp_shortcut );
 845     }
 846
 847     free( p_module->psz_object_name );
 848     free( p_module->psz_capability );
 849
 850     if( p_module->psz_program != NULL )
 851     {
 852         free( p_module->psz_program );
 853     }
 854 }
 855
 856 #endif /* HAVE_DYNAMIC_PLUGINS */
 857
 858 /*****************************************************************************
 859  * AllocateBuiltinModule: initialize a builtin module.
 860  *****************************************************************************
 861  * This function registers a builtin module and allocates a structure
 862  * for its information data. The module can then be handled by module_Need
 863  * and module_Unneed. It can be removed by DeleteModule.
 864  *****************************************************************************/
 865 static int AllocateBuiltinModule( vlc_object_t * p_this,
 866                                   int ( *pf_entry ) ( module_t * ) )
 867 {
 868     module_t * p_module;
 869
 870     /* Now that we have successfully loaded the module, we can
 871      * allocate a structure for it */
 872     p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
 873     if( p_module == NULL )
 874     {
 875         msg_Err( p_this, "out of memory" );
 876         return -1;
 877     }
 878
 879     /* Initialize the module : fill p_module->psz_object_name, etc. */
 880     if( pf_entry( p_module ) != 0 )
 881     {
 882         /* With a well-written module we shouldn't have to print an
 883          * additional error message here, but just make sure. */
 884         msg_Err( p_this, "failed calling entry point in builtin module" );
 885         vlc_object_destroy( p_module );
 886         return -1;
 887     }
 888
 889     /* Everything worked fine ! The module is ready to be added to the list. */
 890     p_module->b_builtin = VLC_TRUE;
 891
 892     /* msg_Dbg( p_this, "builtin \"%s\", %s",
 893                 p_module->psz_object_name, p_module->psz_longname ); */
 894
 895     vlc_object_attach( p_module, p_this->p_libvlc->p_module_bank );
 896
 897     return 0;
 898 }
 899
 900 /*****************************************************************************
 901  * DeleteModule: delete a module and its structure.
 902  *****************************************************************************
 903  * This function can only be called if the module isn't being used.
 904  *****************************************************************************/
 905 static int DeleteModule( module_t * p_module )
 906 {
 907     vlc_object_detach( p_module );
 908
 909     /* We free the structures that we strdup()ed in Allocate*Module(). */
 910 #ifdef HAVE_DYNAMIC_PLUGINS
 911     if( !p_module->b_builtin )
 912     {
 913         if( p_module->b_unloadable )
 914         {
 915             module_unload( p_module->handle );
 916         }
 917         UndupModule( p_module );
 918         free( p_module->psz_filename );
 919         free( p_module->psz_longname );
 920     }
 921 #endif
 922
 923     /* Free and detach the object's children */
 924     while( p_module->i_children )
 925     {
 926         vlc_object_t *p_this = p_module->pp_children[0];
 927         vlc_object_detach( p_this );
 928         vlc_object_destroy( p_this );
 929     }
 930
 931     config_Free( p_module );
 932     vlc_object_destroy( p_module );
 933
 934     return 0;
 935 }
 936
 937 #ifdef HAVE_DYNAMIC_PLUGINS
 938 /*****************************************************************************
 939  * CallEntry: call an entry point.
 940  *****************************************************************************
 941  * This function calls a symbol given its name and a module structure. The
 942  * symbol MUST refer to a function returning int and taking a module_t* as
 943  * an argument.
 944  *****************************************************************************/
 945 static int CallEntry( module_t * p_module )
 946 {
 947     static char *psz_name = "vlc_entry" MODULE_SUFFIX;
 948     int (* pf_symbol) ( module_t * p_module );
 949
 950     /* Try to resolve the symbol */
 951     pf_symbol = (int (*)(module_t *)) module_getsymbol( p_module->handle,
 952                                                         psz_name );
 953
 954     if( pf_symbol == NULL )
 955     {
 956         char psz_buffer[256];
 957
 958         /* We couldn't load the symbol */
 959         msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
 960                             psz_name, p_module->psz_filename,
 961                             module_error( psz_buffer ) );
 962         return -1;
 963     }
 964
 965     /* We can now try to call the symbol */
 966     if( pf_symbol( p_module ) != 0 )
 967     {
 968         /* With a well-written module we shouldn't have to print an
 969          * additional error message here, but just make sure. */
 970         msg_Err( p_module, "failed calling symbol \"%s\" in file `%s'",
 971                            psz_name, p_module->psz_filename );
 972         return -1;
 973     }
 974
 975     /* Everything worked fine, we can return */
 976     return 0;
 977 }
 978 #endif /* HAVE_DYNAMIC_PLUGINS */