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>
6 * gstregistry.c: handle registry
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.
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.
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., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
26 * @short_description: Abstract base class for management of #GstPlugin objects
27 * @see_also: #GstPlugin, #GstPluginFeature
29 * One registry holds the metadata of a set of plugins.
31 * <emphasis role="bold">Design:</emphasis>
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.
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.
45 * On startup, plugins are searched for in the plugin search path. The following
46 * locations are checked in this order:
49 * <para>location from --gst-plugin-path commandline option.</para>
52 * <para>the GST_PLUGIN_PATH environment variable.</para>
55 * <para>the GST_PLUGIN_SYSTEM_PATH environment variable.</para>
58 * <para>default locations (if GST_PLUGIN_SYSTEM_PATH is not set). Those
59 * default locations are:
60 * <filename>$XDG_DATA_HOME/gstreamer-$GST_API_VERSION/plugins/</filename>
61 * and <filename>$prefix/libs/gstreamer-$GST_API_VERSION/</filename>.
62 * <ulink url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">
63 * <filename>$XDG_DATA_HOME</filename></ulink> defaults to
64 * <filename>$HOME/.local/share</filename>.
68 * The registry cache file is loaded from
69 * <filename>$XDG_CACHE_HOME/gstreamer-$GST_API_VERSION/registry-$ARCH.bin</filename>
71 * <ulink url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">
72 * <filename>$XDG_CACHE_HOME</filename></ulink> defaults to
73 * <filename>$HOME/.cache</filename>) or the file listed in the GST_REGISTRY
74 * env var. One reason to change the registry location is for testing.
76 * For each plugin that is found in the plugin search path, there could be 3
77 * possibilities for cached information:
80 * <para>the cache may not contain information about a given file.</para>
83 * <para>the cache may have stale information.</para>
86 * <para>the cache may have current information.</para>
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
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
100 * <emphasis role="bold">Implementation notes:</emphasis>
102 * The "cache" and "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.
112 #include "gstconfig.h"
113 #include "gst_private.h"
115 #include <sys/types.h>
116 #include <sys/stat.h>
125 #include <glib/gstdio.h>
128 #include "gsterror.h"
129 #include "gstregistry.h"
130 #include "gstdevicemonitorfactory.h"
132 #include "gstpluginloader.h"
134 #include "gst-i18n-lib.h"
137 #include "glib-compat-private.h"
141 extern HMODULE _priv_gst_dll_handle;
144 #define GST_CAT_DEFAULT GST_CAT_REGISTRY
146 struct _GstRegistryPrivate
157 /* hash to speedup _lookup_feature_locked() */
158 GHashTable *feature_hash;
159 /* hash to speedup _lookup */
160 GHashTable *basename_hash;
162 /* updated whenever the feature list changes */
164 /* speedup for searching features */
165 GList *element_factory_list;
167 GList *typefind_factory_list;
169 GList *device_monitor_factory_list;
173 /* the one instance of the default registry and the mutex protecting the
175 static GMutex _gst_registry_mutex;
176 static GstRegistry *_gst_registry_default = NULL;
179 #define DEFAULT_FORK TRUE
181 /* control the behaviour of registry rebuild */
182 static gboolean _gst_enable_registry_fork = DEFAULT_FORK;
183 /* List of plugins that need preloading/reloading after scanning registry */
184 extern GSList *_priv_gst_preload_plugins;
186 #ifndef GST_DISABLE_REGISTRY
187 /*set to TRUE when registry needn't to be updated */
188 gboolean _priv_gst_disable_registry_update = FALSE;
189 extern GList *_priv_gst_plugin_paths;
191 /* Set to TRUE when the registry cache should be disabled */
192 gboolean _gst_disable_registry_cache = FALSE;
194 static gboolean __registry_reuse_plugin_scanner = TRUE;
197 /* Element signals and args */
205 static void gst_registry_finalize (GObject * object);
207 static guint gst_registry_signals[LAST_SIGNAL] = { 0 };
209 static GstPluginFeature *gst_registry_lookup_feature_locked (GstRegistry *
210 registry, const char *name);
211 static GstPlugin *gst_registry_lookup_bn_locked (GstRegistry * registry,
212 const char *basename);
214 #define gst_registry_parent_class parent_class
215 G_DEFINE_TYPE (GstRegistry, gst_registry, GST_TYPE_OBJECT);
218 gst_registry_class_init (GstRegistryClass * klass)
220 GObjectClass *gobject_class;
222 gobject_class = (GObjectClass *) klass;
224 g_type_class_add_private (klass, sizeof (GstRegistryPrivate));
227 * GstRegistry::plugin-added:
228 * @registry: the registry that emitted the signal
229 * @plugin: the plugin that has been added
231 * Signals that a plugin has been added to the registry (possibly
232 * replacing a previously-added one by the same name)
234 gst_registry_signals[PLUGIN_ADDED] =
235 g_signal_new ("plugin-added", G_TYPE_FROM_CLASS (klass),
236 G_SIGNAL_RUN_LAST, 0, NULL, NULL, g_cclosure_marshal_generic,
237 G_TYPE_NONE, 1, GST_TYPE_PLUGIN);
240 * GstRegistry::feature-added:
241 * @registry: the registry that emitted the signal
242 * @feature: the feature that has been added
244 * Signals that a feature has been added to the registry (possibly
245 * replacing a previously-added one by the same name)
247 gst_registry_signals[FEATURE_ADDED] =
248 g_signal_new ("feature-added", G_TYPE_FROM_CLASS (klass),
249 G_SIGNAL_RUN_LAST, 0, NULL, NULL, g_cclosure_marshal_generic,
250 G_TYPE_NONE, 1, GST_TYPE_PLUGIN_FEATURE);
252 gobject_class->finalize = gst_registry_finalize;
256 gst_registry_init (GstRegistry * registry)
259 G_TYPE_INSTANCE_GET_PRIVATE (registry, GST_TYPE_REGISTRY,
261 registry->priv->feature_hash = g_hash_table_new (g_str_hash, g_str_equal);
262 registry->priv->basename_hash = g_hash_table_new (g_str_hash, g_str_equal);
266 gst_registry_finalize (GObject * object)
268 GstRegistry *registry = GST_REGISTRY (object);
272 plugins = registry->priv->plugins;
273 registry->priv->plugins = NULL;
275 GST_DEBUG_OBJECT (registry, "registry finalize");
278 GstPlugin *plugin = p->data;
281 GST_LOG_OBJECT (registry, "removing plugin %s",
282 gst_plugin_get_name (plugin));
283 gst_object_unref (plugin);
287 g_list_free (plugins);
289 features = registry->priv->features;
290 registry->priv->features = NULL;
294 GstPluginFeature *feature = f->data;
297 GST_LOG_OBJECT (registry, "removing feature %p (%s)", feature,
298 GST_OBJECT_NAME (feature));
299 gst_object_unparent (GST_OBJECT_CAST (feature));
303 g_list_free (features);
305 g_hash_table_destroy (registry->priv->feature_hash);
306 registry->priv->feature_hash = NULL;
307 g_hash_table_destroy (registry->priv->basename_hash);
308 registry->priv->basename_hash = NULL;
310 if (registry->priv->element_factory_list) {
311 GST_DEBUG_OBJECT (registry, "Cleaning up cached element factory list");
312 gst_plugin_feature_list_free (registry->priv->element_factory_list);
315 if (registry->priv->typefind_factory_list) {
316 GST_DEBUG_OBJECT (registry, "Cleaning up cached typefind factory list");
317 gst_plugin_feature_list_free (registry->priv->typefind_factory_list);
320 if (registry->priv->device_monitor_factory_list) {
321 GST_DEBUG_OBJECT (registry,
322 "Cleaning up cached device monitor factory list");
323 gst_plugin_feature_list_free (registry->priv->device_monitor_factory_list);
326 G_OBJECT_CLASS (parent_class)->finalize (object);
332 * Retrieves the singleton plugin registry. The caller does not own a
333 * reference on the registry, as it is alive as long as GStreamer is
336 * Returns: (transfer none): the #GstRegistry.
339 gst_registry_get (void)
341 GstRegistry *registry;
343 g_mutex_lock (&_gst_registry_mutex);
344 if (G_UNLIKELY (!_gst_registry_default)) {
345 _gst_registry_default = g_object_newv (GST_TYPE_REGISTRY, 0, NULL);
346 gst_object_ref_sink (GST_OBJECT_CAST (_gst_registry_default));
348 registry = _gst_registry_default;
349 g_mutex_unlock (&_gst_registry_mutex);
356 * gst_registry_add_path:
357 * @registry: the registry to add the path to
358 * @path: the path to add to the registry
360 * Add the given path to the registry. The syntax of the
361 * path is specific to the registry. If the path has already been
365 gst_registry_add_path (GstRegistry * registry, const gchar * path)
367 g_return_if_fail (GST_IS_REGISTRY (registry));
368 g_return_if_fail (path != NULL);
370 if (strlen (path) == 0)
373 GST_OBJECT_LOCK (registry);
374 if (g_list_find_custom (registry->priv->paths, path, (GCompareFunc) strcmp))
377 GST_INFO ("Adding plugin path: \"%s\"", path);
378 registry->priv->paths =
379 g_list_append (registry->priv->paths, g_strdup (path));
380 GST_OBJECT_UNLOCK (registry);
386 GST_INFO ("Ignoring empty plugin path");
391 g_warning ("path %s already added to registry", path);
392 GST_OBJECT_UNLOCK (registry);
398 * gst_registry_get_path_list:
399 * @registry: the registry to get the pathlist of
401 * Get the list of paths for the given registry.
403 * Returns: (transfer container) (element-type char*): A #GList of paths as
404 * strings. g_list_free after use.
409 gst_registry_get_path_list (GstRegistry * registry)
413 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
415 GST_OBJECT_LOCK (registry);
416 /* We don't need to copy the strings, because they won't be deleted
417 * as long as the GstRegistry is around */
418 list = g_list_copy (registry->priv->paths);
419 GST_OBJECT_UNLOCK (registry);
426 * gst_registry_add_plugin:
427 * @registry: the registry to add the plugin to
428 * @plugin: (transfer full): the plugin to add
430 * Add the plugin to the registry. The plugin-added signal will be emitted.
431 * This function will sink @plugin.
433 * Returns: TRUE on success.
438 gst_registry_add_plugin (GstRegistry * registry, GstPlugin * plugin)
440 GstPlugin *existing_plugin;
442 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
443 g_return_val_if_fail (GST_IS_PLUGIN (plugin), FALSE);
445 GST_OBJECT_LOCK (registry);
446 if (G_LIKELY (plugin->basename)) {
447 /* we have a basename, see if we find the plugin */
449 gst_registry_lookup_bn_locked (registry, plugin->basename);
450 if (existing_plugin) {
451 GST_DEBUG_OBJECT (registry,
452 "Replacing existing plugin \"%s\" %p with new plugin %p for filename \"%s\"",
453 GST_STR_NULL (existing_plugin->filename), existing_plugin, plugin,
454 GST_STR_NULL (plugin->filename));
455 /* If the new plugin is blacklisted and the existing one isn't cached, do not
456 * accept if it's from a different location than the existing one */
457 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED) &&
458 strcmp (plugin->filename, existing_plugin->filename)) {
459 GST_WARNING_OBJECT (registry,
460 "Not replacing plugin because new one (%s) is blacklisted but for a different location than existing one (%s)",
461 plugin->filename, existing_plugin->filename);
462 gst_object_unref (plugin);
463 GST_OBJECT_UNLOCK (registry);
466 registry->priv->plugins =
467 g_list_remove (registry->priv->plugins, existing_plugin);
468 if (G_LIKELY (existing_plugin->basename))
469 g_hash_table_remove (registry->priv->basename_hash,
470 existing_plugin->basename);
471 gst_object_unref (existing_plugin);
475 GST_DEBUG_OBJECT (registry, "adding plugin %p for filename \"%s\"",
476 plugin, GST_STR_NULL (plugin->filename));
478 registry->priv->plugins = g_list_prepend (registry->priv->plugins, plugin);
479 if (G_LIKELY (plugin->basename))
480 g_hash_table_replace (registry->priv->basename_hash, plugin->basename,
483 gst_object_ref_sink (plugin);
484 GST_OBJECT_UNLOCK (registry);
486 GST_LOG_OBJECT (registry, "emitting plugin-added for filename \"%s\"",
487 GST_STR_NULL (plugin->filename));
488 g_signal_emit (registry, gst_registry_signals[PLUGIN_ADDED], 0, plugin);
494 gst_registry_remove_features_for_plugin_unlocked (GstRegistry * registry,
499 g_return_if_fail (GST_IS_REGISTRY (registry));
500 g_return_if_fail (GST_IS_PLUGIN (plugin));
502 /* Remove all features for this plugin */
503 f = registry->priv->features;
505 GList *next = g_list_next (f);
506 GstPluginFeature *feature = f->data;
508 if (G_UNLIKELY (feature && feature->plugin == plugin)) {
509 GST_DEBUG_OBJECT (registry, "removing feature %p (%s) for plugin %p (%s)",
510 feature, gst_plugin_feature_get_name (feature), plugin,
513 registry->priv->features =
514 g_list_delete_link (registry->priv->features, f);
515 g_hash_table_remove (registry->priv->feature_hash,
516 GST_OBJECT_NAME (feature));
517 gst_object_unparent (GST_OBJECT_CAST (feature));
521 registry->priv->cookie++;
525 * gst_registry_remove_plugin:
526 * @registry: the registry to remove the plugin from
527 * @plugin: (transfer none): the plugin to remove
529 * Remove the plugin from the registry.
534 gst_registry_remove_plugin (GstRegistry * registry, GstPlugin * plugin)
536 g_return_if_fail (GST_IS_REGISTRY (registry));
537 g_return_if_fail (GST_IS_PLUGIN (plugin));
539 GST_DEBUG_OBJECT (registry, "removing plugin %p (%s)",
540 plugin, gst_plugin_get_name (plugin));
542 GST_OBJECT_LOCK (registry);
543 registry->priv->plugins = g_list_remove (registry->priv->plugins, plugin);
544 if (G_LIKELY (plugin->basename))
545 g_hash_table_remove (registry->priv->basename_hash, plugin->basename);
546 gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
547 GST_OBJECT_UNLOCK (registry);
548 gst_object_unref (plugin);
552 * gst_registry_add_feature:
553 * @registry: the registry to add the plugin to
554 * @feature: (transfer full): the feature to add
556 * Add the feature to the registry. The feature-added signal will be emitted.
557 * This function sinks @feature.
559 * Returns: TRUE on success.
564 gst_registry_add_feature (GstRegistry * registry, GstPluginFeature * feature)
566 GstPluginFeature *existing_feature;
568 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
569 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
570 g_return_val_if_fail (GST_OBJECT_NAME (feature) != NULL, FALSE);
571 g_return_val_if_fail (feature->plugin_name != NULL, FALSE);
573 GST_OBJECT_LOCK (registry);
574 existing_feature = gst_registry_lookup_feature_locked (registry,
575 GST_OBJECT_NAME (feature));
576 if (G_UNLIKELY (existing_feature)) {
577 GST_DEBUG_OBJECT (registry, "replacing existing feature %p (%s)",
578 existing_feature, GST_OBJECT_NAME (feature));
579 /* Remove the existing feature from the list now, before we insert the new
580 * one, but don't unref yet because the hash is still storing a reference to
582 registry->priv->features =
583 g_list_remove (registry->priv->features, existing_feature);
586 GST_DEBUG_OBJECT (registry, "adding feature %p (%s)", feature,
587 GST_OBJECT_NAME (feature));
589 registry->priv->features = g_list_prepend (registry->priv->features, feature);
590 g_hash_table_replace (registry->priv->feature_hash, GST_OBJECT_NAME (feature),
593 if (G_UNLIKELY (existing_feature)) {
594 /* We unref now. No need to remove the feature name from the hash table, it
595 * got replaced by the new feature */
596 gst_object_unparent (GST_OBJECT_CAST (existing_feature));
599 gst_object_set_parent (GST_OBJECT_CAST (feature), GST_OBJECT_CAST (registry));
601 registry->priv->cookie++;
602 GST_OBJECT_UNLOCK (registry);
604 GST_LOG_OBJECT (registry, "emitting feature-added for %s",
605 GST_OBJECT_NAME (feature));
606 g_signal_emit (registry, gst_registry_signals[FEATURE_ADDED], 0, feature);
612 * gst_registry_remove_feature:
613 * @registry: the registry to remove the feature from
614 * @feature: (transfer none): the feature to remove
616 * Remove the feature from the registry.
621 gst_registry_remove_feature (GstRegistry * registry, GstPluginFeature * feature)
623 g_return_if_fail (GST_IS_REGISTRY (registry));
624 g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
626 GST_DEBUG_OBJECT (registry, "removing feature %p (%s)",
627 feature, gst_plugin_feature_get_name (feature));
629 GST_OBJECT_LOCK (registry);
630 registry->priv->features = g_list_remove (registry->priv->features, feature);
631 g_hash_table_remove (registry->priv->feature_hash, GST_OBJECT_NAME (feature));
632 registry->priv->cookie++;
633 GST_OBJECT_UNLOCK (registry);
635 gst_object_unparent ((GstObject *) feature);
639 * gst_registry_plugin_filter:
640 * @registry: registry to query
641 * @filter: (scope call): the filter to use
642 * @first: only return first match
643 * @user_data: (closure): user data passed to the filter function
645 * Runs a filter against all plugins in the registry and returns a #GList with
646 * the results. If the first flag is set, only the first match is
647 * returned (as a list with a single object).
648 * Every plugin is reffed; use gst_plugin_list_free() after use, which
651 * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
652 * Use gst_plugin_list_free() after usage.
657 gst_registry_plugin_filter (GstRegistry * registry,
658 GstPluginFilter filter, gboolean first, gpointer user_data)
662 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
664 GST_OBJECT_LOCK (registry);
668 for (walk = registry->priv->plugins; walk != NULL; walk = walk->next) {
669 GstPlugin *plugin = walk->data;
671 if (filter == NULL || filter (plugin, user_data)) {
672 list = g_list_prepend (list, gst_object_ref (plugin));
679 GST_OBJECT_UNLOCK (registry);
691 gst_plugin_feature_type_name_filter (GstPluginFeature * feature,
692 GstTypeNameData * data)
694 g_assert (GST_IS_PLUGIN_FEATURE (feature));
696 return ((data->type == 0 || data->type == G_OBJECT_TYPE (feature)) &&
697 (data->name == NULL || !strcmp (data->name, GST_OBJECT_NAME (feature))));
700 /* returns TRUE if the list was changed
702 * Must be called with the object lock taken */
704 gst_registry_get_feature_list_or_create (GstRegistry * registry,
705 GList ** previous, guint32 * cookie, GType type)
707 gboolean res = FALSE;
708 GstRegistryPrivate *priv = registry->priv;
710 if (G_UNLIKELY (!*previous || priv->cookie != *cookie)) {
711 GstTypeNameData data;
715 gst_plugin_feature_list_free (*previous);
722 for (walk = registry->priv->features; walk != NULL; walk = walk->next) {
723 GstPluginFeature *feature = walk->data;
725 if (gst_plugin_feature_type_name_filter (feature, &data)) {
726 *previous = g_list_prepend (*previous, gst_object_ref (feature));
730 *cookie = priv->cookie;
738 type_find_factory_rank_cmp (const GstPluginFeature * fac1,
739 const GstPluginFeature * fac2)
741 if (G_LIKELY (fac1->rank != fac2->rank))
742 return fac2->rank - fac1->rank;
744 /* to make the order in which things happen more deterministic,
745 * sort by name when the ranks are the same. */
746 return strcmp (GST_OBJECT_NAME (fac1), GST_OBJECT_NAME (fac2));
750 gst_registry_get_element_factory_list (GstRegistry * registry)
754 GST_OBJECT_LOCK (registry);
756 gst_registry_get_feature_list_or_create (registry,
757 ®istry->priv->element_factory_list, ®istry->priv->efl_cookie,
758 GST_TYPE_ELEMENT_FACTORY);
760 /* Return reffed copy */
761 list = gst_plugin_feature_list_copy (registry->priv->element_factory_list);
763 GST_OBJECT_UNLOCK (registry);
769 gst_registry_get_typefind_factory_list (GstRegistry * registry)
773 GST_OBJECT_LOCK (registry);
775 if (G_UNLIKELY (gst_registry_get_feature_list_or_create (registry,
776 ®istry->priv->typefind_factory_list,
777 ®istry->priv->tfl_cookie, GST_TYPE_TYPE_FIND_FACTORY)))
778 registry->priv->typefind_factory_list =
779 g_list_sort (registry->priv->typefind_factory_list,
780 (GCompareFunc) type_find_factory_rank_cmp);
782 /* Return reffed copy */
783 list = gst_plugin_feature_list_copy (registry->priv->typefind_factory_list);
785 GST_OBJECT_UNLOCK (registry);
792 gst_registry_get_device_monitor_factory_list (GstRegistry * registry)
796 GST_OBJECT_LOCK (registry);
798 gst_registry_get_feature_list_or_create (registry,
799 ®istry->priv->device_monitor_factory_list,
800 ®istry->priv->dmfl_cookie, GST_TYPE_DEVICE_MONITOR_FACTORY);
802 /* Return reffed copy */
804 gst_plugin_feature_list_copy (registry->priv->
805 device_monitor_factory_list);
807 GST_OBJECT_UNLOCK (registry);
813 * gst_registry_feature_filter:
814 * @registry: registry to query
815 * @filter: (scope call): the filter to use
816 * @first: only return first match
817 * @user_data: (closure): user data passed to the filter function
819 * Runs a filter against all features of the plugins in the registry
820 * and returns a GList with the results.
821 * If the first flag is set, only the first match is
822 * returned (as a list with a single object).
824 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
825 * #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
830 gst_registry_feature_filter (GstRegistry * registry,
831 GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
835 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
837 GST_OBJECT_LOCK (registry);
841 for (walk = registry->priv->features; walk != NULL; walk = walk->next) {
842 GstPluginFeature *feature = walk->data;
844 if (filter == NULL || filter (feature, user_data)) {
845 list = g_list_prepend (list, gst_object_ref (feature));
852 GST_OBJECT_UNLOCK (registry);
858 gst_registry_plugin_name_filter (GstPlugin * plugin, const gchar * name)
860 return (plugin->desc.name && !strcmp (plugin->desc.name, name));
864 * gst_registry_find_plugin:
865 * @registry: the registry to search
866 * @name: the plugin name to find
868 * Find the plugin with the given name in the registry.
869 * The plugin will be reffed; caller is responsible for unreffing.
871 * Returns: (transfer full): the plugin with the given name or NULL if the
872 * plugin was not found. gst_object_unref() after usage.
877 gst_registry_find_plugin (GstRegistry * registry, const gchar * name)
880 GstPlugin *result = NULL;
882 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
883 g_return_val_if_fail (name != NULL, NULL);
885 walk = gst_registry_plugin_filter (registry,
886 (GstPluginFilter) gst_registry_plugin_name_filter, TRUE, (gpointer) name);
888 result = GST_PLUGIN_CAST (walk->data);
890 gst_object_ref (result);
891 gst_plugin_list_free (walk);
898 * gst_registry_find_feature:
899 * @registry: the registry to search
900 * @name: the pluginfeature name to find
901 * @type: the pluginfeature type to find
903 * Find the pluginfeature with the given name and type in the registry.
905 * Returns: (transfer full): the pluginfeature with the given name and type
906 * or NULL if the plugin was not found. gst_object_unref() after usage.
911 gst_registry_find_feature (GstRegistry * registry, const gchar * name,
914 GstPluginFeature *feature = NULL;
916 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
917 g_return_val_if_fail (name != NULL, NULL);
918 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
920 feature = gst_registry_lookup_feature (registry, name);
921 if (feature && !g_type_is_a (G_TYPE_FROM_INSTANCE (feature), type)) {
922 gst_object_unref (feature);
930 * gst_registry_get_feature_list:
931 * @registry: a #GstRegistry
934 * Retrieves a #GList of #GstPluginFeature of @type.
936 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
937 * #GstPluginFeature of @type. Use gst_plugin_feature_list_free() after use
942 gst_registry_get_feature_list (GstRegistry * registry, GType type)
944 GstTypeNameData data;
946 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
947 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
950 if (type == GST_TYPE_ELEMENT_FACTORY)
951 return gst_registry_get_element_factory_list (registry);
952 else if (type == GST_TYPE_TYPE_FIND_FACTORY)
953 return gst_registry_get_typefind_factory_list (registry);
954 else if (type == GST_TYPE_DEVICE_MONITOR_FACTORY)
955 return gst_registry_get_device_monitor_factory_list (registry);
960 return gst_registry_feature_filter (registry,
961 (GstPluginFeatureFilter) gst_plugin_feature_type_name_filter,
966 * gst_registry_get_plugin_list:
967 * @registry: the registry to search
969 * Get a copy of all plugins registered in the given registry. The refcount
970 * of each element in the list in incremented.
972 * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
973 * Use gst_plugin_list_free() after usage.
978 gst_registry_get_plugin_list (GstRegistry * registry)
983 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
985 GST_OBJECT_LOCK (registry);
986 list = g_list_copy (registry->priv->plugins);
987 for (g = list; g; g = g->next) {
988 gst_object_ref (GST_PLUGIN_CAST (g->data));
990 GST_OBJECT_UNLOCK (registry);
995 static GstPluginFeature *
996 gst_registry_lookup_feature_locked (GstRegistry * registry, const char *name)
998 return g_hash_table_lookup (registry->priv->feature_hash, name);
1002 * gst_registry_lookup_feature:
1003 * @registry: a #GstRegistry
1004 * @name: a #GstPluginFeature name
1006 * Find a #GstPluginFeature with @name in @registry.
1008 * Returns: (transfer full): a #GstPluginFeature with its refcount incremented,
1009 * use gst_object_unref() after usage.
1014 gst_registry_lookup_feature (GstRegistry * registry, const char *name)
1016 GstPluginFeature *feature;
1018 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1019 g_return_val_if_fail (name != NULL, NULL);
1021 GST_OBJECT_LOCK (registry);
1022 feature = gst_registry_lookup_feature_locked (registry, name);
1024 gst_object_ref (feature);
1025 GST_OBJECT_UNLOCK (registry);
1031 gst_registry_lookup_bn_locked (GstRegistry * registry, const char *basename)
1033 return g_hash_table_lookup (registry->priv->basename_hash, basename);
1037 gst_registry_lookup_bn (GstRegistry * registry, const char *basename)
1041 GST_OBJECT_LOCK (registry);
1042 plugin = gst_registry_lookup_bn_locked (registry, basename);
1044 gst_object_ref (plugin);
1045 GST_OBJECT_UNLOCK (registry);
1051 * gst_registry_lookup:
1052 * @registry: the registry to look up in
1053 * @filename: the name of the file to look up
1055 * Look up a plugin in the given registry with the given filename.
1056 * If found, plugin is reffed.
1058 * Returns: (transfer full): the #GstPlugin if found, or NULL if not.
1059 * gst_object_unref() after usage.
1062 gst_registry_lookup (GstRegistry * registry, const char *filename)
1067 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1068 g_return_val_if_fail (filename != NULL, NULL);
1070 basename = g_path_get_basename (filename);
1071 if (G_UNLIKELY (basename == NULL))
1074 plugin = gst_registry_lookup_bn (registry, basename);
1083 REGISTRY_SCAN_HELPER_NOT_STARTED = 0,
1084 REGISTRY_SCAN_HELPER_DISABLED,
1085 REGISTRY_SCAN_HELPER_RUNNING
1086 } GstRegistryScanHelperState;
1090 GstRegistry *registry;
1091 GstRegistryScanHelperState helper_state;
1092 GstPluginLoader *helper;
1094 } GstRegistryScanContext;
1097 init_scan_context (GstRegistryScanContext * context, GstRegistry * registry)
1101 context->registry = registry;
1103 /* see if forking is enabled and set up the scan helper state accordingly */
1104 do_fork = _gst_enable_registry_fork;
1106 const gchar *fork_env;
1108 /* forking enabled, see if it is disabled with an env var */
1109 if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) {
1110 /* fork enabled for any value different from "no" */
1111 do_fork = strcmp (fork_env, "no") != 0;
1116 context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1118 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1120 context->helper = NULL;
1121 context->changed = FALSE;
1125 clear_scan_context (GstRegistryScanContext * context)
1127 if (context->helper) {
1128 context->changed |= _priv_gst_plugin_loader_funcs.destroy (context->helper);
1129 context->helper = NULL;
1134 gst_registry_scan_plugin_file (GstRegistryScanContext * context,
1135 const gchar * filename, off_t file_size, time_t file_mtime)
1137 gboolean changed = FALSE;
1138 GstPlugin *newplugin = NULL;
1141 /* Disable external plugin loader on Windows until it is ported properly. */
1142 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1146 /* Have a plugin to load - see if the scan-helper needs starting */
1147 if (context->helper_state == REGISTRY_SCAN_HELPER_NOT_STARTED) {
1148 GST_DEBUG ("Starting plugin scanner for file %s", filename);
1149 context->helper = _priv_gst_plugin_loader_funcs.create (context->registry);
1150 if (context->helper != NULL)
1151 context->helper_state = REGISTRY_SCAN_HELPER_RUNNING;
1153 GST_WARNING ("Failed starting plugin scanner. Scanning in-process");
1154 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1158 if (context->helper_state == REGISTRY_SCAN_HELPER_RUNNING) {
1159 GST_DEBUG ("Using scan-helper to load plugin %s", filename);
1160 if (!_priv_gst_plugin_loader_funcs.load (context->helper,
1161 filename, file_size, file_mtime)) {
1162 g_warning ("External plugin loader failed. This most likely means that "
1163 "the plugin loader helper binary was not found or could not be run. "
1164 "You might need to set the GST_PLUGIN_SCANNER environment variable "
1165 "if your setup is unusual. This should normally not be required "
1167 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1171 /* Check if the helper is disabled (or just got disabled above) */
1172 if (context->helper_state == REGISTRY_SCAN_HELPER_DISABLED) {
1173 /* Load plugin the old fashioned way... */
1175 /* We don't use a GError here because a failure to load some shared
1176 * objects as plugins is normal (particularly in the uninstalled case)
1178 newplugin = gst_plugin_load_file (filename, NULL);
1182 GST_DEBUG_OBJECT (context->registry, "marking new plugin %p as registered",
1184 newplugin->registered = TRUE;
1185 gst_object_unref (newplugin);
1188 #ifndef GST_DISABLE_REGISTRY
1189 if (!__registry_reuse_plugin_scanner) {
1190 clear_scan_context (context);
1191 context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1199 is_blacklisted_hidden_directory (const gchar * dirent)
1201 if (G_LIKELY (dirent[0] != '.'))
1204 /* skip the .debug directory, these contain elf files that are not
1205 * useful or worse, can crash dlopen () */
1206 if (strcmp (dirent, ".debug") == 0)
1209 /* can also skip .git and .deps dirs, those won't contain useful files.
1210 * This speeds up scanning a bit in uninstalled setups. */
1211 if (strcmp (dirent, ".git") == 0 || strcmp (dirent, ".deps") == 0)
1218 gst_registry_scan_path_level (GstRegistryScanContext * context,
1219 const gchar * path, int level)
1222 const gchar *dirent;
1225 gboolean changed = FALSE;
1227 dir = g_dir_open (path, 0, NULL);
1231 while ((dirent = g_dir_read_name (dir))) {
1232 GStatBuf file_status;
1234 filename = g_build_filename (path, dirent, NULL);
1235 if (g_stat (filename, &file_status) < 0) {
1236 /* Plugin will be removed from cache after the scan completes if it
1237 * is still marked 'cached' */
1242 if (file_status.st_mode & S_IFDIR) {
1243 if (G_UNLIKELY (is_blacklisted_hidden_directory (dirent))) {
1244 GST_TRACE_OBJECT (context->registry, "ignoring %s directory", dirent);
1248 /* FIXME 0.11: Don't recurse into directories, this behaviour
1249 * is inconsistent with other PATH environment variables
1252 GST_LOG_OBJECT (context->registry, "recursing into directory %s",
1254 changed |= gst_registry_scan_path_level (context, filename, level - 1);
1256 GST_LOG_OBJECT (context->registry, "not recursing into directory %s, "
1257 "recursion level too deep", filename);
1262 if (!(file_status.st_mode & S_IFREG)) {
1263 GST_TRACE_OBJECT (context->registry, "%s is not a regular file, ignoring",
1268 if (!g_str_has_suffix (dirent, G_MODULE_SUFFIX)
1269 #ifdef GST_EXTRA_MODULE_SUFFIX
1270 && !g_str_has_suffix (dirent, GST_EXTRA_MODULE_SUFFIX)
1273 GST_TRACE_OBJECT (context->registry,
1274 "extension is not recognized as module file, ignoring file %s",
1280 GST_LOG_OBJECT (context->registry, "file %s looks like a possible module",
1283 /* try to avoid unnecessary plugin-move pain */
1284 if (g_str_has_prefix (dirent, "libgstvalve") ||
1285 g_str_has_prefix (dirent, "libgstselector")) {
1286 GST_WARNING_OBJECT (context->registry, "ignoring old plugin %s which "
1287 "has been merged into the corelements plugin", filename);
1288 /* Plugin will be removed from cache after the scan completes if it
1289 * is still marked 'cached' */
1294 /* plug-ins are considered unique by basename; if the given name
1295 * was already seen by the registry, we ignore it */
1296 plugin = gst_registry_lookup_bn (context->registry, dirent);
1298 gboolean env_vars_changed, deps_changed = FALSE;
1300 if (plugin->registered) {
1301 GST_DEBUG_OBJECT (context->registry,
1302 "plugin already registered from path \"%s\"",
1303 GST_STR_NULL (plugin->filename));
1305 gst_object_unref (plugin);
1309 env_vars_changed = _priv_plugin_deps_env_vars_changed (plugin);
1311 /* If a file with a certain basename is seen on a different path,
1312 * update the plugin to ensure the registry cache will reflect up
1313 * to date information */
1315 if (plugin->file_mtime == file_status.st_mtime &&
1316 plugin->file_size == file_status.st_size && !env_vars_changed &&
1317 !(deps_changed = _priv_plugin_deps_files_changed (plugin)) &&
1318 !strcmp (plugin->filename, filename)) {
1319 GST_LOG_OBJECT (context->registry, "file %s cached", filename);
1320 GST_OBJECT_FLAG_UNSET (plugin, GST_PLUGIN_FLAG_CACHED);
1321 GST_LOG_OBJECT (context->registry,
1322 "marking plugin %p as registered as %s", plugin, filename);
1323 plugin->registered = TRUE;
1325 GST_INFO_OBJECT (context->registry, "cached info for %s is stale",
1327 GST_DEBUG_OBJECT (context->registry, "mtime %" G_GINT64_FORMAT " != %"
1328 G_GINT64_FORMAT " or size %" G_GINT64_FORMAT " != %"
1329 G_GINT64_FORMAT " or external dependency env_vars changed: %d or"
1330 " external dependencies changed: %d or old path %s != new path %s",
1331 (gint64) plugin->file_mtime, (gint64) file_status.st_mtime,
1332 (gint64) plugin->file_size, (gint64) file_status.st_size,
1333 env_vars_changed, deps_changed, plugin->filename, filename);
1334 gst_registry_remove_plugin (context->registry, plugin);
1335 changed |= gst_registry_scan_plugin_file (context, filename,
1336 file_status.st_size, file_status.st_mtime);
1338 gst_object_unref (plugin);
1341 GST_DEBUG_OBJECT (context->registry, "file %s not yet in registry",
1343 changed |= gst_registry_scan_plugin_file (context, filename,
1344 file_status.st_size, file_status.st_mtime);
1356 gst_registry_scan_path_internal (GstRegistryScanContext * context,
1361 GST_DEBUG_OBJECT (context->registry, "scanning path %s", path);
1362 changed = gst_registry_scan_path_level (context, path, 10);
1364 GST_DEBUG_OBJECT (context->registry, "registry changed in path %s: %d", path,
1370 * gst_registry_scan_path:
1371 * @registry: the registry to add found plugins to
1372 * @path: the path to scan
1374 * Scan the given path for plugins to add to the registry. The syntax of the
1375 * path is specific to the registry.
1377 * Returns: %TRUE if registry changed
1380 gst_registry_scan_path (GstRegistry * registry, const gchar * path)
1382 GstRegistryScanContext context;
1385 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1386 g_return_val_if_fail (path != NULL, FALSE);
1388 init_scan_context (&context, registry);
1390 result = gst_registry_scan_path_internal (&context, path);
1392 clear_scan_context (&context);
1393 result |= context.changed;
1399 _gst_plugin_feature_filter_plugin_name (GstPluginFeature * feature,
1402 return (strcmp (feature->plugin_name, (gchar *) user_data) == 0);
1406 * gst_registry_get_feature_list_by_plugin:
1407 * @registry: a #GstRegistry.
1408 * @name: a plugin name.
1410 * Retrieves a #GList of features of the plugin with name @name.
1412 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
1413 * #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
1416 gst_registry_get_feature_list_by_plugin (GstRegistry * registry,
1419 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1420 g_return_val_if_fail (name != NULL, NULL);
1422 return gst_registry_feature_filter (registry,
1423 _gst_plugin_feature_filter_plugin_name, FALSE, (gpointer) name);
1426 /* Unref and delete the default registry */
1428 _priv_gst_registry_cleanup (void)
1430 GstRegistry *registry;
1432 g_mutex_lock (&_gst_registry_mutex);
1433 if ((registry = _gst_registry_default) != NULL) {
1434 _gst_registry_default = NULL;
1436 g_mutex_unlock (&_gst_registry_mutex);
1438 /* unref outside of the lock because we can. */
1440 gst_object_unref (registry);
1444 * gst_registry_check_feature_version:
1445 * @registry: a #GstRegistry
1446 * @feature_name: the name of the feature (e.g. "oggdemux")
1447 * @min_major: the minimum major version number
1448 * @min_minor: the minimum minor version number
1449 * @min_micro: the minimum micro version number
1451 * Checks whether a plugin feature by the given name exists in
1452 * @registry and whether its version is at least the
1455 * Returns: #TRUE if the feature could be found and the version is
1456 * the same as the required version or newer, and #FALSE otherwise.
1459 gst_registry_check_feature_version (GstRegistry * registry,
1460 const gchar * feature_name, guint min_major, guint min_minor,
1463 GstPluginFeature *feature;
1464 gboolean ret = FALSE;
1466 g_return_val_if_fail (feature_name != NULL, FALSE);
1468 GST_DEBUG ("Looking up plugin feature '%s'", feature_name);
1470 feature = gst_registry_lookup_feature (registry, feature_name);
1472 ret = gst_plugin_feature_check_version (feature, min_major, min_minor,
1474 gst_object_unref (feature);
1476 GST_DEBUG ("Could not find plugin feature '%s'", feature_name);
1483 load_plugin_func (gpointer data, gpointer user_data)
1486 const gchar *filename;
1489 filename = (const gchar *) data;
1490 GST_DEBUG ("Pre-loading plugin %s", filename);
1492 plugin = gst_plugin_load_file (filename, &err);
1495 GST_INFO ("Loaded plugin: \"%s\"", filename);
1497 gst_registry_add_plugin (gst_registry_get (), plugin);
1500 /* Report error to user, and free error */
1501 GST_ERROR ("Failed to load plugin: %s", err->message);
1504 GST_WARNING ("Failed to load plugin: \"%s\"", filename);
1509 #ifndef GST_DISABLE_REGISTRY
1510 /* Unref all plugins marked 'cached', to clear old plugins that no
1511 * longer exist. Returns TRUE if any plugins were removed */
1513 gst_registry_remove_cache_plugins (GstRegistry * registry)
1518 gboolean changed = FALSE;
1520 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1522 GST_OBJECT_LOCK (registry);
1524 GST_DEBUG_OBJECT (registry, "removing cached plugins");
1525 g = registry->priv->plugins;
1529 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_CACHED)) {
1530 GST_DEBUG_OBJECT (registry, "removing cached plugin \"%s\"",
1531 GST_STR_NULL (plugin->filename));
1532 registry->priv->plugins = g_list_delete_link (registry->priv->plugins, g);
1533 if (G_LIKELY (plugin->basename))
1534 g_hash_table_remove (registry->priv->basename_hash, plugin->basename);
1535 gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
1536 gst_object_unref (plugin);
1542 GST_OBJECT_UNLOCK (registry);
1549 REGISTRY_SCAN_AND_UPDATE_FAILURE = 0,
1550 REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED,
1551 REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED
1552 } GstRegistryScanAndUpdateResult;
1555 * scan_and_update_registry:
1556 * @default_registry: the #GstRegistry
1557 * @registry_file: registry filename
1558 * @write_changes: write registry if it has changed?
1560 * Scans for registry changes and eventually updates the registry cache.
1562 * Return: %REGISTRY_SCAN_AND_UPDATE_FAILURE if the registry could not scanned
1563 * or updated, %REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED if the
1564 * registry is clean and %REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED if
1565 * it has been updated and the cache needs to be re-read.
1567 static GstRegistryScanAndUpdateResult
1568 scan_and_update_registry (GstRegistry * default_registry,
1569 const gchar * registry_file, gboolean write_changes, GError ** error)
1571 const gchar *plugin_path;
1572 gboolean changed = FALSE;
1574 GstRegistryScanContext context;
1576 GST_INFO ("Validating plugins from registry cache: %s", registry_file);
1578 init_scan_context (&context, default_registry);
1580 /* It sounds tempting to just compare the mtime of directories with the mtime
1581 * of the registry cache, but it does not work. It would not catch updated
1582 * plugins, which might bring more or less features.
1585 /* scan paths specified via --gst-plugin-path */
1586 GST_DEBUG ("scanning paths added via --gst-plugin-path");
1587 for (l = _priv_gst_plugin_paths; l != NULL; l = l->next) {
1588 GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data);
1589 changed |= gst_registry_scan_path_internal (&context, (gchar *) l->data);
1591 /* keep plugin_paths around in case a re-scan is forced later on */
1593 /* GST_PLUGIN_PATH specifies a list of directories to scan for
1594 * additional plugins. These take precedence over the system plugins */
1595 plugin_path = g_getenv ("GST_PLUGIN_PATH_1_0");
1596 if (plugin_path == NULL)
1597 plugin_path = g_getenv ("GST_PLUGIN_PATH");
1602 GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path);
1603 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1604 for (i = 0; list[i]; i++) {
1605 changed |= gst_registry_scan_path_internal (&context, list[i]);
1609 GST_DEBUG ("GST_PLUGIN_PATH not set");
1612 /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always
1613 * loaded by default. If not set, this defaults to the system-installed
1614 * path, and the plugins installed in the user's home directory */
1615 plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH_1_0");
1616 if (plugin_path == NULL)
1617 plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH");
1618 if (plugin_path == NULL) {
1621 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set");
1623 /* plugins in the user's home directory take precedence over
1624 * system-installed ones */
1625 home_plugins = g_build_filename (g_get_user_data_dir (),
1626 "gstreamer-" GST_API_VERSION, "plugins", NULL);
1628 GST_DEBUG ("scanning home plugins %s", home_plugins);
1629 changed |= gst_registry_scan_path_internal (&context, home_plugins);
1630 g_free (home_plugins);
1632 /* add the main (installed) library path */
1640 g_win32_get_package_installation_directory_of_module
1641 (_priv_gst_dll_handle);
1644 g_build_filename (base_dir,
1649 "gstreamer-" GST_API_VERSION,
1651 GST_DEBUG ("scanning DLL dir %s", dir);
1653 changed |= gst_registry_scan_path_internal (&context, dir);
1659 GST_DEBUG ("scanning main plugins %s", PLUGINDIR);
1660 changed |= gst_registry_scan_path_internal (&context, PLUGINDIR);
1666 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path);
1667 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1668 for (i = 0; list[i]; i++) {
1669 changed |= gst_registry_scan_path_internal (&context, list[i]);
1674 clear_scan_context (&context);
1675 changed |= context.changed;
1677 /* Remove cached plugins so stale info is cleared. */
1678 changed |= gst_registry_remove_cache_plugins (default_registry);
1681 GST_INFO ("Registry cache has not changed");
1682 return REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED;
1685 if (!write_changes) {
1686 GST_INFO ("Registry cache changed, but writing is disabled. Not writing.");
1687 return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1690 GST_INFO ("Registry cache changed. Writing new registry cache");
1691 if (!priv_gst_registry_binary_write_cache (default_registry,
1692 default_registry->priv->plugins, registry_file)) {
1693 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
1694 _("Error writing registry cache to %s: %s"),
1695 registry_file, g_strerror (errno));
1696 return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1699 GST_INFO ("Registry cache written successfully");
1700 return REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED;
1704 ensure_current_registry (GError ** error)
1706 gchar *registry_file;
1707 GstRegistry *default_registry;
1708 gboolean ret = TRUE;
1709 gboolean do_update = TRUE;
1710 gboolean have_cache = TRUE;
1712 default_registry = gst_registry_get ();
1714 registry_file = g_strdup (g_getenv ("GST_REGISTRY_1_0"));
1715 if (registry_file == NULL)
1716 registry_file = g_strdup (g_getenv ("GST_REGISTRY"));
1717 if (registry_file == NULL) {
1718 registry_file = g_build_filename (g_get_user_cache_dir (),
1719 "gstreamer-" GST_API_VERSION, "registry." TARGET_CPU ".bin", NULL);
1722 if (!_gst_disable_registry_cache) {
1723 GST_INFO ("reading registry cache: %s", registry_file);
1724 have_cache = priv_gst_registry_binary_read_cache (default_registry,
1726 /* Only ever read the registry cache once, then disable it for
1727 * subsequent updates during the program lifetime */
1728 _gst_disable_registry_cache = TRUE;
1732 do_update = !_priv_gst_disable_registry_update;
1734 const gchar *update_env;
1736 if ((update_env = g_getenv ("GST_REGISTRY_UPDATE"))) {
1737 /* do update for any value different from "no" */
1738 do_update = (strcmp (update_env, "no") != 0);
1744 const gchar *reuse_env;
1746 if ((reuse_env = g_getenv ("GST_REGISTRY_REUSE_PLUGIN_SCANNER"))) {
1747 /* do reuse for any value different from "no" */
1748 __registry_reuse_plugin_scanner = (strcmp (reuse_env, "no") != 0);
1750 /* now check registry */
1751 GST_DEBUG ("Updating registry cache");
1752 scan_and_update_registry (default_registry, registry_file, TRUE, error);
1754 GST_DEBUG ("Not updating registry cache (disabled)");
1757 g_free (registry_file);
1758 GST_INFO ("registry reading and updating done, result = %d", ret);
1762 #endif /* GST_DISABLE_REGISTRY */
1765 * gst_registry_fork_is_enabled:
1767 * By default GStreamer will perform scanning and rebuilding of the
1768 * registry file using a helper child process.
1770 * Applications might want to disable this behaviour with the
1771 * gst_registry_fork_set_enabled() function, in which case new plugins
1772 * are scanned (and loaded) into the application process.
1774 * Returns: %TRUE if GStreamer will use the child helper process when
1775 * rebuilding the registry.
1778 gst_registry_fork_is_enabled (void)
1780 return _gst_enable_registry_fork;
1784 * gst_registry_fork_set_enabled:
1785 * @enabled: whether rebuilding the registry can use a temporary child helper process.
1787 * Applications might want to disable/enable spawning of a child helper process
1788 * when rebuilding the registry. See gst_registry_fork_is_enabled() for more
1792 gst_registry_fork_set_enabled (gboolean enabled)
1794 _gst_enable_registry_fork = enabled;
1798 * gst_update_registry:
1800 * Forces GStreamer to re-scan its plugin paths and update the default
1803 * Applications will almost never need to call this function, it is only
1804 * useful if the application knows new plugins have been installed (or old
1805 * ones removed) since the start of the application (or, to be precise, the
1806 * first call to gst_init()) and the application wants to make use of any
1807 * newly-installed plugins without restarting the application.
1809 * Applications should assume that the registry update is neither atomic nor
1810 * thread-safe and should therefore not have any dynamic pipelines running
1811 * (including the playbin and decodebin elements) and should also not create
1812 * any elements or access the GStreamer registry while the update is in
1815 * Note that this function may block for a significant amount of time.
1817 * Returns: %TRUE if the registry has been updated successfully (does not
1818 * imply that there were changes), otherwise %FALSE.
1821 gst_update_registry (void)
1825 #ifndef GST_DISABLE_REGISTRY
1828 res = ensure_current_registry (&err);
1830 GST_WARNING ("registry update failed: %s", err->message);
1833 GST_LOG ("registry update succeeded");
1837 GST_WARNING ("registry update failed: %s", "registry disabled");
1839 #endif /* GST_DISABLE_REGISTRY */
1841 if (_priv_gst_preload_plugins) {
1842 GST_DEBUG ("Preloading indicated plugins...");
1843 g_slist_foreach (_priv_gst_preload_plugins, load_plugin_func, NULL);
1850 * gst_registry_get_feature_list_cookie:
1851 * @registry: the registry
1853 * Returns the registry's feature list cookie. This changes
1854 * every time a feature is added or removed from the registry.
1856 * Returns: the feature list cookie.
1859 gst_registry_get_feature_list_cookie (GstRegistry * registry)
1861 g_return_val_if_fail (GST_IS_REGISTRY (registry), 0);
1863 return registry->priv->cookie;