gst/gstregistry.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2005 David A. Schleef <ds@schleef.org>
   5  *
   6  * gstregistry.c: handle registry
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstregistry
  26  * @short_description: Abstract base class for management of #GstPlugin objects
  27  * @see_also: #GstPlugin, #GstPluginFeature
  28  *
  29  * One registry holds the metadata of a set of plugins.
  30  *
  31  * <emphasis role="bold">Design:</emphasis>
  32  *
  33  * The #GstRegistry object is a list of plugins and some functions for dealing
  34  * with them. Each #GstPlugin is matched 1-1 with a file on disk, and may or may
  35  * not be loaded at a given time. There may be multiple #GstRegistry objects,
  36  * but the "default registry" is the only object that has any meaning to the
  37  * core.
  38  *
  39  * The registry file is actually a cache of plugin information. This is
  40  * unlike versions prior to 0.10, where the registry file was the primary source
  41  * of plugin information, and was created by the gst-register command.
  42  *
  43  * The primary source, at all times, of plugin information is each plugin file
  44  * itself. Thus, if an application wants information about a particular plugin,
  45  * or wants to search for a feature that satisfies given criteria, the primary
  46  * means of doing so is to load every plugin and look at the resulting
  47  * information that is gathered in the default registry. Clearly, this is a time
  48  * consuming process, so we cache information in the registry file. The format
  49  * and location of the cache file is internal to gstreamer.
  50  *
  51  * On startup, plugins are searched for in the plugin search path. The following
  52  * locations are checked in this order:
  53  * <itemizedlist>
  54  *   <listitem>
  55  *     <para>location from --gst-plugin-path commandline option.</para>
  56  *   </listitem>
  57  *   <listitem>
  58  *     <para>the GST_PLUGIN_PATH environment variable.</para>
  59  *   </listitem>
  60  *   <listitem>
  61  *     <para>the GST_PLUGIN_SYSTEM_PATH environment variable.</para>
  62  *   </listitem>
  63  *   <listitem>
  64  *     <para>default locations (if GST_PLUGIN_SYSTEM_PATH is not set). Those
  65  *       default locations are:
  66  *       <filename>~/.gstreamer-$GST_MAJORMINOR/plugins/</filename>
  67  *       and <filename>$prefix/libs/gstreamer-$GST_MAJORMINOR/</filename>.
  68  *     </para>
  69  *   </listitem>
  70  * </itemizedlist>
  71  * The registry cache file is loaded from
  72  * <filename>~/.gstreamer-$GST_MAJORMINOR/registry-$ARCH.bin</filename> or the
  73  * file listed in the GST_REGISTRY env var. One reason to change the registry
  74  * location is for testing.
  75  *
  76  * For each plugin that is found in the plugin search path, there could be 3
  77  * possibilities for cached information:
  78  * <itemizedlist>
  79  *   <listitem>
  80  *     <para>the cache may not contain information about a given file.</para>
  81  *   </listitem>
  82  *   <listitem>
  83  *     <para>the cache may have stale information.</para>
  84  *   </listitem>
  85  *   <listitem>
  86  *     <para>the cache may have current information.</para>
  87  *   </listitem>
  88  * </itemizedlist>
  89  *
  90  * In the first two cases, the plugin is loaded and the cache updated. In
  91  * addition to these cases, the cache may have entries for plugins that are not
  92  * relevant to the current process. These are marked as not available to the
  93  * current process. If the cache is updated for whatever reason, it is marked
  94  * dirty.
  95  *
  96  * A dirty cache is written out at the end of initialization. Each entry is
  97  * checked to make sure the information is minimally valid. If not, the entry is
  98  * simply dropped.
  99  *
 100  * <emphasis role="bold">Implementation notes:</emphasis>
 101  *
 102  * The "cache" and "default registry" are different concepts and can represent
 103  * different sets of plugins. For various reasons, at init time, the cache is
 104  * stored in the default registry, and plugins not relevant to the current
 105  * process are marked with the %GST_PLUGIN_FLAG_CACHED bit. These plugins are
 106  * removed at the end of intitialization.
 107  */
 108
 109 #ifdef HAVE_CONFIG_H
 110 #include "config.h"
 111 #endif
 112 #include "gstconfig.h"
 113 #include "gst_private.h"
 114 #include <glib.h>
 115 #include <sys/types.h>
 116 #include <sys/stat.h>
 117 #ifdef HAVE_UNISTD_H
 118 #include <unistd.h>
 119 #endif
 120 #include <errno.h>
 121 #include <stdio.h>
 122 #include <string.h>
 123
 124 /* For g_stat () */
 125 #include <glib/gstdio.h>
 126
 127 #include "gstinfo.h"
 128 #include "gsterror.h"
 129 #include "gstregistry.h"
 130 #include "gstmarshal.h"
 131 #include "gstfilter.h"
 132
 133 #include "gstpluginloader.h"
 134
 135 #include "gst-i18n-lib.h"
 136
 137 #include "gst.h"
 138 #include "glib-compat-private.h"
 139
 140 #ifdef G_OS_WIN32
 141 #include <windows.h>
 142 extern HMODULE _priv_gst_dll_handle;
 143 #endif
 144
 145 #define GST_CAT_DEFAULT GST_CAT_REGISTRY
 146
 147 struct _GstRegistryPrivate
 148 {
 149   /* updated whenever the feature list changes */
 150   guint32 cookie;
 151   /* speedup for searching features */
 152   GList *element_factory_list;
 153   guint32 efl_cookie;
 154   GList *typefind_factory_list;
 155   guint32 tfl_cookie;
 156 };
 157
 158 /* the one instance of the default registry and the mutex protecting the
 159  * variable. */
 160 static GStaticMutex _gst_registry_mutex = G_STATIC_MUTEX_INIT;
 161 static GstRegistry *_gst_registry_default = NULL;
 162
 163 /* defaults */
 164 #define DEFAULT_FORK TRUE
 165
 166 /* control the behaviour of registry rebuild */
 167 static gboolean _gst_enable_registry_fork = DEFAULT_FORK;
 168 /* List of plugins that need preloading/reloading after scanning registry */
 169 extern GSList *_priv_gst_preload_plugins;
 170
 171 #ifndef GST_DISABLE_REGISTRY
 172 /*set to TRUE when registry needn't to be updated */
 173 gboolean _priv_gst_disable_registry_update = FALSE;
 174 extern GList *_priv_gst_plugin_paths;
 175
 176 /* Set to TRUE when the registry cache should be disabled */
 177 gboolean _gst_disable_registry_cache = FALSE;
 178 #endif
 179
 180 /* Element signals and args */
 181 enum
 182 {
 183   PLUGIN_ADDED,
 184   FEATURE_ADDED,
 185   LAST_SIGNAL
 186 };
 187
 188 static void gst_registry_finalize (GObject * object);
 189
 190 static guint gst_registry_signals[LAST_SIGNAL] = { 0 };
 191
 192 static GstPluginFeature *gst_registry_lookup_feature_locked (GstRegistry *
 193     registry, const char *name);
 194 static GstPlugin *gst_registry_lookup_bn_locked (GstRegistry * registry,
 195     const char *basename);
 196
 197 G_DEFINE_TYPE (GstRegistry, gst_registry, GST_TYPE_OBJECT);
 198 static GstObjectClass *parent_class = NULL;
 199
 200 static void
 201 gst_registry_class_init (GstRegistryClass * klass)
 202 {
 203   GObjectClass *gobject_class;
 204
 205   gobject_class = (GObjectClass *) klass;
 206
 207   parent_class = g_type_class_peek_parent (klass);
 208   g_type_class_add_private (klass, sizeof (GstRegistryPrivate));
 209
 210   /**
 211    * GstRegistry::plugin-added:
 212    * @registry: the registry that emitted the signal
 213    * @plugin: the plugin that has been added
 214    *
 215    * Signals that a plugin has been added to the registry (possibly
 216    * replacing a previously-added one by the same name)
 217    */
 218   gst_registry_signals[PLUGIN_ADDED] =
 219       g_signal_new ("plugin-added", G_TYPE_FROM_CLASS (klass),
 220       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRegistryClass, plugin_added), NULL,
 221       NULL, gst_marshal_VOID__POINTER, G_TYPE_NONE, 1, G_TYPE_POINTER);
 222
 223   /**
 224    * GstRegistry::feature-added:
 225    * @registry: the registry that emitted the signal
 226    * @feature: the feature that has been added
 227    *
 228    * Signals that a feature has been added to the registry (possibly
 229    * replacing a previously-added one by the same name)
 230    */
 231   gst_registry_signals[FEATURE_ADDED] =
 232       g_signal_new ("feature-added", G_TYPE_FROM_CLASS (klass),
 233       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRegistryClass, feature_added),
 234       NULL, NULL, gst_marshal_VOID__POINTER, G_TYPE_NONE, 1, G_TYPE_POINTER);
 235
 236   gobject_class->finalize = gst_registry_finalize;
 237 }
 238
 239 static void
 240 gst_registry_init (GstRegistry * registry)
 241 {
 242   registry->feature_hash = g_hash_table_new (g_str_hash, g_str_equal);
 243   registry->basename_hash = g_hash_table_new (g_str_hash, g_str_equal);
 244   registry->priv =
 245       G_TYPE_INSTANCE_GET_PRIVATE (registry, GST_TYPE_REGISTRY,
 246       GstRegistryPrivate);
 247 }
 248
 249 static void
 250 gst_registry_finalize (GObject * object)
 251 {
 252   GstRegistry *registry = GST_REGISTRY (object);
 253   GList *plugins, *p;
 254   GList *features, *f;
 255
 256   plugins = registry->plugins;
 257   registry->plugins = NULL;
 258
 259   GST_DEBUG_OBJECT (registry, "registry finalize");
 260   p = plugins;
 261   while (p) {
 262     GstPlugin *plugin = p->data;
 263
 264     if (plugin) {
 265       GST_LOG_OBJECT (registry, "removing plugin %s",
 266           gst_plugin_get_name (plugin));
 267       gst_object_unref (plugin);
 268     }
 269     p = g_list_next (p);
 270   }
 271   g_list_free (plugins);
 272
 273   features = registry->features;
 274   registry->features = NULL;
 275
 276   f = features;
 277   while (f) {
 278     GstPluginFeature *feature = f->data;
 279
 280     if (feature) {
 281       GST_LOG_OBJECT (registry, "removing feature %p (%s)",
 282           feature, gst_plugin_feature_get_name (feature));
 283       gst_object_unref (feature);
 284     }
 285     f = g_list_next (f);
 286   }
 287   g_list_free (features);
 288
 289   g_hash_table_destroy (registry->feature_hash);
 290   registry->feature_hash = NULL;
 291   g_hash_table_destroy (registry->basename_hash);
 292   registry->basename_hash = NULL;
 293
 294   if (registry->priv->element_factory_list) {
 295     GST_DEBUG_OBJECT (registry, "Cleaning up cached element factory list");
 296     gst_plugin_feature_list_free (registry->priv->element_factory_list);
 297   }
 298
 299   if (registry->priv->typefind_factory_list) {
 300     GST_DEBUG_OBJECT (registry, "Cleaning up cached typefind factory list");
 301     gst_plugin_feature_list_free (registry->priv->typefind_factory_list);
 302   }
 303
 304   G_OBJECT_CLASS (parent_class)->finalize (object);
 305 }
 306
 307 /**
 308  * gst_registry_get_default:
 309  *
 310  * Retrieves the default registry. The caller does not own a reference on the
 311  * registry, as it is alive as long as GStreamer is initialized.
 312  *
 313  * Returns: (transfer none): The default #GstRegistry.
 314  */
 315 GstRegistry *
 316 gst_registry_get_default (void)
 317 {
 318   GstRegistry *registry;
 319
 320   g_static_mutex_lock (&_gst_registry_mutex);
 321   if (G_UNLIKELY (!_gst_registry_default)) {
 322     _gst_registry_default = g_object_newv (GST_TYPE_REGISTRY, 0, NULL);
 323     gst_object_ref_sink (GST_OBJECT_CAST (_gst_registry_default));
 324   }
 325   registry = _gst_registry_default;
 326   g_static_mutex_unlock (&_gst_registry_mutex);
 327
 328   return registry;
 329 }
 330
 331 /**
 332  * gst_registry_add_path:
 333  * @registry: the registry to add the path to
 334  * @path: the path to add to the registry
 335  *
 336  * Add the given path to the registry. The syntax of the
 337  * path is specific to the registry. If the path has already been
 338  * added, do nothing.
 339  */
 340 void
 341 gst_registry_add_path (GstRegistry * registry, const gchar * path)
 342 {
 343   g_return_if_fail (GST_IS_REGISTRY (registry));
 344   g_return_if_fail (path != NULL);
 345
 346   if (strlen (path) == 0)
 347     goto empty_path;
 348
 349   GST_OBJECT_LOCK (registry);
 350   if (g_list_find_custom (registry->paths, path, (GCompareFunc) strcmp))
 351     goto was_added;
 352
 353   GST_INFO ("Adding plugin path: \"%s\"", path);
 354   registry->paths = g_list_append (registry->paths, g_strdup (path));
 355   GST_OBJECT_UNLOCK (registry);
 356
 357   return;
 358
 359 empty_path:
 360   {
 361     GST_INFO ("Ignoring empty plugin path");
 362     return;
 363   }
 364 was_added:
 365   {
 366     g_warning ("path %s already added to registry", path);
 367     GST_OBJECT_UNLOCK (registry);
 368     return;
 369   }
 370 }
 371
 372 /**
 373  * gst_registry_get_path_list:
 374  * @registry: the registry to get the pathlist of
 375  *
 376  * Get the list of paths for the given registry.
 377  *
 378  * Returns: (transfer container) (element-type char*): A #GList of paths as
 379  *     strings. g_list_free after use.
 380  *
 381  * MT safe.
 382  */
 383 GList *
 384 gst_registry_get_path_list (GstRegistry * registry)
 385 {
 386   GList *list;
 387
 388   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 389
 390   GST_OBJECT_LOCK (registry);
 391   /* We don't need to copy the strings, because they won't be deleted
 392    * as long as the GstRegistry is around */
 393   list = g_list_copy (registry->paths);
 394   GST_OBJECT_UNLOCK (registry);
 395
 396   return list;
 397 }
 398
 399
 400 /**
 401  * gst_registry_add_plugin:
 402  * @registry: the registry to add the plugin to
 403  * @plugin: (transfer full): the plugin to add
 404  *
 405  * Add the plugin to the registry. The plugin-added signal will be emitted.
 406  * This function will sink @plugin.
 407  *
 408  * Returns: TRUE on success.
 409  *
 410  * MT safe.
 411  */
 412 gboolean
 413 gst_registry_add_plugin (GstRegistry * registry, GstPlugin * plugin)
 414 {
 415   GstPlugin *existing_plugin;
 416
 417   g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
 418   g_return_val_if_fail (GST_IS_PLUGIN (plugin), FALSE);
 419
 420   GST_OBJECT_LOCK (registry);
 421   if (G_LIKELY (plugin->basename)) {
 422     /* we have a basename, see if we find the plugin */
 423     existing_plugin =
 424         gst_registry_lookup_bn_locked (registry, plugin->basename);
 425     if (existing_plugin) {
 426       GST_DEBUG_OBJECT (registry,
 427           "Replacing existing plugin \"%s\" %p with new plugin %p for filename \"%s\"",
 428           GST_STR_NULL (existing_plugin->filename), existing_plugin, plugin,
 429           GST_STR_NULL (plugin->filename));
 430       /* If the new plugin is blacklisted and the existing one isn't cached, do not
 431        * accept if it's from a different location than the existing one */
 432       if ((plugin->flags & GST_PLUGIN_FLAG_BLACKLISTED) &&
 433           strcmp (plugin->filename, existing_plugin->filename)) {
 434         GST_WARNING_OBJECT (registry,
 435             "Not replacing plugin because new one (%s) is blacklisted but for a different location than existing one (%s)",
 436             plugin->filename, existing_plugin->filename);
 437         gst_object_unref (plugin);
 438         GST_OBJECT_UNLOCK (registry);
 439         return FALSE;
 440       }
 441       registry->plugins = g_list_remove (registry->plugins, existing_plugin);
 442       if (G_LIKELY (existing_plugin->basename))
 443         g_hash_table_remove (registry->basename_hash,
 444             existing_plugin->basename);
 445       gst_object_unref (existing_plugin);
 446     }
 447   }
 448
 449   GST_DEBUG_OBJECT (registry, "adding plugin %p for filename \"%s\"",
 450       plugin, GST_STR_NULL (plugin->filename));
 451
 452   registry->plugins = g_list_prepend (registry->plugins, plugin);
 453   if (G_LIKELY (plugin->basename))
 454     g_hash_table_replace (registry->basename_hash, plugin->basename, plugin);
 455
 456   gst_object_ref_sink (plugin);
 457   GST_OBJECT_UNLOCK (registry);
 458
 459   GST_LOG_OBJECT (registry, "emitting plugin-added for filename \"%s\"",
 460       GST_STR_NULL (plugin->filename));
 461   g_signal_emit (registry, gst_registry_signals[PLUGIN_ADDED], 0, plugin);
 462
 463   return TRUE;
 464 }
 465
 466 static void
 467 gst_registry_remove_features_for_plugin_unlocked (GstRegistry * registry,
 468     GstPlugin * plugin)
 469 {
 470   GList *f;
 471
 472   g_return_if_fail (GST_IS_REGISTRY (registry));
 473   g_return_if_fail (GST_IS_PLUGIN (plugin));
 474
 475   /* Remove all features for this plugin */
 476   f = registry->features;
 477   while (f != NULL) {
 478     GList *next = g_list_next (f);
 479     GstPluginFeature *feature = f->data;
 480
 481     if (G_UNLIKELY (feature && feature->plugin == plugin)) {
 482       GST_DEBUG_OBJECT (registry, "removing feature %p (%s) for plugin %p (%s)",
 483           feature, gst_plugin_feature_get_name (feature), plugin,
 484           plugin->desc.name);
 485
 486       registry->features = g_list_delete_link (registry->features, f);
 487       g_hash_table_remove (registry->feature_hash, feature->name);
 488       gst_object_unref (feature);
 489     }
 490     f = next;
 491   }
 492   registry->priv->cookie++;
 493 }
 494
 495 /**
 496  * gst_registry_remove_plugin:
 497  * @registry: the registry to remove the plugin from
 498  * @plugin: (transfer none): the plugin to remove
 499  *
 500  * Remove the plugin from the registry.
 501  *
 502  * MT safe.
 503  */
 504 void
 505 gst_registry_remove_plugin (GstRegistry * registry, GstPlugin * plugin)
 506 {
 507   g_return_if_fail (GST_IS_REGISTRY (registry));
 508   g_return_if_fail (GST_IS_PLUGIN (plugin));
 509
 510   GST_DEBUG_OBJECT (registry, "removing plugin %p (%s)",
 511       plugin, gst_plugin_get_name (plugin));
 512
 513   GST_OBJECT_LOCK (registry);
 514   registry->plugins = g_list_remove (registry->plugins, plugin);
 515   if (G_LIKELY (plugin->basename))
 516     g_hash_table_remove (registry->basename_hash, plugin->basename);
 517   gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
 518   GST_OBJECT_UNLOCK (registry);
 519   gst_object_unref (plugin);
 520 }
 521
 522 /**
 523  * gst_registry_add_feature:
 524  * @registry: the registry to add the plugin to
 525  * @feature: (transfer full): the feature to add
 526  *
 527  * Add the feature to the registry. The feature-added signal will be emitted.
 528  * This function sinks @feature.
 529  *
 530  * Returns: TRUE on success.
 531  *
 532  * MT safe.
 533  */
 534 gboolean
 535 gst_registry_add_feature (GstRegistry * registry, GstPluginFeature * feature)
 536 {
 537   GstPluginFeature *existing_feature;
 538
 539   g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
 540   g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
 541   g_return_val_if_fail (feature->name != NULL, FALSE);
 542   g_return_val_if_fail (feature->plugin_name != NULL, FALSE);
 543
 544   GST_OBJECT_LOCK (registry);
 545   existing_feature = gst_registry_lookup_feature_locked (registry,
 546       feature->name);
 547   if (G_UNLIKELY (existing_feature)) {
 548     GST_DEBUG_OBJECT (registry, "replacing existing feature %p (%s)",
 549         existing_feature, feature->name);
 550     /* Remove the existing feature from the list now, before we insert the new
 551      * one, but don't unref yet because the hash is still storing a reference to
 552      * it. */
 553     registry->features = g_list_remove (registry->features, existing_feature);
 554   }
 555
 556   GST_DEBUG_OBJECT (registry, "adding feature %p (%s)", feature, feature->name);
 557
 558   registry->features = g_list_prepend (registry->features, feature);
 559   g_hash_table_replace (registry->feature_hash, feature->name, feature);
 560
 561   if (G_UNLIKELY (existing_feature)) {
 562     /* We unref now. No need to remove the feature name from the hash table, it
 563      * got replaced by the new feature */
 564     gst_object_unref (existing_feature);
 565   }
 566
 567   gst_object_ref_sink (feature);
 568
 569   registry->priv->cookie++;
 570   GST_OBJECT_UNLOCK (registry);
 571
 572   GST_LOG_OBJECT (registry, "emitting feature-added for %s", feature->name);
 573   g_signal_emit (registry, gst_registry_signals[FEATURE_ADDED], 0, feature);
 574
 575   return TRUE;
 576 }
 577
 578 /**
 579  * gst_registry_remove_feature:
 580  * @registry: the registry to remove the feature from
 581  * @feature: (transfer none): the feature to remove
 582  *
 583  * Remove the feature from the registry.
 584  *
 585  * MT safe.
 586  */
 587 void
 588 gst_registry_remove_feature (GstRegistry * registry, GstPluginFeature * feature)
 589 {
 590   g_return_if_fail (GST_IS_REGISTRY (registry));
 591   g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
 592
 593   GST_DEBUG_OBJECT (registry, "removing feature %p (%s)",
 594       feature, gst_plugin_feature_get_name (feature));
 595
 596   GST_OBJECT_LOCK (registry);
 597   registry->features = g_list_remove (registry->features, feature);
 598   g_hash_table_remove (registry->feature_hash, feature->name);
 599   registry->priv->cookie++;
 600   GST_OBJECT_UNLOCK (registry);
 601   gst_object_unref (feature);
 602 }
 603
 604 /**
 605  * gst_registry_plugin_filter:
 606  * @registry: registry to query
 607  * @filter: (scope call): the filter to use
 608  * @first: only return first match
 609  * @user_data: (closure): user data passed to the filter function
 610  *
 611  * Runs a filter against all plugins in the registry and returns a #GList with
 612  * the results. If the first flag is set, only the first match is
 613  * returned (as a list with a single object).
 614  * Every plugin is reffed; use gst_plugin_list_free() after use, which
 615  * will unref again.
 616  *
 617  * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
 618  *     Use gst_plugin_list_free() after usage.
 619  *
 620  * MT safe.
 621  */
 622 GList *
 623 gst_registry_plugin_filter (GstRegistry * registry,
 624     GstPluginFilter filter, gboolean first, gpointer user_data)
 625 {
 626   GList *list;
 627   GList *g;
 628
 629   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 630
 631   GST_OBJECT_LOCK (registry);
 632   list = gst_filter_run (registry->plugins, (GstFilterFunc) filter, first,
 633       user_data);
 634   for (g = list; g; g = g->next) {
 635     gst_object_ref (GST_PLUGIN_CAST (g->data));
 636   }
 637   GST_OBJECT_UNLOCK (registry);
 638
 639   return list;
 640 }
 641
 642 /* returns TRUE if the list was changed
 643  *
 644  * Must be called with the object lock taken */
 645 static gboolean
 646 gst_registry_get_feature_list_or_create (GstRegistry * registry,
 647     GList ** previous, guint32 * cookie, GType type)
 648 {
 649   gboolean res = FALSE;
 650   GstRegistryPrivate *priv = registry->priv;
 651
 652   if (G_UNLIKELY (!*previous || priv->cookie != *cookie)) {
 653     GstTypeNameData data;
 654
 655     if (*previous)
 656       gst_plugin_feature_list_free (*previous);
 657
 658     data.type = type;
 659     data.name = NULL;
 660     *previous =
 661         gst_filter_run (registry->features,
 662         (GstFilterFunc) gst_plugin_feature_type_name_filter, FALSE, &data);
 663     g_list_foreach (*previous, (GFunc) gst_object_ref, NULL);
 664     *cookie = priv->cookie;
 665     res = TRUE;
 666   }
 667
 668   return res;
 669 }
 670
 671 static gint
 672 type_find_factory_rank_cmp (const GstPluginFeature * fac1,
 673     const GstPluginFeature * fac2)
 674 {
 675   if (G_LIKELY (fac1->rank != fac2->rank))
 676     return fac2->rank - fac1->rank;
 677
 678   /* to make the order in which things happen more deterministic,
 679    * sort by name when the ranks are the same. */
 680   return strcmp (fac1->name, fac2->name);
 681 }
 682
 683 static GList *
 684 gst_registry_get_element_factory_list (GstRegistry * registry)
 685 {
 686   GList *list;
 687
 688   GST_OBJECT_LOCK (registry);
 689
 690   gst_registry_get_feature_list_or_create (registry,
 691       &registry->priv->element_factory_list, &registry->priv->efl_cookie,
 692       GST_TYPE_ELEMENT_FACTORY);
 693
 694   /* Return reffed copy */
 695   list = gst_plugin_feature_list_copy (registry->priv->element_factory_list);
 696
 697   GST_OBJECT_UNLOCK (registry);
 698
 699   return list;
 700 }
 701
 702 static GList *
 703 gst_registry_get_typefind_factory_list (GstRegistry * registry)
 704 {
 705   GList *list;
 706
 707   GST_OBJECT_LOCK (registry);
 708
 709   if (G_UNLIKELY (gst_registry_get_feature_list_or_create (registry,
 710               &registry->priv->typefind_factory_list,
 711               &registry->priv->tfl_cookie, GST_TYPE_TYPE_FIND_FACTORY)))
 712     registry->priv->typefind_factory_list =
 713         g_list_sort (registry->priv->typefind_factory_list,
 714         (GCompareFunc) type_find_factory_rank_cmp);
 715
 716   /* Return reffed copy */
 717   list = gst_plugin_feature_list_copy (registry->priv->typefind_factory_list);
 718
 719   GST_OBJECT_UNLOCK (registry);
 720
 721   return list;
 722 }
 723
 724 /**
 725  * gst_registry_feature_filter:
 726  * @registry: registry to query
 727  * @filter: (scope call): the filter to use
 728  * @first: only return first match
 729  * @user_data: (closure): user data passed to the filter function
 730  *
 731  * Runs a filter against all features of the plugins in the registry
 732  * and returns a GList with the results.
 733  * If the first flag is set, only the first match is
 734  * returned (as a list with a single object).
 735  *
 736  * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
 737  *     #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
 738  *
 739  * MT safe.
 740  */
 741 GList *
 742 gst_registry_feature_filter (GstRegistry * registry,
 743     GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
 744 {
 745   GList *list;
 746   GList *g;
 747
 748   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 749
 750   GST_OBJECT_LOCK (registry);
 751   list = gst_filter_run (registry->features, (GstFilterFunc) filter, first,
 752       user_data);
 753   for (g = list; g; g = g->next) {
 754     gst_object_ref (GST_PLUGIN_FEATURE_CAST (g->data));
 755   }
 756   GST_OBJECT_UNLOCK (registry);
 757
 758   return list;
 759 }
 760
 761 /**
 762  * gst_registry_find_plugin:
 763  * @registry: the registry to search
 764  * @name: the plugin name to find
 765  *
 766  * Find the plugin with the given name in the registry.
 767  * The plugin will be reffed; caller is responsible for unreffing.
 768  *
 769  * Returns: (transfer full): the plugin with the given name or NULL if the
 770  *     plugin was not found. gst_object_unref() after usage.
 771  *
 772  * MT safe.
 773  */
 774 GstPlugin *
 775 gst_registry_find_plugin (GstRegistry * registry, const gchar * name)
 776 {
 777   GList *walk;
 778   GstPlugin *result = NULL;
 779
 780   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 781   g_return_val_if_fail (name != NULL, NULL);
 782
 783   walk = gst_registry_plugin_filter (registry,
 784       (GstPluginFilter) gst_plugin_name_filter, TRUE, (gpointer) name);
 785   if (walk) {
 786     result = GST_PLUGIN_CAST (walk->data);
 787
 788     gst_object_ref (result);
 789     gst_plugin_list_free (walk);
 790   }
 791
 792   return result;
 793 }
 794
 795 /**
 796  * gst_registry_find_feature:
 797  * @registry: the registry to search
 798  * @name: the pluginfeature name to find
 799  * @type: the pluginfeature type to find
 800  *
 801  * Find the pluginfeature with the given name and type in the registry.
 802  *
 803  * Returns: (transfer full): the pluginfeature with the given name and type
 804  *     or NULL if the plugin was not found. gst_object_unref() after usage.
 805  *
 806  * MT safe.
 807  */
 808 GstPluginFeature *
 809 gst_registry_find_feature (GstRegistry * registry, const gchar * name,
 810     GType type)
 811 {
 812   GstPluginFeature *feature = NULL;
 813
 814   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 815   g_return_val_if_fail (name != NULL, NULL);
 816   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
 817
 818   feature = gst_registry_lookup_feature (registry, name);
 819   if (feature && !g_type_is_a (G_TYPE_FROM_INSTANCE (feature), type)) {
 820     gst_object_unref (feature);
 821     feature = NULL;
 822   }
 823
 824   return feature;
 825 }
 826
 827 /**
 828  * gst_registry_get_feature_list:
 829  * @registry: a #GstRegistry
 830  * @type: a #GType.
 831  *
 832  * Retrieves a #GList of #GstPluginFeature of @type.
 833  *
 834  * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
 835  *     #GstPluginFeature of @type. Use gst_plugin_feature_list_free() after use
 836  *
 837  * MT safe.
 838  */
 839 GList *
 840 gst_registry_get_feature_list (GstRegistry * registry, GType type)
 841 {
 842   GstTypeNameData data;
 843
 844   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 845   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
 846
 847   /* Speed up */
 848   if (type == GST_TYPE_ELEMENT_FACTORY)
 849     return gst_registry_get_element_factory_list (registry);
 850   else if (type == GST_TYPE_TYPE_FIND_FACTORY)
 851     return gst_registry_get_typefind_factory_list (registry);
 852
 853   data.type = type;
 854   data.name = NULL;
 855
 856   return gst_registry_feature_filter (registry,
 857       (GstPluginFeatureFilter) gst_plugin_feature_type_name_filter,
 858       FALSE, &data);
 859 }
 860
 861 /**
 862  * gst_registry_get_plugin_list:
 863  * @registry: the registry to search
 864  *
 865  * Get a copy of all plugins registered in the given registry. The refcount
 866  * of each element in the list in incremented.
 867  *
 868  * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
 869  *     Use gst_plugin_list_free() after usage.
 870  *
 871  * MT safe.
 872  */
 873 GList *
 874 gst_registry_get_plugin_list (GstRegistry * registry)
 875 {
 876   GList *list;
 877   GList *g;
 878
 879   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 880
 881   GST_OBJECT_LOCK (registry);
 882   list = g_list_copy (registry->plugins);
 883   for (g = list; g; g = g->next) {
 884     gst_object_ref (GST_PLUGIN_CAST (g->data));
 885   }
 886   GST_OBJECT_UNLOCK (registry);
 887
 888   return list;
 889 }
 890
 891 static GstPluginFeature *
 892 gst_registry_lookup_feature_locked (GstRegistry * registry, const char *name)
 893 {
 894   return g_hash_table_lookup (registry->feature_hash, name);
 895 }
 896
 897 /**
 898  * gst_registry_lookup_feature:
 899  * @registry: a #GstRegistry
 900  * @name: a #GstPluginFeature name
 901  *
 902  * Find a #GstPluginFeature with @name in @registry.
 903  *
 904  * Returns: (transfer full): a #GstPluginFeature with its refcount incremented,
 905  *     use gst_object_unref() after usage.
 906  *
 907  * MT safe.
 908  */
 909 GstPluginFeature *
 910 gst_registry_lookup_feature (GstRegistry * registry, const char *name)
 911 {
 912   GstPluginFeature *feature;
 913
 914   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 915   g_return_val_if_fail (name != NULL, NULL);
 916
 917   GST_OBJECT_LOCK (registry);
 918   feature = gst_registry_lookup_feature_locked (registry, name);
 919   if (feature)
 920     gst_object_ref (feature);
 921   GST_OBJECT_UNLOCK (registry);
 922
 923   return feature;
 924 }
 925
 926 static GstPlugin *
 927 gst_registry_lookup_bn_locked (GstRegistry * registry, const char *basename)
 928 {
 929   return g_hash_table_lookup (registry->basename_hash, basename);
 930 }
 931
 932 static GstPlugin *
 933 gst_registry_lookup_bn (GstRegistry * registry, const char *basename)
 934 {
 935   GstPlugin *plugin;
 936
 937   GST_OBJECT_LOCK (registry);
 938   plugin = gst_registry_lookup_bn_locked (registry, basename);
 939   if (plugin)
 940     gst_object_ref (plugin);
 941   GST_OBJECT_UNLOCK (registry);
 942
 943   return plugin;
 944 }
 945
 946 /**
 947  * gst_registry_lookup:
 948  * @registry: the registry to look up in
 949  * @filename: the name of the file to look up
 950  *
 951  * Look up a plugin in the given registry with the given filename.
 952  * If found, plugin is reffed.
 953  *
 954  * Returns: (transfer full): the #GstPlugin if found, or NULL if not.
 955  *     gst_object_unref() after usage.
 956  */
 957 GstPlugin *
 958 gst_registry_lookup (GstRegistry * registry, const char *filename)
 959 {
 960   GstPlugin *plugin;
 961   gchar *basename;
 962
 963   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 964   g_return_val_if_fail (filename != NULL, NULL);
 965
 966   basename = g_path_get_basename (filename);
 967   if (G_UNLIKELY (basename == NULL))
 968     return NULL;
 969
 970   plugin = gst_registry_lookup_bn (registry, basename);
 971
 972   g_free (basename);
 973
 974   return plugin;
 975 }
 976
 977 typedef enum
 978 {
 979   REGISTRY_SCAN_HELPER_NOT_STARTED = 0,
 980   REGISTRY_SCAN_HELPER_DISABLED,
 981   REGISTRY_SCAN_HELPER_RUNNING
 982 } GstRegistryScanHelperState;
 983
 984 typedef struct
 985 {
 986   GstRegistry *registry;
 987   GstRegistryScanHelperState helper_state;
 988   GstPluginLoader *helper;
 989   gboolean changed;
 990 } GstRegistryScanContext;
 991
 992 static void
 993 init_scan_context (GstRegistryScanContext * context, GstRegistry * registry)
 994 {
 995   gboolean do_fork;
 996
 997   context->registry = registry;
 998
 999   /* see if forking is enabled and set up the scan helper state accordingly */
1000   do_fork = _gst_enable_registry_fork;
1001   if (do_fork) {
1002     const gchar *fork_env;
1003
1004     /* forking enabled, see if it is disabled with an env var */
1005     if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) {
1006       /* fork enabled for any value different from "no" */
1007       do_fork = strcmp (fork_env, "no") != 0;
1008     }
1009   }
1010
1011   if (do_fork)
1012     context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1013   else
1014     context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1015
1016   context->helper = NULL;
1017   context->changed = FALSE;
1018 }
1019
1020 static void
1021 clear_scan_context (GstRegistryScanContext * context)
1022 {
1023   if (context->helper) {
1024     context->changed |= _priv_gst_plugin_loader_funcs.destroy (context->helper);
1025     context->helper = NULL;
1026   }
1027 }
1028
1029 static gboolean
1030 gst_registry_scan_plugin_file (GstRegistryScanContext * context,
1031     const gchar * filename, off_t file_size, time_t file_mtime)
1032 {
1033   gboolean changed = FALSE;
1034   GstPlugin *newplugin = NULL;
1035
1036 #ifdef G_OS_WIN32
1037   /* Disable external plugin loader on Windows until it is ported properly. */
1038   context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1039 #endif
1040
1041
1042   /* Have a plugin to load - see if the scan-helper needs starting */
1043   if (context->helper_state == REGISTRY_SCAN_HELPER_NOT_STARTED) {
1044     GST_DEBUG ("Starting plugin scanner for file %s", filename);
1045     context->helper = _priv_gst_plugin_loader_funcs.create (context->registry);
1046     if (context->helper != NULL)
1047       context->helper_state = REGISTRY_SCAN_HELPER_RUNNING;
1048     else {
1049       GST_WARNING ("Failed starting plugin scanner. Scanning in-process");
1050       context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1051     }
1052   }
1053
1054   if (context->helper_state == REGISTRY_SCAN_HELPER_RUNNING) {
1055     GST_DEBUG ("Using scan-helper to load plugin %s", filename);
1056     if (!_priv_gst_plugin_loader_funcs.load (context->helper,
1057             filename, file_size, file_mtime)) {
1058       g_warning ("External plugin loader failed. This most likely means that "
1059           "the plugin loader helper binary was not found or could not be run. "
1060           "%s", (g_getenv ("GST_PLUGIN_PATH") != NULL) ?
1061           "If you are running an uninstalled GStreamer setup, you might need "
1062           "to update your gst-uninstalled script so that the "
1063           "GST_PLUGIN_SCANNER environment variable gets set." : "");
1064       context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1065     }
1066   }
1067
1068   /* Check if the helper is disabled (or just got disabled above) */
1069   if (context->helper_state == REGISTRY_SCAN_HELPER_DISABLED) {
1070     /* Load plugin the old fashioned way... */
1071
1072     /* We don't use a GError here because a failure to load some shared
1073      * objects as plugins is normal (particularly in the uninstalled case)
1074      */
1075     newplugin = gst_plugin_load_file (filename, NULL);
1076   }
1077
1078   if (newplugin) {
1079     GST_DEBUG_OBJECT (context->registry, "marking new plugin %p as registered",
1080         newplugin);
1081     newplugin->registered = TRUE;
1082     gst_object_unref (newplugin);
1083     changed = TRUE;
1084   }
1085
1086   return changed;
1087 }
1088
1089 static gboolean
1090 is_blacklisted_hidden_directory (const gchar * dirent)
1091 {
1092   if (G_LIKELY (dirent[0] != '.'))
1093     return FALSE;
1094
1095   /* skip the .debug directory, these contain elf files that are not
1096    * useful or worse, can crash dlopen () */
1097   if (strcmp (dirent, ".debug") == 0)
1098     return TRUE;
1099
1100   /* can also skip .git and .deps dirs, those won't contain useful files.
1101    * This speeds up scanning a bit in uninstalled setups. */
1102   if (strcmp (dirent, ".git") == 0 || strcmp (dirent, ".deps") == 0)
1103     return TRUE;
1104
1105   return FALSE;
1106 }
1107
1108 static gboolean
1109 gst_registry_scan_path_level (GstRegistryScanContext * context,
1110     const gchar * path, int level)
1111 {
1112   GDir *dir;
1113   const gchar *dirent;
1114   gchar *filename;
1115   GstPlugin *plugin;
1116   gboolean changed = FALSE;
1117
1118   dir = g_dir_open (path, 0, NULL);
1119   if (!dir)
1120     return FALSE;
1121
1122   while ((dirent = g_dir_read_name (dir))) {
1123     GStatBuf file_status;
1124
1125     filename = g_build_filename (path, dirent, NULL);
1126     if (g_stat (filename, &file_status) < 0) {
1127       /* Plugin will be removed from cache after the scan completes if it
1128        * is still marked 'cached' */
1129       g_free (filename);
1130       continue;
1131     }
1132
1133     if (file_status.st_mode & S_IFDIR) {
1134       if (G_UNLIKELY (is_blacklisted_hidden_directory (dirent))) {
1135         GST_TRACE_OBJECT (context->registry, "ignoring %s directory", dirent);
1136         g_free (filename);
1137         continue;
1138       }
1139       /* FIXME 0.11: Don't recurse into directories, this behaviour
1140        * is inconsistent with other PATH environment variables
1141        */
1142       if (level > 0) {
1143         GST_LOG_OBJECT (context->registry, "recursing into directory %s",
1144             filename);
1145         changed |= gst_registry_scan_path_level (context, filename, level - 1);
1146       } else {
1147         GST_LOG_OBJECT (context->registry, "not recursing into directory %s, "
1148             "recursion level too deep", filename);
1149       }
1150       g_free (filename);
1151       continue;
1152     }
1153     if (!(file_status.st_mode & S_IFREG)) {
1154       GST_TRACE_OBJECT (context->registry, "%s is not a regular file, ignoring",
1155           filename);
1156       g_free (filename);
1157       continue;
1158     }
1159     if (!g_str_has_suffix (dirent, G_MODULE_SUFFIX)
1160 #ifdef GST_EXTRA_MODULE_SUFFIX
1161         && !g_str_has_suffix (dirent, GST_EXTRA_MODULE_SUFFIX)
1162 #endif
1163         ) {
1164       GST_TRACE_OBJECT (context->registry,
1165           "extension is not recognized as module file, ignoring file %s",
1166           filename);
1167       g_free (filename);
1168       continue;
1169     }
1170
1171     GST_LOG_OBJECT (context->registry, "file %s looks like a possible module",
1172         filename);
1173
1174     /* try to avoid unnecessary plugin-move pain */
1175     if (g_str_has_prefix (dirent, "libgstvalve") ||
1176         g_str_has_prefix (dirent, "libgstselector")) {
1177       GST_WARNING_OBJECT (context->registry, "ignoring old plugin %s which "
1178           "has been merged into the corelements plugin", filename);
1179       /* Plugin will be removed from cache after the scan completes if it
1180        * is still marked 'cached' */
1181       g_free (filename);
1182       continue;
1183     }
1184
1185     /* plug-ins are considered unique by basename; if the given name
1186      * was already seen by the registry, we ignore it */
1187     plugin = gst_registry_lookup_bn (context->registry, dirent);
1188     if (plugin) {
1189       gboolean env_vars_changed, deps_changed = FALSE;
1190
1191       if (plugin->registered) {
1192         GST_DEBUG_OBJECT (context->registry,
1193             "plugin already registered from path \"%s\"",
1194             GST_STR_NULL (plugin->filename));
1195         g_free (filename);
1196         gst_object_unref (plugin);
1197         continue;
1198       }
1199
1200       env_vars_changed = _priv_plugin_deps_env_vars_changed (plugin);
1201
1202       /* If a file with a certain basename is seen on a different path,
1203        * update the plugin to ensure the registry cache will reflect up
1204        * to date information */
1205
1206       if (plugin->file_mtime == file_status.st_mtime &&
1207           plugin->file_size == file_status.st_size && !env_vars_changed &&
1208           !(deps_changed = _priv_plugin_deps_files_changed (plugin)) &&
1209           !strcmp (plugin->filename, filename)) {
1210         GST_LOG_OBJECT (context->registry, "file %s cached", filename);
1211         plugin->flags &= ~GST_PLUGIN_FLAG_CACHED;
1212         GST_LOG_OBJECT (context->registry,
1213             "marking plugin %p as registered as %s", plugin, filename);
1214         plugin->registered = TRUE;
1215       } else {
1216         GST_INFO_OBJECT (context->registry, "cached info for %s is stale",
1217             filename);
1218         GST_DEBUG_OBJECT (context->registry, "mtime %ld != %ld or size %"
1219             G_GINT64_FORMAT " != %" G_GINT64_FORMAT " or external dependency "
1220             "env_vars changed: %d or external dependencies changed: %d"
1221             " or old path %s != new path %s",
1222             plugin->file_mtime, file_status.st_mtime,
1223             (gint64) plugin->file_size, (gint64) file_status.st_size,
1224             env_vars_changed, deps_changed, plugin->filename, filename);
1225         gst_registry_remove_plugin (context->registry, plugin);
1226         changed |= gst_registry_scan_plugin_file (context, filename,
1227             file_status.st_size, file_status.st_mtime);
1228       }
1229       gst_object_unref (plugin);
1230
1231     } else {
1232       GST_DEBUG_OBJECT (context->registry, "file %s not yet in registry",
1233           filename);
1234       changed |= gst_registry_scan_plugin_file (context, filename,
1235           file_status.st_size, file_status.st_mtime);
1236     }
1237
1238     g_free (filename);
1239   }
1240
1241   g_dir_close (dir);
1242
1243   return changed;
1244 }
1245
1246 static gboolean
1247 gst_registry_scan_path_internal (GstRegistryScanContext * context,
1248     const gchar * path)
1249 {
1250   gboolean changed;
1251
1252   GST_DEBUG_OBJECT (context->registry, "scanning path %s", path);
1253   changed = gst_registry_scan_path_level (context, path, 10);
1254
1255   GST_DEBUG_OBJECT (context->registry, "registry changed in path %s: %d", path,
1256       changed);
1257   return changed;
1258 }
1259
1260 /**
1261  * gst_registry_scan_path:
1262  * @registry: the registry to add found plugins to
1263  * @path: the path to scan
1264  *
1265  * Scan the given path for plugins to add to the registry. The syntax of the
1266  * path is specific to the registry.
1267  *
1268  * Returns: %TRUE if registry changed
1269  */
1270 gboolean
1271 gst_registry_scan_path (GstRegistry * registry, const gchar * path)
1272 {
1273   GstRegistryScanContext context;
1274   gboolean result;
1275
1276   g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1277   g_return_val_if_fail (path != NULL, FALSE);
1278
1279   init_scan_context (&context, registry);
1280
1281   result = gst_registry_scan_path_internal (&context, path);
1282
1283   clear_scan_context (&context);
1284   result |= context.changed;
1285
1286   return result;
1287 }
1288
1289 static gboolean
1290 _gst_plugin_feature_filter_plugin_name (GstPluginFeature * feature,
1291     gpointer user_data)
1292 {
1293   return (strcmp (feature->plugin_name, (gchar *) user_data) == 0);
1294 }
1295
1296 /**
1297  * gst_registry_get_feature_list_by_plugin:
1298  * @registry: a #GstRegistry.
1299  * @name: a plugin name.
1300  *
1301  * Retrieves a #GList of features of the plugin with name @name.
1302  *
1303  * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
1304  *     #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
1305  */
1306 GList *
1307 gst_registry_get_feature_list_by_plugin (GstRegistry * registry,
1308     const gchar * name)
1309 {
1310   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1311   g_return_val_if_fail (name != NULL, NULL);
1312
1313   return gst_registry_feature_filter (registry,
1314       _gst_plugin_feature_filter_plugin_name, FALSE, (gpointer) name);
1315 }
1316
1317 /* Unref and delete the default registry */
1318 void
1319 _priv_gst_registry_cleanup (void)
1320 {
1321   GstRegistry *registry;
1322
1323   g_static_mutex_lock (&_gst_registry_mutex);
1324   if ((registry = _gst_registry_default) != NULL) {
1325     _gst_registry_default = NULL;
1326   }
1327   g_static_mutex_unlock (&_gst_registry_mutex);
1328
1329   /* unref outside of the lock because we can. */
1330   if (registry)
1331     gst_object_unref (registry);
1332 }
1333
1334 /**
1335  * gst_default_registry_check_feature_version:
1336  * @feature_name: the name of the feature (e.g. "oggdemux")
1337  * @min_major: the minimum major version number
1338  * @min_minor: the minimum minor version number
1339  * @min_micro: the minimum micro version number
1340  *
1341  * Checks whether a plugin feature by the given name exists in the
1342  * default registry and whether its version is at least the
1343  * version required.
1344  *
1345  * Returns: #TRUE if the feature could be found and the version is
1346  * the same as the required version or newer, and #FALSE otherwise.
1347  */
1348 gboolean
1349 gst_default_registry_check_feature_version (const gchar * feature_name,
1350     guint min_major, guint min_minor, guint min_micro)
1351 {
1352   GstPluginFeature *feature;
1353   GstRegistry *registry;
1354   gboolean ret = FALSE;
1355
1356   g_return_val_if_fail (feature_name != NULL, FALSE);
1357
1358   GST_DEBUG ("Looking up plugin feature '%s'", feature_name);
1359
1360   registry = gst_registry_get_default ();
1361   feature = gst_registry_lookup_feature (registry, feature_name);
1362   if (feature) {
1363     ret = gst_plugin_feature_check_version (feature, min_major, min_minor,
1364         min_micro);
1365     gst_object_unref (feature);
1366   } else {
1367     GST_DEBUG ("Could not find plugin feature '%s'", feature_name);
1368   }
1369
1370   return ret;
1371 }
1372
1373 static void
1374 load_plugin_func (gpointer data, gpointer user_data)
1375 {
1376   GstPlugin *plugin;
1377   const gchar *filename;
1378   GError *err = NULL;
1379
1380   filename = (const gchar *) data;
1381   GST_DEBUG ("Pre-loading plugin %s", filename);
1382
1383   plugin = gst_plugin_load_file (filename, &err);
1384
1385   if (plugin) {
1386     GST_INFO ("Loaded plugin: \"%s\"", filename);
1387
1388     gst_default_registry_add_plugin (plugin);
1389   } else {
1390     if (err) {
1391       /* Report error to user, and free error */
1392       GST_ERROR ("Failed to load plugin: %s", err->message);
1393       g_error_free (err);
1394     } else {
1395       GST_WARNING ("Failed to load plugin: \"%s\"", filename);
1396     }
1397   }
1398 }
1399
1400 #ifndef GST_DISABLE_REGISTRY
1401 /* Unref all plugins marked 'cached', to clear old plugins that no
1402  * longer exist. Returns TRUE if any plugins were removed */
1403 static gboolean
1404 gst_registry_remove_cache_plugins (GstRegistry * registry)
1405 {
1406   GList *g;
1407   GList *g_next;
1408   GstPlugin *plugin;
1409   gboolean changed = FALSE;
1410
1411   g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1412
1413   GST_OBJECT_LOCK (registry);
1414
1415   GST_DEBUG_OBJECT (registry, "removing cached plugins");
1416   g = registry->plugins;
1417   while (g) {
1418     g_next = g->next;
1419     plugin = g->data;
1420     if (plugin->flags & GST_PLUGIN_FLAG_CACHED) {
1421       GST_DEBUG_OBJECT (registry, "removing cached plugin \"%s\"",
1422           GST_STR_NULL (plugin->filename));
1423       registry->plugins = g_list_delete_link (registry->plugins, g);
1424       if (G_LIKELY (plugin->basename))
1425         g_hash_table_remove (registry->basename_hash, plugin->basename);
1426       gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
1427       gst_object_unref (plugin);
1428       changed = TRUE;
1429     }
1430     g = g_next;
1431   }
1432
1433   GST_OBJECT_UNLOCK (registry);
1434
1435   return changed;
1436 }
1437
1438 typedef enum
1439 {
1440   REGISTRY_SCAN_AND_UPDATE_FAILURE = 0,
1441   REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED,
1442   REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED
1443 } GstRegistryScanAndUpdateResult;
1444
1445 /*
1446  * scan_and_update_registry:
1447  * @default_registry: the #GstRegistry
1448  * @registry_file: registry filename
1449  * @write_changes: write registry if it has changed?
1450  *
1451  * Scans for registry changes and eventually updates the registry cache.
1452  *
1453  * Return: %REGISTRY_SCAN_AND_UPDATE_FAILURE if the registry could not scanned
1454  *         or updated, %REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED if the
1455  *         registry is clean and %REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED if
1456  *         it has been updated and the cache needs to be re-read.
1457  */
1458 static GstRegistryScanAndUpdateResult
1459 scan_and_update_registry (GstRegistry * default_registry,
1460     const gchar * registry_file, gboolean write_changes, GError ** error)
1461 {
1462   const gchar *plugin_path;
1463   gboolean changed = FALSE;
1464   GList *l;
1465   GstRegistryScanContext context;
1466
1467   GST_INFO ("Validating plugins from registry cache: %s", registry_file);
1468
1469   init_scan_context (&context, default_registry);
1470
1471   /* It sounds tempting to just compare the mtime of directories with the mtime
1472    * of the registry cache, but it does not work. It would not catch updated
1473    * plugins, which might bring more or less features.
1474    */
1475
1476   /* scan paths specified via --gst-plugin-path */
1477   GST_DEBUG ("scanning paths added via --gst-plugin-path");
1478   for (l = _priv_gst_plugin_paths; l != NULL; l = l->next) {
1479     GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data);
1480     changed |= gst_registry_scan_path_internal (&context, (gchar *) l->data);
1481   }
1482   /* keep plugin_paths around in case a re-scan is forced later on */
1483
1484   /* GST_PLUGIN_PATH specifies a list of directories to scan for
1485    * additional plugins.  These take precedence over the system plugins */
1486   plugin_path = g_getenv ("GST_PLUGIN_PATH");
1487   if (plugin_path) {
1488     char **list;
1489     int i;
1490
1491     GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path);
1492     list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1493     for (i = 0; list[i]; i++) {
1494       changed |= gst_registry_scan_path_internal (&context, list[i]);
1495     }
1496     g_strfreev (list);
1497   } else {
1498     GST_DEBUG ("GST_PLUGIN_PATH not set");
1499   }
1500
1501   /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always
1502    * loaded by default.  If not set, this defaults to the system-installed
1503    * path, and the plugins installed in the user's home directory */
1504   plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH");
1505   if (plugin_path == NULL) {
1506     char *home_plugins;
1507
1508     GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set");
1509
1510     /* plugins in the user's home directory take precedence over
1511      * system-installed ones */
1512     home_plugins = g_build_filename (g_get_user_data_dir (),
1513         "gstreamer-" GST_MAJORMINOR, "plugins", NULL);
1514
1515     GST_DEBUG ("scanning home plugins %s", home_plugins);
1516     changed |= gst_registry_scan_path_internal (&context, home_plugins);
1517     g_free (home_plugins);
1518
1519     /* add the main (installed) library path */
1520     GST_DEBUG ("scanning main plugins %s", PLUGINDIR);
1521     changed |= gst_registry_scan_path_internal (&context, PLUGINDIR);
1522
1523 #ifdef G_OS_WIN32
1524     {
1525       char *base_dir;
1526       char *dir;
1527
1528       base_dir =
1529           g_win32_get_package_installation_directory_of_module
1530           (_priv_gst_dll_handle);
1531
1532       dir = g_build_filename (base_dir, "lib", "gstreamer-0.10", NULL);
1533       GST_DEBUG ("scanning DLL dir %s", dir);
1534
1535       changed |= gst_registry_scan_path_internal (&context, dir);
1536
1537       g_free (dir);
1538       g_free (base_dir);
1539     }
1540 #endif
1541   } else {
1542     gchar **list;
1543     gint i;
1544
1545     GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path);
1546     list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1547     for (i = 0; list[i]; i++) {
1548       changed |= gst_registry_scan_path_internal (&context, list[i]);
1549     }
1550     g_strfreev (list);
1551   }
1552
1553   clear_scan_context (&context);
1554   changed |= context.changed;
1555
1556   /* Remove cached plugins so stale info is cleared. */
1557   changed |= gst_registry_remove_cache_plugins (default_registry);
1558
1559   if (!changed) {
1560     GST_INFO ("Registry cache has not changed");
1561     return REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED;
1562   }
1563
1564   if (!write_changes) {
1565     GST_INFO ("Registry cache changed, but writing is disabled. Not writing.");
1566     return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1567   }
1568
1569   GST_INFO ("Registry cache changed. Writing new registry cache");
1570   if (!gst_registry_binary_write_cache (default_registry, registry_file)) {
1571     g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
1572         _("Error writing registry cache to %s: %s"),
1573         registry_file, g_strerror (errno));
1574     return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1575   }
1576
1577   GST_INFO ("Registry cache written successfully");
1578   return REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED;
1579 }
1580
1581 static gboolean
1582 ensure_current_registry (GError ** error)
1583 {
1584   gchar *registry_file;
1585   GstRegistry *default_registry;
1586   gboolean ret = TRUE;
1587   gboolean do_update = TRUE;
1588   gboolean have_cache = TRUE;
1589
1590   default_registry = gst_registry_get_default ();
1591   registry_file = g_strdup (g_getenv ("GST_REGISTRY"));
1592   if (registry_file == NULL) {
1593     registry_file = g_build_filename (g_get_user_cache_dir (),
1594         "gstreamer-" GST_MAJORMINOR, "registry." HOST_CPU ".bin", NULL);
1595   }
1596
1597   if (!_gst_disable_registry_cache) {
1598     GST_INFO ("reading registry cache: %s", registry_file);
1599     have_cache = gst_registry_binary_read_cache (default_registry,
1600         registry_file);
1601     /* Only ever read the registry cache once, then disable it for
1602      * subsequent updates during the program lifetime */
1603     _gst_disable_registry_cache = TRUE;
1604   }
1605
1606   if (have_cache) {
1607     do_update = !_priv_gst_disable_registry_update;
1608     if (do_update) {
1609       const gchar *update_env;
1610
1611       if ((update_env = g_getenv ("GST_REGISTRY_UPDATE"))) {
1612         /* do update for any value different from "no" */
1613         do_update = (strcmp (update_env, "no") != 0);
1614       }
1615     }
1616   }
1617
1618   if (do_update) {
1619     /* now check registry */
1620     GST_DEBUG ("Updating registry cache");
1621     scan_and_update_registry (default_registry, registry_file, TRUE, error);
1622   } else {
1623     GST_DEBUG ("Not updating registry cache (disabled)");
1624   }
1625
1626   g_free (registry_file);
1627   GST_INFO ("registry reading and updating done, result = %d", ret);
1628
1629   return ret;
1630 }
1631 #endif /* GST_DISABLE_REGISTRY */
1632
1633 /**
1634  * gst_registry_fork_is_enabled:
1635  *
1636  * By default GStreamer will perform scanning and rebuilding of the
1637  * registry file using a helper child process.
1638  *
1639  * Applications might want to disable this behaviour with the
1640  * gst_registry_fork_set_enabled() function, in which case new plugins
1641  * are scanned (and loaded) into the application process.
1642  *
1643  * Returns: %TRUE if GStreamer will use the child helper process when
1644  * rebuilding the registry.
1645  *
1646  * Since: 0.10.10
1647  */
1648 gboolean
1649 gst_registry_fork_is_enabled (void)
1650 {
1651   return _gst_enable_registry_fork;
1652 }
1653
1654 /**
1655  * gst_registry_fork_set_enabled:
1656  * @enabled: whether rebuilding the registry can use a temporary child helper process.
1657  *
1658  * Applications might want to disable/enable spawning of a child helper process
1659  * when rebuilding the registry. See gst_registry_fork_is_enabled() for more
1660  * information.
1661  *
1662  * Since: 0.10.10
1663  */
1664 void
1665 gst_registry_fork_set_enabled (gboolean enabled)
1666 {
1667   _gst_enable_registry_fork = enabled;
1668 }
1669
1670 /**
1671  * gst_update_registry:
1672  *
1673  * Forces GStreamer to re-scan its plugin paths and update the default
1674  * plugin registry.
1675  *
1676  * Applications will almost never need to call this function, it is only
1677  * useful if the application knows new plugins have been installed (or old
1678  * ones removed) since the start of the application (or, to be precise, the
1679  * first call to gst_init()) and the application wants to make use of any
1680  * newly-installed plugins without restarting the application.
1681  *
1682  * Applications should assume that the registry update is neither atomic nor
1683  * thread-safe and should therefore not have any dynamic pipelines running
1684  * (including the playbin and decodebin elements) and should also not create
1685  * any elements or access the GStreamer registry while the update is in
1686  * progress.
1687  *
1688  * Note that this function may block for a significant amount of time.
1689  *
1690  * Returns: %TRUE if the registry has been updated successfully (does not
1691  *          imply that there were changes), otherwise %FALSE.
1692  *
1693  * Since: 0.10.12
1694  */
1695 gboolean
1696 gst_update_registry (void)
1697 {
1698   gboolean res;
1699
1700 #ifndef GST_DISABLE_REGISTRY
1701   GError *err = NULL;
1702
1703   res = ensure_current_registry (&err);
1704   if (err) {
1705     GST_WARNING ("registry update failed: %s", err->message);
1706     g_error_free (err);
1707   } else {
1708     GST_LOG ("registry update succeeded");
1709   }
1710
1711 #else
1712   GST_WARNING ("registry update failed: %s", "registry disabled");
1713   res = TRUE;
1714 #endif /* GST_DISABLE_REGISTRY */
1715
1716   if (_priv_gst_preload_plugins) {
1717     GST_DEBUG ("Preloading indicated plugins...");
1718     g_slist_foreach (_priv_gst_preload_plugins, load_plugin_func, NULL);
1719   }
1720
1721   return res;
1722 }
1723
1724 /**
1725  * gst_registry_get_feature_list_cookie:
1726  * @registry: the registry
1727  *
1728  * Returns the registrys feature list cookie. This changes
1729  * every time a feature is added or removed from the registry.
1730  *
1731  * Returns: the feature list cookie.
1732  *
1733  * Since: 0.10.26
1734  */
1735 guint32
1736 gst_registry_get_feature_list_cookie (GstRegistry * registry)
1737 {
1738   g_return_val_if_fail (GST_IS_REGISTRY (registry), 0);
1739
1740   return registry->priv->cookie;
1741 }