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\n", 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 gst_registry_xml_read_cache (default_registry, registry_file);
648 /* scan paths specified via --gst-plugin-path */
649 GST_DEBUG ("scanning paths added via --gst-plugin-path");
650 for (l = plugin_paths; l != NULL; l = l->next) {
651 GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data);
652 /* CHECKME: add changed |= here as well? */
653 gst_registry_scan_path (default_registry, (gchar *) l->data);
655 /* keep plugin_paths around in case a re-scan is forced later on */
657 /* GST_PLUGIN_PATH specifies a list of directories to scan for
658 * additional plugins. These take precedence over the system plugins */
659 plugin_path = g_getenv ("GST_PLUGIN_PATH");
664 GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path);
665 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
666 for (i = 0; list[i]; i++) {
667 changed |= gst_registry_scan_path (default_registry, list[i]);
671 GST_DEBUG ("GST_PLUGIN_PATH not set");
674 /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always
675 * loaded by default. If not set, this defaults to the system-installed
676 * path, and the plugins installed in the user's home directory */
677 plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH");
678 if (plugin_path == NULL) {
681 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set");
683 /* plugins in the user's home directory take precedence over
684 * system-installed ones */
685 home_plugins = g_build_filename (g_get_home_dir (),
686 ".gstreamer-" GST_MAJORMINOR, "plugins", NULL);
687 changed |= gst_registry_scan_path (default_registry, home_plugins);
688 g_free (home_plugins);
690 /* add the main (installed) library path */
691 changed |= gst_registry_scan_path (default_registry, PLUGINDIR);
696 GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path);
697 list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
698 for (i = 0; list[i]; i++) {
699 changed |= gst_registry_scan_path (default_registry, list[i]);
704 /* Remove cached plugins so stale info is cleared. */
705 changed |= _priv_gst_registry_remove_cache_plugins (default_registry);
708 GST_INFO ("Registry cache has not changed");
712 if (!write_changes) {
713 GST_INFO ("Registry cached changed, but writing is disabled. Not writing.");
717 GST_INFO ("Registry cache changed. Writing new registry cache");
718 if (!gst_registry_xml_write_cache (default_registry, registry_file)) {
719 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
720 _("Error writing registry cache to %s: %s"),
721 registry_file, g_strerror (errno));
725 GST_INFO ("Registry cache written successfully");
730 ensure_current_registry_nonforking (GstRegistry * default_registry,
731 const gchar * registry_file, GError ** error)
733 /* fork() not available */
734 GST_DEBUG ("Updating registry cache in-process");
735 scan_and_update_registry (default_registry, registry_file, TRUE, error);
739 /* when forking is not available this function always does nothing but return
742 ensure_current_registry_forking (GstRegistry * default_registry,
743 const gchar * registry_file, GError ** error)
750 /* We fork here, and let the child read and possibly rebuild the registry.
751 * After that, the parent will re-read the freshly generated registry. */
752 GST_DEBUG ("forking to update registry");
754 if (pipe (pfd) == -1) {
755 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
756 _("Error re-scanning registry %s: %s"),
757 ", could not create pipes. Error", g_strerror (errno));
763 GST_ERROR ("Failed to fork()");
764 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
765 _("Error re-scanning registry %s: %s"),
766 ", failed to fork. Error", g_strerror (errno));
774 /* this is the child. Close the read pipe */
775 (void) close (pfd[0]);
777 GST_DEBUG ("child reading registry cache");
779 scan_and_update_registry (default_registry, registry_file, TRUE, NULL);
781 /* need to use _exit, so that any exit handlers registered don't
782 * bring down the main program */
783 GST_DEBUG ("child exiting: %s", (res) ? "SUCCESS" : "FAILURE");
785 /* make valgrind happy (yes, you can call it insane) */
786 g_free ((char *) registry_file);
788 /* write a result byte to the pipe */
789 res_byte = res ? '1' : '0';
791 ret = write (pfd[1], &res_byte, 1);
792 } while (ret == -1 && errno == EINTR);
793 /* if ret == -1 now, we could not write to pipe, probably
794 * means parent has exited before us */
795 (void) close (pfd[1]);
801 /* parent. Close write pipe */
802 (void) close (pfd[1]);
804 /* Wait for result from the pipe */
805 GST_DEBUG ("Waiting for data from child");
807 ret = read (pfd[0], &res_byte, 1);
808 } while (ret == -1 && errno == EINTR);
811 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
812 _("Error re-scanning registry %s: %s"),
813 ", read returned error", g_strerror (errno));
817 (void) close (pfd[0]);
819 /* Wait to ensure the child is reaped, but ignore the result */
820 GST_DEBUG ("parent waiting on child");
821 waitpid (pid, NULL, 0);
822 GST_DEBUG ("parent done waiting on child");
825 GST_ERROR ("child did not exit normally, terminated by signal");
826 g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
827 _("Error re-scanning registry %s"), ", child terminated by signal");
831 if (res_byte == '1') {
832 GST_DEBUG ("Child succeeded. Parent reading registry cache");
833 gst_registry_xml_read_cache (default_registry, registry_file);
835 GST_DEBUG ("Child failed. Parent re-scanning registry, ignoring errors.");
836 scan_and_update_registry (default_registry, registry_file, FALSE, NULL);
839 #endif /* HAVE_FORK */
844 ensure_current_registry (GError ** error)
847 GstRegistry *default_registry;
851 default_registry = gst_registry_get_default ();
852 registry_file = g_strdup (g_getenv ("GST_REGISTRY"));
853 if (registry_file == NULL) {
854 registry_file = g_build_filename (g_get_home_dir (),
855 ".gstreamer-" GST_MAJORMINOR, "registry." HOST_CPU ".xml", NULL);
858 /* first see if forking is enabled */
859 do_fork = _gst_enable_registry_fork;
861 const gchar *fork_env;
863 /* forking enabled, see if it is disabled with an env var */
864 if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) {
865 /* fork enabled for any value different from "no" */
866 do_fork = strcmp (fork_env, "no") != 0;
870 /* now check registry with or without forking */
872 GST_DEBUG ("forking for registry rebuild");
873 ret = ensure_current_registry_forking (default_registry, registry_file,
876 GST_DEBUG ("requested not to fork for registry rebuild");
877 ret = ensure_current_registry_nonforking (default_registry, registry_file,
881 g_free (registry_file);
885 #endif /* GST_DISABLE_REGISTRY */
889 * - initalization of threads if we use them
892 * - initializes gst_format
893 * - registers a bunch of types for gst_objects
895 * - we don't have cases yet where this fails, but in the future
896 * we might and then it's nice to be able to return that
899 init_post (GOptionContext * context, GOptionGroup * group, gpointer data,
904 #ifndef GST_DISABLE_TRACE
906 #endif /* GST_DISABLE_TRACE */
908 if (gst_initialized) {
909 GST_DEBUG ("already initialized");
913 llf = G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_ERROR | G_LOG_FLAG_FATAL;
914 g_log_set_handler (g_log_domain_gstreamer, llf, debug_log_handler, NULL);
916 _priv_gst_quarks_initialize ();
917 _gst_format_initialize ();
918 _gst_query_initialize ();
919 gst_object_get_type ();
921 gst_element_factory_get_type ();
922 gst_element_get_type ();
923 gst_type_find_factory_get_type ();
926 #ifndef GST_DISABLE_INDEX
927 gst_index_factory_get_type ();
928 #endif /* GST_DISABLE_INDEX */
929 #ifndef GST_DISABLE_URI
930 gst_uri_handler_get_type ();
931 #endif /* GST_DISABLE_URI */
933 gst_structure_get_type ();
934 _gst_value_initialize ();
935 gst_caps_get_type ();
936 _gst_event_initialize ();
937 _gst_buffer_initialize ();
938 _gst_message_initialize ();
939 _gst_tag_initialize ();
941 /* register core plugins */
942 _gst_plugin_register_static (&plugin_desc);
944 _gst_plugin_initialize ();
947 * Any errors happening below this point are non-fatal, we therefore mark
948 * gstreamer as being initialized, since it is the case from a plugin point of
951 * If anything fails, it will be put back to FALSE in gst_init_check().
952 * This allows some special plugins that would call gst_init() to not cause a
953 * looping effect (i.e. initializing GStreamer twice).
955 gst_initialized = TRUE;
957 #ifndef GST_DISABLE_REGISTRY
958 if (!ensure_current_registry (error))
960 #endif /* GST_DISABLE_REGISTRY */
962 /* if we need to preload plugins, do so now */
963 g_slist_foreach (preload_plugins, load_plugin_func, NULL);
964 /* keep preload_plugins around in case a re-scan is forced later on */
966 #ifndef GST_DISABLE_TRACE
969 gst_trace = gst_trace_new ("gst.trace", 1024);
970 gst_trace_set_default (gst_trace);
972 #endif /* GST_DISABLE_TRACE */
977 #ifndef GST_DISABLE_GST_DEBUG
979 select_all (GstPlugin * plugin, gpointer user_data)
985 sort_by_category_name (gconstpointer a, gconstpointer b)
987 return strcmp (gst_debug_category_get_name ((GstDebugCategory *) a),
988 gst_debug_category_get_name ((GstDebugCategory *) b));
991 gst_debug_help (void)
996 /* Need to ensure the registry is loaded to get debug categories */
997 if (!init_post (NULL, NULL, NULL, NULL))
1000 list2 = gst_registry_plugin_filter (gst_registry_get_default (),
1001 select_all, FALSE, NULL);
1003 /* FIXME this is gross. why don't debug have categories PluginFeatures? */
1004 for (g = list2; g; g = g_list_next (g)) {
1005 GstPlugin *plugin = GST_PLUGIN_CAST (g->data);
1007 gst_plugin_load (plugin);
1009 g_list_free (list2);
1011 list = gst_debug_get_all_categories ();
1012 walk = list = g_slist_sort (list, sort_by_category_name);
1015 g_print ("name level description\n");
1016 g_print ("---------------------+--------+--------------------------------\n");
1019 GstDebugCategory *cat = (GstDebugCategory *) walk->data;
1021 if (gst_debug_is_colored ()) {
1022 gchar *color = gst_debug_construct_term_color (cat->color);
1024 g_print ("%s%-20s\033[00m %1d %s %s%s\033[00m\n",
1026 gst_debug_category_get_name (cat),
1027 gst_debug_category_get_threshold (cat),
1028 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
1029 color, gst_debug_category_get_description (cat));
1032 g_print ("%-20s %1d %s %s\n", gst_debug_category_get_name (cat),
1033 gst_debug_category_get_threshold (cat),
1034 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
1035 gst_debug_category_get_description (cat));
1037 walk = g_slist_next (walk);
1039 g_slist_free (list);
1045 parse_one_option (gint opt, const gchar * arg, GError ** err)
1049 g_print ("GStreamer Core Library version %s\n", PACKAGE_VERSION);
1051 case ARG_FATAL_WARNINGS:{
1052 GLogLevelFlags fatal_mask;
1054 fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
1055 fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL;
1056 g_log_set_always_fatal (fatal_mask);
1059 #ifndef GST_DISABLE_GST_DEBUG
1060 case ARG_DEBUG_LEVEL:{
1063 tmp = strtol (arg, NULL, 0);
1064 if (tmp >= 0 && tmp < GST_LEVEL_COUNT) {
1065 gst_debug_set_default_threshold (tmp);
1070 parse_debug_list (arg);
1072 case ARG_DEBUG_NO_COLOR:
1073 gst_debug_set_colored (FALSE);
1075 case ARG_DEBUG_DISABLE:
1076 gst_debug_set_active (FALSE);
1078 case ARG_DEBUG_HELP:
1082 case ARG_PLUGIN_SPEW:
1084 case ARG_PLUGIN_PATH:
1085 #ifndef GST_DISABLE_REGISTRY
1086 split_and_iterate (arg, G_SEARCHPATH_SEPARATOR_S, add_path_func, NULL);
1087 #endif /* GST_DISABLE_REGISTRY */
1089 case ARG_PLUGIN_LOAD:
1090 split_and_iterate (arg, ",", prepare_for_load_plugin_func, NULL);
1092 case ARG_SEGTRAP_DISABLE:
1093 _gst_disable_segtrap = TRUE;
1095 case ARG_REGISTRY_FORK_DISABLE:
1096 _gst_enable_registry_fork = FALSE;
1099 g_set_error (err, G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
1100 _("Unknown option"));
1108 parse_goption_arg (const gchar * opt,
1109 const gchar * arg, gpointer data, GError ** err)
1117 "--gst-version", ARG_VERSION}, {
1118 "--gst-fatal-warnings", ARG_FATAL_WARNINGS},
1119 #ifndef GST_DISABLE_GST_DEBUG
1121 "--gst-debug-level", ARG_DEBUG_LEVEL}, {
1122 "--gst-debug", ARG_DEBUG}, {
1123 "--gst-debug-disable", ARG_DEBUG_DISABLE}, {
1124 "--gst-debug-no-color", ARG_DEBUG_NO_COLOR}, {
1125 "--gst-debug-help", ARG_DEBUG_HELP},
1128 "--gst-plugin-spew", ARG_PLUGIN_SPEW}, {
1129 "--gst-plugin-path", ARG_PLUGIN_PATH}, {
1130 "--gst-plugin-load", ARG_PLUGIN_LOAD}, {
1131 "--gst-disable-segtrap", ARG_SEGTRAP_DISABLE}, {
1132 "--gst-disable-registry-fork", ARG_REGISTRY_FORK_DISABLE}, {
1137 for (n = 0; options[n].opt; n++) {
1138 if (!strcmp (opt, options[n].opt)) {
1139 val = options[n].val;
1144 return parse_one_option (val, arg, err);
1147 extern GstRegistry *_gst_registry_default;
1152 * Clean up any resources created by GStreamer in gst_init().
1154 * It is normally not needed to call this function in a normal application
1155 * as the resources will automatically be freed when the program terminates.
1156 * This function is therefore mostly used by testsuites and other memory
1159 * After this call GStreamer (including this method) should not be used anymore.
1166 GST_INFO ("deinitializing GStreamer");
1168 if (!gst_initialized) {
1169 GST_DEBUG ("already deinitialized");
1173 g_slist_foreach (preload_plugins, (GFunc) g_free, NULL);
1174 g_slist_free (preload_plugins);
1175 preload_plugins = NULL;
1177 g_list_foreach (plugin_paths, (GFunc) g_free, NULL);
1178 g_list_free (plugin_paths);
1179 plugin_paths = NULL;
1181 clock = gst_system_clock_obtain ();
1182 gst_object_unref (clock);
1183 gst_object_unref (clock);
1185 _priv_gst_registry_cleanup ();
1187 gst_initialized = FALSE;
1188 GST_INFO ("deinitialized GStreamer");
1193 * @major: pointer to a guint to store the major version number
1194 * @minor: pointer to a guint to store the minor version number
1195 * @micro: pointer to a guint to store the micro version number
1196 * @nano: pointer to a guint to store the nano version number
1198 * Gets the version number of the GStreamer library.
1201 gst_version (guint * major, guint * minor, guint * micro, guint * nano)
1203 g_return_if_fail (major);
1204 g_return_if_fail (minor);
1205 g_return_if_fail (micro);
1206 g_return_if_fail (nano);
1208 *major = GST_VERSION_MAJOR;
1209 *minor = GST_VERSION_MINOR;
1210 *micro = GST_VERSION_MICRO;
1211 *nano = GST_VERSION_NANO;
1215 * gst_version_string:
1217 * This function returns a string that is useful for describing this version
1218 * of GStreamer to the outside world: user agent strings, logging, ...
1220 * Returns: a newly allocated string describing this version of GStreamer.
1224 gst_version_string ()
1226 guint major, minor, micro, nano;
1228 gst_version (&major, &minor, µ, &nano);
1230 return g_strdup_printf ("GStreamer %d.%d.%d", major, minor, micro);
1232 return g_strdup_printf ("GStreamer %d.%d.%d (CVS)", major, minor, micro);
1234 return g_strdup_printf ("GStreamer %d.%d.%d (prerelease)", major, minor,
1239 * gst_segtrap_is_enabled:
1241 * Some functions in the GStreamer core might install a custom SIGSEGV handler
1242 * to better catch and report errors to the application. Currently this feature
1243 * is enabled by default when loading plugins.
1245 * Applications might want to disable this behaviour with the
1246 * gst_segtrap_set_enabled() function. This is typically done if the application
1247 * wants to install its own handler without GStreamer interfering.
1249 * Returns: %TRUE if GStreamer is allowed to install a custom SIGSEGV handler.
1254 gst_segtrap_is_enabled (void)
1256 /* yeps, it's enabled when it's not disabled */
1257 return !_gst_disable_segtrap;
1261 * gst_segtrap_set_enabled:
1262 * @enabled: whether a custom SIGSEGV handler should be installed.
1264 * Applications might want to disable/enable the SIGSEGV handling of
1265 * the GStreamer core. See gst_segtrap_is_enabled() for more information.
1270 gst_segtrap_set_enabled (gboolean enabled)
1272 _gst_disable_segtrap = !enabled;
1276 * gst_registry_fork_is_enabled:
1278 * By default GStreamer will perform a fork() when scanning and rebuilding the
1281 * Applications might want to disable this behaviour with the
1282 * gst_registry_fork_set_enabled() function.
1284 * Returns: %TRUE if GStreamer will use fork() when rebuilding the registry. On
1285 * platforms without fork(), this function will always return %FALSE.
1290 gst_registry_fork_is_enabled (void)
1292 return _gst_enable_registry_fork;
1296 * gst_registry_fork_set_enabled:
1297 * @enabled: whether rebuilding the registry may fork
1299 * Applications might want to disable/enable the usage of fork() when rebuilding
1300 * the registry. See gst_registry_fork_is_enabled() for more information.
1302 * On platforms without fork(), this function will have no effect on the return
1303 * value of gst_registry_fork_is_enabled().
1308 gst_registry_fork_set_enabled (gboolean enabled)
1311 _gst_enable_registry_fork = enabled;
1312 #endif /* HAVE_FORK */
1317 * gst_update_registry:
1319 * Forces GStreamer to re-scan its plugin paths and update the default
1322 * Applications will almost never need to call this function, it is only
1323 * useful if the application knows new plugins have been installed (or old
1324 * ones removed) since the start of the application (or, to be precise, the
1325 * first call to gst_init()) and the application wants to make use of any
1326 * newly-installed plugins without restarting the application.
1328 * Applications should assume that the registry update is neither atomic nor
1329 * thread-safe and should therefore not have any dynamic pipelines running
1330 * (including the playbin and decodebin elements) and should also not create
1331 * any elements or access the GStreamer registry while the update is in
1334 * Note that this function may block for a significant amount of time.
1336 * Returns: %TRUE if the registry has been updated successfully (does not
1337 * imply that there were changes), otherwise %FALSE.
1342 gst_update_registry (void)
1344 gboolean res = FALSE;
1346 #ifndef GST_DISABLE_REGISTRY
1349 res = ensure_current_registry (&err);
1351 GST_WARNING ("registry update failed: %s", err->message);
1354 GST_LOG ("registry update succeeded");
1357 if (preload_plugins) {
1358 g_slist_foreach (preload_plugins, load_plugin_func, NULL);
1361 GST_WARNING ("registry update failed: %s", "registry disabled");
1362 #endif /* GST_DISABLE_REGISTRY */