]> git.sesse.net Git - vlc/blobdiff - src/modules/modules.c
Avoid ?: GCC-ism
[vlc] / src / modules / modules.c
index 0b00d07ee4ad8245c89c926c73589e18ba743bf0..7c1290823bf5e9abcd2b5074ed440b613f942cc8 100644 (file)
 #include "vlc_arrays.h"
 
 #include "modules/modules.h"
-#include "modules/builtin.h"
 
 static module_bank_t *p_module_bank = NULL;
 static vlc_mutex_t module_lock = VLC_STATIC_MUTEX;
 
+int vlc_entry__main( module_t * );
+
 /*****************************************************************************
  * Local prototypes
  *****************************************************************************/
 #ifdef HAVE_DYNAMIC_PLUGINS
-static void AllocateAllPlugins  ( vlc_object_t * );
-static void AllocatePluginDir   ( vlc_object_t *, const char *, int );
-static int  AllocatePluginFile  ( vlc_object_t *, char *, int64_t, int64_t );
-static module_t * AllocatePlugin( vlc_object_t *, char * );
+static void AllocateAllPlugins( vlc_object_t *, module_bank_t * );
+static void AllocatePluginDir( vlc_object_t *, module_bank_t *, const char *,
+                               unsigned );
+static int  AllocatePluginFile( vlc_object_t *, module_bank_t *, const char *,
+                                int64_t, int64_t );
+static module_t * AllocatePlugin( vlc_object_t *, const char * );
 #endif
 static int  AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
 static void DeleteModule ( module_bank_t *, module_t * );
@@ -145,28 +148,39 @@ void __module_InitBank( vlc_object_t *p_this )
     else
         p_module_bank->i_usage++;
 
-    vlc_mutex_unlock( &module_lock );
+    /* We do retain the module bank lock until the plugins are loaded as well.
+     * This is ugly, this staged loading approach is needed: LibVLC gets
+     * some configuration parameters relevant to loading the plugins from
+     * the main (builtin) module. The module bank becomes shared read-only data
+     * once it is ready, so we need to fully serialize initialization.
+     * DO NOT UNCOMMENT the following line unless you managed to squeeze
+     * module_LoadPlugins() before you unlock the mutex. */
+    /*vlc_mutex_unlock( &module_lock );*/
 }
 
-
+#undef module_EndBank
 /**
- * End bank
- *
  * Unloads all unused plugin modules and empties the module
  * bank in case of success.
  * \param p_this vlc object structure
  * \return nothing
  */
