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