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., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 /**
  24  * SECTION:gstplugin
  25  * @title: GstPlugin
  26  * @short_description: Container for features loaded from a shared object module
  27  * @see_also: #GstPluginFeature, #GstElementFactory
  28  *
  29  * GStreamer is extensible, so #GstElement instances can be loaded at runtime.
  30  * A plugin system can provide one or more of the basic
  31  * <application>GStreamer</application> #GstPluginFeature subclasses.
  32  *
  33  * A plugin should export a symbol <symbol>gst_plugin_desc</symbol> that is a
  34  * struct of type #GstPluginDesc.
  35  * the plugin loader will check the version of the core library the plugin was
  36  * linked against and will create a new #GstPlugin. It will then call the
  37  * #GstPluginInitFunc function that was provided in the
  38  * <symbol>gst_plugin_desc</symbol>.
  39  *
  40  * Once you have a handle to a #GstPlugin (e.g. from the #GstRegistry), you
  41  * can add any object that subclasses #GstPluginFeature.
  42  *
  43  * Usually plugins are always automatically loaded so you don't need to call
  44  * gst_plugin_load() explicitly to bring it into memory. There are options to
  45  * statically link plugins to an app or even use GStreamer without a plugin
  46  * repository in which case gst_plugin_load() can be needed to bring the plugin
  47  * into memory.
  48  */
  49
  50 #ifdef HAVE_CONFIG_H
  51 #include "config.h"
  52 #endif
  53
  54 #include "gst_private.h"
  55
  56 #include <glib/gstdio.h>
  57 #include <sys/types.h>
  58 #ifdef HAVE_DIRENT_H
  59 #include <dirent.h>
  60 #endif
  61 #ifdef HAVE_UNISTD_H
  62 #include <unistd.h>
  63 #endif
  64 #include <signal.h>
  65 #include <errno.h>
  66 #include <string.h>
  67
  68 #include "glib-compat-private.h"
  69
  70 #include <gst/gst.h>
  71
  72 #define GST_CAT_DEFAULT GST_CAT_PLUGIN_LOADING
  73
  74 static guint _num_static_plugins;       /* 0    */
  75 static GstPluginDesc *_static_plugins;  /* NULL */
  76 static gboolean _gst_plugin_inited;
  77 static gchar **_plugin_loading_whitelist;       /* NULL */
  78
  79 /* static variables for segfault handling of plugin loading */
  80 static char *_gst_plugin_fault_handler_filename = NULL;
  81
  82 /* list of valid licenses.
  83  * One of these must be specified or the plugin won't be loaded
  84  * Please file a bug to request any additional license be added.
  85  *
  86  * GPL: http://www.gnu.org/copyleft/gpl.html
  87  * LGPL: http://www.gnu.org/copyleft/lesser.html
  88  * QPL: http://www.trolltech.com/licenses/qpl.html
  89  * MPL: http://www.opensource.org/licenses/mozilla1.1.php
  90  * MIT/X11: http://www.opensource.org/licenses/mit-license.php
  91  * 3-clause BSD: http://www.opensource.org/licenses/bsd-license.php
  92  */
  93 static const gchar valid_licenses[] = "LGPL\000"        /* GNU Lesser General Public License */
  94     "GPL\000"                   /* GNU General Public License */
  95     "QPL\000"                   /* Trolltech Qt Public License */
  96     "GPL/QPL\000"               /* Combi-license of GPL + QPL */
  97     "MPL\000"                   /* MPL 1.1 license */
  98     "BSD\000"                   /* 3-clause BSD license */
  99     "MIT/X11\000"               /* MIT/X11 license */
 100     "Proprietary\000"           /* Proprietary license */
 101     GST_LICENSE_UNKNOWN;        /* some other license */
 102
 103 static const guint8 valid_licenses_idx[] = { 0, 5, 9, 13, 21, 25, 29, 37, 49 };
 104
 105 static GstPlugin *gst_plugin_register_func (GstPlugin * plugin,
 106     const GstPluginDesc * desc, gpointer user_data);
 107 static void gst_plugin_desc_copy (GstPluginDesc * dest,
 108     const GstPluginDesc * src);
 109
 110 static void gst_plugin_ext_dep_free (GstPluginDep * dep);
 111
 112 G_DEFINE_TYPE (GstPlugin, gst_plugin, GST_TYPE_OBJECT);
 113
 114 static void
 115 gst_plugin_init (GstPlugin * plugin)
 116 {
 117   plugin->priv =
 118       G_TYPE_INSTANCE_GET_PRIVATE (plugin, GST_TYPE_PLUGIN, GstPluginPrivate);
 119 }
 120
 121 static void
 122 gst_plugin_finalize (GObject * object)
 123 {
 124   GstPlugin *plugin = GST_PLUGIN_CAST (object);
 125
 126   GST_DEBUG ("finalizing plugin %" GST_PTR_FORMAT, plugin);
 127
 128   /* FIXME: make registry add a weak ref instead */
 129 #if 0
 130   GstRegistry *registry = gst_registry_get ();
 131   GList *g;
 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 #endif
 138
 139   g_free (plugin->filename);
 140   g_free (plugin->basename);
 141
 142   g_list_foreach (plugin->priv->deps, (GFunc) gst_plugin_ext_dep_free, NULL);
 143   g_list_free (plugin->priv->deps);
 144   plugin->priv->deps = NULL;
 145
 146   if (plugin->priv->cache_data) {
 147     gst_structure_free (plugin->priv->cache_data);
 148   }
 149
 150   G_OBJECT_CLASS (gst_plugin_parent_class)->finalize (object);
 151 }
 152
 153 static void
 154 gst_plugin_class_init (GstPluginClass * klass)
 155 {
 156   G_OBJECT_CLASS (klass)->finalize = gst_plugin_finalize;
 157
 158   g_type_class_add_private (klass, sizeof (GstPluginPrivate));
 159 }
 160
 161 GQuark
 162 gst_plugin_error_quark (void)
 163 {
 164   static GQuark quark = 0;
 165
 166   if (!quark)
 167     quark = g_quark_from_static_string ("gst_plugin_error");
 168   return quark;
 169 }
 170
 171 /**
 172  * gst_plugin_register_static:
 173  * @major_version: the major version number of the GStreamer core that the
 174  *     plugin was compiled for, you can just use GST_VERSION_MAJOR here
 175  * @minor_version: the minor version number of the GStreamer core that the
 176  *     plugin was compiled for, you can just use GST_VERSION_MINOR here
 177  * @name: a unique name of the plugin (ideally prefixed with an application- or
 178  *     library-specific namespace prefix in order to avoid name conflicts in
 179  *     case a similar plugin with the same name ever gets added to GStreamer)
 180  * @description: description of the plugin
 181  * @init_func: (scope call): pointer to the init function of this plugin.
 182  * @version: version string of the plugin
 183  * @license: effective license of plugin. Must be one of the approved licenses
 184  *     (see #GstPluginDesc above) or the plugin will not be registered.
 185  * @source: source module plugin belongs to
 186  * @package: shipped package plugin belongs to
 187  * @origin: URL to provider of plugin
 188  *
 189  * Registers a static plugin, ie. a plugin which is private to an application
 190  * or library and contained within the application or library (as opposed to
 191  * being shipped as a separate module file).
 192  *
 193  * You must make sure that GStreamer has been initialised (with gst_init() or
 194  * via gst_init_get_option_group()) before calling this function.
 195  *
 196  * Returns: %TRUE if the plugin was registered correctly, otherwise %FALSE.
 197  */
 198 gboolean
 199 gst_plugin_register_static (gint major_version, gint minor_version,
 200     const gchar * name, const gchar * description, GstPluginInitFunc init_func,
 201     const gchar * version, const gchar * license, const gchar * source,
 202     const gchar * package, const gchar * origin)
 203 {
 204   GstPluginDesc desc = { major_version, minor_version, name, description,
 205     init_func, version, license, source, package, origin, NULL,
 206   };
 207   GstPlugin *plugin;
 208   gboolean res = FALSE;
 209
 210   g_return_val_if_fail (name != NULL, FALSE);
 211   g_return_val_if_fail (description != NULL, FALSE);
 212   g_return_val_if_fail (init_func != NULL, FALSE);
 213   g_return_val_if_fail (version != NULL, FALSE);
 214   g_return_val_if_fail (license != NULL, FALSE);
 215   g_return_val_if_fail (source != NULL, FALSE);
 216   g_return_val_if_fail (package != NULL, FALSE);
 217   g_return_val_if_fail (origin != NULL, FALSE);
 218
 219   /* make sure gst_init() has been called */
 220   g_return_val_if_fail (_gst_plugin_inited != FALSE, FALSE);
 221
 222   GST_LOG ("attempting to load static plugin \"%s\" now...", name);
 223   plugin = g_object_new (GST_TYPE_PLUGIN, NULL);
 224   if (gst_plugin_register_func (plugin, &desc, NULL) != NULL) {
 225     GST_INFO ("registered static plugin \"%s\"", name);
 226     res = gst_registry_add_plugin (gst_registry_get (), plugin);
 227     GST_INFO ("added static plugin \"%s\", result: %d", name, res);
 228   }
 229   return res;
 230 }
 231
 232 /**
 233  * gst_plugin_register_static_full:
 234  * @major_version: the major version number of the GStreamer core that the
 235  *     plugin was compiled for, you can just use GST_VERSION_MAJOR here
 236  * @minor_version: the minor version number of the GStreamer core that the
 237  *     plugin was compiled for, you can just use GST_VERSION_MINOR here
 238  * @name: a unique name of the plugin (ideally prefixed with an application- or
 239  *     library-specific namespace prefix in order to avoid name conflicts in
 240  *     case a similar plugin with the same name ever gets added to GStreamer)
 241  * @description: description of the plugin
 242  * @init_full_func: (scope call): pointer to the init function with user data
 243  *     of this plugin.
 244  * @version: version string of the plugin
 245  * @license: effective license of plugin. Must be one of the approved licenses
 246  *     (see #GstPluginDesc above) or the plugin will not be registered.
 247  * @source: source module plugin belongs to
 248  * @package: shipped package plugin belongs to
 249  * @origin: URL to provider of plugin
 250  * @user_data: gpointer to user data
 251  *
 252  * Registers a static plugin, ie. a plugin which is private to an application
 253  * or library and contained within the application or library (as opposed to
 254  * being shipped as a separate module file) with a #GstPluginInitFullFunc
 255  * which allows user data to be passed to the callback function (useful
 256  * for bindings).
 257  *
 258  * You must make sure that GStreamer has been initialised (with gst_init() or
 259  * via gst_init_get_option_group()) before calling this function.
 260  *
 261  * Returns: %TRUE if the plugin was registered correctly, otherwise %FALSE.
 262  */
 263 gboolean
 264 gst_plugin_register_static_full (gint major_version, gint minor_version,
 265     const gchar * name, const gchar * description,
 266     GstPluginInitFullFunc init_full_func, const gchar * version,
 267     const gchar * license, const gchar * source, const gchar * package,
 268     const gchar * origin, gpointer user_data)
 269 {
 270   GstPluginDesc desc = { major_version, minor_version, name, description,
 271     (GstPluginInitFunc) init_full_func, version, license, source, package,
 272     origin, NULL,
 273   };
 274   GstPlugin *plugin;
 275   gboolean res = FALSE;
 276
 277   g_return_val_if_fail (name != NULL, FALSE);
 278   g_return_val_if_fail (description != NULL, FALSE);
 279   g_return_val_if_fail (init_full_func != NULL, FALSE);
 280   g_return_val_if_fail (version != NULL, FALSE);
 281   g_return_val_if_fail (license != NULL, FALSE);
 282   g_return_val_if_fail (source != NULL, FALSE);
 283   g_return_val_if_fail (package != NULL, FALSE);
 284   g_return_val_if_fail (origin != NULL, FALSE);
 285
 286   /* make sure gst_init() has been called */
 287   g_return_val_if_fail (_gst_plugin_inited != FALSE, FALSE);
 288
 289   GST_LOG ("attempting to load static plugin \"%s\" now...", name);
 290   plugin = g_object_new (GST_TYPE_PLUGIN, NULL);
 291   if (gst_plugin_register_func (plugin, &desc, user_data) != NULL) {
 292     GST_INFO ("registered static plugin \"%s\"", name);
 293     res = gst_registry_add_plugin (gst_registry_get (), plugin);
 294     GST_INFO ("added static plugin \"%s\", result: %d", name, res);
 295   }
 296   return res;
 297 }
 298
 299 void
 300 _priv_gst_plugin_initialize (void)
 301 {
 302   const gchar *whitelist;
 303   guint i;
 304
 305   _gst_plugin_inited = TRUE;
 306
 307   whitelist = g_getenv ("GST_PLUGIN_LOADING_WHITELIST");
 308   if (whitelist != NULL && *whitelist != '\0') {
 309     _plugin_loading_whitelist = g_strsplit (whitelist,
 310         G_SEARCHPATH_SEPARATOR_S, -1);
 311     for (i = 0; _plugin_loading_whitelist[i] != NULL; ++i) {
 312       GST_INFO ("plugins whitelist entry: %s", _plugin_loading_whitelist[i]);
 313     }
 314   }
 315
 316   /* now register all static plugins */
 317   GST_INFO ("registering %u static plugins", _num_static_plugins);
 318   for (i = 0; i < _num_static_plugins; ++i) {
 319     gst_plugin_register_static (_static_plugins[i].major_version,
 320         _static_plugins[i].minor_version, _static_plugins[i].name,
 321         _static_plugins[i].description, _static_plugins[i].plugin_init,
 322         _static_plugins[i].version, _static_plugins[i].license,
 323         _static_plugins[i].source, _static_plugins[i].package,
 324         _static_plugins[i].origin);
 325   }
 326
 327   if (_static_plugins) {
 328     free (_static_plugins);
 329     _static_plugins = NULL;
 330     _num_static_plugins = 0;
 331   }
 332 }
 333
 334 /* Whitelist entry format:
 335  *
 336  *   plugin1,plugin2@pathprefix or
 337  *   plugin1,plugin2@* or just
 338  *   plugin1,plugin2 or
 339  *   source-package@pathprefix or
 340  *   source-package@* or just
 341  *   source-package
 342  *
 343  * ie. the bit before the path will be checked against both the plugin
 344  * name and the plugin's source package name, to keep the format simple.
 345  */
 346 static gboolean
 347 gst_plugin_desc_matches_whitelist_entry (GstPluginDesc * desc,
 348     const gchar * filename, const gchar * pattern)
 349 {
 350   const gchar *sep;
 351   gboolean ret = FALSE;
 352   gchar *name;
 353
 354   GST_LOG ("Whitelist pattern '%s', plugin: %s of %s@%s", pattern, desc->name,
 355       desc->source, GST_STR_NULL (filename));
 356
 357   /* do we have a path prefix? */
 358   sep = strchr (pattern, '@');
 359   if (sep != NULL && strcmp (sep, "@*") != 0 && strcmp (sep, "@") != 0) {
 360     /* paths are not canonicalised or treated with realpath() here. This
 361      * should be good enough for our use case, since we just use the paths
 362      * autotools uses, and those will be constructed from the same prefix. */
 363     if (filename != NULL && !g_str_has_prefix (filename, sep + 1))
 364       return FALSE;
 365
 366     GST_LOG ("%s matches path prefix %s", GST_STR_NULL (filename), sep + 1);
 367   }
 368
 369   if (sep != NULL) {
 370     name = g_strndup (pattern, (gsize) (sep - pattern));
 371   } else {
 372     name = g_strdup (pattern);
 373   }
 374
 375   g_strstrip (name);
 376   if (!g_ascii_isalnum (*name)) {
 377     GST_WARNING ("Invalid whitelist pattern: %s", pattern);
 378     goto done;
 379   }
 380
 381   /* now check plugin names / source package name */
 382   if (strchr (name, ',') == NULL) {
 383     /* only a single name: either a plugin name or the source package name */
 384     ret = (strcmp (desc->source, name) == 0 || strcmp (desc->name, name) == 0);
 385   } else {
 386     gchar **n, **names;
 387
 388     /* multiple names: assume these are plugin names */
 389     names = g_strsplit (name, ",", -1);
 390     for (n = names; n != NULL && *n != NULL; ++n) {
 391       g_strstrip (*n);
 392       if (strcmp (desc->name, *n) == 0) {
 393         ret = TRUE;
 394         break;
 395       }
 396     }
 397     g_strfreev (names);
 398   }
 399
 400   GST_LOG ("plugin / source package name match: %d", ret);
 401
 402 done:
 403
 404   g_free (name);
 405   return ret;
 406 }
 407
 408 gboolean
 409 priv_gst_plugin_desc_is_whitelisted (GstPluginDesc * desc,
 410     const gchar * filename)
 411 {
 412   gchar **entry;
 413
 414   if (_plugin_loading_whitelist == NULL)
 415     return TRUE;
 416
 417   for (entry = _plugin_loading_whitelist; *entry != NULL; ++entry) {
 418     if (gst_plugin_desc_matches_whitelist_entry (desc, filename, *entry)) {
 419       GST_LOG ("Plugin %s is in whitelist", filename);
 420       return TRUE;
 421     }
 422   }
 423
 424   GST_LOG ("Plugin %s (package %s, file %s) not in whitelist", desc->name,
 425       desc->source, filename);
 426   return FALSE;
 427 }
 428
 429 gboolean
 430 priv_gst_plugin_loading_have_whitelist (void)
 431 {
 432   return (_plugin_loading_whitelist != NULL);
 433 }
 434
 435 guint32
 436 priv_gst_plugin_loading_get_whitelist_hash (void)
 437 {
 438   guint32 hash = 0;
 439
 440   if (_plugin_loading_whitelist != NULL) {
 441     gchar **w;
 442
 443     for (w = _plugin_loading_whitelist; *w != NULL; ++w)
 444       hash ^= g_str_hash (*w);
 445   }
 446
 447   return hash;
 448 }
 449
 450 /* this function could be extended to check if the plugin license matches the
 451  * applications license (would require the app to register its license somehow).
 452  * We'll wait for someone who's interested in it to code it :)
 453  */
 454 static gboolean
 455 gst_plugin_check_license (const gchar * license)
 456 {
 457   gint i;
 458
 459   for (i = 0; i < G_N_ELEMENTS (valid_licenses_idx); ++i) {
 460     if (strcmp (license, valid_licenses + valid_licenses_idx[i]) == 0)
 461       return TRUE;
 462   }
 463   return FALSE;
 464 }
 465
 466 static gboolean
 467 gst_plugin_check_version (gint major, gint minor)
 468 {
 469   /* return NULL if the major and minor version numbers are not compatible */
 470   /* with ours. */
 471   if (major != GST_VERSION_MAJOR || minor > GST_VERSION_MINOR)
 472     return FALSE;
 473
 474   return TRUE;
 475 }
 476
 477 static GstPlugin *
 478 gst_plugin_register_func (GstPlugin * plugin, const GstPluginDesc * desc,
 479     gpointer user_data)
 480 {
 481   if (!gst_plugin_check_version (desc->major_version, desc->minor_version)) {
 482     if (GST_CAT_DEFAULT)
 483       GST_WARNING ("plugin \"%s\" has incompatible version "
 484           "(plugin: %d.%d, gst: %d,%d), not loading",
 485           GST_STR_NULL (plugin->filename), desc->major_version,
 486           desc->minor_version, GST_VERSION_MAJOR, GST_VERSION_MINOR);
 487     return NULL;
 488   }
 489
 490   if (!desc->license || !desc->description || !desc->source ||
 491       !desc->package || !desc->origin) {
 492     if (GST_CAT_DEFAULT)
 493       GST_WARNING ("plugin \"%s\" has missing detail in GstPluginDesc, not "
 494           "loading", GST_STR_NULL (plugin->filename));
 495     return NULL;
 496   }
 497
 498   if (!gst_plugin_check_license (desc->license)) {
 499     if (GST_CAT_DEFAULT)
 500       GST_WARNING ("plugin \"%s\" has invalid license \"%s\", not loading",
 501           GST_STR_NULL (plugin->filename), desc->license);
 502     return NULL;
 503   }
 504
 505   if (GST_CAT_DEFAULT)
 506     GST_LOG ("plugin \"%s\" looks good", GST_STR_NULL (plugin->filename));
 507
 508   gst_plugin_desc_copy (&plugin->desc, desc);
 509
 510   /* make resident so we're really sure it never gets unloaded again.
 511    * Theoretically this is not needed, but practically it doesn't hurt.
 512    * And we're rather safe than sorry. */
 513   if (plugin->module)
 514     g_module_make_resident (plugin->module);
 515
 516   if (user_data) {
 517     if (!(((GstPluginInitFullFunc) (desc->plugin_init)) (plugin, user_data))) {
 518       if (GST_CAT_DEFAULT)
 519         GST_WARNING ("plugin \"%s\" failed to initialise",
 520             GST_STR_NULL (plugin->filename));
 521       return NULL;
 522     }
 523   } else {
 524     if (!((desc->plugin_init) (plugin))) {
 525       if (GST_CAT_DEFAULT)
 526         GST_WARNING ("plugin \"%s\" failed to initialise",
 527             GST_STR_NULL (plugin->filename));
 528       return NULL;
 529     }
 530   }
 531
 532   if (GST_CAT_DEFAULT)
 533     GST_LOG ("plugin \"%s\" initialised", GST_STR_NULL (plugin->filename));
 534
 535   return plugin;
 536 }
 537
 538 #ifdef HAVE_SIGACTION
 539 static struct sigaction oldaction;
 540 static gboolean _gst_plugin_fault_handler_is_setup = FALSE;
 541
 542 /*
 543  * _gst_plugin_fault_handler_restore:
 544  * segfault handler restorer
 545  */
 546 static void
 547 _gst_plugin_fault_handler_restore (void)
 548 {
 549   if (!_gst_plugin_fault_handler_is_setup)
 550     return;
 551
 552   _gst_plugin_fault_handler_is_setup = FALSE;
 553
 554   sigaction (SIGSEGV, &oldaction, NULL);
 555 }
 556
 557 /*
 558  * _gst_plugin_fault_handler_sighandler:
 559  * segfault handler implementation
 560  */
 561 static void
 562 _gst_plugin_fault_handler_sighandler (int signum)
 563 {
 564   /* We need to restore the fault handler or we'll keep getting it */
 565   _gst_plugin_fault_handler_restore ();
 566
 567   switch (signum) {
 568     case SIGSEGV:
 569       g_print ("\nERROR: ");
 570       g_print ("Caught a segmentation fault while loading plugin file:\n");
 571       g_print ("%s\n\n", _gst_plugin_fault_handler_filename);
 572       g_print ("Please either:\n");
 573       g_print ("- remove it and restart.\n");
 574       g_print
 575           ("- run with --gst-disable-segtrap --gst-disable-registry-fork and debug.\n");
 576       exit (-1);
 577       break;
 578     default:
 579       g_print ("Caught unhandled signal on plugin loading\n");
 580       break;
 581   }
 582 }
 583
 584 /*
 585  * _gst_plugin_fault_handler_setup:
 586  * sets up the segfault handler
 587  */
 588 static void
 589 _gst_plugin_fault_handler_setup (void)
 590 {
 591   struct sigaction action;
 592
 593   /* if asked to leave segfaults alone, just return */
 594   if (!gst_segtrap_is_enabled ())
 595     return;
 596
 597   if (_gst_plugin_fault_handler_is_setup)
 598     return;
 599
 600   _gst_plugin_fault_handler_is_setup = TRUE;
 601
 602   memset (&action, 0, sizeof (action));
 603   action.sa_handler = _gst_plugin_fault_handler_sighandler;
 604
 605   sigaction (SIGSEGV, &action, &oldaction);
 606 }
 607 #else /* !HAVE_SIGACTION */
 608 static void
 609 _gst_plugin_fault_handler_restore (void)
 610 {
 611 }
 612
 613 static void
 614 _gst_plugin_fault_handler_setup (void)
 615 {
 616 }
 617 #endif /* HAVE_SIGACTION */
 618
 619 /* g_time_val_from_iso8601() doesn't do quite what we want */
 620 static gboolean
 621 check_release_datetime (const gchar * date_time)
 622 {
 623   guint64 val;
 624
 625   /* we require YYYY-MM-DD or YYYY-MM-DDTHH:MMZ format */
 626   if (!g_ascii_isdigit (*date_time))
 627     return FALSE;
 628
 629   val = g_ascii_strtoull (date_time, (gchar **) & date_time, 10);
 630   if (val < 2000 || val > 2100 || *date_time != '-')
 631     return FALSE;
 632
 633   val = g_ascii_strtoull (date_time + 1, (gchar **) & date_time, 10);
 634   if (val == 0 || val > 12 || *date_time != '-')
 635     return FALSE;
 636
 637   val = g_ascii_strtoull (date_time + 1, (gchar **) & date_time, 10);
 638   if (val == 0 || val > 32)
 639     return FALSE;
 640
 641   /* end of string or date/time separator + HH:MMZ */
 642   if (*date_time == 'T' || *date_time == ' ') {
 643     val = g_ascii_strtoull (date_time + 1, (gchar **) & date_time, 10);
 644     if (val > 24 || *date_time != ':')
 645       return FALSE;
 646
 647     val = g_ascii_strtoull (date_time + 1, (gchar **) & date_time, 10);
 648     if (val > 59 || *date_time != 'Z')
 649       return FALSE;
 650
 651     ++date_time;
 652   }
 653
 654   return (*date_time == '\0');
 655 }
 656
 657 static GMutex gst_plugin_loading_mutex;
 658
 659 #define CHECK_PLUGIN_DESC_FIELD(desc,field,fn)                               \
 660   if (G_UNLIKELY ((desc)->field == NULL || *(desc)->field == '\0')) {        \
 661     g_warning ("Plugin description for '%s' has no valid %s field", fn, G_STRINGIFY (field)); \
 662     g_set_error (error, GST_PLUGIN_ERROR, GST_PLUGIN_ERROR_MODULE, \
 663         "Plugin %s has invalid plugin description field '%s'", \
 664         filename, G_STRINGIFY (field)); \
 665     goto return_error;                                                       \
 666   }
 667
 668 /**
 669  * gst_plugin_load_file:
 670  * @filename: the plugin filename to load
 671  * @error: pointer to a %NULL-valued GError
 672  *
 673  * Loads the given plugin and refs it.  Caller needs to unref after use.
 674  *
 675  * Returns: (transfer full): a reference to the existing loaded GstPlugin, a
 676  * reference to the newly-loaded GstPlugin, or %NULL if an error occurred.
 677  */
 678 GstPlugin *
 679 gst_plugin_load_file (const gchar * filename, GError ** error)
 680 {
 681   return _priv_gst_plugin_load_file_for_registry (filename, NULL, error);
 682 }
 683
 684 GstPlugin *
 685 _priv_gst_plugin_load_file_for_registry (const gchar * filename,
 686     GstRegistry * registry, GError ** error)
 687 {
 688   GstPluginDesc *desc;
 689   GstPlugin *plugin;
 690   GModule *module;
 691   gboolean ret;
 692   gpointer ptr;
 693   GStatBuf file_status;
 694   gboolean new_plugin = TRUE;
 695   GModuleFlags flags;
 696
 697   g_return_val_if_fail (filename != NULL, NULL);
 698
 699   if (registry == NULL)
 700     registry = gst_registry_get ();
 701
 702   g_mutex_lock (&gst_plugin_loading_mutex);
 703
 704   plugin = gst_registry_lookup (registry, filename);
 705   if (plugin) {
 706     if (plugin->module) {
 707       /* already loaded */
 708       g_mutex_unlock (&gst_plugin_loading_mutex);
 709       return plugin;
 710     } else {
 711       /* load plugin and update fields */
 712       new_plugin = FALSE;
 713     }
 714   }
 715
 716   GST_CAT_DEBUG (GST_CAT_PLUGIN_LOADING, "attempt to load plugin \"%s\"",
 717       filename);
 718
 719   if (!g_module_supported ()) {
 720     GST_CAT_DEBUG (GST_CAT_PLUGIN_LOADING, "module loading not supported");
 721     g_set_error (error,
 722         GST_PLUGIN_ERROR,
 723         GST_PLUGIN_ERROR_MODULE, "Dynamic loading not supported");
 724     goto return_error;
 725   }
 726
 727   if (g_stat (filename, &file_status)) {
 728     GST_CAT_DEBUG (GST_CAT_PLUGIN_LOADING, "problem accessing file");
 729     g_set_error (error,
 730         GST_PLUGIN_ERROR,
 731         GST_PLUGIN_ERROR_MODULE, "Problem accessing file %s: %s", filename,
 732         g_strerror (errno));
 733     goto return_error;
 734   }
 735
 736   flags = G_MODULE_BIND_LOCAL;
 737   /* libgstpython.so is the gst-python plugin loader. It needs to be loaded with
 738    * G_MODULE_BIND_LAZY.
 739    *
 740    * Ideally there should be a generic way for plugins to specify that they
 741    * need to be loaded with _LAZY.
 742    * */
 743   if (strstr (filename, "libgstpython"))
 744     flags |= G_MODULE_BIND_LAZY;
 745
 746   module = g_module_open (filename, flags);
 747   if (module == NULL) {
 748     GST_CAT_WARNING (GST_CAT_PLUGIN_LOADING, "module_open failed: %s",
 749         g_module_error ());
 750     g_set_error (error,
 751         GST_PLUGIN_ERROR, GST_PLUGIN_ERROR_MODULE, "Opening module failed: %s",
 752         g_module_error ());
 753     /* If we failed to open the shared object, then it's probably because a
 754      * plugin is linked against the wrong libraries. Print out an easy-to-see
 755      * message in this case. */
 756     g_warning ("Failed to load plugin '%s': %s", filename, g_module_error ());
 757     goto return_error;
 758   }
 759
 760   ret = g_module_symbol (module, "gst_plugin_desc", &ptr);
 761   if (!ret) {
 762     GST_DEBUG ("Could not find plugin entry point in \"%s\"", filename);
 763     g_set_error (error,
 764         GST_PLUGIN_ERROR,
 765         GST_PLUGIN_ERROR_MODULE,
 766         "File \"%s\" is not a GStreamer plugin", filename);
 767     g_module_close (module);
 768     goto return_error;
 769   }
 770
 771   desc = (GstPluginDesc *) ptr;
 772
 773   if (priv_gst_plugin_loading_have_whitelist () &&
 774       !priv_gst_plugin_desc_is_whitelisted (desc, filename)) {
 775     GST_INFO ("Whitelist specified and plugin not in whitelist, not loading: "
 776         "name=%s, package=%s, file=%s", desc->name, desc->source, filename);
 777     g_set_error (error, GST_PLUGIN_ERROR, GST_PLUGIN_ERROR_MODULE,
 778         "Not loading plugin file \"%s\", not in whitelist", filename);
 779     g_module_close (module);
 780     goto return_error;
 781   }
 782
 783   if (new_plugin) {
 784     plugin = g_object_new (GST_TYPE_PLUGIN, NULL);
 785     plugin->file_mtime = file_status.st_mtime;
 786     plugin->file_size = file_status.st_size;
 787     plugin->filename = g_strdup (filename);
 788     plugin->basename = g_path_get_basename (filename);
 789   }
 790
 791   plugin->module = module;
 792   plugin->orig_desc = desc;
 793
 794   if (new_plugin) {
 795     /* check plugin description: complain about bad values and fail */
 796     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, name, filename);
 797     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, description, filename);
 798     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, version, filename);
 799     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, license, filename);
 800     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, source, filename);
 801     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, package, filename);
 802     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, origin, filename);
 803
 804     if (plugin->orig_desc->name != NULL && plugin->orig_desc->name[0] == '"') {
 805       g_warning ("Invalid plugin name '%s' - fix your GST_PLUGIN_DEFINE "
 806           "(remove quotes around plugin name)", plugin->orig_desc->name);
 807     }
 808
 809     if (plugin->orig_desc->release_datetime != NULL &&
 810         !check_release_datetime (plugin->orig_desc->release_datetime)) {
 811       GST_ERROR ("GstPluginDesc for '%s' has invalid datetime '%s'",
 812           filename, plugin->orig_desc->release_datetime);
 813       plugin->orig_desc->release_datetime = NULL;
 814     }
 815   }
 816
 817   GST_LOG ("Plugin %p for file \"%s\" prepared, calling entry function...",
 818       plugin, filename);
 819
 820   /* this is where we load the actual .so, so let's trap SIGSEGV */
 821   _gst_plugin_fault_handler_setup ();
 822   _gst_plugin_fault_handler_filename = plugin->filename;
 823
 824   GST_LOG ("Plugin %p for file \"%s\" prepared, registering...",
 825       plugin, filename);
 826
 827   if (!gst_plugin_register_func (plugin, plugin->orig_desc, NULL)) {
 828     /* remove signal handler */
 829     _gst_plugin_fault_handler_restore ();
 830     GST_DEBUG ("gst_plugin_register_func failed for plugin \"%s\"", filename);
 831     /* plugin == NULL */
 832     g_set_error (error,
 833         GST_PLUGIN_ERROR,
 834         GST_PLUGIN_ERROR_MODULE,
 835         "File \"%s\" appears to be a GStreamer plugin, but it failed to initialize",
 836         filename);
 837     goto return_error;
 838   }
 839
 840   /* remove signal handler */
 841   _gst_plugin_fault_handler_restore ();
 842   _gst_plugin_fault_handler_filename = NULL;
 843   GST_INFO ("plugin \"%s\" loaded", plugin->filename);
 844
 845   if (new_plugin) {
 846     gst_object_ref (plugin);
 847     gst_registry_add_plugin (registry, plugin);
 848   }
 849
 850   g_mutex_unlock (&gst_plugin_loading_mutex);
 851   return plugin;
 852
 853 return_error:
 854   {
 855     if (plugin)
 856       gst_object_unref (plugin);
 857     g_mutex_unlock (&gst_plugin_loading_mutex);
 858     return NULL;
 859   }
 860 }
 861
 862 static void
 863 gst_plugin_desc_copy (GstPluginDesc * dest, const GstPluginDesc * src)
 864 {
 865   dest->major_version = src->major_version;
 866   dest->minor_version = src->minor_version;
 867   dest->name = g_intern_string (src->name);
 868   dest->description = g_intern_string (src->description);
 869   dest->plugin_init = src->plugin_init;
 870   dest->version = g_intern_string (src->version);
 871   dest->license = g_intern_string (src->license);
 872   dest->source = g_intern_string (src->source);
 873   dest->package = g_intern_string (src->package);
 874   dest->origin = g_intern_string (src->origin);
 875   dest->release_datetime = g_intern_string (src->release_datetime);
 876 }
 877
 878 /**
 879  * gst_plugin_get_name:
 880  * @plugin: plugin to get the name of
 881  *
 882  * Get the short name of the plugin
 883  *
 884  * Returns: the name of the plugin
 885  */
 886 const gchar *
 887 gst_plugin_get_name (GstPlugin * plugin)
 888 {
 889   g_return_val_if_fail (plugin != NULL, NULL);
 890
 891   return plugin->desc.name;
 892 }
 893
 894 /**
 895  * gst_plugin_get_description:
 896  * @plugin: plugin to get long name of
 897  *
 898  * Get the long descriptive name of the plugin
 899  *
 900  * Returns: the long name of the plugin
 901  */
 902 const gchar *
 903 gst_plugin_get_description (GstPlugin * plugin)
 904 {
 905   g_return_val_if_fail (plugin != NULL, NULL);
 906
 907   return plugin->desc.description;
 908 }
 909
 910 /**
 911  * gst_plugin_get_filename:
 912  * @plugin: plugin to get the filename of
 913  *
 914  * get the filename of the plugin
 915  *
 916  * Returns: the filename of the plugin
 917  */
 918 const gchar *
 919 gst_plugin_get_filename (GstPlugin * plugin)
 920 {
 921   g_return_val_if_fail (plugin != NULL, NULL);
 922
 923   return plugin->filename;
 924 }
 925
 926 /**
 927  * gst_plugin_get_version:
 928  * @plugin: plugin to get the version of
 929  *
 930  * get the version of the plugin
 931  *
 932  * Returns: the version of the plugin
 933  */
 934 const gchar *
 935 gst_plugin_get_version (GstPlugin * plugin)
 936 {
 937   g_return_val_if_fail (plugin != NULL, NULL);
 938
 939   return plugin->desc.version;
 940 }
 941
 942 /**
 943  * gst_plugin_get_license:
 944  * @plugin: plugin to get the license of
 945  *
 946  * get the license of the plugin
 947  *
 948  * Returns: the license of the plugin
 949  */
 950 const gchar *
 951 gst_plugin_get_license (GstPlugin * plugin)
 952 {
 953   g_return_val_if_fail (plugin != NULL, NULL);
 954
 955   return plugin->desc.license;
 956 }
 957
 958 /**
 959  * gst_plugin_get_source:
 960  * @plugin: plugin to get the source of
 961  *
 962  * get the source module the plugin belongs to.
 963  *
 964  * Returns: the source of the plugin
 965  */
 966 const gchar *
 967 gst_plugin_get_source (GstPlugin * plugin)
 968 {
 969   g_return_val_if_fail (plugin != NULL, NULL);
 970
 971   return plugin->desc.source;
 972 }
 973
 974 /**
 975  * gst_plugin_get_package:
 976  * @plugin: plugin to get the package of
 977  *
 978  * get the package the plugin belongs to.
 979  *
 980  * Returns: the package of the plugin
 981  */
 982 const gchar *
 983 gst_plugin_get_package (GstPlugin * plugin)
 984 {
 985   g_return_val_if_fail (plugin != NULL, NULL);
 986
 987   return plugin->desc.package;
 988 }
 989
 990 /**
 991  * gst_plugin_get_origin:
 992  * @plugin: plugin to get the origin of
 993  *
 994  * get the URL where the plugin comes from
 995  *
 996  * Returns: the origin of the plugin
 997  */
 998 const gchar *
 999 gst_plugin_get_origin (GstPlugin * plugin)
