]> git.sesse.net Git - vlc/blobdiff - src/misc/modules.c
* String review, round one
[vlc] / src / misc / modules.c
index b2e6f0abb3103c779560b048d20b362ca73aed4b..5046059eb0a9f038fc0f53e03dcb816238ce7877 100644 (file)
@@ -1,10 +1,10 @@
 /*****************************************************************************
  * modules.c : Builtin and plugin modules management functions
  *****************************************************************************
- * Copyright (C) 2001 VideoLAN
- * $Id: modules.c,v 1.117 2003/03/25 15:38:14 gbazin Exp $
+ * Copyright (C) 2001-2004 VideoLAN
+ * $Id: modules.c,v 1.144 2004/01/25 17:16:06 zorglub Exp $
  *
- * Authors: Samuel Hocevar <sam@zoy.org>
+ * Authors: Sam Hocevar <sam@zoy.org>
  *          Ethan C. Baldridge <BaldridgeE@cadmus.com>
  *          Hans-Peter Jansen <hpj@urpla.net>
  *
 #   include <unistd.h>
 #endif
 
-#if defined(HAVE_DLFCN_H)                                /* Linux, BSD, Hurd */
-#   include <dlfcn.h>                        /* dlopen(), dlsym(), dlclose() */
-#   define HAVE_DYNAMIC_PLUGINS
-#elif defined(HAVE_IMAGE_H)                                          /* BeOS */
-#   include <image.h>
-#   define HAVE_DYNAMIC_PLUGINS
-#elif defined(UNDER_CE)
-#   define HAVE_DYNAMIC_PLUGINS
-#elif defined(WIN32)
-#   define HAVE_DYNAMIC_PLUGINS
+#define HAVE_DYNAMIC_PLUGINS
+#if defined(HAVE_DL_DYLD)
+#   if defined(HAVE_MACH_O_DYLD_H)
+#       include <mach-o/dyld.h>
+#   endif
+#elif defined(HAVE_DL_BEOS)
+#   if defined(HAVE_IMAGE_H)
+#       include <image.h>
+#   endif
+#elif defined(HAVE_DL_WINDOWS)
+#   include <windows.h>
+#elif defined(HAVE_DL_DLOPEN)
+#   if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
+#       include <dlfcn.h>
+#   endif
+#   if defined(HAVE_SYS_DL_H)
+#       include <sys/dl.h>
+#   endif
+#elif defined(HAVE_DL_SHL_LOAD)
+#   if defined(HAVE_DL_H)
+#       include <dl.h>
+#   endif
 #else
 #   undef HAVE_DYNAMIC_PLUGINS
 #endif
 
-#include "error.h"
-#include "netutils.h"
+#include "vlc_error.h"
 
-#include "interface.h"
+#include "vlc_interface.h"
 #include "vlc_playlist.h"
 #include "intf_eject.h"
 
 #include "input_ext-intf.h"
 #include "input_ext-dec.h"
 #include "input_ext-plugins.h"
+#include "ninput.h"
 
-#include "video.h"
+#include "vlc_video.h"
 #include "video_output.h"
+#include "vout_synchro.h"
 
 #include "audio_output.h"
 #include "aout_internal.h"
 
 #include "stream_output.h"
+#include "osd.h"
 
 #include "iso_lang.h"
+#include "charset.h"
+
+#include "vlc_block.h"
 
 #if defined( UNDER_CE )
 #   define MYCHAR wchar_t
 #else
 #    include "modules_builtin.h"
 #endif
