]> git.sesse.net Git - vlc/blobdiff - src/misc/modules.c
* Ported Glide and MGA plugins to the new module API. MGA never worked,
[vlc] / src / misc / modules.c
index 334e3a0cf9814349fa8381e92aa00ab6993e26b3..307ea544345f3fb8e7271232c8019a69f06edc9a 100644 (file)
 
 #include "config.h"
 
+/* Some faulty libcs have a broken struct dirent when _FILE_OFFSET_BITS
+ * is set to 64. Don't try to be cleverer. */
+#ifdef _FILE_OFFSET_BITS
+#undef _FILE_OFFSET_BITS
+#endif
+
 #include <stdlib.h>                                      /* free(), strtol() */
 #include <stdio.h>                                              /* sprintf() */
 #include <string.h>                                              /* strdup() */
@@ -55,6 +61,8 @@
 static int AllocateDynModule( module_bank_t * p_bank, char * psz_filename );
 static int HideModule( module_t * p_module );
 static int FreeModule( module_bank_t * p_bank, module_t * p_module );
+static int LockModule( module_t * p_module );
+static int UnlockModule( module_t * p_module );
 static int CallSymbol( module_t * p_module, char * psz_name );
 
 /*****************************************************************************
@@ -79,13 +87,15 @@ module_bank_t * module_CreateBank( void )
  *****************************************************************************/
 void module_InitBank( module_bank_t * p_bank )
 {
-    static char * path[] = { ".", "lib", PLUGIN_PATH, NULL } ;
+    static char * path[] = { ".", "lib", PLUGIN_PATH, NULL };
 
     char **         ppsz_path = path;
+    char *          psz_fullpath;
     char *          psz_file;
 #ifdef SYS_BEOS
-    char *          psz_program_path = beos_GetProgramPath();
-    int             i_programlen = strlen( psz_program_path );
+    char *          psz_vlcpath = beos_GetProgramPath();
+    int             i_vlclen = strlen( psz_vlcpath );
+    boolean_t       b_notinroot;
 #endif
     DIR *           dir;
     struct dirent * file;
@@ -93,15 +103,39 @@ void module_InitBank( module_bank_t * p_bank )
     p_bank->first = NULL;
     vlc_mutex_init( &p_bank->lock );
 
-    intf_Msg( "module: module bank initialized" );
+    intf_WarnMsg( 1, "module: module bank initialized" );
 
     for( ; *ppsz_path != NULL ; ppsz_path++ )
     {
-        if( (dir = opendir( *ppsz_path )) )
+        /* Store strlen(*ppsz_path) for later use. */
+        int i_dirlen = strlen( *ppsz_path );
+
+#ifdef SYS_BEOS
+        b_notinroot = 0;
+        /* Under BeOS, we need to add beos_GetProgramPath() to access
+         * files under the current directory */
+        if( ( i_dirlen > 1 ) && strncmp( *ppsz_path, "/", 1 ) )
         {
-            /* Store strlen(*ppsz_path) for later use. */
-            int i_dirlen = strlen( *ppsz_path );
+            i_dirlen += i_vlclen + 2;
+            b_notinroot = 1;
 
+            psz_fullpath = malloc( i_dirlen );
+            if( psz_fullpath == NULL )
+            {
+                continue;
+            }
+            sprintf( psz_fullpath, "%s/%s", psz_vlcpath, *ppsz_path );
+        }
+        else
+#endif
+        {
+            psz_fullpath = *ppsz_path;
+        }
+
+        intf_WarnMsgImm( 2, "module: browsing %s", psz_fullpath );
+
+        if( (dir = opendir( psz_fullpath )) )
+        {
             /* Parse the directory and try to load all files it contains. */
             while( (file = readdir( dir )) )
             {
@@ -109,32 +143,15 @@ void module_InitBank( module_bank_t * p_bank )
 
                 /* We only load files ending with ".so" */
                 if( i_filelen > 3
-                        && !strcmp( file->d_name + i_filelen - 3, ".so" ) )
+                        && !strncmp( file->d_name + i_filelen - 3, ".so", 3 ) )
                 {
-#ifdef SYS_BEOS
-                    /* Under BeOS, we need to add beos_GetProgramPath() to
-                     * access files under the current directory */
-                    if( memcmp( file->d_name, "/", 1 ) )
+                    psz_file = malloc( i_dirlen + i_filelen + 2 );
+                    if( psz_file == NULL )
                     {
-                        psz_file = malloc( i_programlen + i_dirlen
-                                               + i_filelen + 3 );
-                        if( psz_file == NULL )
-                        {
-                            continue;
-                        }
-                        sprintf( psz_file, "%s/%s/%s", psz_programlen,
-                                 *ppsz_path, file->d_name );
-                    }
-                    else
-#endif
-                    {
-                        psz_file = malloc( i_dirlen + i_filelen + 2 );
-                        if( psz_file == NULL )
-                        {
-                            continue;
-                        }
-                        sprintf( psz_file, "%s/%s", *ppsz_path, file->d_name );
+                        continue;
                     }
+                    sprintf( psz_file, "%s/%s", psz_fullpath, file->d_name );
+
                     /* We created a nice filename -- now we just try to load
                      * it as a dynamic module. */
                     AllocateDynModule( p_bank, psz_file );
@@ -143,7 +160,17 @@ void module_InitBank( module_bank_t * p_bank )
                     free( psz_file );
                 }
             }
+
+            /* Close the directory if successfully opened */
+            closedir( dir );
         }
+
+#ifdef SYS_BEOS
+        if( b_notinroot )
+        {
+            free( psz_fullpath );
+        }
+#endif
     }
 
     return;
