2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gst.c: Initialization and non-pipeline operations
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
25 * @short_description: Media library supporting arbitrary formats and filter
27 * @see_also: Check out both <ulink url="http://www.cse.ogi.edu/sysl/">OGI's
28 * pipeline</ulink> and Microsoft's DirectShow for some background.
30 * GStreamer is a framework for constructing graphs of various filters
31 * (termed elements here) that will handle streaming media. Any discreet
32 * (packetizable) media type is supported, with provisions for automatically
33 * determining source type. Formatting/framing information is provided with
34 * a powerful negotiation framework. Plugins are heavily used to provide for
35 * all elements, allowing one to construct plugins outside of the GST
36 * library, even released binary-only if license require (please don't).
38 * GStreamer borrows heavily from both the <ulink
39 * url="http://www.cse.ogi.edu/sysl/">OGI media pipeline</ulink> and
40 * Microsoft's DirectShow, hopefully taking the best of both and leaving the
41 * cruft behind. Its interface is slowly getting stable.
43 * The <application>GStreamer</application> library should be initialized with
44 * gst_init() before it can be used. You should pass pointers to the main argc
45 * and argv variables so that GStreamer can process its own command line
46 * options, as shown in the following example.
49 * <title>Initializing the gstreamer library</title>
50 * <programlisting language="c">
52 * main (int argc, char *argv[])
54 * // initialize the GStreamer library
55 * gst_init (&argc, &argv);
61 * It's allowed to pass two NULL pointers to gst_init() in case you don't want
62 * to pass the command line args to GStreamer.
64 * You can also use GOption to initialize your own parameters as shown in
65 * the next code fragment:
67 * <title>Initializing own parameters when initializing gstreamer</title>
69 * static gboolean stats = FALSE;
72 * main (int argc, char *argv[])
74 * GOptionEntry options[] = {
75 * {"tags", 't', 0, G_OPTION_ARG_NONE, &tags,
76 * N_("Output tags (also known as metadata)"), NULL},
79 * // must initialise the threading system before using any other GLib funtion
80 * if (!g_thread_supported ())
81 * g_thread_init (NULL);
82 * ctx = g_option_context_new ("[ADDITIONAL ARGUMENTS]");
83 * g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
84 * g_option_context_add_group (ctx, gst_init_get_option_group ());
85 * if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
86 * g_print ("Error initializing: %s\n", GST_STR_NULL (err->message));
89 * g_option_context_free (ctx);
95 * Use gst_version() to query the library version at runtime or use the
96 * GST_VERSION_* macros to find the version at compile time. Optionally
97 * gst_version_string() returns a printable string.
99 * The gst_deinit() call is used to clean up all internal resources used
100 * by <application>GStreamer</application>. It is mostly used in unit tests
101 * to check for leaks.
103 * Last reviewed on 2006-08-11 (0.10.10)
106 #include "gst_private.h"
109 #include <sys/types.h>
111 #include <sys/wait.h>
112 #endif /* HAVE_FORK */
113 #ifdef HAVE_SYS_UTSNAME_H
114 #include <sys/utsname.h>
120 #include "gst-i18n-lib.h"
121 #include <locale.h> /* for LC_ALL */
125 #define GST_CAT_DEFAULT GST_CAT_GST_INIT
127 #define MAX_PATH_SPLIT 16
128 #define GST_PLUGIN_SEPARATOR ","
130 static gboolean gst_initialized = FALSE;
132 #ifndef GST_DISABLE_REGISTRY
133 static GList *plugin_paths = NULL; /* for delayed processing in post_init */
136 extern gint _gst_trace_on;
140 #define DEFAULT_FORK TRUE
142 #define DEFAULT_FORK FALSE
143 #endif /* HAVE_FORK */
145 /* set to TRUE when segfaults need to be left as is, FIXME, this variable is
147 gboolean _gst_disable_segtrap = FALSE;
149 /* control the behaviour of registry rebuild */
150 static gboolean _gst_enable_registry_fork = DEFAULT_FORK;
152 static void load_plugin_func (gpointer data, gpointer user_data);
153 static gboolean init_pre (GOptionContext * context, GOptionGroup * group,
154 gpointer data, GError ** error);
155 static gboolean init_post (GOptionContext * context, GOptionGroup * group,
156 gpointer data, GError ** error);
157 static gboolean parse_goption_arg (const gchar * s_opt,
158 const gchar * arg, gpointer data, GError ** err);
160 static GSList *preload_plugins = NULL;
162 const gchar g_log_domain_gstreamer[] = "GStreamer";
165 debug_log_handler (const gchar * log_domain,
166 GLogLevelFlags log_level, const gchar * message, gpointer user_data)
168 g_log_default_handler (log_domain, log_level, message, user_data);
169 /* FIXME: do we still need this ? fatal errors these days are all
170 * other than core errors */
171 /* g_on_error_query (NULL); */
178 #ifndef GST_DISABLE_GST_DEBUG
189 ARG_REGISTRY_FORK_DISABLE
192 /* debug-spec ::= category-spec [, category-spec]*
193 * category-spec ::= category:val | val
202 #ifndef GST_DISABLE_GST_DEBUG
204 parse_debug_category (gchar * str, const gchar ** category)
221 parse_debug_level (gchar * str, gint * level)
229 if (str[0] != NUL && str[1] == NUL
230 && str[0] >= '0' && str[0] < '0' + GST_LEVEL_COUNT) {
231 *level = str[0] - '0';
239 parse_debug_list (const gchar * list)
244 g_return_if_fail (list != NULL);
246 split = g_strsplit (list, ",", 0);
248 for (walk = split; *walk; walk++) {
249 if (strchr (*walk, ':')) {
250 gchar **values = g_strsplit (*walk, ":", 2);
252 if (values[0] && values[1]) {
254 const gchar *category;
256 if (parse_debug_category (values[0], &category)
257 && parse_debug_level (values[1], &level))
258 gst_debug_set_threshold_for_name (category, level);
265 if (parse_debug_level (*walk, &level))
266 gst_debug_set_default_threshold (level);
275 * gst_init_get_option_group:
277 * Returns a #GOptionGroup with GStreamer's argument specifications. The
278 * group is set up to use standard GOption callbacks, so when using this
279 * group in combination with GOption parsing methods, all argument parsing
280 * and initialization is automated.
282 * This function is useful if you want to integrate GStreamer with other
283 * libraries that use GOption (see g_option_context_add_group() ).
285 * If you use this function, you should make sure you initialise the GLib
286 * threading system as one of the very first things in your program
287 * (see the example at the beginning of this section).
289 * Returns: a pointer to GStreamer's option group.
293 gst_init_get_option_group (void)
296 const static GOptionEntry gst_args[] = {
297 {"gst-version", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
298 (gpointer) parse_goption_arg, N_("Print the GStreamer version"), NULL},
299 {"gst-fatal-warnings", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
300 (gpointer) parse_goption_arg, N_("Make all warnings fatal"), NULL},
301 #ifndef GST_DISABLE_GST_DEBUG
302 {"gst-debug-help", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
303 (gpointer) parse_goption_arg,
304 N_("Print available debug categories and exit"),
306 {"gst-debug-level", 0, 0, G_OPTION_ARG_CALLBACK,
307 (gpointer) parse_goption_arg,
308 N_("Default debug level from 1 (only error) to 5 (anything) or "
311 {"gst-debug", 0, 0, G_OPTION_ARG_CALLBACK, (gpointer) parse_goption_arg,
312 N_("Comma-separated list of category_name:level pairs to set "
313 "specific levels for the individual categories. Example: "
314 "GST_AUTOPLUG:5,GST_ELEMENT_*:3"),
316 {"gst-debug-no-color", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
317 (gpointer) parse_goption_arg, N_("Disable colored debugging output"),
319 {"gst-debug-disable", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
320 (gpointer) parse_goption_arg, N_("Disable debugging"), NULL},
322 {"gst-plugin-spew", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
323 (gpointer) parse_goption_arg,
324 N_("Enable verbose plugin loading diagnostics"),
326 {"gst-plugin-path", 0, 0, G_OPTION_ARG_CALLBACK,
327 (gpointer) parse_goption_arg,
328 N_("Colon-separated paths containing plugins"), N_("PATHS")},
329 {"gst-plugin-load", 0, 0, G_OPTION_ARG_CALLBACK,
330 (gpointer) parse_goption_arg,
331 N_("Comma-separated list of plugins to preload in addition to the "
332 "list stored in environment variable GST_PLUGIN_PATH"),
334 {"gst-disable-segtrap", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
335 (gpointer) parse_goption_arg,
336 N_("Disable trapping of segmentation faults during plugin loading"),
338 {"gst-disable-registry-fork", 0, G_OPTION_FLAG_NO_ARG,
339 G_OPTION_ARG_CALLBACK,
340 (gpointer) parse_goption_arg,
341 N_("Disable the use of fork() while scanning the registry"),
346 /* The GLib threading system must be initialised before calling any other
347 * GLib function according to the documentation; if the application hasn't
348 * called gst_init() yet or initialised the threading system otherwise, we
349 * better issue a warning here (since chances are high that the application
350 * has already called other GLib functions such as g_option_context_new() */
351 if (!g_thread_supported ()) {
352 g_warning ("The GStreamer function gst_init_get_option_group() was\n"
353 "\tcalled, but the GLib threading system has not been initialised\n"
354 "\tyet, something that must happen before any other GLib function\n"
355 "\tis called. The application needs to be fixed so that it calls\n"
356 "\t if (!g_thread_supported ()) g_thread_init(NULL);\n"
357 "\tas very first thing in its main() function. Please file a bug\n"
358 "\tagainst this application.");
359 g_thread_init (NULL);
362 group = g_option_group_new ("gst", _("GStreamer Options"),
363 _("Show GStreamer Options"), NULL, NULL);
364 g_option_group_set_parse_hooks (group, (GOptionParseFunc) init_pre,
365 (GOptionParseFunc) init_post);
367 g_option_group_add_entries (group, gst_args);
368 g_option_group_set_translation_domain (group, GETTEXT_PACKAGE);
375 * @argc: pointer to application's argc
376 * @argv: pointer to application's argv
377 * @err: pointer to a #GError to which a message will be posted on error
379 * Initializes the GStreamer library, setting up internal path lists,
380 * registering built-in elements, and loading standard plugins.
382 * This function will return %FALSE if GStreamer could not be initialized
383 * for some reason. If you want your program to fail fatally,
384 * use gst_init() instead.
386 * This function should be called before calling any other GLib functions. If
387 * this is not an option, your program must initialise the GLib thread system
388 * using g_thread_init() before any other GLib functions are called.
390 * Returns: %TRUE if GStreamer could be initialized.
393 gst_init_check (int *argc, char **argv[], GError ** err)
399 if (!g_thread_supported ())
400 g_thread_init (NULL);
402 GST_INFO ("initializing GStreamer");
404 if (gst_initialized) {
405 GST_DEBUG ("already initialized gst");
409 ctx = g_option_context_new ("- GStreamer initialization");
410 g_option_context_set_ignore_unknown_options (ctx, TRUE);
411 group = gst_init_get_option_group ();
412 g_option_context_add_group (ctx, group);
413 res = g_option_context_parse (ctx, argc, argv, err);
414 g_option_context_free (ctx);
416 gst_initialized = res;
419 GST_INFO ("initialized GStreamer successfully");
421 GST_INFO ("failed to initialize GStreamer");
429 * @argc: pointer to application's argc
430 * @argv: pointer to application's argv
432 * Initializes the GStreamer library, setting up internal path lists,
433 * registering built-in elements, and loading standard plugins.
435 * This function should be called before calling any other GLib functions. If
436 * this is not an option, your program must initialise the GLib thread system
437 * using g_thread_init() before any other GLib functions are called.
440 * This function will terminate your program if it was unable to initialize
441 * GStreamer for some reason. If you want your program to fall back,
442 * use gst_init_check() instead.
445 * WARNING: This function does not work in the same way as corresponding
446 * functions in other glib-style libraries, such as gtk_init(). In
447 * particular, unknown command line options cause this function to
448 * abort program execution.
451 gst_init (int *argc, char **argv[])
455 if (!gst_init_check (argc, argv, &err)) {
456 g_print ("Could not initialize GStreamer: %s\n",
457 err ? err->message : "unknown error occurred");
465 #ifndef GST_DISABLE_REGISTRY
467 add_path_func (gpointer data, gpointer user_data)
469 GST_INFO ("Adding plugin path: \"%s\", will scan later", (gchar *) data);
470 plugin_paths = g_list_append (plugin_paths, g_strdup (data));
475 prepare_for_load_plugin_func (gpointer data, gpointer user_data)
477 preload_plugins = g_slist_prepend (preload_plugins, g_strdup (data));
481 load_plugin_func (gpointer data, gpointer user_data)
484 const gchar *filename;
487 filename = (const gchar *) data;
489 plugin = gst_plugin_load_file (filename, &err);
492 GST_INFO ("Loaded plugin: \"%s\"", filename);
494 gst_default_registry_add_plugin (plugin);
497 /* Report error to user, and free error */
498 GST_ERROR ("Failed to load plugin: %s", err->message);
501 GST_WARNING ("Failed to load plugin: \"%s\"", filename);
507 split_and_iterate (const gchar * stringlist, gchar * separator, GFunc iterator,
512 gchar *lastlist = g_strdup (stringlist);
515 strings = g_strsplit (lastlist, separator, MAX_PATH_SPLIT);
520 iterator (strings[j], user_data);
521 if (++j == MAX_PATH_SPLIT) {
522 lastlist = g_strdup (strings[j]);
527 g_strfreev (strings);
531 /* we have no fail cases yet, but maybe in the future */
533 init_pre (GOptionContext * context, GOptionGroup * group, gpointer data,
536 if (gst_initialized) {
537 GST_DEBUG ("already initialized");
541 /* GStreamer was built against a GLib >= 2.8 and is therefore not doing
542 * the refcount hack. Check that it isn't being run against an older GLib */
543 if (glib_major_version < 2 ||
544 (glib_major_version == 2 && glib_minor_version < 8)) {
545 g_warning ("GStreamer was compiled against GLib %d.%d.%d but is running"
546 " against %d.%d.%d. This will cause reference counting issues",
547 GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION, GLIB_MICRO_VERSION,
548 glib_major_version, glib_minor_version, glib_micro_version);
553 /* we need threading to be enabled right here */
554 g_assert (g_thread_supported ());
558 setlocale (LC_ALL, "");
559 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
560 #endif /* ENABLE_NLS */
562 #ifndef GST_DISABLE_GST_DEBUG
564 const gchar *debug_list;
566 if (g_getenv ("GST_DEBUG_NO_COLOR") != NULL)
567 gst_debug_set_colored (FALSE);
569 debug_list = g_getenv ("GST_DEBUG");
571 parse_debug_list (debug_list);
575 /* This is the earliest we can make stuff show up in the logs.
576 * So give some useful info about GStreamer here */
577 GST_INFO ("Initializing GStreamer Core Library version %s", VERSION);
578 GST_INFO ("Using library installed in %s", LIBDIR);
580 /* Print some basic system details if possible (OS/architecture) */
581 #ifdef HAVE_SYS_UTSNAME_H
583 struct utsname sys_details;
585 if (uname (&sys_details) == 0) {
586 GST_INFO ("%s %s %s %s %s", sys_details.sysname,
587 sys_details.nodename, sys_details.release, sys_details.version,
588 sys_details.machine);
597 gst_register_core_elements (GstPlugin * plugin)
599 /* register some standard builtin types */
600 if (!gst_element_register (plugin, "bin", GST_RANK_PRIMARY,
602 !gst_element_register (plugin, "pipeline", GST_RANK_PRIMARY,
605 g_assert_not_reached ();
610 static GstPluginDesc plugin_desc = {
614 "core elements linked into the GStreamer library",
615 gst_register_core_elements,
625 #ifndef GST_DISABLE_REGISTRY
628 * scan_and_update_registry:
629 * @default_registry: the #GstRegistry
630 * @registry_file: registry filename
631 * @write_changes: write registry if it has changed?
633 * Scans for registry changes and eventually updates the registry cache.
635 * Return: %TRUE if the registry could be updated
638 scan_and_update_registry (GstRegistry * default_registry,
639 const gchar * registry_file, gboolean write_changes, GError ** error)
641 const gchar *plugin_path;
642 gboolean changed = FALSE;
645 GST_DEBUG ("reading registry cache: %s", registry_file);
646 #ifdef USE_BINARY_REGISTRY
647 gst_registry_binary_read_cache (default_registry, registry_file);
649 gst_registry_xml_read_cache (default_registry, registry_file);
651 /* scan paths specified via --gst-plugin-path */
652 GST_DEBUG ("scanning paths added via --gst-plugin-path");
653 for (l = plugin_paths; l != NULL; l = l->next) {
654 GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data);
655 /* CHECKME: add changed |= here as well? */
656 gst_registry_scan_path (default_registry, (gchar *) l->data);
658 /* keep plugin_paths around in case a re-scan is forced later on */
660 /* GST_PLUGIN_PATH specifies a list of directories to scan for
661 * additional plugins. These take precedence over the system plugins */
662 plugin_path = g_getenv ("GST_PLUGIN_PATH");
667 GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path);
668 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
669 for (i = 0; list[i]; i++) {
670 changed |= gst_registry_scan_path (default_registry, list[i]);
674 GST_DEBUG ("GST_PLUGIN_PATH not set");
677 /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always
678 * loaded by default. If not set, this defaults to the system-installed
679 * path, and the plugins installed in the user's home directory */
680 plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH");
681 if (plugin_path == NULL) {
684 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set");
686 /* plugins in the user's home directory take precedence over
687 * system-installed ones */
688 home_plugins = g_build_filename (g_get_home_dir (),
689 ".gstreamer-" GST_MAJORMINOR, "plugins", NULL);
690 changed |= gst_registry_scan_path (default_registry, home_plugins);
691 g_free (home_plugins);
693 /* add the main (installed) library path */
694 changed |= gst_registry_scan_path (default_registry, PLUGINDIR);
699 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path);
700 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
701 for (i = 0; list[i]; i++) {
702 changed |= gst_registry_scan_path (default_registry, list[i]);
707 /* Remove cached plugins so stale info is cleared. */
708 changed |= _priv_gst_registry_remove_cache_plugins (default_registry);
711 GST_INFO ("Registry cache has not changed");
715 if (!write_changes) {
716 GST_INFO ("Registry cached changed, but writing is disabled. Not writing.");
720 GST_INFO ("Registry cache changed. Writing new registry cache");
721 #ifdef USE_BINARY_REGISTRY
722 if (!gst_registry_binary_write_cache (default_registry, registry_file)) {
724 if (!gst_registry_xml_write_cache (default_registry, registry_file)) {
726 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
727 _("Error writing registry cache to %s: %s"),
728 registry_file, g_strerror (errno));
732 GST_INFO ("Registry cache written successfully");
737 ensure_current_registry_nonforking (GstRegistry * default_registry,
738 const gchar * registry_file, GError ** error)
740 /* fork() not available */
741 GST_DEBUG ("Updating registry cache in-process");
742 scan_and_update_registry (default_registry, registry_file, TRUE, error);
746 /* when forking is not available this function always does nothing but return
749 ensure_current_registry_forking (GstRegistry * default_registry,
750 const gchar * registry_file, GError ** error)
757 /* We fork here, and let the child read and possibly rebuild the registry.
758 * After that, the parent will re-read the freshly generated registry. */
759 GST_DEBUG ("forking to update registry");
761 if (pipe (pfd) == -1) {
762 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
763 _("Error re-scanning registry %s: %s"),
764 ", could not create pipes. Error", g_strerror (errno));
770 GST_ERROR ("Failed to fork()");
771 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
772 _("Error re-scanning registry %s: %s"),
773 ", failed to fork. Error", g_strerror (errno));
781 /* this is the child. Close the read pipe */
782 (void) close (pfd[0]);
784 GST_DEBUG ("child reading registry cache");
786 scan_and_update_registry (default_registry, registry_file, TRUE, NULL);
788 /* need to use _exit, so that any exit handlers registered don't
789 * bring down the main program */
790 GST_DEBUG ("child exiting: %s", (res) ? "SUCCESS" : "FAILURE");
792 /* make valgrind happy (yes, you can call it insane) */
793 g_free ((char *) registry_file);
795 /* write a result byte to the pipe */
796 res_byte = res ? '1' : '0';
798 ret = write (pfd[1], &res_byte, 1);
799 } while (ret == -1 && errno == EINTR);
800 /* if ret == -1 now, we could not write to pipe, probably
801 * means parent has exited before us */
802 (void) close (pfd[1]);
808 /* parent. Close write pipe */
809 (void) close (pfd[1]);
811 /* Wait for result from the pipe */
812 GST_DEBUG ("Waiting for data from child");
814 ret = read (pfd[0], &res_byte, 1);
815 } while (ret == -1 && errno == EINTR);
818 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
819 _("Error re-scanning registry %s: %s"),
820 ", read returned error", g_strerror (errno));
824 (void) close (pfd[0]);
826 /* Wait to ensure the child is reaped, but ignore the result */
827 GST_DEBUG ("parent waiting on child");
828 waitpid (pid, NULL, 0);
829 GST_DEBUG ("parent done waiting on child");
832 GST_ERROR ("child did not exit normally, terminated by signal");
833 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
834 _("Error re-scanning registry %s"), ", child terminated by signal");
838 if (res_byte == '1') {
839 GST_DEBUG ("Child succeeded. Parent reading registry cache");
840 #ifdef USE_BINARY_REGISTRY
841 gst_registry_binary_read_cache (default_registry, registry_file);
843 gst_registry_xml_read_cache (default_registry, registry_file);
846 GST_DEBUG ("Child failed. Parent re-scanning registry, ignoring errors.");
847 scan_and_update_registry (default_registry, registry_file, FALSE, NULL);
850 #endif /* HAVE_FORK */
855 ensure_current_registry (GError ** error)
858 GstRegistry *default_registry;
862 default_registry = gst_registry_get_default ();
863 registry_file = g_strdup (g_getenv ("GST_REGISTRY"));
864 if (registry_file == NULL) {
865 #ifdef USE_BINARY_REGISTRY
866 registry_file = g_build_filename (g_get_home_dir (),
867 ".gstreamer-" GST_MAJORMINOR, "registry." HOST_CPU ".bin", NULL);
869 registry_file = g_build_filename (g_get_home_dir (),
870 ".gstreamer-" GST_MAJORMINOR, "registry." HOST_CPU ".xml", NULL);
874 /* first see if forking is enabled */
875 do_fork = _gst_enable_registry_fork;
877 const gchar *fork_env;
879 /* forking enabled, see if it is disabled with an env var */
880 if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) {
881 /* fork enabled for any value different from "no" */
882 do_fork = strcmp (fork_env, "no") != 0;
886 /* now check registry with or without forking */
888 GST_DEBUG ("forking for registry rebuild");
889 ret = ensure_current_registry_forking (default_registry, registry_file,
892 GST_DEBUG ("requested not to fork for registry rebuild");
893 ret = ensure_current_registry_nonforking (default_registry, registry_file,
897 g_free (registry_file);
901 #endif /* GST_DISABLE_REGISTRY */
905 * - initalization of threads if we use them
908 * - initializes gst_format
909 * - registers a bunch of types for gst_objects
911 * - we don't have cases yet where this fails, but in the future
912 * we might and then it's nice to be able to return that
915 init_post (GOptionContext * context, GOptionGroup * group, gpointer data,
920 #ifndef GST_DISABLE_TRACE
922 #endif /* GST_DISABLE_TRACE */
924 if (gst_initialized) {
925 GST_DEBUG ("already initialized");
929 llf = G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_ERROR | G_LOG_FLAG_FATAL;
930 g_log_set_handler (g_log_domain_gstreamer, llf, debug_log_handler, NULL);
932 _priv_gst_quarks_initialize ();
933 _gst_format_initialize ();
934 _gst_query_initialize ();
935 gst_object_get_type ();
937 gst_element_factory_get_type ();
938 gst_element_get_type ();
939 gst_type_find_factory_get_type ();
942 #ifndef GST_DISABLE_INDEX
943 gst_index_factory_get_type ();
944 #endif /* GST_DISABLE_INDEX */
945 #ifndef GST_DISABLE_URI
946 gst_uri_handler_get_type ();
947 #endif /* GST_DISABLE_URI */
949 gst_structure_get_type ();
950 _gst_value_initialize ();
951 gst_caps_get_type ();
952 _gst_event_initialize ();
953 _gst_buffer_initialize ();
954 _gst_message_initialize ();
955 _gst_tag_initialize ();
957 /* register core plugins */
958 _gst_plugin_register_static (&plugin_desc);
960 _gst_plugin_initialize ();
963 * Any errors happening below this point are non-fatal, we therefore mark
964 * gstreamer as being initialized, since it is the case from a plugin point of
967 * If anything fails, it will be put back to FALSE in gst_init_check().
968 * This allows some special plugins that would call gst_init() to not cause a
969 * looping effect (i.e. initializing GStreamer twice).
971 gst_initialized = TRUE;
973 #ifndef GST_DISABLE_REGISTRY
974 if (!ensure_current_registry (error))
976 #endif /* GST_DISABLE_REGISTRY */
978 /* if we need to preload plugins, do so now */
979 g_slist_foreach (preload_plugins, load_plugin_func, NULL);
980 /* keep preload_plugins around in case a re-scan is forced later on */
982 #ifndef GST_DISABLE_TRACE
985 gst_trace = gst_trace_new ("gst.trace", 1024);
986 gst_trace_set_default (gst_trace);
988 #endif /* GST_DISABLE_TRACE */
993 #ifndef GST_DISABLE_GST_DEBUG
995 select_all (GstPlugin * plugin, gpointer user_data)
1001 sort_by_category_name (gconstpointer a, gconstpointer b)
1003 return strcmp (gst_debug_category_get_name ((GstDebugCategory *) a),
1004 gst_debug_category_get_name ((GstDebugCategory *) b));
1008 gst_debug_help (void)
1010 GSList *list, *walk;
1013 /* Need to ensure the registry is loaded to get debug categories */
1014 if (!init_post (NULL, NULL, NULL, NULL))
1017 list2 = gst_registry_plugin_filter (gst_registry_get_default (),
1018 select_all, FALSE, NULL);
1020 /* FIXME this is gross. why don't debug have categories PluginFeatures? */
1021 for (g = list2; g; g = g_list_next (g)) {
1022 GstPlugin *plugin = GST_PLUGIN_CAST (g->data);
1024 gst_plugin_load (plugin);
1026 g_list_free (list2);
1028 list = gst_debug_get_all_categories ();
1029 walk = list = g_slist_sort (list, sort_by_category_name);
1032 g_print ("name level description\n");
1033 g_print ("---------------------+--------+--------------------------------\n");
1036 GstDebugCategory *cat = (GstDebugCategory *) walk->data;
1038 if (gst_debug_is_colored ()) {
1039 gchar *color = gst_debug_construct_term_color (cat->color);
1041 g_print ("%s%-20s\033[00m %1d %s %s%s\033[00m\n",
1043 gst_debug_category_get_name (cat),
1044 gst_debug_category_get_threshold (cat),
1045 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
1046 color, gst_debug_category_get_description (cat));
1049 g_print ("%-20s %1d %s %s\n", gst_debug_category_get_name (cat),
1050 gst_debug_category_get_threshold (cat),
1051 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
1052 gst_debug_category_get_description (cat));
1054 walk = g_slist_next (walk);
1056 g_slist_free (list);
1062 parse_one_option (gint opt, const gchar * arg, GError ** err)
1066 g_print ("GStreamer Core Library version %s\n", PACKAGE_VERSION);
1068 case ARG_FATAL_WARNINGS:{
1069 GLogLevelFlags fatal_mask;
1071 fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
1072 fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL;
1073 g_log_set_always_fatal (fatal_mask);
1076 #ifndef GST_DISABLE_GST_DEBUG
1077 case ARG_DEBUG_LEVEL:{
1080 tmp = strtol (arg, NULL, 0);
1081 if (tmp >= 0 && tmp < GST_LEVEL_COUNT) {
1082 gst_debug_set_default_threshold (tmp);
1087 parse_debug_list (arg);
1089 case ARG_DEBUG_NO_COLOR:
1090 gst_debug_set_colored (FALSE);
1092 case ARG_DEBUG_DISABLE:
1093 gst_debug_set_active (FALSE);
1095 case ARG_DEBUG_HELP:
1099 case ARG_PLUGIN_SPEW:
1101 case ARG_PLUGIN_PATH:
1102 #ifndef GST_DISABLE_REGISTRY
1103 split_and_iterate (arg, G_SEARCHPATH_SEPARATOR_S, add_path_func, NULL);
1104 #endif /* GST_DISABLE_REGISTRY */
1106 case ARG_PLUGIN_LOAD:
1107 split_and_iterate (arg, ",", prepare_for_load_plugin_func, NULL);
1109 case ARG_SEGTRAP_DISABLE:
1110 _gst_disable_segtrap = TRUE;
1112 case ARG_REGISTRY_FORK_DISABLE:
1113 _gst_enable_registry_fork = FALSE;
1116 g_set_error (err, G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
1117 _("Unknown option"));
1125 parse_goption_arg (const gchar * opt,
1126 const gchar * arg, gpointer data, GError ** err)
1134 "--gst-version", ARG_VERSION}, {
1135 "--gst-fatal-warnings", ARG_FATAL_WARNINGS},
1136 #ifndef GST_DISABLE_GST_DEBUG
1138 "--gst-debug-level", ARG_DEBUG_LEVEL}, {
1139 "--gst-debug", ARG_DEBUG}, {
1140 "--gst-debug-disable", ARG_DEBUG_DISABLE}, {
1141 "--gst-debug-no-color", ARG_DEBUG_NO_COLOR}, {
1142 "--gst-debug-help", ARG_DEBUG_HELP},
1145 "--gst-plugin-spew", ARG_PLUGIN_SPEW}, {
1146 "--gst-plugin-path", ARG_PLUGIN_PATH}, {
1147 "--gst-plugin-load", ARG_PLUGIN_LOAD}, {
1148 "--gst-disable-segtrap", ARG_SEGTRAP_DISABLE}, {
1149 "--gst-disable-registry-fork", ARG_REGISTRY_FORK_DISABLE}, {
1154 for (n = 0; options[n].opt; n++) {
1155 if (!strcmp (opt, options[n].opt)) {
1156 val = options[n].val;
1161 return parse_one_option (val, arg, err);
1164 extern GstRegistry *_gst_registry_default;
1169 * Clean up any resources created by GStreamer in gst_init().
1171 * It is normally not needed to call this function in a normal application
1172 * as the resources will automatically be freed when the program terminates.
1173 * This function is therefore mostly used by testsuites and other memory
1176 * After this call GStreamer (including this method) should not be used anymore.
1183 GST_INFO ("deinitializing GStreamer");
1185 if (!gst_initialized) {
1186 GST_DEBUG ("already deinitialized");
1190 g_slist_foreach (preload_plugins, (GFunc) g_free, NULL);
1191 g_slist_free (preload_plugins);
1192 preload_plugins = NULL;
1194 g_list_foreach (plugin_paths, (GFunc) g_free, NULL);
1195 g_list_free (plugin_paths);
1196 plugin_paths = NULL;
1198 clock = gst_system_clock_obtain ();
1199 gst_object_unref (clock);
1200 gst_object_unref (clock);
1202 _priv_gst_registry_cleanup ();
1204 gst_initialized = FALSE;
1205 GST_INFO ("deinitialized GStreamer");
1210 * @major: pointer to a guint to store the major version number
1211 * @minor: pointer to a guint to store the minor version number
1212 * @micro: pointer to a guint to store the micro version number
1213 * @nano: pointer to a guint to store the nano version number
1215 * Gets the version number of the GStreamer library.
1218 gst_version (guint * major, guint * minor, guint * micro, guint * nano)
1220 g_return_if_fail (major);
1221 g_return_if_fail (minor);
1222 g_return_if_fail (micro);
1223 g_return_if_fail (nano);
1225 *major = GST_VERSION_MAJOR;
1226 *minor = GST_VERSION_MINOR;
1227 *micro = GST_VERSION_MICRO;
1228 *nano = GST_VERSION_NANO;
1232 * gst_version_string:
1234 * This function returns a string that is useful for describing this version
1235 * of GStreamer to the outside world: user agent strings, logging, ...
1237 * Returns: a newly allocated string describing this version of GStreamer.
1241 gst_version_string ()
1243 guint major, minor, micro, nano;
1245 gst_version (&major, &minor, µ, &nano);
1247 return g_strdup_printf ("GStreamer %d.%d.%d", major, minor, micro);
1249 return g_strdup_printf ("GStreamer %d.%d.%d (CVS)", major, minor, micro);
1251 return g_strdup_printf ("GStreamer %d.%d.%d (prerelease)", major, minor,
1256 * gst_segtrap_is_enabled:
1258 * Some functions in the GStreamer core might install a custom SIGSEGV handler
1259 * to better catch and report errors to the application. Currently this feature
1260 * is enabled by default when loading plugins.
1262 * Applications might want to disable this behaviour with the
1263 * gst_segtrap_set_enabled() function. This is typically done if the application
1264 * wants to install its own handler without GStreamer interfering.
1266 * Returns: %TRUE if GStreamer is allowed to install a custom SIGSEGV handler.
1271 gst_segtrap_is_enabled (void)
1273 /* yeps, it's enabled when it's not disabled */
1274 return !_gst_disable_segtrap;
1278 * gst_segtrap_set_enabled:
1279 * @enabled: whether a custom SIGSEGV handler should be installed.
1281 * Applications might want to disable/enable the SIGSEGV handling of
1282 * the GStreamer core. See gst_segtrap_is_enabled() for more information.
1287 gst_segtrap_set_enabled (gboolean enabled)
1289 _gst_disable_segtrap = !enabled;
1293 * gst_registry_fork_is_enabled:
1295 * By default GStreamer will perform a fork() when scanning and rebuilding the
1298 * Applications might want to disable this behaviour with the
1299 * gst_registry_fork_set_enabled() function.
1301 * Returns: %TRUE if GStreamer will use fork() when rebuilding the registry. On
1302 * platforms without fork(), this function will always return %FALSE.
1307 gst_registry_fork_is_enabled (void)
1309 return _gst_enable_registry_fork;
1313 * gst_registry_fork_set_enabled:
1314 * @enabled: whether rebuilding the registry may fork
1316 * Applications might want to disable/enable the usage of fork() when rebuilding
1317 * the registry. See gst_registry_fork_is_enabled() for more information.
1319 * On platforms without fork(), this function will have no effect on the return
1320 * value of gst_registry_fork_is_enabled().
1325 gst_registry_fork_set_enabled (gboolean enabled)
1328 _gst_enable_registry_fork = enabled;
1329 #endif /* HAVE_FORK */
1334 * gst_update_registry:
1336 * Forces GStreamer to re-scan its plugin paths and update the default
1339 * Applications will almost never need to call this function, it is only
1340 * useful if the application knows new plugins have been installed (or old
1341 * ones removed) since the start of the application (or, to be precise, the
1342 * first call to gst_init()) and the application wants to make use of any
1343 * newly-installed plugins without restarting the application.
1345 * Applications should assume that the registry update is neither atomic nor
1346 * thread-safe and should therefore not have any dynamic pipelines running
1347 * (including the playbin and decodebin elements) and should also not create
1348 * any elements or access the GStreamer registry while the update is in
1351 * Note that this function may block for a significant amount of time.
1353 * Returns: %TRUE if the registry has been updated successfully (does not
1354 * imply that there were changes), otherwise %FALSE.
1359 gst_update_registry (void)
1361 gboolean res = FALSE;
1363 #ifndef GST_DISABLE_REGISTRY
1366 res = ensure_current_registry (&err);
1368 GST_WARNING ("registry update failed: %s", err->message);
1371 GST_LOG ("registry update succeeded");
1374 if (preload_plugins) {
1375 g_slist_foreach (preload_plugins, load_plugin_func, NULL);
1378 GST_WARNING ("registry update failed: %s", "registry disabled");
1379 #endif /* GST_DISABLE_REGISTRY */