-void __module_EndBank( vlc_object_t *p_this )
+void module_EndBank( vlc_object_t *p_this, bool b_plugins )
 {
-    module_bank_t *p_bank;
+    module_bank_t *p_bank = p_module_bank;
+
+    assert (p_bank != NULL);
 
     /* Save the configuration */
     config_AutoSaveConfigFile( p_this );
 
-    vlc_mutex_lock( &module_lock );
-    p_bank = p_module_bank;
-    assert (p_bank != NULL);
+    /* If plugins were _not_ loaded, then the caller still has the bank lock
+     * from module_InitBank(). */
+    if( b_plugins )
+        vlc_mutex_lock( &module_lock );
+    /*else
+        vlc_assert_locked( &module_lock ); not for static mutexes :( */
+
     if( --p_bank->i_usage > 0 )
     {
         vlc_mutex_unlock( &module_lock );
@@ -213,59 +227,34 @@ void __module_EndBank( vlc_object_t *p_this )
     free( p_bank );
 }
 
-/**
- * Load all modules which we built with.
- *
- * Fills the module bank structure with the builtin modules.
- * \param p_this vlc object structure
- * \return nothing
- */
-void __module_LoadBuiltins( vlc_object_t * p_this )
-{
-    vlc_mutex_lock( &module_lock );
-    if( p_module_bank->b_builtins )
-    {
-        vlc_mutex_unlock( &module_lock );
-        return;
-    }
-    p_module_bank->b_builtins = true;
-    vlc_mutex_unlock( &module_lock );
-
-    msg_Dbg( p_this, "checking builtin modules" );
-    /* FIXME: race here - do this under the lock!! */
-    ALLOCATE_ALL_BUILTINS();
-}
-
 #undef module_LoadPlugins
 /**
- * Load all plugins
- *
- * Load all plugin modules we can find.
+ * Loads module descriptions for all available plugins.
  * Fills the module bank structure with the plugin modules.
+ *
  * \param p_this vlc object structure
  * \return nothing
  */
 void module_LoadPlugins( vlc_object_t * p_this, bool b_cache_delete )
 {
+    module_bank_t *p_bank = p_module_bank;
+
+    assert( p_bank );
+    /*vlc_assert_locked( &module_lock ); not for static mutexes :( */
+
 #ifdef HAVE_DYNAMIC_PLUGINS
-    vlc_mutex_lock( &module_lock );
-    if( p_module_bank->b_plugins )
+    if( p_bank->i_usage == 1 )
     {
-        vlc_mutex_unlock( &module_lock );
-        return;
+        msg_Dbg( p_this, "checking plugin modules" );
+        p_module_bank->b_cache = config_GetInt( p_this, "plugins-cache" ) > 0;
+
+        if( p_module_bank->b_cache || b_cache_delete )
+            CacheLoad( p_this, p_module_bank, b_cache_delete );
+        AllocateAllPlugins( p_this, p_module_bank );
     }
+#endif
     p_module_bank->b_plugins = true;
     vlc_mutex_unlock( &module_lock );
-
-    msg_Dbg( p_this, "checking plugin modules" );
-    p_module_bank->b_cache = config_GetInt( p_this, "plugins-cache" ) > 0;
-
-    if( p_module_bank->b_cache || b_cache_delete )
-        CacheLoad( p_this, p_module_bank, b_cache_delete );
-
-    /* FIXME: race - do this under the lock */
-    AllocateAllPlugins( p_this );
-#endif
 }
 
 /**
@@ -303,7 +292,7 @@ const char *module_get_name( const module_t *m, bool long_name )
     if( long_name && ( m->psz_longname != NULL) )
         return m->psz_longname;
 
-    return m->psz_shortname ?: m->psz_object_name;
+    return m->psz_shortname ? m->psz_shortname : m->psz_object_name;
 }
 
 /**
@@ -317,6 +306,28 @@ const char *module_get_help( const module_t *m )
     return m->psz_help;
 }
 
+/**
+ * Get the capability for a module
+ *
+ * \param m the module
+ * return the capability
+ */
+const char *module_get_capability( const module_t *m )
+{
+    return m->psz_capability;
+}
+
+/**
+ * Get the score for a module
+ *
+ * \param m the module
+ * return the score for the capability
+ */
+int module_get_score( const module_t *m )
+{
+    return m->i_score;
+}
+
 module_t *module_hold (module_t *m)
 {
     vlc_hold (&m->vlc_gc_data);
@@ -523,11 +534,10 @@ module_t * __module_need( vlc_object_t *p_this, const char *psz_capability,
             if( b_strict )
                 continue;
         }
-        /* If we didn't require a shortcut, trash <= 0 scored plugins */
-        else if( p_module->i_score <= 0 )
-        {
+
+        /* Trash <= 0 scored plugins (they can only be selected by shortcut) */
+        if( p_module->i_score <= 0 )
             continue;
-        }
 
 found_shortcut:
         /* Store this new module */
@@ -544,14 +554,8 @@ found_shortcut:
 
     /* Sort candidates by descending score */
     qsort (p_list, count, sizeof (p_list[0]), modulecmp);
-#ifdef WIN32
-    /* FIXME: Remove this hack after finding a general solution for %z's */
-    msg_Dbg( p_this, "looking for %s module: %u candidate%s", psz_capability,
-             count, count == 1 ? "" : "s" );
-#else
     msg_Dbg( p_this, "looking for %s module: %zu candidate%s", psz_capability,
              count, count == 1 ? "" : "s" );
-#endif
 
     /* Parse the linked list and use the first successful module */
     p_module = NULL;
@@ -608,6 +612,7 @@ found_shortcut:
     else if( count == 0 )
     {
         if( !strcmp( psz_capability, "access_demux" )
+         || !strcmp( psz_capability, "stream_filter" )
          || !strcmp( psz_capability, "vout_window" ) )
         {
             msg_Dbg( p_this, "no %s module matched \"%s\"",
@@ -666,7 +671,6 @@ void __module_unneed( vlc_object_t * p_this, module_t * p_module )
 /**
  * Get a pointer to a module_t given it's name.
  *
- * \param p_this vlc object structure
  * \param psz_name the name of the module
  * \return a pointer to the module or NULL in case of a failure
  */
@@ -695,7 +699,6 @@ module_t *module_find( const char * psz_name )
 /**
  * Tell if a module exists and release it in thic case
  *
- * \param p_this vlc object structure
  * \param psz_name th name of the module
  * \return TRUE if the module exists
  */
@@ -707,6 +710,41 @@ bool module_exists (const char * psz_name)
     return p_module != NULL;
 }
 
+/**
+ * Get a pointer to a module_t that matches a shortcut.
+ * This is a temporary hack for SD. Do not re-use (generally multiple modules
+ * can have the same shortcut, so this is *broken* - use module_need()!).
+ *
+ * \param psz_shortcut shortcut of the module
+ * \param psz_cap capability of the module
+ * \return a pointer to the module or NULL in case of a failure
+ */
+module_t *module_find_by_shortcut (const char *psz_shortcut)
+{
+    module_t **list, *module;
+
+    list = module_list_get (NULL);
+    if (!list)
+        return NULL;
+
+    for (size_t i = 0; (module = list[i]) != NULL; i++)
+    {
+        for (size_t j = 0;
+             (module->pp_shortcuts[j] != NULL) && (j < MODULE_SHORTCUT_MAX);
+             j++)
+        {
+            if (!strcmp (module->pp_shortcuts[j], psz_shortcut))
+            {
+                module_hold (module);
+                goto out;
+             }
+        }
+    }
+out:
+    module_list_free (list);
+    return module;
+}
+
 /**
  * GetModuleNamesForCapability
  *
@@ -726,16 +764,18 @@ char ** module_GetModulesNamesForCapability( const char *psz_capability,
 
     module_t **list = module_list_get (NULL);
 
-    /* Do it in two passes : count the number of modules before */
+    /* Proceed in two passes: count the number of modules first */
     for (size_t i = 0; list[i]; i++)
     {
         module_t *p_module = list[i];
         const char *psz_module_capability = p_module->psz_capability;
 
-        if( psz_module_capability && !strcmp( psz_module_capability, psz_capability ) )
+        if( psz_module_capability
+         && !strcmp( psz_module_capability, psz_capability ) )
             count++;
     }
 
+    /* Then get the names */
     psz_ret = malloc( sizeof(char*) * (count+1) );
     if( pppsz_longname )
         *pppsz_longname = malloc( sizeof(char*) * (count+1) );
@@ -756,16 +796,17 @@ char ** module_GetModulesNamesForCapability( const char *psz_capability,
         module_t *p_module = list[i];
         const char *psz_module_capability = p_module->psz_capability;
 
-        if( psz_module_capability && !strcmp( psz_module_capability, psz_capability ) )
+        if( psz_module_capability
+         && !strcmp( psz_module_capability, psz_capability ) )
         {
-            int k = -1; /* hack to handle submodules properly */
-            if( p_module->b_submodule )
-            {
-                while( p_module->pp_shortcuts[++k] != NULL );
-                k--;
-            }
-            psz_ret[j] = strdup( k>=0?p_module->pp_shortcuts[k]
-                                     :p_module->psz_object_name );
+            /* Explicit hack: Use the last shortcut. It _should_ be
+             * different from the object name, at least if the object
+             * contains multiple submodules with the same capability. */
+            unsigned k = 0;
+            while( p_module->pp_shortcuts[k] != NULL )
+                k++;
+            assert( k > 0); /* pp_shortcuts[0] is always set */
+            psz_ret[j] = strdup( p_module->pp_shortcuts[k - 1] );
             if( pppsz_longname )
                 (*pppsz_longname)[j] = strdup( module_get_name( p_module, true ) );
             j++;
@@ -881,7 +922,7 @@ char *psz_vlcpath = NULL;
  * AllocateAllPlugins: load all plugin modules we can find.
  *****************************************************************************/
 #ifdef HAVE_DYNAMIC_PLUGINS
-static void AllocateAllPlugins( vlc_object_t *p_this )
+static void AllocateAllPlugins( vlc_object_t *p_this, module_bank_t *p_bank )
 {
     const char *vlcpath = psz_vlcpath;
     int count,i;
@@ -920,7 +961,7 @@ static void AllocateAllPlugins( vlc_object_t *p_this )
         msg_Dbg( p_this, "recursively browsing `%s'", path );
 
         /* Don't go deeper than 5 subdirectories */
-        AllocatePluginDir( p_this, path, 5 );
+        AllocatePluginDir( p_this, p_bank, path, 5 );
 
         free( path );
     }
@@ -932,8 +973,8 @@ static void AllocateAllPlugins( vlc_object_t *p_this )
 /*****************************************************************************
  * AllocatePluginDir: recursively parse a directory to look for plugins
  *****************************************************************************/
-static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
-                               int i_maxdepth )
+static void AllocatePluginDir( vlc_object_t *p_this, module_bank_t *p_bank,
+                               const char *psz_dir, unsigned i_maxdepth )
 {
 /* FIXME: Needs to be ported to wide char on ALL Windows builds */
 #ifdef WIN32
@@ -957,10 +998,8 @@ static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
 #endif
     char * psz_file;
 
-    if( p_this->p_libvlc->b_die || i_maxdepth < 0 )
-    {
+    if( i_maxdepth == 0 )
         return;
-    }
 
 #if defined( UNDER_CE ) || defined( _MSC_VER )
 #ifdef UNDER_CE
@@ -1016,7 +1055,7 @@ static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
         if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
 #endif
         {
-            AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
+            AllocatePluginDir( p_this, p_bank, psz_path, i_maxdepth - 1 );
         }
         else if( i_len > strlen( LIBEXT )
                   /* We only load files ending with LIBEXT */
@@ -1044,7 +1083,7 @@ static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
             }
             psz_file = psz_path;
 
-            AllocatePluginFile( p_this, psz_file, i_time, i_size );
+            AllocatePluginFile( p_this, p_bank, psz_file, i_time, i_size );
         }
     }
     while( !p_this->p_libvlc->b_die && FindNextFile( handle, &finddata ) );
@@ -1082,7 +1121,7 @@ static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
         i_stat = stat( psz_file, &statbuf );
         if( !i_stat && statbuf.st_mode & S_IFDIR )
         {
-            AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
+            AllocatePluginDir( p_this, p_bank, psz_file, i_maxdepth - 1 );
         }
         else if( i_len > strlen( LIBEXT )
                   /* We only load files ending with LIBEXT */
@@ -1097,7 +1136,7 @@ static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
                 i_size = statbuf.st_size;
             }
 
-            AllocatePluginFile( p_this, psz_file, i_time, i_size );
+            AllocatePluginFile( p_this, p_bank, psz_file, i_time, i_size );
         }
 
         free( psz_file );
@@ -1116,7 +1155,8 @@ static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
  * for its information data. The module can then be handled by module_need
  * and module_unneed. It can be removed by DeleteModule.
  *****************************************************************************/
-static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
+static int AllocatePluginFile( vlc_object_t * p_this, module_bank_t *p_bank,
+                               const char *psz_file,
                                int64_t i_file_time, int64_t i_file_size )
 {
     module_t * p_module = NULL;
@@ -1125,9 +1165,7 @@ static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
     /*
      * Check our plugins cache first then load plugin if needed
      */
-    p_cache_entry =
-        CacheFind( p_module_bank, psz_file, i_file_time, i_file_size );
-
+    p_cache_entry = CacheFind( p_bank, psz_file, i_file_time, i_file_size );
     if( !p_cache_entry )
     {
         p_module = AllocatePlugin( p_this, psz_file );
@@ -1171,13 +1209,12 @@ static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
 
         /* msg_Dbg( p_this, "plugin \"%s\", %s",
                     p_module->psz_object_name, p_module->psz_longname ); */
-        p_module->next = p_module_bank->head;
-        p_module_bank->head = p_module;
+        p_module->next = p_bank->head;
+        p_bank->head = p_module;
 
         if( !p_module_bank->b_cache )
             return 0;
 
-#define p_bank p_module_bank
         /* Add entry to cache */
         p_bank->pp_cache =
             realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
@@ -1191,7 +1228,6 @@ static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
         p_bank->pp_cache[p_bank->i_cache]->b_used = true;
         p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
         p_bank->i_cache++;
-#undef p_bank
     }
 
     return p_module ? 0 : -1;
@@ -1204,7 +1240,7 @@ static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
  * for its information data. The module can then be handled by module_need
  * and module_unneed. It can be removed by DeleteModule.
  *****************************************************************************/
-static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
+static module_t * AllocatePlugin( vlc_object_t * p_this, const char *psz_file )
 {
     module_t * p_module = NULL;
     module_handle_t handle;
@@ -1221,8 +1257,7 @@ static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
         return NULL;
     }
 
-    /* We need to fill these since they may be needed by module_Call() */
-    p_module->psz_filename = psz_file;
+    p_module->psz_filename = strdup( psz_file );
     p_module->handle = handle;
     p_module->b_loaded = true;
 
@@ -1230,13 +1265,13 @@ static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
     if( module_Call( p_this, p_module ) != 0 )
     {
         /* We couldn't call module_init() */
+        free( p_module->psz_filename );
         module_release( p_module );
         module_Unload( handle );
         return NULL;
     }
 
     DupModule( p_module );
-    p_module->psz_filename = strdup( p_module->psz_filename );
 
     /* Everything worked fine ! The module is ready to be added to the list. */
     p_module->b_builtin = false;