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., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, 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 */
121 #include "gsttrace.h"
123 #define GST_CAT_DEFAULT GST_CAT_GST_INIT
125 #define MAX_PATH_SPLIT 16
126 #define GST_PLUGIN_SEPARATOR ","
128 static gboolean gst_initialized = FALSE;
129 static gboolean gst_deinitialized = FALSE;
132 HMODULE _priv_gst_dll_handle = NULL;
135 #ifndef GST_DISABLE_REGISTRY
136 GList *_priv_gst_plugin_paths = NULL; /* for delayed processing in post_init */
138 extern gboolean _priv_gst_disable_registry_update;
141 #ifndef GST_DISABLE_GST_DEBUG
142 const gchar *priv_gst_dump_dot_dir;
147 /* set to TRUE when segfaults need to be left as is */
148 static gboolean _gst_disable_segtrap = FALSE;
150 static gboolean init_pre (GOptionContext * context, GOptionGroup * group,
151 gpointer data, GError ** error);
152 static gboolean init_post (GOptionContext * context, GOptionGroup * group,
153 gpointer data, GError ** error);
154 #ifndef GST_DISABLE_OPTION_PARSING
155 static gboolean parse_goption_arg (const gchar * s_opt,
156 const gchar * arg, gpointer data, GError ** err);
159 GSList *_priv_gst_preload_plugins = NULL;
161 const gchar g_log_domain_gstreamer[] = "GStreamer";
164 debug_log_handler (const gchar * log_domain,
165 GLogLevelFlags log_level, const gchar * message, gpointer user_data)
167 g_log_default_handler (log_domain, log_level, message, user_data);
168 /* FIXME: do we still need this ? fatal errors these days are all
169 * other than core errors */
170 /* g_on_error_query (NULL); */
177 #ifndef GST_DISABLE_GST_DEBUG
188 ARG_REGISTRY_UPDATE_DISABLE,
189 ARG_REGISTRY_FORK_DISABLE
192 /* debug-spec ::= category-spec [, category-spec]*
193 * category-spec ::= category:val | val
199 BOOL WINAPI DllMain (HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved);
201 DllMain (HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
203 if (fdwReason == DLL_PROCESS_ATTACH)
204 _priv_gst_dll_handle = (HMODULE) hinstDLL;
211 * gst_init_get_option_group: (skip)
213 * Returns a #GOptionGroup with GStreamer's argument specifications. The
214 * group is set up to use standard GOption callbacks, so when using this
215 * group in combination with GOption parsing methods, all argument parsing
216 * and initialization is automated.
218 * This function is useful if you want to integrate GStreamer with other
219 * libraries that use GOption (see g_option_context_add_group() ).
221 * If you use this function, you should make sure you initialise the GLib
222 * threading system as one of the very first things in your program
223 * (see the example at the beginning of this section).
225 * Returns: (transfer full): a pointer to GStreamer's option group.
229 gst_init_get_option_group (void)
231 #ifndef GST_DISABLE_OPTION_PARSING
233 static const GOptionEntry gst_args[] = {
234 {"gst-version", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
235 (gpointer) parse_goption_arg, N_("Print the GStreamer version"), NULL},
236 {"gst-fatal-warnings", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
237 (gpointer) parse_goption_arg, N_("Make all warnings fatal"), NULL},
238 #ifndef GST_DISABLE_GST_DEBUG
239 {"gst-debug-help", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
240 (gpointer) parse_goption_arg,
241 N_("Print available debug categories and exit"),
243 {"gst-debug-level", 0, 0, G_OPTION_ARG_CALLBACK,
244 (gpointer) parse_goption_arg,
245 N_("Default debug level from 1 (only error) to 5 (anything) or "
248 {"gst-debug", 0, 0, G_OPTION_ARG_CALLBACK, (gpointer) parse_goption_arg,
249 N_("Comma-separated list of category_name:level pairs to set "
250 "specific levels for the individual categories. Example: "
251 "GST_AUTOPLUG:5,GST_ELEMENT_*:3"),
253 {"gst-debug-no-color", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
254 (gpointer) parse_goption_arg, N_("Disable colored debugging output"),
256 {"gst-debug-disable", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
257 (gpointer) parse_goption_arg, N_("Disable debugging"), NULL},
259 {"gst-plugin-spew", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
260 (gpointer) parse_goption_arg,
261 N_("Enable verbose plugin loading diagnostics"),
263 {"gst-plugin-path", 0, 0, G_OPTION_ARG_CALLBACK,
264 (gpointer) parse_goption_arg,
265 N_("Colon-separated paths containing plugins"), N_("PATHS")},
266 {"gst-plugin-load", 0, 0, G_OPTION_ARG_CALLBACK,
267 (gpointer) parse_goption_arg,
268 N_("Comma-separated list of plugins to preload in addition to the "
269 "list stored in environment variable GST_PLUGIN_PATH"),
271 {"gst-disable-segtrap", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
272 (gpointer) parse_goption_arg,
273 N_("Disable trapping of segmentation faults during plugin loading"),
275 {"gst-disable-registry-update", 0, G_OPTION_FLAG_NO_ARG,
276 G_OPTION_ARG_CALLBACK,
277 (gpointer) parse_goption_arg,
278 N_("Disable updating the registry"),
280 {"gst-disable-registry-fork", 0, G_OPTION_FLAG_NO_ARG,
281 G_OPTION_ARG_CALLBACK,
282 (gpointer) parse_goption_arg,
283 N_("Disable spawning a helper process while scanning the registry"),
288 group = g_option_group_new ("gst", _("GStreamer Options"),
289 _("Show GStreamer Options"), NULL, NULL);
290 g_option_group_set_parse_hooks (group, (GOptionParseFunc) init_pre,
291 (GOptionParseFunc) init_post);
293 g_option_group_add_entries (group, gst_args);
294 g_option_group_set_translation_domain (group, GETTEXT_PACKAGE);
304 * @argc: (inout) (allow-none): pointer to application's argc
305 * @argv: (inout) (array length=argc) (allow-none): pointer to application's argv
306 * @err: pointer to a #GError to which a message will be posted on error
308 * Initializes the GStreamer library, setting up internal path lists,
309 * registering built-in elements, and loading standard plugins.
311 * This function will return %FALSE if GStreamer could not be initialized
312 * for some reason. If you want your program to fail fatally,
313 * use gst_init() instead.
315 * This function should be called before calling any other GLib functions. If
316 * this is not an option, your program must initialise the GLib thread system
317 * using g_thread_init() before any other GLib functions are called.
319 * Returns: %TRUE if GStreamer could be initialized.
322 gst_init_check (int *argc, char **argv[], GError ** err)
324 #ifndef GST_DISABLE_OPTION_PARSING
330 if (gst_initialized) {
331 GST_DEBUG ("already initialized gst");
334 #ifndef GST_DISABLE_OPTION_PARSING
335 ctx = g_option_context_new ("- GStreamer initialization");
336 g_option_context_set_ignore_unknown_options (ctx, TRUE);
337 group = gst_init_get_option_group ();
338 g_option_context_add_group (ctx, group);
339 res = g_option_context_parse (ctx, argc, argv, err);
340 g_option_context_free (ctx);
342 init_pre (NULL, NULL, NULL, NULL);
343 init_post (NULL, NULL, NULL, NULL);
347 gst_initialized = res;
350 GST_INFO ("initialized GStreamer successfully");
352 GST_INFO ("failed to initialize GStreamer");
360 * @argc: (inout) (allow-none): pointer to application's argc
361 * @argv: (inout) (array length=argc) (allow-none): pointer to application's argv
363 * Initializes the GStreamer library, setting up internal path lists,
364 * registering built-in elements, and loading standard plugins.
366 * Unless the plugin registry is disabled at compile time, the registry will be
367 * loaded. By default this will also check if the registry cache needs to be
368 * updated and rescan all plugins if needed. See gst_update_registry() for
369 * details and section
370 * <link linkend="gst-running">Running GStreamer Applications</link>
371 * for how to disable automatic registry updates.
373 * This function should be called before calling any other GLib functions. If
374 * this is not an option, your program must initialise the GLib thread system
375 * using g_thread_init() before any other GLib functions are called.
378 * This function will terminate your program if it was unable to initialize
379 * GStreamer for some reason. If you want your program to fall back,
380 * use gst_init_check() instead.
383 * WARNING: This function does not work in the same way as corresponding
384 * functions in other glib-style libraries, such as gtk_init(). In
385 * particular, unknown command line options cause this function to
386 * abort program execution.
389 gst_init (int *argc, char **argv[])
393 if (!gst_init_check (argc, argv, &err)) {
394 g_print ("Could not initialize GStreamer: %s\n",
395 err ? err->message : "unknown error occurred");
404 * gst_is_initialized:
406 * Use this function to check if GStreamer has been initialized with gst_init()
407 * or gst_init_check().
409 * Returns: TRUE if initialization has been done, FALSE otherwise.
412 gst_is_initialized (void)
414 return gst_initialized;
417 #ifndef GST_DISABLE_REGISTRY
419 add_path_func (gpointer data, gpointer user_data)
421 GST_INFO ("Adding plugin path: \"%s\", will scan later", (gchar *) data);
422 _priv_gst_plugin_paths =
423 g_list_append (_priv_gst_plugin_paths, g_strdup (data));
427 #ifndef GST_DISABLE_OPTION_PARSING
429 prepare_for_load_plugin_func (gpointer data, gpointer user_data)
431 _priv_gst_preload_plugins =
432 g_slist_prepend (_priv_gst_preload_plugins, g_strdup (data));
436 #ifndef GST_DISABLE_OPTION_PARSING
438 split_and_iterate (const gchar * stringlist, const gchar * separator,
439 GFunc iterator, gpointer user_data)
443 gchar *lastlist = g_strdup (stringlist);
446 strings = g_strsplit (lastlist, separator, MAX_PATH_SPLIT);
451 iterator (strings[j], user_data);
452 if (++j == MAX_PATH_SPLIT) {
453 lastlist = g_strdup (strings[j]);
458 g_strfreev (strings);
463 /* we have no fail cases yet, but maybe in the future */
465 init_pre (GOptionContext * context, GOptionGroup * group, gpointer data,
468 if (gst_initialized) {
469 GST_DEBUG ("already initialized");
472 #if !GLIB_CHECK_VERSION(2, 35, 0)
476 #ifndef GST_DISABLE_GST_DEBUG
477 _priv_gst_debug_init ();
481 setlocale (LC_ALL, "");
482 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
483 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
484 #endif /* ENABLE_NLS */
486 #ifndef GST_DISABLE_GST_DEBUG
488 const gchar *debug_list;
490 if (g_getenv ("GST_DEBUG_NO_COLOR") != NULL)
491 gst_debug_set_colored (FALSE);
493 debug_list = g_getenv ("GST_DEBUG");
495 gst_debug_set_threshold_from_string (debug_list, FALSE);
499 priv_gst_dump_dot_dir = g_getenv ("GST_DEBUG_DUMP_DOT_DIR");
501 /* This is the earliest we can make stuff show up in the logs.
502 * So give some useful info about GStreamer here */
503 GST_INFO ("Initializing GStreamer Core Library version %s", VERSION);
504 GST_INFO ("Using library installed in %s", LIBDIR);
506 /* Print some basic system details if possible (OS/architecture) */
507 #ifdef HAVE_SYS_UTSNAME_H
509 struct utsname sys_details;
511 if (uname (&sys_details) == 0) {
512 GST_INFO ("%s %s %s %s %s", sys_details.sysname,
513 sys_details.nodename, sys_details.release, sys_details.version,
514 sys_details.machine);
519 #ifndef G_ATOMIC_LOCK_FREE
520 GST_CAT_WARNING (GST_CAT_PERFORMANCE, "GLib atomic operations are NOT "
521 "implemented using real hardware atomic operations!");
528 gst_register_core_elements (GstPlugin * plugin)
530 /* register some standard builtin types */
531 if (!gst_element_register (plugin, "bin", GST_RANK_PRIMARY,
533 !gst_element_register (plugin, "pipeline", GST_RANK_PRIMARY,
536 g_assert_not_reached ();
543 * - initalization of threads if we use them
546 * - initializes gst_format
547 * - registers a bunch of types for gst_objects
549 * - we don't have cases yet where this fails, but in the future
550 * we might and then it's nice to be able to return that
553 init_post (GOptionContext * context, GOptionGroup * group, gpointer data,
558 if (gst_initialized) {
559 GST_DEBUG ("already initialized");
563 llf = G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_ERROR | G_LOG_FLAG_FATAL;
564 g_log_set_handler (g_log_domain_gstreamer, llf, debug_log_handler, NULL);
566 #ifndef GST_DISABLE_TRACE
567 _priv_gst_alloc_trace_initialize ();
570 _priv_gst_mini_object_initialize ();
571 _priv_gst_quarks_initialize ();
572 _priv_gst_memory_initialize ();
573 _priv_gst_format_initialize ();
574 _priv_gst_query_initialize ();
575 _priv_gst_structure_initialize ();
576 _priv_gst_caps_initialize ();
577 _priv_gst_meta_initialize ();
579 g_type_class_ref (gst_object_get_type ());
580 g_type_class_ref (gst_pad_get_type ());
581 g_type_class_ref (gst_element_factory_get_type ());
582 g_type_class_ref (gst_element_get_type ());
583 g_type_class_ref (gst_type_find_factory_get_type ());
584 g_type_class_ref (gst_bin_get_type ());
585 g_type_class_ref (gst_bus_get_type ());
586 g_type_class_ref (gst_task_get_type ());
587 g_type_class_ref (gst_clock_get_type ());
589 gst_uri_handler_get_type ();
591 g_type_class_ref (gst_object_flags_get_type ());
592 g_type_class_ref (gst_bin_flags_get_type ());
593 g_type_class_ref (gst_buffer_flags_get_type ());
594 g_type_class_ref (gst_buffer_copy_flags_get_type ());
595 g_type_class_ref (gst_bus_flags_get_type ());
596 g_type_class_ref (gst_bus_sync_reply_get_type ());
597 g_type_class_ref (gst_caps_flags_get_type ());
598 g_type_class_ref (gst_clock_return_get_type ());
599 g_type_class_ref (gst_clock_entry_type_get_type ());
600 g_type_class_ref (gst_clock_flags_get_type ());
601 g_type_class_ref (gst_clock_type_get_type ());
602 g_type_class_ref (gst_debug_graph_details_get_type ());
603 g_type_class_ref (gst_state_get_type ());
604 g_type_class_ref (gst_state_change_return_get_type ());
605 g_type_class_ref (gst_state_change_get_type ());
606 g_type_class_ref (gst_element_flags_get_type ());
607 g_type_class_ref (gst_core_error_get_type ());
608 g_type_class_ref (gst_library_error_get_type ());
609 g_type_class_ref (gst_resource_error_get_type ());
610 g_type_class_ref (gst_stream_error_get_type ());
611 g_type_class_ref (gst_event_type_flags_get_type ());
612 g_type_class_ref (gst_event_type_get_type ());
613 g_type_class_ref (gst_seek_type_get_type ());
614 g_type_class_ref (gst_seek_flags_get_type ());
615 g_type_class_ref (gst_qos_type_get_type ());
616 g_type_class_ref (gst_format_get_type ());
617 g_type_class_ref (gst_debug_level_get_type ());
618 g_type_class_ref (gst_debug_color_flags_get_type ());
619 g_type_class_ref (gst_iterator_result_get_type ());
620 g_type_class_ref (gst_iterator_item_get_type ());
621 g_type_class_ref (gst_message_type_get_type ());
622 g_type_class_ref (gst_mini_object_flags_get_type ());
623 g_type_class_ref (gst_pad_link_return_get_type ());
624 g_type_class_ref (gst_pad_link_check_get_type ());
625 g_type_class_ref (gst_flow_return_get_type ());
626 g_type_class_ref (gst_pad_mode_get_type ());
627 g_type_class_ref (gst_pad_direction_get_type ());
628 g_type_class_ref (gst_pad_flags_get_type ());
629 g_type_class_ref (gst_pad_presence_get_type ());
630 g_type_class_ref (gst_pad_template_flags_get_type ());
631 g_type_class_ref (gst_pipeline_flags_get_type ());
632 g_type_class_ref (gst_plugin_error_get_type ());
633 g_type_class_ref (gst_plugin_flags_get_type ());
634 g_type_class_ref (gst_plugin_dependency_flags_get_type ());
635 g_type_class_ref (gst_rank_get_type ());
636 g_type_class_ref (gst_query_type_flags_get_type ());
637 g_type_class_ref (gst_query_type_get_type ());
638 g_type_class_ref (gst_buffering_mode_get_type ());
639 g_type_class_ref (gst_stream_status_type_get_type ());
640 g_type_class_ref (gst_structure_change_type_get_type ());
641 g_type_class_ref (gst_tag_merge_mode_get_type ());
642 g_type_class_ref (gst_tag_flag_get_type ());
643 g_type_class_ref (gst_tag_scope_get_type ());
644 g_type_class_ref (gst_task_pool_get_type ());
645 g_type_class_ref (gst_task_state_get_type ());
646 g_type_class_ref (gst_toc_entry_type_get_type ());
647 g_type_class_ref (gst_type_find_probability_get_type ());
648 g_type_class_ref (gst_uri_error_get_type ());
649 g_type_class_ref (gst_uri_type_get_type ());
650 g_type_class_ref (gst_parse_error_get_type ());
651 g_type_class_ref (gst_parse_flags_get_type ());
652 g_type_class_ref (gst_search_mode_get_type ());
653 g_type_class_ref (gst_progress_type_get_type ());
654 g_type_class_ref (gst_buffer_pool_acquire_flags_get_type ());
655 g_type_class_ref (gst_memory_flags_get_type ());
656 g_type_class_ref (gst_map_flags_get_type ());
657 g_type_class_ref (gst_caps_intersect_mode_get_type ());
658 g_type_class_ref (gst_pad_probe_type_get_type ());
659 g_type_class_ref (gst_pad_probe_return_get_type ());
660 g_type_class_ref (gst_segment_flags_get_type ());
661 g_type_class_ref (gst_scheduling_flags_get_type ());
662 g_type_class_ref (gst_meta_flags_get_type ());
663 g_type_class_ref (gst_toc_entry_type_get_type ());
664 g_type_class_ref (gst_toc_scope_get_type ());
665 g_type_class_ref (gst_control_binding_get_type ());
666 g_type_class_ref (gst_control_source_get_type ());
667 g_type_class_ref (gst_lock_flags_get_type ());
668 g_type_class_ref (gst_allocator_flags_get_type ());
670 _priv_gst_event_initialize ();
671 _priv_gst_buffer_initialize ();
672 _priv_gst_message_initialize ();
673 _priv_gst_buffer_list_initialize ();
674 _priv_gst_sample_initialize ();
675 _priv_gst_value_initialize ();
677 g_type_class_ref (gst_param_spec_fraction_get_type ());
678 _priv_gst_tag_initialize ();
679 gst_parse_context_get_type ();
681 _priv_gst_plugin_initialize ();
683 /* register core plugins */
684 gst_plugin_register_static (GST_VERSION_MAJOR, GST_VERSION_MINOR,
685 "staticelements", "core elements linked into the GStreamer library",
686 gst_register_core_elements, VERSION, GST_LICENSE, PACKAGE,
687 GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);
690 * Any errors happening below this point are non-fatal, we therefore mark
691 * gstreamer as being initialized, since it is the case from a plugin point of
694 * If anything fails, it will be put back to FALSE in gst_init_check().
695 * This allows some special plugins that would call gst_init() to not cause a
696 * looping effect (i.e. initializing GStreamer twice).
698 gst_initialized = TRUE;
700 if (!gst_update_registry ())
703 GST_INFO ("GLib runtime version: %d.%d.%d", glib_major_version,
704 glib_minor_version, glib_micro_version);
705 GST_INFO ("GLib headers version: %d.%d.%d", GLIB_MAJOR_VERSION,
706 GLIB_MINOR_VERSION, GLIB_MICRO_VERSION);
711 #ifndef GST_DISABLE_GST_DEBUG
713 select_all (GstPlugin * plugin, gpointer user_data)
719 sort_by_category_name (gconstpointer a, gconstpointer b)
721 return strcmp (gst_debug_category_get_name ((GstDebugCategory *) a),
722 gst_debug_category_get_name ((GstDebugCategory *) b));
726 gst_debug_help (void)
731 /* Need to ensure the registry is loaded to get debug categories */
732 if (!init_post (NULL, NULL, NULL, NULL))
735 list2 = gst_registry_plugin_filter (gst_registry_get (),
736 select_all, FALSE, NULL);
738 /* FIXME this is gross. why don't debug have categories PluginFeatures? */
739 for (g = list2; g; g = g_list_next (g)) {
740 GstPlugin *plugin = GST_PLUGIN_CAST (g->data);
742 gst_plugin_load (plugin);
746 list = gst_debug_get_all_categories ();
747 walk = list = g_slist_sort (list, sort_by_category_name);
750 g_print ("name level description\n");
751 g_print ("---------------------+--------+--------------------------------\n");
754 GstDebugCategory *cat = (GstDebugCategory *) walk->data;
756 if (gst_debug_is_colored ()) {
758 gint color = gst_debug_construct_win_color (cat->color);
759 const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
761 SetConsoleTextAttribute (GetStdHandle (STD_OUTPUT_HANDLE), color);
762 g_print ("%-20s", gst_debug_category_get_name (cat));
763 SetConsoleTextAttribute (GetStdHandle (STD_OUTPUT_HANDLE), clear);
764 g_print (" %1d %s ", gst_debug_category_get_threshold (cat),
765 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)));
766 SetConsoleTextAttribute (GetStdHandle (STD_OUTPUT_HANDLE), color);
767 g_print ("%s", gst_debug_category_get_description (cat));
768 SetConsoleTextAttribute (GetStdHandle (STD_OUTPUT_HANDLE), clear);
770 #else /* G_OS_WIN32 */
771 gchar *color = gst_debug_construct_term_color (cat->color);
773 g_print ("%s%-20s\033[00m %1d %s %s%s\033[00m\n",
775 gst_debug_category_get_name (cat),
776 gst_debug_category_get_threshold (cat),
777 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
778 color, gst_debug_category_get_description (cat));
780 #endif /* G_OS_WIN32 */
782 g_print ("%-20s %1d %s %s\n", gst_debug_category_get_name (cat),
783 gst_debug_category_get_threshold (cat),
784 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
785 gst_debug_category_get_description (cat));
787 walk = g_slist_next (walk);
794 #ifndef GST_DISABLE_OPTION_PARSING
796 parse_one_option (gint opt, const gchar * arg, GError ** err)
800 g_print ("GStreamer Core Library version %s\n", PACKAGE_VERSION);
802 case ARG_FATAL_WARNINGS:{
803 GLogLevelFlags fatal_mask;
805 fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
806 fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL;
807 g_log_set_always_fatal (fatal_mask);
810 #ifndef GST_DISABLE_GST_DEBUG
811 case ARG_DEBUG_LEVEL:{
812 GstDebugLevel tmp = GST_LEVEL_NONE;
814 tmp = (GstDebugLevel) strtol (arg, NULL, 0);
815 if (((guint) tmp) < GST_LEVEL_COUNT) {
816 gst_debug_set_default_threshold (tmp);
821 gst_debug_set_threshold_from_string (arg, FALSE);
823 case ARG_DEBUG_NO_COLOR:
824 gst_debug_set_colored (FALSE);
826 case ARG_DEBUG_DISABLE:
827 gst_debug_set_active (FALSE);
833 case ARG_PLUGIN_SPEW:
835 case ARG_PLUGIN_PATH:
836 #ifndef GST_DISABLE_REGISTRY
837 split_and_iterate (arg, G_SEARCHPATH_SEPARATOR_S, add_path_func, NULL);
838 #endif /* GST_DISABLE_REGISTRY */
840 case ARG_PLUGIN_LOAD:
841 split_and_iterate (arg, ",", prepare_for_load_plugin_func, NULL);
843 case ARG_SEGTRAP_DISABLE:
844 _gst_disable_segtrap = TRUE;
846 case ARG_REGISTRY_UPDATE_DISABLE:
847 #ifndef GST_DISABLE_REGISTRY
848 _priv_gst_disable_registry_update = TRUE;
851 case ARG_REGISTRY_FORK_DISABLE:
852 gst_registry_fork_set_enabled (FALSE);
855 g_set_error (err, G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
856 _("Unknown option"));
864 parse_goption_arg (const gchar * opt,
865 const gchar * arg, gpointer data, GError ** err)
873 "--gst-version", ARG_VERSION}, {
874 "--gst-fatal-warnings", ARG_FATAL_WARNINGS},
875 #ifndef GST_DISABLE_GST_DEBUG
877 "--gst-debug-level", ARG_DEBUG_LEVEL}, {
878 "--gst-debug", ARG_DEBUG}, {
879 "--gst-debug-disable", ARG_DEBUG_DISABLE}, {
880 "--gst-debug-no-color", ARG_DEBUG_NO_COLOR}, {
881 "--gst-debug-help", ARG_DEBUG_HELP},
884 "--gst-plugin-spew", ARG_PLUGIN_SPEW}, {
885 "--gst-plugin-path", ARG_PLUGIN_PATH}, {
886 "--gst-plugin-load", ARG_PLUGIN_LOAD}, {
887 "--gst-disable-segtrap", ARG_SEGTRAP_DISABLE}, {
888 "--gst-disable-registry-update", ARG_REGISTRY_UPDATE_DISABLE}, {
889 "--gst-disable-registry-fork", ARG_REGISTRY_FORK_DISABLE}, {
894 for (n = 0; options[n].opt; n++) {
895 if (!strcmp (opt, options[n].opt)) {
896 val = options[n].val;
901 return parse_one_option (val, arg, err);
908 * Clean up any resources created by GStreamer in gst_init().
910 * It is normally not needed to call this function in a normal application
911 * as the resources will automatically be freed when the program terminates.
912 * This function is therefore mostly used by testsuites and other memory
915 * After this call GStreamer (including this method) should not be used anymore.
922 GST_INFO ("deinitializing GStreamer");
924 if (gst_deinitialized) {
925 GST_DEBUG ("already deinitialized");
929 g_slist_foreach (_priv_gst_preload_plugins, (GFunc) g_free, NULL);
930 g_slist_free (_priv_gst_preload_plugins);
931 _priv_gst_preload_plugins = NULL;
933 #ifndef GST_DISABLE_REGISTRY
934 g_list_foreach (_priv_gst_plugin_paths, (GFunc) g_free, NULL);
935 g_list_free (_priv_gst_plugin_paths);
936 _priv_gst_plugin_paths = NULL;
939 clock = gst_system_clock_obtain ();
940 gst_object_unref (clock);
941 gst_object_unref (clock);
943 _priv_gst_registry_cleanup ();
945 #ifndef GST_DISABLE_TRACE
946 _priv_gst_alloc_trace_deinit ();
949 g_type_class_unref (g_type_class_peek (gst_object_get_type ()));
950 g_type_class_unref (g_type_class_peek (gst_pad_get_type ()));
951 g_type_class_unref (g_type_class_peek (gst_element_factory_get_type ()));
952 g_type_class_unref (g_type_class_peek (gst_element_get_type ()));
953 g_type_class_unref (g_type_class_peek (gst_type_find_factory_get_type ()));
954 g_type_class_unref (g_type_class_peek (gst_bin_get_type ()));
955 g_type_class_unref (g_type_class_peek (gst_bus_get_type ()));
956 g_type_class_unref (g_type_class_peek (gst_task_get_type ()));
957 g_type_class_unref (g_type_class_peek (gst_object_flags_get_type ()));
958 g_type_class_unref (g_type_class_peek (gst_bin_flags_get_type ()));
959 g_type_class_unref (g_type_class_peek (gst_buffer_flags_get_type ()));
960 g_type_class_unref (g_type_class_peek (gst_buffer_copy_flags_get_type ()));
961 g_type_class_unref (g_type_class_peek (gst_bus_flags_get_type ()));
962 g_type_class_unref (g_type_class_peek (gst_bus_sync_reply_get_type ()));
963 g_type_class_unref (g_type_class_peek (gst_caps_flags_get_type ()));
964 g_type_class_unref (g_type_class_peek (gst_clock_type_get_type ()));
965 g_type_class_unref (g_type_class_peek (gst_clock_return_get_type ()));
966 g_type_class_unref (g_type_class_peek (gst_clock_entry_type_get_type ()));
967 g_type_class_unref (g_type_class_peek (gst_clock_flags_get_type ()));
968 g_type_class_unref (g_type_class_peek (gst_debug_graph_details_get_type ()));
969 g_type_class_unref (g_type_class_peek (gst_state_get_type ()));
970 g_type_class_unref (g_type_class_peek (gst_state_change_return_get_type ()));
971 g_type_class_unref (g_type_class_peek (gst_state_change_get_type ()));
972 g_type_class_unref (g_type_class_peek (gst_element_flags_get_type ()));
973 g_type_class_unref (g_type_class_peek (gst_core_error_get_type ()));
974 g_type_class_unref (g_type_class_peek (gst_library_error_get_type ()));
975 g_type_class_unref (g_type_class_peek (gst_plugin_dependency_flags_get_type
977 g_type_class_unref (g_type_class_peek (gst_parse_flags_get_type ()));
978 g_type_class_unref (g_type_class_peek (gst_resource_error_get_type ()));
979 g_type_class_unref (g_type_class_peek (gst_search_mode_get_type ()));
980 g_type_class_unref (g_type_class_peek (gst_stream_error_get_type ()));
981 g_type_class_unref (g_type_class_peek (gst_stream_status_type_get_type ()));
982 g_type_class_unref (g_type_class_peek (gst_structure_change_type_get_type
984 g_type_class_unref (g_type_class_peek (gst_event_type_flags_get_type ()));
985 g_type_class_unref (g_type_class_peek (gst_event_type_get_type ()));
986 g_type_class_unref (g_type_class_peek (gst_seek_type_get_type ()));
987 g_type_class_unref (g_type_class_peek (gst_seek_flags_get_type ()));
988 g_type_class_unref (g_type_class_peek (gst_qos_type_get_type ()));
989 g_type_class_unref (g_type_class_peek (gst_format_get_type ()));
990 g_type_class_unref (g_type_class_peek (gst_debug_level_get_type ()));
991 g_type_class_unref (g_type_class_peek (gst_debug_color_flags_get_type ()));
992 g_type_class_unref (g_type_class_peek (gst_iterator_result_get_type ()));
993 g_type_class_unref (g_type_class_peek (gst_iterator_item_get_type ()));
994 g_type_class_unref (g_type_class_peek (gst_message_type_get_type ()));
995 g_type_class_unref (g_type_class_peek (gst_meta_flags_get_type ()));
996 g_type_class_unref (g_type_class_peek (gst_mini_object_flags_get_type ()));
997 g_type_class_unref (g_type_class_peek (gst_pad_link_return_get_type ()));
998 g_type_class_unref (g_type_class_peek (gst_pad_link_check_get_type ()));
999 g_type_class_unref (g_type_class_peek (gst_flow_return_get_type ()));
1000 g_type_class_unref (g_type_class_peek (gst_pad_mode_get_type ()));
1001 g_type_class_unref (g_type_class_peek (gst_pad_direction_get_type ()));
1002 g_type_class_unref (g_type_class_peek (gst_pad_flags_get_type ()));
1003 g_type_class_unref (g_type_class_peek (gst_pad_presence_get_type ()));
1004 g_type_class_unref (g_type_class_peek (gst_pad_template_flags_get_type ()));
1005 g_type_class_unref (g_type_class_peek (gst_pipeline_flags_get_type ()));
1006 g_type_class_unref (g_type_class_peek (gst_plugin_error_get_type ()));
1007 g_type_class_unref (g_type_class_peek (gst_plugin_flags_get_type ()));
1008 g_type_class_unref (g_type_class_peek (gst_rank_get_type ()));
1009 g_type_class_unref (g_type_class_peek (gst_query_type_flags_get_type ()));
1010 g_type_class_unref (g_type_class_peek (gst_query_type_get_type ()));
1011 g_type_class_unref (g_type_class_peek (gst_buffering_mode_get_type ()));
1012 g_type_class_unref (g_type_class_peek (gst_tag_merge_mode_get_type ()));
1013 g_type_class_unref (g_type_class_peek (gst_tag_flag_get_type ()));
1014 g_type_class_unref (g_type_class_peek (gst_tag_scope_get_type ()));
1015 g_type_class_unref (g_type_class_peek (gst_task_state_get_type ()));
1016 g_type_class_unref (g_type_class_peek (gst_toc_entry_type_get_type ()));
1017 g_type_class_unref (g_type_class_peek (gst_toc_scope_get_type ()));
1018 g_type_class_unref (g_type_class_peek (gst_type_find_probability_get_type
1020 g_type_class_unref (g_type_class_peek (gst_uri_type_get_type ()));
1021 g_type_class_unref (g_type_class_peek (gst_uri_error_get_type ()));
1022 g_type_class_unref (g_type_class_peek (gst_parse_error_get_type ()));
1023 g_type_class_unref (g_type_class_peek (gst_param_spec_fraction_get_type ()));
1024 g_type_class_unref (g_type_class_peek (gst_progress_type_get_type ()));
1025 g_type_class_unref (g_type_class_peek (gst_buffer_pool_acquire_flags_get_type
1027 g_type_class_unref (g_type_class_peek (gst_memory_flags_get_type ()));
1028 g_type_class_unref (g_type_class_peek (gst_map_flags_get_type ()));
1029 g_type_class_unref (g_type_class_peek (gst_caps_intersect_mode_get_type ()));
1030 g_type_class_unref (g_type_class_peek (gst_pad_probe_type_get_type ()));
1031 g_type_class_unref (g_type_class_peek (gst_pad_probe_return_get_type ()));
1032 g_type_class_unref (g_type_class_peek (gst_segment_flags_get_type ()));
1033 g_type_class_unref (g_type_class_peek (gst_scheduling_flags_get_type ()));
1035 g_type_class_unref (g_type_class_peek (gst_control_binding_get_type ()));
1036 g_type_class_unref (g_type_class_peek (gst_control_source_get_type ()));
1037 g_type_class_unref (g_type_class_peek (gst_toc_entry_type_get_type ()));
1038 g_type_class_unref (g_type_class_peek (gst_lock_flags_get_type ()));
1039 g_type_class_unref (g_type_class_peek (gst_allocator_flags_get_type ()));
1042 gst_deinitialized = TRUE;
1043 GST_INFO ("deinitialized GStreamer");
1048 * @major: (out): pointer to a guint to store the major version number
1049 * @minor: (out): pointer to a guint to store the minor version number
1050 * @micro: (out): pointer to a guint to store the micro version number
1051 * @nano: (out): pointer to a guint to store the nano version number
1053 * Gets the version number of the GStreamer library.
1056 gst_version (guint * major, guint * minor, guint * micro, guint * nano)
1058 g_return_if_fail (major);
1059 g_return_if_fail (minor);
1060 g_return_if_fail (micro);
1061 g_return_if_fail (nano);
1063 *major = GST_VERSION_MAJOR;
1064 *minor = GST_VERSION_MINOR;
1065 *micro = GST_VERSION_MICRO;
1066 *nano = GST_VERSION_NANO;
1070 * gst_version_string:
1072 * This function returns a string that is useful for describing this version
1073 * of GStreamer to the outside world: user agent strings, logging, ...
1075 * Returns: (transfer full): a newly allocated string describing this version
1080 gst_version_string (void)
1082 guint major, minor, micro, nano;
1084 gst_version (&major, &minor, µ, &nano);
1086 return g_strdup_printf ("GStreamer %d.%d.%d", major, minor, micro);
1088 return g_strdup_printf ("GStreamer %d.%d.%d (GIT)", major, minor, micro);
1090 return g_strdup_printf ("GStreamer %d.%d.%d (prerelease)", major, minor,
1095 * gst_segtrap_is_enabled:
1097 * Some functions in the GStreamer core might install a custom SIGSEGV handler
1098 * to better catch and report errors to the application. Currently this feature
1099 * is enabled by default when loading plugins.
1101 * Applications might want to disable this behaviour with the
1102 * gst_segtrap_set_enabled() function. This is typically done if the application
1103 * wants to install its own handler without GStreamer interfering.
1105 * Returns: %TRUE if GStreamer is allowed to install a custom SIGSEGV handler.
1108 gst_segtrap_is_enabled (void)
1110 /* yeps, it's enabled when it's not disabled */
1111 return !_gst_disable_segtrap;
1115 * gst_segtrap_set_enabled:
1116 * @enabled: whether a custom SIGSEGV handler should be installed.
1118 * Applications might want to disable/enable the SIGSEGV handling of
1119 * the GStreamer core. See gst_segtrap_is_enabled() for more information.
1122 gst_segtrap_set_enabled (gboolean enabled)
1124 _gst_disable_segtrap = !enabled;