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
28 * GStreamer is a framework for constructing graphs of various filters
29 * (termed elements here) that will handle streaming media. Any discreet
30 * (packetizable) media type is supported, with provisions for automatically
31 * determining source type. Formatting/framing information is provided with
32 * a powerful negotiation framework. Plugins are heavily used to provide for
33 * all elements, allowing one to construct plugins outside of the GST
34 * library, even released binary-only if license require (please don't).
35 * GStreamer covers a wide range of use cases including: playback, recording,
36 * editing, serving streams, voice over ip and video calls.
38 * The <application>GStreamer</application> library should be initialized with
39 * gst_init() before it can be used. You should pass pointers to the main argc
40 * and argv variables so that GStreamer can process its own command line
41 * options, as shown in the following example.
44 * <title>Initializing the gstreamer library</title>
45 * <programlisting language="c">
47 * main (int argc, char *argv[])
49 * // initialize the GStreamer library
50 * gst_init (&argc, &argv);
56 * It's allowed to pass two NULL pointers to gst_init() in case you don't want
57 * to pass the command line args to GStreamer.
59 * You can also use GOption to initialize your own parameters as shown in
60 * the next code fragment:
62 * <title>Initializing own parameters when initializing gstreamer</title>
64 * static gboolean stats = FALSE;
67 * main (int argc, char *argv[])
69 * GOptionEntry options[] = {
70 * {"tags", 't', 0, G_OPTION_ARG_NONE, &tags,
71 * N_("Output tags (also known as metadata)"), NULL},
74 * // must initialise the threading system before using any other GLib funtion
75 * if (!g_thread_supported ())
76 * g_thread_init (NULL);
77 * ctx = g_option_context_new ("[ADDITIONAL ARGUMENTS]");
78 * g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
79 * g_option_context_add_group (ctx, gst_init_get_option_group ());
80 * if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
81 * g_print ("Error initializing: %s\n", GST_STR_NULL (err->message));
84 * g_option_context_free (ctx);
90 * Use gst_version() to query the library version at runtime or use the
91 * GST_VERSION_* macros to find the version at compile time. Optionally
92 * gst_version_string() returns a printable string.
94 * The gst_deinit() call is used to clean up all internal resources used
95 * by <application>GStreamer</application>. It is mostly used in unit tests
98 * Last reviewed on 2006-08-11 (0.10.10)
101 #include "gst_private.h"
102 #include "gstconfig.h"
105 #include <sys/types.h>
106 #ifdef HAVE_SYS_UTSNAME_H
107 #include <sys/utsname.h>
113 #define WIN32_LEAN_AND_MEAN /* prevents from including too many things */
114 #include <windows.h> /* GetStdHandle, windows console */
117 #include "gst-i18n-lib.h"
118 #include <locale.h> /* for LC_ALL */
122 #define GST_CAT_DEFAULT GST_CAT_GST_INIT
124 #define MAX_PATH_SPLIT 16
125 #define GST_PLUGIN_SEPARATOR ","
127 static gboolean gst_initialized = FALSE;
128 static gboolean gst_deinitialized = FALSE;
131 HMODULE _priv_gst_dll_handle = NULL;
134 #ifndef GST_DISABLE_REGISTRY
135 GList *_priv_gst_plugin_paths = NULL; /* for delayed processing in post_init */
137 extern gboolean _priv_gst_disable_registry_update;
140 #ifndef GST_DISABLE_GST_DEBUG
141 extern const gchar *priv_gst_dump_dot_dir;
146 /* set to TRUE when segfaults need to be left as is */
147 static gboolean _gst_disable_segtrap = FALSE;
149 static gboolean init_pre (GOptionContext * context, GOptionGroup * group,
150 gpointer data, GError ** error);
151 static gboolean init_post (GOptionContext * context, GOptionGroup * group,
152 gpointer data, GError ** error);
153 #ifndef GST_DISABLE_OPTION_PARSING
154 static gboolean parse_goption_arg (const gchar * s_opt,
155 const gchar * arg, gpointer data, GError ** err);
158 GSList *_priv_gst_preload_plugins = NULL;
160 const gchar g_log_domain_gstreamer[] = "GStreamer";
163 debug_log_handler (const gchar * log_domain,
164 GLogLevelFlags log_level, const gchar * message, gpointer user_data)
166 g_log_default_handler (log_domain, log_level, message, user_data);
167 /* FIXME: do we still need this ? fatal errors these days are all
168 * other than core errors */
169 /* g_on_error_query (NULL); */
176 #ifndef GST_DISABLE_GST_DEBUG
187 ARG_REGISTRY_UPDATE_DISABLE,
188 ARG_REGISTRY_FORK_DISABLE
191 /* debug-spec ::= category-spec [, category-spec]*
192 * category-spec ::= category:val | val
201 #ifndef GST_DISABLE_GST_DEBUG
203 parse_debug_category (gchar * str, const gchar ** category)
220 parse_debug_level (gchar * str, gint * level)
228 if (str[0] != NUL && str[1] == NUL
229 && str[0] >= '0' && str[0] < '0' + GST_LEVEL_COUNT) {
230 *level = str[0] - '0';
238 parse_debug_list (const gchar * list)
245 split = g_strsplit (list, ",", 0);
247 for (walk = split; *walk; walk++) {
248 if (strchr (*walk, ':')) {
249 gchar **values = g_strsplit (*walk, ":", 2);
251 if (values[0] && values[1]) {
253 const gchar *category;
255 if (parse_debug_category (values[0], &category)
256 && parse_debug_level (values[1], &level))
257 gst_debug_set_threshold_for_name (category, level);
264 if (parse_debug_level (*walk, &level))
265 gst_debug_set_default_threshold (level);
274 BOOL WINAPI DllMain (HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved);
276 DllMain (HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
278 if (fdwReason == DLL_PROCESS_ATTACH)
279 _priv_gst_dll_handle = (HMODULE) hinstDLL;
286 * gst_init_get_option_group:
288 * Returns a #GOptionGroup with GStreamer's argument specifications. The
289 * group is set up to use standard GOption callbacks, so when using this
290 * group in combination with GOption parsing methods, all argument parsing
291 * and initialization is automated.
293 * This function is useful if you want to integrate GStreamer with other
294 * libraries that use GOption (see g_option_context_add_group() ).
296 * If you use this function, you should make sure you initialise the GLib
297 * threading system as one of the very first things in your program
298 * (see the example at the beginning of this section).
300 * Returns: (transfer full): a pointer to GStreamer's option group.
304 gst_init_get_option_group (void)
306 #ifndef GST_DISABLE_OPTION_PARSING
308 static const GOptionEntry gst_args[] = {
309 {"gst-version", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
310 (gpointer) parse_goption_arg, N_("Print the GStreamer version"), NULL},
311 {"gst-fatal-warnings", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
312 (gpointer) parse_goption_arg, N_("Make all warnings fatal"), NULL},
313 #ifndef GST_DISABLE_GST_DEBUG
314 {"gst-debug-help", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
315 (gpointer) parse_goption_arg,
316 N_("Print available debug categories and exit"),
318 {"gst-debug-level", 0, 0, G_OPTION_ARG_CALLBACK,
319 (gpointer) parse_goption_arg,
320 N_("Default debug level from 1 (only error) to 5 (anything) or "
323 {"gst-debug", 0, 0, G_OPTION_ARG_CALLBACK, (gpointer) parse_goption_arg,
324 N_("Comma-separated list of category_name:level pairs to set "
325 "specific levels for the individual categories. Example: "
326 "GST_AUTOPLUG:5,GST_ELEMENT_*:3"),
328 {"gst-debug-no-color", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
329 (gpointer) parse_goption_arg, N_("Disable colored debugging output"),
331 {"gst-debug-disable", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
332 (gpointer) parse_goption_arg, N_("Disable debugging"), NULL},
334 {"gst-plugin-spew", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
335 (gpointer) parse_goption_arg,
336 N_("Enable verbose plugin loading diagnostics"),
338 {"gst-plugin-path", 0, 0, G_OPTION_ARG_CALLBACK,
339 (gpointer) parse_goption_arg,
340 N_("Colon-separated paths containing plugins"), N_("PATHS")},
341 {"gst-plugin-load", 0, 0, G_OPTION_ARG_CALLBACK,
342 (gpointer) parse_goption_arg,
343 N_("Comma-separated list of plugins to preload in addition to the "
344 "list stored in environment variable GST_PLUGIN_PATH"),
346 {"gst-disable-segtrap", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
347 (gpointer) parse_goption_arg,
348 N_("Disable trapping of segmentation faults during plugin loading"),
350 {"gst-disable-registry-update", 0, G_OPTION_FLAG_NO_ARG,
351 G_OPTION_ARG_CALLBACK,
352 (gpointer) parse_goption_arg,
353 N_("Disable updating the registry"),
355 {"gst-disable-registry-fork", 0, G_OPTION_FLAG_NO_ARG,
356 G_OPTION_ARG_CALLBACK,
357 (gpointer) parse_goption_arg,
358 N_("Disable spawning a helper process while scanning the registry"),
363 /* Since GLib 2.23.2 calling g_thread_init() 'late' is allowed and is
364 * automatically done as part of g_type_init() */
365 if (glib_check_version (2, 23, 3)) {
366 /* The GLib threading system must be initialised before calling any other
367 * GLib function according to the documentation; if the application hasn't
368 * called gst_init() yet or initialised the threading system otherwise, we
369 * better issue a warning here (since chances are high that the application
370 * has already called other GLib functions such as g_option_context_new() */
371 if (!g_thread_get_initialized ()) {
372 g_warning ("The GStreamer function gst_init_get_option_group() was\n"
373 "\tcalled, but the GLib threading system has not been initialised\n"
374 "\tyet, something that must happen before any other GLib function\n"
375 "\tis called. The application needs to be fixed so that it calls\n"
376 "\t if (!g_thread_get_initialized ()) g_thread_init(NULL);\n"
377 "\tas very first thing in its main() function. Please file a bug\n"
378 "\tagainst this application.");
379 g_thread_init (NULL);
385 group = g_option_group_new ("gst", _("GStreamer Options"),
386 _("Show GStreamer Options"), NULL, NULL);
387 g_option_group_set_parse_hooks (group, (GOptionParseFunc) init_pre,
388 (GOptionParseFunc) init_post);
390 g_option_group_add_entries (group, gst_args);
391 g_option_group_set_translation_domain (group, GETTEXT_PACKAGE);
401 * @argc: (inout) (allow-none): pointer to application's argc
402 * @argv: (inout) (array length=argc) (allow-none): pointer to application's argv
403 * @err: pointer to a #GError to which a message will be posted on error
405 * Initializes the GStreamer library, setting up internal path lists,
406 * registering built-in elements, and loading standard plugins.
408 * This function will return %FALSE if GStreamer could not be initialized
409 * for some reason. If you want your program to fail fatally,
410 * use gst_init() instead.
412 * This function should be called before calling any other GLib functions. If
413 * this is not an option, your program must initialise the GLib thread system
414 * using g_thread_init() before any other GLib functions are called.
416 * Returns: %TRUE if GStreamer could be initialized.
419 gst_init_check (int *argc, char **argv[], GError ** err)
421 #ifndef GST_DISABLE_OPTION_PARSING
427 if (!g_thread_get_initialized ())
428 g_thread_init (NULL);
430 if (gst_initialized) {
431 GST_DEBUG ("already initialized gst");
434 #ifndef GST_DISABLE_OPTION_PARSING
435 ctx = g_option_context_new ("- GStreamer initialization");
436 g_option_context_set_ignore_unknown_options (ctx, TRUE);
437 group = gst_init_get_option_group ();
438 g_option_context_add_group (ctx, group);
439 res = g_option_context_parse (ctx, argc, argv, err);
440 g_option_context_free (ctx);
442 init_pre (NULL, NULL, NULL, NULL);
443 init_post (NULL, NULL, NULL, NULL);
447 gst_initialized = res;
450 GST_INFO ("initialized GStreamer successfully");
452 GST_INFO ("failed to initialize GStreamer");
460 * @argc: (inout) (allow-none): pointer to application's argc
461 * @argv: (inout) (array length=argc) (allow-none): pointer to application's argv
463 * Initializes the GStreamer library, setting up internal path lists,
464 * registering built-in elements, and loading standard plugins.
466 * Unless the plugin registry is disabled at compile time, the registry will be
467 * loaded. By default this will also check if the registry cache needs to be
468 * updated and rescan all plugins if needed. See gst_update_registry() for
469 * details and section
470 * <link linkend="gst-running">Running GStreamer Applications</link>
471 * for how to disable automatic registry updates.
473 * This function should be called before calling any other GLib functions. If
474 * this is not an option, your program must initialise the GLib thread system
475 * using g_thread_init() before any other GLib functions are called.
478 * This function will terminate your program if it was unable to initialize
479 * GStreamer for some reason. If you want your program to fall back,
480 * use gst_init_check() instead.
483 * WARNING: This function does not work in the same way as corresponding
484 * functions in other glib-style libraries, such as gtk_init(). In
485 * particular, unknown command line options cause this function to
486 * abort program execution.
489 gst_init (int *argc, char **argv[])
493 if (!gst_init_check (argc, argv, &err)) {
494 g_print ("Could not initialize GStreamer: %s\n",
495 err ? err->message : "unknown error occurred");
504 * gst_is_initialized:
506 * Use this function to check if GStreamer has been initialized with gst_init()
507 * or gst_init_check().
509 * Returns: TRUE if initialization has been done, FALSE otherwise.
514 gst_is_initialized (void)
516 return gst_initialized;
519 #ifndef GST_DISABLE_REGISTRY
521 add_path_func (gpointer data, gpointer user_data)
523 GST_INFO ("Adding plugin path: \"%s\", will scan later", (gchar *) data);
524 _priv_gst_plugin_paths =
525 g_list_append (_priv_gst_plugin_paths, g_strdup (data));
529 #ifndef GST_DISABLE_OPTION_PARSING
531 prepare_for_load_plugin_func (gpointer data, gpointer user_data)
533 _priv_gst_preload_plugins =
534 g_slist_prepend (_priv_gst_preload_plugins, g_strdup (data));
538 #ifndef GST_DISABLE_OPTION_PARSING
540 split_and_iterate (const gchar * stringlist, const gchar * separator,
541 GFunc iterator, gpointer user_data)
545 gchar *lastlist = g_strdup (stringlist);
548 strings = g_strsplit (lastlist, separator, MAX_PATH_SPLIT);
553 iterator (strings[j], user_data);
554 if (++j == MAX_PATH_SPLIT) {
555 lastlist = g_strdup (strings[j]);
560 g_strfreev (strings);
565 /* we have no fail cases yet, but maybe in the future */
567 init_pre (GOptionContext * context, GOptionGroup * group, gpointer data,
570 if (gst_initialized) {
571 GST_DEBUG ("already initialized");
577 /* we need threading to be enabled right here */
578 g_assert (g_thread_get_initialized ());
583 setlocale (LC_ALL, "");
584 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
585 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
586 #endif /* ENABLE_NLS */
588 #ifndef GST_DISABLE_GST_DEBUG
590 const gchar *debug_list;
592 if (g_getenv ("GST_DEBUG_NO_COLOR") != NULL)
593 gst_debug_set_colored (FALSE);
595 debug_list = g_getenv ("GST_DEBUG");
597 parse_debug_list (debug_list);
601 priv_gst_dump_dot_dir = g_getenv ("GST_DEBUG_DUMP_DOT_DIR");
603 /* This is the earliest we can make stuff show up in the logs.
604 * So give some useful info about GStreamer here */
605 GST_INFO ("Initializing GStreamer Core Library version %s", VERSION);
606 GST_INFO ("Using library installed in %s", LIBDIR);
608 /* Print some basic system details if possible (OS/architecture) */
609 #ifdef HAVE_SYS_UTSNAME_H
611 struct utsname sys_details;
613 if (uname (&sys_details) == 0) {
614 GST_INFO ("%s %s %s %s %s", sys_details.sysname,
615 sys_details.nodename, sys_details.release, sys_details.version,
616 sys_details.machine);
625 gst_register_core_elements (GstPlugin * plugin)
627 /* register some standard builtin types */
628 if (!gst_element_register (plugin, "bin", GST_RANK_PRIMARY,
630 !gst_element_register (plugin, "pipeline", GST_RANK_PRIMARY,
633 g_assert_not_reached ();
640 * - initalization of threads if we use them
643 * - initializes gst_format
644 * - registers a bunch of types for gst_objects
646 * - we don't have cases yet where this fails, but in the future
647 * we might and then it's nice to be able to return that
650 init_post (GOptionContext * context, GOptionGroup * group, gpointer data,
655 #ifndef GST_DISABLE_TRACE
657 #endif /* GST_DISABLE_TRACE */
659 if (gst_initialized) {
660 GST_DEBUG ("already initialized");
664 llf = G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_ERROR | G_LOG_FLAG_FATAL;
665 g_log_set_handler (g_log_domain_gstreamer, llf, debug_log_handler, NULL);
667 _priv_gst_quarks_initialize ();
668 _gst_format_initialize ();
669 _gst_query_initialize ();
670 g_type_class_ref (gst_object_get_type ());
671 g_type_class_ref (gst_pad_get_type ());
672 g_type_class_ref (gst_element_factory_get_type ());
673 g_type_class_ref (gst_element_get_type ());
674 g_type_class_ref (gst_type_find_factory_get_type ());
675 g_type_class_ref (gst_bin_get_type ());
676 g_type_class_ref (gst_bus_get_type ());
677 g_type_class_ref (gst_task_get_type ());
678 g_type_class_ref (gst_clock_get_type ());
680 g_type_class_ref (gst_index_factory_get_type ());
681 gst_uri_handler_get_type ();
683 g_type_class_ref (gst_object_flags_get_type ());
684 g_type_class_ref (gst_bin_flags_get_type ());
685 g_type_class_ref (gst_buffer_flag_get_type ());
686 g_type_class_ref (gst_buffer_copy_flags_get_type ());
687 g_type_class_ref (gst_buffer_list_item_get_type ());
688 g_type_class_ref (gst_bus_flags_get_type ());
689 g_type_class_ref (gst_bus_sync_reply_get_type ());
690 g_type_class_ref (gst_caps_flags_get_type ());
691 g_type_class_ref (gst_clock_return_get_type ());
692 g_type_class_ref (gst_clock_entry_type_get_type ());
693 g_type_class_ref (gst_clock_flags_get_type ());
694 g_type_class_ref (gst_clock_type_get_type ());
695 g_type_class_ref (gst_debug_graph_details_get_type ());
696 g_type_class_ref (gst_state_get_type ());
697 g_type_class_ref (gst_state_change_return_get_type ());
698 g_type_class_ref (gst_state_change_get_type ());
699 g_type_class_ref (gst_element_flags_get_type ());
700 g_type_class_ref (gst_core_error_get_type ());
701 g_type_class_ref (gst_library_error_get_type ());
702 g_type_class_ref (gst_resource_error_get_type ());
703 g_type_class_ref (gst_stream_error_get_type ());
704 g_type_class_ref (gst_event_type_flags_get_type ());
705 g_type_class_ref (gst_event_type_get_type ());
706 g_type_class_ref (gst_seek_type_get_type ());
707 g_type_class_ref (gst_seek_flags_get_type ());
708 g_type_class_ref (gst_qos_type_get_type ());
709 g_type_class_ref (gst_format_get_type ());
710 g_type_class_ref (gst_index_certainty_get_type ());
711 g_type_class_ref (gst_index_entry_type_get_type ());
712 g_type_class_ref (gst_index_lookup_method_get_type ());
713 g_type_class_ref (gst_assoc_flags_get_type ());
714 g_type_class_ref (gst_index_resolver_method_get_type ());
715 g_type_class_ref (gst_index_flags_get_type ());
716 g_type_class_ref (gst_debug_level_get_type ());
717 g_type_class_ref (gst_debug_color_flags_get_type ());
718 g_type_class_ref (gst_iterator_result_get_type ());
719 g_type_class_ref (gst_iterator_item_get_type ());
720 g_type_class_ref (gst_message_type_get_type ());
721 g_type_class_ref (gst_mini_object_flags_get_type ());
722 g_type_class_ref (gst_pad_link_return_get_type ());
723 g_type_class_ref (gst_pad_link_check_get_type ());
724 g_type_class_ref (gst_flow_return_get_type ());
725 g_type_class_ref (gst_activate_mode_get_type ());
726 g_type_class_ref (gst_pad_direction_get_type ());
727 g_type_class_ref (gst_pad_flags_get_type ());
728 g_type_class_ref (gst_pad_presence_get_type ());
729 g_type_class_ref (gst_pad_template_flags_get_type ());
730 g_type_class_ref (gst_pipeline_flags_get_type ());
731 g_type_class_ref (gst_plugin_error_get_type ());
732 g_type_class_ref (gst_plugin_flags_get_type ());
733 g_type_class_ref (gst_plugin_dependency_flags_get_type ());
734 g_type_class_ref (gst_rank_get_type ());
735 g_type_class_ref (gst_query_type_get_type ());
736 g_type_class_ref (gst_buffering_mode_get_type ());
737 g_type_class_ref (gst_stream_status_type_get_type ());
738 g_type_class_ref (gst_structure_change_type_get_type ());
739 g_type_class_ref (gst_tag_merge_mode_get_type ());
740 g_type_class_ref (gst_tag_flag_get_type ());
741 g_type_class_ref (gst_task_pool_get_type ());
742 g_type_class_ref (gst_task_state_get_type ());
743 g_type_class_ref (gst_alloc_trace_flags_get_type ());
744 g_type_class_ref (gst_type_find_probability_get_type ());
745 g_type_class_ref (gst_uri_type_get_type ());
746 g_type_class_ref (gst_parse_error_get_type ());
747 g_type_class_ref (gst_parse_flags_get_type ());
748 g_type_class_ref (gst_search_mode_get_type ());
749 g_type_class_ref (gst_progress_type_get_type ());
751 gst_structure_get_type ();
752 _gst_value_initialize ();
753 g_type_class_ref (gst_param_spec_fraction_get_type ());
754 gst_caps_get_type ();
755 _gst_event_initialize ();
756 _gst_buffer_initialize ();
757 _gst_buffer_list_initialize ();
758 _gst_message_initialize ();
759 _gst_tag_initialize ();
761 _gst_plugin_initialize ();
763 gst_g_error_get_type ();
765 /* register core plugins */
766 gst_plugin_register_static (GST_VERSION_MAJOR, GST_VERSION_MINOR,
767 "staticelements", "core elements linked into the GStreamer library",
768 gst_register_core_elements, VERSION, GST_LICENSE, PACKAGE,
769 GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);
772 * Any errors happening below this point are non-fatal, we therefore mark
773 * gstreamer as being initialized, since it is the case from a plugin point of
776 * If anything fails, it will be put back to FALSE in gst_init_check().
777 * This allows some special plugins that would call gst_init() to not cause a
778 * looping effect (i.e. initializing GStreamer twice).
780 gst_initialized = TRUE;
782 if (!gst_update_registry ())
785 #ifndef GST_DISABLE_TRACE
788 gst_trace = gst_trace_new ("gst.trace", 1024);
789 gst_trace_set_default (gst_trace);
791 #endif /* GST_DISABLE_TRACE */
793 GST_INFO ("GLib runtime version: %d.%d.%d", glib_major_version,
794 glib_minor_version, glib_micro_version);
795 GST_INFO ("GLib headers version: %d.%d.%d", GLIB_MAJOR_VERSION,
796 GLIB_MINOR_VERSION, GLIB_MICRO_VERSION);
801 #ifndef GST_DISABLE_GST_DEBUG
803 select_all (GstPlugin * plugin, gpointer user_data)
809 sort_by_category_name (gconstpointer a, gconstpointer b)
811 return strcmp (gst_debug_category_get_name ((GstDebugCategory *) a),
812 gst_debug_category_get_name ((GstDebugCategory *) b));
816 gst_debug_help (void)
821 /* Need to ensure the registry is loaded to get debug categories */
822 if (!init_post (NULL, NULL, NULL, NULL))
825 list2 = gst_registry_plugin_filter (gst_registry_get_default (),
826 select_all, FALSE, NULL);
828 /* FIXME this is gross. why don't debug have categories PluginFeatures? */
829 for (g = list2; g; g = g_list_next (g)) {
830 GstPlugin *plugin = GST_PLUGIN_CAST (g->data);
832 gst_plugin_load (plugin);
836 list = gst_debug_get_all_categories ();
837 walk = list = g_slist_sort (list, sort_by_category_name);
840 g_print ("name level description\n");
841 g_print ("---------------------+--------+--------------------------------\n");
844 GstDebugCategory *cat = (GstDebugCategory *) walk->data;
846 if (gst_debug_is_colored ()) {
848 gint color = gst_debug_construct_win_color (cat->color);
849 const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
851 SetConsoleTextAttribute (GetStdHandle (STD_OUTPUT_HANDLE), color);
852 g_print ("%-20s", gst_debug_category_get_name (cat));
853 SetConsoleTextAttribute (GetStdHandle (STD_OUTPUT_HANDLE), clear);
854 g_print (" %1d %s ", gst_debug_category_get_threshold (cat),
855 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)));
856 SetConsoleTextAttribute (GetStdHandle (STD_OUTPUT_HANDLE), color);
857 g_print ("%s", gst_debug_category_get_description (cat));
858 SetConsoleTextAttribute (GetStdHandle (STD_OUTPUT_HANDLE), clear);
860 #else /* G_OS_WIN32 */
861 gchar *color = gst_debug_construct_term_color (cat->color);
863 g_print ("%s%-20s\033[00m %1d %s %s%s\033[00m\n",
865 gst_debug_category_get_name (cat),
866 gst_debug_category_get_threshold (cat),
867 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
868 color, gst_debug_category_get_description (cat));
870 #endif /* G_OS_WIN32 */
872 g_print ("%-20s %1d %s %s\n", gst_debug_category_get_name (cat),
873 gst_debug_category_get_threshold (cat),
874 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
875 gst_debug_category_get_description (cat));
877 walk = g_slist_next (walk);
884 #ifndef GST_DISABLE_OPTION_PARSING
886 parse_one_option (gint opt, const gchar * arg, GError ** err)
890 g_print ("GStreamer Core Library version %s\n", PACKAGE_VERSION);
892 case ARG_FATAL_WARNINGS:{
893 GLogLevelFlags fatal_mask;
895 fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
896 fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL;
897 g_log_set_always_fatal (fatal_mask);
900 #ifndef GST_DISABLE_GST_DEBUG
901 case ARG_DEBUG_LEVEL:{
904 tmp = strtol (arg, NULL, 0);
905 if (tmp >= 0 && tmp < GST_LEVEL_COUNT) {
906 gst_debug_set_default_threshold (tmp);
911 parse_debug_list (arg);
913 case ARG_DEBUG_NO_COLOR:
914 gst_debug_set_colored (FALSE);
916 case ARG_DEBUG_DISABLE:
917 gst_debug_set_active (FALSE);
923 case ARG_PLUGIN_SPEW:
925 case ARG_PLUGIN_PATH:
926 #ifndef GST_DISABLE_REGISTRY
927 split_and_iterate (arg, G_SEARCHPATH_SEPARATOR_S, add_path_func, NULL);
928 #endif /* GST_DISABLE_REGISTRY */
930 case ARG_PLUGIN_LOAD:
931 split_and_iterate (arg, ",", prepare_for_load_plugin_func, NULL);
933 case ARG_SEGTRAP_DISABLE:
934 _gst_disable_segtrap = TRUE;
936 case ARG_REGISTRY_UPDATE_DISABLE:
937 #ifndef GST_DISABLE_REGISTRY
938 _priv_gst_disable_registry_update = TRUE;
941 case ARG_REGISTRY_FORK_DISABLE:
942 gst_registry_fork_set_enabled (FALSE);
945 g_set_error (err, G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
946 _("Unknown option"));
954 parse_goption_arg (const gchar * opt,
955 const gchar * arg, gpointer data, GError ** err)
963 "--gst-version", ARG_VERSION}, {
964 "--gst-fatal-warnings", ARG_FATAL_WARNINGS},
965 #ifndef GST_DISABLE_GST_DEBUG
967 "--gst-debug-level", ARG_DEBUG_LEVEL}, {
968 "--gst-debug", ARG_DEBUG}, {
969 "--gst-debug-disable", ARG_DEBUG_DISABLE}, {
970 "--gst-debug-no-color", ARG_DEBUG_NO_COLOR}, {
971 "--gst-debug-help", ARG_DEBUG_HELP},
974 "--gst-plugin-spew", ARG_PLUGIN_SPEW}, {
975 "--gst-plugin-path", ARG_PLUGIN_PATH}, {
976 "--gst-plugin-load", ARG_PLUGIN_LOAD}, {
977 "--gst-disable-segtrap", ARG_SEGTRAP_DISABLE}, {
978 "--gst-disable-registry-update", ARG_REGISTRY_UPDATE_DISABLE}, {
979 "--gst-disable-registry-fork", ARG_REGISTRY_FORK_DISABLE}, {
984 for (n = 0; options[n].opt; n++) {
985 if (!strcmp (opt, options[n].opt)) {
986 val = options[n].val;
991 return parse_one_option (val, arg, err);
998 * Clean up any resources created by GStreamer in gst_init().
1000 * It is normally not needed to call this function in a normal application
1001 * as the resources will automatically be freed when the program terminates.
1002 * This function is therefore mostly used by testsuites and other memory
1005 * After this call GStreamer (including this method) should not be used anymore.
1012 GST_INFO ("deinitializing GStreamer");
1014 if (gst_deinitialized) {
1015 GST_DEBUG ("already deinitialized");
1019 g_slist_foreach (_priv_gst_preload_plugins, (GFunc) g_free, NULL);
1020 g_slist_free (_priv_gst_preload_plugins);
1021 _priv_gst_preload_plugins = NULL;
1023 #ifndef GST_DISABLE_REGISTRY
1024 g_list_foreach (_priv_gst_plugin_paths, (GFunc) g_free, NULL);
1025 g_list_free (_priv_gst_plugin_paths);
1026 _priv_gst_plugin_paths = NULL;
1029 clock = gst_system_clock_obtain ();
1030 gst_object_unref (clock);
1031 gst_object_unref (clock);
1033 _priv_gst_registry_cleanup ();
1035 g_type_class_unref (g_type_class_peek (gst_object_get_type ()));
1036 g_type_class_unref (g_type_class_peek (gst_pad_get_type ()));
1037 g_type_class_unref (g_type_class_peek (gst_element_factory_get_type ()));
1038 g_type_class_unref (g_type_class_peek (gst_element_get_type ()));
1039 g_type_class_unref (g_type_class_peek (gst_type_find_factory_get_type ()));
1040 g_type_class_unref (g_type_class_peek (gst_bin_get_type ()));
1041 g_type_class_unref (g_type_class_peek (gst_bus_get_type ()));
1042 g_type_class_unref (g_type_class_peek (gst_task_get_type ()));
1043 g_type_class_unref (g_type_class_peek (gst_index_factory_get_type ()));
1044 g_type_class_unref (g_type_class_peek (gst_object_flags_get_type ()));
1045 g_type_class_unref (g_type_class_peek (gst_bin_flags_get_type ()));
1046 g_type_class_unref (g_type_class_peek (gst_buffer_flag_get_type ()));
1047 g_type_class_unref (g_type_class_peek (gst_buffer_copy_flags_get_type ()));
1048 g_type_class_unref (g_type_class_peek (gst_buffer_list_item_get_type ()));
1049 g_type_class_unref (g_type_class_peek (gst_bus_flags_get_type ()));
1050 g_type_class_unref (g_type_class_peek (gst_bus_sync_reply_get_type ()));
1051 g_type_class_unref (g_type_class_peek (gst_caps_flags_get_type ()));
1052 g_type_class_unref (g_type_class_peek (gst_clock_type_get_type ()));
1053 g_type_class_unref (g_type_class_peek (gst_clock_return_get_type ()));
1054 g_type_class_unref (g_type_class_peek (gst_clock_entry_type_get_type ()));
1055 g_type_class_unref (g_type_class_peek (gst_clock_flags_get_type ()));
1056 g_type_class_unref (g_type_class_peek (gst_debug_graph_details_get_type ()));
1057 g_type_class_unref (g_type_class_peek (gst_state_get_type ()));
1058 g_type_class_unref (g_type_class_peek (gst_state_change_return_get_type ()));
1059 g_type_class_unref (g_type_class_peek (gst_state_change_get_type ()));
1060 g_type_class_unref (g_type_class_peek (gst_element_flags_get_type ()));
1061 g_type_class_unref (g_type_class_peek (gst_core_error_get_type ()));
1062 g_type_class_unref (g_type_class_peek (gst_library_error_get_type ()));
1063 g_type_class_unref (g_type_class_peek (gst_plugin_dependency_flags_get_type
1065 g_type_class_unref (g_type_class_peek (gst_parse_flags_get_type ()));
1066 g_type_class_unref (g_type_class_peek (gst_resource_error_get_type ()));
1067 g_type_class_unref (g_type_class_peek (gst_search_mode_get_type ()));
1068 g_type_class_unref (g_type_class_peek (gst_stream_error_get_type ()));
1069 g_type_class_unref (g_type_class_peek (gst_stream_status_type_get_type ()));
1070 g_type_class_unref (g_type_class_peek (gst_structure_change_type_get_type
1072 g_type_class_unref (g_type_class_peek (gst_event_type_flags_get_type ()));
1073 g_type_class_unref (g_type_class_peek (gst_event_type_get_type ()));
1074 g_type_class_unref (g_type_class_peek (gst_seek_type_get_type ()));
1075 g_type_class_unref (g_type_class_peek (gst_seek_flags_get_type ()));
1076 g_type_class_unref (g_type_class_peek (gst_qos_type_get_type ()));
1077 g_type_class_unref (g_type_class_peek (gst_format_get_type ()));
1078 g_type_class_unref (g_type_class_peek (gst_index_certainty_get_type ()));
1079 g_type_class_unref (g_type_class_peek (gst_index_entry_type_get_type ()));
1080 g_type_class_unref (g_type_class_peek (gst_index_lookup_method_get_type ()));
1081 g_type_class_unref (g_type_class_peek (gst_assoc_flags_get_type ()));
1082 g_type_class_unref (g_type_class_peek (gst_index_resolver_method_get_type
1084 g_type_class_unref (g_type_class_peek (gst_index_flags_get_type ()));
1085 g_type_class_unref (g_type_class_peek (gst_debug_level_get_type ()));
1086 g_type_class_unref (g_type_class_peek (gst_debug_color_flags_get_type ()));
1087 g_type_class_unref (g_type_class_peek (gst_iterator_result_get_type ()));
1088 g_type_class_unref (g_type_class_peek (gst_iterator_item_get_type ()));
1089 g_type_class_unref (g_type_class_peek (gst_message_type_get_type ()));
1090 g_type_class_unref (g_type_class_peek (gst_mini_object_flags_get_type ()));
1091 g_type_class_unref (g_type_class_peek (gst_pad_link_return_get_type ()));
1092 g_type_class_unref (g_type_class_peek (gst_pad_link_check_get_type ()));
1093 g_type_class_unref (g_type_class_peek (gst_flow_return_get_type ()));
1094 g_type_class_unref (g_type_class_peek (gst_activate_mode_get_type ()));
1095 g_type_class_unref (g_type_class_peek (gst_pad_direction_get_type ()));
1096 g_type_class_unref (g_type_class_peek (gst_pad_flags_get_type ()));
1097 g_type_class_unref (g_type_class_peek (gst_pad_presence_get_type ()));
1098 g_type_class_unref (g_type_class_peek (gst_pad_template_flags_get_type ()));
1099 g_type_class_unref (g_type_class_peek (gst_pipeline_flags_get_type ()));
1100 g_type_class_unref (g_type_class_peek (gst_plugin_error_get_type ()));
1101 g_type_class_unref (g_type_class_peek (gst_plugin_flags_get_type ()));
1102 g_type_class_unref (g_type_class_peek (gst_rank_get_type ()));
1103 g_type_class_unref (g_type_class_peek (gst_query_type_get_type ()));
1104 g_type_class_unref (g_type_class_peek (gst_buffering_mode_get_type ()));
1105 g_type_class_unref (g_type_class_peek (gst_tag_merge_mode_get_type ()));
1106 g_type_class_unref (g_type_class_peek (gst_tag_flag_get_type ()));
1107 g_type_class_unref (g_type_class_peek (gst_task_state_get_type ()));
1108 g_type_class_unref (g_type_class_peek (gst_alloc_trace_flags_get_type ()));
1109 g_type_class_unref (g_type_class_peek (gst_type_find_probability_get_type
1111 g_type_class_unref (g_type_class_peek (gst_uri_type_get_type ()));
1112 g_type_class_unref (g_type_class_peek (gst_parse_error_get_type ()));
1113 g_type_class_unref (g_type_class_peek (gst_param_spec_fraction_get_type ()));
1115 gst_deinitialized = TRUE;
1116 GST_INFO ("deinitialized GStreamer");
1121 * @major: (out): pointer to a guint to store the major version number
1122 * @minor: (out): pointer to a guint to store the minor version number
1123 * @micro: (out): pointer to a guint to store the micro version number
1124 * @nano: (out): pointer to a guint to store the nano version number
1126 * Gets the version number of the GStreamer library.
1129 gst_version (guint * major, guint * minor, guint * micro, guint * nano)
1131 g_return_if_fail (major);
1132 g_return_if_fail (minor);
1133 g_return_if_fail (micro);
1134 g_return_if_fail (nano);
1136 *major = GST_VERSION_MAJOR;
1137 *minor = GST_VERSION_MINOR;
1138 *micro = GST_VERSION_MICRO;
1139 *nano = GST_VERSION_NANO;
1143 * gst_version_string:
1145 * This function returns a string that is useful for describing this version
1146 * of GStreamer to the outside world: user agent strings, logging, ...
1148 * Returns: (transfer full): a newly allocated string describing this version
1153 gst_version_string (void)
1155 guint major, minor, micro, nano;
1157 gst_version (&major, &minor, µ, &nano);
1159 return g_strdup_printf ("GStreamer %d.%d.%d", major, minor, micro);
1161 return g_strdup_printf ("GStreamer %d.%d.%d (GIT)", major, minor, micro);
1163 return g_strdup_printf ("GStreamer %d.%d.%d (prerelease)", major, minor,
1168 * gst_segtrap_is_enabled:
1170 * Some functions in the GStreamer core might install a custom SIGSEGV handler
1171 * to better catch and report errors to the application. Currently this feature
1172 * is enabled by default when loading plugins.
1174 * Applications might want to disable this behaviour with the
1175 * gst_segtrap_set_enabled() function. This is typically done if the application
1176 * wants to install its own handler without GStreamer interfering.
1178 * Returns: %TRUE if GStreamer is allowed to install a custom SIGSEGV handler.
1183 gst_segtrap_is_enabled (void)
1185 /* yeps, it's enabled when it's not disabled */
1186 return !_gst_disable_segtrap;
1190 * gst_segtrap_set_enabled:
1191 * @enabled: whether a custom SIGSEGV handler should be installed.
1193 * Applications might want to disable/enable the SIGSEGV handling of
1194 * the GStreamer core. See gst_segtrap_is_enabled() for more information.
1199 gst_segtrap_set_enabled (gboolean enabled)
1201 _gst_disable_segtrap = !enabled;