gst/gstplugin.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstplugin.c: Plugin subsystem for loading elements, types, and libs
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26 #include <sys/types.h>
  27 #include <sys/stat.h>
  28 #ifdef HAVE_DIRENT_H
  29 #include <dirent.h>
  30 #endif
  31 #ifdef HAVE_UNISTD_H
  32 #include <unistd.h>
  33 #endif
  34 #include <signal.h>
  35 #include <errno.h>
  36
  37 #include "gst_private.h"
  38
  39 #include "gstplugin.h"
  40 #include "gstversion.h"
  41 #include "gstregistrypool.h"
  42 #include "gstinfo.h"
  43 #include "gstfilter.h"
  44
  45
  46 #define GST_CAT_DEFAULT GST_CAT_PLUGIN_LOADING
  47
  48 static GModule *main_module = NULL;
  49 static GList *_gst_plugin_static = NULL;
  50
  51 /* static variables for segfault handling of plugin loading */
  52 static char *_gst_plugin_fault_handler_filename = NULL;
  53 extern gboolean _gst_disable_segtrap;   /* see gst.c */
  54
  55 #ifndef HAVE_WIN32
  56 static gboolean _gst_plugin_fault_handler_is_setup = FALSE;
  57 #endif
  58
  59 /* list of valid licenses.
  60  * One of these must be specified or the plugin won't be loaded
  61  * Contact gstreamer-devel@lists.sourceforge.net if your license should be
  62  * added.
  63  *
  64  * GPL: http://www.gnu.org/copyleft/gpl.html
  65  * LGPL: http://www.gnu.org/copyleft/lesser.html
  66  * QPL: http://www.trolltech.com/licenses/qpl.html
  67  */
  68 static gchar *valid_licenses[] = {
  69   "LGPL",                       /* GNU Lesser General Public License */
  70   "GPL",                        /* GNU General Public License */
  71   "QPL",                        /* Trolltech Qt Public License */
  72   "GPL/QPL",                    /* Combi-license of GPL + QPL */
  73   GST_LICENSE_UNKNOWN,          /* some other license */
  74   NULL
  75 };
  76
  77 static void gst_plugin_desc_copy (GstPluginDesc * dest,
  78     const GstPluginDesc * src);
  79
  80 static GstPlugin *gst_plugin_register_func (GstPlugin * plugin,
  81     GModule * module, GstPluginDesc * desc);
  82
  83 static GstPlugin *
  84 gst_plugin_copy (GstPlugin * plugin)
  85 {
  86   return g_memdup (plugin, sizeof (*plugin));
  87 }
  88
  89 GType
  90 gst_plugin_get_type (void)
  91 {
  92   static GType plugin_type;
  93
  94   if (plugin_type == 0) {
  95     plugin_type = g_boxed_type_register_static ("GstPlugin",
  96         (GBoxedCopyFunc) gst_plugin_copy, g_free);
  97   }
  98
  99   return plugin_type;
 100 }
 101
 102 GQuark
 103 gst_plugin_error_quark (void)
 104 {
 105   static GQuark quark = 0;
 106
 107   if (!quark)
 108     quark = g_quark_from_static_string ("gst_plugin_error");
 109   return quark;
 110 }
 111
 112 /* this function can be called in the GCC constructor extension, before
 113  * the _gst_plugin_initialize() was called. In that case, we store the
 114  * plugin description in a list to initialize it when we open the main
 115  * module later on.
 116  * When the main module is known, we can register the plugin right away.
 117  */
 118 void
 119 _gst_plugin_register_static (GstPluginDesc * desc)
 120 {
 121   if (main_module == NULL) {
 122     if (GST_CAT_DEFAULT)
 123       GST_LOG ("queueing static plugin \"%s\" for loading later on",
 124           desc->name);
 125     _gst_plugin_static = g_list_prepend (_gst_plugin_static, desc);
 126   } else {
 127     GstPlugin *plugin;
 128
 129     if (GST_CAT_DEFAULT)
 130       GST_LOG ("attempting to load static plugin \"%s\" now...", desc->name);
 131     plugin = g_new0 (GstPlugin, 1);
 132     if (gst_plugin_register_func (plugin, main_module, desc)) {
 133       if (GST_CAT_DEFAULT)
 134         GST_INFO ("loaded static plugin \"%s\"", desc->name);
 135       gst_registry_pool_add_plugin (plugin);
 136     }
 137   }
 138 }
 139
 140 void
 141 _gst_plugin_initialize (void)
 142 {
 143   main_module = g_module_open (NULL, G_MODULE_BIND_LAZY);
 144
 145   /* now register all static plugins */
 146   g_list_foreach (_gst_plugin_static, (GFunc) _gst_plugin_register_static,
 147       NULL);
 148 }
 149
 150 /* this function could be extended to check if the plugin license matches the
 151  * applications license (would require the app to register its license somehow).
 152  * We'll wait for someone who's interested in it to code it :)
 153  */
 154 static gboolean
 155 gst_plugin_check_license (const gchar * license)
 156 {
 157   gchar **check_license = valid_licenses;
 158
 159   g_assert (check_license);
 160
 161   while (*check_license) {
 162     if (strcmp (license, *check_license) == 0)
 163       return TRUE;
 164     check_license++;
 165   }
 166   return FALSE;
 167 }
 168
 169 static gboolean
 170 gst_plugin_check_version (gint major, gint minor)
 171 {
 172   /* return NULL if the major and minor version numbers are not compatible */
 173   /* with ours. */
 174   if (major != GST_VERSION_MAJOR || minor != GST_VERSION_MINOR)
 175     return FALSE;
 176
 177   return TRUE;
 178 }
 179
 180 static GstPlugin *
 181 gst_plugin_register_func (GstPlugin * plugin, GModule * module,
 182     GstPluginDesc * desc)
 183 {
 184   g_assert (plugin->module == NULL);
 185
 186   if (!gst_plugin_check_version (desc->major_version, desc->minor_version)) {
 187     if (GST_CAT_DEFAULT)
 188       GST_INFO ("plugin \"%s\" has incompatible version, not loading",
 189           plugin->filename);
 190     return NULL;
 191   }
 192
 193   if (!desc->license || !desc->description || !desc->source ||
 194       !desc->package || !desc->origin) {
 195     if (GST_CAT_DEFAULT)
 196       GST_INFO ("plugin \"%s\" has incorrect GstPluginDesc, not loading",
 197           plugin->filename);
 198     return NULL;
 199   }
 200
 201   if (!gst_plugin_check_license (desc->license)) {
 202     if (GST_CAT_DEFAULT)
 203       GST_INFO ("plugin \"%s\" has invalid license \"%s\", not loading",
 204           plugin->filename, desc->license);
 205     return NULL;
 206   }
 207
 208   if (GST_CAT_DEFAULT)
 209     GST_LOG ("plugin \"%s\" looks good", GST_STR_NULL (plugin->filename));
 210
 211   gst_plugin_desc_copy (&plugin->desc, desc);
 212   plugin->module = module;
 213
 214   if (!((desc->plugin_init) (plugin))) {
 215     if (GST_CAT_DEFAULT)
 216       GST_INFO ("plugin \"%s\" failed to initialise", plugin->filename);
 217     plugin->module = NULL;
 218     return NULL;
 219   }
 220
 221   if (GST_CAT_DEFAULT)
 222     GST_LOG ("plugin \"%s\" initialised", GST_STR_NULL (plugin->filename));
 223
 224   return plugin;
 225 }
 226
 227 #ifndef HAVE_WIN32
 228 /*
 229  * _gst_plugin_fault_handler_restore:
 230  * segfault handler restorer
 231  */
 232 static void
 233 _gst_plugin_fault_handler_restore (void)
 234 {
 235   struct sigaction action;
 236
 237   memset (&action, 0, sizeof (action));
 238   action.sa_handler = SIG_DFL;
 239
 240   sigaction (SIGSEGV, &action, NULL);
 241 }
 242
 243 /*
 244  * _gst_plugin_fault_handler_sighandler:
 245  * segfault handler implementation
 246  */
 247 static void
 248 _gst_plugin_fault_handler_sighandler (int signum)
 249 {
 250   /* We need to restore the fault handler or we'll keep getting it */
 251   _gst_plugin_fault_handler_restore ();
 252
 253   switch (signum) {
 254     case SIGSEGV:
 255       g_print ("\nERROR: ");
 256       g_print ("Caught a segmentation fault while loading plugin file:\n");
 257       g_print ("%s\n\n", _gst_plugin_fault_handler_filename);
 258       g_print ("Please either:\n");
 259       g_print ("- remove it and restart.\n");
 260       g_print ("- run with --gst-disable-segtrap and debug.\n");
 261       exit (-1);
 262       break;
 263     default:
 264       g_print ("Caught unhandled signal on plugin loading\n");
 265       break;
 266   }
 267 }
 268
 269 /*
 270  * _gst_plugin_fault_handler_setup:
 271  * sets up the segfault handler
 272  */
 273 static void
 274 _gst_plugin_fault_handler_setup (void)
 275 {
 276   struct sigaction action;
 277
 278   /* if asked to leave segfaults alone, just return */
 279   if (_gst_disable_segtrap)
 280     return;
 281
 282   if (_gst_plugin_fault_handler_is_setup)
 283     return;
 284
 285   memset (&action, 0, sizeof (action));
 286   action.sa_handler = _gst_plugin_fault_handler_sighandler;
 287
 288   sigaction (SIGSEGV, &action, NULL);
 289 }
 290 #else
 291 static void
 292 _gst_plugin_fault_handler_restore (void)
 293 {
 294 }
 295
 296 static void
 297 _gst_plugin_fault_handler_setup (void)
 298 {
 299 }
 300 #endif
 301
 302 static void _gst_plugin_fault_handler_setup ();
 303
 304 /**
 305  * gst_plugin_check_module:
 306  * @module: GModule handle to check for pluginness
 307  * @error: pointer to a NULL-valued GError
 308  * @pptr: pointer to a gpointer used to return the gst_plugin_desc symbol
 309  *        (can be NULL)
 310  *
 311  * Checks if the given module is a GStreamer plugin
 312  *
 313  * Returns: TRUE if the given module is a GStreamer plugin
 314  */
 315 static gboolean
 316 gst_plugin_check_module (GModule * module, const char *filename,
 317     GError ** error, gpointer * pptr)
 318 {
 319   gpointer ptr;
 320
 321   if (pptr == NULL)
 322     pptr = &ptr;
 323
 324   if (module == NULL) {
 325     GST_DEBUG ("Error loading plugin %s, reason: %s", filename,
 326         g_module_error ());
 327     g_set_error (error, GST_PLUGIN_ERROR, GST_PLUGIN_ERROR_MODULE,
 328         "Error loading plugin %s, reason: %s", filename, g_module_error ());
 329     return FALSE;
 330   }
 331
 332   if (!g_module_symbol (module, "gst_plugin_desc", pptr)) {
 333     GST_DEBUG ("Could not find plugin entry point in \"%s\"", filename);
 334     g_set_error (error,
 335         GST_PLUGIN_ERROR,
 336         GST_PLUGIN_ERROR_MODULE,
 337         "Could not find plugin entry point in \"%s\"", filename);
 338     return FALSE;
 339   }
 340
 341   return TRUE;
 342 }
 343
 344 /**
 345  * gst_plugin_check_file:
 346  * @filename: the plugin filename to check for pluginness
 347  * @error: pointer to a NULL-valued GError
 348  *
 349  * Checks if the given path represents a GStreamer plugin.
 350  *
 351  * Returns: TRUE if the given path is a GStreamer plugin.
 352  */
 353 gboolean
 354 gst_plugin_check_file (const gchar * filename, GError ** error)
 355 {
 356   GModule *module;
 357   struct stat file_status;
 358   gboolean check;
 359
 360   g_return_val_if_fail (filename != NULL, FALSE);
 361
 362   if (g_module_supported () == FALSE) {
 363     g_set_error (error,
 364         GST_PLUGIN_ERROR,
 365         GST_PLUGIN_ERROR_MODULE, "Dynamic loading not supported");
 366     return FALSE;
 367   }
 368
 369   if (stat (filename, &file_status)) {
 370     g_set_error (error,
 371         GST_PLUGIN_ERROR,
 372         GST_PLUGIN_ERROR_MODULE, "Problem accessing file %s: %s\n", filename,
 373         strerror (errno));
 374     return FALSE;
 375   }
 376
 377   module = g_module_open (filename, G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL);
 378   if (!module) {
 379     check = FALSE;
 380     goto beach;
 381   }
 382   check = gst_plugin_check_module (module, filename, error, NULL);
 383   g_module_close (module);
 384
 385 beach:
 386   GST_INFO ("file \"%s\" %s look like a gst plugin", filename,
 387       check ? "does" : "doesn't");
 388   return check;
 389
 390 }
 391
 392 /**
 393  * gst_plugin_load_file:
 394  * @filename: the plugin filename to load
 395  * @error: pointer to a NULL-valued GError
 396  *
 397  * Loads the given plugin.
 398  *
 399  * Returns: a new GstPlugin or NULL, if an error occurred.
 400  */
 401 GstPlugin *
 402 gst_plugin_load_file (const gchar * filename, GError ** error)
 403 {
 404   GstPlugin *plugin;
 405   GModule *module;
 406   GstPluginDesc *desc;
 407   gboolean free_plugin;
 408   gpointer ptr;
 409
 410   g_return_val_if_fail (filename != NULL, NULL);
 411
 412   GST_CAT_DEBUG (GST_CAT_PLUGIN_LOADING, "attempt to load plugin \"%s\"",
 413       filename);
 414
 415   module = g_module_open (filename, G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL);
 416
 417   /* handle module == NULL case */
 418   if (!gst_plugin_check_module (module, filename, error, &ptr))
 419     return NULL;
 420
 421   desc = (GstPluginDesc *) ptr;
 422
 423   plugin = gst_registry_pool_find_plugin (desc->name);
 424   if (!plugin) {
 425     free_plugin = TRUE;
 426     plugin = g_new0 (GstPlugin, 1);
 427     plugin->filename = g_strdup (filename);
 428     GST_DEBUG ("created new GstPlugin %p for file \"%s\"", plugin, filename);
 429   } else {
 430     free_plugin = FALSE;
 431     if (gst_plugin_is_loaded (plugin)) {
 432       g_module_close (module);
 433       if (plugin->filename && strcmp (plugin->filename, filename) != 0) {
 434         GST_WARNING
 435             ("plugin %p from file \"%s\" with same name %s is already "
 436             "loaded, aborting loading of \"%s\"", plugin, plugin->filename,
 437             plugin->desc.name, filename);
 438         g_set_error (error, GST_PLUGIN_ERROR,
 439             GST_PLUGIN_ERROR_NAME_MISMATCH,
 440             "plugin %p from file \"%s\" with same name %s is already "
 441             "loaded, aborting loading of \"%s\"", plugin, plugin->filename,
 442             plugin->desc.name, filename);
 443         if (free_plugin)
 444           g_free (plugin);
 445         return NULL;
 446       }
 447       GST_LOG ("Plugin %p for file \"%s\" already loaded, returning it now",
 448           plugin, filename);
 449       return plugin;
 450     }
 451   }
 452   GST_LOG ("Plugin %p for file \"%s\" prepared, calling entry function...",
 453       plugin, filename);
 454
 455   if (g_module_symbol (module, "plugin_init", &ptr)) {
 456     GST_WARNING
 457         ("plugin %p from file \"%s\" exports a symbol named plugin_init\n",
 458         plugin, plugin->filename);
 459     g_set_error (error, GST_PLUGIN_ERROR, GST_PLUGIN_ERROR_NAME_MISMATCH,
 460         "plugin \"%s\" exports a symbol named plugin_init", desc->name);
 461   }
 462
 463   /* this is where we load the actual .so, so let's trap SIGSEGV */
 464   _gst_plugin_fault_handler_setup ();
 465   _gst_plugin_fault_handler_filename = plugin->filename;
 466
 467   GST_LOG ("Plugin %p for file \"%s\" prepared, registering...",
 468       plugin, filename);
 469
 470   if (gst_plugin_register_func (plugin, module, desc)) {
 471     /* remove signal handler */
 472     _gst_plugin_fault_handler_restore ();
 473     _gst_plugin_fault_handler_filename = NULL;
 474     GST_INFO ("plugin \"%s\" loaded", plugin->filename);
 475     return plugin;
 476   } else {
 477     /* remove signal handler */
 478     _gst_plugin_fault_handler_restore ();
 479     GST_DEBUG ("gst_plugin_register_func failed for plugin \"%s\"", filename);
 480     /* plugin == NULL */
 481     g_set_error (error,
 482         GST_PLUGIN_ERROR,
 483         GST_PLUGIN_ERROR_MODULE,
 484         "gst_plugin_register_func failed for plugin \"%s\"", filename);
 485     g_module_close (module);
 486     if (free_plugin)
 487       g_free (plugin);
 488     return NULL;
 489   }
 490 }
 491
 492 static void
 493 gst_plugin_desc_copy (GstPluginDesc * dest, const GstPluginDesc * src)
 494 {
 495   dest->major_version = src->major_version;
 496   dest->minor_version = src->minor_version;
 497   g_free (dest->name);
 498   dest->name = g_strdup (src->name);
 499   g_free (dest->description);
 500   dest->description = g_strdup (src->description);
 501   dest->plugin_init = src->plugin_init;
 502   dest->plugin_exit = src->plugin_exit;
 503   g_free (dest->version);
 504   dest->version = g_strdup (src->version);
 505   g_free (dest->license);
 506   dest->license = g_strdup (src->license);
 507   g_free (dest->source);
 508   dest->source = g_strdup (src->source);
 509   g_free (dest->package);
 510   dest->package = g_strdup (src->package);
 511   g_free (dest->origin);
 512   dest->origin = g_strdup (src->origin);
 513 }
 514
 515 #if 0
 516 /* unused */
 517 static void
 518 gst_plugin_desc_free (GstPluginDesc * desc)
 519 {
 520   g_free (desc->name);
 521   g_free (desc->description);
 522   g_free (desc->version);
 523   g_free (desc->license);
 524   g_free (desc->source);
 525   g_free (desc->package);
 526   g_free (desc->origin);
 527
 528   memset (desc, 0, sizeof (GstPluginDesc));
 529 }
 530 #endif
 531 /**
 532  * gst_plugin_unload_plugin:
 533  * @plugin: The plugin to unload
 534  *
 535  * Unload the given plugin.
 536  *
 537  * Returns: whether or not the plugin unloaded
 538  */
 539 gboolean
 540 gst_plugin_unload_plugin (GstPlugin * plugin)
 541 {
 542   g_return_val_if_fail (plugin != NULL, FALSE);
 543
 544   if (!plugin->module)
 545     return TRUE;
 546
 547   if (g_module_close (plugin->module)) {
 548     plugin->module = NULL;
 549     GST_CAT_INFO (GST_CAT_PLUGIN_LOADING, "plugin \"%s\" unloaded",
 550         plugin->filename);
 551     return TRUE;
 552   } else {
 553     GST_CAT_INFO (GST_CAT_PLUGIN_LOADING, "failed to unload plugin \"%s\"",
 554         plugin->filename);
 555     return FALSE;
 556   }
 557 }
 558
 559 /**
 560  * gst_plugin_get_name:
 561  * @plugin: plugin to get the name of
 562  *
 563  * Get the short name of the plugin
 564  *
 565  * Returns: the name of the plugin
 566  */
 567 const gchar *
 568 gst_plugin_get_name (GstPlugin * plugin)
 569 {
 570   g_return_val_if_fail (plugin != NULL, NULL);
 571
 572   return plugin->desc.name;
 573 }
 574
 575 /**
 576  * gst_plugin_get_description:
 577  * @plugin: plugin to get long name of
 578  *
 579  * Get the long descriptive name of the plugin
 580  *
 581  * Returns: the long name of the plugin
 582  */
 583 G_CONST_RETURN gchar *
 584 gst_plugin_get_description (GstPlugin * plugin)
 585 {
 586   g_return_val_if_fail (plugin != NULL, NULL);
 587
 588   return plugin->desc.description;
 589 }
 590
 591 /**
 592  * gst_plugin_get_filename:
 593  * @plugin: plugin to get the filename of
 594  *
 595  * get the filename of the plugin
 596  *
 597  * Returns: the filename of the plugin
 598  */
 599 G_CONST_RETURN gchar *
 600 gst_plugin_get_filename (GstPlugin * plugin)
 601 {
 602   g_return_val_if_fail (plugin != NULL, NULL);
 603
 604   return plugin->filename;
 605 }
 606
 607 /**
 608  * gst_plugin_get_version:
 609  * @plugin: plugin to get the version of
 610  *
 611  * get the version of the plugin
 612  *
 613  * Returns: the version of the plugin
 614  */
 615 G_CONST_RETURN gchar *
 616 gst_plugin_get_version (GstPlugin * plugin)
 617 {
 618   g_return_val_if_fail (plugin != NULL, NULL);
 619
 620   return plugin->desc.version;
 621 }
 622
 623 /**
 624  * gst_plugin_get_license:
 625  * @plugin: plugin to get the license of
 626  *
 627  * get the license of the plugin
 628  *
 629  * Returns: the license of the plugin
 630  */
 631 G_CONST_RETURN gchar *
 632 gst_plugin_get_license (GstPlugin * plugin)
 633 {
 634   g_return_val_if_fail (plugin != NULL, NULL);
 635
 636   return plugin->desc.license;
 637 }
 638
 639 /**
 640  * gst_plugin_get_source:
 641  * @plugin: plugin to get the source of
 642  *
 643  * get the source module the plugin belongs to.
 644  *
 645  * Returns: the source of the plugin
 646  */
 647 G_CONST_RETURN gchar *
 648 gst_plugin_get_source (GstPlugin * plugin)
 649 {
 650   g_return_val_if_fail (plugin != NULL, NULL);
 651
 652   return plugin->desc.source;
 653 }
 654
 655 /**
 656  * gst_plugin_get_package:
 657  * @plugin: plugin to get the package of
 658  *
 659  * get the package the plugin belongs to.
 660  *
 661  * Returns: the package of the plugin
 662  */
 663 G_CONST_RETURN gchar *
 664 gst_plugin_get_package (GstPlugin * plugin)
 665 {
 666   g_return_val_if_fail (plugin != NULL, NULL);
 667
 668   return plugin->desc.package;
 669 }
 670
 671 /**
 672  * gst_plugin_get_origin:
 673  * @plugin: plugin to get the origin of
 674  *
 675  * get the URL where the plugin comes from
 676  *
 677  * Returns: the origin of the plugin
 678  */
 679 G_CONST_RETURN gchar *
 680 gst_plugin_get_origin (GstPlugin * plugin)
 681 {
 682   g_return_val_if_fail (plugin != NULL, NULL);
 683
 684   return plugin->desc.origin;
 685 }
 686
 687 /**
 688  * gst_plugin_get_module:
 689  * @plugin: plugin to query
 690  *
 691  * Gets the #GModule of the plugin. If the plugin isn't loaded yet, NULL is
 692  * returned.
 693  *
 694  * Returns: module belonging to the plugin or NULL if the plugin isn't
 695  *          loaded yet.
 696  */
 697 GModule *
 698 gst_plugin_get_module (GstPlugin * plugin)
 699 {
 700   g_return_val_if_fail (plugin != NULL, NULL);
 701
 702   return plugin->module;
 703 }
 704
 705 /**
 706  * gst_plugin_is_loaded:
 707  * @plugin: plugin to query
 708  *
 709  * queries if the plugin is loaded into memory
 710  *
 711  * Returns: TRUE is loaded, FALSE otherwise
 712  */
 713 gboolean
 714 gst_plugin_is_loaded (GstPlugin * plugin)
 715 {
 716   g_return_val_if_fail (plugin != NULL, FALSE);
 717
 718   return (plugin->module != NULL);
 719 }
 720
 721 /**
 722  * gst_plugin_feature_list:
 723  * @plugin: plugin to query
 724  * @filter: the filter to use
 725  * @first: only return first match
 726  * @user_data: user data passed to the filter function
 727  *
 728  * Runs a filter against all plugin features and returns a GList with
 729  * the results. If the first flag is set, only the first match is
 730  * returned (as a list with a single object).
 731  *
 732  * Returns: a GList of features, g_list_free after use.
 733  */
 734 GList *
 735 gst_plugin_feature_filter (GstPlugin * plugin,
 736     GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
 737 {
 738   return gst_filter_run (plugin->features, (GstFilterFunc) filter, first,
 739       user_data);
 740 }
 741
 742 typedef struct
 743 {
 744   GstPluginFeatureFilter filter;
 745   gboolean first;
 746   gpointer user_data;
 747   GList *result;
 748 }
 749 FeatureFilterData;
 750
 751 static gboolean
 752 _feature_filter (GstPlugin * plugin, gpointer user_data)
 753 {
 754   GList *result;
 755   FeatureFilterData *data = (FeatureFilterData *) user_data;
 756
 757   result =
 758       gst_plugin_feature_filter (plugin, data->filter, data->first,
 759       data->user_data);
 760   if (result) {
 761     data->result = g_list_concat (data->result, result);
 762     return TRUE;
 763   }
 764   return FALSE;
 765 }
 766
 767 /**
 768  * gst_plugin_list_feature_filter:
 769  * @list: a #GList of plugins to query
 770  * @filter: the filter function to use
 771  * @first: only return first match
 772  * @user_data: user data passed to the filter function
 773  *
 774  * Runs a filter against all plugin features of the plugins in the given
 775  * list and returns a GList with the results.
 776  * If the first flag is set, only the first match is
 777  * returned (as a list with a single object).
 778  *
 779  * Returns: a GList of features, g_list_free after use.
 780  */
 781 GList *
 782 gst_plugin_list_feature_filter (GList * list,
 783     GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
 784 {
 785   FeatureFilterData data;
 786   GList *result;
 787
 788   data.filter = filter;
 789   data.first = first;
 790   data.user_data = user_data;
 791   data.result = NULL;
 792
 793   result = gst_filter_run (list, (GstFilterFunc) _feature_filter, first, &data);
 794   g_list_free (result);
 795
 796   return data.result;
 797 }
 798
 799 /**
 800  * gst_plugin_name_filter:
 801  * @plugin: the plugin to check
 802  * @name: the name of the plugin
 803  *
 804  * A standard filter that returns TRUE when the plugin is of the
 805  * given name.
 806  *
 807  * Returns: TRUE if the plugin is of the given name.
 808  */
 809 gboolean
 810 gst_plugin_name_filter (GstPlugin * plugin, const gchar * name)
 811 {
 812   return (plugin->desc.name && !strcmp (plugin->desc.name, name));
 813 }
 814
 815 /**
 816  * gst_plugin_find_feature:
 817  * @plugin: plugin to get the feature from
 818  * @name: The name of the feature to find
 819  * @type: The type of the feature to find
 820  *
 821  * Find a feature of the given name and type in the given plugin.
 822  *
 823  * Returns: a GstPluginFeature or NULL if the feature was not found.
 824  */
 825 GstPluginFeature *
 826 gst_plugin_find_feature (GstPlugin * plugin, const gchar * name, GType type)
 827 {
 828   GList *walk;
 829   GstPluginFeature *result = NULL;
 830   GstTypeNameData data;
 831
 832   g_return_val_if_fail (name != NULL, NULL);
 833
 834   data.type = type;
 835   data.name = name;
 836
 837   walk = gst_filter_run (plugin->features,
 838       (GstFilterFunc) gst_plugin_feature_type_name_filter, TRUE, &data);
 839
 840   if (walk)
 841     result = GST_PLUGIN_FEATURE (walk->data);
 842
 843   return result;
 844 }
 845
 846 /**
 847  * gst_plugin_add_feature:
 848  * @plugin: plugin to add feature to
 849  * @feature: feature to add
 850  *
 851  * Add feature to the list of those provided by the plugin.
 852  * There is a separate namespace for each plugin feature type.
 853  * See #gst_plugin_get_feature_list
 854  */
 855 void
 856 gst_plugin_add_feature (GstPlugin * plugin, GstPluginFeature * feature)
 857 {
 858   GstPluginFeature *oldfeature;
 859
 860   /* FIXME 0.9: get reference counting somewhat right in here,
 861    * GstPluginFeatures should probably be GstObjects that are sinked when
 862    * adding them to a plugin */
 863   g_return_if_fail (plugin != NULL);
 864   g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
 865   g_return_if_fail (feature != NULL);
 866
 867   oldfeature = gst_plugin_find_feature (plugin,
 868       GST_PLUGIN_FEATURE_NAME (feature), G_OBJECT_TYPE (feature));
 869
 870   if (oldfeature == feature) {
 871     GST_WARNING ("feature %s has already been added",
 872         GST_PLUGIN_FEATURE_NAME (feature));
 873     /* g_object_unref (feature); */
 874   } else if (oldfeature) {
 875     GST_WARNING ("feature %s already present in plugin",
 876         GST_PLUGIN_FEATURE_NAME (feature));
 877     /* g_object_unref (feature); */
 878   } else {
 879     feature->manager = plugin;
 880     plugin->features = g_list_prepend (plugin->features, feature);
 881     plugin->numfeatures++;
 882   }
 883 }
 884
 885 /**
 886  * gst_plugin_get_feature_list:
 887  * @plugin: the plugin to get the features from
 888  *
 889  * get a list of all the features that this plugin provides
 890  *
 891  * Returns: a GList of features, use g_list_free to free the list.
 892  */
 893 GList *
 894 gst_plugin_get_feature_list (GstPlugin * plugin)
 895 {
 896   g_return_val_if_fail (plugin != NULL, NULL);
 897
 898   return g_list_copy (plugin->features);
 899 }
 900
 901 /**
 902  * gst_plugin_load:
 903  * @name: name of plugin to load
 904  *
 905  * Load the named plugin.
 906  *
 907  * Returns: whether the plugin was loaded or not
 908  */
 909 gboolean
 910 gst_plugin_load (const gchar * name)
 911 {
 912   GstPlugin *plugin;
 913   GError *error = NULL;
 914
 915   plugin = gst_registry_pool_find_plugin (name);
 916   if (plugin) {
 917     plugin = gst_plugin_load_file (plugin->filename, &error);
 918     if (!plugin) {
 919       GST_WARNING ("load_plugin error: %s\n", error->message);
 920       g_error_free (error);
 921       return FALSE;
 922     }
 923     return TRUE;;
 924   }
 925
 926   GST_DEBUG ("Could not find %s in registry pool", name);
 927   return FALSE;
 928 }