1 /* GStreamer
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>
5 *
6 * gstregistry.c: handle registry
7 *
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.
12 *
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.
17 *
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
22 */
23
24 /**
25 * SECTION:gstregistry
26 * @title: GstRegistry
27 * @short_description: Abstract base class for management of #GstPlugin objects
28 * @see_also: #GstPlugin, #GstPluginFeature
29 *
30 * One registry holds the metadata of a set of plugins.
31 *
32 * <emphasis role="bold">Design:</emphasis>
33 *
34 * The #GstRegistry object is a list of plugins and some functions for dealing
35 * with them. Each #GstPlugin is matched 1-1 with a file on disk, and may or may
36 * not be loaded at a given time.
37 *
38 * The primary source, at all times, of plugin information is each plugin file
39 * itself. Thus, if an application wants information about a particular plugin,
40 * or wants to search for a feature that satisfies given criteria, the primary
41 * means of doing so is to load every plugin and look at the resulting
42 * information that is gathered in the default registry. Clearly, this is a time
43 * consuming process, so we cache information in the registry file. The format
44 * and location of the cache file is internal to gstreamer.
45 *
46 * On startup, plugins are searched for in the plugin search path. The following
47 * locations are checked in this order:
48 *
49 * * location from --gst-plugin-path commandline option.
50 * * the GST_PLUGIN_PATH environment variable.
51 * * the GST_PLUGIN_SYSTEM_PATH environment variable.
52 * * default locations (if GST_PLUGIN_SYSTEM_PATH is not set).
53 * Those default locations are:
54 * `$XDG_DATA_HOME/gstreamer-$GST_API_VERSION/plugins/`
55 * and `$prefix/libs/gstreamer-$GST_API_VERSION/`.
56 * [$XDG_DATA_HOME](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html) defaults to
57 * `$HOME/.local/share`.
58 *
59 * The registry cache file is loaded from
60 * `$XDG_CACHE_HOME/gstreamer-$GST_API_VERSION/registry-$ARCH.bin`
61 * (where $XDG_CACHE_HOME defaults to `$HOME/.cache`) or the file listed in the `GST_REGISTRY`
62 * env var. One reason to change the registry location is for testing.
63 *
64 * For each plugin that is found in the plugin search path, there could be 3
65 * possibilities for cached information:
66 *
67 * * the cache may not contain information about a given file.
68 * * the cache may have stale information.
69 * * the cache may have current information.
70 *
71 * In the first two cases, the plugin is loaded and the cache updated. In
72 * addition to these cases, the cache may have entries for plugins that are not
73 * relevant to the current process. These are marked as not available to the
74 * current process. If the cache is updated for whatever reason, it is marked
75 * dirty.
76 *
77 * A dirty cache is written out at the end of initialization. Each entry is
78 * checked to make sure the information is minimally valid. If not, the entry is
79 * simply dropped.
80 *
81 * ## Implementation notes:
82 *
83 * The "cache" and "registry" are different concepts and can represent
84 * different sets of plugins. For various reasons, at init time, the cache is
85 * stored in the default registry, and plugins not relevant to the current
86 * process are marked with the %GST_PLUGIN_FLAG_CACHED bit. These plugins are
87 * removed at the end of initialization.
88 */
89
90 #ifdef HAVE_CONFIG_H
91 #include "config.h"
92 #endif
93 #include "gstconfig.h"
94 #include "gst_private.h"
95 #include <glib.h>
96 #include <sys/types.h>
97 #include <sys/stat.h>
98 #ifdef HAVE_UNISTD_H
99 #include <unistd.h>
100 #endif
101 #include <errno.h>
102 #include <stdio.h>
103 #include <string.h>
104
105 /* For g_stat () */
106 #include <glib/gstdio.h>
107
108 #include "gstinfo.h"
109 #include "gsterror.h"
110 #include "gstregistry.h"
111 #include "gstdeviceproviderfactory.h"
112
113 #include "gstpluginloader.h"
114
115 #include "gst-i18n-lib.h"
116
117 #include "gst.h"
118 #include "glib-compat-private.h"
119
120 #ifdef G_OS_WIN32
121 #include <windows.h>
122 extern HMODULE _priv_gst_dll_handle;
123 #endif
124 #ifdef HAVE_DLFCN_H
125 #include <dlfcn.h>
126 #endif
127
128 /* Use a toolchain-dependent suffix on Windows */
129 #ifdef G_OS_WIN32
130 # ifdef _MSC_VER
131 # define GST_REGISTRY_FILE_SUFFIX TARGET_CPU "-msvc"
132 # else
133 # define GST_REGISTRY_FILE_SUFFIX TARGET_CPU "-mingw"
134 # endif
135 #else
136 # define GST_REGISTRY_FILE_SUFFIX TARGET_CPU
137 #endif
138 #define GST_REGISTRY_FILE_NAME "registry." GST_REGISTRY_FILE_SUFFIX ".bin"
139
140
141 #define GST_CAT_DEFAULT GST_CAT_REGISTRY
142
143 struct _GstRegistryPrivate
144 {
145 GList *plugins;
146 GList *features;
147
148 guint n_plugins;
149 #if 0
150 GList *paths;
151 #endif
152
153 int cache_file;
154
155 /* hash to speedup _lookup_feature_locked() */
156 GHashTable *feature_hash;
157 /* hash to speedup _lookup */
158 GHashTable *basename_hash;
159
160 /* updated whenever the feature list changes */
161 guint32 cookie;
162 /* speedup for searching features */
163 GList *element_factory_list;
164 guint32 efl_cookie;
165 GList *typefind_factory_list;
166 guint32 tfl_cookie;
167 GList *device_provider_factory_list;
168 guint32 dmfl_cookie;
169 };
170
171 /* the one instance of the default registry and the mutex protecting the
172 * variable. */
173 static GMutex _gst_registry_mutex;
174 static GstRegistry *_gst_registry_default = NULL;
175
176 /* defaults */
177 #define DEFAULT_FORK TRUE
178
179 /* control the behaviour of registry rebuild */
180 static gboolean _gst_enable_registry_fork = DEFAULT_FORK;
181 /* List of plugins that need preloading/reloading after scanning registry */
182 extern GSList *_priv_gst_preload_plugins;
183
184 #ifndef GST_DISABLE_REGISTRY
185 /* Set to TRUE to disable registry, behaves similar to GST_DISABLE_REGISTRY */
186 gboolean _priv_gst_disable_registry = FALSE;
187 /*set to TRUE when registry needn't to be updated */
188 gboolean _priv_gst_disable_registry_update = FALSE;
189 extern GList *_priv_gst_plugin_paths;
190
191 /* Set to TRUE when the registry cache should be disabled */
192 gboolean _gst_disable_registry_cache = FALSE;
193
194 static gboolean __registry_reuse_plugin_scanner = TRUE;
195 #endif
196
197 /* Element signals and args */
198 enum
199 {
200 PLUGIN_ADDED,
201 FEATURE_ADDED,
202 LAST_SIGNAL
203 };
204
205 static void gst_registry_finalize (GObject * object);
206
207 static guint gst_registry_signals[LAST_SIGNAL] = { 0 };
208
209 static GstPluginFeature *gst_registry_lookup_feature_locked (GstRegistry *
210 registry, const char *name);
211 static GstPlugin *gst_registry_lookup_bn_locked (GstRegistry * registry,
212 const char *basename);
213
214 #define gst_registry_parent_class parent_class
215 G_DEFINE_TYPE_WITH_PRIVATE (GstRegistry, gst_registry, GST_TYPE_OBJECT);
216
217 static void
gst_registry_class_init(GstRegistryClass * klass)218 gst_registry_class_init (GstRegistryClass * klass)
219 {
220 GObjectClass *gobject_class;
221
222 gobject_class = (GObjectClass *) klass;
223
224 /**
225 * GstRegistry::plugin-added:
226 * @registry: the registry that emitted the signal
227 * @plugin: the plugin that has been added
228 *
229 * Signals that a plugin has been added to the registry (possibly
230 * replacing a previously-added one by the same name)
231 */
232 gst_registry_signals[PLUGIN_ADDED] =
233 g_signal_new ("plugin-added", G_TYPE_FROM_CLASS (klass),
234 G_SIGNAL_RUN_LAST, 0, NULL, NULL, NULL, G_TYPE_NONE, 1, GST_TYPE_PLUGIN);
235
236 /**
237 * GstRegistry::feature-added:
238 * @registry: the registry that emitted the signal
239 * @feature: the feature that has been added
240 *
241 * Signals that a feature has been added to the registry (possibly
242 * replacing a previously-added one by the same name)
243 */
244 gst_registry_signals[FEATURE_ADDED] =
245 g_signal_new ("feature-added", G_TYPE_FROM_CLASS (klass),
246 G_SIGNAL_RUN_LAST, 0, NULL, NULL, NULL,
247 G_TYPE_NONE, 1, GST_TYPE_PLUGIN_FEATURE);
248
249 gobject_class->finalize = gst_registry_finalize;
250 }
251
252 static void
gst_registry_init(GstRegistry * registry)253 gst_registry_init (GstRegistry * registry)
254 {
255 registry->priv = gst_registry_get_instance_private (registry);
256 registry->priv->feature_hash = g_hash_table_new (g_str_hash, g_str_equal);
257 registry->priv->basename_hash = g_hash_table_new (g_str_hash, g_str_equal);
258 }
259
260 static void
gst_registry_finalize(GObject * object)261 gst_registry_finalize (GObject * object)
262 {
263 GstRegistry *registry = GST_REGISTRY (object);
264 GList *plugins, *p;
265 GList *features, *f;
266
267 plugins = registry->priv->plugins;
268 registry->priv->plugins = NULL;
269 registry->priv->n_plugins = 0;
270
271 GST_DEBUG_OBJECT (registry, "registry finalize");
272 p = plugins;
273 while (p) {
274 GstPlugin *plugin = p->data;
275
276 if (plugin) {
277 GST_LOG_OBJECT (registry, "removing plugin %s",
278 gst_plugin_get_name (plugin));
279 gst_object_unref (plugin);
280 }
281 p = g_list_next (p);
282 }
283 g_list_free (plugins);
284
285 features = registry->priv->features;
286 registry->priv->features = NULL;
287
288 f = features;
289 while (f) {
290 GstPluginFeature *feature = f->data;
291
292 if (feature) {
293 GST_LOG_OBJECT (registry, "removing feature %p (%s)", feature,
294 GST_OBJECT_NAME (feature));
295 gst_object_unparent (GST_OBJECT_CAST (feature));
296 }
297 f = g_list_next (f);
298 }
299 g_list_free (features);
300
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;
305
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);
309 }
310
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);
314 }
315
316 if (registry->priv->device_provider_factory_list) {
317 GST_DEBUG_OBJECT (registry,
318 "Cleaning up cached device provider factory list");
319 gst_plugin_feature_list_free (registry->priv->device_provider_factory_list);
320 }
321
322 G_OBJECT_CLASS (parent_class)->finalize (object);
323 }
324
325 /**
326 * gst_registry_get:
327 *
328 * Retrieves the singleton plugin registry. The caller does not own a
329 * reference on the registry, as it is alive as long as GStreamer is
330 * initialized.
331 *
332 * Returns: (transfer none): the #GstRegistry.
333 */
334 GstRegistry *
gst_registry_get(void)335 gst_registry_get (void)
336 {
337 GstRegistry *registry;
338
339 g_mutex_lock (&_gst_registry_mutex);
340 if (G_UNLIKELY (!_gst_registry_default)) {
341 _gst_registry_default = g_object_new (GST_TYPE_REGISTRY, NULL);
342 gst_object_ref_sink (GST_OBJECT_CAST (_gst_registry_default));
343 }
344 registry = _gst_registry_default;
345 g_mutex_unlock (&_gst_registry_mutex);
346
347 return registry;
348 }
349
350 #if 0
351 /**
352 * gst_registry_add_path:
353 * @registry: the registry to add the path to
354 * @path: the path to add to the registry
355 *
356 * Add the given path to the registry. The syntax of the
357 * path is specific to the registry. If the path has already been
358 * added, do nothing.
359 */
360 void
361 gst_registry_add_path (GstRegistry * registry, const gchar * path)
362 {
363 g_return_if_fail (GST_IS_REGISTRY (registry));
364 g_return_if_fail (path != NULL);
365
366 if (strlen (path) == 0)
367 goto empty_path;
368
369 GST_OBJECT_LOCK (registry);
370 if (g_list_find_custom (registry->priv->paths, path, (GCompareFunc) strcmp))
371 goto was_added;
372
373 GST_INFO ("Adding plugin path: \"%s\"", path);
374 registry->priv->paths =
375 g_list_append (registry->priv->paths, g_strdup (path));
376 GST_OBJECT_UNLOCK (registry);
377
378 return;
379
380 empty_path:
381 {
382 GST_INFO ("Ignoring empty plugin path");
383 return;
384 }
385 was_added:
386 {
387 g_warning ("path %s already added to registry", path);
388 GST_OBJECT_UNLOCK (registry);
389 return;
390 }
391 }
392
393 /**
394 * gst_registry_get_path_list:
395 * @registry: the registry to get the pathlist of
396 *
397 * Get the list of paths for the given registry.
398 *
399 * Returns: (transfer container) (element-type filename): A #GList of
400 * paths as strings. g_list_free after use.
401 *
402 * MT safe.
403 */
404 GList *
405 gst_registry_get_path_list (GstRegistry * registry)
406 {
407 GList *list;
408
409 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
410
411 GST_OBJECT_LOCK (registry);
412 /* We don't need to copy the strings, because they won't be deleted
413 * as long as the GstRegistry is around */
414 list = g_list_copy (registry->priv->paths);
415 GST_OBJECT_UNLOCK (registry);
416
417 return list;
418 }
419 #endif
420
421 /**
422 * gst_registry_add_plugin:
423 * @registry: the registry to add the plugin to
424 * @plugin: (transfer floating): the plugin to add
425 *
426 * Add the plugin to the registry. The plugin-added signal will be emitted.
427 *
428 * @plugin's reference count will be incremented, and any floating
429 * reference will be removed (see gst_object_ref_sink())
430 *
431 * Returns: %TRUE on success.
432 *
433 * MT safe.
434 */
435 gboolean
gst_registry_add_plugin(GstRegistry * registry,GstPlugin * plugin)436 gst_registry_add_plugin (GstRegistry * registry, GstPlugin * plugin)
437 {
438 GstPlugin *existing_plugin;
439
440 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
441 g_return_val_if_fail (GST_IS_PLUGIN (plugin), FALSE);
442
443 GST_OBJECT_LOCK (registry);
444 if (G_LIKELY (plugin->basename)) {
445 /* we have a basename, see if we find the plugin */
446 existing_plugin =
447 gst_registry_lookup_bn_locked (registry, plugin->basename);
448 if (existing_plugin) {
449 GST_DEBUG_OBJECT (registry,
450 "Replacing existing plugin \"%s\" %p with new plugin %p for filename \"%s\"",
451 GST_STR_NULL (existing_plugin->filename), existing_plugin, plugin,
452 GST_STR_NULL (plugin->filename));
453 /* If the new plugin is blacklisted and the existing one isn't cached, do not
454 * accept if it's from a different location than the existing one */
455 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED) &&
456 strcmp (plugin->filename, existing_plugin->filename)) {
457 GST_WARNING_OBJECT (registry,
458 "Not replacing plugin because new one (%s) is blacklisted but for a different location than existing one (%s)",
459 plugin->filename, existing_plugin->filename);
460 /* Keep reference counting consistent */
461 gst_object_ref_sink (plugin);
462 gst_object_unref (plugin);
463 GST_OBJECT_UNLOCK (registry);
464 return FALSE;
465 }
466 registry->priv->plugins =
467 g_list_remove (registry->priv->plugins, existing_plugin);
468 --registry->priv->n_plugins;
469 if (G_LIKELY (existing_plugin->basename))
470 g_hash_table_remove (registry->priv->basename_hash,
471 existing_plugin->basename);
472 gst_object_unref (existing_plugin);
473 }
474 }
475
476 GST_DEBUG_OBJECT (registry, "adding plugin %p for filename \"%s\"",
477 plugin, GST_STR_NULL (plugin->filename));
478
479 registry->priv->plugins = g_list_prepend (registry->priv->plugins, plugin);
480 ++registry->priv->n_plugins;
481
482 if (G_LIKELY (plugin->basename))
483 g_hash_table_replace (registry->priv->basename_hash, plugin->basename,
484 plugin);
485
486 gst_object_ref_sink (plugin);
487 GST_OBJECT_UNLOCK (registry);
488
489 GST_LOG_OBJECT (registry, "emitting plugin-added for filename \"%s\"",
490 GST_STR_NULL (plugin->filename));
491 g_signal_emit (registry, gst_registry_signals[PLUGIN_ADDED], 0, plugin);
492
493 return TRUE;
494 }
495
496 static void
gst_registry_remove_features_for_plugin_unlocked(GstRegistry * registry,GstPlugin * plugin)497 gst_registry_remove_features_for_plugin_unlocked (GstRegistry * registry,
498 GstPlugin * plugin)
499 {
500 GList *f;
501
502 g_return_if_fail (GST_IS_REGISTRY (registry));
503 g_return_if_fail (GST_IS_PLUGIN (plugin));
504
505 /* Remove all features for this plugin */
506 f = registry->priv->features;
507 while (f != NULL) {
508 GList *next = g_list_next (f);
509 GstPluginFeature *feature = f->data;
510
511 if (G_UNLIKELY (feature && feature->plugin == plugin)) {
512 GST_DEBUG_OBJECT (registry, "removing feature %p (%s) for plugin %p (%s)",
513 feature, gst_plugin_feature_get_name (feature), plugin,
514 plugin->desc.name);
515
516 registry->priv->features =
517 g_list_delete_link (registry->priv->features, f);
518 g_hash_table_remove (registry->priv->feature_hash,
519 GST_OBJECT_NAME (feature));
520 gst_object_unparent (GST_OBJECT_CAST (feature));
521 }
522 f = next;
523 }
524 registry->priv->cookie++;
525 }
526
527 /**
528 * gst_registry_remove_plugin:
529 * @registry: the registry to remove the plugin from
530 * @plugin: (transfer none): the plugin to remove
531 *
532 * Remove the plugin from the registry.
533 *
534 * MT safe.
535 */
536 void
gst_registry_remove_plugin(GstRegistry * registry,GstPlugin * plugin)537 gst_registry_remove_plugin (GstRegistry * registry, GstPlugin * plugin)
538 {
539 g_return_if_fail (GST_IS_REGISTRY (registry));
540 g_return_if_fail (GST_IS_PLUGIN (plugin));
541
542 GST_DEBUG_OBJECT (registry, "removing plugin %p (%s)",
543 plugin, gst_plugin_get_name (plugin));
544
545 GST_OBJECT_LOCK (registry);
546 registry->priv->plugins = g_list_remove (registry->priv->plugins, plugin);
547 --registry->priv->n_plugins;
548 if (G_LIKELY (plugin->basename))
549 g_hash_table_remove (registry->priv->basename_hash, plugin->basename);
550 gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
551 GST_OBJECT_UNLOCK (registry);
552 gst_object_unref (plugin);
553 }
554
555 /**
556 * gst_registry_add_feature:
557 * @registry: the registry to add the plugin to
558 * @feature: (transfer floating): the feature to add
559 *
560 * Add the feature to the registry. The feature-added signal will be emitted.
561 *
562 * @feature's reference count will be incremented, and any floating
563 * reference will be removed (see gst_object_ref_sink())
564 *
565 * Returns: %TRUE on success.
566 *
567 * MT safe.
568 */
569 gboolean
gst_registry_add_feature(GstRegistry * registry,GstPluginFeature * feature)570 gst_registry_add_feature (GstRegistry * registry, GstPluginFeature * feature)
571 {
572 GstPluginFeature *existing_feature;
573
574 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
575 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
576 g_return_val_if_fail (GST_OBJECT_NAME (feature) != NULL, FALSE);
577 g_return_val_if_fail (feature->plugin_name != NULL, FALSE);
578
579 GST_OBJECT_LOCK (registry);
580 existing_feature = gst_registry_lookup_feature_locked (registry,
581 GST_OBJECT_NAME (feature));
582 if (G_UNLIKELY (existing_feature)) {
583 GST_DEBUG_OBJECT (registry, "replacing existing feature %p (%s)",
584 existing_feature, GST_OBJECT_NAME (feature));
585 /* Remove the existing feature from the list now, before we insert the new
586 * one, but don't unref yet because the hash is still storing a reference to
587 * it. */
588 registry->priv->features =
589 g_list_remove (registry->priv->features, existing_feature);
590 }
591
592 GST_DEBUG_OBJECT (registry, "adding feature %p (%s)", feature,
593 GST_OBJECT_NAME (feature));
594
595 registry->priv->features = g_list_prepend (registry->priv->features, feature);
596 g_hash_table_replace (registry->priv->feature_hash, GST_OBJECT_NAME (feature),
597 feature);
598
599 if (G_UNLIKELY (existing_feature)) {
600 /* We unref now. No need to remove the feature name from the hash table, it
601 * got replaced by the new feature */
602 gst_object_unparent (GST_OBJECT_CAST (existing_feature));
603 }
604
605 gst_object_set_parent (GST_OBJECT_CAST (feature), GST_OBJECT_CAST (registry));
606
607 registry->priv->cookie++;
608 GST_OBJECT_UNLOCK (registry);
609
610 GST_LOG_OBJECT (registry, "emitting feature-added for %s",
611 GST_OBJECT_NAME (feature));
612 g_signal_emit (registry, gst_registry_signals[FEATURE_ADDED], 0, feature);
613
614 return TRUE;
615 }
616
617 /**
618 * gst_registry_remove_feature:
619 * @registry: the registry to remove the feature from
620 * @feature: (transfer none): the feature to remove
621 *
622 * Remove the feature from the registry.
623 *
624 * MT safe.
625 */
626 void
gst_registry_remove_feature(GstRegistry * registry,GstPluginFeature * feature)627 gst_registry_remove_feature (GstRegistry * registry, GstPluginFeature * feature)
628 {
629 g_return_if_fail (GST_IS_REGISTRY (registry));
630 g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
631
632 GST_DEBUG_OBJECT (registry, "removing feature %p (%s)",
633 feature, gst_plugin_feature_get_name (feature));
634
635 GST_OBJECT_LOCK (registry);
636 registry->priv->features = g_list_remove (registry->priv->features, feature);
637 g_hash_table_remove (registry->priv->feature_hash, GST_OBJECT_NAME (feature));
638 registry->priv->cookie++;
639 GST_OBJECT_UNLOCK (registry);
640
641 gst_object_unparent ((GstObject *) feature);
642 }
643
644 /**
645 * gst_registry_plugin_filter:
646 * @registry: registry to query
647 * @filter: (scope call): the filter to use
648 * @first: only return first match
649 * @user_data: (closure): user data passed to the filter function
650 *
651 * Runs a filter against all plugins in the registry and returns a #GList with
652 * the results. If the first flag is set, only the first match is
653 * returned (as a list with a single object).
654 * Every plugin is reffed; use gst_plugin_list_free() after use, which
655 * will unref again.
656 *
657 * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
658 * Use gst_plugin_list_free() after usage.
659 *
660 * MT safe.
661 */
662 GList *
gst_registry_plugin_filter(GstRegistry * registry,GstPluginFilter filter,gboolean first,gpointer user_data)663 gst_registry_plugin_filter (GstRegistry * registry,
664 GstPluginFilter filter, gboolean first, gpointer user_data)
665 {
666 GstPlugin **plugins;
667 GList *walk, *list = NULL;
668 guint n_plugins, i;
669
670 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
671
672 GST_OBJECT_LOCK (registry);
673 n_plugins = registry->priv->n_plugins;
674 plugins = g_newa (GstPlugin *, n_plugins + 1);
675 for (walk = registry->priv->plugins, i = 0; walk != NULL; walk = walk->next)
676 plugins[i++] = gst_object_ref (walk->data);
677 GST_OBJECT_UNLOCK (registry);
678
679 for (i = 0; i < n_plugins; ++i) {
680 if (filter == NULL || filter (plugins[i], user_data)) {
681 list = g_list_prepend (list, gst_object_ref (plugins[i]));
682
683 if (first)
684 break;
685 }
686 }
687
688 for (i = 0; i < n_plugins; ++i)
689 gst_object_unref (plugins[i]);
690
691 return list;
692 }
693
694 typedef struct
695 {
696 const gchar *name;
697 GType type;
698 } GstTypeNameData;
699
700 static gboolean
gst_plugin_feature_type_name_filter(GstPluginFeature * feature,GstTypeNameData * data)701 gst_plugin_feature_type_name_filter (GstPluginFeature * feature,
702 GstTypeNameData * data)
703 {
704 g_assert (GST_IS_PLUGIN_FEATURE (feature));
705
706 return ((data->type == 0 || data->type == G_OBJECT_TYPE (feature)) &&
707 (data->name == NULL || !strcmp (data->name, GST_OBJECT_NAME (feature))));
708 }
709
710 /* returns TRUE if the list was changed
711 *
712 * Must be called with the object lock taken */
713 static gboolean
gst_registry_get_feature_list_or_create(GstRegistry * registry,GList ** previous,guint32 * cookie,GType type)714 gst_registry_get_feature_list_or_create (GstRegistry * registry,
715 GList ** previous, guint32 * cookie, GType type)
716 {
717 gboolean res = FALSE;
718 GstRegistryPrivate *priv = registry->priv;
719
720 if (G_UNLIKELY (!*previous || priv->cookie != *cookie)) {
721 GstTypeNameData data;
722 const GList *walk;
723
724 if (*previous) {
725 gst_plugin_feature_list_free (*previous);
726 *previous = NULL;
727 }
728
729 data.type = type;
730 data.name = NULL;
731
732 for (walk = registry->priv->features; walk != NULL; walk = walk->next) {
733 GstPluginFeature *feature = walk->data;
734
735 if (gst_plugin_feature_type_name_filter (feature, &data)) {
736 *previous = g_list_prepend (*previous, gst_object_ref (feature));
737 }
738 }
739
740 *cookie = priv->cookie;
741 res = TRUE;
742 }
743
744 return res;
745 }
746
747 static gint
type_find_factory_rank_cmp(const GstPluginFeature * fac1,const GstPluginFeature * fac2)748 type_find_factory_rank_cmp (const GstPluginFeature * fac1,
749 const GstPluginFeature * fac2)
750 {
751 if (G_LIKELY (fac1->rank != fac2->rank))
752 return fac2->rank - fac1->rank;
753
754 /* to make the order in which things happen more deterministic,
755 * sort by name when the ranks are the same. */
756 return strcmp (GST_OBJECT_NAME (fac1), GST_OBJECT_NAME (fac2));
757 }
758
759 static GList *
gst_registry_get_element_factory_list(GstRegistry * registry)760 gst_registry_get_element_factory_list (GstRegistry * registry)
761 {
762 GList *list;
763
764 GST_OBJECT_LOCK (registry);
765
766 gst_registry_get_feature_list_or_create (registry,
767 ®istry->priv->element_factory_list, ®istry->priv->efl_cookie,
768 GST_TYPE_ELEMENT_FACTORY);
769
770 /* Return reffed copy */
771 list = gst_plugin_feature_list_copy (registry->priv->element_factory_list);
772
773 GST_OBJECT_UNLOCK (registry);
774
775 return list;
776 }
777
778 static GList *
gst_registry_get_typefind_factory_list(GstRegistry * registry)779 gst_registry_get_typefind_factory_list (GstRegistry * registry)
780 {
781 GList *list;
782
783 GST_OBJECT_LOCK (registry);
784
785 if (G_UNLIKELY (gst_registry_get_feature_list_or_create (registry,
786 ®istry->priv->typefind_factory_list,
787 ®istry->priv->tfl_cookie, GST_TYPE_TYPE_FIND_FACTORY)))
788 registry->priv->typefind_factory_list =
789 g_list_sort (registry->priv->typefind_factory_list,
790 (GCompareFunc) type_find_factory_rank_cmp);
791
792 /* Return reffed copy */
793 list = gst_plugin_feature_list_copy (registry->priv->typefind_factory_list);
794
795 GST_OBJECT_UNLOCK (registry);
796
797 return list;
798 }
799
800
801 static GList *
gst_registry_get_device_provider_factory_list(GstRegistry * registry)802 gst_registry_get_device_provider_factory_list (GstRegistry * registry)
803 {
804 GList *list;
805
806 GST_OBJECT_LOCK (registry);
807
808 gst_registry_get_feature_list_or_create (registry,
809 ®istry->priv->device_provider_factory_list,
810 ®istry->priv->dmfl_cookie, GST_TYPE_DEVICE_PROVIDER_FACTORY);
811
812 /* Return reffed copy */
813 list =
814 gst_plugin_feature_list_copy (registry->
815 priv->device_provider_factory_list);
816
817 GST_OBJECT_UNLOCK (registry);
818
819 return list;
820 }
821
822 /**
823 * gst_registry_feature_filter:
824 * @registry: registry to query
825 * @filter: (scope call): the filter to use
826 * @first: only return first match
827 * @user_data: (closure): user data passed to the filter function
828 *
829 * Runs a filter against all features of the plugins in the registry
830 * and returns a GList with the results.
831 * If the first flag is set, only the first match is
832 * returned (as a list with a single object).
833 *
834 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
835 * #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
836 *
837 * MT safe.
838 */
839 GList *
gst_registry_feature_filter(GstRegistry * registry,GstPluginFeatureFilter filter,gboolean first,gpointer user_data)840 gst_registry_feature_filter (GstRegistry * registry,
841 GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
842 {
843 GstPluginFeature **features;
844 GList *walk, *list = NULL;
845 guint n_features, i;
846
847 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
848
849 GST_OBJECT_LOCK (registry);
850 n_features = g_hash_table_size (registry->priv->feature_hash);
851 features = g_newa (GstPluginFeature *, n_features + 1);
852 for (walk = registry->priv->features, i = 0; walk != NULL; walk = walk->next)
853 features[i++] = gst_object_ref (walk->data);
854 GST_OBJECT_UNLOCK (registry);
855
856 for (i = 0; i < n_features; ++i) {
857 if (filter == NULL || filter (features[i], user_data)) {
858 list = g_list_prepend (list, gst_object_ref (features[i]));
859
860 if (first)
861 break;
862 }
863 }
864
865 for (i = 0; i < n_features; ++i)
866 gst_object_unref (features[i]);
867
868 return list;
869 }
870
871 static gboolean
gst_registry_plugin_name_filter(GstPlugin * plugin,const gchar * name)872 gst_registry_plugin_name_filter (GstPlugin * plugin, const gchar * name)
873 {
874 return (plugin->desc.name && !strcmp (plugin->desc.name, name));
875 }
876
877 /**
878 * gst_registry_find_plugin:
879 * @registry: the registry to search
880 * @name: the plugin name to find
881 *
882 * Find the plugin with the given name in the registry.
883 * The plugin will be reffed; caller is responsible for unreffing.
884 *
885 * Returns: (transfer full) (nullable): the plugin with the given name
886 * or %NULL if the plugin was not found. gst_object_unref() after
887 * usage.
888 *
889 * MT safe.
890 */
891 GstPlugin *
gst_registry_find_plugin(GstRegistry * registry,const gchar * name)892 gst_registry_find_plugin (GstRegistry * registry, const gchar * name)
893 {
894 GList *walk;
895 GstPlugin *result = NULL;
896
897 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
898 g_return_val_if_fail (name != NULL, NULL);
899
900 walk = gst_registry_plugin_filter (registry,
901 (GstPluginFilter) gst_registry_plugin_name_filter, TRUE, (gpointer) name);
902 if (walk) {
903 result = GST_PLUGIN_CAST (walk->data);
904
905 gst_object_ref (result);
906 gst_plugin_list_free (walk);
907 }
908
909 return result;
910 }
911
912 /**
913 * gst_registry_find_feature:
914 * @registry: the registry to search
915 * @name: the pluginfeature name to find
916 * @type: the pluginfeature type to find
917 *
918 * Find the pluginfeature with the given name and type in the registry.
919 *
920 * Returns: (transfer full) (nullable): the pluginfeature with the
921 * given name and type or %NULL if the plugin was not
922 * found. gst_object_unref() after usage.
923 *
924 * MT safe.
925 */
926 GstPluginFeature *
gst_registry_find_feature(GstRegistry * registry,const gchar * name,GType type)927 gst_registry_find_feature (GstRegistry * registry, const gchar * name,
928 GType type)
929 {
930 GstPluginFeature *feature = NULL;
931
932 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
933 g_return_val_if_fail (name != NULL, NULL);
934 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
935
936 feature = gst_registry_lookup_feature (registry, name);
937 if (feature && !g_type_is_a (G_TYPE_FROM_INSTANCE (feature), type)) {
938 gst_object_unref (feature);
939 feature = NULL;
940 }
941
942 return feature;
943 }
944
945 /**
946 * gst_registry_get_feature_list:
947 * @registry: a #GstRegistry
948 * @type: a #GType.
949 *
950 * Retrieves a #GList of #GstPluginFeature of @type.
951 *
952 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
953 * #GstPluginFeature of @type. Use gst_plugin_feature_list_free() after use
954 *
955 * MT safe.
956 */
957 GList *
gst_registry_get_feature_list(GstRegistry * registry,GType type)958 gst_registry_get_feature_list (GstRegistry * registry, GType type)
959 {
960 GstTypeNameData data;
961
962 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
963 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
964
965 /* Speed up */
966 if (type == GST_TYPE_ELEMENT_FACTORY)
967 return gst_registry_get_element_factory_list (registry);
968 else if (type == GST_TYPE_TYPE_FIND_FACTORY)
969 return gst_registry_get_typefind_factory_list (registry);
970 else if (type == GST_TYPE_DEVICE_PROVIDER_FACTORY)
971 return gst_registry_get_device_provider_factory_list (registry);
972
973 data.type = type;
974 data.name = NULL;
975
976 return gst_registry_feature_filter (registry,
977 (GstPluginFeatureFilter) gst_plugin_feature_type_name_filter,
978 FALSE, &data);
979 }
980
981 /**
982 * gst_registry_get_plugin_list:
983 * @registry: the registry to search
984 *
985 * Get a copy of all plugins registered in the given registry. The refcount
986 * of each element in the list in incremented.
987 *
988 * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
989 * Use gst_plugin_list_free() after usage.
990 *
991 * MT safe.
992 */
993 GList *
gst_registry_get_plugin_list(GstRegistry * registry)994 gst_registry_get_plugin_list (GstRegistry * registry)
995 {
996 GList *list;
997 GList *g;
998
999 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1000
1001 GST_OBJECT_LOCK (registry);
1002 list = g_list_copy (registry->priv->plugins);
1003 for (g = list; g; g = g->next) {
1004 gst_object_ref (GST_PLUGIN_CAST (g->data));
1005 }
1006 GST_OBJECT_UNLOCK (registry);
1007
1008 return list;
1009 }
1010
1011 static GstPluginFeature *
gst_registry_lookup_feature_locked(GstRegistry * registry,const char * name)1012 gst_registry_lookup_feature_locked (GstRegistry * registry, const char *name)
1013 {
1014 return g_hash_table_lookup (registry->priv->feature_hash, name);
1015 }
1016
1017 /**
1018 * gst_registry_lookup_feature:
1019 * @registry: a #GstRegistry
1020 * @name: a #GstPluginFeature name
1021 *
1022 * Find a #GstPluginFeature with @name in @registry.
1023 *
1024 * Returns: (transfer full) (nullable): a #GstPluginFeature with its refcount incremented,
1025 * use gst_object_unref() after usage.
1026 *
1027 * MT safe.
1028 */
1029 GstPluginFeature *
gst_registry_lookup_feature(GstRegistry * registry,const char * name)1030 gst_registry_lookup_feature (GstRegistry * registry, const char *name)
1031 {
1032 GstPluginFeature *feature;
1033
1034 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1035 g_return_val_if_fail (name != NULL, NULL);
1036
1037 GST_OBJECT_LOCK (registry);
1038 feature = gst_registry_lookup_feature_locked (registry, name);
1039 if (feature)
1040 gst_object_ref (feature);
1041 GST_OBJECT_UNLOCK (registry);
1042
1043 return feature;
1044 }
1045
1046 static GstPlugin *
gst_registry_lookup_bn_locked(GstRegistry * registry,const char * basename)1047 gst_registry_lookup_bn_locked (GstRegistry * registry, const char *basename)
1048 {
1049 return g_hash_table_lookup (registry->priv->basename_hash, basename);
1050 }
1051
1052 static GstPlugin *
gst_registry_lookup_bn(GstRegistry * registry,const char * basename)1053 gst_registry_lookup_bn (GstRegistry * registry, const char *basename)
1054 {
1055 GstPlugin *plugin;
1056
1057 GST_OBJECT_LOCK (registry);
1058 plugin = gst_registry_lookup_bn_locked (registry, basename);
1059 if (plugin)
1060 gst_object_ref (plugin);
1061 GST_OBJECT_UNLOCK (registry);
1062
1063 return plugin;
1064 }
1065
1066 /**
1067 * gst_registry_lookup:
1068 * @registry: the registry to look up in
1069 * @filename: the name of the file to look up
1070 *
1071 * Look up a plugin in the given registry with the given filename.
1072 * If found, plugin is reffed.
1073 *
1074 * Returns: (transfer full) (nullable): the #GstPlugin if found, or
1075 * %NULL if not. gst_object_unref() after usage.
1076 */
1077 GstPlugin *
gst_registry_lookup(GstRegistry * registry,const char * filename)1078 gst_registry_lookup (GstRegistry * registry, const char *filename)
1079 {
1080 GstPlugin *plugin;
1081 gchar *basename;
1082
1083 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1084 g_return_val_if_fail (filename != NULL, NULL);
1085
1086 basename = g_path_get_basename (filename);
1087 if (G_UNLIKELY (basename == NULL))
1088 return NULL;
1089
1090 plugin = gst_registry_lookup_bn (registry, basename);
1091
1092 g_free (basename);
1093
1094 return plugin;
1095 }
1096
1097 typedef enum
1098 {
1099 REGISTRY_SCAN_HELPER_NOT_STARTED = 0,
1100 REGISTRY_SCAN_HELPER_DISABLED,
1101 REGISTRY_SCAN_HELPER_RUNNING
1102 } GstRegistryScanHelperState;
1103
1104 typedef struct
1105 {
1106 GstRegistry *registry;
1107 GstRegistryScanHelperState helper_state;
1108 GstPluginLoader *helper;
1109 gboolean changed;
1110 } GstRegistryScanContext;
1111
1112 static void
init_scan_context(GstRegistryScanContext * context,GstRegistry * registry)1113 init_scan_context (GstRegistryScanContext * context, GstRegistry * registry)
1114 {
1115 gboolean do_fork;
1116
1117 context->registry = registry;
1118
1119 /* see if forking is enabled and set up the scan helper state accordingly */
1120 do_fork = _gst_enable_registry_fork;
1121 if (do_fork) {
1122 const gchar *fork_env;
1123
1124 /* forking enabled, see if it is disabled with an env var */
1125 if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) {
1126 /* fork enabled for any value different from "no" */
1127 do_fork = strcmp (fork_env, "no") != 0;
1128 }
1129 }
1130
1131 if (do_fork)
1132 context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1133 else
1134 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1135
1136 context->helper = NULL;
1137 context->changed = FALSE;
1138 }
1139
1140 static void
clear_scan_context(GstRegistryScanContext * context)1141 clear_scan_context (GstRegistryScanContext * context)
1142 {
1143 if (context->helper) {
1144 context->changed |= _priv_gst_plugin_loader_funcs.destroy (context->helper);
1145 context->helper = NULL;
1146 }
1147 }
1148
1149 static gboolean
gst_registry_scan_plugin_file(GstRegistryScanContext * context,const gchar * filename,off_t file_size,time_t file_mtime)1150 gst_registry_scan_plugin_file (GstRegistryScanContext * context,
1151 const gchar * filename, off_t file_size, time_t file_mtime)
1152 {
1153 gboolean changed = FALSE;
1154 GstPlugin *newplugin = NULL;
1155
1156 #ifdef G_OS_WIN32
1157 /* Disable external plugin loader on Windows until it is ported properly. */
1158 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1159 #endif
1160
1161
1162 /* Have a plugin to load - see if the scan-helper needs starting */
1163 if (context->helper_state == REGISTRY_SCAN_HELPER_NOT_STARTED) {
1164 GST_DEBUG ("Starting plugin scanner for file %s", filename);
1165 context->helper = _priv_gst_plugin_loader_funcs.create (context->registry);
1166 if (context->helper != NULL)
1167 context->helper_state = REGISTRY_SCAN_HELPER_RUNNING;
1168 else {
1169 GST_WARNING ("Failed starting plugin scanner. Scanning in-process");
1170 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1171 }
1172 }
1173
1174 if (context->helper_state == REGISTRY_SCAN_HELPER_RUNNING) {
1175 GST_DEBUG ("Using scan-helper to load plugin %s", filename);
1176 if (!_priv_gst_plugin_loader_funcs.load (context->helper,
1177 filename, file_size, file_mtime)) {
1178 g_warning ("External plugin loader failed. This most likely means that "
1179 "the plugin loader helper binary was not found or could not be run. "
1180 "You might need to set the GST_PLUGIN_SCANNER environment variable "
1181 "if your setup is unusual. This should normally not be required "
1182 "though.");
1183 context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1184 }
1185 }
1186
1187 /* Check if the helper is disabled (or just got disabled above) */
1188 if (context->helper_state == REGISTRY_SCAN_HELPER_DISABLED) {
1189 /* Load plugin the old fashioned way... */
1190
1191 /* We don't use a GError here because a failure to load some shared
1192 * objects as plugins is normal (particularly in the development environment case)
1193 */
1194 newplugin = _priv_gst_plugin_load_file_for_registry (filename,
1195 context->registry, NULL);
1196 }
1197
1198 if (newplugin) {
1199 GST_DEBUG_OBJECT (context->registry, "marking new plugin %p as registered",
1200 newplugin);
1201 newplugin->registered = TRUE;
1202 gst_object_unref (newplugin);
1203 changed = TRUE;
1204 }
1205 #ifndef GST_DISABLE_REGISTRY
1206 if (!__registry_reuse_plugin_scanner) {
1207 clear_scan_context (context);
1208 context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1209 }
1210 #endif
1211
1212 return changed;
1213 }
1214
1215 static gboolean
skip_directory(const gchar * parent_path,const gchar * dirent)1216 skip_directory (const gchar * parent_path, const gchar * dirent)
1217 {
1218 const gchar *target;
1219
1220 /* hotdoc private folder can contain many files and it slows down
1221 * the discovery for nothing */
1222 if (g_str_has_prefix (dirent, "hotdoc-private-"))
1223 return TRUE;
1224
1225 /* Rust build dirs which may contain artefacts we should skip, can be
1226 * /target/{debug,release} or /target/{arch}/{debug,release} */
1227 target = strstr (parent_path, "/target/");
1228
1229 /* On Windows both forward and backward slashes may be used */
1230 #ifdef G_OS_WIN32
1231 if (target == NULL)
1232 target = strstr (parent_path, "\\target\\");
1233 #endif
1234
1235 if (target != NULL) {
1236 if (g_str_has_suffix (target + 7, "/debug")
1237 #ifdef G_OS_WIN32
1238 || g_str_has_suffix (target + 7, "\\debug")
1239 || g_str_has_suffix (target + 7, "\\release")
1240 #endif
1241 || g_str_has_suffix (target + 7, "/release")) {
1242 if (dirent[0] == '.'
1243 || strcmp (dirent, "build") == 0
1244 || strcmp (dirent, "deps") == 0
1245 || strcmp (dirent, "incremental") == 0) {
1246 return TRUE;
1247 }
1248 }
1249 }
1250
1251 if (G_LIKELY (dirent[0] != '.'))
1252 return FALSE;
1253
1254 /* skip the .debug directory, these contain elf files that are not
1255 * useful or worse, can crash dlopen () */
1256 if (strcmp (dirent, ".debug") == 0)
1257 return TRUE;
1258
1259 /* can also skip .git and .deps dirs, those won't contain useful files.
1260 * This speeds up scanning a bit in development environment setups. */
1261 if (strcmp (dirent, ".git") == 0 || strcmp (dirent, ".deps") == 0)
1262 return TRUE;
1263
1264 return FALSE;
1265 }
1266
1267 static gboolean
gst_registry_scan_path_level(GstRegistryScanContext * context,const gchar * path,int level)1268 gst_registry_scan_path_level (GstRegistryScanContext * context,
1269 const gchar * path, int level)
1270 {
1271 GDir *dir;
1272 const gchar *dirent;
1273 gchar *filename;
1274 GstPlugin *plugin;
1275 gboolean changed = FALSE;
1276
1277 dir = g_dir_open (path, 0, NULL);
1278 if (!dir)
1279 return FALSE;
1280
1281 while ((dirent = g_dir_read_name (dir))) {
1282 GStatBuf file_status;
1283
1284 filename = g_build_filename (path, dirent, NULL);
1285 if (g_stat (filename, &file_status) < 0) {
1286 /* Plugin will be removed from cache after the scan completes if it
1287 * is still marked 'cached' */
1288 g_free (filename);
1289 continue;
1290 }
1291
1292 if (file_status.st_mode & S_IFDIR) {
1293 if (G_UNLIKELY (skip_directory (path, dirent))) {
1294 GST_TRACE_OBJECT (context->registry, "ignoring %s directory", dirent);
1295 g_free (filename);
1296 continue;
1297 }
1298 /* FIXME 2.0: Don't recurse into directories, this behaviour
1299 * is inconsistent with other PATH environment variables
1300 */
1301 if (level > 0) {
1302 GST_LOG_OBJECT (context->registry, "recursing into directory %s",
1303 filename);
1304 changed |= gst_registry_scan_path_level (context, filename, level - 1);
1305 } else {
1306 GST_LOG_OBJECT (context->registry, "not recursing into directory %s, "
1307 "recursion level too deep", filename);
1308 }
1309 g_free (filename);
1310 continue;
1311 }
1312 if (!(file_status.st_mode & S_IFREG)) {
1313 GST_TRACE_OBJECT (context->registry, "%s is not a regular file, ignoring",
1314 filename);
1315 g_free (filename);
1316 continue;
1317 }
1318 if (!g_str_has_suffix (dirent, "." G_MODULE_SUFFIX)
1319 #ifdef GST_EXTRA_MODULE_SUFFIX
1320 && !g_str_has_suffix (dirent, GST_EXTRA_MODULE_SUFFIX)
1321 #endif
1322 ) {
1323 GST_TRACE_OBJECT (context->registry,
1324 "extension is not recognized as module file, ignoring file %s",
1325 filename);
1326 g_free (filename);
1327 continue;
1328 }
1329
1330 GST_LOG_OBJECT (context->registry, "file %s looks like a possible module",
1331 filename);
1332
1333 /* try to avoid unnecessary plugin-move pain */
1334 if (g_str_has_prefix (dirent, "libgstvalve") ||
1335 g_str_has_prefix (dirent, "libgstselector")) {
1336 GST_WARNING_OBJECT (context->registry, "ignoring old plugin %s which "
1337 "has been merged into the corelements plugin", filename);
1338 /* Plugin will be removed from cache after the scan completes if it
1339 * is still marked 'cached' */
1340 g_free (filename);
1341 continue;
1342 }
1343
1344 /* plug-ins are considered unique by basename; if the given name
1345 * was already seen by the registry, we ignore it */
1346 plugin = gst_registry_lookup_bn (context->registry, dirent);
1347 if (plugin) {
1348 gboolean env_vars_changed, deps_changed = FALSE;
1349
1350 if (plugin->registered) {
1351 GST_DEBUG_OBJECT (context->registry,
1352 "plugin already registered from path \"%s\"",
1353 GST_STR_NULL (plugin->filename));
1354 g_free (filename);
1355 gst_object_unref (plugin);
1356 continue;
1357 }
1358
1359 env_vars_changed = _priv_plugin_deps_env_vars_changed (plugin);
1360
1361 /* If a file with a certain basename is seen on a different path,
1362 * update the plugin to ensure the registry cache will reflect up
1363 * to date information */
1364
1365 if (plugin->file_mtime == file_status.st_mtime &&
1366 plugin->file_size == file_status.st_size && !env_vars_changed &&
1367 !(deps_changed = _priv_plugin_deps_files_changed (plugin)) &&
1368 !strcmp (plugin->filename, filename)) {
1369 GST_LOG_OBJECT (context->registry, "file %s cached", filename);
1370 GST_OBJECT_FLAG_UNSET (plugin, GST_PLUGIN_FLAG_CACHED);
1371 GST_LOG_OBJECT (context->registry,
1372 "marking plugin %p as registered as %s", plugin, filename);
1373 plugin->registered = TRUE;
1374 } else {
1375 GST_INFO_OBJECT (context->registry, "cached info for %s is stale",
1376 filename);
1377 GST_DEBUG_OBJECT (context->registry, "mtime %" G_GINT64_FORMAT " != %"
1378 G_GINT64_FORMAT " or size %" G_GINT64_FORMAT " != %"
1379 G_GINT64_FORMAT " or external dependency env_vars changed: %d or"
1380 " external dependencies changed: %d or old path %s != new path %s",
1381 (gint64) plugin->file_mtime, (gint64) file_status.st_mtime,
1382 (gint64) plugin->file_size, (gint64) file_status.st_size,
1383 env_vars_changed, deps_changed, plugin->filename, filename);
1384 gst_registry_remove_plugin (context->registry, plugin);
1385 changed |= gst_registry_scan_plugin_file (context, filename,
1386 file_status.st_size, file_status.st_mtime);
1387 }
1388 gst_object_unref (plugin);
1389
1390 } else {
1391 GST_DEBUG_OBJECT (context->registry, "file %s not yet in registry",
1392 filename);
1393 changed |= gst_registry_scan_plugin_file (context, filename,
1394 file_status.st_size, file_status.st_mtime);
1395 }
1396
1397 g_free (filename);
1398 }
1399
1400 g_dir_close (dir);
1401
1402 return changed;
1403 }
1404
1405 static gboolean
gst_registry_scan_path_internal(GstRegistryScanContext * context,const gchar * path)1406 gst_registry_scan_path_internal (GstRegistryScanContext * context,
1407 const gchar * path)
1408 {
1409 gboolean changed;
1410
1411 GST_DEBUG_OBJECT (context->registry, "scanning path %s", path);
1412 changed = gst_registry_scan_path_level (context, path, 10);
1413
1414 GST_DEBUG_OBJECT (context->registry, "registry changed in path %s: %d", path,
1415 changed);
1416 return changed;
1417 }
1418
1419 /**
1420 * gst_registry_scan_path:
1421 * @registry: the registry to add found plugins to
1422 * @path: (type filename): the path to scan
1423 *
1424 * Scan the given path for plugins to add to the registry. The syntax of the
1425 * path is specific to the registry.
1426 *
1427 * Returns: %TRUE if registry changed
1428 */
1429 gboolean
gst_registry_scan_path(GstRegistry * registry,const gchar * path)1430 gst_registry_scan_path (GstRegistry * registry, const gchar * path)
1431 {
1432 GstRegistryScanContext context;
1433 gboolean result;
1434
1435 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1436 g_return_val_if_fail (path != NULL, FALSE);
1437
1438 init_scan_context (&context, registry);
1439
1440 result = gst_registry_scan_path_internal (&context, path);
1441
1442 clear_scan_context (&context);
1443 result |= context.changed;
1444
1445 return result;
1446 }
1447
1448 static gboolean
_gst_plugin_feature_filter_plugin_name(GstPluginFeature * feature,gpointer user_data)1449 _gst_plugin_feature_filter_plugin_name (GstPluginFeature * feature,
1450 gpointer user_data)
1451 {
1452 return (strcmp (feature->plugin_name, (gchar *) user_data) == 0);
1453 }
1454
1455 /**
1456 * gst_registry_get_feature_list_by_plugin:
1457 * @registry: a #GstRegistry.
1458 * @name: a plugin name.
1459 *
1460 * Retrieves a #GList of features of the plugin with name @name.
1461 *
1462 * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
1463 * #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
1464 */
1465 GList *
gst_registry_get_feature_list_by_plugin(GstRegistry * registry,const gchar * name)1466 gst_registry_get_feature_list_by_plugin (GstRegistry * registry,
1467 const gchar * name)
1468 {
1469 g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1470 g_return_val_if_fail (name != NULL, NULL);
1471
1472 return gst_registry_feature_filter (registry,
1473 _gst_plugin_feature_filter_plugin_name, FALSE, (gpointer) name);
1474 }
1475
1476 /* Private function for getting plugin features directly */
1477 GList *
_priv_plugin_get_features(GstRegistry * registry,GstPlugin * plugin)1478 _priv_plugin_get_features (GstRegistry * registry, GstPlugin * plugin)
1479 {
1480 GList *res = NULL;
1481 GList *walk;
1482
1483 GST_OBJECT_LOCK (registry);
1484 for (walk = registry->priv->features; walk; walk = walk->next) {
1485 GstPluginFeature *feat = (GstPluginFeature *) walk->data;
1486 if (feat->plugin == plugin)
1487 res = g_list_prepend (res, gst_object_ref (feat));
1488 }
1489 GST_OBJECT_UNLOCK (registry);
1490
1491 return res;
1492 }
1493
1494 /* Unref and delete the default registry */
1495 void
_priv_gst_registry_cleanup(void)1496 _priv_gst_registry_cleanup (void)
1497 {
1498 GstRegistry *registry;
1499
1500 g_mutex_lock (&_gst_registry_mutex);
1501 if ((registry = _gst_registry_default) != NULL) {
1502 _gst_registry_default = NULL;
1503 }
1504 g_mutex_unlock (&_gst_registry_mutex);
1505
1506 /* unref outside of the lock because we can. */
1507 if (registry)
1508 gst_object_unref (registry);
1509 }
1510
1511 /**
1512 * gst_registry_check_feature_version:
1513 * @registry: a #GstRegistry
1514 * @feature_name: the name of the feature (e.g. "oggdemux")
1515 * @min_major: the minimum major version number
1516 * @min_minor: the minimum minor version number
1517 * @min_micro: the minimum micro version number
1518 *
1519 * Checks whether a plugin feature by the given name exists in
1520 * @registry and whether its version is at least the
1521 * version required.
1522 *
1523 * Returns: %TRUE if the feature could be found and the version is
1524 * the same as the required version or newer, and %FALSE otherwise.
1525 */
1526 gboolean
gst_registry_check_feature_version(GstRegistry * registry,const gchar * feature_name,guint min_major,guint min_minor,guint min_micro)1527 gst_registry_check_feature_version (GstRegistry * registry,
1528 const gchar * feature_name, guint min_major, guint min_minor,
1529 guint min_micro)
1530 {
1531 GstPluginFeature *feature;
1532 gboolean ret = FALSE;
1533
1534 g_return_val_if_fail (feature_name != NULL, FALSE);
1535
1536 GST_DEBUG ("Looking up plugin feature '%s'", feature_name);
1537
1538 feature = gst_registry_lookup_feature (registry, feature_name);
1539 if (feature) {
1540 ret = gst_plugin_feature_check_version (feature, min_major, min_minor,
1541 min_micro);
1542 gst_object_unref (feature);
1543 } else {
1544 GST_DEBUG ("Could not find plugin feature '%s'", feature_name);
1545 }
1546
1547 return ret;
1548 }
1549
1550 static void
load_plugin_func(gpointer data,gpointer user_data)1551 load_plugin_func (gpointer data, gpointer user_data)
1552 {
1553 GstPlugin *plugin;
1554 const gchar *filename;
1555 GError *err = NULL;
1556
1557 filename = (const gchar *) data;
1558 GST_DEBUG ("Pre-loading plugin %s", filename);
1559
1560 plugin = gst_plugin_load_file (filename, &err);
1561
1562 if (plugin) {
1563 GST_INFO ("Loaded plugin: \"%s\"", filename);
1564
1565 gst_registry_add_plugin (gst_registry_get (), plugin);
1566 } else {
1567 if (err) {
1568 /* Report error to user, and free error */
1569 GST_ERROR ("Failed to load plugin: %s", err->message);
1570 g_error_free (err);
1571 } else {
1572 GST_WARNING ("Failed to load plugin: \"%s\"", filename);
1573 }
1574 }
1575 }
1576
1577 char *
priv_gst_get_relocated_libgstreamer(void)1578 priv_gst_get_relocated_libgstreamer (void)
1579 {
1580 char *dir = NULL;
1581
1582 #ifdef G_OS_WIN32
1583 {
1584 char *base_dir;
1585
1586 GST_DEBUG ("attempting to retrieve libgstreamer-1.0 location using "
1587 "Win32-specific method");
1588
1589 base_dir =
1590 g_win32_get_package_installation_directory_of_module
1591 (_priv_gst_dll_handle);
1592 if (!base_dir)
1593 return NULL;
1594
1595 dir = g_build_filename (base_dir, GST_PLUGIN_SUBDIR, NULL);
1596 GST_DEBUG ("using DLL dir %s", dir);
1597
1598 g_free (base_dir);
1599 }
1600 #elif defined(__APPLE__) && defined(HAVE_DLADDR)
1601 {
1602 Dl_info info;
1603
1604 GST_DEBUG ("attempting to retrieve libgstreamer-1.0 location using "
1605 "dladdr()");
1606
1607 if (dladdr (&gst_init, &info)) {
1608 GST_LOG ("dli_fname: %s", info.dli_fname);
1609
1610 if (!info.dli_fname) {
1611 return NULL;
1612 }
1613
1614 dir = g_path_get_dirname (info.dli_fname);
1615 } else {
1616 GST_LOG ("dladdr() failed");
1617 return NULL;
1618 }
1619 }
1620 #endif
1621
1622 return dir;
1623 }
1624
1625 #ifndef GST_DISABLE_REGISTRY
1626 /* Unref all plugins marked 'cached', to clear old plugins that no
1627 * longer exist. Returns %TRUE if any plugins were removed */
1628 static gboolean
gst_registry_remove_cache_plugins(GstRegistry * registry)1629 gst_registry_remove_cache_plugins (GstRegistry * registry)
1630 {
1631 GList *g;
1632 GList *g_next;
1633 GstPlugin *plugin;
1634 gboolean changed = FALSE;
1635
1636 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1637
1638 GST_OBJECT_LOCK (registry);
1639
1640 GST_DEBUG_OBJECT (registry, "removing cached plugins");
1641 g = registry->priv->plugins;
1642 while (g) {
1643 g_next = g->next;
1644 plugin = g->data;
1645 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_CACHED)) {
1646 GST_DEBUG_OBJECT (registry, "removing cached plugin \"%s\"",
1647 GST_STR_NULL (plugin->filename));
1648 registry->priv->plugins = g_list_delete_link (registry->priv->plugins, g);
1649 --registry->priv->n_plugins;
1650 if (G_LIKELY (plugin->basename))
1651 g_hash_table_remove (registry->priv->basename_hash, plugin->basename);
1652 gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
1653 gst_object_unref (plugin);
1654 changed = TRUE;
1655 }
1656 g = g_next;
1657 }
1658
1659 GST_OBJECT_UNLOCK (registry);
1660
1661 return changed;
1662 }
1663
1664 typedef enum
1665 {
1666 REGISTRY_SCAN_AND_UPDATE_FAILURE = 0,
1667 REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED,
1668 REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED
1669 } GstRegistryScanAndUpdateResult;
1670
1671 /*
1672 * scan_and_update_registry:
1673 * @default_registry: the #GstRegistry
1674 * @registry_file: registry filename
1675 * @write_changes: write registry if it has changed?
1676 *
1677 * Scans for registry changes and eventually updates the registry cache.
1678 *
1679 * Return: %REGISTRY_SCAN_AND_UPDATE_FAILURE if the registry could not scanned
1680 * or updated, %REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED if the
1681 * registry is clean and %REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED if
1682 * it has been updated and the cache needs to be re-read.
1683 */
1684 static GstRegistryScanAndUpdateResult
scan_and_update_registry(GstRegistry * default_registry,const gchar * registry_file,gboolean write_changes,GError ** error)1685 scan_and_update_registry (GstRegistry * default_registry,
1686 const gchar * registry_file, gboolean write_changes, GError ** error)
1687 {
1688 const gchar *plugin_path;
1689 gboolean changed = FALSE;
1690 GList *l;
1691 GstRegistryScanContext context;
1692
1693 GST_INFO ("Validating plugins from registry cache: %s", registry_file);
1694
1695 init_scan_context (&context, default_registry);
1696
1697 /* It sounds tempting to just compare the mtime of directories with the mtime
1698 * of the registry cache, but it does not work. It would not catch updated
1699 * plugins, which might bring more or less features.
1700 */
1701
1702 /* scan paths specified via --gst-plugin-path */
1703 GST_DEBUG ("scanning paths added via --gst-plugin-path");
1704 for (l = _priv_gst_plugin_paths; l != NULL; l = l->next) {
1705 GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data);
1706 changed |= gst_registry_scan_path_internal (&context, (gchar *) l->data);
1707 }
1708 /* keep plugin_paths around in case a re-scan is forced later on */
1709
1710 /* GST_PLUGIN_PATH specifies a list of directories to scan for
1711 * additional plugins. These take precedence over the system plugins */
1712 plugin_path = g_getenv ("GST_PLUGIN_PATH_1_0");
1713 if (plugin_path == NULL)
1714 plugin_path = g_getenv ("GST_PLUGIN_PATH");
1715 if (plugin_path) {
1716 char **list;
1717 int i;
1718
1719 GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path);
1720 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1721 for (i = 0; list[i]; i++) {
1722 changed |= gst_registry_scan_path_internal (&context, list[i]);
1723 }
1724 g_strfreev (list);
1725 } else {
1726 GST_DEBUG ("GST_PLUGIN_PATH not set");
1727 }
1728
1729 /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always
1730 * loaded by default. If not set, this defaults to the system-installed
1731 * path, and the plugins installed in the user's home directory */
1732 plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH_1_0");
1733 if (plugin_path == NULL)
1734 plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH");
1735 if (plugin_path == NULL) {
1736 char *home_plugins, *relocated_libgstreamer, *system_plugindir;
1737
1738 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set");
1739
1740 /* plugins in the user's home directory take precedence over
1741 * system-installed ones */
1742 home_plugins = g_build_filename (g_get_user_data_dir (),
1743 "gstreamer-" GST_API_VERSION, "plugins", NULL);
1744
1745 GST_DEBUG ("scanning home plugins %s", home_plugins);
1746 changed |= gst_registry_scan_path_internal (&context, home_plugins);
1747 g_free (home_plugins);
1748
1749 /* add the main (installed) library path */
1750
1751 relocated_libgstreamer = priv_gst_get_relocated_libgstreamer ();
1752 if (relocated_libgstreamer) {
1753 GST_DEBUG ("found libgstreamer-" GST_API_VERSION " library "
1754 "at %s", relocated_libgstreamer);
1755 system_plugindir = g_build_filename (relocated_libgstreamer,
1756 "gstreamer-" GST_API_VERSION, NULL);
1757 } else {
1758 system_plugindir = g_strdup (PLUGINDIR);
1759 }
1760
1761 GST_DEBUG ("using plugin dir %s", system_plugindir);
1762 changed |= gst_registry_scan_path_internal (&context, system_plugindir);
1763
1764 g_clear_pointer (&system_plugindir, g_free);
1765 g_clear_pointer (&relocated_libgstreamer, g_free);
1766 } else {
1767 gchar **list;
1768 gint i;
1769
1770 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path);
1771 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1772 for (i = 0; list[i]; i++) {
1773 changed |= gst_registry_scan_path_internal (&context, list[i]);
1774 }
1775 g_strfreev (list);
1776 }
1777
1778 clear_scan_context (&context);
1779 changed |= context.changed;
1780
1781 /* Remove cached plugins so stale info is cleared. */
1782 changed |= gst_registry_remove_cache_plugins (default_registry);
1783
1784 if (!changed) {
1785 GST_INFO ("Registry cache has not changed");
1786 return REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED;
1787 }
1788
1789 if (!write_changes) {
1790 GST_INFO ("Registry cache changed, but writing is disabled. Not writing.");
1791 return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1792 }
1793
1794 GST_INFO ("Registry cache changed. Writing new registry cache");
1795 if (!priv_gst_registry_binary_write_cache (default_registry,
1796 default_registry->priv->plugins, registry_file)) {
1797 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
1798 _("Error writing registry cache to %s: %s"),
1799 registry_file, g_strerror (errno));
1800 return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1801 }
1802
1803 GST_INFO ("Registry cache written successfully");
1804 return REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED;
1805 }
1806
1807 static gboolean
ensure_current_registry(GError ** error)1808 ensure_current_registry (GError ** error)
1809 {
1810 gchar *registry_file;
1811 GstRegistry *default_registry;
1812 gboolean ret = TRUE;
1813 gboolean do_update = TRUE;
1814 gboolean have_cache = TRUE;
1815
1816 default_registry = gst_registry_get ();
1817
1818 registry_file = g_strdup (g_getenv ("GST_REGISTRY_1_0"));
1819 if (registry_file == NULL)
1820 registry_file = g_strdup (g_getenv ("GST_REGISTRY"));
1821 if (registry_file == NULL) {
1822 registry_file = g_build_filename (g_get_user_cache_dir (),
1823 "gstreamer-" GST_API_VERSION, GST_REGISTRY_FILE_NAME, NULL);
1824 }
1825
1826 if (!_gst_disable_registry_cache) {
1827 GST_INFO ("reading registry cache: %s", registry_file);
1828 have_cache = priv_gst_registry_binary_read_cache (default_registry,
1829 registry_file);
1830 /* Only ever read the registry cache once, then disable it for
1831 * subsequent updates during the program lifetime */
1832 _gst_disable_registry_cache = TRUE;
1833 }
1834
1835 if (have_cache) {
1836 do_update = !_priv_gst_disable_registry_update;
1837 if (do_update) {
1838 const gchar *update_env;
1839
1840 if ((update_env = g_getenv ("GST_REGISTRY_UPDATE"))) {
1841 /* do update for any value different from "no" */
1842 do_update = (strcmp (update_env, "no") != 0);
1843 }
1844 }
1845 }
1846
1847 if (do_update) {
1848 const gchar *reuse_env;
1849
1850 if ((reuse_env = g_getenv ("GST_REGISTRY_REUSE_PLUGIN_SCANNER"))) {
1851 /* do reuse for any value different from "no" */
1852 __registry_reuse_plugin_scanner = (strcmp (reuse_env, "no") != 0);
1853 }
1854 /* now check registry */
1855 GST_DEBUG ("Updating registry cache");
1856 scan_and_update_registry (default_registry, registry_file, TRUE, error);
1857 } else {
1858 GST_DEBUG ("Not updating registry cache (disabled)");
1859 }
1860
1861 g_free (registry_file);
1862 GST_INFO ("registry reading and updating done, result = %d", ret);
1863
1864 return ret;
1865 }
1866 #endif /* GST_DISABLE_REGISTRY */
1867
1868 /**
1869 * gst_registry_fork_is_enabled:
1870 *
1871 * By default GStreamer will perform scanning and rebuilding of the
1872 * registry file using a helper child process.
1873 *
1874 * Applications might want to disable this behaviour with the
1875 * gst_registry_fork_set_enabled() function, in which case new plugins
1876 * are scanned (and loaded) into the application process.
1877 *
1878 * Returns: %TRUE if GStreamer will use the child helper process when
1879 * rebuilding the registry.
1880 */
1881 gboolean
gst_registry_fork_is_enabled(void)1882 gst_registry_fork_is_enabled (void)
1883 {
1884 return _gst_enable_registry_fork;
1885 }
1886
1887 /**
1888 * gst_registry_fork_set_enabled:
1889 * @enabled: whether rebuilding the registry can use a temporary child helper process.
1890 *
1891 * Applications might want to disable/enable spawning of a child helper process
1892 * when rebuilding the registry. See gst_registry_fork_is_enabled() for more
1893 * information.
1894 */
1895 void
gst_registry_fork_set_enabled(gboolean enabled)1896 gst_registry_fork_set_enabled (gboolean enabled)
1897 {
1898 _gst_enable_registry_fork = enabled;
1899 }
1900
1901 /**
1902 * gst_update_registry:
1903 *
1904 * Forces GStreamer to re-scan its plugin paths and update the default
1905 * plugin registry.
1906 *
1907 * Applications will almost never need to call this function, it is only
1908 * useful if the application knows new plugins have been installed (or old
1909 * ones removed) since the start of the application (or, to be precise, the
1910 * first call to gst_init()) and the application wants to make use of any
1911 * newly-installed plugins without restarting the application.
1912 *
1913 * Applications should assume that the registry update is neither atomic nor
1914 * thread-safe and should therefore not have any dynamic pipelines running
1915 * (including the playbin and decodebin elements) and should also not create
1916 * any elements or access the GStreamer registry while the update is in
1917 * progress.
1918 *
1919 * Note that this function may block for a significant amount of time.
1920 *
1921 * Returns: %TRUE if the registry has been updated successfully (does not
1922 * imply that there were changes), otherwise %FALSE.
1923 */
1924 gboolean
gst_update_registry(void)1925 gst_update_registry (void)
1926 {
1927 gboolean res;
1928
1929 #ifndef GST_DISABLE_REGISTRY
1930 if (!_priv_gst_disable_registry) {
1931 GError *err = NULL;
1932
1933 res = ensure_current_registry (&err);
1934 if (err) {
1935 GST_WARNING ("registry update failed: %s", err->message);
1936 g_error_free (err);
1937 } else {
1938 GST_LOG ("registry update succeeded");
1939 }
1940 } else {
1941 GST_INFO ("registry update disabled by environment");
1942 res = TRUE;
1943 }
1944
1945 #else
1946 GST_WARNING ("registry update failed: %s", "registry disabled");
1947 res = TRUE;
1948 #endif /* GST_DISABLE_REGISTRY */
1949
1950 #ifndef GST_DISABLE_OPTION_PARSING
1951 if (_priv_gst_preload_plugins) {
1952 GST_DEBUG ("Preloading indicated plugins...");
1953 g_slist_foreach (_priv_gst_preload_plugins, load_plugin_func, NULL);
1954 }
1955 #endif
1956
1957 return res;
1958 }
1959
1960 /**
1961 * gst_registry_get_feature_list_cookie:
1962 * @registry: the registry
1963 *
1964 * Returns the registry's feature list cookie. This changes
1965 * every time a feature is added or removed from the registry.
1966 *
1967 * Returns: the feature list cookie.
1968 */
1969 guint32
gst_registry_get_feature_list_cookie(GstRegistry * registry)1970 gst_registry_get_feature_list_cookie (GstRegistry * registry)
1971 {
1972 g_return_val_if_fail (GST_IS_REGISTRY (registry), 0);
1973
1974 return registry->priv->cookie;
1975 }
1976