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     /* Arch plugins */
  90     SEEK_PLUGIN( "beos" );
  91
  92     /* Low level Video */
  93     SEEK_PLUGIN( "x11" );
  94     SEEK_PLUGIN( "fb" );
  95     SEEK_PLUGIN( "glide" );
  96     SEEK_PLUGIN( "mga" );
  97
  98     /* High level Video */
  99     SEEK_PLUGIN( "gnome" );
 100     SEEK_PLUGIN( "ggi" );
 101     SEEK_PLUGIN( "sdl" );
 102
 103     /* Video calculus */
 104     SEEK_PLUGIN( "yuvmmx" );
 105     SEEK_PLUGIN( "yuv" );
 106
 107     /* Audio pluins */
 108     SEEK_PLUGIN( "dsp" );
 109     SEEK_PLUGIN( "esd" );
 110     SEEK_PLUGIN( "alsa" );
 111
 112     /* Dummy plugin */
 113     SEEK_PLUGIN( "dummy" );
 114
 115 #undef SEEK_PLUGIN
 116 }
 117
 118 void bank_Destroy( plugin_bank_t * p_bank )
 119 {
 120     int i;
 121     for( i = 0 ; i < p_bank->i_plugin_count ; i++ )
 122     {
 123         if( p_bank->p_info[ i ] != NULL )
 124         {
 125             free( p_bank->p_info[ i ]-> psz_filename );
 126         }
 127     }
 128
 129     free( p_bank );
 130 }
 131
 132 /*
 133  * Following functions are local
 134  */
 135
 136 char * TestPlugin ( plugin_id_t *p_plugin_id, char * psz_name )
 137 {
 138     int i_count, i_length;
 139     char * psz_plugin;
 140     char * psz_plugin_path[ ] =
 141     {
 142         ".",
 143         "lib", /* this one should disappear */
 144         PLUGIN_PATH,
 145         NULL
 146     };
 147
 148     i_length = strlen( psz_name );
 149
 150     for ( i_count = 0 ; psz_plugin_path[ i_count ] ; i_count++ )
 151     {
 152 #ifdef SYS_BEOS
 153         char * psz_program_path;
 154
 155         psz_program_path = beos_GetProgramPath();
 156         psz_plugin = malloc( strlen(psz_plugin_path[i_count]) +
 157                              strlen(psz_program_path) + i_length + 6 );
 158         sprintf( psz_plugin, "%s/%s/%s.so", psz_program_path,
 159                  psz_plugin_path[i_count], psz_name );
 160
 161         *p_plugin_id = load_add_on( psz_plugin );
 162 #else
 163         psz_plugin = malloc( strlen(psz_plugin_path[i_count]) + i_length + 5 );
 164         sprintf( psz_plugin, "%s/%s.so", psz_plugin_path[i_count], psz_name );
 165
 166         *p_plugin_id = dlopen( psz_plugin, RTLD_NOW | RTLD_GLOBAL );
 167 #endif
 168
 169 #ifdef SYS_BEOS
 170         if( *p_plugin_id >= 0 )
 171 #else
 172         if( *p_plugin_id != NULL )
 173 #endif
 174         {
 175             /* plugin successfuly dlopened */
 176             return( psz_plugin );
 177         }
 178 #ifndef SYS_BEOS
 179         else
 180         {
 181             intf_DbgMsg( "%s\n", dlerror() );
 182         }
 183 #endif
 184
 185         free( psz_plugin );
 186     }
 187
 188     return( NULL );
 189 }
 190
 191
 192 int AllocatePlugin( plugin_id_t plugin_id, plugin_bank_t * p_bank,
 193                     char * psz_filename )
 194 {
 195     typedef plugin_info_t * ( get_config_t ) ( void );
 196     get_config_t * p_func;
 197     int i;
 198
 199     for( i = 0 ; i < p_bank->i_plugin_count ; i++ )
 200     {
 201         if( p_bank->p_info[ i ] == NULL )
 202         {
 203             break;
 204         }
 205     }
 206
 207     /* no room to store that plugin, quit */
 208     if( i == p_bank->i_plugin_count )
 209     {
 210         intf_ErrMsg( "plugin bank error: reached max plugin count (%i), "
 211                      "increase MAX_PLUGIN_COUNT\n", p_bank->i_plugin_count );
 212         return( -1 );
 213     }
 214
 215     /* system-specific dynamic symbol loading */
 216     GET_PLUGIN( p_func, plugin_id, "GetConfig" );
 217
 218     /* if it failed, just quit */
 219     if( !p_func )
 220     {
 221         return( -1 );
 222     }
 223
 224     /* run the plugin function to initialize the structure */
 225     p_bank->p_info[ i ]            = p_func( );
 226     p_bank->p_info[ i ]->plugin_id = plugin_id;
 227     p_bank->p_info[ i ]->psz_filename = strdup( psz_filename );
 228
 229
 230     /* Tell the world we found it */
 231     intf_Msg( "Plugin %i: %s %s [0x%x]\n", i,
 232               p_bank->p_info[ i ]->psz_name,
 233               p_bank->p_info[ i ]->psz_version,
 234               p_bank->p_info[ i ]->i_score );
 235
 236     /* return nicely */
 237     return( 0 );
 238 }
 239
 240 #if 0
 241 void TrashPlugin ( plugin_id_t plugin_id )
 242 {
 243 #ifdef SYS_BEOS
 244     unload_add_on( plugin_id );
 245 #else
 246     dlclose( plugin_id );
 247 #endif
 248 }
 249 #endif
 250