@@ -174,6 +201,9 @@ void module_DestroyBank( module_bank_t * p_bank )
         }
     }
 
+    /* Destroy the lock */
+    vlc_mutex_destroy( &p_bank->lock );
+    
     /* We can free the module bank */
     free( p_bank );
 
@@ -219,8 +249,8 @@ void module_ManageBank( module_bank_t * p_bank )
             }
             else
             {
-                intf_Msg( "module: hiding unused module `%s'",
-                          p_module->psz_name );
+                intf_WarnMsg( 1, "module: hiding unused module `%s'",
+                              p_module->psz_name );
                 HideModule( p_module );
             }
         }
@@ -233,87 +263,107 @@ void module_ManageBank( module_bank_t * p_bank )
 }
 
 /*****************************************************************************
- * module_Need: increase the usage count of a module and load it if needed.
+ * module_Need: return the best module function, given a capability list.
  *****************************************************************************
- * This function has to be called before a thread starts using a module. If
- * the module is already loaded, we just increase its usage count. If it isn't
- * loaded, we have to dynamically open it and initialize it.
- * If you successfully call module_Need() at any moment, be careful to call
- * module_Unneed() when you don't need it anymore.
+ * This function returns the module that best fits the asked capabilities.
  *****************************************************************************/
-int module_Need( module_t * p_module )
+module_t * module_Need( module_bank_t *p_bank,
+                        int i_capabilities, void *p_data )
 {
-    if( p_module->i_usage >= 0 )
-    {
-        /* This module is already loaded and activated, we can return */
-        p_module->i_usage++;
-        return( 0 );
-    }
+    module_t * p_module;
+    module_t * p_bestmodule = NULL;
+    int i_score, i_totalscore, i_bestscore = 0;
+    int i_index;
 
-    if( p_module->b_builtin )
-    {
-        /* A built-in module should always have a refcount >= 0 ! */
-        intf_ErrMsg( "module error: built-in module `%s' has refcount %i",
-                     p_module->psz_name, p_module->i_usage );
-        return( -1 );
-    }
+    /* We take the global lock */
+    vlc_mutex_lock( &p_bank->lock );
 
-    if( p_module->i_usage != -1 )
+    /* Parse the module list for capabilities and probe each of them */
+    for( p_module = p_bank->first ;
+         p_module != NULL ;
+         p_module = p_module->next )
     {
-        /* This shouldn't happen. Ever. We have serious problems here. */
-        intf_ErrMsg( "module error: dynamic module `%s' has refcount %i",
-                     p_module->psz_name, p_module->i_usage );
-        return( -1 );
-    }
+        /* Test that this module can do everything we need */
+        if( ( p_module->i_capabilities & i_capabilities ) == i_capabilities )
+        {
+            i_totalscore = 0;
 
-    /* i_usage == -1, which means that the module isn't in memory */
-    if( ! module_load( p_module->psz_filename, &p_module->handle ) )
-    {
-        /* The dynamic module couldn't be opened */
-        intf_ErrMsg( "module error: cannot open %s (%s)",
-                     p_module->psz_filename, module_error() );
-        return( -1 );
+            LockModule( p_module );
+
+            /* Parse all the requested capabilities and test them */
+            for( i_index = 0 ; (1 << i_index) <= i_capabilities ; i_index++ )
+            {
+                if( ( (1 << i_index) & i_capabilities ) )
+                {
+                    i_score = ( (function_list_t *)p_module->p_functions)
+                                                  [i_index].pf_probe( p_data );
+
+                    if( i_score )
+                    {
+                        i_totalscore += i_score;
+                    }
+                    else
+                    {
+                        break;
+                    }
+                }
+            }
+
+            /* If the high score was broken, we have a new champion */
+            if( i_totalscore > i_bestscore )
+            {
+                /* Keep the current module locked, but release the previous */
+                if( p_bestmodule != NULL )
+                {
+                    UnlockModule( p_bestmodule );
+                }
+
+                /* This is the new best module */
+                i_bestscore = i_totalscore;
+                p_bestmodule = p_module;
+            }
+            else
+            {
+                /* This module wasn't interesting, unlock it and forget it */
+                UnlockModule( p_module );
+            }
+        }
     }
 
-    if( CallSymbol( p_module, "ActivateModule" ) != 0 )
+    /* We release the global lock */
+    vlc_mutex_unlock( &p_bank->lock );
+
+    if( p_bestmodule != NULL )
     {
-        /* We couldn't call ActivateModule() -- looks nasty, but
-         * we can't do much about it. Just try to unload module. */
-        module_unload( p_module->handle );
-        p_module->i_usage = -1;
-        return( -1 );
+        intf_WarnMsg( 1, "module: locking module `%s'",
+                      p_bestmodule->psz_name );
     }
 
-    /* Everything worked fine ! The module is ready to be used */
-    p_module->i_usage = 1;
-
-    return( 0 );
+    /* Don't forget that the module is still locked if bestmodule != NULL */
+    return( p_bestmodule );
 }
 
 /*****************************************************************************
  * module_Unneed: decrease the usage count of a module.
  *****************************************************************************
- * This function has to be called before a thread starts using a module. If
- * the module is already loaded, we just increase its usage count. If it isn't
- * loaded, we have to dynamically open it and initialize it.
- * If you successfully call module_Need() at any moment, be careful to call
- * module_Unneed() when you don't need it anymore.
+ * This function must be called by the thread that called module_Need, to
+ * decrease the reference count and allow for hiding of modules.
  *****************************************************************************/
