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.
27 * @short_description: Abstract base class for management of #GstPlugin objects
28 * @see_also: #GstPlugin, #GstPluginFeature
30 * One registry holds the metadata of a set of plugins.
32 * <emphasis role="bold">Design:</emphasis>
34 * The #GstRegistry object is a list of plugins and some functions for dealing
35 * with them. Each #GstPlugin is matched 1-1 with a file on disk, and may or may
36 * not be loaded at a given time.
38 * The primary source, at all times, of plugin information is each plugin file
39 * itself. Thus, if an application wants information about a particular plugin,
40 * or wants to search for a feature that satisfies given criteria, the primary
41 * means of doing so is to load every plugin and look at the resulting
42 * information that is gathered in the default registry. Clearly, this is a time
43 * consuming process, so we cache information in the registry file. The format
44 * and location of the cache file is internal to gstreamer.
46 * On startup, plugins are searched for in the plugin search path. The following
47 * locations are checked in this order:
49 * * location from --gst-plugin-path commandline option.
50 * * the GST_PLUGIN_PATH environment variable.
51 * * the GST_PLUGIN_SYSTEM_PATH environment variable.
52 * * default locations (if GST_PLUGIN_SYSTEM_PATH is not set).
53 * Those default locations are:
54 * `$XDG_DATA_HOME/gstreamer-$GST_API_VERSION/plugins/`
55 * and `$prefix/libs/gstreamer-$GST_API_VERSION/`.
56 * [$XDG_DATA_HOME](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html) defaults to
57 * `$HOME/.local/share`.
59 * The registry cache file is loaded from
60 * `$XDG_CACHE_HOME/gstreamer-$GST_API_VERSION/registry-$ARCH.bin`
61 * (where $XDG_CACHE_HOME defaults to `$HOME/.cache`) or the file listed in the `GST_REGISTRY`
62 * env var. One reason to change the registry location is for testing.
64 * For each plugin that is found in the plugin search path, there could be 3
65 * possibilities for cached information:
67 * * the cache may not contain information about a given file.
68 * * the cache may have stale information.
69 * * the cache may have current information.
71 * In the first two cases, the plugin is loaded and the cache updated. In
72 * addition to these cases, the cache may have entries for plugins that are not
73 * relevant to the current process. These are marked as not available to the
74 * current process. If the cache is updated for whatever reason, it is marked
77 * A dirty cache is written out at the end of initialization. Each entry is
78 * checked to make sure the information is minimally valid. If not, the entry is
81 * ## Implementation notes:
83 * The "cache" and "registry" are different concepts and can represent
84 * different sets of plugins. For various reasons, at init time, the cache is
85 * stored in the default registry, and plugins not relevant to the current
86 * process are marked with the %GST_PLUGIN_FLAG_CACHED bit. These plugins are
87 * removed at the end of initialization.
93 #include "gstconfig.h"
94 #include "gst_private.h"
96 #include <sys/types.h>
106 #include <glib/gstdio.h>
109 #include "gsterror.h"
110 #include "gstregistry.h"
111 #include "gstdeviceproviderfactory.h"
113 #include "gstpluginloader.h"
115 #include <glib/gi18n-lib.h>
118 #include "glib-compat-private.h"
122 extern HMODULE _priv_gst_dll_handle;
128 /* Use a toolchain-dependent suffix on Windows */
131 # define GST_REGISTRY_FILE_SUFFIX TARGET_CPU "-msvc"
133 # define GST_REGISTRY_FILE_SUFFIX TARGET_CPU "-mingw"
136 # define GST_REGISTRY_FILE_SUFFIX TARGET_CPU
138 #define GST_REGISTRY_FILE_NAME "registry." GST_REGISTRY_FILE_SUFFIX ".bin"
141 #define GST_CAT_DEFAULT GST_CAT_REGISTRY
143 struct _GstRegistryPrivate
155 /* hash to speedup _lookup_feature_locked() */
156 GHashTable *feature_hash;
157 /* hash to speedup _lookup */
158 GHashTable *basename_hash;
160 /* updated whenever the feature list changes */
162 /* speedup for searching features */
163 GList *element_factory_list;
165 GList *typefind_factory_list;
167 GList *device_provider_factory_list;
171 /* the one instance of the default registry and the mutex protecting the
173 static GMutex _gst_registry_mutex;
174 static GstRegistry *_gst_registry_default = NULL;
177 #define DEFAULT_FORK TRUE
179 /* control the behaviour of registry rebuild */
180 static gboolean _gst_enable_registry_fork = DEFAULT_FORK;
181 /* List of plugins that need preloading/reloading after scanning registry */
182 extern GSList *_priv_gst_preload_plugins;
184 #ifndef GST_DISABLE_REGISTRY
185 /* Set to TRUE to disable registry, behaves similar to GST_DISABLE_REGISTRY */
186 gboolean _priv_gst_disable_registry = FALSE;
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_WITH_PRIVATE (GstRegistry, gst_registry, GST_TYPE_OBJECT);
218 gst_registry_class_init (GstRegistryClass * klass)
220 GObjectClass *gobject_class;
222 gobject_class = (GObjectClass *) klass;
225 * GstRegistry::plugin-added:
226 * @registry: the registry that emitted the signal
227 * @plugin: the plugin that has been added
229 * Signals that a plugin has been added to the registry (possibly
230 * replacing a previously-added one by the same name)
232 gst_registry_signals[PLUGIN_ADDED] =
233 g_signal_new ("plugin-added", G_TYPE_FROM_CLASS (klass),
234 G_SIGNAL_RUN_LAST, 0, NULL, NULL, NULL, G_TYPE_NONE, 1, GST_TYPE_PLUGIN);
237 * GstRegistry::feature-added:
238 * @registry: the registry that emitted the signal
239 * @feature: the feature that has been added
241 * Signals that a feature has been added to the registry (possibly
242 * replacing a previously-added one by the same name)
244 gst_registry_signals[FEATURE_ADDED] =
245 g_signal_new ("feature-added", G_TYPE_FROM_CLASS (klass),
246 G_SIGNAL_RUN_LAST, 0, NULL, NULL, NULL,
247 G_TYPE_NONE, 1, GST_TYPE_PLUGIN_FEATURE);
249 gobject_class->finalize = gst_registry_finalize;
253 gst_registry_init (GstRegistry * registry)
255 registry->priv = gst_registry_get_instance_private (registry);
256 registry->priv->feature_hash = g_hash_table_new (g_str_hash, g_str_equal);
257 registry->priv->basename_hash = g_hash_table_new (g_str_hash, g_str_equal);
261 gst_registry_finalize (GObject * object)
263 GstRegistry *registry = GST_REGISTRY (object);
267 plugins = registry->priv->plugins;
268 registry->priv->plugins = NULL;
269 registry->priv->n_plugins = 0;
271 GST_DEBUG_OBJECT (registry, "registry finalize");
274 GstPlugin *plugin = p->data;
277 GST_LOG_OBJECT (registry, "removing plugin %s",
278 gst_plugin_get_name (plugin));
279 gst_object_unref (plugin);
283 g_list_free (plugins);
285 features = registry->priv->features;
286 registry->priv->features = NULL;
290 GstPluginFeature *feature = f->data;
293 GST_LOG_OBJECT (registry, "removing feature %p (%s)", feature,
294 GST_OBJECT_NAME (feature));
295 gst_object_unparent (GST_OBJECT_CAST (feature));
299 g_list_free (features);
301 g_hash_table_destroy (registry->priv->feature_hash);
302 registry->priv->feature_hash = NULL;
303 g_hash_table_destroy (registry->priv->basename_hash);
304 registry->priv->basename_hash = NULL;
306 if (registry->priv->element_factory_list) {
307 GST_DEBUG_OBJECT (registry, "Cleaning up cached element factory list");
308 gst_plugin_feature_list_free (registry->priv->element_factory_list);
311 if (registry->priv->typefind_factory_list) {
312 GST_DEBUG_OBJECT (registry, "Cleaning up cached typefind factory list");
313 gst_plugin_feature_list_free (registry->priv->typefind_factory_list);
316 if (registry->priv->device_provider_factory_list) {
317 GST_DEBUG_OBJECT (registry,
318 "Cleaning up cached device provider factory list");
319 gst_plugin_feature_list_free (registry->priv->device_provider_factory_list);
322 G_OBJECT_CLASS (parent_class)->finalize (object);
328 * Retrieves the singleton plugin registry. The caller does not own a
329 * reference on the registry, as it is alive as long as GStreamer is
332 * Returns: (transfer none): the #GstRegistry.
335 gst_registry_get (void)
337 GstRegistry *registry;
339 g_mutex_lock (&_gst_registry_mutex);
340 if (G_UNLIKELY (!_gst_registry_default)) {
341 _gst_registry_default = g_object_new (GST_TYPE_REGISTRY, NULL);
342 gst_object_ref_sink (GST_OBJECT_CAST (_gst_registry_default));
344 registry = _gst_registry_default;
345 g_mutex_unlock (&_gst_registry_mutex);
352 * gst_registry_add_path:
353 * @registry: the registry to add the path to
354 * @path: the path to add to the registry
356 * Add the given path to the registry. The syntax of the
357 * path is specific to the registry. If the path has already been
361 gst_registry_add_path (GstRegistry * registry, const gchar * path)
363 g_return_if_fail (GST_IS_REGISTRY (registry));
364 g_return_if_fail (path != NULL);
366 if (strlen (path) == 0)
369 GST_OBJECT_LOCK (registry);
370 if (g_list_find_custom (registry->priv->paths, path, (GCompareFunc) strcmp))
373 GST_INFO ("Adding plugin path: \"%s\"", path);
374 registry->priv->paths =
375 g_list_append (registry->priv->paths, g_strdup (path));
376 GST_OBJECT_UNLOCK (registry);
382 GST_INFO ("Ignoring empty plugin path");
387 g_warning ("path %s already added to registry", path);
388 GST_OBJECT_UNLOCK (registry);
394 * gst_registry_get_path_list:
395 * @registry: the registry to get the pathlist of
397 * Get the list of paths for the given registry.
399 * Returns: (transfer container) (element-type filename): A #GList of
400 * paths as strings. g_list_free after use.
405 gst_registry_get_path_list (GstRegistry * registry)
409 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
411 GST_OBJECT_LOCK (registry);
412 /* We don't need to copy the strings, because they won't be deleted
413 * as long as the GstRegistry is around */
414 list = g_list_copy (registry->priv->paths);
415 GST_OBJECT_UNLOCK (registry);
422 * gst_registry_add_plugin:
423 * @registry: the registry to add the plugin to
424 * @plugin: (transfer floating): the plugin to add
426 * Add the plugin to the registry. The plugin-added signal will be emitted.
428 * @plugin's reference count will be incremented, and any floating
429 * reference will be removed (see gst_object_ref_sink())
431 * Returns: %TRUE on success.
436 gst_registry_add_plugin (GstRegistry * registry, GstPlugin * plugin)
438 GstPlugin *existing_plugin;
440 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
441 g_return_val_if_fail (GST_IS_PLUGIN (plugin), FALSE);
443 GST_OBJECT_LOCK (registry);
444 if (G_LIKELY (plugin->basename)) {
445 /* we have a basename, see if we find the plugin */
447 gst_registry_lookup_bn_locked (registry, plugin->basename);
448 if (existing_plugin) {
449 GST_DEBUG_OBJECT (registry,
450 "Replacing existing plugin \"%s\" %p with new plugin %p for filename \"%s\"",
451 GST_STR_NULL (existing_plugin->filename), existing_plugin, plugin,
452 GST_STR_NULL (plugin->filename));
453 /* If the new plugin is blacklisted and the existing one isn't cached, do not
454 * accept if it's from a different location than the existing one */
455 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED) &&
456 strcmp (plugin->filename, existing_plugin->filename)) {
457 GST_WARNING_OBJECT (registry,
458 "Not replacing plugin because new one (%s) is blacklisted but for a different location than existing one (%s)",
459 plugin->filename, existing_plugin->filename);
460 /* Keep reference counting consistent */
461 gst_object_ref_sink (plugin);
462 gst_object_unref (plugin);
463 GST_OBJECT_UNLOCK (registry);
466 registry->priv->plugins =
467 g_list_remove (registry->priv->plugins, existing_plugin);
468 --registry->priv->n_plugins;
469 if (G_LIKELY (existing_plugin->basename))
470 g_hash_table_remove (registry->priv->basename_hash,
471 existing_plugin->basename);
472 gst_object_unref (existing_plugin);
476 GST_DEBUG_OBJECT (registry, "adding plugin %p for filename \"%s\"",
477 plugin, GST_STR_NULL (plugin->filename));
479 registry->priv->plugins = g_list_prepend (registry->priv->plugins, plugin);
480 ++registry->priv->n_plugins;
482 if (G_LIKELY (plugin->basename))
483 g_hash_table_replace (registry->priv->basename_hash, plugin->basename,
486 gst_object_ref_sink (plugin);
487 GST_OBJECT_UNLOCK (registry);
489 GST_LOG_OBJECT (registry, "emitting plugin-added for filename \"%s\"",
490 GST_STR_NULL (plugin->filename));
491 g_signal_emit (registry, gst_registry_signals[PLUGIN_ADDED], 0, plugin);
497 gst_registry_remove_features_for_plugin_unlocked (GstRegistry * registry,
502 g_return_if_fail (GST_IS_REGISTRY (registry));
503 g_return_if_fail (GST_IS_PLUGIN (plugin));
505 /* Remove all features for this plugin */
506 f = registry->priv->features;
508 GList *next = g_list_next (f);
509 GstPluginFeature *feature = f->data;
511 if (G_UNLIKELY (feature && feature->plugin == plugin)) {
512 GST_DEBUG_OBJECT (registry, "removing feature %p (%s) for plugin %p (%s)",
513 feature, gst_plugin_feature_get_name (feature), plugin,
516 registry->priv->features =
517 g_list_delete_link (registry->priv->features, f);
518 g_hash_table_remove (registry->priv->feature_hash,
519 GST_OBJECT_NAME (feature));
520 gst_object_unparent (GST_OBJECT_CAST (feature));
524 registry->priv->cookie++;
528 * gst_registry_remove_plugin:
529 * @registry: the registry to remove the plugin from
530 * @plugin: (transfer none): the plugin to remove
532 * Remove the plugin from the registry.
537 gst_registry_remove_plugin (GstRegistry * registry, GstPlugin * plugin)
539 g_return_if_fail (GST_IS_REGISTRY (registry));
540 g_return_if_fail (GST_IS_PLUGIN (plugin));
542 GST_DEBUG_OBJECT (registry, "removing plugin %p (%s)",
543 plugin, gst_plugin_get_name (plugin));
545 GST_OBJECT_LOCK (registry);
546 registry->priv->plugins = g_list_remove (registry->priv->plugins, plugin);
547 --registry->priv->n_plugins;
548 if (G_LIKELY (plugin->basename))
549 g_hash_table_remove (registry->priv->basename_hash, plugin->basename);
550 gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
551 GST_OBJECT_UNLOCK (registry);
552 gst_object_unref (plugin);
556 * gst_registry_add_feature:
557 * @registry: the registry to add the plugin to
558 * @feature: (transfer floating): the feature to add
560 * Add the feature to the registry. The feature-added signal will be emitted.
562 * @feature's reference count will be incremented, and any floating
563 * reference will be removed (see gst_object_ref_sink())
565 * Returns: %TRUE on success.
570 gst_registry_add_feature (GstRegistry * registry, GstPluginFeature * feature)
572 GstPluginFeature *existing_feature;
574 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
575 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
576 g_return_val_if_fail (GST_OBJECT_NAME (feature) != NULL, FALSE);
577 g_return_val_if_fail (feature->plugin_name != NULL, FALSE);
579 GST_OBJECT_LOCK (registry);
580 existing_feature = gst_registry_lookup_feature_locked (registry,
581 GST_OBJECT_NAME (feature));
582 if (G_UNLIKELY (existing_feature)) {
583 GST_DEBUG_OBJECT (registry, "replacing existing feature %p (%s)",
584 existing_feature, GST_OBJECT_NAME (feature));
585 /* Remove the existing feature from the list now, before we insert the new
586 * one, but don't unref yet because the hash is still storing a reference to
588 registry->priv->features =
589 g_list_remove (registry->priv->features, existing_feature);
592 GST_DEBUG_OBJECT (registry, "adding feature %p (%s)", feature,
593 GST_OBJECT_NAME (feature));
595 registry->priv->features = g_list_prepend (registry->priv->features, feature);
596 g_hash_table_replace (registry->priv->feature_hash, GST_OBJECT_NAME (feature),
599 if (G_UNLIKELY (existing_feature)) {
600 /* We unref now. No need to remove the feature name from the hash table, it
601 * got replaced by the new feature */
602 gst_object_unparent (GST_OBJECT_CAST (existing_feature));
605 gst_object_set_parent (GST_OBJECT_CAST (feature), GST_OBJECT_CAST (registry));
607 registry->priv->cookie++;
608 GST_OBJECT_UNLOCK (registry);
610 GST_LOG_OBJECT (registry, "emitting feature-added for %s",
611 GST_OBJECT_NAME (feature));
612 g_signal_emit (registry, gst_registry_signals[FEATURE_ADDED], 0, feature);
618 * gst_registry_remove_feature:
619 * @registry: the registry to remove the feature from
620 * @feature: (transfer none): the feature to remove
622 * Remove the feature from the registry.
627 gst_registry_remove_feature (GstRegistry * registry, GstPluginFeature * feature)
629 g_return_if_fail (GST_IS_REGISTRY (registry));
630 g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
632 GST_DEBUG_OBJECT (registry, "removing feature %p (%s)",
633 feature, gst_plugin_feature_get_name (feature));
635 GST_OBJECT_LOCK (registry);
636 registry->priv->features = g_list_remove (registry->priv->features, feature);
637 g_hash_table_remove (registry->priv->feature_hash, GST_OBJECT_NAME (feature));
638 registry->priv->cookie++;
639 GST_OBJECT_UNLOCK (registry);
641 gst_object_unparent ((GstObject *) feature);
645 * gst_registry_plugin_filter:
646 * @registry: registry to query
647 * @filter: (scope call): the filter to use
648 * @first: only return first match
649 * @user_data: (closure): user data passed to the filter function
651 * Runs a filter against all plugins in the registry and returns a #GList with
652 * the results. If the first flag is set, only the first match is
653 * returned (as a list with a single object).
654 * Every plugin is reffed; use gst_plugin_list_free() after use, which
657 * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
658 * Use gst_plugin_list_free() after usage.
663 gst_registry_plugin_filter (GstRegistry * registry,
664 GstPluginFilter filter, gboolean first, gpointer user_data)
667 GList *walk, *list = NULL;
670 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
672 GST_OBJECT_LOCK (registry);
673 n_plugins = registry->priv->n_plugins;
674 plugins = g_newa (GstPlugin *, n_plugins + 1);
675 for (walk = registry->priv->plugins, i = 0; walk != NULL; walk = walk->next)
676 plugins[i++] = gst_object_ref (walk->data);
677 GST_OBJECT_UNLOCK (registry);
679 for (i = 0; i < n_plugins; ++i) {
680 if (filter == NULL || filter (plugins[i], user_data)) {
681 list = g_list_prepend (list, gst_object_ref (plugins[i]));
688 for (i = 0; i < n_plugins; ++i)
689 gst_object_unref (plugins[i]);
701 gst_plugin_feature_type_name_filter (GstPluginFeature * feature,
702 GstTypeNameData * data)
704 g_assert (GST_IS_PLUGIN_FEATURE (feature));
706 return ((data->type == G_TYPE_INVALID
707 || data->type == G_OBJECT_TYPE (feature)) && (data->name == NULL
708 || !strcmp (data->name, GST_OBJECT_NAME (feature))));
711 /* returns TRUE if the list was changed
713 * Must be called with the object lock taken */
715 gst_registry_get_feature_list_or_create (GstRegistry * registry,
716 GList ** previous, guint32 * cookie, GType type)
718 gboolean res = FALSE;
719 GstRegistryPrivate *priv = registry->priv;
721 if (G_UNLIKELY (!*previous || priv->cookie != *cookie)) {
722 GstTypeNameData data;
726 gst_plugin_feature_list_free (*previous);
733 for (walk = registry->priv->features; walk != NULL; walk = walk->next) {
734 GstPluginFeature *feature = walk->data;
736 if (gst_plugin_feature_type_name_filter (feature, &data)) {
737 *previous = g_list_prepend (*previous, gst_object_ref (feature));
741 *cookie = priv->cookie;
749 type_find_factory_rank_cmp (const GstPluginFeature * fac1,
750 const GstPluginFeature * fac2)
752 if (G_LIKELY (fac1->rank != fac2->rank))
753 return fac2->rank - fac1->rank;
755 /* to make the order in which things happen more deterministic,
756 * sort by name when the ranks are the same. */
757 return strcmp (GST_OBJECT_NAME (fac1), GST_OBJECT_NAME (fac2));
761 gst_registry_get_element_factory_list (GstRegistry * registry)
765 GST_OBJECT_LOCK (registry);
767 gst_registry_get_feature_list_or_create (registry,
768 ®istry->priv->element_factory_list, ®istry->priv->efl_cookie,
769 GST_TYPE_ELEMENT_FACTORY);
771 /* Return reffed copy */
772 list = gst_plugin_feature_list_copy (registry->priv->element_factory_list);
774 GST_OBJECT_UNLOCK (registry);
780 gst_registry_get_typefind_factory_list (GstRegistry * registry)
784 GST_OBJECT_LOCK (registry);
786 if (G_UNLIKELY (gst_registry_get_feature_list_or_create (registry,
787 ®istry->priv->typefind_factory_list,
788 ®istry->priv->tfl_cookie, GST_TYPE_TYPE_FIND_FACTORY)))
789 registry->priv->typefind_factory_list =
790 g_list_sort (registry->priv->typefind_factory_list,
791 (GCompareFunc) type_find_factory_rank_cmp);
793 /* Return reffed copy */
794 list = gst_plugin_feature_list_copy (registry->priv->typefind_factory_list);
796 GST_OBJECT_UNLOCK (registry);
803 gst_registry_get_device_provider_factory_list (GstRegistry * registry)
807 GST_OBJECT_LOCK (registry);
809 gst_registry_get_feature_list_or_create (registry,
810 ®istry->priv->device_provider_factory_list,
811 ®istry->priv->dmfl_cookie, GST_TYPE_DEVICE_PROVIDER_FACTORY);
813 /* Return reffed copy */
815 gst_plugin_feature_list_copy (registry->
816 priv->device_provider_factory_list);
818 GST_OBJECT_UNLOCK (registry);
824 * gst_registry_feature_filter:
825 * @registry: registry to query
826 * @filter: (scope call): the filter to use
827 * @first: only return first match
828 * @user_data: (closure): user data passed to the filter function
830 * Runs a filter against all features of the plugins in the registry
831 * and returns a GList with the results.
832 * If the first flag is set, only the first match is
833 * returned (as a list with a single object).
835 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
836 * #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
841 gst_registry_feature_filter (GstRegistry * registry,
842 GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
844 GstPluginFeature **features;
845 GList *walk, *list = NULL;
848 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
850 GST_OBJECT_LOCK (registry);
851 n_features = g_hash_table_size (registry->priv->feature_hash);
852 features = g_newa (GstPluginFeature *, n_features + 1);
853 for (walk = registry->priv->features, i = 0; walk != NULL; walk = walk->next)
854 features[i++] = gst_object_ref (walk->data);
855 GST_OBJECT_UNLOCK (registry);
857 for (i = 0; i < n_features; ++i) {
858 if (filter == NULL || filter (features[i], user_data)) {
859 list = g_list_prepend (list, gst_object_ref (features[i]));
866 for (i = 0; i < n_features; ++i)
867 gst_object_unref (features[i]);
873 gst_registry_plugin_name_filter (GstPlugin * plugin, const gchar * name)
875 return (plugin->desc.name && !strcmp (plugin->desc.name, name));
879 * gst_registry_find_plugin:
880 * @registry: the registry to search
881 * @name: the plugin name to find
883 * Find the plugin with the given name in the registry.
884 * The plugin will be reffed; caller is responsible for unreffing.
886 * Returns: (transfer full) (nullable): the plugin with the given name
887 * or %NULL if the plugin was not found. gst_object_unref() after
893 gst_registry_find_plugin (GstRegistry * registry, const gchar * name)
896 GstPlugin *result = NULL;
898 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
899 g_return_val_if_fail (name != NULL, NULL);
901 walk = gst_registry_plugin_filter (registry,
902 (GstPluginFilter) gst_registry_plugin_name_filter, TRUE, (gpointer) name);
904 result = GST_PLUGIN_CAST (walk->data);
906 gst_object_ref (result);
907 gst_plugin_list_free (walk);
914 * gst_registry_find_feature:
915 * @registry: the registry to search
916 * @name: the pluginfeature name to find
917 * @type: the pluginfeature type to find
919 * Find the pluginfeature with the given name and type in the registry.
921 * Returns: (transfer full) (nullable): the pluginfeature with the
922 * given name and type or %NULL if the plugin was not
923 * found. gst_object_unref() after usage.
928 gst_registry_find_feature (GstRegistry * registry, const gchar * name,
931 GstPluginFeature *feature = NULL;
933 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
934 g_return_val_if_fail (name != NULL, NULL);
935 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
937 feature = gst_registry_lookup_feature (registry, name);
938 if (feature && !g_type_is_a (G_TYPE_FROM_INSTANCE (feature), type)) {
939 gst_object_unref (feature);
947 * gst_registry_get_feature_list:
948 * @registry: a #GstRegistry
951 * Retrieves a #GList of #GstPluginFeature of @type.
953 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
954 * #GstPluginFeature of @type. Use gst_plugin_feature_list_free() after use
959 gst_registry_get_feature_list (GstRegistry * registry, GType type)
961 GstTypeNameData data;
963 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
964 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
967 if (type == GST_TYPE_ELEMENT_FACTORY)
968 return gst_registry_get_element_factory_list (registry);
969 else if (type == GST_TYPE_TYPE_FIND_FACTORY)
970 return gst_registry_get_typefind_factory_list (registry);
971 else if (type == GST_TYPE_DEVICE_PROVIDER_FACTORY)
972 return gst_registry_get_device_provider_factory_list (registry);
977 return gst_registry_feature_filter (registry,
978 (GstPluginFeatureFilter) gst_plugin_feature_type_name_filter,
983 * gst_registry_get_plugin_list:
984 * @registry: the registry to search
986 * Get a copy of all plugins registered in the given registry. The refcount
987 * of each element in the list in incremented.
989 * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
990 * Use gst_plugin_list_free() after usage.
995 gst_registry_get_plugin_list (GstRegistry * registry)
1000 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1002 GST_OBJECT_LOCK (registry);
1003 list = g_list_copy (registry->priv->plugins);
1004 for (g = list; g; g = g->next) {
1005 gst_object_ref (GST_PLUGIN_CAST (g->data));
1007 GST_OBJECT_UNLOCK (registry);
1012 static GstPluginFeature *
1013 gst_registry_lookup_feature_locked (GstRegistry * registry, const char *name)
1015 return g_hash_table_lookup (registry->priv->feature_hash, name);
1019 * gst_registry_lookup_feature:
1020 * @registry: a #GstRegistry
1021 * @name: a #GstPluginFeature name
1023 * Find a #GstPluginFeature with @name in @registry.
1025 * Returns: (transfer full) (nullable): a #GstPluginFeature with its refcount incremented,
1026 * use gst_object_unref() after usage.
1031 gst_registry_lookup_feature (GstRegistry * registry, const char *name)
1033 GstPluginFeature *feature;
1035 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1036 g_return_val_if_fail (name != NULL, NULL);
1038 GST_OBJECT_LOCK (registry);
1039 feature = gst_registry_lookup_feature_locked (registry, name);
1041 gst_object_ref (feature);
1042 GST_OBJECT_UNLOCK (registry);
1048 gst_registry_lookup_bn_locked (GstRegistry * registry, const char *basename)
1050 return g_hash_table_lookup (registry->priv->basename_hash, basename);
1054 gst_registry_lookup_bn (GstRegistry * registry, const char *basename)
1058 GST_OBJECT_LOCK (registry);
1059 plugin = gst_registry_lookup_bn_locked (registry, basename);
1061 gst_object_ref (plugin);
1062 GST_OBJECT_UNLOCK (registry);
1068 * gst_registry_lookup:
1069 * @registry: the registry to look up in
1070 * @filename: the name of the file to look up
1072 * Look up a plugin in the given registry with the given filename.
1073 * If found, plugin is reffed.
1075 * Returns: (transfer full) (nullable): the #GstPlugin if found, or
1076 * %NULL if not. gst_object_unref() after usage.
1079 gst_registry_lookup (GstRegistry * registry, const char *filename)
1084 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1085 g_return_val_if_fail (filename != NULL, NULL);
1087 basename = g_path_get_basename (filename);
1088 if (G_UNLIKELY (basename == NULL))
1091 plugin = gst_registry_lookup_bn (registry, basename);
1100 REGISTRY_SCAN_HELPER_NOT_STARTED = 0,
1101 REGISTRY_SCAN_HELPER_DISABLED,
1102 REGISTRY_SCAN_HELPER_RUNNING
1103 } GstRegistryScanHelperState;
1107 GstRegistry *registry;
1108 GstRegistryScanHelperState helper_state;
1109 GstPluginLoader *helper;
1111 } GstRegistryScanContext;
1114 init_scan_context (GstRegistryScanContext * context, GstRegistry * registry)
1118 context->registry = registry;
1120 /* see if forking is enabled and set up the scan helper state accordingly */
1121 do_fork = _gst_enable_registry_fork;
1123 const gchar *fork_env;
1125 /* forking enabled, see if it is disabled with an env var */
1126 if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) {
1127 /* fork enabled for any value different from "no" */
1128 do_fork = strcmp (fork_env, "no") != 0;
1133 context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1135 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1137 context->helper = NULL;
1138 context->changed = FALSE;
1142 clear_scan_context (GstRegistryScanContext * context)
1144 if (context->helper) {
1145 context->changed |= _priv_gst_plugin_loader_funcs.destroy (context->helper);
1146 context->helper = NULL;
1151 gst_registry_scan_plugin_file (GstRegistryScanContext * context,
1152 const gchar * filename, off_t file_size, time_t file_mtime)
1154 gboolean changed = FALSE;
1155 GstPlugin *newplugin = NULL;
1158 /* Disable external plugin loader on Windows until it is ported properly. */
1159 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1163 /* Have a plugin to load - see if the scan-helper needs starting */
1164 if (context->helper_state == REGISTRY_SCAN_HELPER_NOT_STARTED) {
1165 GST_DEBUG ("Starting plugin scanner for file %s", filename);
1166 context->helper = _priv_gst_plugin_loader_funcs.create (context->registry);
1167 if (context->helper != NULL)
1168 context->helper_state = REGISTRY_SCAN_HELPER_RUNNING;
1170 GST_WARNING ("Failed starting plugin scanner. Scanning in-process");
1171 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1175 if (context->helper_state == REGISTRY_SCAN_HELPER_RUNNING) {
1176 GST_DEBUG ("Using scan-helper to load plugin %s", filename);
1177 if (!_priv_gst_plugin_loader_funcs.load (context->helper,
1178 filename, file_size, file_mtime)) {
1179 g_warning ("External plugin loader failed. This most likely means that "
1180 "the plugin loader helper binary was not found or could not be run. "
1181 "You might need to set the GST_PLUGIN_SCANNER environment variable "
1182 "if your setup is unusual. This should normally not be required "
1184 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1188 /* Check if the helper is disabled (or just got disabled above) */
1189 if (context->helper_state == REGISTRY_SCAN_HELPER_DISABLED) {
1190 /* Load plugin the old fashioned way... */
1192 /* We don't use a GError here because a failure to load some shared
1193 * objects as plugins is normal (particularly in the development environment case)
1195 newplugin = _priv_gst_plugin_load_file_for_registry (filename,
1196 context->registry, NULL);
1200 GST_DEBUG_OBJECT (context->registry, "marking new plugin %p as registered",
1202 newplugin->registered = TRUE;
1203 gst_object_unref (newplugin);
1206 #ifndef GST_DISABLE_REGISTRY
1207 if (!__registry_reuse_plugin_scanner) {
1208 clear_scan_context (context);
1209 context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1217 skip_directory (const gchar * parent_path, const gchar * dirent)
1219 const gchar *target;
1221 /* hotdoc private folder can contain many files and it slows down
1222 * the discovery for nothing */
1223 if (g_str_has_prefix (dirent, "hotdoc-private-"))
1226 /* gst-integration-testsuites can end up with many log files */
1227 if (strcmp (dirent, "gst-integration-testsuites") == 0)
1230 /* Rust build dirs which may contain artefacts we should skip, can be
1231 * /target/{debug,release} or /target/{arch}/{debug,release} */
1232 target = strstr (parent_path, "/target/");
1234 /* On Windows both forward and backward slashes may be used */
1237 target = strstr (parent_path, "\\target\\");
1240 if (target != NULL) {
1241 if (g_str_has_suffix (target + 7, "/debug")
1243 || g_str_has_suffix (target + 7, "\\debug")
1244 || g_str_has_suffix (target + 7, "\\release")
1246 || g_str_has_suffix (target + 7, "/release")) {
1247 if (dirent[0] == '.'
1248 || strcmp (dirent, "build") == 0
1249 || strcmp (dirent, "deps") == 0
1250 || strcmp (dirent, "incremental") == 0) {
1256 if (G_LIKELY (dirent[0] != '.'))
1259 /* skip the .debug directory, these contain elf files that are not
1260 * useful or worse, can crash dlopen () */
1261 if (strcmp (dirent, ".debug") == 0)
1264 /* can also skip .git and .deps dirs, those won't contain useful files.
1265 * This speeds up scanning a bit in development environment setups. */
1266 if (strcmp (dirent, ".git") == 0 || strcmp (dirent, ".deps") == 0)
1273 gst_registry_scan_path_level (GstRegistryScanContext * context,
1274 const gchar * path, int level)
1277 const gchar *dirent;
1280 gboolean changed = FALSE;
1282 dir = g_dir_open (path, 0, NULL);
1286 while ((dirent = g_dir_read_name (dir))) {
1287 GStatBuf file_status;
1289 filename = g_build_filename (path, dirent, NULL);
1290 if (g_stat (filename, &file_status) < 0) {
1291 /* Plugin will be removed from cache after the scan completes if it
1292 * is still marked 'cached' */
1297 if (file_status.st_mode & S_IFDIR) {
1298 if (G_UNLIKELY (skip_directory (path, dirent))) {
1299 GST_TRACE_OBJECT (context->registry, "ignoring %s directory", dirent);
1303 /* FIXME 2.0: Don't recurse into directories, this behaviour
1304 * is inconsistent with other PATH environment variables
1307 GST_LOG_OBJECT (context->registry, "recursing into directory %s",
1309 changed |= gst_registry_scan_path_level (context, filename, level - 1);
1311 GST_LOG_OBJECT (context->registry, "not recursing into directory %s, "
1312 "recursion level too deep", filename);
1317 if (!(file_status.st_mode & S_IFREG)) {
1318 GST_TRACE_OBJECT (context->registry, "%s is not a regular file, ignoring",
1323 if (!g_str_has_suffix (dirent, "." G_MODULE_SUFFIX)
1324 #ifdef GST_EXTRA_MODULE_SUFFIX
1325 && !g_str_has_suffix (dirent, GST_EXTRA_MODULE_SUFFIX)
1328 GST_TRACE_OBJECT (context->registry,
1329 "extension is not recognized as module file, ignoring file %s",
1335 GST_LOG_OBJECT (context->registry, "file %s looks like a possible module",
1338 /* try to avoid unnecessary plugin-move pain */
1339 if (g_str_has_prefix (dirent, "libgstvalve") ||
1340 g_str_has_prefix (dirent, "libgstselector")) {
1341 GST_WARNING_OBJECT (context->registry, "ignoring old plugin %s which "
1342 "has been merged into the corelements plugin", filename);
1343 /* Plugin will be removed from cache after the scan completes if it
1344 * is still marked 'cached' */
1349 /* plug-ins are considered unique by basename; if the given name
1350 * was already seen by the registry, we ignore it */
1351 plugin = gst_registry_lookup_bn (context->registry, dirent);
1353 gboolean env_vars_changed, deps_changed = FALSE;
1355 if (plugin->registered) {
1356 GST_DEBUG_OBJECT (context->registry,
1357 "plugin already registered from path \"%s\"",
1358 GST_STR_NULL (plugin->filename));
1360 gst_object_unref (plugin);
1364 env_vars_changed = _priv_plugin_deps_env_vars_changed (plugin);
1366 /* If a file with a certain basename is seen on a different path,
1367 * update the plugin to ensure the registry cache will reflect up
1368 * to date information */
1370 if (plugin->file_mtime == file_status.st_mtime &&
1371 plugin->file_size == file_status.st_size && !env_vars_changed &&
1372 !(deps_changed = _priv_plugin_deps_files_changed (plugin)) &&
1373 !strcmp (plugin->filename, filename)) {
1374 GST_LOG_OBJECT (context->registry, "file %s cached", filename);
1375 GST_OBJECT_FLAG_UNSET (plugin, GST_PLUGIN_FLAG_CACHED);
1376 GST_LOG_OBJECT (context->registry,
1377 "marking plugin %p as registered as %s", plugin, filename);
1378 plugin->registered = TRUE;
1380 GST_INFO_OBJECT (context->registry, "cached info for %s is stale",
1382 GST_DEBUG_OBJECT (context->registry, "mtime %" G_GINT64_FORMAT " != %"
1383 G_GINT64_FORMAT " or size %" G_GINT64_FORMAT " != %"
1384 G_GINT64_FORMAT " or external dependency env_vars changed: %d or"
1385 " external dependencies changed: %d or old path %s != new path %s",
1386 (gint64) plugin->file_mtime, (gint64) file_status.st_mtime,
1387 (gint64) plugin->file_size, (gint64) file_status.st_size,
1388 env_vars_changed, deps_changed, plugin->filename, filename);
1389 gst_registry_remove_plugin (context->registry, plugin);
1390 changed |= gst_registry_scan_plugin_file (context, filename,
1391 file_status.st_size, file_status.st_mtime);
1393 gst_object_unref (plugin);
1396 GST_DEBUG_OBJECT (context->registry, "file %s not yet in registry",
1398 changed |= gst_registry_scan_plugin_file (context, filename,
1399 file_status.st_size, file_status.st_mtime);
1411 gst_registry_scan_path_internal (GstRegistryScanContext * context,
1416 GST_DEBUG_OBJECT (context->registry, "scanning path %s", path);
1417 changed = gst_registry_scan_path_level (context, path, 10);
1419 GST_DEBUG_OBJECT (context->registry, "registry changed in path %s: %d", path,
1425 * gst_registry_scan_path:
1426 * @registry: the registry to add found plugins to
1427 * @path: (type filename): the path to scan
1429 * Scan the given path for plugins to add to the registry. The syntax of the
1430 * path is specific to the registry.
1432 * Returns: %TRUE if registry changed
1435 gst_registry_scan_path (GstRegistry * registry, const gchar * path)
1437 GstRegistryScanContext context;
1440 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1441 g_return_val_if_fail (path != NULL, FALSE);
1443 init_scan_context (&context, registry);
1445 result = gst_registry_scan_path_internal (&context, path);
1447 clear_scan_context (&context);
1448 result |= context.changed;
1454 _gst_plugin_feature_filter_plugin_name (GstPluginFeature * feature,
1457 return (strcmp (feature->plugin_name, (gchar *) user_data) == 0);
1461 * gst_registry_get_feature_list_by_plugin:
1462 * @registry: a #GstRegistry.
1463 * @name: a plugin name.
1465 * Retrieves a #GList of features of the plugin with name @name.
1467 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
1468 * #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
1471 gst_registry_get_feature_list_by_plugin (GstRegistry * registry,
1474 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1475 g_return_val_if_fail (name != NULL, NULL);
1477 return gst_registry_feature_filter (registry,
1478 _gst_plugin_feature_filter_plugin_name, FALSE, (gpointer) name);
1481 /* Private function for getting plugin features directly */
1483 _priv_plugin_get_features (GstRegistry * registry, GstPlugin * plugin)
1488 GST_OBJECT_LOCK (registry);
1489 for (walk = registry->priv->features; walk; walk = walk->next) {
1490 GstPluginFeature *feat = (GstPluginFeature *) walk->data;
1491 if (feat->plugin == plugin)
1492 res = g_list_prepend (res, gst_object_ref (feat));
1494 GST_OBJECT_UNLOCK (registry);
1499 /* Unref and delete the default registry */
1501 _priv_gst_registry_cleanup (void)
1503 GstRegistry *registry;
1505 g_mutex_lock (&_gst_registry_mutex);
1506 if ((registry = _gst_registry_default) != NULL) {
1507 _gst_registry_default = NULL;
1509 g_mutex_unlock (&_gst_registry_mutex);
1511 /* unref outside of the lock because we can. */
1513 gst_object_unref (registry);
1517 * gst_registry_check_feature_version:
1518 * @registry: a #GstRegistry
1519 * @feature_name: the name of the feature (e.g. "oggdemux")
1520 * @min_major: the minimum major version number
1521 * @min_minor: the minimum minor version number
1522 * @min_micro: the minimum micro version number
1524 * Checks whether a plugin feature by the given name exists in
1525 * @registry and whether its version is at least the
1528 * Returns: %TRUE if the feature could be found and the version is
1529 * the same as the required version or newer, and %FALSE otherwise.
1532 gst_registry_check_feature_version (GstRegistry * registry,
1533 const gchar * feature_name, guint min_major, guint min_minor,
1536 GstPluginFeature *feature;
1537 gboolean ret = FALSE;
1539 g_return_val_if_fail (feature_name != NULL, FALSE);
1541 GST_DEBUG ("Looking up plugin feature '%s'", feature_name);
1543 feature = gst_registry_lookup_feature (registry, feature_name);
1545 ret = gst_plugin_feature_check_version (feature, min_major, min_minor,
1547 gst_object_unref (feature);
1549 GST_DEBUG ("Could not find plugin feature '%s'", feature_name);
1556 load_plugin_func (gpointer data, gpointer user_data)
1559 const gchar *filename;
1562 filename = (const gchar *) data;
1563 GST_DEBUG ("Pre-loading plugin %s", filename);
1565 plugin = gst_plugin_load_file (filename, &err);
1568 GST_INFO ("Loaded plugin: \"%s\"", filename);
1570 gst_registry_add_plugin (gst_registry_get (), plugin);
1573 /* Report error to user, and free error */
1574 GST_ERROR ("Failed to load plugin: %s", err->message);
1577 GST_WARNING ("Failed to load plugin: \"%s\"", filename);
1583 priv_gst_get_relocated_libgstreamer (void)
1591 GST_DEBUG ("attempting to retrieve libgstreamer-1.0 location using "
1592 "Win32-specific method");
1595 g_win32_get_package_installation_directory_of_module
1596 (_priv_gst_dll_handle);
1600 dir = g_build_filename (base_dir, GST_PLUGIN_SUBDIR, NULL);
1601 GST_DEBUG ("using DLL dir %s", dir);
1605 #elif defined(HAVE_DLADDR)
1609 GST_DEBUG ("attempting to retrieve libgstreamer-1.0 location using "
1612 if (dladdr (&gst_init, &info)) {
1613 GST_LOG ("dli_fname: %s", info.dli_fname);
1615 if (!info.dli_fname) {
1619 dir = g_path_get_dirname (info.dli_fname);
1621 GST_LOG ("dladdr() failed");
1626 #warning "Unsupported platform for retrieving the current location of a shared library."
1627 #warning "Relocatable builds will not work."
1628 GST_WARNING ("Don't know how to retrieve the location of the shared "
1629 "library libgstreamer-" GST_API_VERSION);
1635 #ifndef GST_DISABLE_REGISTRY
1636 /* Unref all plugins marked 'cached', to clear old plugins that no
1637 * longer exist. Returns %TRUE if any plugins were removed */
1639 gst_registry_remove_cache_plugins (GstRegistry * registry)
1644 gboolean changed = FALSE;
1646 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1648 GST_OBJECT_LOCK (registry);
1650 GST_DEBUG_OBJECT (registry, "removing cached plugins");
1651 g = registry->priv->plugins;
1655 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_CACHED)) {
1656 GST_DEBUG_OBJECT (registry, "removing cached plugin \"%s\"",
1657 GST_STR_NULL (plugin->filename));
1658 registry->priv->plugins = g_list_delete_link (registry->priv->plugins, g);
1659 --registry->priv->n_plugins;
1660 if (G_LIKELY (plugin->basename))
1661 g_hash_table_remove (registry->priv->basename_hash, plugin->basename);
1662 gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
1663 gst_object_unref (plugin);
1669 GST_OBJECT_UNLOCK (registry);
1676 REGISTRY_SCAN_AND_UPDATE_FAILURE = 0,
1677 REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED,
1678 REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED
1679 } GstRegistryScanAndUpdateResult;
1682 * scan_and_update_registry:
1683 * @default_registry: the #GstRegistry
1684 * @registry_file: registry filename
1685 * @write_changes: write registry if it has changed?
1687 * Scans for registry changes and eventually updates the registry cache.
1689 * Return: %REGISTRY_SCAN_AND_UPDATE_FAILURE if the registry could not scanned
1690 * or updated, %REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED if the
1691 * registry is clean and %REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED if
1692 * it has been updated and the cache needs to be re-read.
1694 static GstRegistryScanAndUpdateResult
1695 scan_and_update_registry (GstRegistry * default_registry,
1696 const gchar * registry_file, gboolean write_changes, GError ** error)
1698 const gchar *plugin_path;
1699 gboolean changed = FALSE;
1701 GstRegistryScanContext context;
1703 GST_INFO ("Validating plugins from registry cache: %s", registry_file);
1705 init_scan_context (&context, default_registry);
1707 /* It sounds tempting to just compare the mtime of directories with the mtime
1708 * of the registry cache, but it does not work. It would not catch updated
1709 * plugins, which might bring more or less features.
1712 /* scan paths specified via --gst-plugin-path */
1713 GST_DEBUG ("scanning paths added via --gst-plugin-path");
1714 for (l = _priv_gst_plugin_paths; l != NULL; l = l->next) {
1715 GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data);
1716 changed |= gst_registry_scan_path_internal (&context, (gchar *) l->data);
1718 /* keep plugin_paths around in case a re-scan is forced later on */
1720 /* GST_PLUGIN_PATH specifies a list of directories to scan for
1721 * additional plugins. These take precedence over the system plugins */
1722 plugin_path = g_getenv ("GST_PLUGIN_PATH_1_0");
1723 if (plugin_path == NULL)
1724 plugin_path = g_getenv ("GST_PLUGIN_PATH");
1729 GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path);
1730 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1731 for (i = 0; list[i]; i++) {
1732 changed |= gst_registry_scan_path_internal (&context, list[i]);
1736 GST_DEBUG ("GST_PLUGIN_PATH not set");
1739 /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always
1740 * loaded by default. If not set, this defaults to the system-installed
1741 * path, and the plugins installed in the user's home directory */
1742 plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH_1_0");
1743 if (plugin_path == NULL)
1744 plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH");
1745 if (plugin_path == NULL) {
1746 char *home_plugins, *relocated_libgstreamer, *system_plugindir;
1748 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set");
1750 /* plugins in the user's home directory take precedence over
1751 * system-installed ones */
1752 home_plugins = g_build_filename (g_get_user_data_dir (),
1753 "gstreamer-" GST_API_VERSION, "plugins", NULL);
1755 GST_DEBUG ("scanning home plugins %s", home_plugins);
1756 changed |= gst_registry_scan_path_internal (&context, home_plugins);
1757 g_free (home_plugins);
1759 /* add the main (installed) library path */
1761 relocated_libgstreamer = priv_gst_get_relocated_libgstreamer ();
1762 if (relocated_libgstreamer) {
1763 GST_DEBUG ("found libgstreamer-" GST_API_VERSION " library "
1764 "at %s", relocated_libgstreamer);
1765 system_plugindir = g_build_filename (relocated_libgstreamer,
1766 "gstreamer-" GST_API_VERSION, NULL);
1768 system_plugindir = g_strdup (PLUGINDIR);
1771 GST_DEBUG ("using plugin dir %s", system_plugindir);
1772 changed |= gst_registry_scan_path_internal (&context, system_plugindir);
1774 g_clear_pointer (&system_plugindir, g_free);
1775 g_clear_pointer (&relocated_libgstreamer, g_free);
1780 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path);
1781 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1782 for (i = 0; list[i]; i++) {
1783 changed |= gst_registry_scan_path_internal (&context, list[i]);
1788 clear_scan_context (&context);
1789 changed |= context.changed;
1791 /* Remove cached plugins so stale info is cleared. */
1792 changed |= gst_registry_remove_cache_plugins (default_registry);
1795 GST_INFO ("Registry cache has not changed");
1796 return REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED;
1799 if (!write_changes) {
1800 GST_INFO ("Registry cache changed, but writing is disabled. Not writing.");
1801 return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1804 GST_INFO ("Registry cache changed. Writing new registry cache");
1805 if (!priv_gst_registry_binary_write_cache (default_registry,
1806 default_registry->priv->plugins, registry_file)) {
1807 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
1808 _("Error writing registry cache to %s: %s"),
1809 registry_file, g_strerror (errno));
1810 return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1813 GST_INFO ("Registry cache written successfully");
1814 return REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED;
1818 ensure_current_registry (GError ** error)
1820 gchar *registry_file;
1821 GstRegistry *default_registry;
1822 gboolean do_update = TRUE;
1823 gboolean have_cache = TRUE;
1825 default_registry = gst_registry_get ();
1827 registry_file = g_strdup (g_getenv ("GST_REGISTRY_1_0"));
1828 if (registry_file == NULL)
1829 registry_file = g_strdup (g_getenv ("GST_REGISTRY"));
1830 if (registry_file == NULL) {
1831 registry_file = g_build_filename (g_get_user_cache_dir (),
1832 "gstreamer-" GST_API_VERSION, GST_REGISTRY_FILE_NAME, NULL);
1835 if (!_gst_disable_registry_cache) {
1836 GST_INFO ("reading registry cache: %s", registry_file);
1837 have_cache = priv_gst_registry_binary_read_cache (default_registry,
1839 /* Only ever read the registry cache once, then disable it for
1840 * subsequent updates during the program lifetime */
1841 _gst_disable_registry_cache = TRUE;
1845 do_update = !_priv_gst_disable_registry_update;
1847 const gchar *update_env;
1849 if ((update_env = g_getenv ("GST_REGISTRY_UPDATE"))) {
1850 /* do update for any value different from "no" */
1851 do_update = (strcmp (update_env, "no") != 0);
1857 const gchar *reuse_env;
1859 if ((reuse_env = g_getenv ("GST_REGISTRY_REUSE_PLUGIN_SCANNER"))) {
1860 /* do reuse for any value different from "no" */
1861 __registry_reuse_plugin_scanner = (strcmp (reuse_env, "no") != 0);
1863 /* now check registry */
1864 GST_DEBUG ("Updating registry cache");
1865 scan_and_update_registry (default_registry, registry_file, TRUE, error);
1867 GST_DEBUG ("Not updating registry cache (disabled)");
1870 g_free (registry_file);
1871 GST_INFO ("registry reading and updating done");
1873 #endif /* GST_DISABLE_REGISTRY */
1876 * gst_registry_fork_is_enabled:
1878 * By default GStreamer will perform scanning and rebuilding of the
1879 * registry file using a helper child process.
1881 * Applications might want to disable this behaviour with the
1882 * gst_registry_fork_set_enabled() function, in which case new plugins
1883 * are scanned (and loaded) into the application process.
1885 * Returns: %TRUE if GStreamer will use the child helper process when
1886 * rebuilding the registry.
1889 gst_registry_fork_is_enabled (void)
1891 return _gst_enable_registry_fork;
1895 * gst_registry_fork_set_enabled:
1896 * @enabled: whether rebuilding the registry can use a temporary child helper process.
1898 * Applications might want to disable/enable spawning of a child helper process
1899 * when rebuilding the registry. See gst_registry_fork_is_enabled() for more
1903 gst_registry_fork_set_enabled (gboolean enabled)
1905 _gst_enable_registry_fork = enabled;
1909 * gst_update_registry:
1911 * Forces GStreamer to re-scan its plugin paths and update the default
1914 * Applications will almost never need to call this function, it is only
1915 * useful if the application knows new plugins have been installed (or old
1916 * ones removed) since the start of the application (or, to be precise, the
1917 * first call to gst_init()) and the application wants to make use of any
1918 * newly-installed plugins without restarting the application.
1920 * Applications should assume that the registry update is neither atomic nor
1921 * thread-safe and should therefore not have any dynamic pipelines running
1922 * (including the playbin and decodebin elements) and should also not create
1923 * any elements or access the GStreamer registry while the update is in
1926 * Note that this function may block for a significant amount of time.
1928 * Returns: %TRUE if the registry has been updated successfully (does not
1929 * imply that there were changes), otherwise %FALSE.
1932 gst_update_registry (void)
1934 #ifndef GST_DISABLE_REGISTRY
1935 if (!_priv_gst_disable_registry) {
1938 ensure_current_registry (&err);
1940 GST_WARNING ("registry update failed: %s", err->message);
1943 GST_LOG ("registry update succeeded");
1946 GST_INFO ("registry update disabled by environment");
1950 GST_WARNING ("registry update failed: %s", "registry disabled");
1951 #endif /* GST_DISABLE_REGISTRY */
1953 #ifndef GST_DISABLE_OPTION_PARSING
1954 if (_priv_gst_preload_plugins) {
1955 GST_DEBUG ("Preloading indicated plugins...");
1956 g_slist_foreach (_priv_gst_preload_plugins, load_plugin_func, NULL);
1964 * gst_registry_get_feature_list_cookie:
1965 * @registry: the registry
1967 * Returns the registry's feature list cookie. This changes
1968 * every time a feature is added or removed from the registry.
1970 * Returns: the feature list cookie.
1973 gst_registry_get_feature_list_cookie (GstRegistry * registry)
1975 g_return_val_if_fail (GST_IS_REGISTRY (registry), 0);
1977 return registry->priv->cookie;