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., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, 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. There may be multiple #GstRegistry objects,
36 * but the "default registry" is the only object that has any meaning to the
39 * The registry file is actually a cache of plugin information. This is
40 * unlike versions prior to 0.10, where the registry file was the primary source
41 * of plugin information, and was created by the gst-register command.
43 * The primary source, at all times, of plugin information is each plugin file
44 * itself. Thus, if an application wants information about a particular plugin,
45 * or wants to search for a feature that satisfies given criteria, the primary
46 * means of doing so is to load every plugin and look at the resulting
47 * information that is gathered in the default registry. Clearly, this is a time
48 * consuming process, so we cache information in the registry file. The format
49 * and location of the cache file is internal to gstreamer.
51 * On startup, plugins are searched for in the plugin search path. The following
52 * locations are checked in this order:
55 * <para>location from --gst-plugin-path commandline option.</para>
58 * <para>the GST_PLUGIN_PATH environment variable.</para>
61 * <para>the GST_PLUGIN_SYSTEM_PATH environment variable.</para>
64 * <para>default locations (if GST_PLUGIN_SYSTEM_PATH is not set). Those
65 * default locations are:
66 * <filename>~/.gstreamer-$GST_MAJORMINOR/plugins/</filename>
67 * and <filename>$prefix/libs/gstreamer-$GST_MAJORMINOR/</filename>.
71 * The registry cache file is loaded from
72 * <filename>~/.gstreamer-$GST_MAJORMINOR/registry-$ARCH.bin</filename> or the
73 * file listed in the GST_REGISTRY env var. One reason to change the registry
74 * location is for testing.
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 "default registry" are different concepts and can represent
103 * different sets of plugins. For various reasons, at init time, the cache is
104 * stored in the default registry, and plugins not relevant to the current
105 * process are marked with the %GST_PLUGIN_FLAG_CACHED bit. These plugins are
106 * removed at the end of initialization.
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 "gstmarshal.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
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;
169 /* the one instance of the default registry and the mutex protecting the
171 static GStaticMutex _gst_registry_mutex = G_STATIC_MUTEX_INIT;
172 static GstRegistry *_gst_registry_default = NULL;
175 #define DEFAULT_FORK TRUE
177 /* control the behaviour of registry rebuild */
178 static gboolean _gst_enable_registry_fork = DEFAULT_FORK;
179 /* List of plugins that need preloading/reloading after scanning registry */
180 extern GSList *_priv_gst_preload_plugins;
182 #ifndef GST_DISABLE_REGISTRY
183 /*set to TRUE when registry needn't to be updated */
184 gboolean _priv_gst_disable_registry_update = FALSE;
185 extern GList *_priv_gst_plugin_paths;
187 /* Set to TRUE when the registry cache should be disabled */
188 gboolean _gst_disable_registry_cache = FALSE;
190 static gboolean __registry_reuse_plugin_scanner = TRUE;
193 /* Element signals and args */
201 static void gst_registry_finalize (GObject * object);
203 static guint gst_registry_signals[LAST_SIGNAL] = { 0 };
205 static GstPluginFeature *gst_registry_lookup_feature_locked (GstRegistry *
206 registry, const char *name);
207 static GstPlugin *gst_registry_lookup_bn_locked (GstRegistry * registry,
208 const char *basename);
210 #define gst_registry_parent_class parent_class
211 G_DEFINE_TYPE (GstRegistry, gst_registry, GST_TYPE_OBJECT);
214 gst_registry_class_init (GstRegistryClass * klass)
216 GObjectClass *gobject_class;
218 gobject_class = (GObjectClass *) klass;
220 g_type_class_add_private (klass, sizeof (GstRegistryPrivate));
223 * GstRegistry::plugin-added:
224 * @registry: the registry that emitted the signal
225 * @plugin: the plugin that has been added
227 * Signals that a plugin has been added to the registry (possibly
228 * replacing a previously-added one by the same name)
230 gst_registry_signals[PLUGIN_ADDED] =
231 g_signal_new ("plugin-added", G_TYPE_FROM_CLASS (klass),
232 G_SIGNAL_RUN_LAST, 0, NULL, NULL, gst_marshal_VOID__OBJECT,
233 G_TYPE_NONE, 1, GST_TYPE_PLUGIN);
236 * GstRegistry::feature-added:
237 * @registry: the registry that emitted the signal
238 * @feature: the feature that has been added
240 * Signals that a feature has been added to the registry (possibly
241 * replacing a previously-added one by the same name)
243 gst_registry_signals[FEATURE_ADDED] =
244 g_signal_new ("feature-added", G_TYPE_FROM_CLASS (klass),
245 G_SIGNAL_RUN_LAST, 0, NULL, NULL, gst_marshal_VOID__OBJECT,
246 G_TYPE_NONE, 1, GST_TYPE_PLUGIN_FEATURE);
248 gobject_class->finalize = gst_registry_finalize;
252 gst_registry_init (GstRegistry * registry)
255 G_TYPE_INSTANCE_GET_PRIVATE (registry, GST_TYPE_REGISTRY,
257 registry->priv->feature_hash = g_hash_table_new (g_str_hash, g_str_equal);
258 registry->priv->basename_hash = g_hash_table_new (g_str_hash, g_str_equal);
262 gst_registry_finalize (GObject * object)
264 GstRegistry *registry = GST_REGISTRY (object);
268 plugins = registry->priv->plugins;
269 registry->priv->plugins = NULL;
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 G_OBJECT_CLASS (parent_class)->finalize (object);
320 * gst_registry_get_default:
322 * Retrieves the default registry. The caller does not own a reference on the
323 * registry, as it is alive as long as GStreamer is initialized.
325 * Returns: (transfer none): The default #GstRegistry.
328 gst_registry_get_default (void)
330 GstRegistry *registry;
332 g_static_mutex_lock (&_gst_registry_mutex);
333 if (G_UNLIKELY (!_gst_registry_default)) {
334 _gst_registry_default = g_object_newv (GST_TYPE_REGISTRY, 0, NULL);
335 gst_object_ref_sink (GST_OBJECT_CAST (_gst_registry_default));
337 registry = _gst_registry_default;
338 g_static_mutex_unlock (&_gst_registry_mutex);
344 * gst_registry_add_path:
345 * @registry: the registry to add the path to
346 * @path: the path to add to the registry
348 * Add the given path to the registry. The syntax of the
349 * path is specific to the registry. If the path has already been
353 gst_registry_add_path (GstRegistry * registry, const gchar * path)
355 g_return_if_fail (GST_IS_REGISTRY (registry));
356 g_return_if_fail (path != NULL);
358 if (strlen (path) == 0)
361 GST_OBJECT_LOCK (registry);
362 if (g_list_find_custom (registry->priv->paths, path, (GCompareFunc) strcmp))
365 GST_INFO ("Adding plugin path: \"%s\"", path);
366 registry->priv->paths =
367 g_list_append (registry->priv->paths, g_strdup (path));
368 GST_OBJECT_UNLOCK (registry);
374 GST_INFO ("Ignoring empty plugin path");
379 g_warning ("path %s already added to registry", path);
380 GST_OBJECT_UNLOCK (registry);
386 * gst_registry_get_path_list:
387 * @registry: the registry to get the pathlist of
389 * Get the list of paths for the given registry.
391 * Returns: (transfer container) (element-type char*): A #GList of paths as
392 * strings. g_list_free after use.
397 gst_registry_get_path_list (GstRegistry * registry)
401 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
403 GST_OBJECT_LOCK (registry);
404 /* We don't need to copy the strings, because they won't be deleted
405 * as long as the GstRegistry is around */
406 list = g_list_copy (registry->priv->paths);
407 GST_OBJECT_UNLOCK (registry);
414 * gst_registry_add_plugin:
415 * @registry: the registry to add the plugin to
416 * @plugin: (transfer full): the plugin to add
418 * Add the plugin to the registry. The plugin-added signal will be emitted.
419 * This function will sink @plugin.
421 * Returns: TRUE on success.
426 gst_registry_add_plugin (GstRegistry * registry, GstPlugin * plugin)
428 GstPlugin *existing_plugin;
430 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
431 g_return_val_if_fail (GST_IS_PLUGIN (plugin), FALSE);
433 GST_OBJECT_LOCK (registry);
434 if (G_LIKELY (plugin->basename)) {
435 /* we have a basename, see if we find the plugin */
437 gst_registry_lookup_bn_locked (registry, plugin->basename);
438 if (existing_plugin) {
439 GST_DEBUG_OBJECT (registry,
440 "Replacing existing plugin \"%s\" %p with new plugin %p for filename \"%s\"",
441 GST_STR_NULL (existing_plugin->filename), existing_plugin, plugin,
442 GST_STR_NULL (plugin->filename));
443 /* If the new plugin is blacklisted and the existing one isn't cached, do not
444 * accept if it's from a different location than the existing one */
445 if ((plugin->flags & GST_PLUGIN_FLAG_BLACKLISTED) &&
446 strcmp (plugin->filename, existing_plugin->filename)) {
447 GST_WARNING_OBJECT (registry,
448 "Not replacing plugin because new one (%s) is blacklisted but for a different location than existing one (%s)",
449 plugin->filename, existing_plugin->filename);
450 gst_object_unref (plugin);
451 GST_OBJECT_UNLOCK (registry);
454 registry->priv->plugins =
455 g_list_remove (registry->priv->plugins, existing_plugin);
456 if (G_LIKELY (existing_plugin->basename))
457 g_hash_table_remove (registry->priv->basename_hash,
458 existing_plugin->basename);
459 gst_object_unref (existing_plugin);
463 GST_DEBUG_OBJECT (registry, "adding plugin %p for filename \"%s\"",
464 plugin, GST_STR_NULL (plugin->filename));
466 registry->priv->plugins = g_list_prepend (registry->priv->plugins, plugin);
467 if (G_LIKELY (plugin->basename))
468 g_hash_table_replace (registry->priv->basename_hash, plugin->basename,
471 gst_object_ref_sink (plugin);
472 GST_OBJECT_UNLOCK (registry);
474 GST_LOG_OBJECT (registry, "emitting plugin-added for filename \"%s\"",
475 GST_STR_NULL (plugin->filename));
476 g_signal_emit (registry, gst_registry_signals[PLUGIN_ADDED], 0, plugin);
482 gst_registry_remove_features_for_plugin_unlocked (GstRegistry * registry,
487 g_return_if_fail (GST_IS_REGISTRY (registry));
488 g_return_if_fail (GST_IS_PLUGIN (plugin));
490 /* Remove all features for this plugin */
491 f = registry->priv->features;
493 GList *next = g_list_next (f);
494 GstPluginFeature *feature = f->data;
496 if (G_UNLIKELY (feature && feature->plugin == plugin)) {
497 GST_DEBUG_OBJECT (registry, "removing feature %p (%s) for plugin %p (%s)",
498 feature, gst_plugin_feature_get_name (feature), plugin,
501 registry->priv->features =
502 g_list_delete_link (registry->priv->features, f);
503 g_hash_table_remove (registry->priv->feature_hash,
504 GST_OBJECT_NAME (feature));
505 gst_object_unparent (GST_OBJECT_CAST (feature));
509 registry->priv->cookie++;
513 * gst_registry_remove_plugin:
514 * @registry: the registry to remove the plugin from
515 * @plugin: (transfer none): the plugin to remove
517 * Remove the plugin from the registry.
522 gst_registry_remove_plugin (GstRegistry * registry, GstPlugin * plugin)
524 g_return_if_fail (GST_IS_REGISTRY (registry));
525 g_return_if_fail (GST_IS_PLUGIN (plugin));
527 GST_DEBUG_OBJECT (registry, "removing plugin %p (%s)",
528 plugin, gst_plugin_get_name (plugin));
530 GST_OBJECT_LOCK (registry);
531 registry->priv->plugins = g_list_remove (registry->priv->plugins, plugin);
532 if (G_LIKELY (plugin->basename))
533 g_hash_table_remove (registry->priv->basename_hash, plugin->basename);
534 gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
535 GST_OBJECT_UNLOCK (registry);
536 gst_object_unref (plugin);
540 * gst_registry_add_feature:
541 * @registry: the registry to add the plugin to
542 * @feature: (transfer full): the feature to add
544 * Add the feature to the registry. The feature-added signal will be emitted.
545 * This function sinks @feature.
547 * Returns: TRUE on success.
552 gst_registry_add_feature (GstRegistry * registry, GstPluginFeature * feature)
554 GstPluginFeature *existing_feature;
556 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
557 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
558 g_return_val_if_fail (GST_OBJECT_NAME (feature) != NULL, FALSE);
559 g_return_val_if_fail (feature->plugin_name != NULL, FALSE);
561 GST_OBJECT_LOCK (registry);
562 existing_feature = gst_registry_lookup_feature_locked (registry,
563 GST_OBJECT_NAME (feature));
564 if (G_UNLIKELY (existing_feature)) {
565 GST_DEBUG_OBJECT (registry, "replacing existing feature %p (%s)",
566 existing_feature, GST_OBJECT_NAME (feature));
567 /* Remove the existing feature from the list now, before we insert the new
568 * one, but don't unref yet because the hash is still storing a reference to
570 registry->priv->features =
571 g_list_remove (registry->priv->features, existing_feature);
574 GST_DEBUG_OBJECT (registry, "adding feature %p (%s)", feature,
575 GST_OBJECT_NAME (feature));
577 registry->priv->features = g_list_prepend (registry->priv->features, feature);
578 g_hash_table_replace (registry->priv->feature_hash, GST_OBJECT_NAME (feature),
581 if (G_UNLIKELY (existing_feature)) {
582 /* We unref now. No need to remove the feature name from the hash table, it
583 * got replaced by the new feature */
584 gst_object_unparent (GST_OBJECT_CAST (existing_feature));
587 gst_object_set_parent (GST_OBJECT_CAST (feature), GST_OBJECT_CAST (registry));
589 registry->priv->cookie++;
590 GST_OBJECT_UNLOCK (registry);
592 GST_LOG_OBJECT (registry, "emitting feature-added for %s",
593 GST_OBJECT_NAME (feature));
594 g_signal_emit (registry, gst_registry_signals[FEATURE_ADDED], 0, feature);
600 * gst_registry_remove_feature:
601 * @registry: the registry to remove the feature from
602 * @feature: (transfer none): the feature to remove
604 * Remove the feature from the registry.
609 gst_registry_remove_feature (GstRegistry * registry, GstPluginFeature * feature)
611 g_return_if_fail (GST_IS_REGISTRY (registry));
612 g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
614 GST_DEBUG_OBJECT (registry, "removing feature %p (%s)",
615 feature, gst_plugin_feature_get_name (feature));
617 GST_OBJECT_LOCK (registry);
618 registry->priv->features = g_list_remove (registry->priv->features, feature);
619 g_hash_table_remove (registry->priv->feature_hash, GST_OBJECT_NAME (feature));
620 registry->priv->cookie++;
621 GST_OBJECT_UNLOCK (registry);
623 gst_object_unparent ((GstObject *) feature);
627 * gst_registry_plugin_filter:
628 * @registry: registry to query
629 * @filter: (scope call): the filter to use
630 * @first: only return first match
631 * @user_data: (closure): user data passed to the filter function
633 * Runs a filter against all plugins in the registry and returns a #GList with
634 * the results. If the first flag is set, only the first match is
635 * returned (as a list with a single object).
636 * Every plugin is reffed; use gst_plugin_list_free() after use, which
639 * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
640 * Use gst_plugin_list_free() after usage.
645 gst_registry_plugin_filter (GstRegistry * registry,
646 GstPluginFilter filter, gboolean first, gpointer user_data)
650 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
652 GST_OBJECT_LOCK (registry);
656 for (walk = registry->priv->plugins; walk != NULL; walk = walk->next) {
657 GstPlugin *plugin = walk->data;
659 if (filter == NULL || filter (plugin, user_data)) {
660 list = g_list_prepend (list, gst_object_ref (plugin));
667 GST_OBJECT_UNLOCK (registry);
679 gst_plugin_feature_type_name_filter (GstPluginFeature * feature,
680 GstTypeNameData * data)
682 g_assert (GST_IS_PLUGIN_FEATURE (feature));
684 return ((data->type == 0 || data->type == G_OBJECT_TYPE (feature)) &&
685 (data->name == NULL || !strcmp (data->name, GST_OBJECT_NAME (feature))));
688 /* returns TRUE if the list was changed
690 * Must be called with the object lock taken */
692 gst_registry_get_feature_list_or_create (GstRegistry * registry,
693 GList ** previous, guint32 * cookie, GType type)
695 gboolean res = FALSE;
696 GstRegistryPrivate *priv = registry->priv;
698 if (G_UNLIKELY (!*previous || priv->cookie != *cookie)) {
699 GstTypeNameData data;
703 gst_plugin_feature_list_free (*previous);
710 for (walk = registry->priv->features; walk != NULL; walk = walk->next) {
711 GstPluginFeature *feature = walk->data;
713 if (gst_plugin_feature_type_name_filter (feature, &data)) {
714 *previous = g_list_prepend (*previous, gst_object_ref (feature));
718 *cookie = priv->cookie;
726 type_find_factory_rank_cmp (const GstPluginFeature * fac1,
727 const GstPluginFeature * fac2)
729 if (G_LIKELY (fac1->rank != fac2->rank))
730 return fac2->rank - fac1->rank;
732 /* to make the order in which things happen more deterministic,
733 * sort by name when the ranks are the same. */
734 return strcmp (GST_OBJECT_NAME (fac1), GST_OBJECT_NAME (fac2));
738 gst_registry_get_element_factory_list (GstRegistry * registry)
742 GST_OBJECT_LOCK (registry);
744 gst_registry_get_feature_list_or_create (registry,
745 ®istry->priv->element_factory_list, ®istry->priv->efl_cookie,
746 GST_TYPE_ELEMENT_FACTORY);
748 /* Return reffed copy */
749 list = gst_plugin_feature_list_copy (registry->priv->element_factory_list);
751 GST_OBJECT_UNLOCK (registry);
757 gst_registry_get_typefind_factory_list (GstRegistry * registry)
761 GST_OBJECT_LOCK (registry);
763 if (G_UNLIKELY (gst_registry_get_feature_list_or_create (registry,
764 ®istry->priv->typefind_factory_list,
765 ®istry->priv->tfl_cookie, GST_TYPE_TYPE_FIND_FACTORY)))
766 registry->priv->typefind_factory_list =
767 g_list_sort (registry->priv->typefind_factory_list,
768 (GCompareFunc) type_find_factory_rank_cmp);
770 /* Return reffed copy */
771 list = gst_plugin_feature_list_copy (registry->priv->typefind_factory_list);
773 GST_OBJECT_UNLOCK (registry);
779 * gst_registry_feature_filter:
780 * @registry: registry to query
781 * @filter: (scope call): the filter to use
782 * @first: only return first match
783 * @user_data: (closure): user data passed to the filter function
785 * Runs a filter against all features of the plugins in the registry
786 * and returns a GList with the results.
787 * If the first flag is set, only the first match is
788 * returned (as a list with a single object).
790 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
791 * #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
796 gst_registry_feature_filter (GstRegistry * registry,
797 GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
801 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
803 GST_OBJECT_LOCK (registry);
807 for (walk = registry->priv->features; walk != NULL; walk = walk->next) {
808 GstPluginFeature *feature = walk->data;
810 if (filter == NULL || filter (feature, user_data)) {
811 list = g_list_prepend (list, gst_object_ref (feature));
818 GST_OBJECT_UNLOCK (registry);
824 * gst_registry_find_plugin:
825 * @registry: the registry to search
826 * @name: the plugin name to find
828 * Find the plugin with the given name in the registry.
829 * The plugin will be reffed; caller is responsible for unreffing.
831 * Returns: (transfer full): the plugin with the given name or NULL if the
832 * plugin was not found. gst_object_unref() after usage.
837 gst_registry_find_plugin (GstRegistry * registry, const gchar * name)
840 GstPlugin *result = NULL;
842 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
843 g_return_val_if_fail (name != NULL, NULL);
845 walk = gst_registry_plugin_filter (registry,
846 (GstPluginFilter) gst_plugin_name_filter, TRUE, (gpointer) name);
848 result = GST_PLUGIN_CAST (walk->data);
850 gst_object_ref (result);
851 gst_plugin_list_free (walk);
858 * gst_registry_find_feature:
859 * @registry: the registry to search
860 * @name: the pluginfeature name to find
861 * @type: the pluginfeature type to find
863 * Find the pluginfeature with the given name and type in the registry.
865 * Returns: (transfer full): the pluginfeature with the given name and type
866 * or NULL if the plugin was not found. gst_object_unref() after usage.
871 gst_registry_find_feature (GstRegistry * registry, const gchar * name,
874 GstPluginFeature *feature = NULL;
876 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
877 g_return_val_if_fail (name != NULL, NULL);
878 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
880 feature = gst_registry_lookup_feature (registry, name);
881 if (feature && !g_type_is_a (G_TYPE_FROM_INSTANCE (feature), type)) {
882 gst_object_unref (feature);
890 * gst_registry_get_feature_list:
891 * @registry: a #GstRegistry
894 * Retrieves a #GList of #GstPluginFeature of @type.
896 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
897 * #GstPluginFeature of @type. Use gst_plugin_feature_list_free() after use
902 gst_registry_get_feature_list (GstRegistry * registry, GType type)
904 GstTypeNameData data;
906 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
907 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
910 if (type == GST_TYPE_ELEMENT_FACTORY)
911 return gst_registry_get_element_factory_list (registry);
912 else if (type == GST_TYPE_TYPE_FIND_FACTORY)
913 return gst_registry_get_typefind_factory_list (registry);
918 return gst_registry_feature_filter (registry,
919 (GstPluginFeatureFilter) gst_plugin_feature_type_name_filter,
924 * gst_registry_get_plugin_list:
925 * @registry: the registry to search
927 * Get a copy of all plugins registered in the given registry. The refcount
928 * of each element in the list in incremented.
930 * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
931 * Use gst_plugin_list_free() after usage.
936 gst_registry_get_plugin_list (GstRegistry * registry)
941 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
943 GST_OBJECT_LOCK (registry);
944 list = g_list_copy (registry->priv->plugins);
945 for (g = list; g; g = g->next) {
946 gst_object_ref (GST_PLUGIN_CAST (g->data));
948 GST_OBJECT_UNLOCK (registry);
953 static GstPluginFeature *
954 gst_registry_lookup_feature_locked (GstRegistry * registry, const char *name)
956 return g_hash_table_lookup (registry->priv->feature_hash, name);
960 * gst_registry_lookup_feature:
961 * @registry: a #GstRegistry
962 * @name: a #GstPluginFeature name
964 * Find a #GstPluginFeature with @name in @registry.
966 * Returns: (transfer full): a #GstPluginFeature with its refcount incremented,
967 * use gst_object_unref() after usage.
972 gst_registry_lookup_feature (GstRegistry * registry, const char *name)
974 GstPluginFeature *feature;
976 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
977 g_return_val_if_fail (name != NULL, NULL);
979 GST_OBJECT_LOCK (registry);
980 feature = gst_registry_lookup_feature_locked (registry, name);
982 gst_object_ref (feature);
983 GST_OBJECT_UNLOCK (registry);
989 gst_registry_lookup_bn_locked (GstRegistry * registry, const char *basename)
991 return g_hash_table_lookup (registry->priv->basename_hash, basename);
995 gst_registry_lookup_bn (GstRegistry * registry, const char *basename)
999 GST_OBJECT_LOCK (registry);
1000 plugin = gst_registry_lookup_bn_locked (registry, basename);
1002 gst_object_ref (plugin);
1003 GST_OBJECT_UNLOCK (registry);
1009 * gst_registry_lookup:
1010 * @registry: the registry to look up in
1011 * @filename: the name of the file to look up
1013 * Look up a plugin in the given registry with the given filename.
1014 * If found, plugin is reffed.
1016 * Returns: (transfer full): the #GstPlugin if found, or NULL if not.
1017 * gst_object_unref() after usage.
1020 gst_registry_lookup (GstRegistry * registry, const char *filename)
1025 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1026 g_return_val_if_fail (filename != NULL, NULL);
1028 basename = g_path_get_basename (filename);
1029 if (G_UNLIKELY (basename == NULL))
1032 plugin = gst_registry_lookup_bn (registry, basename);
1041 REGISTRY_SCAN_HELPER_NOT_STARTED = 0,
1042 REGISTRY_SCAN_HELPER_DISABLED,
1043 REGISTRY_SCAN_HELPER_RUNNING
1044 } GstRegistryScanHelperState;
1048 GstRegistry *registry;
1049 GstRegistryScanHelperState helper_state;
1050 GstPluginLoader *helper;
1052 } GstRegistryScanContext;
1055 init_scan_context (GstRegistryScanContext * context, GstRegistry * registry)
1059 context->registry = registry;
1061 /* see if forking is enabled and set up the scan helper state accordingly */
1062 do_fork = _gst_enable_registry_fork;
1064 const gchar *fork_env;
1066 /* forking enabled, see if it is disabled with an env var */
1067 if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) {
1068 /* fork enabled for any value different from "no" */
1069 do_fork = strcmp (fork_env, "no") != 0;
1074 context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1076 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1078 context->helper = NULL;
1079 context->changed = FALSE;
1083 clear_scan_context (GstRegistryScanContext * context)
1085 if (context->helper) {
1086 context->changed |= _priv_gst_plugin_loader_funcs.destroy (context->helper);
1087 context->helper = NULL;
1092 gst_registry_scan_plugin_file (GstRegistryScanContext * context,
1093 const gchar * filename, off_t file_size, time_t file_mtime)
1095 gboolean changed = FALSE;
1096 GstPlugin *newplugin = NULL;
1099 /* Disable external plugin loader on Windows until it is ported properly. */
1100 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1104 /* Have a plugin to load - see if the scan-helper needs starting */
1105 if (context->helper_state == REGISTRY_SCAN_HELPER_NOT_STARTED) {
1106 GST_DEBUG ("Starting plugin scanner for file %s", filename);
1107 context->helper = _priv_gst_plugin_loader_funcs.create (context->registry);
1108 if (context->helper != NULL)
1109 context->helper_state = REGISTRY_SCAN_HELPER_RUNNING;
1111 GST_WARNING ("Failed starting plugin scanner. Scanning in-process");
1112 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1116 if (context->helper_state == REGISTRY_SCAN_HELPER_RUNNING) {
1117 GST_DEBUG ("Using scan-helper to load plugin %s", filename);
1118 if (!_priv_gst_plugin_loader_funcs.load (context->helper,
1119 filename, file_size, file_mtime)) {
1120 g_warning ("External plugin loader failed. This most likely means that "
1121 "the plugin loader helper binary was not found or could not be run. "
1122 "%s", (g_getenv ("GST_PLUGIN_PATH") != NULL) ?
1123 "If you are running an uninstalled GStreamer setup, you might need "
1124 "to update your gst-uninstalled script so that the "
1125 "GST_PLUGIN_SCANNER environment variable gets set." : "");
1126 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1130 /* Check if the helper is disabled (or just got disabled above) */
1131 if (context->helper_state == REGISTRY_SCAN_HELPER_DISABLED) {
1132 /* Load plugin the old fashioned way... */
1134 /* We don't use a GError here because a failure to load some shared
1135 * objects as plugins is normal (particularly in the uninstalled case)
1137 newplugin = gst_plugin_load_file (filename, NULL);
1141 GST_DEBUG_OBJECT (context->registry, "marking new plugin %p as registered",
1143 newplugin->registered = TRUE;
1144 gst_object_unref (newplugin);
1148 if (!__registry_reuse_plugin_scanner) {
1149 clear_scan_context (context);
1150 context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1157 is_blacklisted_hidden_directory (const gchar * dirent)
1159 if (G_LIKELY (dirent[0] != '.'))
1162 /* skip the .debug directory, these contain elf files that are not
1163 * useful or worse, can crash dlopen () */
1164 if (strcmp (dirent, ".debug") == 0)
1167 /* can also skip .git and .deps dirs, those won't contain useful files.
1168 * This speeds up scanning a bit in uninstalled setups. */
1169 if (strcmp (dirent, ".git") == 0 || strcmp (dirent, ".deps") == 0)
1176 gst_registry_scan_path_level (GstRegistryScanContext * context,
1177 const gchar * path, int level)
1180 const gchar *dirent;
1183 gboolean changed = FALSE;
1185 dir = g_dir_open (path, 0, NULL);
1189 while ((dirent = g_dir_read_name (dir))) {
1190 GStatBuf file_status;
1192 filename = g_build_filename (path, dirent, NULL);
1193 if (g_stat (filename, &file_status) < 0) {
1194 /* Plugin will be removed from cache after the scan completes if it
1195 * is still marked 'cached' */
1200 if (file_status.st_mode & S_IFDIR) {
1201 if (G_UNLIKELY (is_blacklisted_hidden_directory (dirent))) {
1202 GST_TRACE_OBJECT (context->registry, "ignoring %s directory", dirent);
1206 /* FIXME 0.11: Don't recurse into directories, this behaviour
1207 * is inconsistent with other PATH environment variables
1210 GST_LOG_OBJECT (context->registry, "recursing into directory %s",
1212 changed |= gst_registry_scan_path_level (context, filename, level - 1);
1214 GST_LOG_OBJECT (context->registry, "not recursing into directory %s, "
1215 "recursion level too deep", filename);
1220 if (!(file_status.st_mode & S_IFREG)) {
1221 GST_TRACE_OBJECT (context->registry, "%s is not a regular file, ignoring",
1226 if (!g_str_has_suffix (dirent, G_MODULE_SUFFIX)
1227 #ifdef GST_EXTRA_MODULE_SUFFIX
1228 && !g_str_has_suffix (dirent, GST_EXTRA_MODULE_SUFFIX)
1231 GST_TRACE_OBJECT (context->registry,
1232 "extension is not recognized as module file, ignoring file %s",
1238 GST_LOG_OBJECT (context->registry, "file %s looks like a possible module",
1241 /* try to avoid unnecessary plugin-move pain */
1242 if (g_str_has_prefix (dirent, "libgstvalve") ||
1243 g_str_has_prefix (dirent, "libgstselector")) {
1244 GST_WARNING_OBJECT (context->registry, "ignoring old plugin %s which "
1245 "has been merged into the corelements plugin", filename);
1246 /* Plugin will be removed from cache after the scan completes if it
1247 * is still marked 'cached' */
1252 /* plug-ins are considered unique by basename; if the given name
1253 * was already seen by the registry, we ignore it */
1254 plugin = gst_registry_lookup_bn (context->registry, dirent);
1256 gboolean env_vars_changed, deps_changed = FALSE;
1258 if (plugin->registered) {
1259 GST_DEBUG_OBJECT (context->registry,
1260 "plugin already registered from path \"%s\"",
1261 GST_STR_NULL (plugin->filename));
1263 gst_object_unref (plugin);
1267 env_vars_changed = _priv_plugin_deps_env_vars_changed (plugin);
1269 /* If a file with a certain basename is seen on a different path,
1270 * update the plugin to ensure the registry cache will reflect up
1271 * to date information */
1273 if (plugin->file_mtime == file_status.st_mtime &&
1274 plugin->file_size == file_status.st_size && !env_vars_changed &&
1275 !(deps_changed = _priv_plugin_deps_files_changed (plugin)) &&
1276 !strcmp (plugin->filename, filename)) {
1277 GST_LOG_OBJECT (context->registry, "file %s cached", filename);
1278 plugin->flags &= ~GST_PLUGIN_FLAG_CACHED;
1279 GST_LOG_OBJECT (context->registry,
1280 "marking plugin %p as registered as %s", plugin, filename);
1281 plugin->registered = TRUE;
1283 GST_INFO_OBJECT (context->registry, "cached info for %s is stale",
1285 GST_DEBUG_OBJECT (context->registry, "mtime %" G_GINT64_FORMAT " != %"
1286 G_GINT64_FORMAT " or size %" G_GINT64_FORMAT " != %"
1287 G_GINT64_FORMAT " or external dependency env_vars changed: %d or"
1288 " external dependencies changed: %d or old path %s != new path %s",
1289 (gint64) plugin->file_mtime, (gint64) file_status.st_mtime,
1290 (gint64) plugin->file_size, (gint64) file_status.st_size,
1291 env_vars_changed, deps_changed, plugin->filename, filename);
1292 gst_registry_remove_plugin (context->registry, plugin);
1293 changed |= gst_registry_scan_plugin_file (context, filename,
1294 file_status.st_size, file_status.st_mtime);
1296 gst_object_unref (plugin);
1299 GST_DEBUG_OBJECT (context->registry, "file %s not yet in registry",
1301 changed |= gst_registry_scan_plugin_file (context, filename,
1302 file_status.st_size, file_status.st_mtime);
1314 gst_registry_scan_path_internal (GstRegistryScanContext * context,
1319 GST_DEBUG_OBJECT (context->registry, "scanning path %s", path);
1320 changed = gst_registry_scan_path_level (context, path, 10);
1322 GST_DEBUG_OBJECT (context->registry, "registry changed in path %s: %d", path,
1328 * gst_registry_scan_path:
1329 * @registry: the registry to add found plugins to
1330 * @path: the path to scan
1332 * Scan the given path for plugins to add to the registry. The syntax of the
1333 * path is specific to the registry.
1335 * Returns: %TRUE if registry changed
1338 gst_registry_scan_path (GstRegistry * registry, const gchar * path)
1340 GstRegistryScanContext context;
1343 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1344 g_return_val_if_fail (path != NULL, FALSE);
1346 init_scan_context (&context, registry);
1348 result = gst_registry_scan_path_internal (&context, path);
1350 clear_scan_context (&context);
1351 result |= context.changed;
1357 _gst_plugin_feature_filter_plugin_name (GstPluginFeature * feature,
1360 return (strcmp (feature->plugin_name, (gchar *) user_data) == 0);
1364 * gst_registry_get_feature_list_by_plugin:
1365 * @registry: a #GstRegistry.
1366 * @name: a plugin name.
1368 * Retrieves a #GList of features of the plugin with name @name.
1370 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
1371 * #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
1374 gst_registry_get_feature_list_by_plugin (GstRegistry * registry,
1377 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1378 g_return_val_if_fail (name != NULL, NULL);
1380 return gst_registry_feature_filter (registry,
1381 _gst_plugin_feature_filter_plugin_name, FALSE, (gpointer) name);
1384 /* Unref and delete the default registry */
1386 _priv_gst_registry_cleanup (void)
1388 GstRegistry *registry;
1390 g_static_mutex_lock (&_gst_registry_mutex);
1391 if ((registry = _gst_registry_default) != NULL) {
1392 _gst_registry_default = NULL;
1394 g_static_mutex_unlock (&_gst_registry_mutex);
1396 /* unref outside of the lock because we can. */
1398 gst_object_unref (registry);
1402 * gst_default_registry_check_feature_version:
1403 * @feature_name: the name of the feature (e.g. "oggdemux")
1404 * @min_major: the minimum major version number
1405 * @min_minor: the minimum minor version number
1406 * @min_micro: the minimum micro version number
1408 * Checks whether a plugin feature by the given name exists in the
1409 * default registry and whether its version is at least the
1412 * Returns: #TRUE if the feature could be found and the version is
1413 * the same as the required version or newer, and #FALSE otherwise.
1416 gst_default_registry_check_feature_version (const gchar * feature_name,
1417 guint min_major, guint min_minor, guint min_micro)
1419 GstPluginFeature *feature;
1420 GstRegistry *registry;
1421 gboolean ret = FALSE;
1423 g_return_val_if_fail (feature_name != NULL, FALSE);
1425 GST_DEBUG ("Looking up plugin feature '%s'", feature_name);
1427 registry = gst_registry_get_default ();
1428 feature = gst_registry_lookup_feature (registry, feature_name);
1430 ret = gst_plugin_feature_check_version (feature, min_major, min_minor,
1432 gst_object_unref (feature);
1434 GST_DEBUG ("Could not find plugin feature '%s'", feature_name);
1441 load_plugin_func (gpointer data, gpointer user_data)
1444 const gchar *filename;
1447 filename = (const gchar *) data;
1448 GST_DEBUG ("Pre-loading plugin %s", filename);
1450 plugin = gst_plugin_load_file (filename, &err);
1453 GST_INFO ("Loaded plugin: \"%s\"", filename);
1455 gst_default_registry_add_plugin (plugin);
1458 /* Report error to user, and free error */
1459 GST_ERROR ("Failed to load plugin: %s", err->message);
1462 GST_WARNING ("Failed to load plugin: \"%s\"", filename);
1467 #ifndef GST_DISABLE_REGISTRY
1468 /* Unref all plugins marked 'cached', to clear old plugins that no
1469 * longer exist. Returns TRUE if any plugins were removed */
1471 gst_registry_remove_cache_plugins (GstRegistry * registry)
1476 gboolean changed = FALSE;
1478 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1480 GST_OBJECT_LOCK (registry);
1482 GST_DEBUG_OBJECT (registry, "removing cached plugins");
1483 g = registry->priv->plugins;
1487 if (plugin->flags & GST_PLUGIN_FLAG_CACHED) {
1488 GST_DEBUG_OBJECT (registry, "removing cached plugin \"%s\"",
1489 GST_STR_NULL (plugin->filename));
1490 registry->priv->plugins = g_list_delete_link (registry->priv->plugins, g);
1491 if (G_LIKELY (plugin->basename))
1492 g_hash_table_remove (registry->priv->basename_hash, plugin->basename);
1493 gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
1494 gst_object_unref (plugin);
1500 GST_OBJECT_UNLOCK (registry);
1507 REGISTRY_SCAN_AND_UPDATE_FAILURE = 0,
1508 REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED,
1509 REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED
1510 } GstRegistryScanAndUpdateResult;
1513 * scan_and_update_registry:
1514 * @default_registry: the #GstRegistry
1515 * @registry_file: registry filename
1516 * @write_changes: write registry if it has changed?
1518 * Scans for registry changes and eventually updates the registry cache.
1520 * Return: %REGISTRY_SCAN_AND_UPDATE_FAILURE if the registry could not scanned
1521 * or updated, %REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED if the
1522 * registry is clean and %REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED if
1523 * it has been updated and the cache needs to be re-read.
1525 static GstRegistryScanAndUpdateResult
1526 scan_and_update_registry (GstRegistry * default_registry,
1527 const gchar * registry_file, gboolean write_changes, GError ** error)
1529 const gchar *plugin_path;
1530 gboolean changed = FALSE;
1532 GstRegistryScanContext context;
1534 GST_INFO ("Validating plugins from registry cache: %s", registry_file);
1536 init_scan_context (&context, default_registry);
1538 /* It sounds tempting to just compare the mtime of directories with the mtime
1539 * of the registry cache, but it does not work. It would not catch updated
1540 * plugins, which might bring more or less features.
1543 /* scan paths specified via --gst-plugin-path */
1544 GST_DEBUG ("scanning paths added via --gst-plugin-path");
1545 for (l = _priv_gst_plugin_paths; l != NULL; l = l->next) {
1546 GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data);
1547 changed |= gst_registry_scan_path_internal (&context, (gchar *) l->data);
1549 /* keep plugin_paths around in case a re-scan is forced later on */
1551 /* GST_PLUGIN_PATH specifies a list of directories to scan for
1552 * additional plugins. These take precedence over the system plugins */
1553 plugin_path = g_getenv ("GST_PLUGIN_PATH");
1558 GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path);
1559 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1560 for (i = 0; list[i]; i++) {
1561 changed |= gst_registry_scan_path_internal (&context, list[i]);
1565 GST_DEBUG ("GST_PLUGIN_PATH not set");
1568 /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always
1569 * loaded by default. If not set, this defaults to the system-installed
1570 * path, and the plugins installed in the user's home directory */
1571 plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH");
1572 if (plugin_path == NULL) {
1575 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set");
1577 /* plugins in the user's home directory take precedence over
1578 * system-installed ones */
1579 home_plugins = g_build_filename (g_get_user_data_dir (),
1580 "gstreamer-" GST_MAJORMINOR, "plugins", NULL);
1582 GST_DEBUG ("scanning home plugins %s", home_plugins);
1583 changed |= gst_registry_scan_path_internal (&context, home_plugins);
1584 g_free (home_plugins);
1586 /* add the main (installed) library path */
1587 GST_DEBUG ("scanning main plugins %s", PLUGINDIR);
1588 changed |= gst_registry_scan_path_internal (&context, PLUGINDIR);
1596 g_win32_get_package_installation_directory_of_module
1597 (_priv_gst_dll_handle);
1599 dir = g_build_filename (base_dir, "lib", "gstreamer-0.10", NULL);
1600 GST_DEBUG ("scanning DLL dir %s", dir);
1602 changed |= gst_registry_scan_path_internal (&context, dir);
1612 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path);
1613 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1614 for (i = 0; list[i]; i++) {
1615 changed |= gst_registry_scan_path_internal (&context, list[i]);
1620 clear_scan_context (&context);
1621 changed |= context.changed;
1623 /* Remove cached plugins so stale info is cleared. */
1624 changed |= gst_registry_remove_cache_plugins (default_registry);
1627 GST_INFO ("Registry cache has not changed");
1628 return REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED;
1631 if (!write_changes) {
1632 GST_INFO ("Registry cache changed, but writing is disabled. Not writing.");
1633 return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1636 GST_INFO ("Registry cache changed. Writing new registry cache");
1637 if (!priv_gst_registry_binary_write_cache (default_registry,
1638 default_registry->priv->plugins, registry_file)) {
1639 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
1640 _("Error writing registry cache to %s: %s"),
1641 registry_file, g_strerror (errno));
1642 return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1645 GST_INFO ("Registry cache written successfully");
1646 return REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED;
1650 ensure_current_registry (GError ** error)
1652 gchar *registry_file;
1653 GstRegistry *default_registry;
1654 gboolean ret = TRUE;
1655 gboolean do_update = TRUE;
1656 gboolean have_cache = TRUE;
1658 default_registry = gst_registry_get_default ();
1659 registry_file = g_strdup (g_getenv ("GST_REGISTRY"));
1660 if (registry_file == NULL) {
1661 registry_file = g_build_filename (g_get_user_cache_dir (),
1662 "gstreamer-" GST_MAJORMINOR, "registry." HOST_CPU ".bin", NULL);
1665 if (!_gst_disable_registry_cache) {
1666 GST_INFO ("reading registry cache: %s", registry_file);
1667 have_cache = priv_gst_registry_binary_read_cache (default_registry,
1669 /* Only ever read the registry cache once, then disable it for
1670 * subsequent updates during the program lifetime */
1671 _gst_disable_registry_cache = TRUE;
1675 do_update = !_priv_gst_disable_registry_update;
1677 const gchar *update_env;
1679 if ((update_env = g_getenv ("GST_REGISTRY_UPDATE"))) {
1680 /* do update for any value different from "no" */
1681 do_update = (strcmp (update_env, "no") != 0);
1687 const gchar *reuse_env;
1689 if ((reuse_env = g_getenv ("GST_REGISTRY_REUSE_PLUGIN_SCANNER"))) {
1690 /* do reuse for any value different from "no" */
1691 __registry_reuse_plugin_scanner = (strcmp (reuse_env, "no") != 0);
1693 /* now check registry */
1694 GST_DEBUG ("Updating registry cache");
1695 scan_and_update_registry (default_registry, registry_file, TRUE, error);
1697 GST_DEBUG ("Not updating registry cache (disabled)");
1700 g_free (registry_file);
1701 GST_INFO ("registry reading and updating done, result = %d", ret);
1705 #endif /* GST_DISABLE_REGISTRY */
1708 * gst_registry_fork_is_enabled:
1710 * By default GStreamer will perform scanning and rebuilding of the
1711 * registry file using a helper child process.
1713 * Applications might want to disable this behaviour with the
1714 * gst_registry_fork_set_enabled() function, in which case new plugins
1715 * are scanned (and loaded) into the application process.
1717 * Returns: %TRUE if GStreamer will use the child helper process when
1718 * rebuilding the registry.
1723 gst_registry_fork_is_enabled (void)
1725 return _gst_enable_registry_fork;
1729 * gst_registry_fork_set_enabled:
1730 * @enabled: whether rebuilding the registry can use a temporary child helper process.
1732 * Applications might want to disable/enable spawning of a child helper process
1733 * when rebuilding the registry. See gst_registry_fork_is_enabled() for more
1739 gst_registry_fork_set_enabled (gboolean enabled)
1741 _gst_enable_registry_fork = enabled;
1745 * gst_update_registry:
1747 * Forces GStreamer to re-scan its plugin paths and update the default
1750 * Applications will almost never need to call this function, it is only
1751 * useful if the application knows new plugins have been installed (or old
1752 * ones removed) since the start of the application (or, to be precise, the
1753 * first call to gst_init()) and the application wants to make use of any
1754 * newly-installed plugins without restarting the application.
1756 * Applications should assume that the registry update is neither atomic nor
1757 * thread-safe and should therefore not have any dynamic pipelines running
1758 * (including the playbin and decodebin elements) and should also not create
1759 * any elements or access the GStreamer registry while the update is in
1762 * Note that this function may block for a significant amount of time.
1764 * Returns: %TRUE if the registry has been updated successfully (does not
1765 * imply that there were changes), otherwise %FALSE.
1770 gst_update_registry (void)
1774 #ifndef GST_DISABLE_REGISTRY
1777 res = ensure_current_registry (&err);
1779 GST_WARNING ("registry update failed: %s", err->message);
1782 GST_LOG ("registry update succeeded");
1786 GST_WARNING ("registry update failed: %s", "registry disabled");
1788 #endif /* GST_DISABLE_REGISTRY */
1790 if (_priv_gst_preload_plugins) {
1791 GST_DEBUG ("Preloading indicated plugins...");
1792 g_slist_foreach (_priv_gst_preload_plugins, load_plugin_func, NULL);
1799 * gst_registry_get_feature_list_cookie:
1800 * @registry: the registry
1802 * Returns the registrys feature list cookie. This changes
1803 * every time a feature is added or removed from the registry.
1805 * Returns: the feature list cookie.
1810 gst_registry_get_feature_list_cookie (GstRegistry * registry)
1812 g_return_val_if_fail (GST_IS_REGISTRY (registry), 0);
1814 return registry->priv->cookie;