+#include "network.h"
 
 /*****************************************************************************
  * Local prototypes
@@ -118,9 +136,14 @@ static int  AllocatePluginFile   ( vlc_object_t *, MYCHAR * );
 static int  AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
 static int  DeleteModule ( module_t * );
 #ifdef HAVE_DYNAMIC_PLUGINS
-static void DupModule    ( module_t * );
-static void UndupModule  ( module_t * );
-static int  CallEntry    ( module_t * );
+static void   DupModule        ( module_t * );
+static void   UndupModule      ( module_t * );
+static int    CallEntry        ( module_t * );
+static void   CloseModule      ( module_handle_t );
+static void * GetSymbol        ( module_handle_t, const char * );
+#if defined(HAVE_DL_WINDOWS)
+static char * GetWindowsError  ( void );
+#endif
 #endif
 
 /*****************************************************************************
@@ -265,7 +288,10 @@ module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
     /* Deal with variables */
     if( psz_name && psz_name[0] == '$' )
     {
-        psz_var = config_GetPsz( p_this, psz_name + 1 );
+        vlc_value_t val;
+        var_Create( p_this, psz_name + 1, VLC_VAR_MODULE | VLC_VAR_DOINHERIT );
+        var_Get( p_this, psz_name + 1, &val );
+        psz_var = val.psz_string;
         psz_name = psz_var;
     }
 
