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