1000 {
1001   g_return_val_if_fail (plugin != NULL, NULL);
1002
1003   return plugin->desc.origin;
1004 }
1005
1006 /**
1007  * gst_plugin_get_release_date_string:
1008  * @plugin: plugin to get the release date of
1009  *
1010  * Get the release date (and possibly time) in form of a string, if available.
1011  *
1012  * For normal GStreamer plugin releases this will usually just be a date in
1013  * the form of "YYYY-MM-DD", while pre-releases and builds from git may contain
1014  * a time component after the date as well, in which case the string will be
1015  * formatted like "YYYY-MM-DDTHH:MMZ" (e.g. "2012-04-30T09:30Z").
1016  *
1017  * There may be plugins that do not have a valid release date set on them.
1018  *
1019  * Returns: (nullable): the date string of the plugin, or %NULL if not
1020  * available.
1021  */
1022 const gchar *
1023 gst_plugin_get_release_date_string (GstPlugin * plugin)
1024 {
1025   g_return_val_if_fail (plugin != NULL, NULL);
1026
1027   return plugin->desc.release_datetime;
1028 }
1029
1030 /**
1031  * gst_plugin_is_loaded:
1032  * @plugin: plugin to query
1033  *
1034  * queries if the plugin is loaded into memory
1035  *
1036  * Returns: %TRUE is loaded, %FALSE otherwise
1037  */
1038 gboolean
1039 gst_plugin_is_loaded (GstPlugin * plugin)
1040 {
1041   g_return_val_if_fail (plugin != NULL, FALSE);
1042
1043   return (plugin->module != NULL || plugin->filename == NULL);
1044 }
1045
1046 /**
1047  * gst_plugin_get_cache_data:
1048  * @plugin: a plugin
1049  *
1050  * Gets the plugin specific data cache. If it is %NULL there is no cached data
1051  * stored. This is the case when the registry is getting rebuilt.
1052  *
1053  * Returns: (transfer none) (nullable): The cached data as a
1054  * #GstStructure or %NULL.
1055  */
1056 const GstStructure *
1057 gst_plugin_get_cache_data (GstPlugin * plugin)
1058 {
1059   g_return_val_if_fail (GST_IS_PLUGIN (plugin), NULL);
1060
1061   return plugin->priv->cache_data;
1062 }
1063
1064 /**
1065  * gst_plugin_set_cache_data:
1066  * @plugin: a plugin
1067  * @cache_data: (transfer full): a structure containing the data to cache
1068  *
1069  * Adds plugin specific data to cache. Passes the ownership of the structure to
1070  * the @plugin.
1071  *
1072  * The cache is flushed every time the registry is rebuilt.
1073  */
1074 void
1075 gst_plugin_set_cache_data (GstPlugin * plugin, GstStructure * cache_data)
1076 {
1077   g_return_if_fail (GST_IS_PLUGIN (plugin));
1078   g_return_if_fail (GST_IS_STRUCTURE (cache_data));
1079
1080   if (plugin->priv->cache_data) {
1081     gst_structure_free (plugin->priv->cache_data);
1082   }
1083   plugin->priv->cache_data = cache_data;
1084 }
1085
1086 #if 0
1087 /**
1088  * gst_plugin_feature_list:
1089  * @plugin: plugin to query
1090  * @filter: the filter to use
1091  * @first: only return first match
1092  * @user_data: user data passed to the filter function
1093  *
1094  * Runs a filter against all plugin features and returns a GList with
1095  * the results. If the first flag is set, only the first match is
1096  * returned (as a list with a single object).
1097  *
1098  * Returns: a GList of features, g_list_free after use.
1099  */
1100 GList *
1101 gst_plugin_feature_filter (GstPlugin * plugin,
1102     GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
1103 {
1104   GList *list;
1105   GList *g;
1106
1107   list = gst_filter_run (plugin->features, (GstFilterFunc) filter, first,
1108       user_data);
1109   for (g = list; g; g = g->next) {
1110     gst_object_ref (plugin);
1111   }
1112
1113   return list;
1114 }
1115
1116 typedef struct
1117 {
1118   GstPluginFeatureFilter filter;
1119   gboolean first;
1120   gpointer user_data;
1121   GList *result;
1122 }
1123 FeatureFilterData;
1124
1125 static gboolean
1126 _feature_filter (GstPlugin * plugin, gpointer user_data)
1127 {
1128   GList *result;
1129   FeatureFilterData *data = (FeatureFilterData *) user_data;
1130
1131   result = gst_plugin_feature_filter (plugin, data->filter, data->first,
1132       data->user_data);
1133   if (result) {
1134     data->result = g_list_concat (data->result, result);
1135     return TRUE;
1136   }
1137   return FALSE;
1138 }
1139
1140 /**
1141  * gst_plugin_list_feature_filter:
1142  * @list: a #GList of plugins to query
1143  * @filter: the filter function to use
1144  * @first: only return first match
1145  * @user_data: user data passed to the filter function
1146  *
1147  * Runs a filter against all plugin features of the plugins in the given
1148  * list and returns a GList with the results.
1149  * If the first flag is set, only the first match is
1150  * returned (as a list with a single object).
1151  *
1152  * Returns: a GList of features, g_list_free after use.
1153  */
1154 GList *
1155 gst_plugin_list_feature_filter (GList * list,
1156     GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
1157 {
1158   FeatureFilterData data;
1159   GList *result;
1160
1161   data.filter = filter;
1162   data.first = first;
1163   data.user_data = user_data;
1164   data.result = NULL;
1165
1166   result = gst_filter_run (list, (GstFilterFunc) _feature_filter, first, &data);
1167   g_list_free (result);
1168
1169   return data.result;
1170 }
1171
1172 /**
1173  * gst_plugin_find_feature:
1174  * @plugin: plugin to get the feature from
1175  * @name: The name of the feature to find
1176  * @type: The type of the feature to find
1177  *
1178  * Find a feature of the given name and type in the given plugin.
1179  *
1180  * Returns: a GstPluginFeature or %NULL if the feature was not found.
1181  */
1182 GstPluginFeature *
1183 gst_plugin_find_feature (GstPlugin * plugin, const gchar * name, GType type)
1184 {
1185   GList *walk;
1186   GstPluginFeature *result = NULL;
1187   GstTypeNameData data;
1188
1189   g_return_val_if_fail (name != NULL, NULL);
1190
1191   data.type = type;
1192   data.name = name;
1193
1194   walk = gst_filter_run (plugin->features,
1195       (GstFilterFunc) gst_plugin_feature_type_name_filter, TRUE, &data);
1196
1197   if (walk) {
1198     result = GST_PLUGIN_FEATURE (walk->data);
1199
1200     gst_object_ref (result);
1201     gst_plugin_feature_list_free (walk);
1202   }
1203
1204   return result;
1205 }
1206 #endif
1207
1208 #if 0
1209 static gboolean
1210 gst_plugin_feature_name_filter (GstPluginFeature * feature, const gchar * name)
1211 {
1212   return !strcmp (name, GST_PLUGIN_FEATURE_NAME (feature));
1213 }
1214 #endif
1215
1216 #if 0
1217 /**
1218  * gst_plugin_find_feature_by_name:
1219  * @plugin: plugin to get the feature from
1220  * @name: The name of the feature to find
1221  *
1222  * Find a feature of the given name in the given plugin.
1223  *
1224  * Returns: a GstPluginFeature or %NULL if the feature was not found.
1225  */
1226 GstPluginFeature *
1227 gst_plugin_find_feature_by_name (GstPlugin * plugin, const gchar * name)
1228 {
1229   GList *walk;
1230   GstPluginFeature *result = NULL;
1231
1232   g_return_val_if_fail (name != NULL, NULL);
1233
1234   walk = gst_filter_run (plugin->features,
1235       (GstFilterFunc) gst_plugin_feature_name_filter, TRUE, (void *) name);
1236
1237   if (walk) {
1238     result = GST_PLUGIN_FEATURE (walk->data);
1239
1240     gst_object_ref (result);
1241     gst_plugin_feature_list_free (walk);
1242   }
1243
1244   return result;
1245 }
1246 #endif
1247
1248 /**
1249  * gst_plugin_load_by_name:
1250  * @name: name of plugin to load
1251  *
1252  * Load the named plugin. Refs the plugin.
1253  *
1254  * Returns: (transfer full): a reference to a loaded plugin, or %NULL on error.
1255  */
1256 GstPlugin *
1257 gst_plugin_load_by_name (const gchar * name)
1258 {
1259   GstPlugin *plugin, *newplugin;
1260   GError *error = NULL;
1261
1262   GST_DEBUG ("looking up plugin %s in default registry", name);
1263   plugin = gst_registry_find_plugin (gst_registry_get (), name);
1264   if (plugin) {
1265     GST_DEBUG ("loading plugin %s from file %s", name, plugin->filename);
1266     newplugin = gst_plugin_load_file (plugin->filename, &error);
1267     gst_object_unref (plugin);
1268
1269     if (!newplugin) {
1270       GST_WARNING ("load_plugin error: %s", error->message);
1271       g_error_free (error);
1272       return NULL;
1273     }
1274     /* newplugin was reffed by load_file */
1275     return newplugin;
1276   }
1277
1278   GST_DEBUG ("Could not find plugin %s in registry", name);
1279   return NULL;
1280 }
1281
1282 /**
1283  * gst_plugin_load:
1284  * @plugin: (transfer none): plugin to load
1285  *
1286  * Loads @plugin. Note that the *return value* is the loaded plugin; @plugin is
1287  * untouched. The normal use pattern of this function goes like this:
1288  *
1289  * |[
1290  * GstPlugin *loaded_plugin;
1291  * loaded_plugin = gst_plugin_load (plugin);
1292  * // presumably, we're no longer interested in the potentially-unloaded plugin
1293  * gst_object_unref (plugin);
1294  * plugin = loaded_plugin;
1295  * ]|
1296  *
1297  * Returns: (transfer full): a reference to a loaded plugin, or %NULL on error.
1298  */
1299 GstPlugin *
1300 gst_plugin_load (GstPlugin * plugin)
1301 {
1302   GError *error = NULL;
1303   GstPlugin *newplugin;
1304
1305   if (gst_plugin_is_loaded (plugin)) {
1306     return plugin;
1307   }
1308
1309   if (!(newplugin = gst_plugin_load_file (plugin->filename, &error)))
1310     goto load_error;
1311
1312   return newplugin;
1313
1314 load_error:
1315   {
1316     GST_WARNING ("load_plugin error: %s", error->message);
1317     g_error_free (error);
1318     return NULL;
1319   }
1320 }
1321
1322 /**
1323  * gst_plugin_list_free:
1324  * @list: (transfer full) (element-type Gst.Plugin): list of #GstPlugin
1325  *
1326  * Unrefs each member of @list, then frees the list.
1327  */
1328 void
1329 gst_plugin_list_free (GList * list)
1330 {
1331   GList *g;
1332
1333   for (g = list; g; g = g->next) {
1334     gst_object_unref (GST_PLUGIN_CAST (g->data));
1335   }
1336   g_list_free (list);
1337 }
1338
1339 /* ===== plugin dependencies ===== */
1340
1341 /* Scenarios:
1342  * ENV + xyz     where ENV can contain multiple values separated by SEPARATOR
1343  *               xyz may be "" (if ENV contains path to file rather than dir)
1344  * ENV + *xyz   same as above, but xyz acts as suffix filter
1345  * ENV + xyz*   same as above, but xyz acts as prefix filter (is this needed?)
1346  * ENV + *xyz*  same as above, but xyz acts as strstr filter (is this needed?)
1347  *
1348  * same as above, with additional paths hard-coded at compile-time:
1349  *   - only check paths + ... if ENV is not set or yields not paths
1350  *   - always check paths + ... in addition to ENV
1351  *
1352  * When user specifies set of environment variables, he/she may also use e.g.
1353  * "HOME/.mystuff/plugins", and we'll expand the content of $HOME with the
1354  * remainder
1355  */
1356
1357 /* we store in registry:
1358  *  sets of:
1359  *   {
1360  *     - environment variables (array of strings)
1361  *     - last hash of env variable contents (uint) (so we can avoid doing stats
1362  *       if one of the env vars has changed; premature optimisation galore)
1363  *     - hard-coded paths (array of strings)
1364  *     - xyz filename/suffix/prefix strings (array of strings)
1365  *     - flags (int)
1366  *     - last hash of file/dir stats (int)
1367  *   }
1368  *   (= struct GstPluginDep)
1369  */
1370
1371 static guint
1372 gst_plugin_ext_dep_get_env_vars_hash (GstPlugin * plugin, GstPluginDep * dep)
1373 {
1374   gchar **e;
1375   guint hash;
1376
1377   /* there's no deeper logic to what we do here; all we want to know (when
1378    * checking if the plugin needs to be rescanned) is whether the content of
1379    * one of the environment variables in the list is different from when it
1380    * was last scanned */
1381   hash = 0;
1382   for (e = dep->env_vars; e != NULL && *e != NULL; ++e) {
1383     const gchar *val;
1384     gchar env_var[256];
1385
1386     /* order matters: "val",NULL needs to yield a different hash than
1387      * NULL,"val", so do a shift here whether the var is set or not */
1388     hash = hash << 5;
1389
1390     /* want environment variable at beginning of string */
1391     if (!g_ascii_isalnum (**e)) {
1392       GST_WARNING_OBJECT (plugin, "string prefix is not a valid environment "
1393           "variable string: %s", *e);
1394       continue;
1395     }
1396
1397     /* user is allowed to specify e.g. "HOME/.pitivi/plugins" */
1398     g_strlcpy (env_var, *e, sizeof (env_var));
1399     g_strdelimit (env_var, "/\\", '\0');
1400
1401     if ((val = g_getenv (env_var)))
1402       hash += g_str_hash (val);
1403   }
1404
1405   return hash;
1406 }
1407
1408 gboolean
1409 _priv_plugin_deps_env_vars_changed (GstPlugin * plugin)
1410 {
1411   GList *l;
1412
1413   for (l = plugin->priv->deps; l != NULL; l = l->next) {
1414     GstPluginDep *dep = l->data;
1415
1416     if (dep->env_hash != gst_plugin_ext_dep_get_env_vars_hash (plugin, dep))
1417       return TRUE;
1418   }
1419
1420   return FALSE;
1421 }
1422
1423 static void
1424 gst_plugin_ext_dep_extract_env_vars_paths (GstPlugin * plugin,
1425     GstPluginDep * dep, GQueue * paths)
1426 {
1427   gchar **evars;
1428
1429   for (evars = dep->env_vars; evars != NULL && *evars != NULL; ++evars) {
1430     const gchar *e;
1431     gchar **components;
1432
1433     /* want environment variable at beginning of string */
1434     if (!g_ascii_isalnum (**evars)) {
1435       GST_WARNING_OBJECT (plugin, "string prefix is not a valid environment "
1436           "variable string: %s", *evars);
1437       continue;
1438     }
1439
1440     /* user is allowed to specify e.g. "HOME/.pitivi/plugins", which we want to
1441      * split into the env_var name component and the path component */
1442     components = g_strsplit_set (*evars, "/\\", 2);
1443     g_assert (components != NULL);
1444
1445     e = g_getenv (components[0]);
1446     GST_LOG_OBJECT (plugin, "expanding %s = '%s' (path suffix: %s)",
1447         components[0], GST_STR_NULL (e), GST_STR_NULL (components[1]));
1448
1449     if (components[1] != NULL) {
1450       g_strdelimit (components[1], "/\\", G_DIR_SEPARATOR);
1451     }
1452
1453     if (e != NULL && *e != '\0') {
1454       gchar **arr;
1455       guint i;
1456
1457       arr = g_strsplit (e, G_SEARCHPATH_SEPARATOR_S, -1);
1458
1459       for (i = 0; arr != NULL && arr[i] != NULL; ++i) {
1460         gchar *full_path;
1461
1462         if (!g_path_is_absolute (arr[i])) {
1463           GST_INFO_OBJECT (plugin, "ignoring environment variable content '%s'"
1464               ": either not an absolute path or not a path at all", arr[i]);
1465           continue;
1466         }
1467
1468         if (components[1] != NULL) {
1469           full_path = g_build_filename (arr[i], components[1], NULL);
1470         } else {
1471           full_path = g_strdup (arr[i]);
1472         }
1473
1474         if (!g_queue_find_custom (paths, full_path, (GCompareFunc) strcmp)) {
1475           GST_LOG_OBJECT (plugin, "path: '%s'", full_path);
1476           g_queue_push_tail (paths, full_path);
1477           full_path = NULL;
1478         } else {
1479           GST_LOG_OBJECT (plugin, "path: '%s' (duplicate,ignoring)", full_path);
1480           g_free (full_path);
1481         }
1482       }
1483
1484       g_strfreev (arr);
1485     }
1486
1487     g_strfreev (components);
1488   }
1489
1490   GST_LOG_OBJECT (plugin, "Extracted %d paths from environment", paths->length);
1491 }
1492
1493 static guint
1494 gst_plugin_ext_dep_get_hash_from_stat_entry (GStatBuf * s)
1495 {
1496 #ifdef S_IFBLK
1497   if (!(s->st_mode & (S_IFDIR | S_IFREG | S_IFBLK | S_IFCHR)))
1498 #else
1499   /* MSVC does not have S_IFBLK */
1500   if (!(s->st_mode & (S_IFDIR | S_IFREG | S_IFCHR)))
1501 #endif
1502     return (guint) - 1;
1503
1504   /* completely random formula */
1505   return ((s->st_size << 3) + (s->st_mtime << 5)) ^ s->st_ctime;
1506 }
1507
1508 static gboolean
1509 gst_plugin_ext_dep_direntry_matches (GstPlugin * plugin, const gchar * entry,
1510     const gchar ** filenames, GstPluginDependencyFlags flags)
1511 {
1512   /* no filenames specified, match all entries for now (could probably
1513    * optimise by just taking the dir stat hash or so) */
1514   if (filenames == NULL || *filenames == NULL || **filenames == '\0')
1515     return TRUE;
1516
1517   while (*filenames != NULL) {
1518     /* suffix match? */
1519     if (((flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX)) &&
1520         g_str_has_suffix (entry, *filenames)) {
1521       return TRUE;
1522     } else if (((flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_PREFIX)) &&
1523         g_str_has_prefix (entry, *filenames)) {
1524       return TRUE;
1525       /* else it's an exact match that's needed */
1526     } else if (strcmp (entry, *filenames) == 0) {
1527       return TRUE;
1528     }
1529     GST_LOG ("%s does not match %s, flags=0x%04x", entry, *filenames, flags);
1530     ++filenames;
1531   }
1532   return FALSE;
1533 }
1534
1535 static guint
1536 gst_plugin_ext_dep_scan_dir_and_match_names (GstPlugin * plugin,
1537     const gchar * path, const gchar ** filenames,
1538     GstPluginDependencyFlags flags, int depth)
1539 {
1540   const gchar *entry;
1541   gboolean recurse_dirs;
1542   GError *err = NULL;
1543   GDir *dir;
1544   guint hash = 0;
1545
1546   recurse_dirs = ! !(flags & GST_PLUGIN_DEPENDENCY_FLAG_RECURSE);
1547
1548   dir = g_dir_open (path, 0, &err);
1549   if (dir == NULL) {
1550     GST_DEBUG_OBJECT (plugin, "g_dir_open(%s) failed: %s", path, err->message);
1551     g_error_free (err);
1552     return (guint) - 1;
1553   }
1554
1555   /* FIXME: we're assuming here that we always get the directory entries in
1556    * the same order, and not in a random order */
1557   while ((entry = g_dir_read_name (dir))) {
1558     gboolean have_match;
1559     GStatBuf s;
1560     gchar *full_path;
1561     guint fhash;
1562
1563     have_match =
1564         gst_plugin_ext_dep_direntry_matches (plugin, entry, filenames, flags);
1565
1566     /* avoid the stat if possible */
1567     if (!have_match && !recurse_dirs)
1568       continue;
1569
1570     full_path = g_build_filename (path, entry, NULL);
1571     if (g_stat (full_path, &s) < 0) {
1572       fhash = (guint) - 1;
1573       GST_LOG_OBJECT (plugin, "stat: %s (error: %s)", full_path,
1574           g_strerror (errno));
1575     } else if (have_match) {
1576       fhash = gst_plugin_ext_dep_get_hash_from_stat_entry (&s);
1577       GST_LOG_OBJECT (plugin, "stat: %s (result: %u)", full_path, fhash);
1578     } else if ((s.st_mode & (S_IFDIR))) {
1579       fhash = gst_plugin_ext_dep_scan_dir_and_match_names (plugin, full_path,
1580           filenames, flags, depth + 1);
1581     } else {
1582       /* it's not a name match, we want to recurse, but it's not a directory */
1583       g_free (full_path);
1584       continue;
1585     }
1586
1587     hash = hash + fhash;
1588     g_free (full_path);
1589   }
1590
1591   g_dir_close (dir);
1592   return hash;
1593 }
1594
1595 static guint
1596 gst_plugin_ext_dep_scan_path_with_filenames (GstPlugin * plugin,
1597     const gchar * path, const gchar ** filenames,
1598     GstPluginDependencyFlags flags)
1599 {
1600   const gchar *empty_filenames[] = { "", NULL };
1601   gboolean recurse_into_dirs, partial_names = FALSE;
1602   guint i, hash = 0;
1603
1604   /* to avoid special-casing below (FIXME?) */
1605   if (filenames == NULL || *filenames == NULL)
1606     filenames = empty_filenames;
1607
1608   recurse_into_dirs = ! !(flags & GST_PLUGIN_DEPENDENCY_FLAG_RECURSE);
1609
1610   if ((flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX) ||
1611       (flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_PREFIX))
1612     partial_names = TRUE;
1613
1614   /* if we can construct the exact paths to check with the data we have, just
1615    * stat them one by one; this is more efficient than opening the directory
1616    * and going through each entry to see if it matches one of our filenames. */
1617   if (!recurse_into_dirs && !partial_names) {
1618     for (i = 0; filenames[i] != NULL; ++i) {
1619       GStatBuf s;
1620       gchar *full_path;
1621       guint fhash;
1622
1623       full_path = g_build_filename (path, filenames[i], NULL);
1624       if (g_stat (full_path, &s) < 0) {
1625         fhash = (guint) - 1;
1626         GST_LOG_OBJECT (plugin, "stat: %s (error: %s)", full_path,
1627             g_strerror (errno));
1628       } else {
1629         fhash = gst_plugin_ext_dep_get_hash_from_stat_entry (&s);
1630         GST_LOG_OBJECT (plugin, "stat: %s (result: %08x)", full_path, fhash);
1631       }
1632       hash += fhash;
1633       g_free (full_path);
1634     }
1635   } else {
1636     hash = gst_plugin_ext_dep_scan_dir_and_match_names (plugin, path,
1637         filenames, flags, 0);
1638   }
1639
1640   return hash;
1641 }
1642
1643 static guint
1644 gst_plugin_ext_dep_get_stat_hash (GstPlugin * plugin, GstPluginDep * dep)
1645 {
1646   gboolean paths_are_default_only;
1647   GQueue scan_paths = G_QUEUE_INIT;
1648   guint scan_hash = 0;
1649   gchar *path;
1650
1651   GST_LOG_OBJECT (plugin, "start");
1652
1653   paths_are_default_only =
1654       dep->flags & GST_PLUGIN_DEPENDENCY_FLAG_PATHS_ARE_DEFAULT_ONLY;
1655
1656   gst_plugin_ext_dep_extract_env_vars_paths (plugin, dep, &scan_paths);
1657
1658   if (g_queue_is_empty (&scan_paths) || !paths_are_default_only) {
1659     gchar **paths;
1660
1661     for (paths = dep->paths; paths != NULL && *paths != NULL; ++paths) {
1662       const gchar *path = *paths;
1663
1664       if (!g_queue_find_custom (&scan_paths, path, (GCompareFunc) strcmp)) {
1665         GST_LOG_OBJECT (plugin, "path: '%s'", path);
1666         g_queue_push_tail (&scan_paths, g_strdup (path));
1667       } else {
1668         GST_LOG_OBJECT (plugin, "path: '%s' (duplicate, ignoring)", path);
1669       }
1670     }
1671   }
1672
1673   while ((path = g_queue_pop_head (&scan_paths))) {
1674     scan_hash += gst_plugin_ext_dep_scan_path_with_filenames (plugin, path,
1675         (const gchar **) dep->names, dep->flags);
1676     g_free (path);
1677   }
1678
1679   GST_LOG_OBJECT (plugin, "done, scan_hash: %08x", scan_hash);
1680   return scan_hash;
1681 }
1682
1683 gboolean
1684 _priv_plugin_deps_files_changed (GstPlugin * plugin)
1685 {
1686   GList *l;
1687
1688   for (l = plugin->priv->deps; l != NULL; l = l->next) {
1689     GstPluginDep *dep = l->data;
1690
1691     if (dep->stat_hash != gst_plugin_ext_dep_get_stat_hash (plugin, dep))
1692       return TRUE;
1693   }
1694
1695   return FALSE;
1696 }
1697
1698 static void
1699 gst_plugin_ext_dep_free (GstPluginDep * dep)
1700 {
1701   g_strfreev (dep->env_vars);
1702   g_strfreev (dep->paths);
1703   g_strfreev (dep->names);
1704   g_slice_free (GstPluginDep, dep);
1705 }
1706
1707 static gboolean
1708 gst_plugin_ext_dep_strv_equal (gchar ** arr1, gchar ** arr2)
1709 {
1710   if (arr1 == arr2)
1711     return TRUE;
1712   if (arr1 == NULL || arr2 == NULL)
1713     return FALSE;
1714   for (; *arr1 != NULL && *arr2 != NULL; ++arr1, ++arr2) {
1715     if (strcmp (*arr1, *arr2) != 0)
1716       return FALSE;
1717   }
1718   return (*arr1 == *arr2);
1719 }
1720
1721 static gboolean
1722 gst_plugin_ext_dep_equals (GstPluginDep * dep, const gchar ** env_vars,
1723     const gchar ** paths, const gchar ** names, GstPluginDependencyFlags flags)
1724 {
1725   if (dep->flags != flags)
1726     return FALSE;
1727
1728   return gst_plugin_ext_dep_strv_equal (dep->env_vars, (gchar **) env_vars) &&
1729       gst_plugin_ext_dep_strv_equal (dep->paths, (gchar **) paths) &&
1730       gst_plugin_ext_dep_strv_equal (dep->names, (gchar **) names);
1731 }
1732
1733 /**
1734  * gst_plugin_add_dependency:
1735  * @plugin: a #GstPlugin
1736  * @env_vars: (allow-none): %NULL-terminated array of environment variables affecting the
1737  *     feature set of the plugin (e.g. an environment variable containing
1738  *     paths where to look for additional modules/plugins of a library),
1739  *     or %NULL. Environment variable names may be followed by a path component
1740  *      which will be added to the content of the environment variable, e.g.
1741  *      "HOME/.mystuff/plugins".
1742  * @paths: (allow-none): %NULL-terminated array of directories/paths where dependent files
1743  *     may be, or %NULL.
1744  * @names: (allow-none): %NULL-terminated array of file names (or file name suffixes,
1745  *     depending on @flags) to be used in combination with the paths from
1746  *     @paths and/or the paths extracted from the environment variables in
1747  *     @env_vars, or %NULL.
1748  * @flags: optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE
1749  *
1750  * Make GStreamer aware of external dependencies which affect the feature
1751  * set of this plugin (ie. the elements or typefinders associated with it).
1752  *
1753  * GStreamer will re-inspect plugins with external dependencies whenever any
1754  * of the external dependencies change. This is useful for plugins which wrap
1755  * other plugin systems, e.g. a plugin which wraps a plugin-based visualisation
1756  * library and makes visualisations available as GStreamer elements, or a
1757  * codec loader which exposes elements and/or caps dependent on what external
1758  * codec libraries are currently installed.
1759  */
1760 void
1761 gst_plugin_add_dependency (GstPlugin * plugin, const gchar ** env_vars,
1762     const gchar ** paths, const gchar ** names, GstPluginDependencyFlags flags)
1763 {
1764   GstPluginDep *dep;
1765   GList *l;
1766
1767   g_return_if_fail (GST_IS_PLUGIN (plugin));
1768
1769   if ((env_vars == NULL || env_vars[0] == NULL) &&
1770       (paths == NULL || paths[0] == NULL)) {
1771     GST_DEBUG_OBJECT (plugin,
1772         "plugin registered empty dependency set. Ignoring");
1773     return;
1774   }
1775
1776   for (l = plugin->priv->deps; l != NULL; l = l->next) {
1777     if (gst_plugin_ext_dep_equals (l->data, env_vars, paths, names, flags)) {
1778       GST_LOG_OBJECT (plugin, "dependency already registered");
1779       return;
1780     }
1781   }
1782
1783   dep = g_slice_new (GstPluginDep);
1784
1785   dep->env_vars = g_strdupv ((gchar **) env_vars);
1786   dep->paths = g_strdupv ((gchar **) paths);
1787   dep->names = g_strdupv ((gchar **) names);
1788   dep->flags = flags;
1789
1790   dep->env_hash = gst_plugin_ext_dep_get_env_vars_hash (plugin, dep);
1791   dep->stat_hash = gst_plugin_ext_dep_get_stat_hash (plugin, dep);
1792
1793   plugin->priv->deps = g_list_append (plugin->priv->deps, dep);
1794
1795   GST_DEBUG_OBJECT (plugin, "added dependency:");
1796   for (; env_vars != NULL && *env_vars != NULL; ++env_vars)
1797     GST_DEBUG_OBJECT (plugin, " evar: %s", *env_vars);
1798   for (; paths != NULL && *paths != NULL; ++paths)
1799     GST_DEBUG_OBJECT (plugin, " path: %s", *paths);
1800   for (; names != NULL && *names != NULL; ++names)
1801     GST_DEBUG_OBJECT (plugin, " name: %s", *names);
1802 }
1803
1804 /**
1805  * gst_plugin_add_dependency_simple:
1806  * @plugin: the #GstPlugin
1807  * @env_vars: (allow-none): one or more environment variables (separated by ':', ';' or ','),
1808  *      or %NULL. Environment variable names may be followed by a path component
1809  *      which will be added to the content of the environment variable, e.g.
1810  *      "HOME/.mystuff/plugins:MYSTUFF_PLUGINS_PATH"
1811  * @paths: (allow-none): one ore more directory paths (separated by ':' or ';' or ','),
1812  *      or %NULL. Example: "/usr/lib/mystuff/plugins"
1813  * @names: (allow-none): one or more file names or file name suffixes (separated by commas),
1814  *      or %NULL
1815  * @flags: optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE
1816  *
1817  * Make GStreamer aware of external dependencies which affect the feature
1818  * set of this plugin (ie. the elements or typefinders associated with it).
1819  *
1820  * GStreamer will re-inspect plugins with external dependencies whenever any
1821  * of the external dependencies change. This is useful for plugins which wrap
1822  * other plugin systems, e.g. a plugin which wraps a plugin-based visualisation
1823  * library and makes visualisations available as GStreamer elements, or a
1824  * codec loader which exposes elements and/or caps dependent on what external
1825  * codec libraries are currently installed.
1826  *
1827  * Convenience wrapper function for gst_plugin_add_dependency() which
1828  * takes simple strings as arguments instead of string arrays, with multiple
1829  * arguments separated by predefined delimiters (see above).
1830  */
1831 void
1832 gst_plugin_add_dependency_simple (GstPlugin * plugin,
1833     const gchar * env_vars, const gchar * paths, const gchar * names,
1834     GstPluginDependencyFlags flags)
1835 {
1836   gchar **a_evars = NULL;
1837   gchar **a_paths = NULL;
1838   gchar **a_names = NULL;
1839
1840   if (env_vars)
1841     a_evars = g_strsplit_set (env_vars, ":;,", -1);
1842   if (paths)
1843     a_paths = g_strsplit_set (paths, ":;,", -1);
1844   if (names)
1845     a_names = g_strsplit_set (names, ",", -1);
1846
1847   gst_plugin_add_dependency (plugin, (const gchar **) a_evars,
1848       (const gchar **) a_paths, (const gchar **) a_names, flags);
1849
1850   if (a_evars)
1851     g_strfreev (a_evars);
1852   if (a_paths)
1853     g_strfreev (a_paths);
1854   if (a_names)
1855     g_strfreev (a_names);
1856 }