-int module_Unneed( module_t * p_module )
+void module_Unneed( module_bank_t * p_bank, module_t * p_module )
 {
-    if( p_module->i_usage <= 0 )
-    {
-        /* This shouldn't happen. Ever. We have serious problems here. */
-        intf_ErrMsg( "module error: trying to call module_Unneed() on `%s'"
-                     " which isn't even in use", p_module->psz_name );
-        return( -1 );
-    }
+    /* We take the global lock */
+    vlc_mutex_lock( &p_bank->lock );
 
-    /* This module is still in use, we can return */
-    p_module->i_usage--;
-    p_module->i_unused_delay = 0;
+    /* Just unlock the module - we can't do anything if it fails,
+     * so there is no need to check the return value. */
+    UnlockModule( p_module );
 
-    return( 0 );
+    intf_WarnMsg( 1, "module: unlocking module `%s'", p_module->psz_name );
+
+    /* We release the global lock */
+    vlc_mutex_unlock( &p_bank->lock );
+
+    return;
 }
 
 /*****************************************************************************
@@ -329,15 +379,15 @@ int module_Unneed( module_t * p_module )
  *****************************************************************************/
 static int AllocateDynModule( module_bank_t * p_bank, char * psz_filename )
 {
-    module_t * p_module;
+    module_t * p_module, * p_othermodule;
     module_handle_t handle;
 
     /* Try to dynamically load the module. */
-    if( module_load( psz_filename, &handle ) )
+    if( module_load( psz_filename, &handle ) )
     {
         /* The dynamic module couldn't be opened */
-        intf_DbgMsg( "module error: cannot open %s (%s)",
-                     psz_filename, module_error() );
+        intf_WarnMsgImm( 1, "module warning: cannot open %s (%s)",
+                         psz_filename, module_error() );
         return( -1 );
     }
 
@@ -355,6 +405,7 @@ static int AllocateDynModule( module_bank_t * p_bank, char * psz_filename )
     p_module->psz_filename = psz_filename;
     p_module->handle = handle;
 
+    /* Initialize the module : fill p_module->psz_name, etc. */
     if( CallSymbol( p_module, "InitModule" ) != 0 )
     {
         /* We couldn't call InitModule() */
@@ -363,6 +414,28 @@ static int AllocateDynModule( module_bank_t * p_bank, char * psz_filename )
         return( -1 );
     }
 
+    /* Check that version numbers match */
+    if( strcmp( VERSION, p_module->psz_version ) )
+    {
+        free( p_module );
+        module_unload( handle );
+        return( -1 );
+    }
+
+    /* Check that we don't already have a module with this name */
+    for( p_othermodule = p_bank->first ;
+         p_othermodule != NULL ;
+         p_othermodule = p_othermodule->next )
+    {
+        if( !strcmp( p_othermodule->psz_name, p_module->psz_name ) )
+        {
+            free( p_module );
+            module_unload( handle );
+            return( -1 );
+        }
+    }
+
+    /* Activate the module : fill the capability structure, etc. */
     if( CallSymbol( p_module, "ActivateModule" ) != 0 )
     {
         /* We couldn't call ActivateModule() */
@@ -407,8 +480,9 @@ static int AllocateDynModule( module_bank_t * p_bank, char * psz_filename )
     p_module->prev = NULL;
     p_bank->first = p_module;
 
-    intf_Msg( "module: dynamic module `%s', %s",
-              p_module->psz_name, p_module->psz_longname );
+    /* Immediate message so that a slow module doesn't make the user wait */
+    intf_WarnMsgImm( 1, "module: dynamic module `%s', %s",
+                     p_module->psz_name, p_module->psz_longname );
 
     return( 0 );
 }
@@ -444,6 +518,7 @@ static int HideModule( module_t * p_module )
         return( -1 );
     }
 
