1 /*****************************************************************************
2 * modules.c : Builtin and plugin modules management functions
3 *****************************************************************************
4 * Copyright (C) 2001-2004 VideoLAN
7 * Authors: Sam Hocevar <sam@zoy.org>
8 * Ethan C. Baldridge <BaldridgeE@cadmus.com>
9 * Hans-Peter Jansen <hpj@urpla.net>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
26 /* Some faulty libcs have a broken struct dirent when _FILE_OFFSET_BITS
27 * is set to 64. Don't try to be cleverer. */
28 #ifdef _FILE_OFFSET_BITS
29 #undef _FILE_OFFSET_BITS
32 #include <stdlib.h> /* free(), strtol() */
33 #include <stdio.h> /* sprintf() */
34 #include <string.h> /* strdup() */
40 #elif defined( UNDER_CE )
41 # include <windows.h> /* GetFileAttributes() */
43 # include "../extras/dirent.h"
46 #ifdef HAVE_SYS_TYPES_H
47 # include <sys/types.h>
49 #ifdef HAVE_SYS_STAT_H
50 # include <sys/stat.h>
56 #define HAVE_DYNAMIC_PLUGINS
57 #if defined(HAVE_DL_DYLD)
58 # if defined(HAVE_MACH_O_DYLD_H)
59 # include <mach-o/dyld.h>
61 #elif defined(HAVE_DL_BEOS)
62 # if defined(HAVE_IMAGE_H)
65 #elif defined(HAVE_DL_WINDOWS)
67 #elif defined(HAVE_DL_DLOPEN)
68 # if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
71 # if defined(HAVE_SYS_DL_H)
74 #elif defined(HAVE_DL_SHL_LOAD)
75 # if defined(HAVE_DL_H)
79 # undef HAVE_DYNAMIC_PLUGINS
82 #include "vlc_error.h"
84 #include "vlc_interface.h"
85 #include "vlc_playlist.h"
86 #include "intf_eject.h"
88 #include "stream_control.h"
89 #include "input_ext-intf.h"
90 #include "input_ext-dec.h"
91 #include "input_ext-plugins.h"
94 #include "vlc_video.h"
95 #include "video_output.h"
96 #include "vout_synchro.h"
98 #include "audio_output.h"
99 #include "aout_internal.h"
101 #include "stream_output.h"
103 #include "vlc_httpd.h"
105 #include "iso_lang.h"
108 #include "vlc_block.h"
112 #if defined( UNDER_CE )
113 # define MYCHAR wchar_t
118 #ifdef HAVE_DYNAMIC_PLUGINS
119 # include "modules_plugin.h"
122 #if defined( UNDER_CE )
123 # include "modules_builtin_evc.h"
124 #elif defined( _MSC_VER )
125 # include "modules_builtin_msvc.h"
127 # include "modules_builtin.h"
131 /*****************************************************************************
133 *****************************************************************************/
134 #ifdef HAVE_DYNAMIC_PLUGINS
135 static void AllocateAllPlugins ( vlc_object_t * );
136 static void AllocatePluginDir ( vlc_object_t *, const MYCHAR *, int );
137 static int AllocatePluginFile ( vlc_object_t *, MYCHAR * );
139 static int AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
140 static int DeleteModule ( module_t * );
141 #ifdef HAVE_DYNAMIC_PLUGINS
142 static void DupModule ( module_t * );
143 static void UndupModule ( module_t * );
144 static int CallEntry ( module_t * );
145 static void CloseModule ( module_handle_t );
146 static void * GetSymbol ( module_handle_t, const char * );
147 #if defined(HAVE_DL_WINDOWS)
148 static char * GetWindowsError ( void );
152 /*****************************************************************************
153 * module_InitBank: create the module bank.
154 *****************************************************************************
155 * This function creates a module bank structure which will be filled later
156 * on with all the modules found.
157 *****************************************************************************/
158 void __module_InitBank( vlc_object_t *p_this )
160 module_bank_t *p_bank;
162 p_bank = vlc_object_create( p_this, sizeof(module_bank_t) );
163 p_bank->psz_object_name = "module bank";
166 * Store the symbols to be exported
168 #ifdef HAVE_DYNAMIC_PLUGINS
169 STORE_SYMBOLS( &p_bank->symbols );
172 /* Everything worked, attach the object */
173 p_this->p_libvlc->p_module_bank = p_bank;
174 vlc_object_attach( p_bank, p_this->p_libvlc );
179 /*****************************************************************************
180 * module_ResetBank: reset the module bank.
181 *****************************************************************************
182 * This function resets the module bank by unloading all unused plugin
184 *****************************************************************************/
185 void __module_ResetBank( vlc_object_t *p_this )
187 msg_Err( p_this, "FIXME: module_ResetBank unimplemented" );
191 /*****************************************************************************
192 * module_EndBank: empty the module bank.
193 *****************************************************************************
194 * This function unloads all unused plugin modules and empties the module
195 * bank in case of success.
196 *****************************************************************************/
197 void __module_EndBank( vlc_object_t *p_this )
201 vlc_object_detach( p_this->p_libvlc->p_module_bank );
203 while( p_this->p_libvlc->p_module_bank->i_children )
205 p_next = (module_t *)p_this->p_libvlc->p_module_bank->pp_children[0];
207 if( DeleteModule( p_next ) )
209 /* Module deletion failed */
210 msg_Err( p_this, "module \"%s\" can't be removed, trying harder",
211 p_next->psz_object_name );
213 /* We just free the module by hand. Niahahahahaha. */
214 vlc_object_detach( p_next );
215 vlc_object_destroy( p_next );
219 vlc_object_destroy( p_this->p_libvlc->p_module_bank );
224 /*****************************************************************************
225 * module_LoadMain: load the main program info into the module bank.
226 *****************************************************************************
227 * This function fills the module bank structure with the main module infos.
228 * This is very useful as it will allow us to consider the main program just
229 * as another module, and for instance the configuration options of main will
230 * be available in the module bank structure just as for every other module.
231 *****************************************************************************/
232 void __module_LoadMain( vlc_object_t *p_this )
234 AllocateBuiltinModule( p_this, vlc_entry__main );
237 /*****************************************************************************
238 * module_LoadBuiltins: load all modules which we built with.
239 *****************************************************************************
240 * This function fills the module bank structure with the builtin modules.
241 *****************************************************************************/
242 void __module_LoadBuiltins( vlc_object_t * p_this )
244 msg_Dbg( p_this, "checking builtin modules" );
245 ALLOCATE_ALL_BUILTINS();
248 /*****************************************************************************
249 * module_LoadPlugins: load all plugin modules we can find.
250 *****************************************************************************
251 * This function fills the module bank structure with the plugin modules.
252 *****************************************************************************/
253 void __module_LoadPlugins( vlc_object_t * p_this )
255 #ifdef HAVE_DYNAMIC_PLUGINS
256 msg_Dbg( p_this, "checking plugin modules" );
257 AllocateAllPlugins( p_this );
261 /*****************************************************************************
262 * module_Need: return the best module function, given a capability list.
263 *****************************************************************************
264 * This function returns the module that best fits the asked capabilities.
265 *****************************************************************************/
266 module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
267 const char *psz_name, vlc_bool_t b_strict )
269 typedef struct module_list_t module_list_t;
275 module_list_t *p_next;
278 module_list_t *p_list, *p_first, *p_tmp;
281 int i_which_module, i_index = 0;
282 vlc_bool_t b_intf = VLC_FALSE;
287 char *psz_shortcuts = NULL, *psz_var = NULL;
289 msg_Dbg( p_this, "looking for %s module", psz_capability );
291 /* Deal with variables */
292 if( psz_name && psz_name[0] == '$' )
295 var_Create( p_this, psz_name + 1, VLC_VAR_MODULE | VLC_VAR_DOINHERIT );
296 var_Get( p_this, psz_name + 1, &val );
297 psz_var = val.psz_string;
301 /* Count how many different shortcuts were asked for */
302 if( psz_name && *psz_name )
304 char *psz_parser, *psz_last_shortcut;
306 /* If the user wants none, give him none. */
307 if( !strcmp( psz_name, "none" ) )
309 if( psz_var ) free( psz_var );
314 psz_shortcuts = psz_last_shortcut = strdup( psz_name );
316 for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
318 if( *psz_parser == ',' )
322 psz_last_shortcut = psz_parser + 1;
326 /* Check if the user wants to override the "strict" mode */
327 if( psz_last_shortcut )
329 if( !strcmp(psz_last_shortcut, "none") )
334 else if( !strcmp(psz_last_shortcut, "any") )
336 b_strict = VLC_FALSE;
342 /* Sort the modules and test them */
343 p_all = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
344 p_list = malloc( p_all->i_count * sizeof( module_list_t ) );
347 /* Parse the module list for capabilities and probe each of them */
348 for( i_which_module = 0; i_which_module < p_all->i_count; i_which_module++ )
350 module_t * p_submodule = NULL;
351 int i_shortcut_bonus = 0, i_submodule;
353 p_module = (module_t *)p_all->p_values[i_which_module].p_object;
355 /* Test that this module can do what we need */
356 if( strcmp( p_module->psz_capability, psz_capability ) )
358 for( i_submodule = 0;
359 i_submodule < p_module->i_children;
362 if( !strcmp( ((module_t*)p_module->pp_children[ i_submodule ])
363 ->psz_capability, psz_capability ) )
366 (module_t*)p_module->pp_children[ i_submodule ];
371 if( p_submodule == NULL )
376 p_module = p_submodule;
379 /* Test if we have the required CPU */
380 if( (p_module->i_cpu & p_this->p_libvlc->i_cpu) != p_module->i_cpu )
385 /* If we required a shortcut, check this plugin provides it. */
386 if( i_shortcuts > 0 )
389 int i_dummy, i_short = i_shortcuts;
390 char *psz_name = psz_shortcuts;
392 /* Let's drop modules with a 0 score (unless they are
393 * explicitly requested) */
394 b_trash = !p_module->i_score;
398 for( i_dummy = 0; p_module->pp_shortcuts[i_dummy]; i_dummy++ )
400 if( !strcasecmp( psz_name,
401 p_module->pp_shortcuts[i_dummy] ) )
405 i_shortcut_bonus = i_short * 10000;
410 if( i_shortcut_bonus )
412 /* We found it... remember ? */
416 /* Go to the next shortcut... This is so lame! */
425 /* If we are in "strict" mode and we couldn't
426 * find the module in the list of provided shortcuts,
427 * then kick the bastard out of here!!! */
428 if( i_short == 0 && b_strict )
438 /* If we didn't require a shortcut, trash zero-scored plugins */
439 else if( !p_module->i_score )
444 /* Special case: test if we requested a particular intf plugin */
445 if( !i_shortcuts && p_module->psz_program
446 && !strcmp( p_module->psz_program,
447 p_this->p_vlc->psz_object_name ) )
451 /* Remove previous non-matching plugins */
458 /* This one doesn't match */
462 /* Store this new module */
463 p_list[ i_index ].p_module = p_module;
464 p_list[ i_index ].i_score = p_module->i_score + i_shortcut_bonus;
466 /* Add it to the modules-to-probe list */
469 p_list[ 0 ].p_next = NULL;
474 /* Ok, so at school you learned that quicksort is quick, and
475 * bubble sort sucks raw eggs. But that's when dealing with
476 * thousands of items. Here we have barely 50. */
477 module_list_t *p_newlist = p_first;
479 if( p_first->i_score < p_list[ i_index ].i_score )
481 p_list[ i_index ].p_next = p_first;
482 p_first = &p_list[ i_index ];
486 while( p_newlist->p_next != NULL &&
487 p_newlist->p_next->i_score >= p_list[ i_index ].i_score )
489 p_newlist = p_newlist->p_next;
492 p_list[ i_index ].p_next = p_newlist->p_next;
493 p_newlist->p_next = &p_list[ i_index ];
500 msg_Dbg( p_this, "probing %i candidate%s",
501 i_index, i_index == 1 ? "" : "s" );
503 /* Lock all candidate modules */
505 while( p_tmp != NULL )
507 vlc_object_yield( p_tmp->p_module );
508 p_tmp = p_tmp->p_next;
511 /* We can release the list, interesting modules were yielded */
512 vlc_list_release( p_all );
514 /* Parse the linked list and use the first successful module */
516 while( p_tmp != NULL )
518 if( p_tmp->p_module->pf_activate
519 && p_tmp->p_module->pf_activate( p_this ) == VLC_SUCCESS )
524 vlc_object_release( p_tmp->p_module );
525 p_tmp = p_tmp->p_next;
528 /* Store the locked module value */
531 p_module = p_tmp->p_module;
532 p_tmp = p_tmp->p_next;
539 /* Unlock the remaining modules */
540 while( p_tmp != NULL )
542 vlc_object_release( p_tmp->p_module );
543 p_tmp = p_tmp->p_next;
548 if( p_module != NULL )
550 msg_Dbg( p_module, "using %s module \"%s\"",
551 psz_capability, p_module->psz_object_name );
553 else if( p_first == NULL )
555 msg_Err( p_this, "no %s module matched \"%s\"",
556 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
558 else if( psz_name != NULL && *psz_name )
560 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
561 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
566 free( psz_shortcuts );
574 /* Don't forget that the module is still locked */
578 /*****************************************************************************
579 * module_Unneed: decrease the usage count of a module.
580 *****************************************************************************
581 * This function must be called by the thread that called module_Need, to
582 * decrease the reference count and allow for hiding of modules.
583 *****************************************************************************/
584 void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
586 /* Use the close method */
587 if( p_module->pf_deactivate )
589 p_module->pf_deactivate( p_this );
592 msg_Dbg( p_module, "unlocking module \"%s\"", p_module->psz_object_name );
594 vlc_object_release( p_module );
599 /*****************************************************************************
600 * Following functions are local.
601 *****************************************************************************/
603 /*****************************************************************************
604 * AllocateAllPlugins: load all plugin modules we can find.
605 *****************************************************************************/
606 #ifdef HAVE_DYNAMIC_PLUGINS
607 static void AllocateAllPlugins( vlc_object_t *p_this )
609 /* Yes, there are two NULLs because we replace one with "plugin-path". */
610 char * path[] = { "modules", PLUGIN_PATH, "plugins", NULL,
613 char ** ppsz_path = path;
616 #if defined( UNDER_CE )
617 wchar_t psz_dir[MAX_PATH];
620 /* If the user provided a plugin path, we add it to the list */
621 path[ sizeof(path)/sizeof(char*) - 2 ] = config_GetPsz( p_this,
624 for( ; *ppsz_path != NULL ; ppsz_path++ )
626 #if defined( SYS_BEOS ) || defined( SYS_DARWIN ) \
627 || ( defined( WIN32 ) && !defined( UNDER_CE ) )
629 /* Handle relative as well as absolute paths */
631 if( !(*ppsz_path)[0] || (*ppsz_path)[1] != ':' )
633 if( (*ppsz_path)[0] != '/' )
636 int i_dirlen = strlen( *ppsz_path );
637 i_dirlen += strlen( p_this->p_libvlc->psz_vlcpath ) + 2;
639 psz_fullpath = malloc( i_dirlen );
640 if( psz_fullpath == NULL )
645 sprintf( psz_fullpath, "%s\\%s",
646 p_this->p_libvlc->psz_vlcpath, *ppsz_path );
648 sprintf( psz_fullpath, "%s/%s",
649 p_this->p_libvlc->psz_vlcpath, *ppsz_path );
655 psz_fullpath = strdup( *ppsz_path );
658 msg_Dbg( p_this, "recursively browsing `%s'", psz_fullpath );
660 /* Don't go deeper than 5 subdirectories */
661 #if defined( UNDER_CE )
662 MultiByteToWideChar( CP_ACP, 0, psz_fullpath, -1, psz_dir, MAX_PATH );
663 AllocatePluginDir( p_this, psz_dir, 5 );
665 AllocatePluginDir( p_this, psz_fullpath, 5 );
668 free( psz_fullpath );
671 /* Free plugin-path */
672 if( path[ sizeof(path)/sizeof(char*) - 2 ] )
673 free( path[ sizeof(path)/sizeof(char*) - 2 ] );
674 path[ sizeof(path)/sizeof(char*) - 2 ] = NULL;
677 /*****************************************************************************
678 * AllocatePluginDir: recursively parse a directory to look for plugins
679 *****************************************************************************/
680 static void AllocatePluginDir( vlc_object_t *p_this, const MYCHAR *psz_dir,
683 #if defined( UNDER_CE ) || defined( _MSC_VER )
685 MYCHAR psz_path[MAX_PATH + 256];
687 char psz_path[MAX_PATH + 256];
689 WIN32_FIND_DATA finddata;
696 struct dirent * file;
699 if( p_this->p_vlc->b_die || i_maxdepth < 0 )
704 #if defined( UNDER_CE ) || defined( _MSC_VER )
705 rc = GetFileAttributes( psz_dir );
706 if( !(rc & FILE_ATTRIBUTE_DIRECTORY) )
708 /* Not a directory */
712 /* Parse all files in the directory */
714 swprintf( psz_path, L"%s\\*.*", psz_dir );
716 sprintf( psz_path, "%s\\*.*", psz_dir );
718 handle = FindFirstFile( psz_path, &finddata );
719 if( handle == INVALID_HANDLE_VALUE )
721 /* Empty directory */
725 /* Parse the directory and try to load all files it contains. */
729 unsigned int i_len = wcslen( finddata.cFileName );
730 swprintf( psz_path, L"%s\\%s", psz_dir, finddata.cFileName );
732 unsigned int i_len = strlen( finddata.cFileName );
733 /* Skip ".", ".." and anything starting with "." */
734 if( !*finddata.cFileName || *finddata.cFileName == '.' )
736 if( !FindNextFile( handle, &finddata ) ) break;
739 sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
742 if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
744 AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
746 else if( i_len > strlen( LIBEXT )
750 /* We only load files ending with LIBEXT */
751 && !strncasecmp( psz_path + strlen( psz_path)
753 LIBEXT, strlen( LIBEXT ) ) )
756 AllocatePluginFile( p_this, psz_path );
759 while( !p_this->p_vlc->b_die && FindNextFile( handle, &finddata ) );
761 /* Close the directory */
765 dir = opendir( psz_dir );
771 i_dirlen = strlen( psz_dir );
773 /* Parse the directory and try to load all files it contains. */
774 while( !p_this->p_vlc->b_die && (file = readdir( dir )) )
779 /* Skip ".", ".." and anything starting with "." */
780 if( !*file->d_name || *file->d_name == '.' )
785 i_len = strlen( file->d_name );
786 psz_file = malloc( i_dirlen + 1 + i_len + 1 );
788 sprintf( psz_file, "%s\\%s", psz_dir, file->d_name );
790 sprintf( psz_file, "%s/%s", psz_dir, file->d_name );
793 if( !stat( psz_file, &statbuf ) && statbuf.st_mode & S_IFDIR )
795 AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
797 else if( i_len > strlen( LIBEXT )
798 /* We only load files ending with LIBEXT */
799 && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
800 LIBEXT, strlen( LIBEXT ) ) )
802 AllocatePluginFile( p_this, psz_file );
808 /* Close the directory */
814 /*****************************************************************************
815 * AllocatePluginFile: load a module into memory and initialize it.
816 *****************************************************************************
817 * This function loads a dynamically loadable module and allocates a structure
818 * for its information data. The module can then be handled by module_Need
819 * and module_Unneed. It can be removed by DeleteModule.
820 *****************************************************************************/
821 static int AllocatePluginFile( vlc_object_t * p_this, MYCHAR * psz_file )
824 module_handle_t handle;
827 * Try to dynamically load the module. This part is very platform-
828 * specific, and error messages should be as verbose as possible.
831 #if defined(HAVE_DL_DYLD)
832 NSObjectFileImage image;
833 NSObjectFileImageReturnCode ret;
835 ret = NSCreateObjectFileImageFromFile( psz_file, &image );
837 if( ret != NSObjectFileImageSuccess )
839 msg_Warn( p_this, "cannot create image from `%s'", psz_file );
843 /* Open the dynamic module */
844 handle = NSLinkModule( image, psz_file,
845 NSLINKMODULE_OPTION_RETURN_ON_ERROR );
849 NSLinkEditErrors errors;
850 const char *psz_file, *psz_err;
852 NSLinkEditError( &errors, &i_errnum, &psz_file, &psz_err );
853 msg_Warn( p_this, "cannot link module `%s' (%s)", psz_file, psz_err );
854 NSDestroyObjectFileImage( image );
858 /* Destroy our image, we won't need it */
859 NSDestroyObjectFileImage( image );
861 #elif defined(HAVE_DL_BEOS)
862 handle = load_add_on( psz_file );
865 msg_Warn( p_this, "cannot load module `%s'", psz_file );
869 #elif defined(HAVE_DL_WINDOWS) && defined(UNDER_CE)
870 char psz_filename[MAX_PATH];
871 WideCharToMultiByte( CP_ACP, WC_DEFAULTCHAR, psz_file, -1,
872 psz_filename, MAX_PATH, NULL, NULL );
873 handle = LoadLibrary( psz_filename );
876 char *psz_error = GetWindowsError();
877 msg_Warn( p_this, "cannot load module `%s' (%s)",
878 psz_filename, psz_error );
882 #elif defined(HAVE_DL_WINDOWS) && defined(WIN32)
883 handle = LoadLibrary( psz_file );
886 char *psz_error = GetWindowsError();
887 msg_Warn( p_this, "cannot load module `%s' (%s)",
888 psz_file, psz_error );
892 #elif defined(HAVE_DL_DLOPEN) && defined(RTLD_NOW)
893 /* static is OK, we are called atomically */
894 static vlc_bool_t b_kde = VLC_FALSE;
896 # if defined(SYS_LINUX)
897 /* XXX HACK #1 - we should NOT open modules with RTLD_GLOBAL, or we
898 * are going to get namespace collisions when two modules have common
899 * public symbols, but ALSA is being a pest here. */
900 if( strstr( psz_file, "alsa_plugin" ) )
902 handle = dlopen( psz_file, RTLD_NOW | RTLD_GLOBAL );
905 msg_Warn( p_this, "cannot load module `%s' (%s)",
906 psz_file, dlerror() );
911 /* XXX HACK #2 - the ugly KDE workaround. It seems that libkdewhatever
912 * causes dlopen() to segfault if libstdc++ is not loaded in the caller,
913 * so we just load libstdc++. Bwahahaha! ph34r! -- Sam. */
914 /* Update: FYI, this is Debian bug #180505, and seems to be fixed. */
915 if( !b_kde && !strstr( psz_file, "kde" ) )
917 dlopen( "libstdc++.so.6", RTLD_NOW )
918 || dlopen( "libstdc++.so.5", RTLD_NOW )
919 || dlopen( "libstdc++.so.4", RTLD_NOW )
920 || dlopen( "libstdc++.so.3", RTLD_NOW );
924 handle = dlopen( psz_file, RTLD_NOW );
927 msg_Warn( p_this, "cannot load module `%s' (%s)",
928 psz_file, dlerror() );
932 #elif defined(HAVE_DL_DLOPEN)
933 # if defined(DL_LAZY)
934 handle = dlopen( psz_file, DL_LAZY );
936 handle = dlopen( psz_file, 0 );
940 msg_Warn( p_this, "cannot load module `%s' (%s)",
941 psz_file, dlerror() );
945 #elif defined(HAVE_DL_SHL_LOAD)
946 handle = shl_load( psz_file, BIND_IMMEDIATE | BIND_NONFATAL, NULL );
949 msg_Warn( p_this, "cannot load module `%s' (%s)",
950 psz_file, strerror(errno) );
955 # error "Something is wrong in modules.c"
959 /* Now that we have successfully loaded the module, we can
960 * allocate a structure for it */
961 p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
962 if( p_module == NULL )
964 msg_Err( p_this, "out of memory" );
965 CloseModule( handle );
969 /* We need to fill these since they may be needed by CallEntry() */
971 p_module->psz_filename = psz_filename;
973 p_module->psz_filename = psz_file;
975 p_module->handle = handle;
976 p_module->p_symbols = &p_this->p_libvlc->p_module_bank->symbols;
978 /* Initialize the module: fill p_module->psz_object_name, default config */
979 if( CallEntry( p_module ) != 0 )
981 /* We couldn't call module_init() */
982 vlc_object_destroy( p_module );
983 CloseModule( handle );
987 DupModule( p_module );
988 p_module->psz_filename = strdup( p_module->psz_filename );
989 p_module->psz_longname = strdup( p_module->psz_longname );
991 /* Everything worked fine ! The module is ready to be added to the list. */
992 p_module->b_builtin = VLC_FALSE;
994 /* msg_Dbg( p_this, "plugin \"%s\", %s",
995 p_module->psz_object_name, p_module->psz_longname ); */
997 vlc_object_attach( p_module, p_this->p_libvlc->p_module_bank );
1002 /*****************************************************************************
1003 * DupModule: make a plugin module standalone.
1004 *****************************************************************************
1005 * This function duplicates all strings in the module, so that the dynamic
1006 * object can be unloaded. It acts recursively on submodules.
1007 *****************************************************************************/
1008 static void DupModule( module_t *p_module )
1013 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1015 *pp_shortcut = strdup( *pp_shortcut );
1018 /* We strdup() these entries so that they are still valid when the
1019 * module is unloaded. */
1020 p_module->psz_object_name = strdup( p_module->psz_object_name );
1021 p_module->psz_capability = strdup( p_module->psz_capability );
1023 if( p_module->psz_program != NULL )
1025 p_module->psz_program = strdup( p_module->psz_program );
1028 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1030 DupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1034 /*****************************************************************************
1035 * UndupModule: free a duplicated module.
1036 *****************************************************************************
1037 * This function frees the allocations done in DupModule().
1038 *****************************************************************************/
1039 static void UndupModule( module_t *p_module )
1044 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1046 UndupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1049 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1051 free( *pp_shortcut );
1054 free( p_module->psz_object_name );
1055 free( p_module->psz_capability );
1057 if( p_module->psz_program != NULL )
1059 free( p_module->psz_program );
1063 #endif /* HAVE_DYNAMIC_PLUGINS */
1065 /*****************************************************************************
1066 * AllocateBuiltinModule: initialize a builtin module.
1067 *****************************************************************************
1068 * This function registers a builtin module and allocates a structure
1069 * for its information data. The module can then be handled by module_Need
1070 * and module_Unneed. It can be removed by DeleteModule.
1071 *****************************************************************************/
1072 static int AllocateBuiltinModule( vlc_object_t * p_this,
1073 int ( *pf_entry ) ( module_t * ) )
1075 module_t * p_module;
1077 /* Now that we have successfully loaded the module, we can
1078 * allocate a structure for it */
1079 p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
1080 if( p_module == NULL )
1082 msg_Err( p_this, "out of memory" );
1086 /* Initialize the module : fill p_module->psz_object_name, etc. */
1087 if( pf_entry( p_module ) != 0 )
1089 /* With a well-written module we shouldn't have to print an
1090 * additional error message here, but just make sure. */
1091 msg_Err( p_this, "failed calling entry point in builtin module" );
1092 vlc_object_destroy( p_module );
1096 /* Everything worked fine ! The module is ready to be added to the list. */
1097 p_module->b_builtin = VLC_TRUE;
1099 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1100 p_module->psz_object_name, p_module->psz_longname ); */
1102 vlc_object_attach( p_module, p_this->p_libvlc->p_module_bank );
1107 /*****************************************************************************
1108 * DeleteModule: delete a module and its structure.
1109 *****************************************************************************
1110 * This function can only be called if the module isn't being used.
1111 *****************************************************************************/
1112 static int DeleteModule( module_t * p_module )
1114 vlc_object_detach( p_module );
1116 /* We free the structures that we strdup()ed in Allocate*Module(). */
1117 #ifdef HAVE_DYNAMIC_PLUGINS
1118 if( !p_module->b_builtin )
1120 if( p_module->b_unloadable )
1122 CloseModule( p_module->handle );
1124 UndupModule( p_module );
1125 free( p_module->psz_filename );
1126 free( p_module->psz_longname );
1130 /* Free and detach the object's children */
1131 while( p_module->i_children )
1133 vlc_object_t *p_this = p_module->pp_children[0];
1134 vlc_object_detach( p_this );
1135 vlc_object_destroy( p_this );
1138 config_Free( p_module );
1139 vlc_object_destroy( p_module );
1144 #ifdef HAVE_DYNAMIC_PLUGINS
1145 /*****************************************************************************
1146 * CallEntry: call an entry point.
1147 *****************************************************************************
1148 * This function calls a symbol given its name and a module structure. The
1149 * symbol MUST refer to a function returning int and taking a module_t* as
1151 *****************************************************************************/
1152 static int CallEntry( module_t * p_module )
1154 static char *psz_name = "vlc_entry" MODULE_SUFFIX;
1155 int (* pf_symbol) ( module_t * p_module );
1157 /* Try to resolve the symbol */
1158 pf_symbol = (int (*)(module_t *)) GetSymbol( p_module->handle, psz_name );
1160 if( pf_symbol == NULL )
1162 #if defined(HAVE_DL_DYLD) || defined(HAVE_DL_BEOS)
1163 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s'",
1164 psz_name, p_module->psz_filename );
1165 #elif defined(HAVE_DL_WINDOWS)
1166 char *psz_error = GetWindowsError();
1167 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1168 psz_name, p_module->psz_filename, psz_error );
1170 #elif defined(HAVE_DL_DLOPEN)
1171 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1172 psz_name, p_module->psz_filename, dlerror() );
1173 #elif defined(HAVE_DL_SHL_LOAD)
1174 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1175 psz_name, p_module->psz_filename, strerror(errno) );
1177 # error "Something is wrong in modules.c"
1182 /* We can now try to call the symbol */
1183 if( pf_symbol( p_module ) != 0 )
1185 /* With a well-written module we shouldn't have to print an
1186 * additional error message here, but just make sure. */
1187 msg_Err( p_module, "failed calling symbol \"%s\" in file `%s'",
1188 psz_name, p_module->psz_filename );
1192 /* Everything worked fine, we can return */
1196 /*****************************************************************************
1197 * CloseModule: unload a dynamic library
1198 *****************************************************************************
1199 * This function unloads a previously opened dynamically linked library
1200 * using a system dependant method. No return value is taken in consideration,
1201 * since some libraries sometimes refuse to close properly.
1202 *****************************************************************************/
1203 static void CloseModule( module_handle_t handle )
1205 #if defined(HAVE_DL_DYLD)
1206 NSUnLinkModule( handle, FALSE );
1208 #elif defined(HAVE_DL_BEOS)
1209 unload_add_on( handle );
1211 #elif defined(HAVE_DL_WINDOWS)
1212 FreeLibrary( handle );
1214 #elif defined(HAVE_DL_DLOPEN)
1217 #elif defined(HAVE_DL_SHL_LOAD)
1218 shl_unload( handle );
1224 /*****************************************************************************
1225 * GetSymbol: get a symbol from a dynamic library
1226 *****************************************************************************
1227 * This function queries a loaded library for a symbol specified in a
1228 * string, and returns a pointer to it. We don't check for dlerror() or
1229 * similar functions, since we want a non-NULL symbol anyway.
1230 *****************************************************************************/
1231 static void * _module_getsymbol( module_handle_t, const char * );
1233 static void * GetSymbol( module_handle_t handle, const char * psz_function )
1235 void * p_symbol = _module_getsymbol( handle, psz_function );
1237 /* MacOS X dl library expects symbols to begin with "_". So do
1238 * some other operating systems. That's really lame, but hey, what
1240 if( p_symbol == NULL )
1242 char *psz_call = malloc( strlen( psz_function ) + 2 );
1244 strcpy( psz_call + 1, psz_function );
1245 psz_call[ 0 ] = '_';
1246 p_symbol = _module_getsymbol( handle, psz_call );
1253 static void * _module_getsymbol( module_handle_t handle,
1254 const char * psz_function )
1256 #if defined(HAVE_DL_DYLD)
1257 NSSymbol sym = NSLookupSymbolInModule( handle, psz_function );
1258 return NSAddressOfSymbol( sym );
1260 #elif defined(HAVE_DL_BEOS)
1262 if( B_OK == get_image_symbol( handle, psz_function,
1263 B_SYMBOL_TYPE_TEXT, &p_symbol ) )
1272 #elif defined(HAVE_DL_WINDOWS) && defined(UNDER_CE)
1273 wchar_t psz_real[256];
1274 MultiByteToWideChar( CP_ACP, 0, psz_function, -1, psz_real, 256 );
1276 return (void *)GetProcAddress( handle, psz_real );
1278 #elif defined(HAVE_DL_WINDOWS) && defined(WIN32)
1279 return (void *)GetProcAddress( handle, (MYCHAR*)psz_function );
1281 #elif defined(HAVE_DL_DLOPEN)
1282 return dlsym( handle, psz_function );
1284 #elif defined(HAVE_DL_SHL_LOAD)
1286 shl_findsym( &handle, psz_function, TYPE_UNDEFINED, &p_sym );
1292 #if defined(HAVE_DL_WINDOWS)
1293 static char * GetWindowsError( void )
1295 #if defined(UNDER_CE)
1296 wchar_t psz_tmp[256];
1297 char * psz_buffer = malloc( 256 );
1299 char * psz_tmp = malloc( 256 );
1301 int i = 0, i_error = GetLastError();
1303 FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
1304 NULL, i_error, MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT),
1305 (LPTSTR) psz_tmp, 256, NULL );
1307 /* Go to the end of the string */
1308 #if defined(UNDER_CE)
1309 while( psz_tmp[i] && psz_tmp[i] != L'\r' && psz_tmp[i] != L'\n' )
1311 while( psz_tmp[i] && psz_tmp[i] != '\r' && psz_tmp[i] != '\n' )
1319 #if defined(UNDER_CE)
1320 swprintf( psz_tmp + i, L" (error %i)", i_error );
1321 psz_tmp[ 255 ] = L'\0';
1323 snprintf( psz_tmp + i, 256 - i, " (error %i)", i_error );
1324 psz_tmp[ 255 ] = '\0';
1328 #if defined(UNDER_CE)
1329 WideCharToMultiByte( CP_ACP, WC_DEFAULTCHAR, psz_tmp, -1,
1330 psz_buffer, 256, NULL, NULL );
1336 #endif /* HAVE_DL_WINDOWS */
1338 #endif /* HAVE_DYNAMIC_PLUGINS */