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 "gstdeviceproviderfactory.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
158 /* hash to speedup _lookup_feature_locked() */
159 GHashTable *feature_hash;
160 /* hash to speedup _lookup */
161 GHashTable *basename_hash;
163 /* updated whenever the feature list changes */
165 /* speedup for searching features */
166 GList *element_factory_list;
168 GList *typefind_factory_list;
170 GList *device_provider_factory_list;
174 /* the one instance of the default registry and the mutex protecting the
176 static GMutex _gst_registry_mutex;
177 static GstRegistry *_gst_registry_default = NULL;
180 #define DEFAULT_FORK TRUE
182 /* control the behaviour of registry rebuild */
183 static gboolean _gst_enable_registry_fork = DEFAULT_FORK;
184 /* List of plugins that need preloading/reloading after scanning registry */
185 extern GSList *_priv_gst_preload_plugins;
187 #ifndef GST_DISABLE_REGISTRY
188 /*set to TRUE when registry needn't to be updated */
189 gboolean _priv_gst_disable_registry_update = FALSE;
190 extern GList *_priv_gst_plugin_paths;
192 /* Set to TRUE when the registry cache should be disabled */
193 gboolean _gst_disable_registry_cache = FALSE;
195 static gboolean __registry_reuse_plugin_scanner = TRUE;
198 /* Element signals and args */
206 static void gst_registry_finalize (GObject * object);
208 static guint gst_registry_signals[LAST_SIGNAL] = { 0 };
210 static GstPluginFeature *gst_registry_lookup_feature_locked (GstRegistry *
211 registry, const char *name);
212 static GstPlugin *gst_registry_lookup_bn_locked (GstRegistry * registry,
213 const char *basename);
215 #define gst_registry_parent_class parent_class
216 G_DEFINE_TYPE (GstRegistry, gst_registry, GST_TYPE_OBJECT);
219 gst_registry_class_init (GstRegistryClass * klass)
221 GObjectClass *gobject_class;
223 gobject_class = (GObjectClass *) klass;
225 g_type_class_add_private (klass, sizeof (GstRegistryPrivate));
228 * GstRegistry::plugin-added:
229 * @registry: the registry that emitted the signal
230 * @plugin: the plugin that has been added
232 * Signals that a plugin has been added to the registry (possibly
233 * replacing a previously-added one by the same name)
235 gst_registry_signals[PLUGIN_ADDED] =
236 g_signal_new ("plugin-added", G_TYPE_FROM_CLASS (klass),
237 G_SIGNAL_RUN_LAST, 0, NULL, NULL, g_cclosure_marshal_generic,
238 G_TYPE_NONE, 1, GST_TYPE_PLUGIN);
241 * GstRegistry::feature-added:
242 * @registry: the registry that emitted the signal
243 * @feature: the feature that has been added
245 * Signals that a feature has been added to the registry (possibly
246 * replacing a previously-added one by the same name)
248 gst_registry_signals[FEATURE_ADDED] =
249 g_signal_new ("feature-added", G_TYPE_FROM_CLASS (klass),
250 G_SIGNAL_RUN_LAST, 0, NULL, NULL, g_cclosure_marshal_generic,
251 G_TYPE_NONE, 1, GST_TYPE_PLUGIN_FEATURE);
253 gobject_class->finalize = gst_registry_finalize;
257 gst_registry_init (GstRegistry * registry)
260 G_TYPE_INSTANCE_GET_PRIVATE (registry, GST_TYPE_REGISTRY,
262 registry->priv->feature_hash = g_hash_table_new (g_str_hash, g_str_equal);
263 registry->priv->basename_hash = g_hash_table_new (g_str_hash, g_str_equal);
267 gst_registry_finalize (GObject * object)
269 GstRegistry *registry = GST_REGISTRY (object);
273 plugins = registry->priv->plugins;
274 registry->priv->plugins = NULL;
275 registry->priv->n_plugins = 0;
277 GST_DEBUG_OBJECT (registry, "registry finalize");
280 GstPlugin *plugin = p->data;
283 GST_LOG_OBJECT (registry, "removing plugin %s",
284 gst_plugin_get_name (plugin));
285 gst_object_unref (plugin);
289 g_list_free (plugins);
291 features = registry->priv->features;
292 registry->priv->features = NULL;
296 GstPluginFeature *feature = f->data;
299 GST_LOG_OBJECT (registry, "removing feature %p (%s)", feature,
300 GST_OBJECT_NAME (feature));
301 gst_object_unparent (GST_OBJECT_CAST (feature));
305 g_list_free (features);
307 g_hash_table_destroy (registry->priv->feature_hash);
308 registry->priv->feature_hash = NULL;
309 g_hash_table_destroy (registry->priv->basename_hash);
310 registry->priv->basename_hash = NULL;
312 if (registry->priv->element_factory_list) {
313 GST_DEBUG_OBJECT (registry, "Cleaning up cached element factory list");
314 gst_plugin_feature_list_free (registry->priv->element_factory_list);
317 if (registry->priv->typefind_factory_list) {
318 GST_DEBUG_OBJECT (registry, "Cleaning up cached typefind factory list");
319 gst_plugin_feature_list_free (registry->priv->typefind_factory_list);
322 if (registry->priv->device_provider_factory_list) {
323 GST_DEBUG_OBJECT (registry,
324 "Cleaning up cached device provider factory list");
325 gst_plugin_feature_list_free (registry->priv->device_provider_factory_list);
328 G_OBJECT_CLASS (parent_class)->finalize (object);
334 * Retrieves the singleton plugin registry. The caller does not own a
335 * reference on the registry, as it is alive as long as GStreamer is
338 * Returns: (transfer none): the #GstRegistry.
341 gst_registry_get (void)
343 GstRegistry *registry;
345 g_mutex_lock (&_gst_registry_mutex);
346 if (G_UNLIKELY (!_gst_registry_default)) {
347 _gst_registry_default = g_object_newv (GST_TYPE_REGISTRY, 0, NULL);
348 gst_object_ref_sink (GST_OBJECT_CAST (_gst_registry_default));
350 registry = _gst_registry_default;
351 g_mutex_unlock (&_gst_registry_mutex);
358 * gst_registry_add_path:
359 * @registry: the registry to add the path to
360 * @path: the path to add to the registry
362 * Add the given path to the registry. The syntax of the
363 * path is specific to the registry. If the path has already been
367 gst_registry_add_path (GstRegistry * registry, const gchar * path)
369 g_return_if_fail (GST_IS_REGISTRY (registry));
370 g_return_if_fail (path != NULL);
372 if (strlen (path) == 0)
375 GST_OBJECT_LOCK (registry);
376 if (g_list_find_custom (registry->priv->paths, path, (GCompareFunc) strcmp))
379 GST_INFO ("Adding plugin path: \"%s\"", path);
380 registry->priv->paths =
381 g_list_append (registry->priv->paths, g_strdup (path));
382 GST_OBJECT_UNLOCK (registry);
388 GST_INFO ("Ignoring empty plugin path");
393 g_warning ("path %s already added to registry", path);
394 GST_OBJECT_UNLOCK (registry);
400 * gst_registry_get_path_list:
401 * @registry: the registry to get the pathlist of
403 * Get the list of paths for the given registry.
405 * Returns: (transfer container) (element-type char*): A #GList of paths as
406 * strings. g_list_free after use.
411 gst_registry_get_path_list (GstRegistry * registry)
415 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
417 GST_OBJECT_LOCK (registry);
418 /* We don't need to copy the strings, because they won't be deleted
419 * as long as the GstRegistry is around */
420 list = g_list_copy (registry->priv->paths);
421 GST_OBJECT_UNLOCK (registry);
428 * gst_registry_add_plugin:
429 * @registry: the registry to add the plugin to
430 * @plugin: (transfer full): the plugin to add
432 * Add the plugin to the registry. The plugin-added signal will be emitted.
433 * This function will sink @plugin.
435 * Returns: %TRUE on success.
440 gst_registry_add_plugin (GstRegistry * registry, GstPlugin * plugin)
442 GstPlugin *existing_plugin;
444 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
445 g_return_val_if_fail (GST_IS_PLUGIN (plugin), FALSE);
447 GST_OBJECT_LOCK (registry);
448 if (G_LIKELY (plugin->basename)) {
449 /* we have a basename, see if we find the plugin */
451 gst_registry_lookup_bn_locked (registry, plugin->basename);
452 if (existing_plugin) {
453 GST_DEBUG_OBJECT (registry,
454 "Replacing existing plugin \"%s\" %p with new plugin %p for filename \"%s\"",
455 GST_STR_NULL (existing_plugin->filename), existing_plugin, plugin,
456 GST_STR_NULL (plugin->filename));
457 /* If the new plugin is blacklisted and the existing one isn't cached, do not
458 * accept if it's from a different location than the existing one */
459 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED) &&
460 strcmp (plugin->filename, existing_plugin->filename)) {
461 GST_WARNING_OBJECT (registry,
462 "Not replacing plugin because new one (%s) is blacklisted but for a different location than existing one (%s)",
463 plugin->filename, existing_plugin->filename);
464 gst_object_unref (plugin);
465 GST_OBJECT_UNLOCK (registry);
468 registry->priv->plugins =
469 g_list_remove (registry->priv->plugins, existing_plugin);
470 --registry->priv->n_plugins;
471 if (G_LIKELY (existing_plugin->basename))
472 g_hash_table_remove (registry->priv->basename_hash,
473 existing_plugin->basename);
474 gst_object_unref (existing_plugin);
478 GST_DEBUG_OBJECT (registry, "adding plugin %p for filename \"%s\"",
479 plugin, GST_STR_NULL (plugin->filename));
481 registry->priv->plugins = g_list_prepend (registry->priv->plugins, plugin);
482 ++registry->priv->n_plugins;
484 if (G_LIKELY (plugin->basename))
485 g_hash_table_replace (registry->priv->basename_hash, plugin->basename,
488 gst_object_ref_sink (plugin);
489 GST_OBJECT_UNLOCK (registry);
491 GST_LOG_OBJECT (registry, "emitting plugin-added for filename \"%s\"",
492 GST_STR_NULL (plugin->filename));
493 g_signal_emit (registry, gst_registry_signals[PLUGIN_ADDED], 0, plugin);
499 gst_registry_remove_features_for_plugin_unlocked (GstRegistry * registry,
504 g_return_if_fail (GST_IS_REGISTRY (registry));
505 g_return_if_fail (GST_IS_PLUGIN (plugin));
507 /* Remove all features for this plugin */
508 f = registry->priv->features;
510 GList *next = g_list_next (f);
511 GstPluginFeature *feature = f->data;
513 if (G_UNLIKELY (feature && feature->plugin == plugin)) {
514 GST_DEBUG_OBJECT (registry, "removing feature %p (%s) for plugin %p (%s)",
515 feature, gst_plugin_feature_get_name (feature), plugin,
518 registry->priv->features =
519 g_list_delete_link (registry->priv->features, f);
520 g_hash_table_remove (registry->priv->feature_hash,
521 GST_OBJECT_NAME (feature));
522 gst_object_unparent (GST_OBJECT_CAST (feature));
526 registry->priv->cookie++;
530 * gst_registry_remove_plugin:
531 * @registry: the registry to remove the plugin from
532 * @plugin: (transfer none): the plugin to remove
534 * Remove the plugin from the registry.
539 gst_registry_remove_plugin (GstRegistry * registry, GstPlugin * plugin)
541 g_return_if_fail (GST_IS_REGISTRY (registry));
542 g_return_if_fail (GST_IS_PLUGIN (plugin));
544 GST_DEBUG_OBJECT (registry, "removing plugin %p (%s)",
545 plugin, gst_plugin_get_name (plugin));
547 GST_OBJECT_LOCK (registry);
548 registry->priv->plugins = g_list_remove (registry->priv->plugins, plugin);
549 --registry->priv->n_plugins;
550 if (G_LIKELY (plugin->basename))
551 g_hash_table_remove (registry->priv->basename_hash, plugin->basename);
552 gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
553 GST_OBJECT_UNLOCK (registry);
554 gst_object_unref (plugin);
558 * gst_registry_add_feature:
559 * @registry: the registry to add the plugin to
560 * @feature: (transfer full): the feature to add
562 * Add the feature to the registry. The feature-added signal will be emitted.
563 * This function sinks @feature.
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 == 0 || data->type == G_OBJECT_TYPE (feature)) &&
707 (data->name == NULL || !strcmp (data->name, GST_OBJECT_NAME (feature))));
710 /* returns TRUE if the list was changed
712 * Must be called with the object lock taken */
714 gst_registry_get_feature_list_or_create (GstRegistry * registry,
715 GList ** previous, guint32 * cookie, GType type)
717 gboolean res = FALSE;
718 GstRegistryPrivate *priv = registry->priv;
720 if (G_UNLIKELY (!*previous || priv->cookie != *cookie)) {
721 GstTypeNameData data;
725 gst_plugin_feature_list_free (*previous);
732 for (walk = registry->priv->features; walk != NULL; walk = walk->next) {
733 GstPluginFeature *feature = walk->data;
735 if (gst_plugin_feature_type_name_filter (feature, &data)) {
736 *previous = g_list_prepend (*previous, gst_object_ref (feature));
740 *cookie = priv->cookie;
748 type_find_factory_rank_cmp (const GstPluginFeature * fac1,
749 const GstPluginFeature * fac2)
751 if (G_LIKELY (fac1->rank != fac2->rank))
752 return fac2->rank - fac1->rank;
754 /* to make the order in which things happen more deterministic,
755 * sort by name when the ranks are the same. */
756 return strcmp (GST_OBJECT_NAME (fac1), GST_OBJECT_NAME (fac2));
760 gst_registry_get_element_factory_list (GstRegistry * registry)
764 GST_OBJECT_LOCK (registry);
766 gst_registry_get_feature_list_or_create (registry,
767 ®istry->priv->element_factory_list, ®istry->priv->efl_cookie,
768 GST_TYPE_ELEMENT_FACTORY);
770 /* Return reffed copy */
771 list = gst_plugin_feature_list_copy (registry->priv->element_factory_list);
773 GST_OBJECT_UNLOCK (registry);
779 gst_registry_get_typefind_factory_list (GstRegistry * registry)
783 GST_OBJECT_LOCK (registry);
785 if (G_UNLIKELY (gst_registry_get_feature_list_or_create (registry,
786 ®istry->priv->typefind_factory_list,
787 ®istry->priv->tfl_cookie, GST_TYPE_TYPE_FIND_FACTORY)))
788 registry->priv->typefind_factory_list =
789 g_list_sort (registry->priv->typefind_factory_list,
790 (GCompareFunc) type_find_factory_rank_cmp);
792 /* Return reffed copy */
793 list = gst_plugin_feature_list_copy (registry->priv->typefind_factory_list);
795 GST_OBJECT_UNLOCK (registry);
802 gst_registry_get_device_provider_factory_list (GstRegistry * registry)
806 GST_OBJECT_LOCK (registry);
808 gst_registry_get_feature_list_or_create (registry,
809 ®istry->priv->device_provider_factory_list,
810 ®istry->priv->dmfl_cookie, GST_TYPE_DEVICE_PROVIDER_FACTORY);
812 /* Return reffed copy */
814 gst_plugin_feature_list_copy (registry->
815 priv->device_provider_factory_list);
817 GST_OBJECT_UNLOCK (registry);
823 * gst_registry_feature_filter:
824 * @registry: registry to query
825 * @filter: (scope call): the filter to use
826 * @first: only return first match
827 * @user_data: (closure): user data passed to the filter function
829 * Runs a filter against all features of the plugins in the registry
830 * and returns a GList with the results.
831 * If the first flag is set, only the first match is
832 * returned (as a list with a single object).
834 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
835 * #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
840 gst_registry_feature_filter (GstRegistry * registry,
841 GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
843 GstPluginFeature **features;
844 GList *walk, *list = NULL;
847 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
849 GST_OBJECT_LOCK (registry);
850 n_features = g_hash_table_size (registry->priv->feature_hash);
851 features = g_newa (GstPluginFeature *, n_features + 1);
852 for (walk = registry->priv->features, i = 0; walk != NULL; walk = walk->next)
853 features[i++] = gst_object_ref (walk->data);
854 GST_OBJECT_UNLOCK (registry);
856 for (i = 0; i < n_features; ++i) {
857 if (filter == NULL || filter (features[i], user_data)) {
858 list = g_list_prepend (list, gst_object_ref (features[i]));
865 for (i = 0; i < n_features; ++i)
866 gst_object_unref (features[i]);
872 gst_registry_plugin_name_filter (GstPlugin * plugin, const gchar * name)
874 return (plugin->desc.name && !strcmp (plugin->desc.name, name));
878 * gst_registry_find_plugin:
879 * @registry: the registry to search
880 * @name: the plugin name to find
882 * Find the plugin with the given name in the registry.
883 * The plugin will be reffed; caller is responsible for unreffing.
885 * Returns: (transfer full) (nullable): the plugin with the given name
886 * or %NULL if the plugin was not found. gst_object_unref() after
892 gst_registry_find_plugin (GstRegistry * registry, const gchar * name)
895 GstPlugin *result = NULL;
897 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
898 g_return_val_if_fail (name != NULL, NULL);
900 walk = gst_registry_plugin_filter (registry,
901 (GstPluginFilter) gst_registry_plugin_name_filter, TRUE, (gpointer) name);
903 result = GST_PLUGIN_CAST (walk->data);
905 gst_object_ref (result);
906 gst_plugin_list_free (walk);
913 * gst_registry_find_feature:
914 * @registry: the registry to search
915 * @name: the pluginfeature name to find
916 * @type: the pluginfeature type to find
918 * Find the pluginfeature with the given name and type in the registry.
920 * Returns: (transfer full) (nullable): the pluginfeature with the
921 * given name and type or %NULL if the plugin was not
922 * found. gst_object_unref() after usage.
927 gst_registry_find_feature (GstRegistry * registry, const gchar * name,
930 GstPluginFeature *feature = NULL;
932 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
933 g_return_val_if_fail (name != NULL, NULL);
934 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
936 feature = gst_registry_lookup_feature (registry, name);
937 if (feature && !g_type_is_a (G_TYPE_FROM_INSTANCE (feature), type)) {
938 gst_object_unref (feature);
946 * gst_registry_get_feature_list:
947 * @registry: a #GstRegistry
950 * Retrieves a #GList of #GstPluginFeature of @type.
952 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
953 * #GstPluginFeature of @type. Use gst_plugin_feature_list_free() after use
958 gst_registry_get_feature_list (GstRegistry * registry, GType type)
960 GstTypeNameData data;
962 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
963 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
966 if (type == GST_TYPE_ELEMENT_FACTORY)
967 return gst_registry_get_element_factory_list (registry);
968 else if (type == GST_TYPE_TYPE_FIND_FACTORY)
969 return gst_registry_get_typefind_factory_list (registry);
970 else if (type == GST_TYPE_DEVICE_PROVIDER_FACTORY)
971 return gst_registry_get_device_provider_factory_list (registry);
976 return gst_registry_feature_filter (registry,
977 (GstPluginFeatureFilter) gst_plugin_feature_type_name_filter,
982 * gst_registry_get_plugin_list:
983 * @registry: the registry to search
985 * Get a copy of all plugins registered in the given registry. The refcount
986 * of each element in the list in incremented.
988 * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
989 * Use gst_plugin_list_free() after usage.
994 gst_registry_get_plugin_list (GstRegistry * registry)
999 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1001 GST_OBJECT_LOCK (registry);
1002 list = g_list_copy (registry->priv->plugins);
1003 for (g = list; g; g = g->next) {
1004 gst_object_ref (GST_PLUGIN_CAST (g->data));
1006 GST_OBJECT_UNLOCK (registry);
1011 static GstPluginFeature *
1012 gst_registry_lookup_feature_locked (GstRegistry * registry, const char *name)
1014 return g_hash_table_lookup (registry->priv->feature_hash, name);
1018 * gst_registry_lookup_feature:
1019 * @registry: a #GstRegistry
1020 * @name: a #GstPluginFeature name
1022 * Find a #GstPluginFeature with @name in @registry.
1024 * Returns: (transfer full): a #GstPluginFeature with its refcount incremented,
1025 * use gst_object_unref() after usage.
1030 gst_registry_lookup_feature (GstRegistry * registry, const char *name)
1032 GstPluginFeature *feature;
1034 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1035 g_return_val_if_fail (name != NULL, NULL);
1037 GST_OBJECT_LOCK (registry);
1038 feature = gst_registry_lookup_feature_locked (registry, name);
1040 gst_object_ref (feature);
1041 GST_OBJECT_UNLOCK (registry);
1047 gst_registry_lookup_bn_locked (GstRegistry * registry, const char *basename)
1049 return g_hash_table_lookup (registry->priv->basename_hash, basename);
1053 gst_registry_lookup_bn (GstRegistry * registry, const char *basename)
1057 GST_OBJECT_LOCK (registry);
1058 plugin = gst_registry_lookup_bn_locked (registry, basename);
1060 gst_object_ref (plugin);
1061 GST_OBJECT_UNLOCK (registry);
1067 * gst_registry_lookup:
1068 * @registry: the registry to look up in
1069 * @filename: the name of the file to look up
1071 * Look up a plugin in the given registry with the given filename.
1072 * If found, plugin is reffed.
1074 * Returns: (transfer full) (nullable): the #GstPlugin if found, or
1075 * %NULL if not. gst_object_unref() after usage.
1078 gst_registry_lookup (GstRegistry * registry, const char *filename)
1083 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1084 g_return_val_if_fail (filename != NULL, NULL);
1086 basename = g_path_get_basename (filename);
1087 if (G_UNLIKELY (basename == NULL))
1090 plugin = gst_registry_lookup_bn (registry, basename);
1099 REGISTRY_SCAN_HELPER_NOT_STARTED = 0,
1100 REGISTRY_SCAN_HELPER_DISABLED,
1101 REGISTRY_SCAN_HELPER_RUNNING
1102 } GstRegistryScanHelperState;
1106 GstRegistry *registry;
1107 GstRegistryScanHelperState helper_state;
1108 GstPluginLoader *helper;
1110 } GstRegistryScanContext;
1113 init_scan_context (GstRegistryScanContext * context, GstRegistry * registry)
1117 context->registry = registry;
1119 /* see if forking is enabled and set up the scan helper state accordingly */
1120 do_fork = _gst_enable_registry_fork;
1122 const gchar *fork_env;
1124 /* forking enabled, see if it is disabled with an env var */
1125 if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) {
1126 /* fork enabled for any value different from "no" */
1127 do_fork = strcmp (fork_env, "no") != 0;
1132 context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1134 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1136 context->helper = NULL;
1137 context->changed = FALSE;
1141 clear_scan_context (GstRegistryScanContext * context)
1143 if (context->helper) {
1144 context->changed |= _priv_gst_plugin_loader_funcs.destroy (context->helper);
1145 context->helper = NULL;
1150 gst_registry_scan_plugin_file (GstRegistryScanContext * context,
1151 const gchar * filename, off_t file_size, time_t file_mtime)
1153 gboolean changed = FALSE;
1154 GstPlugin *newplugin = NULL;
1157 /* Disable external plugin loader on Windows until it is ported properly. */
1158 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1162 /* Have a plugin to load - see if the scan-helper needs starting */
1163 if (context->helper_state == REGISTRY_SCAN_HELPER_NOT_STARTED) {
1164 GST_DEBUG ("Starting plugin scanner for file %s", filename);
1165 context->helper = _priv_gst_plugin_loader_funcs.create (context->registry);
1166 if (context->helper != NULL)
1167 context->helper_state = REGISTRY_SCAN_HELPER_RUNNING;
1169 GST_WARNING ("Failed starting plugin scanner. Scanning in-process");
1170 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1174 if (context->helper_state == REGISTRY_SCAN_HELPER_RUNNING) {
1175 GST_DEBUG ("Using scan-helper to load plugin %s", filename);
1176 if (!_priv_gst_plugin_loader_funcs.load (context->helper,
1177 filename, file_size, file_mtime)) {
1178 g_warning ("External plugin loader failed. This most likely means that "
1179 "the plugin loader helper binary was not found or could not be run. "
1180 "You might need to set the GST_PLUGIN_SCANNER environment variable "
1181 "if your setup is unusual. This should normally not be required "
1183 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1187 /* Check if the helper is disabled (or just got disabled above) */
1188 if (context->helper_state == REGISTRY_SCAN_HELPER_DISABLED) {
1189 /* Load plugin the old fashioned way... */
1191 /* We don't use a GError here because a failure to load some shared
1192 * objects as plugins is normal (particularly in the uninstalled case)
1194 newplugin = _priv_gst_plugin_load_file_for_registry (filename,
1195 context->registry, NULL);
1199 GST_DEBUG_OBJECT (context->registry, "marking new plugin %p as registered",
1201 newplugin->registered = TRUE;
1202 gst_object_unref (newplugin);
1205 #ifndef GST_DISABLE_REGISTRY
1206 if (!__registry_reuse_plugin_scanner) {
1207 clear_scan_context (context);
1208 context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1216 is_blacklisted_hidden_directory (const gchar * dirent)
1218 if (G_LIKELY (dirent[0] != '.'))
1221 /* skip the .debug directory, these contain elf files that are not
1222 * useful or worse, can crash dlopen () */
1223 if (strcmp (dirent, ".debug") == 0)
1226 /* can also skip .git and .deps dirs, those won't contain useful files.
1227 * This speeds up scanning a bit in uninstalled setups. */
1228 if (strcmp (dirent, ".git") == 0 || strcmp (dirent, ".deps") == 0)
1235 gst_registry_scan_path_level (GstRegistryScanContext * context,
1236 const gchar * path, int level)
1239 const gchar *dirent;
1242 gboolean changed = FALSE;
1244 dir = g_dir_open (path, 0, NULL);
1248 while ((dirent = g_dir_read_name (dir))) {
1249 GStatBuf file_status;
1251 filename = g_build_filename (path, dirent, NULL);
1252 if (g_stat (filename, &file_status) < 0) {
1253 /* Plugin will be removed from cache after the scan completes if it
1254 * is still marked 'cached' */
1259 if (file_status.st_mode & S_IFDIR) {
1260 if (G_UNLIKELY (is_blacklisted_hidden_directory (dirent))) {
1261 GST_TRACE_OBJECT (context->registry, "ignoring %s directory", dirent);
1265 /* FIXME 2.0: Don't recurse into directories, this behaviour
1266 * is inconsistent with other PATH environment variables
1269 GST_LOG_OBJECT (context->registry, "recursing into directory %s",
1271 changed |= gst_registry_scan_path_level (context, filename, level - 1);
1273 GST_LOG_OBJECT (context->registry, "not recursing into directory %s, "
1274 "recursion level too deep", filename);
1279 if (!(file_status.st_mode & S_IFREG)) {
1280 GST_TRACE_OBJECT (context->registry, "%s is not a regular file, ignoring",
1285 if (!g_str_has_suffix (dirent, G_MODULE_SUFFIX)
1286 #ifdef GST_EXTRA_MODULE_SUFFIX
1287 && !g_str_has_suffix (dirent, GST_EXTRA_MODULE_SUFFIX)
1290 GST_TRACE_OBJECT (context->registry,
1291 "extension is not recognized as module file, ignoring file %s",
1297 GST_LOG_OBJECT (context->registry, "file %s looks like a possible module",
1300 /* try to avoid unnecessary plugin-move pain */
1301 if (g_str_has_prefix (dirent, "libgstvalve") ||
1302 g_str_has_prefix (dirent, "libgstselector")) {
1303 GST_WARNING_OBJECT (context->registry, "ignoring old plugin %s which "
1304 "has been merged into the corelements plugin", filename);
1305 /* Plugin will be removed from cache after the scan completes if it
1306 * is still marked 'cached' */
1311 /* plug-ins are considered unique by basename; if the given name
1312 * was already seen by the registry, we ignore it */
1313 plugin = gst_registry_lookup_bn (context->registry, dirent);
1315 gboolean env_vars_changed, deps_changed = FALSE;
1317 if (plugin->registered) {
1318 GST_DEBUG_OBJECT (context->registry,
1319 "plugin already registered from path \"%s\"",
1320 GST_STR_NULL (plugin->filename));
1322 gst_object_unref (plugin);
1326 env_vars_changed = _priv_plugin_deps_env_vars_changed (plugin);
1328 /* If a file with a certain basename is seen on a different path,
1329 * update the plugin to ensure the registry cache will reflect up
1330 * to date information */
1332 if (plugin->file_mtime == file_status.st_mtime &&
1333 plugin->file_size == file_status.st_size && !env_vars_changed &&
1334 !(deps_changed = _priv_plugin_deps_files_changed (plugin)) &&
1335 !strcmp (plugin->filename, filename)) {
1336 GST_LOG_OBJECT (context->registry, "file %s cached", filename);
1337 GST_OBJECT_FLAG_UNSET (plugin, GST_PLUGIN_FLAG_CACHED);
1338 GST_LOG_OBJECT (context->registry,
1339 "marking plugin %p as registered as %s", plugin, filename);
1340 plugin->registered = TRUE;
1342 GST_INFO_OBJECT (context->registry, "cached info for %s is stale",
1344 GST_DEBUG_OBJECT (context->registry, "mtime %" G_GINT64_FORMAT " != %"
1345 G_GINT64_FORMAT " or size %" G_GINT64_FORMAT " != %"
1346 G_GINT64_FORMAT " or external dependency env_vars changed: %d or"
1347 " external dependencies changed: %d or old path %s != new path %s",
1348 (gint64) plugin->file_mtime, (gint64) file_status.st_mtime,
1349 (gint64) plugin->file_size, (gint64) file_status.st_size,
1350 env_vars_changed, deps_changed, plugin->filename, filename);
1351 gst_registry_remove_plugin (context->registry, plugin);
1352 changed |= gst_registry_scan_plugin_file (context, filename,
1353 file_status.st_size, file_status.st_mtime);
1355 gst_object_unref (plugin);
1358 GST_DEBUG_OBJECT (context->registry, "file %s not yet in registry",
1360 changed |= gst_registry_scan_plugin_file (context, filename,
1361 file_status.st_size, file_status.st_mtime);
1373 gst_registry_scan_path_internal (GstRegistryScanContext * context,
1378 GST_DEBUG_OBJECT (context->registry, "scanning path %s", path);
1379 changed = gst_registry_scan_path_level (context, path, 10);
1381 GST_DEBUG_OBJECT (context->registry, "registry changed in path %s: %d", path,
1387 * gst_registry_scan_path:
1388 * @registry: the registry to add found plugins to
1389 * @path: the path to scan
1391 * Scan the given path for plugins to add to the registry. The syntax of the
1392 * path is specific to the registry.
1394 * Returns: %TRUE if registry changed
1397 gst_registry_scan_path (GstRegistry * registry, const gchar * path)
1399 GstRegistryScanContext context;
1402 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1403 g_return_val_if_fail (path != NULL, FALSE);
1405 init_scan_context (&context, registry);
1407 result = gst_registry_scan_path_internal (&context, path);
1409 clear_scan_context (&context);
1410 result |= context.changed;
1416 _gst_plugin_feature_filter_plugin_name (GstPluginFeature * feature,
1419 return (strcmp (feature->plugin_name, (gchar *) user_data) == 0);
1423 * gst_registry_get_feature_list_by_plugin:
1424 * @registry: a #GstRegistry.
1425 * @name: a plugin name.
1427 * Retrieves a #GList of features of the plugin with name @name.
1429 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
1430 * #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
1433 gst_registry_get_feature_list_by_plugin (GstRegistry * registry,
1436 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1437 g_return_val_if_fail (name != NULL, NULL);
1439 return gst_registry_feature_filter (registry,
1440 _gst_plugin_feature_filter_plugin_name, FALSE, (gpointer) name);
1443 /* Unref and delete the default registry */
1445 _priv_gst_registry_cleanup (void)
1447 GstRegistry *registry;
1449 g_mutex_lock (&_gst_registry_mutex);
1450 if ((registry = _gst_registry_default) != NULL) {
1451 _gst_registry_default = NULL;
1453 g_mutex_unlock (&_gst_registry_mutex);
1455 /* unref outside of the lock because we can. */
1457 gst_object_unref (registry);
1461 * gst_registry_check_feature_version:
1462 * @registry: a #GstRegistry
1463 * @feature_name: the name of the feature (e.g. "oggdemux")
1464 * @min_major: the minimum major version number
1465 * @min_minor: the minimum minor version number
1466 * @min_micro: the minimum micro version number
1468 * Checks whether a plugin feature by the given name exists in
1469 * @registry and whether its version is at least the
1472 * Returns: %TRUE if the feature could be found and the version is
1473 * the same as the required version or newer, and %FALSE otherwise.
1476 gst_registry_check_feature_version (GstRegistry * registry,
1477 const gchar * feature_name, guint min_major, guint min_minor,
1480 GstPluginFeature *feature;
1481 gboolean ret = FALSE;
1483 g_return_val_if_fail (feature_name != NULL, FALSE);
1485 GST_DEBUG ("Looking up plugin feature '%s'", feature_name);
1487 feature = gst_registry_lookup_feature (registry, feature_name);
1489 ret = gst_plugin_feature_check_version (feature, min_major, min_minor,
1491 gst_object_unref (feature);
1493 GST_DEBUG ("Could not find plugin feature '%s'", feature_name);
1500 load_plugin_func (gpointer data, gpointer user_data)
1503 const gchar *filename;
1506 filename = (const gchar *) data;
1507 GST_DEBUG ("Pre-loading plugin %s", filename);
1509 plugin = gst_plugin_load_file (filename, &err);
1512 GST_INFO ("Loaded plugin: \"%s\"", filename);
1514 gst_registry_add_plugin (gst_registry_get (), plugin);
1517 /* Report error to user, and free error */
1518 GST_ERROR ("Failed to load plugin: %s", err->message);
1521 GST_WARNING ("Failed to load plugin: \"%s\"", filename);
1526 #ifndef GST_DISABLE_REGISTRY
1527 /* Unref all plugins marked 'cached', to clear old plugins that no
1528 * longer exist. Returns %TRUE if any plugins were removed */
1530 gst_registry_remove_cache_plugins (GstRegistry * registry)
1535 gboolean changed = FALSE;
1537 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1539 GST_OBJECT_LOCK (registry);
1541 GST_DEBUG_OBJECT (registry, "removing cached plugins");
1542 g = registry->priv->plugins;
1546 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_CACHED)) {
1547 GST_DEBUG_OBJECT (registry, "removing cached plugin \"%s\"",
1548 GST_STR_NULL (plugin->filename));
1549 registry->priv->plugins = g_list_delete_link (registry->priv->plugins, g);
1550 --registry->priv->n_plugins;
1551 if (G_LIKELY (plugin->basename))
1552 g_hash_table_remove (registry->priv->basename_hash, plugin->basename);
1553 gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
1554 gst_object_unref (plugin);
1560 GST_OBJECT_UNLOCK (registry);
1567 REGISTRY_SCAN_AND_UPDATE_FAILURE = 0,
1568 REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED,
1569 REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED
1570 } GstRegistryScanAndUpdateResult;
1573 * scan_and_update_registry:
1574 * @default_registry: the #GstRegistry
1575 * @registry_file: registry filename
1576 * @write_changes: write registry if it has changed?
1578 * Scans for registry changes and eventually updates the registry cache.
1580 * Return: %REGISTRY_SCAN_AND_UPDATE_FAILURE if the registry could not scanned
1581 * or updated, %REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED if the
1582 * registry is clean and %REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED if
1583 * it has been updated and the cache needs to be re-read.
1585 static GstRegistryScanAndUpdateResult
1586 scan_and_update_registry (GstRegistry * default_registry,
1587 const gchar * registry_file, gboolean write_changes, GError ** error)
1589 const gchar *plugin_path;
1590 gboolean changed = FALSE;
1592 GstRegistryScanContext context;
1594 GST_INFO ("Validating plugins from registry cache: %s", registry_file);
1596 init_scan_context (&context, default_registry);
1598 /* It sounds tempting to just compare the mtime of directories with the mtime
1599 * of the registry cache, but it does not work. It would not catch updated
1600 * plugins, which might bring more or less features.
1603 /* scan paths specified via --gst-plugin-path */
1604 GST_DEBUG ("scanning paths added via --gst-plugin-path");
1605 for (l = _priv_gst_plugin_paths; l != NULL; l = l->next) {
1606 GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data);
1607 changed |= gst_registry_scan_path_internal (&context, (gchar *) l->data);
1609 /* keep plugin_paths around in case a re-scan is forced later on */
1611 /* GST_PLUGIN_PATH specifies a list of directories to scan for
1612 * additional plugins. These take precedence over the system plugins */
1613 plugin_path = g_getenv ("GST_PLUGIN_PATH_1_0");
1614 if (plugin_path == NULL)
1615 plugin_path = g_getenv ("GST_PLUGIN_PATH");
1620 GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path);
1621 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1622 for (i = 0; list[i]; i++) {
1623 changed |= gst_registry_scan_path_internal (&context, list[i]);
1627 GST_DEBUG ("GST_PLUGIN_PATH not set");
1630 /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always
1631 * loaded by default. If not set, this defaults to the system-installed
1632 * path, and the plugins installed in the user's home directory */
1633 plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH_1_0");
1634 if (plugin_path == NULL)
1635 plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH");
1636 if (plugin_path == NULL) {
1639 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set");
1641 /* plugins in the user's home directory take precedence over
1642 * system-installed ones */
1643 home_plugins = g_build_filename (g_get_user_data_dir (),
1644 "gstreamer-" GST_API_VERSION, "plugins", NULL);
1646 GST_DEBUG ("scanning home plugins %s", home_plugins);
1647 changed |= gst_registry_scan_path_internal (&context, home_plugins);
1648 g_free (home_plugins);
1650 /* add the main (installed) library path */
1658 g_win32_get_package_installation_directory_of_module
1659 (_priv_gst_dll_handle);
1661 dir = g_build_filename (base_dir,
1665 "lib", "gstreamer-" GST_API_VERSION, NULL);
1666 GST_DEBUG ("scanning DLL dir %s", dir);
1668 changed |= gst_registry_scan_path_internal (&context, dir);
1674 GST_DEBUG ("scanning main plugins %s", PLUGINDIR);
1675 changed |= gst_registry_scan_path_internal (&context, PLUGINDIR);
1681 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path);
1682 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1683 for (i = 0; list[i]; i++) {
1684 changed |= gst_registry_scan_path_internal (&context, list[i]);
1689 clear_scan_context (&context);
1690 changed |= context.changed;
1692 /* Remove cached plugins so stale info is cleared. */
1693 changed |= gst_registry_remove_cache_plugins (default_registry);
1696 GST_INFO ("Registry cache has not changed");
1697 return REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED;
1700 if (!write_changes) {
1701 GST_INFO ("Registry cache changed, but writing is disabled. Not writing.");
1702 return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1705 GST_INFO ("Registry cache changed. Writing new registry cache");
1706 if (!priv_gst_registry_binary_write_cache (default_registry,
1707 default_registry->priv->plugins, registry_file)) {
1708 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
1709 _("Error writing registry cache to %s: %s"),
1710 registry_file, g_strerror (errno));
1711 return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1714 GST_INFO ("Registry cache written successfully");
1715 return REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED;
1719 ensure_current_registry (GError ** error)
1721 gchar *registry_file;
1722 GstRegistry *default_registry;
1723 gboolean ret = TRUE;
1724 gboolean do_update = TRUE;
1725 gboolean have_cache = TRUE;
1727 default_registry = gst_registry_get ();
1729 registry_file = g_strdup (g_getenv ("GST_REGISTRY_1_0"));
1730 if (registry_file == NULL)
1731 registry_file = g_strdup (g_getenv ("GST_REGISTRY"));
1732 if (registry_file == NULL) {
1733 registry_file = g_build_filename (g_get_user_cache_dir (),
1734 "gstreamer-" GST_API_VERSION, "registry." TARGET_CPU ".bin", NULL);
1737 if (!_gst_disable_registry_cache) {
1738 GST_INFO ("reading registry cache: %s", registry_file);
1739 have_cache = priv_gst_registry_binary_read_cache (default_registry,
1741 /* Only ever read the registry cache once, then disable it for
1742 * subsequent updates during the program lifetime */
1743 _gst_disable_registry_cache = TRUE;
1747 do_update = !_priv_gst_disable_registry_update;
1749 const gchar *update_env;
1751 if ((update_env = g_getenv ("GST_REGISTRY_UPDATE"))) {
1752 /* do update for any value different from "no" */
1753 do_update = (strcmp (update_env, "no") != 0);
1759 const gchar *reuse_env;
1761 if ((reuse_env = g_getenv ("GST_REGISTRY_REUSE_PLUGIN_SCANNER"))) {
1762 /* do reuse for any value different from "no" */
1763 __registry_reuse_plugin_scanner = (strcmp (reuse_env, "no") != 0);
1765 /* now check registry */
1766 GST_DEBUG ("Updating registry cache");
1767 scan_and_update_registry (default_registry, registry_file, TRUE, error);
1769 GST_DEBUG ("Not updating registry cache (disabled)");
1772 g_free (registry_file);
1773 GST_INFO ("registry reading and updating done, result = %d", ret);
1777 #endif /* GST_DISABLE_REGISTRY */
1780 * gst_registry_fork_is_enabled:
1782 * By default GStreamer will perform scanning and rebuilding of the
1783 * registry file using a helper child process.
1785 * Applications might want to disable this behaviour with the
1786 * gst_registry_fork_set_enabled() function, in which case new plugins
1787 * are scanned (and loaded) into the application process.
1789 * Returns: %TRUE if GStreamer will use the child helper process when
1790 * rebuilding the registry.
1793 gst_registry_fork_is_enabled (void)
1795 return _gst_enable_registry_fork;
1799 * gst_registry_fork_set_enabled:
1800 * @enabled: whether rebuilding the registry can use a temporary child helper process.
1802 * Applications might want to disable/enable spawning of a child helper process
1803 * when rebuilding the registry. See gst_registry_fork_is_enabled() for more
1807 gst_registry_fork_set_enabled (gboolean enabled)
1809 _gst_enable_registry_fork = enabled;
1813 * gst_update_registry:
1815 * Forces GStreamer to re-scan its plugin paths and update the default
1818 * Applications will almost never need to call this function, it is only
1819 * useful if the application knows new plugins have been installed (or old
1820 * ones removed) since the start of the application (or, to be precise, the
1821 * first call to gst_init()) and the application wants to make use of any
1822 * newly-installed plugins without restarting the application.
1824 * Applications should assume that the registry update is neither atomic nor
1825 * thread-safe and should therefore not have any dynamic pipelines running
1826 * (including the playbin and decodebin elements) and should also not create
1827 * any elements or access the GStreamer registry while the update is in
1830 * Note that this function may block for a significant amount of time.
1832 * Returns: %TRUE if the registry has been updated successfully (does not
1833 * imply that there were changes), otherwise %FALSE.
1836 gst_update_registry (void)
1840 #ifndef GST_DISABLE_REGISTRY
1843 res = ensure_current_registry (&err);
1845 GST_WARNING ("registry update failed: %s", err->message);
1848 GST_LOG ("registry update succeeded");
1852 GST_WARNING ("registry update failed: %s", "registry disabled");
1854 #endif /* GST_DISABLE_REGISTRY */
1856 if (_priv_gst_preload_plugins) {
1857 GST_DEBUG ("Preloading indicated plugins...");
1858 g_slist_foreach (_priv_gst_preload_plugins, load_plugin_func, NULL);
1865 * gst_registry_get_feature_list_cookie:
1866 * @registry: the registry
1868 * Returns the registry's feature list cookie. This changes
1869 * every time a feature is added or removed from the registry.
1871 * Returns: the feature list cookie.
1874 gst_registry_get_feature_list_cookie (GstRegistry * registry)
1876 g_return_val_if_fail (GST_IS_REGISTRY (registry), 0);
1878 return registry->priv->cookie;