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 (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 /*
 274  * _gst_plugin_fault_handler_restore:
 275  * segfault handler restorer
 276  */
 277 static void
 278 _gst_plugin_fault_handler_restore (void)
 279 {
 280   struct sigaction action;
 281
 282   memset (&action, 0, sizeof (action));
 283   action.sa_handler = SIG_DFL;
 284
 285   sigaction (SIGSEGV, &action, NULL);
 286 }
 287
 288 /*
 289  * _gst_plugin_fault_handler_sighandler:
 290  * segfault handler implementation
 291  */
 292 static void
 293 _gst_plugin_fault_handler_sighandler (int signum)
 294 {
 295   /* We need to restore the fault handler or we'll keep getting it */
 296   _gst_plugin_fault_handler_restore ();
 297
 298   switch (signum) {
 299     case SIGSEGV:
 300       g_print ("\nERROR: ");
 301       g_print ("Caught a segmentation fault while loading plugin file:\n");
 302       g_print ("%s\n\n", _gst_plugin_fault_handler_filename);
 303       g_print ("Please either:\n");
 304       g_print ("- remove it and restart.\n");
 305       g_print ("- run with --gst-disable-segtrap and debug.\n");
 306       exit (-1);
 307       break;
 308     default:
 309       g_print ("Caught unhandled signal on plugin loading\n");
 310       break;
 311   }
 312 }
 313
 314 /*
 315  * _gst_plugin_fault_handler_setup:
 316  * sets up the segfault handler
 317  */
 318 static void
 319 _gst_plugin_fault_handler_setup (void)
 320 {
 321   struct sigaction action;
 322
 323   /* if asked to leave segfaults alone, just return */
 324   if (_gst_disable_segtrap)
 325     return;
 326
 327   if (_gst_plugin_fault_handler_is_setup)
 328     return;
 329
 330   memset (&action, 0, sizeof (action));
 331   action.sa_handler = _gst_plugin_fault_handler_sighandler;
 332
 333   sigaction (SIGSEGV, &action, NULL);
 334 }
 335 #else
 336 static void
 337 _gst_plugin_fault_handler_restore (void)
 338 {
 339 }
 340
 341 static void
 342 _gst_plugin_fault_handler_setup (void)
 343 {
 344 }
 345 #endif
 346
 347 static void _gst_plugin_fault_handler_setup ();
 348
 349 GStaticMutex gst_plugin_loading_mutex = G_STATIC_MUTEX_INIT;
 350
 351 /**
 352  * gst_plugin_load_file:
 353  * @filename: the plugin filename to load
 354  * @error: pointer to a NULL-valued GError
 355  *
 356  * Loads the given plugin and refs it.  Caller needs to unref after use.
 357  *
 358  * Returns: a reference to the existing loaded GstPlugin, a reference to the
 359  * newly-loaded GstPlugin, or NULL if an error occurred.
 360  */
 361 GstPlugin *
 362 gst_plugin_load_file (const gchar * filename, GError ** error)
 363 {
 364   GstPlugin *plugin;
 365   GModule *module;
 366   gboolean ret;
 367   gpointer ptr;
 368   struct stat file_status;
 369   GstRegistry *registry;
 370
 371   g_return_val_if_fail (filename != NULL, NULL);
 372
 373   registry = gst_registry_get_default ();
 374   g_static_mutex_lock (&gst_plugin_loading_mutex);
 375
 376   plugin = gst_registry_lookup (registry, filename);
 377   if (plugin) {
 378     if (plugin->module) {
 379       g_static_mutex_unlock (&gst_plugin_loading_mutex);
 380       return plugin;
 381     } else {
 382       gst_object_unref (plugin);
 383       plugin = NULL;
 384     }
 385   }
 386
 387   GST_CAT_DEBUG (GST_CAT_PLUGIN_LOADING, "attempt to load plugin \"%s\"",
 388       filename);
 389
 390   if (g_module_supported () == FALSE) {
 391     GST_CAT_DEBUG (GST_CAT_PLUGIN_LOADING, "module loading not supported");
 392     g_set_error (error,
 393         GST_PLUGIN_ERROR,
 394         GST_PLUGIN_ERROR_MODULE, "Dynamic loading not supported");
 395     goto return_error;
 396   }
 397
 398   if (stat (filename, &file_status)) {
 399     GST_CAT_DEBUG (GST_CAT_PLUGIN_LOADING, "problem accessing file");
 400     g_set_error (error,
 401         GST_PLUGIN_ERROR,
 402         GST_PLUGIN_ERROR_MODULE, "Problem accessing file %s: %s\n", filename,
 403         strerror (errno));
 404     goto return_error;
 405   }
 406
 407   module = g_module_open (filename, G_MODULE_BIND_LOCAL);
 408   if (module == NULL) {
 409     GST_CAT_WARNING (GST_CAT_PLUGIN_LOADING, "module_open failed: %s",
 410         g_module_error ());
 411     g_set_error (error,
 412         GST_PLUGIN_ERROR, GST_PLUGIN_ERROR_MODULE, "Opening module failed");
 413     goto return_error;
 414   }
 415
 416   plugin = g_object_new (GST_TYPE_PLUGIN, NULL);
 417
 418   plugin->module = module;
 419   plugin->filename = g_strdup (filename);
 420   plugin->basename = g_path_get_basename (filename);
 421   plugin->file_mtime = file_status.st_mtime;
 422   plugin->file_size = file_status.st_size;
 423
 424   ret = g_module_symbol (module, "gst_plugin_desc", &ptr);
 425   if (!ret) {
 426     GST_DEBUG ("Could not find plugin entry point in \"%s\"", filename);
 427     g_set_error (error,
 428         GST_PLUGIN_ERROR,
 429         GST_PLUGIN_ERROR_MODULE,
 430         "File \"%s\" is not a GStreamer plugin", filename);
 431     goto return_error;
 432   }
 433   plugin->orig_desc = (GstPluginDesc *) ptr;
 434
 435   GST_LOG ("Plugin %p for file \"%s\" prepared, calling entry function...",
 436       plugin, filename);
 437
 438   /* this is where we load the actual .so, so let's trap SIGSEGV */
 439   _gst_plugin_fault_handler_setup ();
 440   _gst_plugin_fault_handler_filename = plugin->filename;
 441
 442   GST_LOG ("Plugin %p for file \"%s\" prepared, registering...",
 443       plugin, filename);
 444
 445   if (!gst_plugin_register_func (plugin, module, plugin->orig_desc)) {
 446     /* remove signal handler */
 447     _gst_plugin_fault_handler_restore ();
 448     GST_DEBUG ("gst_plugin_register_func failed for plugin \"%s\"", filename);
 449     /* plugin == NULL */
 450     g_set_error (error,
 451         GST_PLUGIN_ERROR,
 452         GST_PLUGIN_ERROR_MODULE,
 453         "File \"%s\" appears to be a GStreamer plugin, but it failed to initialize",
 454         filename);
 455     g_module_close (module);
 456     goto return_error;
 457   }
 458
 459   /* remove signal handler */
 460   _gst_plugin_fault_handler_restore ();
 461   _gst_plugin_fault_handler_filename = NULL;
 462   GST_INFO ("plugin \"%s\" loaded", plugin->filename);
 463
 464   gst_object_ref (plugin);
 465   gst_default_registry_add_plugin (plugin);
 466
 467   g_static_mutex_unlock (&gst_plugin_loading_mutex);
 468   return plugin;
 469
 470 return_error:
 471   {
 472     if (plugin)
 473       gst_object_unref (plugin);
 474     g_static_mutex_unlock (&gst_plugin_loading_mutex);
 475     return NULL;
 476   }
 477 }
 478
 479 static void
 480 gst_plugin_desc_copy (GstPluginDesc * dest, const GstPluginDesc * src)
 481 {
 482   dest->major_version = src->major_version;
 483   dest->minor_version = src->minor_version;
 484   dest->name = g_strdup (src->name);
 485   dest->description = g_strdup (src->description);
 486   dest->plugin_init = src->plugin_init;
 487   dest->version = g_strdup (src->version);
 488   dest->license = g_strdup (src->license);
 489   dest->source = g_strdup (src->source);
 490   dest->package = g_strdup (src->package);
 491   dest->origin = g_strdup (src->origin);
 492 }
 493
 494 /* unused */
 495 static void
 496 gst_plugin_desc_free (GstPluginDesc * desc)
 497 {
 498   g_free (desc->name);
 499   g_free (desc->description);
 500   g_free (desc->version);
 501   g_free (desc->license);
 502   g_free (desc->source);
 503   g_free (desc->package);
 504   g_free (desc->origin);
 505
 506   memset (desc, 0, sizeof (GstPluginDesc));
 507 }
 508
 509 /**
 510  * gst_plugin_get_name:
 511  * @plugin: plugin to get the name of
 512  *
 513  * Get the short name of the plugin
 514  *
 515  * Returns: the name of the plugin
 516  */
 517 const gchar *
 518 gst_plugin_get_name (GstPlugin * plugin)
 519 {
 520   g_return_val_if_fail (plugin != NULL, NULL);
 521
 522   return plugin->desc.name;
 523 }
 524
 525 /**
 526  * gst_plugin_get_description:
 527  * @plugin: plugin to get long name of
 528  *
 529  * Get the long descriptive name of the plugin
 530  *
 531  * Returns: the long name of the plugin
 532  */
 533 G_CONST_RETURN gchar *
 534 gst_plugin_get_description (GstPlugin * plugin)
 535 {
 536   g_return_val_if_fail (plugin != NULL, NULL);
 537
 538   return plugin->desc.description;
 539 }
 540
 541 /**
 542  * gst_plugin_get_filename:
 543  * @plugin: plugin to get the filename of
 544  *
 545  * get the filename of the plugin
 546  *
 547  * Returns: the filename of the plugin
 548  */
 549 G_CONST_RETURN gchar *
 550 gst_plugin_get_filename (GstPlugin * plugin)
 551 {
 552   g_return_val_if_fail (plugin != NULL, NULL);
 553
 554   return plugin->filename;
 555 }
 556
 557 /**
 558  * gst_plugin_get_version:
 559  * @plugin: plugin to get the version of
 560  *
 561  * get the version of the plugin
 562  *
 563  * Returns: the version of the plugin
 564  */
 565 G_CONST_RETURN gchar *
 566 gst_plugin_get_version (GstPlugin * plugin)
 567 {
 568   g_return_val_if_fail (plugin != NULL, NULL);
 569
 570   return plugin->desc.version;
 571 }
 572
 573 /**
 574  * gst_plugin_get_license:
 575  * @plugin: plugin to get the license of
 576  *
 577  * get the license of the plugin
 578  *
 579  * Returns: the license of the plugin
 580  */
 581 G_CONST_RETURN gchar *
 582 gst_plugin_get_license (GstPlugin * plugin)
 583 {
 584   g_return_val_if_fail (plugin != NULL, NULL);
 585
 586   return plugin->desc.license;
 587 }
 588
 589 /**
 590  * gst_plugin_get_source:
 591  * @plugin: plugin to get the source of
 592  *
 593  * get the source module the plugin belongs to.
 594  *
 595  * Returns: the source of the plugin
 596  */
 597 G_CONST_RETURN gchar *
 598 gst_plugin_get_source (GstPlugin * plugin)
 599 {
 600   g_return_val_if_fail (plugin != NULL, NULL);
 601
 602   return plugin->desc.source;
 603 }
 604
 605 /**
 606  * gst_plugin_get_package:
 607  * @plugin: plugin to get the package of
 608  *
 609  * get the package the plugin belongs to.
 610  *
 611  * Returns: the package of the plugin
 612  */
 613 G_CONST_RETURN gchar *
 614 gst_plugin_get_package (GstPlugin * plugin)
 615 {
 616   g_return_val_if_fail (plugin != NULL, NULL);
 617
 618   return plugin->desc.package;
 619 }
 620
 621 /**
 622  * gst_plugin_get_origin:
 623  * @plugin: plugin to get the origin of
 624  *
 625  * get the URL where the plugin comes from
 626  *
 627  * Returns: the origin of the plugin
 628  */
 629 G_CONST_RETURN gchar *
 630 gst_plugin_get_origin (GstPlugin * plugin)
 631 {
 632   g_return_val_if_fail (plugin != NULL, NULL);
 633
 634   return plugin->desc.origin;
 635 }
 636
 637 /**
 638  * gst_plugin_get_module:
 639  * @plugin: plugin to query
 640  *
 641  * Gets the #GModule of the plugin. If the plugin isn't loaded yet, NULL is
 642  * returned.
 643  *
 644  * Returns: module belonging to the plugin or NULL if the plugin isn't
 645  *          loaded yet.
 646  */
 647 GModule *
 648 gst_plugin_get_module (GstPlugin * plugin)
 649 {
 650   g_return_val_if_fail (plugin != NULL, NULL);
 651
 652   return plugin->module;
 653 }
 654
 655 /**
 656  * gst_plugin_is_loaded:
 657  * @plugin: plugin to query
 658  *
 659  * queries if the plugin is loaded into memory
 660  *
 661  * Returns: TRUE is loaded, FALSE otherwise
 662  */
 663 gboolean
 664 gst_plugin_is_loaded (GstPlugin * plugin)
 665 {
 666   g_return_val_if_fail (plugin != NULL, FALSE);
 667
 668   return (plugin->module != NULL || plugin->filename == NULL);
 669 }
 670
 671 #if 0
 672 /**
 673  * gst_plugin_feature_list:
 674  * @plugin: plugin to query
 675  * @filter: the filter to use
 676  * @first: only return first match
 677  * @user_data: user data passed to the filter function
 678  *
 679  * Runs a filter against all plugin features and returns a GList with
 680  * the results. If the first flag is set, only the first match is
 681  * returned (as a list with a single object).
 682  *
 683  * Returns: a GList of features, g_list_free after use.
 684  */
 685 GList *
 686 gst_plugin_feature_filter (GstPlugin * plugin,
 687     GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
 688 {
 689   GList *list;
 690   GList *g;
 691
 692   list = gst_filter_run (plugin->features, (GstFilterFunc) filter, first,
 693       user_data);
 694   for (g = list; g; g = g->next) {
 695     gst_object_ref (plugin);
 696   }
 697
 698   return list;
 699 }
 700
 701 typedef struct
 702 {
 703   GstPluginFeatureFilter filter;
 704   gboolean first;
 705   gpointer user_data;
 706   GList *result;
 707 }
 708 FeatureFilterData;
 709
 710 static gboolean
 711 _feature_filter (GstPlugin * plugin, gpointer user_data)
 712 {
 713   GList *result;
 714   FeatureFilterData *data = (FeatureFilterData *) user_data;
 715
 716   result = gst_plugin_feature_filter (plugin, data->filter, data->first,
 717       data->user_data);
 718   if (result) {
 719     data->result = g_list_concat (data->result, result);
 720     return TRUE;
 721   }
 722   return FALSE;
 723 }
 724
 725 /**
 726  * gst_plugin_list_feature_filter:
 727  * @list: a #GList of plugins to query
 728  * @filter: the filter function to use
 729  * @first: only return first match
 730  * @user_data: user data passed to the filter function
 731  *
 732  * Runs a filter against all plugin features of the plugins in the given
 733  * list and returns a GList with the results.
 734  * If the first flag is set, only the first match is
 735  * returned (as a list with a single object).
 736  *
 737  * Returns: a GList of features, g_list_free after use.
 738  */
 739 GList *
 740 gst_plugin_list_feature_filter (GList * list,
 741     GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
 742 {
 743   FeatureFilterData data;
 744   GList *result;
 745
 746   data.filter = filter;
 747   data.first = first;
 748   data.user_data = user_data;
 749   data.result = NULL;
 750
 751   result = gst_filter_run (list, (GstFilterFunc) _feature_filter, first, &data);
 752   g_list_free (result);
 753
 754   return data.result;
 755 }
 756 #endif
 757
 758 /**
 759  * gst_plugin_name_filter:
 760  * @plugin: the plugin to check
 761  * @name: the name of the plugin
 762  *
 763  * A standard filter that returns TRUE when the plugin is of the
 764  * given name.
 765  *
 766  * Returns: TRUE if the plugin is of the given name.
 767  */
 768 gboolean
 769 gst_plugin_name_filter (GstPlugin * plugin, const gchar * name)
 770 {
 771   return (plugin->desc.name && !strcmp (plugin->desc.name, name));
 772 }
 773
 774 #if 0
 775 /**
 776  * gst_plugin_find_feature:
 777  * @plugin: plugin to get the feature from
 778  * @name: The name of the feature to find
 779  * @type: The type of the feature to find
 780  *
 781  * Find a feature of the given name and type in the given plugin.
 782  *
 783  * Returns: a GstPluginFeature or NULL if the feature was not found.
 784  */
 785 GstPluginFeature *
 786 gst_plugin_find_feature (GstPlugin * plugin, const gchar * name, GType type)
 787 {
 788   GList *walk;
 789   GstPluginFeature *result = NULL;
 790   GstTypeNameData data;
 791
 792   g_return_val_if_fail (name != NULL, NULL);
 793
 794   data.type = type;
 795   data.name = name;
 796
 797   walk = gst_filter_run (plugin->features,
 798       (GstFilterFunc) gst_plugin_feature_type_name_filter, TRUE, &data);
 799
 800   if (walk) {
 801     result = GST_PLUGIN_FEATURE (walk->data);
 802
 803     gst_object_ref (result);
 804     gst_plugin_feature_list_free (walk);
 805   }
 806
 807   return result;
 808 }
 809 #endif
 810
 811 #if 0
 812 static gboolean
 813 gst_plugin_feature_name_filter (GstPluginFeature * feature, const gchar * name)
 814 {
 815   return !strcmp (name, GST_PLUGIN_FEATURE_NAME (feature));
 816 }
 817 #endif
 818
 819 #if 0
 820 /**
 821  * gst_plugin_find_feature_by_name:
 822  * @plugin: plugin to get the feature from
 823  * @name: The name of the feature to find
 824  *
 825  * Find a feature of the given name in the given plugin.
 826  *
 827  * Returns: a GstPluginFeature or NULL if the feature was not found.
 828  */
 829 GstPluginFeature *
 830 gst_plugin_find_feature_by_name (GstPlugin * plugin, const gchar * name)
 831 {
 832   GList *walk;
 833   GstPluginFeature *result = NULL;
 834
 835   g_return_val_if_fail (name != NULL, NULL);
 836
 837   walk = gst_filter_run (plugin->features,
 838       (GstFilterFunc) gst_plugin_feature_name_filter, TRUE, (void *) name);
 839
 840   if (walk) {
 841     result = GST_PLUGIN_FEATURE (walk->data);
 842
 843     gst_object_ref (result);
 844     gst_plugin_feature_list_free (walk);
 845   }
 846
 847   return result;
 848 }
 849 #endif
 850
 851 /**
 852  * gst_plugin_load_by_name:
 853  * @name: name of plugin to load
 854  *
 855  * Load the named plugin. Refs the plugin.
 856  *
 857  * Returns: A reference to a loaded plugin, or NULL on error.
 858  */
 859 GstPlugin *
 860 gst_plugin_load_by_name (const gchar * name)
 861 {
 862   GstPlugin *plugin, *newplugin;
 863   GError *error = NULL;
 864
 865   GST_DEBUG ("looking up plugin %s in default registry", name);
 866   plugin = gst_registry_find_plugin (gst_registry_get_default (), name);
 867   if (plugin) {
 868     GST_DEBUG ("loading plugin %s from file %s", name, plugin->filename);
 869     newplugin = gst_plugin_load_file (plugin->filename, &error);
 870     gst_object_unref (plugin);
 871
 872     if (!newplugin) {
 873       GST_WARNING ("load_plugin error: %s\n", error->message);
 874       g_error_free (error);
 875       return NULL;
 876     }
 877     /* newplugin was reffed by load_file */
 878     return newplugin;
 879   }
 880
 881   GST_DEBUG ("Could not find plugin %s in registry", name);
 882   return NULL;
 883 }
 884
 885 /**
 886  * gst_plugin_load:
 887  * @plugin: plugin to load
 888  *
 889  * Loads @plugin. Note that the *return value* is the loaded plugin; @plugin is
 890  * untouched. The normal use pattern of this function goes like this:
 891  *
 892  * <programlisting>
 893  * GstPlugin *loaded_plugin;
 894  * loaded_plugin = gst_plugin_load (plugin);
 895  * // presumably, we're no longer interested in the potentially-unloaded plugin
 896  * gst_object_unref (plugin);
 897  * plugin = loaded_plugin;
 898  * </programlisting>
 899  *
 900  * Returns: A reference to a loaded plugin, or NULL on error.
 901  */
 902 GstPlugin *
 903 gst_plugin_load (GstPlugin * plugin)
 904 {
 905   GError *error = NULL;
 906   GstPlugin *newplugin;
 907
 908   if (gst_plugin_is_loaded (plugin)) {
 909     return plugin;
 910   }
 911
 912   if (!(newplugin = gst_plugin_load_file (plugin->filename, &error)))
 913     goto load_error;
 914
 915   return newplugin;
 916
 917 load_error:
 918   {
 919     GST_WARNING ("load_plugin error: %s\n", error->message);
 920     g_error_free (error);
 921     return NULL;
 922   }
 923 }
 924
 925 /**
 926  * gst_plugin_list_free:
 927  * @list: list of #GstPlugin
 928  *
 929  * Unrefs each member of @list, then frees the list.
 930  */
 931 void
 932 gst_plugin_list_free (GList * list)
 933 {
 934   GList *g;
 935
 936   for (g = list; g; g = g->next) {
 937     gst_object_unref (GST_PLUGIN (g->data));
 938   }
 939   g_list_free (list);
 940 }