+    /* Deactivate the module : free the capability structure, etc. */
     if( CallSymbol( p_module, "DeactivateModule" ) != 0 )
     {
         /* We couldn't call DeactivateModule() -- looks nasty, but
@@ -527,6 +602,92 @@ static int FreeModule( module_bank_t * p_bank, module_t * p_module )
     return( 0 );
 }
 
+/*****************************************************************************
+ * LockModule: increase the usage count of a module and load it if needed.
+ *****************************************************************************
+ * This function has to be called before a thread starts using a module. If
+ * the module is already loaded, we just increase its usage count. If it isn't
+ * loaded, we have to dynamically open it and initialize it.
+ * If you successfully call LockModule() at any moment, be careful to call
+ * UnlockModule() when you don't need it anymore.
+ *****************************************************************************/
+static int LockModule( module_t * p_module )
+{
+    if( p_module->i_usage >= 0 )
+    {
+        /* This module is already loaded and activated, we can return */
+        p_module->i_usage++;
+        return( 0 );
+    }
+
+    if( p_module->b_builtin )
+    {
+        /* A built-in module should always have a refcount >= 0 ! */
+        intf_ErrMsg( "module error: built-in module `%s' has refcount %i",
+                     p_module->psz_name, p_module->i_usage );
+        return( -1 );
+    }
+
+    if( p_module->i_usage != -1 )
+    {
+        /* This shouldn't happen. Ever. We have serious problems here. */
+        intf_ErrMsg( "module error: dynamic module `%s' has refcount %i",
+                     p_module->psz_name, p_module->i_usage );
+        return( -1 );
+    }
+
+    /* i_usage == -1, which means that the module isn't in memory */
+    if( module_load( p_module->psz_filename, &p_module->handle ) )
+    {
+        /* The dynamic module couldn't be opened */
+        intf_ErrMsg( "module error: cannot open %s (%s)",
+                     p_module->psz_filename, module_error() );
+        return( -1 );
+    }
+
+    /* FIXME: what to do if the guy modified the plugin while it was
+     * unloaded ? It makes XMMS crash nastily, perhaps we should try
+     * to be a bit more clever here. */
+
+    /* Activate the module : fill the capability structure, etc. */
+    if( CallSymbol( p_module, "ActivateModule" ) != 0 )
+    {
+        /* We couldn't call ActivateModule() -- looks nasty, but
+         * we can't do much about it. Just try to unload module. */
+        module_unload( p_module->handle );
+        p_module->i_usage = -1;
+        return( -1 );
+    }
+
+    /* Everything worked fine ! The module is ready to be used */
+    p_module->i_usage = 1;
+
+    return( 0 );
+}
+
+/*****************************************************************************
+ * UnlockModule: decrease the usage count of a module.
+ *****************************************************************************
+ * We decrease the usage count of a module so that we know when a module
+ * becomes unused and can be hidden.
+ *****************************************************************************/
+static int UnlockModule( module_t * p_module )
+{
+    if( p_module->i_usage <= 0 )
+    {
+        /* This shouldn't happen. Ever. We have serious problems here. */
+        intf_ErrMsg( "module error: trying to call module_Unneed() on `%s'"
+                     " which isn't even in use", p_module->psz_name );
+        return( -1 );
+    }
+
+    /* This module is still in use, we can return */
+    p_module->i_usage--;
+    p_module->i_unused_delay = 0;
+
+    return( 0 );
+}
+
 /*****************************************************************************
  * CallSymbol: calls a module symbol.
  *****************************************************************************
@@ -545,8 +706,9 @@ static int CallSymbol( module_t * p_module, char * psz_name )
     if( !p_symbol )
     {
         /* We couldn't load the symbol */
-        intf_DbgMsg( "module warning: cannot find symbol %s in module %s (%s)",
-                     psz_name, p_module->psz_filename, module_error() );
+        intf_WarnMsg( 1, "module warning: "
+                         "cannot find symbol %s in module %s (%s)",
+                         psz_name, p_module->psz_filename, module_error() );
         return( -1 );
     }