/*****************************************************************************
- * modules.c : Built-in and plugin modules management functions
+ * modules.c : Builtin and plugin modules management functions
*****************************************************************************
* Copyright (C) 2001 VideoLAN
- * $Id: modules.c,v 1.49 2002/01/21 00:52:07 sam Exp $
+ * $Id: modules.c,v 1.94 2002/10/03 13:21:55 sam Exp $
*
* Authors: Samuel Hocevar <sam@zoy.org>
* Ethan C. Baldridge <BaldridgeE@cadmus.com>
+ * Hans-Peter Jansen <hpj@urpla.net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
#include <stdio.h> /* sprintf() */
#include <string.h> /* strdup() */
-#include <videolan/vlc.h>
+#include <vlc/vlc.h>
-#if !defined( _MSC_VER )
#include <dirent.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#ifdef HAVE_UNISTD_H
+# include <unistd.h>
#endif
#if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
#elif defined(HAVE_IMAGE_H) /* BeOS */
# include <image.h>
# define HAVE_DYNAMIC_PLUGINS
-#elif defined(WIN32) && defined( __MINGW32__ )
+#elif defined(WIN32)
# define HAVE_DYNAMIC_PLUGINS
#else
# undef HAVE_DYNAMIC_PLUGINS
#endif
+
#include "netutils.h"
#include "interface.h"
-#include "intf_playlist.h"
+#include "vlc_playlist.h"
#include "intf_eject.h"
#include "stream_control.h"
#include "video_output.h"
#include "audio_output.h"
+#include "aout_internal.h"
+
+#include "stream_output.h"
#include "iso_lang.h"
#ifdef HAVE_DYNAMIC_PLUGINS
# include "modules_plugin.h"
#endif
-#include "modules_builtin.h"
+
+#if !defined( _MSC_VER )
+# include "modules_builtin.h"
+#else
+# include "modules_builtin_msvc.h"
+#endif
/*****************************************************************************
* Local prototypes
*****************************************************************************/
#ifdef HAVE_DYNAMIC_PLUGINS
-static void AllocateAllPlugins ( void );
-static int AllocatePluginModule ( char * );
+static void AllocateAllPlugins ( vlc_object_t * );
+static void AllocatePluginDir ( vlc_object_t *, const char *, int );
+static int AllocatePluginFile ( vlc_object_t *, char * );
#endif
-static void AllocateAllBuiltins ( void );
-static int AllocateBuiltinModule( int ( * ) ( module_t * ),
- int ( * ) ( module_t * ),
- int ( * ) ( module_t * ) );
+static int AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
static int DeleteModule ( module_t * );
-static int LockModule ( module_t * );
-static int UnlockModule ( module_t * );
-#ifdef HAVE_DYNAMIC_PLUGINS
-static int HideModule ( module_t * );
-static int CallSymbol ( module_t *, char * );
-#endif
-
#ifdef HAVE_DYNAMIC_PLUGINS
-static module_symbols_t symbols;
+static void DupModule ( module_t * );
+static void UndupModule ( module_t * );
+static int CallEntry ( module_t * );
#endif
/*****************************************************************************
* module_InitBank: create the module bank.
*****************************************************************************
- * This function creates a module bank structure and fills it with the
- * built-in modules, as well as all the plugin modules it can find.
+ * This function creates a module bank structure which will be filled later
+ * on with all the modules found.
*****************************************************************************/
-void module_InitBank( void )
+void __module_InitBank( vlc_object_t *p_this )
{
- p_module_bank->first = NULL;
- p_module_bank->i_count = 0;
- vlc_mutex_init( &p_module_bank->lock );
+ module_bank_t *p_bank;
+
+ p_bank = vlc_object_create( p_this, sizeof(module_bank_t) );
+ p_bank->psz_object_name = "module bank";
/*
* Store the symbols to be exported
*/
#ifdef HAVE_DYNAMIC_PLUGINS
- STORE_SYMBOLS( &symbols );
+ STORE_SYMBOLS( &p_bank->symbols );
#endif
- /*
- * Check all the built-in modules
- */
- intf_WarnMsg( 2, "module: checking built-in modules" );
- AllocateAllBuiltins();
-
- /*
- * Check all the plugin modules we can find
- */
-#ifdef HAVE_DYNAMIC_PLUGINS
- intf_WarnMsg( 2, "module: checking plugin modules" );
- AllocateAllPlugins();
-#endif
+ /* Everything worked, attach the object */
+ p_this->p_libvlc->p_module_bank = p_bank;
+ vlc_object_attach( p_bank, p_this->p_libvlc );
- intf_WarnMsg( 2, "module: module bank initialized, found %i modules",
- p_module_bank->i_count );
+ return;
+}
+/*****************************************************************************
+ * module_ResetBank: reset the module bank.
+ *****************************************************************************
+ * This function resets the module bank by unloading all unused plugin
+ * modules.
+ *****************************************************************************/
+void __module_ResetBank( vlc_object_t *p_this )
+{
+ msg_Err( p_this, "FIXME: module_ResetBank unimplemented" );
return;
}
* This function unloads all unused plugin modules and empties the module
* bank in case of success.
*****************************************************************************/
-void module_EndBank( void )
+void __module_EndBank( vlc_object_t *p_this )
{
module_t * p_next;
- while( p_module_bank->first != NULL )
+ vlc_object_detach( p_this->p_libvlc->p_module_bank );
+
+ while( p_this->p_libvlc->p_module_bank->i_children )
{
- if( DeleteModule( p_module_bank->first ) )
+ p_next = (module_t *)p_this->p_libvlc->p_module_bank->pp_children[0];
+
+ if( DeleteModule( p_next ) )
{
/* Module deletion failed */
- intf_ErrMsg( "module error: `%s' can't be removed, trying harder",
- p_module_bank->first->psz_name );
+ msg_Err( p_this, "module \"%s\" can't be removed, trying harder",
+ p_next->psz_object_name );
/* We just free the module by hand. Niahahahahaha. */
- p_next = p_module_bank->first->next;
- free(p_module_bank->first);
- p_module_bank->first = p_next;
+ vlc_object_detach( p_next );
+ vlc_object_destroy( p_next );
}
}
- /* Destroy the lock */
- vlc_mutex_destroy( &p_module_bank->lock );
+ vlc_object_destroy( p_this->p_libvlc->p_module_bank );
return;
}
/*****************************************************************************
- * module_ResetBank: reset the module bank.
+ * module_LoadMain: load the main program info into the module bank.
*****************************************************************************
- * This function resets the module bank by unloading all unused plugin
- * modules.
+ * This function fills the module bank structure with the main module infos.
+ * This is very useful as it will allow us to consider the main program just
+ * as another module, and for instance the configuration options of main will
+ * be available in the module bank structure just as for every other module.
*****************************************************************************/
-void module_ResetBank( void )
+void __module_LoadMain( vlc_object_t *p_this )
{
- intf_ErrMsg( "FIXME: module_ResetBank unimplemented" );
- return;
+ AllocateBuiltinModule( p_this, vlc_entry__main );
}
/*****************************************************************************
- * module_ManageBank: manage the module bank.
+ * module_LoadBuiltins: load all modules which we built with.
*****************************************************************************
- * This function parses the module bank and hides modules that have been
- * unused for a while.
+ * This function fills the module bank structure with the builtin modules.
*****************************************************************************/
-void module_ManageBank( void )
+void __module_LoadBuiltins( vlc_object_t * p_this )
{
-#ifdef HAVE_DYNAMIC_PLUGINS
- module_t * p_module;
-
- /* We take the global lock */
- vlc_mutex_lock( &p_module_bank->lock );
-
- /* Parse the module list to see if any modules need to be unloaded */
- for( p_module = p_module_bank->first ;
- p_module != NULL ;
- p_module = p_module->next )
- {
- /* If the module is unused and if it is a plugin module... */
- if( p_module->i_usage == 0 && !p_module->b_builtin )
- {
- if( p_module->i_unused_delay < MODULE_HIDE_DELAY )
- {
- p_module->i_unused_delay++;
- }
- else
- {
- intf_WarnMsg( 3, "module: hiding unused plugin module `%s'",
- p_module->psz_name );
- HideModule( p_module );
-
- /* Break here, so that we only hide one module at a time */
- break;
- }
- }
- }
-
- /* We release the global lock */
- vlc_mutex_unlock( &p_module_bank->lock );
-#endif /* HAVE_DYNAMIC_PLUGINS */
+ msg_Dbg( p_this, "checking builtin modules" );
+ ALLOCATE_ALL_BUILTINS();
+}
- return;
+/*****************************************************************************
+ * module_LoadPlugins: load all plugin modules we can find.
+ *****************************************************************************
+ * This function fills the module bank structure with the plugin modules.
+ *****************************************************************************/
+void __module_LoadPlugins( vlc_object_t * p_this )
+{
+#ifdef HAVE_DYNAMIC_PLUGINS
+ msg_Dbg( p_this, "checking plugin modules" );
+ AllocateAllPlugins( p_this );
+#endif
}
-int module_NeedMemcpy( memcpy_module_t *p_memcpy )
+/*****************************************************************************
+ * module_Need: return the best module function, given a capability list.
+ *****************************************************************************
+ * This function returns the module that best fits the asked capabilities.
+ *****************************************************************************/
+module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
+ const char *psz_name )
{
- p_memcpy->p_module = module_Need( MODULE_CAPABILITY_MEMCPY, NULL, NULL );
+ typedef struct module_list_t module_list_t;
- if( p_memcpy->p_module == NULL )
+ struct module_list_t
{
- return -1;
- }
+ module_t *p_module;
+ int i_score;
+ module_list_t *p_next;
+ };
- p_memcpy->pf_memcpy = p_memcpy->p_module->p_functions->memcpy.functions.memcpy.fast_memcpy;
+ module_list_t *p_list, *p_first, *p_tmp;
+ vlc_list_t *p_all;
- return 0;
-}
+ int i_index = 0;
+ vlc_bool_t b_intf = VLC_FALSE;
-void module_UnneedMemcpy( memcpy_module_t *p_memcpy )
-{
- module_Unneed( p_memcpy->p_module );
-}
+ module_t *p_module;
+ module_t **pp_parser;
-#if 0
-int module_NeedIntf( intf_module_t *p_intf )
-{
- p_intf->p_module = module_Need( MODULE_CAPABILITY_INTF, NULL );
+ int i_shortcuts = 0;
+ char *psz_shortcuts = NULL, *psz_var = NULL;
+
+ msg_Dbg( p_this, "looking for %s module", psz_capability );
- if( p_intf->p_module == NULL )
+ /* Deal with variables */
+ if( psz_name && psz_name[0] == '$' )
{
- return -1;
+ psz_var = config_GetPsz( p_this, psz_name + 1 );
+ psz_name = psz_var;
}
- p_intf->pf_open = p_intf->p_module->p_functions->intf.functions.intf.pf_open;
- p_intf->pf_run = p_intf->p_module->p_functions->intf.functions.intf.pf_run;
- p_intf->pf_close = p_intf->p_module->p_functions->intf.functions.intf.pf_close;
-
- return 0;
-}
-#endif
-
-/*****************************************************************************
- * module_Need: return the best module function, given a capability list.
- *****************************************************************************
- * This function returns the module that best fits the asked capabilities.
- *****************************************************************************/
-module_t * module_Need( int i_capability, char *psz_name, probedata_t *p_data )
-{
- module_t * p_module;
-
- /* We take the global lock */
- vlc_mutex_lock( &p_module_bank->lock );
-
- if( psz_name != NULL && *psz_name )
+ /* Count how many different shortcuts were asked for */
+ if( psz_name && *psz_name )
{
-#define MAX_PLUGIN_NAME 128
- /* A module name was requested. Use the first matching one. */
- char psz_realname[ MAX_PLUGIN_NAME + 1 ];
- int i_index;
- boolean_t b_ok = 0;
-
- for( i_index = 0;
- i_index < MAX_PLUGIN_NAME
- && psz_name[ i_index ]
- && psz_name[ i_index ] != ':';
- i_index++ )
+ char *psz_parser;
+
+ /* If the user wants none, give him none. */
+ if( !strcmp( psz_name, "none" ) )
{
- psz_realname[ i_index ] = psz_name[ i_index ];
+ if( psz_var ) free( psz_var );
+ return NULL;
}
- psz_realname[ i_index ] = '\0';
+ i_shortcuts++;
+ psz_shortcuts = strdup( psz_name );
- for( p_module = p_module_bank->first;
- p_module != NULL;
- p_module = p_module->next )
+ for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
{
- /* Test that this module can do everything we need */
- if( !(p_module->i_capabilities & ( 1 << i_capability )) )
+ if( *psz_parser == ',' )
{
- continue;
+ *psz_parser = '\0';
+ i_shortcuts++;
}
+ }
+ }
- /* Test if we have the required CPU */
- if( (p_module->i_cpu_capabilities & p_main->i_cpu_capabilities)
- != p_module->i_cpu_capabilities )
- {
- continue;
- }
+ /* Sort the modules and test them */
+ p_all = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
+ p_list = malloc( p_all->i_count * sizeof( module_list_t ) );
+ p_first = NULL;
+
+ /* Parse the module list for capabilities and probe each of them */
+ for( pp_parser = (module_t**)p_all->pp_objects ; *pp_parser ; pp_parser++ )
+ {
+ module_t * p_submodule = NULL;
+ int i_shortcut_bonus = 0, i_submodule;
+
+ p_module = *pp_parser;
- /* Test if this plugin exports the required shortcut */
- for( i_index = 0;
- !b_ok && p_module->pp_shortcuts[i_index];
- i_index++ )
+ /* Test that this module can do what we need */
+ if( strcmp( p_module->psz_capability, psz_capability ) )
+ {
+ for( i_submodule = 0;
+ i_submodule < p_module->i_children;
+ i_submodule++ )
{
- b_ok = !strcmp( psz_realname,
- p_module->pp_shortcuts[i_index] );
+ if( !strcmp( ((module_t*)p_module->pp_children[ i_submodule ])
+ ->psz_capability, psz_capability ) )
+ {
+ p_submodule =
+ (module_t*)p_module->pp_children[ i_submodule ];
+ break;
+ }
}
- if( b_ok )
+ if( p_submodule == NULL )
{
- break;
+ continue;
}
- }
- if( b_ok )
- {
- /* Open it ! */
- LockModule( p_module );
+ p_module = p_submodule;
}
- else
+
+ /* Test if we have the required CPU */
+ if( (p_module->i_cpu & p_this->p_vlc->i_cpu) != p_module->i_cpu )
{
- intf_ErrMsg( "module error: requested %s module `%s' not found",
- GetCapabilityName( i_capability ), psz_realname );
+ continue;
}
- }
- else
- {
- /* No module name was requested. Sort the modules and test them */
- typedef struct module_list_s
- {
- struct module_s *p_module;
- struct module_list_s* p_next;
- } module_list_t;
-
- int i_score = 0;
- int i_index = 0;
- struct module_list_s *p_list = malloc( p_module_bank->i_count
- * sizeof( module_list_t ) );
- struct module_list_s *p_first = NULL;
-
- /* Parse the module list for capabilities and probe each of them */
- for( p_module = p_module_bank->first ;
- p_module != NULL ;
- p_module = p_module->next )
+
+ /* If we required a shortcut, check this plugin provides it. */
+ if( i_shortcuts )
{
- /* Test that this module can do everything we need */
- if( !(p_module->i_capabilities & ( 1 << i_capability )) )
+ vlc_bool_t b_trash = VLC_TRUE;
+ int i_dummy, i_short = i_shortcuts;
+ char *psz_name = psz_shortcuts;
+
+ while( i_short )
{
- continue;
+ for( i_dummy = 0;
+ b_trash && p_module->pp_shortcuts[i_dummy];
+ i_dummy++ )
+ {
+ b_trash = ( strcmp(psz_name, "any") || !p_module->i_score )
+ && strcmp( psz_name, p_module->pp_shortcuts[i_dummy] );
+ }
+
+ if( !b_trash )
+ {
+ i_shortcut_bonus = i_short * 10000;
+ break;
+ }
+
+ /* Go to the next shortcut... This is so lame! */
+ while( *psz_name )
+ {
+ psz_name++;
+ }
+ psz_name++;
+ i_short--;
}
- /* Test if we have the required CPU */
- if( (p_module->i_cpu_capabilities & p_main->i_cpu_capabilities)
- != p_module->i_cpu_capabilities )
+ if( b_trash )
{
continue;
}
+ }
+ /* If we didn't require a shortcut, trash zero-scored plugins */
+ else if( !p_module->i_score )
+ {
+ continue;
+ }
- /* Test if we requested a particular intf plugin */
-#if 0
- if( i_capability == MODULE_CAPABILITY_INTF
- && p_module->psz_program != NULL
- && strcmp( p_module->psz_program, p_main->psz_arg0 ) )
+ /* Special case: test if we requested a particular intf plugin */
+ if( p_module->psz_program
+ && !strcmp( p_module->psz_program,
+ p_this->p_vlc->psz_object_name ) )
+ {
+ if( !b_intf )
{
- continue;
+ /* Remove previous non-matching plugins */
+ i_index = 0;
+ b_intf = VLC_TRUE;
}
-#endif
+ }
+ else if( b_intf )
+ {
+ /* This one doesn't match */
+ continue;
+ }
- /* Store this new module */
- p_list[ i_index ].p_module = p_module;
+ /* Store this new module */
+ p_list[ i_index ].p_module = p_module;
+ p_list[ i_index ].i_score = p_module->i_score + i_shortcut_bonus;
- if( i_index == 0 )
+ /* Add it to the modules-to-probe list */
+ if( i_index == 0 )
+ {
+ p_list[ 0 ].p_next = NULL;
+ p_first = p_list;
+ }
+ else
+ {
+ /* Ok, so at school you learned that quicksort is quick, and
+ * bubble sort sucks raw eggs. But that's when dealing with
+ * thousands of items. Here we have barely 50. */
+ module_list_t *p_newlist = p_first;
+
+ if( p_first->i_score < p_list[ i_index ].i_score )
{
- p_list[ i_index ].p_next = NULL;
- p_first = p_list;
+ p_list[ i_index ].p_next = p_first;
+ p_first = &p_list[ i_index ];
}
else
{
- /* Ok, so at school you learned that quicksort is quick, and
- * bubble sort sucks raw eggs. But that's when dealing with
- * thousands of items. Here we have barely 50. */
- struct module_list_s *p_newlist = p_first;
-
- if( p_first->p_module->pi_score[i_capability]
- < p_module->pi_score[i_capability] )
- {
- p_list[ i_index ].p_next = p_first;
- p_first = &p_list[ i_index ];
- }
- else
+ while( p_newlist->p_next != NULL &&
+ p_newlist->p_next->i_score >= p_list[ i_index ].i_score )
{
- while( p_newlist->p_next != NULL
- && p_newlist->p_next
- ->p_module->pi_score[i_capability]
- >= p_module->pi_score[i_capability] )
- {
- p_newlist = p_newlist->p_next;
- }
-
- p_list[ i_index ].p_next = p_newlist->p_next;
- p_newlist->p_next = &p_list[ i_index ];
+ p_newlist = p_newlist->p_next;
}
- }
- i_index++;
+ p_list[ i_index ].p_next = p_newlist->p_next;
+ p_newlist->p_next = &p_list[ i_index ];
+ }
}
- /* Parse the linked list and use the first successful module */
- while( p_first != NULL )
- {
- LockModule( p_first->p_module );
+ i_index++;
+ }
- /* Test the requested capability */
- i_score += ((function_list_t *)p_first->p_module->p_functions)
- [i_capability].pf_probe( p_data );
+ msg_Dbg( p_this, "probing %i candidate%s",
+ i_index, i_index == 1 ? "" : "s" );
- /* If the high score was broken, we have a new champion */
- if( i_score )
- {
- break;
- }
+ /* Lock all candidate modules */
+ p_tmp = p_first;
+ while( p_tmp != NULL )
+ {
+ vlc_object_yield( p_tmp->p_module );
+ p_tmp = p_tmp->p_next;
+ }
- UnlockModule( p_first->p_module );
+ /* We can release the list, interesting modules were yielded */
+ vlc_list_release( p_all );
- p_first = p_first->p_next;
+ /* Parse the linked list and use the first successful module */
+ p_tmp = p_first;
+ while( p_tmp != NULL )
+ {
+ if( p_tmp->p_module->pf_activate
+ && p_tmp->p_module->pf_activate( p_this ) == VLC_SUCCESS )
+ {
+ break;
}
- p_module = (p_first == NULL) ? NULL : p_first->p_module;
- free( p_list );
+ vlc_object_release( p_tmp->p_module );
+ p_tmp = p_tmp->p_next;
}
- /* We can release the global lock, module refcount was incremented */
- vlc_mutex_unlock( &p_module_bank->lock );
+ /* Store the locked module value */
+ if( p_tmp != NULL )
+ {
+ p_module = p_tmp->p_module;
+ p_tmp = p_tmp->p_next;
+ }
+ else
+ {
+ p_module = NULL;
+ }
+
+ /* Unlock the remaining modules */
+ while( p_tmp != NULL )
+ {
+ vlc_object_release( p_tmp->p_module );
+ p_tmp = p_tmp->p_next;
+ }
+
+ free( p_list );
if( p_module != NULL )
{
- intf_WarnMsg( 1, "module: locking %s module `%s'",
- GetCapabilityName( i_capability ),
- p_module->psz_name );
+ msg_Info( p_module, "using %s module \"%s\"",
+ psz_capability, p_module->psz_object_name );
+ }
+ else if( p_first == NULL )
+ {
+ msg_Err( p_this, "no %s module matched \"%s\"",
+ psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
+ }
+ else if( psz_name != NULL && *psz_name )
+ {
+ msg_Err( p_this, "no %s module matching \"%s\" could be loaded",
+ psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
}
- /* Don't forget that the module is still locked if bestmodule != NULL */
- return( p_module );
+ if( psz_shortcuts )
+ {
+ free( psz_shortcuts );
+ }
+
+ if( psz_var )
+ {
+ free( psz_var );
+ }
+
+ /* Don't forget that the module is still locked */
+ return p_module;
}
/*****************************************************************************
* This function must be called by the thread that called module_Need, to
* decrease the reference count and allow for hiding of modules.
*****************************************************************************/
-void module_Unneed( module_t * p_module )
+void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
{
- /* We take the global lock */
- vlc_mutex_lock( &p_module_bank->lock );
-
- /* 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 );
+ /* Use the close method */
+ if( p_module->pf_deactivate )
+ {
+ p_module->pf_deactivate( p_this );
+ }
- intf_WarnMsg( 1, "module: unlocking module `%s'", p_module->psz_name );
+ msg_Info( p_module, "unlocking module \"%s\"", p_module->psz_object_name );
- /* We release the global lock */
- vlc_mutex_unlock( &p_module_bank->lock );
+ vlc_object_release( p_module );
return;
}
* AllocateAllPlugins: load all plugin modules we can find.
*****************************************************************************/
#ifdef HAVE_DYNAMIC_PLUGINS
-static void AllocateAllPlugins( void )
+static void AllocateAllPlugins( vlc_object_t *p_this )
{
- static char * path[] = { ".", "plugins", PLUGIN_PATH, NULL, NULL };
+ /* Yes, there are two NULLs because we replace one with "plugin-path". */
+ char * path[] = { "modules", PLUGIN_PATH, "plugins", NULL,
+ NULL };
char ** ppsz_path = path;
char * psz_fullpath;
- char * psz_file;
#if defined( SYS_BEOS ) || defined( SYS_DARWIN )
char * psz_vlcpath = system_GetProgramPath();
int i_vlclen = strlen( psz_vlcpath );
- boolean_t b_notinroot;
+ vlc_bool_t b_notinroot;
#endif
- DIR * dir;
- struct dirent * file;
+
+ /* If the user provided a plugin path, we add it to the list */
+ path[ sizeof(path)/sizeof(char*) - 2 ] = config_GetPsz( p_this,
+ "plugin-path" );
for( ; *ppsz_path != NULL ; ppsz_path++ )
{
+#if defined( SYS_BEOS ) || defined( SYS_DARWIN )
/* Store strlen(*ppsz_path) for later use. */
int i_dirlen = strlen( *ppsz_path );
-#if defined( SYS_BEOS ) || defined( SYS_DARWIN )
- b_notinroot = 0;
+ b_notinroot = VLC_FALSE;
/* Under BeOS, we need to add beos_GetProgramPath() to access
* files under the current directory */
if( ( i_dirlen > 1 ) && strncmp( *ppsz_path, "/", 1 ) )
{
i_dirlen += i_vlclen + 2;
- b_notinroot = 1;
+ b_notinroot = VLC_TRUE;
psz_fullpath = malloc( i_dirlen );
if( psz_fullpath == NULL )
psz_fullpath = *ppsz_path;
}
- intf_WarnMsgImm( 1, "module: browsing `%s'", psz_fullpath );
+ msg_Dbg( p_this, "recursively browsing `%s'", psz_fullpath );
- if( (dir = opendir( psz_fullpath )) )
- {
- /* Parse the directory and try to load all files it contains. */
- while( (file = readdir( dir )) )
- {
- int i_filelen = strlen( file->d_name );
-
- /* We only load files ending with ".so" */
- if( i_filelen > 3
- && !strncmp( file->d_name + i_filelen - 3, ".so", 3 ) )
- {
- psz_file = malloc( i_dirlen + i_filelen + 2 );
- if( psz_file == NULL )
- {
- 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 plugin module. */
- AllocatePluginModule( psz_file );
-
- /* We don't care if the allocation succeeded */
- free( psz_file );
- }
- }
-
- /* Close the directory if successfully opened */
- closedir( dir );
- }
+ /* Don't go deeper than 5 subdirectories */
+ AllocatePluginDir( p_this, psz_fullpath, 5 );
#if defined( SYS_BEOS ) || defined( SYS_DARWIN )
if( b_notinroot )
}
/*****************************************************************************
- * AllocatePluginModule: load a module into memory and initialize it.
- *****************************************************************************
- * This function loads a dynamically loadable module and allocates a structure
- * for its information data. The module can then be handled by module_Need,
- * module_Unneed and HideModule. It can be removed by DeleteModule.
+ * AllocatePluginDir: recursively parse a directory to look for plugins
*****************************************************************************/
-static int AllocatePluginModule( char * psz_filename )
+static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
+ int i_maxdepth )
{
- char **pp_shortcut;
- module_t * p_module, * p_othermodule;
- module_handle_t handle;
+ int i_dirlen;
+ DIR * dir;
+ char * psz_file;
- /* Try to dynamically load the module. */
- if( module_load( psz_filename, &handle ) )
- {
- /* The plugin module couldn't be opened */
- intf_WarnMsgImm( 1, "module warning: cannot open %s (%s)",
- psz_filename, module_error() );
- return( -1 );
- }
+ struct dirent * file;
- /* Now that we have successfully loaded the module, we can
- * allocate a structure for it */
- p_module = malloc( sizeof( module_t ) );
- if( p_module == NULL )
+ if( i_maxdepth < 0 )
{
- intf_ErrMsg( "module error: can't allocate p_module" );
- module_unload( handle );
- return( -1 );
+ return;
}
- /* We need to fill these since they may be needed by CallSymbol() */
- p_module->is.plugin.psz_filename = psz_filename;
- p_module->is.plugin.handle = handle;
- p_module->p_symbols = &symbols;
+ dir = opendir( psz_dir );
- /* Initialize the module : fill p_module->psz_name, etc. */
- if( CallSymbol( p_module, "InitModule" MODULE_SUFFIX ) != 0 )
+ if( !dir )
{
- /* We couldn't call InitModule() */
- free( p_module );
- module_unload( handle );
- return( -1 );
+ return;
}
- /* Check that we don't already have a module with this name */
- for( p_othermodule = p_module_bank->first ;
- p_othermodule != NULL ;
- p_othermodule = p_othermodule->next )
- {
- if( !strcmp( p_othermodule->psz_name, p_module->psz_name ) )
- {
- intf_WarnMsg( 5, "module warning: cannot load %s, a module named "
- "`%s' already exists",
- psz_filename, p_module->psz_name );
- free( p_module );
- module_unload( handle );
- return( -1 );
- }
- }
+ i_dirlen = strlen( psz_dir );
- /* Activate the module : fill the capability structure, etc. */
- if( CallSymbol( p_module, "ActivateModule" MODULE_SUFFIX ) != 0 )
+ /* Parse the directory and try to load all files it contains. */
+ while( (file = readdir( dir )) )
{
- /* We couldn't call ActivateModule() */
- free( p_module );
- module_unload( handle );
- return( -1 );
- }
+ struct stat statbuf;
+ int i_len;
- for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
- {
- *pp_shortcut = strdup( *pp_shortcut );
- }
-
- /* We strdup() these entries so that they are still valid when the
- * module is unloaded. */
- p_module->is.plugin.psz_filename =
- strdup( p_module->is.plugin.psz_filename );
- p_module->psz_name = strdup( p_module->psz_name );
- p_module->psz_longname = strdup( p_module->psz_longname );
-
- if( p_module->is.plugin.psz_filename == NULL
- || p_module->psz_name == NULL
- || p_module->psz_longname == NULL )
- {
- intf_ErrMsg( "module error: can't duplicate strings" );
-
- free( p_module->is.plugin.psz_filename );
- free( p_module->psz_name );
- free( p_module->psz_longname );
- free( p_module->psz_program );
-
- free( p_module );
- module_unload( handle );
- return( -1 );
- }
+ /* Skip ".", ".." and anything starting with "." */
+ if( !*file->d_name || *file->d_name == '.' )
+ {
+ continue;
+ }
- if( p_module->psz_program != NULL )
- {
- p_module->psz_program = strdup( p_module->psz_program );
- }
+ i_len = strlen( file->d_name );
- /* Everything worked fine ! The module is ready to be added to the list. */
- p_module->i_usage = 0;
- p_module->i_unused_delay = 0;
+ psz_file = malloc( i_dirlen + 1 /* / */ + i_len + 1 /* \0 */ );
+ sprintf( psz_file, "%s/%s", psz_dir, file->d_name );
- p_module->b_builtin = 0;
+ if( !stat( psz_file, &statbuf ) && statbuf.st_mode & S_IFDIR )
+ {
+ AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
+ }
+ else if( i_len > strlen( LIBEXT )
+ /* We only load files ending with LIBEXT */
+ && !strncmp( file->d_name + i_len - strlen( LIBEXT ),
+ LIBEXT, strlen( LIBEXT ) ) )
+ {
+ AllocatePluginFile( p_this, psz_file );
+ }
- /* Link module into the linked list */
- if( p_module_bank->first != NULL )
- {
- p_module_bank->first->prev = p_module;
+ free( psz_file );
}
- p_module->next = p_module_bank->first;
- p_module->prev = NULL;
- p_module_bank->first = p_module;
- p_module_bank->i_count++;
-
- /* Immediate message so that a slow module doesn't make the user wait */
- intf_WarnMsgImm( 2, "module: new plugin module `%s', %s",
- p_module->psz_name, p_module->psz_longname );
-
- return( 0 );
-}
-#endif /* HAVE_DYNAMIC_PLUGINS */
-/*****************************************************************************
- * AllocateAllBuiltins: load all modules we were built with.
- *****************************************************************************/
-static void AllocateAllBuiltins( void )
-{
- ALLOCATE_ALL_BUILTINS();
+ /* Close the directory */
+ closedir( dir );
}
/*****************************************************************************
- * AllocateBuiltinModule: initialize a built-in module.
+ * AllocatePluginFile: load a module into memory and initialize it.
*****************************************************************************
- * This function registers a built-in module and allocates a structure
- * for its information data. The module can then be handled by module_Need,
- * module_Unneed and HideModule. It can be removed by DeleteModule.
+ * This function loads a dynamically loadable module and allocates a structure
+ * for its information data. The module can then be handled by module_Need
+ * and module_Unneed. It can be removed by DeleteModule.
*****************************************************************************/
-static int AllocateBuiltinModule( int ( *pf_init ) ( module_t * ),
- int ( *pf_activate ) ( module_t * ),
- int ( *pf_deactivate ) ( module_t * ) )
+static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file )
{
- module_t * p_module, * p_othermodule;
+ module_t * p_module;
+ module_handle_t handle;
+
+ /* Try to dynamically load the module. */
+ if( module_load( psz_file, &handle ) )
+ {
+ char psz_buffer[256];
+
+ /* The plugin module couldn't be opened */
+ msg_Warn( p_this, "cannot open `%s' (%s)",
+ psz_file, module_error( psz_buffer ) );
+ return -1;
+ }
/* Now that we have successfully loaded the module, we can
* allocate a structure for it */
- p_module = malloc( sizeof( module_t ) );
+ p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
if( p_module == NULL )
{
- intf_ErrMsg( "module error: can't allocate p_module" );
- return( -1 );
+ msg_Err( p_this, "out of memory" );
+ module_unload( handle );
+ return -1;
}
- /* Initialize the module : fill p_module->psz_name, etc. */
- if( pf_init( p_module ) != 0 )
- {
- /* With a well-written module we shouldn't have to print an
- * additional error message here, but just make sure. */
- intf_ErrMsg( "module error: failed calling init in builtin module" );
- free( p_module );
- return( -1 );
- }
+ /* We need to fill these since they may be needed by CallEntry() */
+ p_module->psz_filename = psz_file;
+ p_module->handle = handle;
+ p_module->p_symbols = &p_this->p_libvlc->p_module_bank->symbols;
- /* Check that we don't already have a module with this name */
- for( p_othermodule = p_module_bank->first ;
- p_othermodule != NULL ;
- p_othermodule = p_othermodule->next )
+ /* Initialize the module: fill p_module->psz_object_name, default config */
+ if( CallEntry( p_module ) != 0 )
{
- if( !strcmp( p_othermodule->psz_name, p_module->psz_name ) )
- {
- intf_WarnMsg( 5, "module warning: cannot load builtin `%s', a "
- "module named `%s' already exists",
- p_module->psz_name, p_module->psz_name );
- free( p_module );
- return( -1 );
- }
+ /* We couldn't call module_init() */
+ vlc_object_destroy( p_module );
+ module_unload( handle );
+ return -1;
}
- if( pf_activate( p_module ) != 0 )
- {
- /* With a well-written module we shouldn't have to print an
- * additional error message here, but just make sure. */
- intf_ErrMsg( "module error: failed calling activate "
- "in builtin module" );
- free( p_module );
- return( -1 );
- }
+ DupModule( p_module );
+ p_module->psz_filename = strdup( p_module->psz_filename );
+ p_module->psz_longname = strdup( p_module->psz_longname );
/* Everything worked fine ! The module is ready to be added to the list. */
- p_module->i_usage = 0;
- p_module->i_unused_delay = 0;
-
- p_module->b_builtin = 1;
- p_module->is.builtin.pf_deactivate = pf_deactivate;
+ p_module->b_builtin = VLC_FALSE;
- /* Link module into the linked list */
- if( p_module_bank->first != NULL )
- {
- p_module_bank->first->prev = p_module;
- }
- p_module->next = p_module_bank->first;
- p_module->prev = NULL;
- p_module_bank->first = p_module;
- p_module_bank->i_count++;
+ /* msg_Dbg( p_this, "plugin \"%s\", %s",
+ p_module->psz_object_name, p_module->psz_longname ); */
- /* Immediate message so that a slow module doesn't make the user wait */
- intf_WarnMsgImm( 2, "module: new builtin module `%s', %s",
- p_module->psz_name, p_module->psz_longname );
+ vlc_object_attach( p_module, p_this->p_libvlc->p_module_bank );
- return( 0 );
+ return 0;
}
/*****************************************************************************
- * DeleteModule: delete a module and its structure.
+ * DupModule: make a plugin module standalone.
*****************************************************************************
- * This function can only be called if i_usage <= 0.
+ * This function duplicates all strings in the module, so that the dynamic
+ * object can be unloaded. It acts recursively on submodules.
*****************************************************************************/
-static int DeleteModule( module_t * p_module )
+static void DupModule( module_t *p_module )
{
- /* If the module is not in use but is still in memory, we first have
- * to hide it and remove it from memory before we can free the
- * data structure. */
- if( p_module->b_builtin )
- {
- if( p_module->i_usage != 0 )
- {
- intf_ErrMsg( "module error: trying to free builtin module `%s' with"
- " usage %i", p_module->psz_name, p_module->i_usage );
- return( -1 );
- }
- else
- {
- /* We deactivate the module now. */
- p_module->is.builtin.pf_deactivate( p_module );
- }
- }
-#ifdef HAVE_DYNAMIC_PLUGINS
- else
- {
- if( p_module->i_usage >= 1 )
- {
- intf_ErrMsg( "module error: trying to free module `%s' which is"
- " still in use", p_module->psz_name );
- return( -1 );
- }
-
- /* Two possibilities here: i_usage == -1 and the module is already
- * unloaded, we can continue, or i_usage == 0, and we have to hide
- * the module before going on. */
- if( p_module->i_usage == 0 )
- {
- if( HideModule( p_module ) != 0 )
- {
- return( -1 );
- }
- }
- }
-#endif
+ char **pp_shortcut;
+ int i_submodule;
- /* Unlink the module from the linked list. */
- if( p_module->prev != NULL )
- {
- p_module->prev->next = p_module->next;
- }
- else
+ for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
{
- p_module_bank->first = p_module->next;
+ *pp_shortcut = strdup( *pp_shortcut );
}
- if( p_module->next != NULL )
+ /* We strdup() these entries so that they are still valid when the
+ * module is unloaded. */
+ p_module->psz_object_name = strdup( p_module->psz_object_name );
+ p_module->psz_capability = strdup( p_module->psz_capability );
+
+ if( p_module->psz_program != NULL )
{
- p_module->next->prev = p_module->prev;
+ p_module->psz_program = strdup( p_module->psz_program );
}
- p_module_bank->i_count--;
-
- /* We free the structures that we strdup()ed in Allocate*Module(). */
-#ifdef HAVE_DYNAMIC_PLUGINS
- if( !p_module->b_builtin )
+ for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
{
- char **pp_shortcut = p_module->pp_shortcuts;
-
- for( ; *pp_shortcut ; pp_shortcut++ )
- {
- free( *pp_shortcut );
- }
-
- free( p_module->is.plugin.psz_filename );
- free( p_module->psz_name );
- free( p_module->psz_longname );
- free( p_module->psz_program );
+ DupModule( (module_t*)p_module->pp_children[ i_submodule ] );
}
-#endif
-
- free( p_module );
-
- return( 0 );
}
/*****************************************************************************
- * LockModule: increase the usage count of a module and load it if needed.
+ * UndupModule: free a duplicated 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 LockModule() at any moment, be careful to call
- * UnlockModule() when you don't need it anymore.
+ * This function frees the allocations done in DupModule().
*****************************************************************************/
-static int LockModule( module_t * p_module )
+static void UndupModule( 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 );
- }
+ char **pp_shortcut;
+ int i_submodule;
-#ifdef HAVE_DYNAMIC_PLUGINS
- if( p_module->i_usage != -1 )
+ for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
{
- /* This shouldn't happen. Ever. We have serious problems here. */
- intf_ErrMsg( "module error: plugin module `%s' has refcount %i",
- p_module->psz_name, p_module->i_usage );
- return( -1 );
+ UndupModule( (module_t*)p_module->pp_children[ i_submodule ] );
}
- /* i_usage == -1, which means that the module isn't in memory */
- if( module_load( p_module->is.plugin.psz_filename,
- &p_module->is.plugin.handle ) )
+ for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
{
- /* The plugin module couldn't be opened */
- intf_ErrMsg( "module error: cannot open %s (%s)",
- p_module->is.plugin.psz_filename, module_error() );
- return( -1 );
+ free( *pp_shortcut );
}
- /* 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. */
+ free( p_module->psz_object_name );
+ free( p_module->psz_capability );
- /* Activate the module : fill the capability structure, etc. */
- if( CallSymbol( p_module, "ActivateModule" MODULE_SUFFIX ) != 0 )
+ if( p_module->psz_program != 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->is.plugin.handle );
- p_module->i_usage = -1;
- return( -1 );
+ free( p_module->psz_program );
}
+}
- /* Everything worked fine ! The module is ready to be used */
- p_module->i_usage = 1;
#endif /* HAVE_DYNAMIC_PLUGINS */
- return( 0 );
-}
-
/*****************************************************************************
- * UnlockModule: decrease the usage count of a module.
+ * AllocateBuiltinModule: initialize a builtin module.
*****************************************************************************
- * We decrease the usage count of a module so that we know when a module
- * becomes unused and can be hidden.
+ * This function registers a builtin module and allocates a structure
+ * for its information data. The module can then be handled by module_Need
+ * and module_Unneed. It can be removed by DeleteModule.
*****************************************************************************/
-static int UnlockModule( module_t * p_module )
+static int AllocateBuiltinModule( vlc_object_t * p_this,
+ int ( *pf_entry ) ( module_t * ) )
{
- if( p_module->i_usage <= 0 )
+ module_t * p_module;
+
+ /* 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 )
{
- /* 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 );
+ msg_Err( p_this, "out of memory" );
+ return -1;
}
- /* This module is still in use, we can return */
- p_module->i_usage--;
- p_module->i_unused_delay = 0;
+ /* Initialize the module : fill p_module->psz_object_name, etc. */
+ if( pf_entry( p_module ) != 0 )
+ {
+ /* With a well-written module we shouldn't have to print an
+ * additional error message here, but just make sure. */
+ msg_Err( p_this, "failed calling entry point in builtin module" );
+ vlc_object_destroy( p_module );
+ return -1;
+ }
+
+ /* Everything worked fine ! The module is ready to be added to the list. */
+ p_module->b_builtin = VLC_TRUE;
+
+ /* msg_Dbg( p_this, "builtin \"%s\", %s",
+ p_module->psz_object_name, p_module->psz_longname ); */
+
+ vlc_object_attach( p_module, p_this->p_libvlc->p_module_bank );
- return( 0 );
+ return 0;
}
-#ifdef HAVE_DYNAMIC_PLUGINS
/*****************************************************************************
- * HideModule: remove a module from memory but keep its structure.
+ * DeleteModule: delete a module and its structure.
*****************************************************************************
- * This function can only be called if i_usage == 0. It will make a call
- * to the module's inner DeactivateModule() symbol, and then unload it
- * from memory. A call to module_Need() will automagically load it again.
+ * This function can only be called if the module isn't being used.
*****************************************************************************/
-static int HideModule( module_t * p_module )
+static int DeleteModule( module_t * p_module )
{
- if( p_module->b_builtin )
- {
- /* A built-in module should never be hidden. */
- intf_ErrMsg( "module error: trying to hide built-in module `%s'",
- p_module->psz_name );
- return( -1 );
- }
+ vlc_object_detach( p_module );
- if( p_module->i_usage >= 1 )
- {
- intf_ErrMsg( "module error: trying to hide module `%s' which is still"
- " in use", p_module->psz_name );
- return( -1 );
- }
-
- if( p_module->i_usage <= -1 )
+ /* We free the structures that we strdup()ed in Allocate*Module(). */
+#ifdef HAVE_DYNAMIC_PLUGINS
+ if( !p_module->b_builtin )
{
- intf_ErrMsg( "module error: trying to hide module `%s' which is already"
- " hidden", p_module->psz_name );
- return( -1 );
+ if( p_module->b_unloadable )
+ {
+ module_unload( p_module->handle );
+ }
+ UndupModule( p_module );
+ free( p_module->psz_filename );
+ free( p_module->psz_longname );
}
+#endif
- /* Deactivate the module : free the capability structure, etc. */
- if( CallSymbol( p_module, "DeactivateModule" MODULE_SUFFIX ) != 0 )
+ /* Free and detach the object's children */
+ while( p_module->i_children )
{
- /* We couldn't call DeactivateModule() -- looks nasty, but
- * we can't do much about it. Just try to unload module anyway. */
- module_unload( p_module->is.plugin.handle );
- p_module->i_usage = -1;
- return( -1 );
+ vlc_object_t *p_this = p_module->pp_children[0];
+ vlc_object_detach( p_this );
+ vlc_object_destroy( p_this );
}
- /* Everything worked fine, we can safely unload the module. */
- module_unload( p_module->is.plugin.handle );
- p_module->i_usage = -1;
+ config_Free( p_module );
+ vlc_object_destroy( p_module );
- return( 0 );
+ return 0;
}
+#ifdef HAVE_DYNAMIC_PLUGINS
/*****************************************************************************
- * CallSymbol: calls a module symbol.
+ * CallEntry: call an entry point.
*****************************************************************************
* This function calls a symbol given its name and a module structure. The
* symbol MUST refer to a function returning int and taking a module_t* as
* an argument.
*****************************************************************************/
-static int CallSymbol( module_t * p_module, char * psz_name )
+static int CallEntry( module_t * p_module )
{
+ static char *psz_name = "vlc_entry" MODULE_SUFFIX;
int (* pf_symbol) ( module_t * p_module );
/* Try to resolve the symbol */
- pf_symbol = module_getsymbol( p_module->is.plugin.handle, psz_name );
+ pf_symbol = (int (*)(module_t *)) module_getsymbol( p_module->handle,
+ psz_name );
if( pf_symbol == NULL )
{
+ char psz_buffer[256];
+
/* We couldn't load the symbol */
- intf_WarnMsg( 1, "module warning: "
- "cannot find symbol %s in module %s (%s)",
- psz_name, p_module->is.plugin.psz_filename,
- module_error() );
- return( -1 );
+ msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
+ psz_name, p_module->psz_filename,
+ module_error( psz_buffer ) );
+ return -1;
}
/* We can now try to call the symbol */
{
/* With a well-written module we shouldn't have to print an
* additional error message here, but just make sure. */
- intf_ErrMsg( "module error: failed calling symbol %s in module %s",
- psz_name, p_module->is.plugin.psz_filename );
- return( -1 );
+ msg_Err( p_module, "failed calling symbol \"%s\" in file `%s'",
+ psz_name, p_module->psz_filename );
+ return -1;
}
/* Everything worked fine, we can return */
- return( 0 );
+ return 0;
}
#endif /* HAVE_DYNAMIC_PLUGINS */
projects / vlc / blobdiff