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