@@ -361,8 +387,8 @@ module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
 
                 for( i_dummy = 0; p_module->pp_shortcuts[i_dummy]; i_dummy++ )
                 {
-                    if( !strcmp( psz_name,
-                                 p_module->pp_shortcuts[i_dummy] ) )
+                    if( !strcasecmp( psz_name,
+                                     p_module->pp_shortcuts[i_dummy] ) )
                     {
                         /* Found it */
                         b_trash = VLC_FALSE;
@@ -398,7 +424,7 @@ module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
         }
 
         /* Special case: test if we requested a particular intf plugin */
-        if( p_module->psz_program
+        if( !i_shortcuts && p_module->psz_program
              && !strcmp( p_module->psz_program,
                          p_this->p_vlc->psz_object_name ) )
         {
@@ -568,11 +594,6 @@ static void AllocateAllPlugins( vlc_object_t *p_this )
 
     char **         ppsz_path = path;
     char *          psz_fullpath;
-#if defined( SYS_BEOS ) || defined( SYS_DARWIN ) \
-     || ( defined( WIN32 ) && !defined( UNDER_CE ) )
-    int             i_vlclen = strlen( p_this->p_libvlc->psz_vlcpath );
-    vlc_bool_t      b_notinroot;
-#endif
 
 #if defined( UNDER_CE )
     wchar_t         psz_dir[MAX_PATH];
@@ -582,34 +603,20 @@ static void AllocateAllPlugins( vlc_object_t *p_this )
     path[ sizeof(path)/sizeof(char*) - 2 ] = config_GetPsz( p_this,
                                                             "plugin-path" );
 
-#if defined( WIN32 ) && !defined( UNDER_CE ) && !defined( _MSC_VER )
-    /* If there is no 'plugins' nor 'modules' subdirectory, the user may have
-     * screwed up the unzipping stage, so we look into '.' instead */
-    if( !opendir( "plugins" ) && !opendir( "modules" )
-        && !strcmp( *ppsz_path, "modules" ) )
-    {
-        *ppsz_path = ".";
-    }
-#endif
-
     for( ; *ppsz_path != NULL ; ppsz_path++ )
     {
 #if defined( SYS_BEOS ) || defined( SYS_DARWIN ) \
      || ( defined( WIN32 ) && !defined( UNDER_CE ) )
-        /* Store strlen(*ppsz_path) for later use. */
-        int i_dirlen = strlen( *ppsz_path );
 
-        b_notinroot = VLC_FALSE;
-        /* Under BeOS, we need to add beos_GetProgramPath() to access
-         * files under the current directory */
+        /* Handle relative as well as absolute paths */
 #ifdef WIN32
-        if( i_dirlen < 3 || (*ppsz_path)[3] != '\\' )
+        if( !(*ppsz_path)[0] || (*ppsz_path)[1] != ':' )
 #else
         if( (*ppsz_path)[0] != '/' )
 #endif
         {
-            i_dirlen += i_vlclen + 2;
-            b_notinroot = VLC_TRUE;
+            int i_dirlen = strlen( *ppsz_path );
+            i_dirlen += strlen( p_this->p_libvlc->psz_vlcpath ) + 2;
 
             psz_fullpath = malloc( i_dirlen );
             if( psz_fullpath == NULL )
@@ -627,7 +634,7 @@ static void AllocateAllPlugins( vlc_object_t *p_this )
         else
 #endif
         {
-            psz_fullpath = *ppsz_path;
+            psz_fullpath = strdup( *ppsz_path );
         }
 
         msg_Dbg( p_this, "recursively browsing `%s'", psz_fullpath );
@@ -640,16 +647,12 @@ static void AllocateAllPlugins( vlc_object_t *p_this )
         AllocatePluginDir( p_this, psz_fullpath, 5 );
 #endif
 
-#if defined( SYS_BEOS ) || defined( SYS_DARWIN )
-        if( b_notinroot )
-        {
-            free( psz_fullpath );
-        }
-#endif
+        free( psz_fullpath );
     }
 
     /* Free plugin-path */
-    free( path[ sizeof(path)/sizeof(char*) - 2 ] );
+    if( path[ sizeof(path)/sizeof(char*) - 2 ] )
+        free( path[ sizeof(path)/sizeof(char*) - 2 ] );
     path[ sizeof(path)/sizeof(char*) - 2 ] = NULL;
 }
 
@@ -675,7 +678,7 @@ static void AllocatePluginDir( vlc_object_t *p_this, const MYCHAR *psz_dir,
     struct dirent * file;
 #endif
 
-    if( i_maxdepth < 0 )
+    if( p_this->p_vlc->b_die || i_maxdepth < 0 )
     {
         return;
     }
@@ -735,7 +738,7 @@ static void AllocatePluginDir( vlc_object_t *p_this, const MYCHAR *psz_dir,
             AllocatePluginFile( p_this, psz_path );
         }
     }
-    while( FindNextFile( handle, &finddata ) );
+    while( !p_this->p_vlc->b_die && FindNextFile( handle, &finddata ) );
 
     /* Close the directory */
     FindClose( handle );
@@ -750,7 +753,7 @@ static void AllocatePluginDir( vlc_object_t *p_this, const MYCHAR *psz_dir,
     i_dirlen = strlen( psz_dir );
 
     /* Parse the directory and try to load all files it contains. */
-    while( (file = readdir( dir )) )
+    while( !p_this->p_vlc->b_die && (file = readdir( dir )) )
     {
         struct stat statbuf;
         unsigned int i_len;
@@ -802,37 +805,155 @@ static int AllocatePluginFile( vlc_object_t * p_this, MYCHAR * psz_file )
     module_t * p_module;
     module_handle_t handle;
 
-#ifdef UNDER_CE
+    /*
+     * Try to dynamically load the module. This part is very platform-
+     * specific, and error messages should be as verbose as possible.
+     */
+
+#if defined(HAVE_DL_DYLD)
+    NSObjectFileImage image;
+    NSObjectFileImageReturnCode ret;
+
+    ret = NSCreateObjectFileImageFromFile( psz_file, &image );
+
+    if( ret != NSObjectFileImageSuccess )
+    {
+        msg_Warn( p_this, "cannot create image from `%s'", psz_file );
+        return -1;
+    }
+
+    /* Open the dynamic module */
+    handle = NSLinkModule( image, psz_file,
+                           NSLINKMODULE_OPTION_RETURN_ON_ERROR );
+
+    if( !handle )
+    {
+        NSLinkEditErrors errors;
+        const char *psz_file, *psz_err;
+        int i_errnum;
+        NSLinkEditError( &errors, &i_errnum, &psz_file, &psz_err );
+        msg_Warn( p_this, "cannot link module `%s' (%s)", psz_file, psz_err );
+        NSDestroyObjectFileImage( image );
+        return -1;
+    }
+
+    /* Destroy our image, we won't need it */
+    NSDestroyObjectFileImage( image );
+
+#elif defined(HAVE_DL_BEOS)
+    handle = load_add_on( psz_file );
+    if( handle < 0 )
+    {
+        msg_Warn( p_this, "cannot load module `%s'", psz_file );
+        return -1;
+    }
+
+#elif defined(HAVE_DL_WINDOWS) && defined(UNDER_CE)
     char psz_filename[MAX_PATH];
     WideCharToMultiByte( CP_ACP, WC_DEFAULTCHAR, psz_file, -1,
                          psz_filename, MAX_PATH, NULL, NULL );
-#else
-    char * psz_filename = psz_file;
-#endif
+    handle = LoadLibrary( psz_filename );
+    if( handle == NULL )
+    {
+        char *psz_error = GetWindowsError();
+        msg_Warn( p_this, "cannot load module `%s' (%s)",
+                          psz_filename, psz_error );
+        free( psz_error );
+    }
+
+#elif defined(HAVE_DL_WINDOWS) && defined(WIN32)
+    handle = LoadLibrary( psz_file );
+    if( handle == NULL )
+    {
+        char *psz_error = GetWindowsError();
+        msg_Warn( p_this, "cannot load module `%s' (%s)",
+                          psz_file, psz_error );
+        free( psz_error );
+    }
+
+#elif defined(HAVE_DL_DLOPEN) && defined(RTLD_NOW)
+    /* static is OK, we are called atomically */
+    static vlc_bool_t b_kde = VLC_FALSE;
 
-    /* Try to dynamically load the module. */
-    if( module_load( psz_file, &handle ) )
+#   if defined(SYS_LINUX)
+    /* XXX HACK #1 - we should NOT open modules with RTLD_GLOBAL, or we
+     * are going to get namespace collisions when two modules have common
+     * public symbols, but ALSA is being a pest here. */
+    if( strstr( psz_file, "alsa_plugin" ) )
     {
-        char psz_buffer[256];
+        handle = dlopen( psz_file, RTLD_NOW | RTLD_GLOBAL );
+        if( handle == NULL )
+        {
+            msg_Warn( p_this, "cannot load module `%s' (%s)",
+                              psz_file, dlerror() );
+            return -1;
+        }
+    }
+#   endif
+    /* XXX HACK #2 - the ugly KDE workaround. It seems that libkdewhatever
+     * causes dlopen() to segfault if libstdc++ is not loaded in the caller,
+     * so we just load libstdc++. Bwahahaha! ph34r! -- Sam. */
+    /* Update: FYI, this is Debian bug #180505, and seems to be fixed. */
+    if( !b_kde && !strstr( psz_file, "kde" ) )
+    {
+        dlopen( "libstdc++.so.6", RTLD_NOW )
+         || dlopen( "libstdc++.so.5", RTLD_NOW )
+         || dlopen( "libstdc++.so.4", RTLD_NOW )
+         || dlopen( "libstdc++.so.3", RTLD_NOW );
+        b_kde = VLC_TRUE;
+    }
 
-        /* The plugin module couldn't be opened */
-        msg_Warn( p_this, "cannot open `%s' (%s)",
-                  psz_filename, module_error( psz_buffer ) );
+    handle = dlopen( psz_file, RTLD_NOW );
+    if( handle == NULL )
+    {
+        msg_Warn( p_this, "cannot load module `%s' (%s)",
+                          psz_file, dlerror() );
         return -1;
     }
 
+#elif defined(HAVE_DL_DLOPEN)
+#   if defined(DL_LAZY)
+    handle = dlopen( psz_file, DL_LAZY );
+#   else
+    handle = dlopen( psz_file, 0 );
+#   endif
+    if( handle == NULL )
+    {
+        msg_Warn( p_this, "cannot load module `%s' (%s)",
+                          psz_file, dlerror() );
+        return -1;
+    }
+
+#elif defined(HAVE_DL_SHL_LOAD)
+    handle = shl_load( psz_file, BIND_IMMEDIATE | BIND_NONFATAL, NULL );
+    if( handle == NULL )
+    {
+        msg_Warn( p_this, "cannot load module `%s' (%s)",
+                          psz_file, strerror(errno) );
+        return -1;
+    }
+
+#else
+#   error "Something is wrong in modules.c"
+
+#endif
+
     /* Now that we have successfully loaded the module, we can
      * allocate a structure for it */
     p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
     if( p_module == NULL )
     {
         msg_Err( p_this, "out of memory" );
-        module_unload( handle );
+        CloseModule( handle );
         return -1;
     }
 
     /* We need to fill these since they may be needed by CallEntry() */
+#ifdef UNDER_CE
     p_module->psz_filename = psz_filename;
+#else
+    p_module->psz_filename = psz_file;
+#endif
     p_module->handle = handle;
     p_module->p_symbols = &p_this->p_libvlc->p_module_bank->symbols;
 
@@ -841,7 +962,7 @@ static int AllocatePluginFile( vlc_object_t * p_this, MYCHAR * psz_file )
     {
         /* We couldn't call module_init() */
         vlc_object_destroy( p_module );
-        module_unload( handle );
+        CloseModule( handle );
         return -1;
     }
 
@@ -980,7 +1101,7 @@ static int DeleteModule( module_t * p_module )
     {
         if( p_module->b_unloadable )
         {
-            module_unload( p_module->handle );
+            CloseModule( p_module->handle );
         }
         UndupModule( p_module );
         free( p_module->psz_filename );
@@ -1016,17 +1137,27 @@ static int CallEntry( module_t * p_module )
     int (* pf_symbol) ( module_t * p_module );
 
     /* Try to resolve the symbol */
-    pf_symbol = (int (*)(module_t *)) module_getsymbol( p_module->handle,
-                                                        psz_name );
+    pf_symbol = (int (*)(module_t *)) GetSymbol( p_module->handle, psz_name );
 
     if( pf_symbol == NULL )
     {
-        char psz_buffer[256];
-
-        /* We couldn't load the symbol */
+#if defined(HAVE_DL_DYLD) || defined(HAVE_DL_BEOS)
+        msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s'",
+                            psz_name, p_module->psz_filename );
+#elif defined(HAVE_DL_WINDOWS)
+        char *psz_error = GetWindowsError();
+        msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
+                            psz_name, p_module->psz_filename, psz_error );
+        free( psz_error );
+#elif defined(HAVE_DL_DLOPEN)
         msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
-                            psz_name, p_module->psz_filename,
-                            module_error( psz_buffer ) );
+                            psz_name, p_module->psz_filename, dlerror() );
+#elif defined(HAVE_DL_SHL_LOAD)
+        msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
+                            psz_name, p_module->psz_filename, strerror(errno) );
+#else
+#   error "Something is wrong in modules.c"
+#endif
         return -1;
     }
 
@@ -1043,4 +1174,147 @@ static int CallEntry( module_t * p_module )
     /* Everything worked fine, we can return */
     return 0;
 }
