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