git.sesse.net Git - vlc/blob - src/misc/plugins.c

   1 /*****************************************************************************
   2  * plugins.c : Dynamic plugin management functions
   3  *****************************************************************************
   4  * Copyright (C) 1999, 2000 VideoLAN
   5  *
   6  * Authors:
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  21  *****************************************************************************/
  22 #include "defs.h"
  23
  24 #include "config.h"
  25
  26 #include <stdlib.h>                                      /* free(), strtol() */
  27 #include <stdio.h>                                              /* sprintf() */
  28 #include <string.h>                                            /* strerror() */
  29 #include <errno.h>                                                 /* ENOMEM */
  30
  31 #if defined(HAVE_DLFCN_H)                                /* Linux, BSD, Hurd */
  32 #include <dlfcn.h>                           /* dlopen(), dlsym(), dlclose() */
  33
  34 #elif defined(HAVE_IMAGE_H)                                          /* BeOS */
  35 #include <image.h>
  36
  37 #else
  38 #error no dynamic plugins available on your system !
  39 #endif
  40
  41 #ifdef SYS_BEOS
  42 #include "beos_specific.h"
  43 #endif
  44
  45 #include "common.h"
  46
  47 #include "intf_msg.h"
  48 #include "plugins.h"
  49
  50 /* Local prototypes */
  51 char * TestPlugin     ( plugin_id_t *p_plugin_id, char * psz_name );
  52 int    AllocatePlugin ( plugin_id_t plugin_id, plugin_bank_t * p_bank,
  53                         char * psz_filename );
  54
  55 plugin_bank_t * bank_Create( void )
  56 {
  57     plugin_bank_t *p_bank;
  58     int i;
  59
  60     /* Allocate structure */
  61     p_bank = malloc( sizeof( plugin_bank_t ) );
  62     if( !p_bank )
  63     {
  64         intf_ErrMsg("plugin bank error: %s\n", strerror( ENOMEM ) );
  65         return( NULL );
  66     }
  67
  68     /* Initialize structure */
  69     for( i = 0 ; i < MAX_PLUGIN_COUNT ; i++ )
  70     {
  71         p_bank->p_info[ i ] = NULL;
  72     }
  73     p_bank->i_plugin_count = MAX_PLUGIN_COUNT;
  74
  75     intf_Msg("Plugin bank initialized\n");
  76     return( p_bank );
  77 }
  78
  79 void bank_Init( plugin_bank_t * p_bank )
  80 {
  81     plugin_id_t tmp;
  82     char * psz_filename;
  83
  84     /* FIXME: we should browse all directories to get plugins */
  85 #define SEEK_PLUGIN( name ) \
  86     psz_filename = TestPlugin( &tmp, name ); \
  87     if( psz_filename ) AllocatePlugin( tmp, p_bank, psz_filename );
  88
  89     SEEK_PLUGIN( "beos" );
  90     SEEK_PLUGIN( "x11" );
  91     SEEK_PLUGIN( "dsp" );
  92     SEEK_PLUGIN( "gnome" );
  93     SEEK_PLUGIN( "ggi" );
  94     SEEK_PLUGIN( "fb" );
  95     SEEK_PLUGIN( "yuvmmx" );
  96     SEEK_PLUGIN( "yuv" );
  97     SEEK_PLUGIN( "dummy" );
  98
  99 #undef SEEK_PLUGIN
 100 }
 101
 102 void bank_Destroy( plugin_bank_t * p_bank )
 103 {
 104     free( p_bank );
 105 }
 106
 107 /*
 108  * Following functions are local
 109  */
 110
 111 int AllocatePlugin( plugin_id_t plugin_id, plugin_bank_t * p_bank,
 112                     char * psz_filename )
 113 {
 114     typedef plugin_info_t * ( get_config_t ) ( void );
 115     get_config_t * p_func;
 116     int i;
 117
 118     for( i = 0 ; i < p_bank->i_plugin_count ; i++ )
 119     {
 120         if( p_bank->p_info[ i ] == NULL )
 121         {
 122             break;
 123         }
 124     }
 125
 126     /* no room to store that plugin, quit */
 127     if( i == p_bank->i_plugin_count )
 128     {
 129         intf_ErrMsg( "plugin bank error: reached max plugin count (%i), "
 130                      "increase MAX_PLUGIN_COUNT\n", p_bank->i_plugin_count );
 131         return( -1 );
 132     }
 133
 134     /* system-specific dynamic symbol loading */
 135     GET_PLUGIN( p_func, plugin_id, "GetConfig" );
 136
 137     /* if it failed, just quit */
 138     if( !p_func )
 139     {
 140         return( -1 );
 141     }
 142
 143     /* run the plugin function to initialize the structure */
 144     p_bank->p_info[ i ]            = p_func( );
 145     p_bank->p_info[ i ]->plugin_id = plugin_id;
 146
 147     /* Tell the world we found it */
 148     intf_Msg( "Found plugin: %s (version %s)\n", p_bank->p_info[ i ]->psz_name,
 149               p_bank->p_info[ i ]->psz_version );
 150
 151     /* return nicely */
 152     return( 0 );
 153 }
 154
 155
 156 char * TestPlugin ( plugin_id_t *p_plugin_id, char * psz_name )
 157 {
 158     int i_count, i_length;
 159     char * psz_plugin;
 160     char * psz_plugin_path[ ] =
 161     {
 162         ".",
 163         "lib", /* this one should disappear */
 164         PLUGIN_PATH,
 165         NULL
 166     };
 167
 168     i_length = strlen( psz_name );
 169
 170     for ( i_count = 0 ; psz_plugin_path[ i_count ] ; i_count++ )
 171     {
 172 #ifdef SYS_BEOS
 173         char * psz_program_path;
 174
 175         psz_program_path = beos_GetProgramPath();
 176         psz_plugin = malloc( strlen(psz_plugin_path[i_count]) +
 177                              strlen(psz_program_path) + i_length + 5 );
 178         sprintf( psz_plugin, "%s/%s/%s.so", psz_program_path,
 179                  psz_plugin_path[i_count], psz_name );
 180
 181         *p_plugin_id = load_add_on( psz_plugin );
 182 #else
 183         psz_plugin = malloc( strlen(psz_plugin_path[i_count]) + i_length + 5 );
 184         sprintf( psz_plugin, "%s/%s.so", psz_plugin_path[i_count], psz_name );
 185
 186         *p_plugin_id = dlopen( psz_plugin, RTLD_NOW | RTLD_GLOBAL );
 187 #endif
 188
 189 #ifdef SYS_BEOS
 190         if( *p_plugin_id >= 0 )
 191 #else
 192         if( *p_plugin_id != NULL )
 193 #endif
 194         {
 195             /* plugin successfuly dlopened */
 196             return( psz_plugin );
 197         }
 198 #ifndef SYS_BEOS
 199         else
 200         {
 201             intf_DbgMsg( "%s\n", dlerror() );
 202         }
 203 #endif
 204
 205         free( psz_plugin );
 206     }
 207
 208     return( NULL );
 209 }
 210
 211 #if 0
 212 void TrashPlugin ( plugin_id_t plugin_id )
 213 {
 214 #ifdef SYS_BEOS
 215     unload_add_on( plugin_id );
 216 #else
 217     dlclose( plugin_id );
 218 #endif
 219 }
 220 #endif
 221