/* GStreamer * Copyright (C) 1999,2000 Erik Walthinsen * 2000 Wim Taymans * 2005 David A. Schleef * * gstregistry.c: handle registry * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ /** * SECTION:gstregistry * @short_description: Abstract base class for management of #GstPlugin objects * @see_also: #GstPlugin, #GstPluginFeature * * One registry holds the metadata of a set of plugins. * * Design: * * The #GstRegistry object is a list of plugins and some functions for dealing * with them. #GstPlugins are matched 1-1 with a file on disk, and may or may * not be loaded at a given time. There may be multiple #GstRegistry objects, * but the "default registry" is the only object that has any meaning to the * core. * * The registry.xml file is actually a cache of plugin information. This is * unlike versions prior to 0.10, where the registry file was the primary source * of plugin information, and was created by the gst-register command. * * The primary source, at all times, of plugin information is each plugin file * itself. Thus, if an application wants information about a particular plugin, * or wants to search for a feature that satisfies given criteria, the primary * means of doing so is to load every plugin and look at the resulting * information that is gathered in the default registry. Clearly, this is a time * consuming process, so we cache information in the registry.xml file. * * On startup, plugins are searched for in the plugin search path. This path can * be set directly using the %GST_PLUGIN_PATH environment variable. The registry * file is loaded from ~/.gstreamer-$GST_MAJORMINOR/registry-$ARCH.xml or the * file listed in the %GST_REGISTRY env var. The only reason to change the * registry location is for testing. * * For each plugin that is found in the plugin search path, there could be 3 * possibilities for cached information: * * * the cache may not contain information about a given file. * * * the cache may have stale information. * * * the cache may have current information. * * * * In the first two cases, the plugin is loaded and the cache updated. In * addition to these cases, the cache may have entries for plugins that are not * relevant to the current process. These are marked as not available to the * current process. If the cache is updated for whatever reason, it is marked * dirty. * * A dirty cache is written out at the end of initialization. Each entry is * checked to make sure the information is minimally valid. If not, the entry is * simply dropped. * * Implementation notes: * * The "cache" and "default registry" are different concepts and can represent * different sets of plugins. For various reasons, at init time, the cache is * stored in the default registry, and plugins not relevant to the current * process are marked with the %GST_PLUGIN_FLAG_CACHED bit. These plugins are * removed at the end of intitialization. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "gstconfig.h" #include "gst_private.h" #include #include #include #ifdef HAVE_UNISTD_H #include #endif #include #include #include /* For g_stat () */ #include #include "gstinfo.h" #include "gsterror.h" #include "gstregistry.h" #include "gstmarshal.h" #include "gstfilter.h" #include "gstpluginloader.h" #include "gst-i18n-lib.h" /* needed for fast retrieval of element and typefind factory lists */ extern GType gst_type_find_factory_get_type (void); #define GST_TYPE_TYPE_FIND_FACTORY (gst_type_find_factory_get_type()) extern GType gst_element_factory_get_type (void); #define GST_TYPE_ELEMENT_FACTORY (gst_element_factory_get_type()) #define GST_CAT_DEFAULT GST_CAT_REGISTRY struct _GstRegistryPrivate { /* updated whenever the feature list changes */ guint32 cookie; /* speedup for searching features */ GList *element_factory_list; guint32 efl_cookie; GList *typefind_factory_list; guint32 tfl_cookie; }; /* the one instance of the default registry and the mutex protecting the * variable. */ static GStaticMutex _gst_registry_mutex = G_STATIC_MUTEX_INIT; static GstRegistry *_gst_registry_default = NULL; /* defaults */ #define DEFAULT_FORK TRUE /* control the behaviour of registry rebuild */ static gboolean _gst_enable_registry_fork = DEFAULT_FORK; /* List of plugins that need preloading/reloading after scanning registry */ extern GSList *_priv_gst_preload_plugins; #ifndef GST_DISABLE_REGISTRY /*set to TRUE when registry needn't to be updated */ gboolean _priv_gst_disable_registry_update = FALSE; extern GList *_priv_gst_plugin_paths; /* Set to TRUE when the registry cache should be disabled */ gboolean _gst_disable_registry_cache = FALSE; #endif /* Element signals and args */ enum { PLUGIN_ADDED, FEATURE_ADDED, LAST_SIGNAL }; static void gst_registry_finalize (GObject * object); static guint gst_registry_signals[LAST_SIGNAL] = { 0 }; static GstPluginFeature *gst_registry_lookup_feature_locked (GstRegistry * registry, const char *name); static GstPlugin *gst_registry_lookup_bn_locked (GstRegistry * registry, const char *basename); G_DEFINE_TYPE (GstRegistry, gst_registry, GST_TYPE_OBJECT); static GstObjectClass *parent_class = NULL; static void gst_registry_class_init (GstRegistryClass * klass) { GObjectClass *gobject_class; gobject_class = (GObjectClass *) klass; parent_class = g_type_class_peek_parent (klass); g_type_class_add_private (klass, sizeof (GstRegistryPrivate)); /** * GstRegistry::plugin-added: * @registry: the registry that emitted the signal * @plugin: the plugin that has been added * * Signals that a plugin has been added to the registry (possibly * replacing a previously-added one by the same name) */ gst_registry_signals[PLUGIN_ADDED] = g_signal_new ("plugin-added", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRegistryClass, plugin_added), NULL, NULL, gst_marshal_VOID__POINTER, G_TYPE_NONE, 1, G_TYPE_POINTER); /** * GstRegistry::feature-added: * @registry: the registry that emitted the signal * @feature: the feature that has been added * * Signals that a feature has been added to the registry (possibly * replacing a previously-added one by the same name) */ gst_registry_signals[FEATURE_ADDED] = g_signal_new ("feature-added", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRegistryClass, feature_added), NULL, NULL, gst_marshal_VOID__POINTER, G_TYPE_NONE, 1, G_TYPE_POINTER); gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_registry_finalize); } static void gst_registry_init (GstRegistry * registry) { registry->feature_hash = g_hash_table_new (g_str_hash, g_str_equal); registry->basename_hash = g_hash_table_new (g_str_hash, g_str_equal); registry->private = G_TYPE_INSTANCE_GET_PRIVATE (registry, GST_TYPE_REGISTRY, GstRegistryPrivate); } static void gst_registry_finalize (GObject * object) { GstRegistry *registry = GST_REGISTRY (object); GList *plugins, *p; GList *features, *f; plugins = registry->plugins; registry->plugins = NULL; GST_DEBUG_OBJECT (registry, "registry finalize"); p = plugins; while (p) { GstPlugin *plugin = p->data; if (plugin) { GST_LOG_OBJECT (registry, "removing plugin %s", gst_plugin_get_name (plugin)); gst_object_unref (plugin); } p = g_list_next (p); } g_list_free (plugins); features = registry->features; registry->features = NULL; f = features; while (f) { GstPluginFeature *feature = f->data; if (feature) { GST_LOG_OBJECT (registry, "removing feature %p (%s)", feature, gst_plugin_feature_get_name (feature)); gst_object_unref (feature); } f = g_list_next (f); } g_list_free (features); g_hash_table_destroy (registry->feature_hash); registry->feature_hash = NULL; g_hash_table_destroy (registry->basename_hash); registry->basename_hash = NULL; if (registry->private->element_factory_list) { GST_DEBUG_OBJECT (registry, "Cleaning up cached element factory list"); gst_plugin_feature_list_free (registry->private->element_factory_list); } if (registry->private->typefind_factory_list) { GST_DEBUG_OBJECT (registry, "Cleaning up cached typefind factory list"); gst_plugin_feature_list_free (registry->private->typefind_factory_list); } G_OBJECT_CLASS (parent_class)->finalize (object); } /** * gst_registry_get_default: * * Retrieves the default registry. The caller does not own a reference on the * registry, as it is alive as long as GStreamer is initialized. * * Returns: The default #GstRegistry. */ GstRegistry * gst_registry_get_default (void) { GstRegistry *registry; g_static_mutex_lock (&_gst_registry_mutex); if (G_UNLIKELY (!_gst_registry_default)) { _gst_registry_default = g_object_new (GST_TYPE_REGISTRY, NULL); gst_object_ref_sink (GST_OBJECT_CAST (_gst_registry_default)); } registry = _gst_registry_default; g_static_mutex_unlock (&_gst_registry_mutex); return registry; } /** * gst_registry_add_path: * @registry: the registry to add the path to * @path: the path to add to the registry * * Add the given path to the registry. The syntax of the * path is specific to the registry. If the path has already been * added, do nothing. */ void gst_registry_add_path (GstRegistry * registry, const gchar * path) { g_return_if_fail (GST_IS_REGISTRY (registry)); g_return_if_fail (path != NULL); if (strlen (path) == 0) goto empty_path; GST_OBJECT_LOCK (registry); if (g_list_find_custom (registry->paths, path, (GCompareFunc) strcmp)) goto was_added; GST_INFO ("Adding plugin path: \"%s\"", path); registry->paths = g_list_append (registry->paths, g_strdup (path)); GST_OBJECT_UNLOCK (registry); return; empty_path: { GST_INFO ("Ignoring empty plugin path"); return; } was_added: { g_warning ("path %s already added to registry", path); GST_OBJECT_UNLOCK (registry); return; } } /** * gst_registry_get_path_list: * @registry: the registry to get the pathlist of * * Get the list of paths for the given registry. * * Returns: A Glist of paths as strings. g_list_free after use. * * MT safe. */ GList * gst_registry_get_path_list (GstRegistry * registry) { GList *list; g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL); GST_OBJECT_LOCK (registry); /* We don't need to copy the strings, because they won't be deleted * as long as the GstRegistry is around */ list = g_list_copy (registry->paths); GST_OBJECT_UNLOCK (registry); return list; } /** * gst_registry_add_plugin: * @registry: the registry to add the plugin to * @plugin: the plugin to add * * Add the plugin to the registry. The plugin-added signal will be emitted. * This function will sink @plugin. * * Returns: TRUE on success. * * MT safe. */ gboolean gst_registry_add_plugin (GstRegistry * registry, GstPlugin * plugin) { GstPlugin *existing_plugin; g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE); g_return_val_if_fail (GST_IS_PLUGIN (plugin), FALSE); GST_OBJECT_LOCK (registry); if (G_LIKELY (plugin->basename)) { /* we have a basename, see if we find the plugin */ existing_plugin = gst_registry_lookup_bn_locked (registry, plugin->basename); if (existing_plugin) { GST_DEBUG_OBJECT (registry, "Replacing existing plugin %p with new plugin %p for filename \"%s\"", existing_plugin, plugin, GST_STR_NULL (plugin->filename)); registry->plugins = g_list_remove (registry->plugins, existing_plugin); if (G_LIKELY (existing_plugin->basename)) g_hash_table_remove (registry->basename_hash, existing_plugin->basename); gst_object_unref (existing_plugin); } } GST_DEBUG_OBJECT (registry, "adding plugin %p for filename \"%s\"", plugin, GST_STR_NULL (plugin->filename)); registry->plugins = g_list_prepend (registry->plugins, plugin); if (G_LIKELY (plugin->basename)) g_hash_table_replace (registry->basename_hash, plugin->basename, plugin); gst_object_ref_sink (plugin); GST_OBJECT_UNLOCK (registry); GST_LOG_OBJECT (registry, "emitting plugin-added for filename \"%s\"", GST_STR_NULL (plugin->filename)); g_signal_emit (registry, gst_registry_signals[PLUGIN_ADDED], 0, plugin); return TRUE; } static void gst_registry_remove_features_for_plugin_unlocked (GstRegistry * registry, GstPlugin * plugin) { GList *f; const gchar *name; g_return_if_fail (GST_IS_REGISTRY (registry)); g_return_if_fail (GST_IS_PLUGIN (plugin)); name = gst_plugin_get_name (plugin); /* Remove all features for this plugin */ f = registry->features; while (f != NULL) { GList *next = g_list_next (f); GstPluginFeature *feature = f->data; if (G_UNLIKELY (feature && !strcmp (feature->plugin_name, name))) { GST_DEBUG_OBJECT (registry, "removing feature %p (%s) for plugin %s", feature, gst_plugin_feature_get_name (feature), name); registry->features = g_list_delete_link (registry->features, f); g_hash_table_remove (registry->feature_hash, feature->name); gst_object_unref (feature); } f = next; } registry->private->cookie++; } /** * gst_registry_remove_plugin: * @registry: the registry to remove the plugin from * @plugin: the plugin to remove * * Remove the plugin from the registry. * * MT safe. */ void gst_registry_remove_plugin (GstRegistry * registry, GstPlugin * plugin) { g_return_if_fail (GST_IS_REGISTRY (registry)); g_return_if_fail (GST_IS_PLUGIN (plugin)); GST_DEBUG_OBJECT (registry, "removing plugin %p (%s)", plugin, gst_plugin_get_name (plugin)); GST_OBJECT_LOCK (registry); registry->plugins = g_list_remove (registry->plugins, plugin); if (G_LIKELY (plugin->basename)) g_hash_table_remove (registry->basename_hash, plugin->basename); gst_registry_remove_features_for_plugin_unlocked (registry, plugin); GST_OBJECT_UNLOCK (registry); gst_object_unref (plugin); } /** * gst_registry_add_feature: * @registry: the registry to add the plugin to * @feature: the feature to add * * Add the feature to the registry. The feature-added signal will be emitted. * This function sinks @feature. * * Returns: TRUE on success. * * MT safe. */ gboolean gst_registry_add_feature (GstRegistry * registry, GstPluginFeature * feature) { GstPluginFeature *existing_feature; g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE); g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE); g_return_val_if_fail (feature->name != NULL, FALSE); g_return_val_if_fail (feature->plugin_name != NULL, FALSE); GST_OBJECT_LOCK (registry); existing_feature = gst_registry_lookup_feature_locked (registry, feature->name); if (G_UNLIKELY (existing_feature)) { GST_DEBUG_OBJECT (registry, "replacing existing feature %p (%s)", existing_feature, feature->name); /* Remove the existing feature from the list now, before we insert the new * one, but don't unref yet because the hash is still storing a reference to * it. */ registry->features = g_list_remove (registry->features, existing_feature); } GST_DEBUG_OBJECT (registry, "adding feature %p (%s)", feature, feature->name); registry->features = g_list_prepend (registry->features, feature); g_hash_table_replace (registry->feature_hash, feature->name, feature); if (G_UNLIKELY (existing_feature)) { /* We unref now. No need to remove the feature name from the hash table, it * got replaced by the new feature */ gst_object_unref (existing_feature); } gst_object_ref_sink (feature); registry->private->cookie++; GST_OBJECT_UNLOCK (registry); GST_LOG_OBJECT (registry, "emitting feature-added for %s", feature->name); g_signal_emit (registry, gst_registry_signals[FEATURE_ADDED], 0, feature); return TRUE; } /** * gst_registry_remove_feature: * @registry: the registry to remove the feature from * @feature: the feature to remove * * Remove the feature from the registry. * * MT safe. */ void gst_registry_remove_feature (GstRegistry * registry, GstPluginFeature * feature) { g_return_if_fail (GST_IS_REGISTRY (registry)); g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature)); GST_DEBUG_OBJECT (registry, "removing feature %p (%s)", feature, gst_plugin_feature_get_name (feature)); GST_OBJECT_LOCK (registry); registry->features = g_list_remove (registry->features, feature); g_hash_table_remove (registry->feature_hash, feature->name); registry->private->cookie++; GST_OBJECT_UNLOCK (registry); gst_object_unref (feature); } /** * gst_registry_plugin_filter: * @registry: registry to query * @filter: the filter to use * @first: only return first match * @user_data: user data passed to the filter function * * Runs a filter against all plugins in the registry and returns a #GList with * the results. If the first flag is set, only the first match is * returned (as a list with a single object). * Every plugin is reffed; use gst_plugin_list_free() after use, which * will unref again. * * Returns: a #GList of #GstPlugin. Use gst_plugin_list_free() after usage. * * MT safe. */ GList * gst_registry_plugin_filter (GstRegistry * registry, GstPluginFilter filter, gboolean first, gpointer user_data) { GList *list; GList *g; g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL); GST_OBJECT_LOCK (registry); list = gst_filter_run (registry->plugins, (GstFilterFunc) filter, first, user_data); for (g = list; g; g = g->next) { gst_object_ref (GST_PLUGIN_CAST (g->data)); } GST_OBJECT_UNLOCK (registry); return list; } /* returns TRUE if the list was changed * * Must be called with the object lock taken */ static gboolean gst_registry_get_feature_list_or_create (GstRegistry * registry, GList ** previous, guint32 * cookie, GType type) { gboolean res = FALSE; GstRegistryPrivate *private = registry->private; if (G_UNLIKELY (!*previous || private->cookie != *cookie)) { GstTypeNameData data; if (*previous) gst_plugin_feature_list_free (*previous); data.type = type; data.name = NULL; *previous = gst_filter_run (registry->features, (GstFilterFunc) gst_plugin_feature_type_name_filter, FALSE, &data); g_list_foreach (*previous, (GFunc) gst_object_ref, NULL); *cookie = private->cookie; res = TRUE; } return res; } static GList * gst_registry_get_element_factory_list (GstRegistry * registry) { GList *list; GST_OBJECT_LOCK (registry); gst_registry_get_feature_list_or_create (registry, ®istry->private->element_factory_list, ®istry->private->efl_cookie, GST_TYPE_ELEMENT_FACTORY); /* Return reffed copy */ list = gst_plugin_feature_list_copy (registry->private->element_factory_list); GST_OBJECT_UNLOCK (registry); return list; } static GList * gst_registry_get_typefind_factory_list (GstRegistry * registry) { GList *list; GST_OBJECT_LOCK (registry); gst_registry_get_feature_list_or_create (registry, ®istry->private->typefind_factory_list, ®istry->private->tfl_cookie, GST_TYPE_TYPE_FIND_FACTORY); /* Return reffed copy */ list = gst_plugin_feature_list_copy (registry->private->typefind_factory_list); GST_OBJECT_UNLOCK (registry); return list; } /** * gst_registry_feature_filter: * @registry: registry to query * @filter: the filter to use * @first: only return first match * @user_data: user data passed to the filter function * * Runs a filter against all features of the plugins in the registry * and returns a GList with the results. * If the first flag is set, only the first match is * returned (as a list with a single object). * * Returns: a #GList of #GstPluginFeature. Use gst_plugin_feature_list_free() * after usage. * * MT safe. */ GList * gst_registry_feature_filter (GstRegistry * registry, GstPluginFeatureFilter filter, gboolean first, gpointer user_data) { GList *list; GList *g; g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL); GST_OBJECT_LOCK (registry); list = gst_filter_run (registry->features, (GstFilterFunc) filter, first, user_data); for (g = list; g; g = g->next) { gst_object_ref (GST_PLUGIN_FEATURE_CAST (g->data)); } GST_OBJECT_UNLOCK (registry); return list; } /** * gst_registry_find_plugin: * @registry: the registry to search * @name: the plugin name to find * * Find the plugin with the given name in the registry. * The plugin will be reffed; caller is responsible for unreffing. * * Returns: The plugin with the given name or NULL if the plugin was not found. * gst_object_unref() after usage. * * MT safe. */ GstPlugin * gst_registry_find_plugin (GstRegistry * registry, const gchar * name) { GList *walk; GstPlugin *result = NULL; g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL); g_return_val_if_fail (name != NULL, NULL); walk = gst_registry_plugin_filter (registry, (GstPluginFilter) gst_plugin_name_filter, TRUE, (gpointer) name); if (walk) { result = GST_PLUGIN_CAST (walk->data); gst_object_ref (result); gst_plugin_list_free (walk); } return result; } /** * gst_registry_find_feature: * @registry: the registry to search * @name: the pluginfeature name to find * @type: the pluginfeature type to find * * Find the pluginfeature with the given name and type in the registry. * * Returns: The pluginfeature with the given name and type or NULL * if the plugin was not found. gst_object_unref() after usage. * * MT safe. */ GstPluginFeature * gst_registry_find_feature (GstRegistry * registry, const gchar * name, GType type) { GstPluginFeature *feature = NULL; g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL); g_return_val_if_fail (name != NULL, NULL); g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL); feature = gst_registry_lookup_feature (registry, name); if (feature && !g_type_is_a (G_TYPE_FROM_INSTANCE (feature), type)) { gst_object_unref (feature); feature = NULL; } return feature; } /** * gst_registry_get_feature_list: * @registry: a #GstRegistry * @type: a #GType. * * Retrieves a #GList of #GstPluginFeature of @type. * * Returns: a #GList of #GstPluginFeature of @type. Use * gst_plugin_feature_list_free() after usage. * * MT safe. */ GList * gst_registry_get_feature_list (GstRegistry * registry, GType type) { GstTypeNameData data; g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL); g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL); /* Speed up */ if (type == GST_TYPE_ELEMENT_FACTORY) return gst_registry_get_element_factory_list (registry); else if (type == GST_TYPE_TYPE_FIND_FACTORY) return gst_registry_get_typefind_factory_list (registry); data.type = type; data.name = NULL; return gst_registry_feature_filter (registry, (GstPluginFeatureFilter) gst_plugin_feature_type_name_filter, FALSE, &data); } /** * gst_registry_get_plugin_list: * @registry: the registry to search * * Get a copy of all plugins registered in the given registry. The refcount * of each element in the list in incremented. * * Returns: a #GList of #GstPlugin. Use gst_plugin_list_free() after usage. * * MT safe. */ GList * gst_registry_get_plugin_list (GstRegistry * registry) { GList *list; GList *g; g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL); GST_OBJECT_LOCK (registry); list = g_list_copy (registry->plugins); for (g = list; g; g = g->next) { gst_object_ref (GST_PLUGIN_CAST (g->data)); } GST_OBJECT_UNLOCK (registry); return list; } static GstPluginFeature * gst_registry_lookup_feature_locked (GstRegistry * registry, const char *name) { return g_hash_table_lookup (registry->feature_hash, name); } /** * gst_registry_lookup_feature: * @registry: a #GstRegistry * @name: a #GstPluginFeature name * * Find a #GstPluginFeature with @name in @registry. * * Returns: a #GstPluginFeature with its refcount incremented, use * gst_object_unref() after usage. * * MT safe. */ GstPluginFeature * gst_registry_lookup_feature (GstRegistry * registry, const char *name) { GstPluginFeature *feature; g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL); g_return_val_if_fail (name != NULL, NULL); GST_OBJECT_LOCK (registry); feature = gst_registry_lookup_feature_locked (registry, name); if (feature) gst_object_ref (feature); GST_OBJECT_UNLOCK (registry); return feature; } static GstPlugin * gst_registry_lookup_bn_locked (GstRegistry * registry, const char *basename) { return g_hash_table_lookup (registry->basename_hash, basename); } static GstPlugin * gst_registry_lookup_bn (GstRegistry * registry, const char *basename) { GstPlugin *plugin; GST_OBJECT_LOCK (registry); plugin = gst_registry_lookup_bn_locked (registry, basename); if (plugin) gst_object_ref (plugin); GST_OBJECT_UNLOCK (registry); return plugin; } /** * gst_registry_lookup: * @registry: the registry to look up in * @filename: the name of the file to look up * * Look up a plugin in the given registry with the given filename. * If found, plugin is reffed. * * Returns: the #GstPlugin if found, or NULL if not. gst_object_unref() * after usage. */ GstPlugin * gst_registry_lookup (GstRegistry * registry, const char *filename) { GstPlugin *plugin; gchar *basename; g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL); g_return_val_if_fail (filename != NULL, NULL); basename = g_path_get_basename (filename); if (G_UNLIKELY (basename == NULL)) return NULL; plugin = gst_registry_lookup_bn (registry, basename); g_free (basename); return plugin; } typedef enum { REGISTRY_SCAN_HELPER_NOT_STARTED = 0, REGISTRY_SCAN_HELPER_DISABLED, REGISTRY_SCAN_HELPER_RUNNING } GstRegistryScanHelperState; typedef struct { GstRegistry *registry; GstRegistryScanHelperState helper_state; GstPluginLoader *helper; gboolean changed; } GstRegistryScanContext; static void init_scan_context (GstRegistryScanContext * context, GstRegistry * registry) { gboolean do_fork; context->registry = registry; /* see if forking is enabled and set up the scan helper state accordingly */ do_fork = _gst_enable_registry_fork; if (do_fork) { const gchar *fork_env; /* forking enabled, see if it is disabled with an env var */ if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) { /* fork enabled for any value different from "no" */ do_fork = strcmp (fork_env, "no") != 0; } } if (do_fork) context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED; else context->helper_state = REGISTRY_SCAN_HELPER_DISABLED; context->helper = NULL; context->changed = FALSE; } static void clear_scan_context (GstRegistryScanContext * context) { if (context->helper) { context->changed |= _priv_gst_plugin_loader_funcs.destroy (context->helper); context->helper = NULL; } } static gboolean gst_registry_scan_plugin_file (GstRegistryScanContext * context, const gchar * filename, off_t file_size, time_t file_mtime) { gboolean changed = FALSE; GstPlugin *newplugin = NULL; /* Have a plugin to load - see if the scan-helper needs starting */ if (context->helper_state == REGISTRY_SCAN_HELPER_NOT_STARTED) { GST_DEBUG ("Starting plugin scanner for file %s", filename); context->helper = _priv_gst_plugin_loader_funcs.create (context->registry); if (context->helper != NULL) context->helper_state = REGISTRY_SCAN_HELPER_RUNNING; else { GST_WARNING ("Failed starting plugin scanner. Scanning in-process"); context->helper_state = REGISTRY_SCAN_HELPER_DISABLED; } } if (context->helper_state == REGISTRY_SCAN_HELPER_RUNNING) { GST_DEBUG ("Using scan-helper to load plugin %s", filename); if (!_priv_gst_plugin_loader_funcs.load (context->helper, filename, file_size, file_mtime)) { g_warning ("External plugin loader failed. This most likely means that " "the plugin loader helper binary was not found or could not be run. " "%s", (g_getenv ("GST_PLUGIN_PATH") != NULL) ? "If you are running an uninstalled GStreamer setup, you might need " "to update your gst-uninstalled script so that the " "GST_PLUGIN_SCANNER environment variable gets set." : ""); context->helper_state = REGISTRY_SCAN_HELPER_DISABLED; } } /* Check if the helper is disabled (or just got disabled above) */ if (context->helper_state == REGISTRY_SCAN_HELPER_DISABLED) { /* Load plugin the old fashioned way... */ /* We don't use a GError here because a failure to load some shared * objects as plugins is normal (particularly in the uninstalled case) */ newplugin = gst_plugin_load_file (filename, NULL); } if (newplugin) { GST_DEBUG_OBJECT (context->registry, "marking new plugin %p as registered", newplugin); newplugin->registered = TRUE; gst_object_unref (newplugin); changed = TRUE; } return changed; } static gboolean gst_registry_scan_path_level (GstRegistryScanContext * context, const gchar * path, int level) { GDir *dir; const gchar *dirent; gchar *filename; GstPlugin *plugin; gboolean changed = FALSE; dir = g_dir_open (path, 0, NULL); if (!dir) return FALSE; while ((dirent = g_dir_read_name (dir))) { struct stat file_status; filename = g_build_filename (path, dirent, NULL); if (g_stat (filename, &file_status) < 0) { /* Plugin will be removed from cache after the scan completes if it * is still marked 'cached' */ g_free (filename); continue; } if (file_status.st_mode & S_IFDIR) { /* skip the .debug directory, these contain elf files that are not * useful or worse, can crash dlopen (). do a quick check for the . first * and then call the compare functions. */ if (G_UNLIKELY (dirent[0] == '.' && (g_str_equal (dirent, ".debug") || g_str_equal (dirent, ".git")))) { GST_LOG_OBJECT (context->registry, "ignoring .debug or .git directory"); g_free (filename); continue; } /* FIXME 0.11: Don't recurse into directories, this behaviour * is inconsistent with other PATH environment variables */ if (level > 0) { GST_LOG_OBJECT (context->registry, "recursing into directory %s", filename); changed |= gst_registry_scan_path_level (context, filename, level - 1); } else { GST_LOG_OBJECT (context->registry, "not recursing into directory %s, " "recursion level too deep", filename); } g_free (filename); continue; } if (!(file_status.st_mode & S_IFREG)) { GST_LOG_OBJECT (context->registry, "%s is not a regular file, ignoring", filename); g_free (filename); continue; } if (!g_str_has_suffix (dirent, G_MODULE_SUFFIX) #ifdef GST_EXTRA_MODULE_SUFFIX && !g_str_has_suffix (dirent, GST_EXTRA_MODULE_SUFFIX) #endif ) { GST_LOG_OBJECT (context->registry, "extension is not recognized as module file, ignoring file %s", filename); g_free (filename); continue; } GST_LOG_OBJECT (context->registry, "file %s looks like a possible module", filename); /* plug-ins are considered unique by basename; if the given name * was already seen by the registry, we ignore it */ plugin = gst_registry_lookup_bn (context->registry, dirent); if (plugin) { gboolean env_vars_changed, deps_changed = FALSE; if (plugin->registered) { GST_DEBUG_OBJECT (context->registry, "plugin already registered from path \"%s\"", GST_STR_NULL (plugin->filename)); g_free (filename); gst_object_unref (plugin); continue; } env_vars_changed = _priv_plugin_deps_env_vars_changed (plugin); /* If a file with a certain basename is seen on a different path, * update the plugin to ensure the registry cache will reflect up * to date information */ if (plugin->file_mtime == file_status.st_mtime && plugin->file_size == file_status.st_size && !env_vars_changed && !(deps_changed = _priv_plugin_deps_files_changed (plugin)) && !strcmp (plugin->filename, filename)) { GST_LOG_OBJECT (context->registry, "file %s cached", filename); plugin->flags &= ~GST_PLUGIN_FLAG_CACHED; GST_LOG_OBJECT (context->registry, "marking plugin %p as registered as %s", plugin, filename); plugin->registered = TRUE; } else { GST_INFO_OBJECT (context->registry, "cached info for %s is stale", filename); GST_DEBUG_OBJECT (context->registry, "mtime %ld != %ld or size %" G_GINT64_FORMAT " != %" G_GINT64_FORMAT " or external dependency " "env_vars changed: %d or external dependencies changed: %d" " or old path %s != new path %s", plugin->file_mtime, file_status.st_mtime, (gint64) plugin->file_size, (gint64) file_status.st_size, env_vars_changed, deps_changed, plugin->filename, filename); gst_registry_remove_plugin (context->registry, plugin); changed |= gst_registry_scan_plugin_file (context, filename, file_status.st_size, file_status.st_mtime); } gst_object_unref (plugin); } else { GST_DEBUG_OBJECT (context->registry, "file %s not yet in registry", filename); changed |= gst_registry_scan_plugin_file (context, filename, file_status.st_size, file_status.st_mtime); } g_free (filename); } g_dir_close (dir); return changed; } static gboolean gst_registry_scan_path_internal (GstRegistryScanContext * context, const gchar * path) { gboolean changed; GST_DEBUG_OBJECT (context->registry, "scanning path %s", path); changed = gst_registry_scan_path_level (context, path, 10); GST_DEBUG_OBJECT (context->registry, "registry changed in path %s: %d", path, changed); return changed; } /** * gst_registry_scan_path: * @registry: the registry to add found plugins to * @path: the path to scan * * Scan the given path for plugins to add to the registry. The syntax of the * path is specific to the registry. * * Returns: %TRUE if registry changed */ gboolean gst_registry_scan_path (GstRegistry * registry, const gchar * path) { GstRegistryScanContext context; gboolean result; g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE); g_return_val_if_fail (path != NULL, FALSE); init_scan_context (&context, registry); result = gst_registry_scan_path_internal (&context, path); clear_scan_context (&context); result |= context.changed; return result; } static gboolean _gst_plugin_feature_filter_plugin_name (GstPluginFeature * feature, gpointer user_data) { return (strcmp (feature->plugin_name, (gchar *) user_data) == 0); } /** * gst_registry_get_feature_list_by_plugin: * @registry: a #GstRegistry. * @name: a plugin name. * * Retrieves a #GList of features of the plugin with name @name. * * Returns: a #GList of #GstPluginFeature. Use gst_plugin_feature_list_free() * after usage. */ GList * gst_registry_get_feature_list_by_plugin (GstRegistry * registry, const gchar * name) { g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL); g_return_val_if_fail (name != NULL, NULL); return gst_registry_feature_filter (registry, _gst_plugin_feature_filter_plugin_name, FALSE, (gpointer) name); } /* Unref and delete the default registry */ void _priv_gst_registry_cleanup () { GstRegistry *registry; g_static_mutex_lock (&_gst_registry_mutex); if ((registry = _gst_registry_default) != NULL) { _gst_registry_default = NULL; } g_static_mutex_unlock (&_gst_registry_mutex); /* unref outside of the lock because we can. */ if (registry) gst_object_unref (registry); } /** * gst_default_registry_check_feature_version: * @feature_name: the name of the feature (e.g. "oggdemux") * @min_major: the minimum major version number * @min_minor: the minimum minor version number * @min_micro: the minimum micro version number * * Checks whether a plugin feature by the given name exists in the * default registry and whether its version is at least the * version required. * * Returns: #TRUE if the feature could be found and the version is * the same as the required version or newer, and #FALSE otherwise. */ gboolean gst_default_registry_check_feature_version (const gchar * feature_name, guint min_major, guint min_minor, guint min_micro) { GstPluginFeature *feature; GstRegistry *registry; gboolean ret = FALSE; g_return_val_if_fail (feature_name != NULL, FALSE); GST_DEBUG ("Looking up plugin feature '%s'", feature_name); registry = gst_registry_get_default (); feature = gst_registry_lookup_feature (registry, feature_name); if (feature) { ret = gst_plugin_feature_check_version (feature, min_major, min_minor, min_micro); gst_object_unref (feature); } else { GST_DEBUG ("Could not find plugin feature '%s'", feature_name); } return ret; } static void load_plugin_func (gpointer data, gpointer user_data) { GstPlugin *plugin; const gchar *filename; GError *err = NULL; filename = (const gchar *) data; GST_DEBUG ("Pre-loading plugin %s", filename); plugin = gst_plugin_load_file (filename, &err); if (plugin) { GST_INFO ("Loaded plugin: \"%s\"", filename); gst_default_registry_add_plugin (plugin); } else { if (err) { /* Report error to user, and free error */ GST_ERROR ("Failed to load plugin: %s", err->message); g_error_free (err); } else { GST_WARNING ("Failed to load plugin: \"%s\"", filename); } } } #ifndef GST_DISABLE_REGISTRY /* Unref all plugins marked 'cached', to clear old plugins that no * longer exist. Returns TRUE if any plugins were removed */ static gboolean gst_registry_remove_cache_plugins (GstRegistry * registry) { GList *g; GList *g_next; GstPlugin *plugin; gboolean changed = FALSE; g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE); GST_OBJECT_LOCK (registry); GST_DEBUG_OBJECT (registry, "removing cached plugins"); g = registry->plugins; while (g) { g_next = g->next; plugin = g->data; if (plugin->flags & GST_PLUGIN_FLAG_CACHED) { GST_DEBUG_OBJECT (registry, "removing cached plugin \"%s\"", GST_STR_NULL (plugin->filename)); registry->plugins = g_list_delete_link (registry->plugins, g); if (G_LIKELY (plugin->basename)) g_hash_table_remove (registry->basename_hash, plugin->basename); gst_registry_remove_features_for_plugin_unlocked (registry, plugin); gst_object_unref (plugin); changed = TRUE; } g = g_next; } GST_OBJECT_UNLOCK (registry); return changed; } typedef enum { REGISTRY_SCAN_AND_UPDATE_FAILURE = 0, REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED, REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED } GstRegistryScanAndUpdateResult; /* * scan_and_update_registry: * @default_registry: the #GstRegistry * @registry_file: registry filename * @write_changes: write registry if it has changed? * * Scans for registry changes and eventually updates the registry cache. * * Return: %REGISTRY_SCAN_AND_UPDATE_FAILURE if the registry could not scanned * or updated, %REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED if the * registry is clean and %REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED if * it has been updated and the cache needs to be re-read. */ static GstRegistryScanAndUpdateResult scan_and_update_registry (GstRegistry * default_registry, const gchar * registry_file, gboolean write_changes, GError ** error) { const gchar *plugin_path; gboolean changed = FALSE; GList *l; GstRegistryScanContext context; GST_INFO ("Validating plugins from registry cache: %s", registry_file); init_scan_context (&context, default_registry); /* It sounds tempting to just compare the mtime of directories with the mtime * of the registry cache, but it does not work. It would not catch updated * plugins, which might bring more or less features. */ /* scan paths specified via --gst-plugin-path */ GST_DEBUG ("scanning paths added via --gst-plugin-path"); for (l = _priv_gst_plugin_paths; l != NULL; l = l->next) { GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data); changed |= gst_registry_scan_path_internal (&context, (gchar *) l->data); } /* keep plugin_paths around in case a re-scan is forced later on */ /* GST_PLUGIN_PATH specifies a list of directories to scan for * additional plugins. These take precedence over the system plugins */ plugin_path = g_getenv ("GST_PLUGIN_PATH"); if (plugin_path) { char **list; int i; GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path); list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0); for (i = 0; list[i]; i++) { changed |= gst_registry_scan_path_internal (&context, list[i]); } g_strfreev (list); } else { GST_DEBUG ("GST_PLUGIN_PATH not set"); } /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always * loaded by default. If not set, this defaults to the system-installed * path, and the plugins installed in the user's home directory */ plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH"); if (plugin_path == NULL) { char *home_plugins; GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set"); /* plugins in the user's home directory take precedence over * system-installed ones */ home_plugins = g_build_filename (g_get_home_dir (), ".gstreamer-" GST_MAJORMINOR, "plugins", NULL); GST_DEBUG ("scanning home plugins %s", home_plugins); changed |= gst_registry_scan_path_internal (&context, home_plugins); g_free (home_plugins); /* add the main (installed) library path */ GST_DEBUG ("scanning main plugins %s", PLUGINDIR); changed |= gst_registry_scan_path_internal (&context, PLUGINDIR); #ifdef G_OS_WIN32 { char *base_dir; char *dir; base_dir = g_win32_get_package_installation_directory_of_module (_priv_gst_dll_handle); dir = g_build_filename (base_dir, "lib", "gstreamer-0.10", NULL); GST_DEBUG ("scanning DLL dir %s", dir); changed |= gst_registry_scan_path_internal (&context, dir); g_free (dir); g_free (base_dir); } #endif } else { gchar **list; gint i; GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path); list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0); for (i = 0; list[i]; i++) { changed |= gst_registry_scan_path_internal (&context, list[i]); } g_strfreev (list); } clear_scan_context (&context); changed |= context.changed; /* Remove cached plugins so stale info is cleared. */ changed |= gst_registry_remove_cache_plugins (default_registry); if (!changed) { GST_INFO ("Registry cache has not changed"); return REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED; } if (!write_changes) { GST_INFO ("Registry cache changed, but writing is disabled. Not writing."); return REGISTRY_SCAN_AND_UPDATE_FAILURE; } GST_INFO ("Registry cache changed. Writing new registry cache"); if (!gst_registry_binary_write_cache (default_registry, registry_file)) { g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED, _("Error writing registry cache to %s: %s"), registry_file, g_strerror (errno)); return REGISTRY_SCAN_AND_UPDATE_FAILURE; } GST_INFO ("Registry cache written successfully"); return REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED; } static gboolean ensure_current_registry (GError ** error) { gchar *registry_file; GstRegistry *default_registry; gboolean ret = TRUE; gboolean do_update = TRUE; gboolean have_cache = TRUE; default_registry = gst_registry_get_default (); registry_file = g_strdup (g_getenv ("GST_REGISTRY")); if (registry_file == NULL) { registry_file = g_build_filename (g_get_home_dir (), ".gstreamer-" GST_MAJORMINOR, "registry." HOST_CPU ".bin", NULL); } if (!_gst_disable_registry_cache) { GST_INFO ("reading registry cache: %s", registry_file); have_cache = gst_registry_binary_read_cache (default_registry, registry_file); /* Only ever read the registry cache once, then disable it for * subsequent updates during the program lifetime */ _gst_disable_registry_cache = TRUE; } if (have_cache) { do_update = !_priv_gst_disable_registry_update; if (do_update) { const gchar *update_env; if ((update_env = g_getenv ("GST_REGISTRY_UPDATE"))) { /* do update for any value different from "no" */ do_update = (strcmp (update_env, "no") != 0); } } } if (do_update) { /* now check registry */ GST_DEBUG ("Updating registry cache"); scan_and_update_registry (default_registry, registry_file, TRUE, error); } else { GST_DEBUG ("Not updating registry cache (disabled)"); } g_free (registry_file); GST_INFO ("registry reading and updating done, result = %d", ret); return ret; } #endif /* GST_DISABLE_REGISTRY */ /** * gst_registry_fork_is_enabled: * * By default GStreamer will perform scanning and rebuilding of the * registry file using a helper child process. * * Applications might want to disable this behaviour with the * gst_registry_fork_set_enabled() function, in which case new plugins * are scanned (and loaded) into the application process. * * Returns: %TRUE if GStreamer will use the child helper process when * rebuilding the registry. * * Since: 0.10.10 */ gboolean gst_registry_fork_is_enabled (void) { return _gst_enable_registry_fork; } /** * gst_registry_fork_set_enabled: * @enabled: whether rebuilding the registry can use a temporary child helper process. * * Applications might want to disable/enable spawning of a child helper process * when rebuilding the registry. See gst_registry_fork_is_enabled() for more * information. * * Since: 0.10.10 */ void gst_registry_fork_set_enabled (gboolean enabled) { _gst_enable_registry_fork = enabled; } /** * gst_update_registry: * * Forces GStreamer to re-scan its plugin paths and update the default * plugin registry. * * Applications will almost never need to call this function, it is only * useful if the application knows new plugins have been installed (or old * ones removed) since the start of the application (or, to be precise, the * first call to gst_init()) and the application wants to make use of any * newly-installed plugins without restarting the application. * * Applications should assume that the registry update is neither atomic nor * thread-safe and should therefore not have any dynamic pipelines running * (including the playbin and decodebin elements) and should also not create * any elements or access the GStreamer registry while the update is in * progress. * * Note that this function may block for a significant amount of time. * * Returns: %TRUE if the registry has been updated successfully (does not * imply that there were changes), otherwise %FALSE. * * Since: 0.10.12 */ gboolean gst_update_registry (void) { gboolean res; #ifndef GST_DISABLE_REGISTRY GError *err = NULL; res = ensure_current_registry (&err); if (err) { GST_WARNING ("registry update failed: %s", err->message); g_error_free (err); } else { GST_LOG ("registry update succeeded"); } #else GST_WARNING ("registry update failed: %s", "registry disabled"); res = TRUE; #endif /* GST_DISABLE_REGISTRY */ if (_priv_gst_preload_plugins) { GST_DEBUG ("Preloading indicated plugins..."); g_slist_foreach (_priv_gst_preload_plugins, load_plugin_func, NULL); } return res; }