+
+/*****************************************************************************
+ * CloseModule: unload a dynamic library
+ *****************************************************************************
+ * This function unloads a previously opened dynamically linked library
+ * using a system dependant method. No return value is taken in consideration,
+ * since some libraries sometimes refuse to close properly.
+ *****************************************************************************/
+static void CloseModule( module_handle_t handle )
+{
+#if defined(HAVE_DL_DYLD)
+    NSUnLinkModule( handle, FALSE );
+
+#elif defined(HAVE_DL_BEOS)
+    unload_add_on( handle );
+
+#elif defined(HAVE_DL_WINDOWS)
+    FreeLibrary( handle );
+
+#elif defined(HAVE_DL_DLOPEN)
+    dlclose( handle );
+
+#elif defined(HAVE_DL_SHL_LOAD)
+    shl_unload( handle );
+
+#endif
+    return;
+}
+
+/*****************************************************************************
+ * GetSymbol: get a symbol from a dynamic library
+ *****************************************************************************
+ * This function queries a loaded library for a symbol specified in a
+ * string, and returns a pointer to it. We don't check for dlerror() or
+ * similar functions, since we want a non-NULL symbol anyway.
+ *****************************************************************************/
+static void * _module_getsymbol( module_handle_t, const char * );
+
+static void * GetSymbol( module_handle_t handle, const char * psz_function )
+{
+    void * p_symbol = _module_getsymbol( handle, psz_function );
+
+    /* MacOS X dl library expects symbols to begin with "_". So do
+     * some other operating systems. That's really lame, but hey, what
+     * can we do ? */
+    if( p_symbol == NULL )
+    {
+        char *psz_call = malloc( strlen( psz_function ) + 2 );
+
+        strcpy( psz_call + 1, psz_function );
+        psz_call[ 0 ] = '_';
+        p_symbol = _module_getsymbol( handle, psz_call );
+        free( psz_call );
+    }
+
+    return p_symbol;
+}
+
+static void * _module_getsymbol( module_handle_t handle,
+                                 const char * psz_function )
+{
+#if defined(HAVE_DL_DYLD)
+    NSSymbol sym = NSLookupSymbolInModule( handle, psz_function );
+    return NSAddressOfSymbol( sym );
+
+#elif defined(HAVE_DL_BEOS)
+    void * p_symbol;
+    if( B_OK == get_image_symbol( handle, psz_function,
+                                  B_SYMBOL_TYPE_TEXT, &p_symbol ) )
+    {
+        return p_symbol;
+    }
+    else
+    {
+        return NULL;
+    }
+
+#elif defined(HAVE_DL_WINDOWS) && defined(UNDER_CE)
+    wchar_t psz_real[256];
+    MultiByteToWideChar( CP_ACP, 0, psz_function, -1, psz_real, 256 );
+
+    return (void *)GetProcAddress( handle, psz_real );
+
+#elif defined(HAVE_DL_WINDOWS) && defined(WIN32)
+    return (void *)GetProcAddress( handle, (MYCHAR*)psz_function );
+
+#elif defined(HAVE_DL_DLOPEN)
+    return dlsym( handle, psz_function );
+
+#elif defined(HAVE_DL_SHL_LOAD)
+    void *p_sym;
+    shl_findsym( &handle, psz_function, TYPE_UNDEFINED, &p_sym );
+    return p_sym;
+
+#endif
+}
+
+#if defined(HAVE_DL_WINDOWS)
+static char * GetWindowsError( void )
+{
+#if defined(UNDER_CE)
+    wchar_t psz_tmp[256];
+    char * psz_buffer = malloc( 256 );
+#else
+    char * psz_tmp = malloc( 256 );
+#endif
+    int i = 0, i_error = GetLastError();
+
+    FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
+                   NULL, i_error, MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT),
+                   (LPTSTR) psz_tmp, 256, NULL );
+
+    /* Go to the end of the string */
+#if defined(UNDER_CE)
+    while( psz_tmp[i] && psz_tmp[i] != L'\r' && psz_tmp[i] != L'\n' )
+#else
+    while( psz_tmp[i] && psz_tmp[i] != '\r' && psz_tmp[i] != '\n' )
+#endif
+    {
+        i++;
+    }
+
+    if( psz_tmp[i] )
+    {
+#if defined(UNDER_CE)
+        swprintf( psz_tmp + i, L" (error %i)", i_error );
+        psz_tmp[ 255 ] = L'\0';
+#else
+        snprintf( psz_tmp + i, 256 - i, " (error %i)", i_error );
+        psz_tmp[ 255 ] = '\0';
+#endif
+    }
+
+#if defined(UNDER_CE)
+    WideCharToMultiByte( CP_ACP, WC_DEFAULTCHAR, psz_tmp, -1,
+                         psz_buffer, 256, NULL, NULL );
+    return psz_buffer;
+#else
+    return psz_tmp;
+#endif
+}
+#endif /* HAVE_DL_WINDOWS */
+
 #endif /* HAVE_DYNAMIC_PLUGINS */